bs3kit.h@ 59945

Last change on this file since 59945 was 59941, checked in by vboxsync, 9 years ago
bs3kit: Updates and fixes.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 111.3 KB

Line
1	/* $Id: bs3kit.h 59941 2016-03-07 15:13:51Z vboxsync $ */
2	/** @file
3	* BS3Kit - structures, symbols, macros and stuff.
4	*/
5
6	/*
7	* Copyright (C) 2007-2015 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27	#ifndef ___bs3kit_h
28	#define ___bs3kit_h
29
30	#ifndef DOXYGEN_RUNNING
31	# define IN_RING0
32	#endif
33	#include <iprt/cdefs.h>
34	#include <iprt/types.h>
35	#ifndef DOXYGEN_RUNNING
36	# undef IN_RING0
37	#endif
38
39	/*
40	* We may want to reuse some IPRT code in the common name space, so we
41	* redefine the RT_MANGLER to work like BS3_CMN_NM. (We cannot use
42	* BS3_CMN_NM yet, as we need to include IPRT headers with function
43	* declarations before we can define it. Thus the duplciate effort.)
44	*/
45	#define RT_MANGLER(a_Name) RT_CONCAT3(a_Name,_c,ARCH_BITS)
46	#include <iprt/mangling.h>
47	#include <iprt/x86.h>
48	#include <iprt/err.h>
49
50
51
52	RT_C_DECLS_BEGIN
53
54	/** @defgroup grp_bs3kit BS3Kit
55	* @{ */
56
57	/** @name Execution modes.
58	* @{ */
59	#define BS3_MODE_INVALID UINT8_C(0x00)
60	#define BS3_MODE_RM UINT8_C(0x01) /*< real mode. /
61	#define BS3_MODE_PE16 UINT8_C(0x11) /*< 16-bit protected mode kernel+tss, running 16-bit code, unpaged. /
62	#define BS3_MODE_PE16_32 UINT8_C(0x12) /*< 16-bit protected mode kernel+tss, running 32-bit code, unpaged. /
63	#define BS3_MODE_PE16_V86 UINT8_C(0x13) /*< 16-bit protected mode kernel+tss, running virtual 8086 mode code, unpaged. /
64	#define BS3_MODE_PE32 UINT8_C(0x22) /*< 32-bit protected mode kernel+tss, running 32-bit code, unpaged. /
65	#define BS3_MODE_PE32_16 UINT8_C(0x21) /*< 32-bit protected mode kernel+tss, running 16-bit code, unpaged. /
66	#define BS3_MODE_PEV86 UINT8_C(0x23) /*< 32-bit protected mode kernel+tss, running virtual 8086 mode code, unpaged. /
67	#define BS3_MODE_PP16 UINT8_C(0x31) /*< 16-bit protected mode kernel+tss, running 16-bit code, paged. /
68	#define BS3_MODE_PP16_32 UINT8_C(0x32) /*< 16-bit protected mode kernel+tss, running 32-bit code, paged. /
69	#define BS3_MODE_PP16_V86 UINT8_C(0x33) /*< 16-bit protected mode kernel+tss, running virtual 8086 mode code, paged. /
70	#define BS3_MODE_PP32 UINT8_C(0x42) /*< 32-bit protected mode kernel+tss, running 32-bit code, paged. /
71	#define BS3_MODE_PP32_16 UINT8_C(0x41) /*< 32-bit protected mode kernel+tss, running 16-bit code, paged. /
72	#define BS3_MODE_PPV86 UINT8_C(0x43) /*< 32-bit protected mode kernel+tss, running virtual 8086 mode code, paged. /
73	#define BS3_MODE_PAE16 UINT8_C(0x51) /*< 16-bit protected mode kernel+tss, running 16-bit code, PAE paging. /
74	#define BS3_MODE_PAE16_32 UINT8_C(0x52) /*< 16-bit protected mode kernel+tss, running 32-bit code, PAE paging. /
75	#define BS3_MODE_PAE16_V86 UINT8_C(0x53) /*< 16-bit protected mode kernel+tss, running virtual 8086 mode, PAE paging. /
76	#define BS3_MODE_PAE32 UINT8_C(0x62) /*< 32-bit protected mode kernel+tss, running 32-bit code, PAE paging. /
77	#define BS3_MODE_PAE32_16 UINT8_C(0x61) /*< 32-bit protected mode kernel+tss, running 16-bit code, PAE paging. /
78	#define BS3_MODE_PAEV86 UINT8_C(0x63) /*< 32-bit protected mode kernel+tss, running virtual 8086 mode, PAE paging. /
79	#define BS3_MODE_LM16 UINT8_C(0x71) /*< 16-bit long mode (paged), kernel+tss always 64-bit. /
80	#define BS3_MODE_LM32 UINT8_C(0x72) /*< 32-bit long mode (paged), kernel+tss always 64-bit. /
81	#define BS3_MODE_LM64 UINT8_C(0x74) /*< 64-bit long mode (paged), kernel+tss always 64-bit. /
82
83	#define BS3_MODE_CODE_MASK UINT8_C(0x0f) /*< Running code mask. /
84	#define BS3_MODE_CODE_16 UINT8_C(0x01) /*< Running 16-bit code. /
85	#define BS3_MODE_CODE_32 UINT8_C(0x02) /*< Running 32-bit code. /
86	#define BS3_MODE_CODE_V86 UINT8_C(0x03) /*< Running 16-bit virtual 8086 code. /
87	#define BS3_MODE_CODE_64 UINT8_C(0x04) /*< Running 64-bit code. /
88
89	#define BS3_MODE_SYS_MASK UINT8_C(0xf0) /*< kernel+tss mask. /
90	#define BS3_MODE_SYS_RM UINT8_C(0x00) /*< Real mode kernel+tss. /
91	#define BS3_MODE_SYS_PE16 UINT8_C(0x10) /*< 16-bit protected mode kernel+tss. /
92	#define BS3_MODE_SYS_PE32 UINT8_C(0x20) /*< 32-bit protected mode kernel+tss. /
93	#define BS3_MODE_SYS_PP16 UINT8_C(0x30) /*< 16-bit paged protected mode kernel+tss. /
94	#define BS3_MODE_SYS_PP32 UINT8_C(0x40) /*< 32-bit paged protected mode kernel+tss. /
95	#define BS3_MODE_SYS_PAE16 UINT8_C(0x50) /*< 16-bit PAE paged protected mode kernel+tss. /
96	#define BS3_MODE_SYS_PAE32 UINT8_C(0x60) /*< 32-bit PAE paged protected mode kernel+tss. /
97	#define BS3_MODE_SYS_LM UINT8_C(0x70) /*< 64-bit (paged) long mode protected mode kernel+tss. /
98
99	/** Whether the mode has paging enabled. */
100	#define BS3_MODE_IS_PAGED(a_fMode) ((a_fMode) >= BS3_MODE_PP16)
101
102	/** Whether the mode is running v8086 code. */
103	#define BS3_MODE_IS_V86(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_V86)
104	/** Whether the we're executing in real mode or v8086 mode. */
105	#define BS3_MODE_IS_RM_OR_V86(a_fMode) ((a_fMode) == BS3_MODE_RM \|\| BS3_MODE_IS_V86(a_fMode))
106	/** Whether the mode is running 16-bit code, except v8086. */
107	#define BS3_MODE_IS_16BIT_CODE_NO_V86(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_16)
108	/** Whether the mode is running 16-bit code (includes v8086). */
109	#define BS3_MODE_IS_16BIT_CODE(a_fMode) (BS3_MODE_IS_16BIT_CODE_NO_V86(a_fMode) \|\| BS3_MODE_IS_V86(a_fMode))
110	/** Whether the mode is running 32-bit code. */
111	#define BS3_MODE_IS_32BIT_CODE(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_32)
112	/** Whether the mode is running 64-bit code. */
113	#define BS3_MODE_IS_64BIT_CODE(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_64)
114
115	/** Whether the system is in real mode. */
116	#define BS3_MODE_IS_RM_SYS(a_fMode) (((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_RM)
117	/** Whether the system is some 16-bit mode that isn't real mode. */
118	#define BS3_MODE_IS_16BIT_SYS_NO_RM(a_fMode) ( ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PE16 \
119	\|\| ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PP16 \
120	\|\| ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PAE16)
121	/** Whether the system is some 16-bit mode (includes real mode). */
122	#define BS3_MODE_IS_16BIT_SYS(a_fMode) (BS3_MODE_IS_16BIT_SYS_NO_RM(a_fMode) \|\| BS3_MODE_IS_RM_SYS(a_fMode))
123	/** Whether the system is some 32-bit mode. */
124	#define BS3_MODE_IS_32BIT_SYS(a_fMode) ( ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PE32 \
125	\|\| ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PP32 \
126	\|\| ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PAE32)
127	/** Whether the system is long mode. */
128	#define BS3_MODE_IS_64BIT_SYS(a_fMode) (((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_LM)
129
130	/** @todo testcase: How would long-mode handle a 16-bit TSS loaded prior to the switch? (mainly stack switching wise) Hopefully, it will tripple fault, right? */
131	/** @} */
132
133
134	/** @name BS3_ADDR_XXX - Static Memory Allocation
135	* @{ */
136	/** The flat load address for the code after the bootsector. */
137	#define BS3_ADDR_LOAD 0x10000
138	/** Where we save the boot registers during init.
139	* Located right before the code. */
140	#define BS3_ADDR_REG_SAVE (BS3_ADDR_LOAD - sizeof(BS3REGS) - 8)
141	/** Where the stack starts (initial RSP value).
142	* Located 16 bytes (assumed by boot sector) before the saved registers.
143	* SS.BASE=0. The size is a little short of 32KB */
144	#define BS3_ADDR_STACK (BS3_ADDR_REG_SAVE - 16)
145	/** The ring-0 stack (8KB) for ring transitions. */
146	#define BS3_ADDR_STACK_R0 0x06000
147	/** The ring-1 stack (8KB) for ring transitions. */
148	#define BS3_ADDR_STACK_R1 0x04000
149	/** The ring-2 stack (8KB) for ring transitions. */
150	#define BS3_ADDR_STACK_R2 0x02000
151	/** IST1 ring-0 stack for long mode (4KB), used for double faults elsewhere. */
152	#define BS3_ADDR_STACK_R0_IST1 0x09000
153	/** IST2 ring-0 stack for long mode (3KB), used for spare 0 stack elsewhere. */
154	#define BS3_ADDR_STACK_R0_IST2 0x08000
155	/** IST3 ring-0 stack for long mode (1KB). */
156	#define BS3_ADDR_STACK_R0_IST3 0x07400
157	/** IST4 ring-0 stack for long mode (1KB), used for spare 1 stack elsewhere. */
158	#define BS3_ADDR_STACK_R0_IST4 0x07000
159	/** IST5 ring-0 stack for long mode (1KB). */
160	#define BS3_ADDR_STACK_R0_IST5 0x06c00
161	/** IST6 ring-0 stack for long mode (1KB). */
162	#define BS3_ADDR_STACK_R0_IST6 0x06800
163	/** IST7 ring-0 stack for long mode (1KB). */
164	#define BS3_ADDR_STACK_R0_IST7 0x06400
165
166	/** The base address of the BS3TEXT16 segment (same as BS3_LOAD_ADDR).
167	* @sa BS3_SEL_TEXT16 */
168	#define BS3_ADDR_BS3TEXT16 0x10000
169	/** The base address of the BS3SYSTEM16 segment.
170	* @sa BS3_SEL_SYSTEM16 */
171	#define BS3_ADDR_BS3SYSTEM16 0x20000
172	/** The base address of the BS3DATA16 segment.
173	* @sa BS3_SEL_DATA16 */
174	#define BS3_ADDR_BS3DATA16 0x27000
175	/** @} */
176
177	/** @name BS3_SEL_XXX - GDT selector assignments.
178	*
179	* The real mode segment numbers for BS16TEXT, BS16DATA and BS16SYSTEM are
180	* present in the GDT, this allows the 16-bit C/C++ and assembly code to
181	* continue using the real mode segment values in ring-0 protected mode.
182	*
183	* The three segments have fixed locations:
184	* \| segment \| flat address \| real mode segment \|
185	* \| ----------- \| ------------ \| ----------------- \|
186	* \| BS3TEXT16 \| 0x00010000 \| 1000h \|
187	* \| BS3SYSTEM16 \| 0x00020000 \| 2000h \|
188	* \| BS3DATA16 \| 0x00027000 \| 2700h \|
189	*
190	* This means that we've got a lot of GDT space to play around with.
191	*
192	* @{ */
193	#define BS3_SEL_LDT 0x0010 /*< The LDT selector for Bs3Ldt. /
194	#define BS3_SEL_TSS16 0x0020 /*< The 16-bit TSS selector. /
195	#define BS3_SEL_TSS16_DF 0x0028 /*< The 16-bit TSS selector for double faults. /
196	#define BS3_SEL_TSS16_SPARE0 0x0030 /*< The 16-bit TSS selector for testing. /
197	#define BS3_SEL_TSS16_SPARE1 0x0038 /*< The 16-bit TSS selector for testing. /
198	#define BS3_SEL_TSS32 0x0040 /*< The 32-bit TSS selector. /
199	#define BS3_SEL_TSS32_DF 0x0048 /*< The 32-bit TSS selector for double faults. /
200	#define BS3_SEL_TSS32_SPARE0 0x0050 /*< The 32-bit TSS selector for testing. /
201	#define BS3_SEL_TSS32_SPARE1 0x0058 /*< The 32-bit TSS selector for testing. /
202	#define BS3_SEL_TSS32_IOBP_IRB 0x0060 /*< The 32-bit TSS selector with I/O permission and interrupt redirection bitmaps. /
203	#define BS3_SEL_TSS32_IRB 0x0068 /*< The 32-bit TSS selector with only interrupt redirection bitmap (IOPB stripped by limit). /
204	#define BS3_SEL_TSS64 0x0070 /*< The 64-bit TSS selector. /
205	#define BS3_SEL_TSS64_SPARE0 0x0080 /*< The 64-bit TSS selector. /
206	#define BS3_SEL_TSS64_SPARE1 0x0090 /*< The 64-bit TSS selector. /
207	#define BS3_SEL_TSS64_IOBP 0x00a0 /*< The 64-bit TSS selector. /
208
209	#define BS3_SEL_VMMDEV_MMIO16 0x00f8 /*< Selector for accessing the VMMDev MMIO segment at 0100000h from 16-bit code. /
210
211	#define BS3_SEL_RING_SHIFT 8 /*< For the formula: BS3_SEL_R0_XXX + ((cs & 3) << BS3_SEL_RING_SHIFT) /
212
213	#define BS3_SEL_R0_FIRST 0x0100 /*< The first selector in the ring-0 block. /
214	#define BS3_SEL_R0_CS16 0x0100 /*< ring-0: 16-bit code selector, base 0x10000. /
215	#define BS3_SEL_R0_DS16 0x0108 /*< ring-0: 16-bit data selector, base 0x23000. /
216	#define BS3_SEL_R0_SS16 0x0110 /*< ring-0: 16-bit stack selector, base 0x00000. /
217	#define BS3_SEL_R0_CS32 0x0118 /*< ring-0: 32-bit flat code selector. /
218	#define BS3_SEL_R0_DS32 0x0120 /*< ring-0: 32-bit flat data selector. /
219	#define BS3_SEL_R0_SS32 0x0128 /*< ring-0: 32-bit flat stack selector. /
220	#define BS3_SEL_R0_CS64 0x0130 /*< ring-0: 64-bit flat code selector. /
221	#define BS3_SEL_R0_DS64 0x0138 /*< ring-0: 64-bit flat data & stack selector. /
222	#define BS3_SEL_R0_CS16_EO 0x0140 /*< ring-0: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. /
223	#define BS3_SEL_R0_CS16_CNF 0x0148 /*< ring-0: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. /
224	#define BS3_SEL_R0_CS16_CNF_EO 0x0150 /*< ring-0: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. /
225	#define BS3_SEL_R0_CS32_EO 0x0158 /*< ring-0: 32-bit execute-only code selector, not accessed, flat. /
226	#define BS3_SEL_R0_CS32_CNF 0x0160 /*< ring-0: 32-bit conforming code selector, not accessed, flat. /
227	#define BS3_SEL_R0_CS32_CNF_EO 0x0168 /*< ring-0: 32-bit execute-only conforming code selector, not accessed, flat. /
228	#define BS3_SEL_R0_CS64_EO 0x0170 /*< ring-0: 64-bit execute-only code selector, not accessed, flat. /
229	#define BS3_SEL_R0_CS64_CNF 0x0178 /*< ring-0: 64-bit conforming code selector, not accessed, flat. /
230	#define BS3_SEL_R0_CS64_CNF_EO 0x0180 /*< ring-0: 64-bit execute-only conforming code selector, not accessed, flat. /
231
232	#define BS3_SEL_R1_FIRST 0x0200 /*< The first selector in the ring-1 block. /
233	#define BS3_SEL_R1_CS16 0x0200 /*< ring-1: 16-bit code selector, base 0x10000. /
234	#define BS3_SEL_R1_DS16 0x0208 /*< ring-1: 16-bit data selector, base 0x23000. /
235	#define BS3_SEL_R1_SS16 0x0210 /*< ring-1: 16-bit stack selector, base 0x00000. /
236	#define BS3_SEL_R1_CS32 0x0218 /*< ring-1: 32-bit flat code selector. /
237	#define BS3_SEL_R1_DS32 0x0220 /*< ring-1: 32-bit flat data selector. /
238	#define BS3_SEL_R1_SS32 0x0228 /*< ring-1: 32-bit flat stack selector. /
239	#define BS3_SEL_R1_CS64 0x0230 /*< ring-1: 64-bit flat code selector. /
240	#define BS3_SEL_R1_DS64 0x0238 /*< ring-1: 64-bit flat data & stack selector. /
241	#define BS3_SEL_R1_CS16_EO 0x0240 /*< ring-1: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. /
242	#define BS3_SEL_R1_CS16_CNF 0x0248 /*< ring-1: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. /
243	#define BS3_SEL_R1_CS16_CNF_EO 0x0250 /*< ring-1: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. /
244	#define BS3_SEL_R1_CS32_EO 0x0258 /*< ring-1: 32-bit execute-only code selector, not accessed, flat. /
245	#define BS3_SEL_R1_CS32_CNF 0x0260 /*< ring-1: 32-bit conforming code selector, not accessed, flat. /
246	#define BS3_SEL_R1_CS32_CNF_EO 0x0268 /*< ring-1: 32-bit execute-only conforming code selector, not accessed, flat. /
247	#define BS3_SEL_R1_CS64_EO 0x0270 /*< ring-1: 64-bit execute-only code selector, not accessed, flat. /
248	#define BS3_SEL_R1_CS64_CNF 0x0278 /*< ring-1: 64-bit conforming code selector, not accessed, flat. /
249	#define BS3_SEL_R1_CS64_CNF_EO 0x0280 /*< ring-1: 64-bit execute-only conforming code selector, not accessed, flat. /
250
251	#define BS3_SEL_R2_FIRST 0x0300 /*< The first selector in the ring-2 block. /
252	#define BS3_SEL_R2_CS16 0x0300 /*< ring-2: 16-bit code selector, base 0x10000. /
253	#define BS3_SEL_R2_DS16 0x0308 /*< ring-2: 16-bit data selector, base 0x23000. /
254	#define BS3_SEL_R2_SS16 0x0310 /*< ring-2: 16-bit stack selector, base 0x00000. /
255	#define BS3_SEL_R2_CS32 0x0318 /*< ring-2: 32-bit flat code selector. /
256	#define BS3_SEL_R2_DS32 0x0320 /*< ring-2: 32-bit flat data selector. /
257	#define BS3_SEL_R2_SS32 0x0328 /*< ring-2: 32-bit flat stack selector. /
258	#define BS3_SEL_R2_CS64 0x0330 /*< ring-2: 64-bit flat code selector. /
259	#define BS3_SEL_R2_DS64 0x0338 /*< ring-2: 64-bit flat data & stack selector. /
260	#define BS3_SEL_R2_CS16_EO 0x0340 /*< ring-2: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. /
261	#define BS3_SEL_R2_CS16_CNF 0x0348 /*< ring-2: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. /
262	#define BS3_SEL_R2_CS16_CNF_EO 0x0350 /*< ring-2: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. /
263	#define BS3_SEL_R2_CS32_EO 0x0358 /*< ring-2: 32-bit execute-only code selector, not accessed, flat. /
264	#define BS3_SEL_R2_CS32_CNF 0x0360 /*< ring-2: 32-bit conforming code selector, not accessed, flat. /
265	#define BS3_SEL_R2_CS32_CNF_EO 0x0368 /*< ring-2: 32-bit execute-only conforming code selector, not accessed, flat. /
266	#define BS3_SEL_R2_CS64_EO 0x0370 /*< ring-2: 64-bit execute-only code selector, not accessed, flat. /
267	#define BS3_SEL_R2_CS64_CNF 0x0378 /*< ring-2: 64-bit conforming code selector, not accessed, flat. /
268	#define BS3_SEL_R2_CS64_CNF_EO 0x0380 /*< ring-2: 64-bit execute-only conforming code selector, not accessed, flat. /
269
270	#define BS3_SEL_R3_FIRST 0x0400 /*< The first selector in the ring-3 block. /
271	#define BS3_SEL_R3_CS16 0x0400 /*< ring-3: 16-bit code selector, base 0x10000. /
272	#define BS3_SEL_R3_DS16 0x0408 /*< ring-3: 16-bit data selector, base 0x23000. /
273	#define BS3_SEL_R3_SS16 0x0410 /*< ring-3: 16-bit stack selector, base 0x00000. /
274	#define BS3_SEL_R3_CS32 0x0418 /*< ring-3: 32-bit flat code selector. /
275	#define BS3_SEL_R3_DS32 0x0420 /*< ring-3: 32-bit flat data selector. /
276	#define BS3_SEL_R3_SS32 0x0428 /*< ring-3: 32-bit flat stack selector. /
277	#define BS3_SEL_R3_CS64 0x0430 /*< ring-3: 64-bit flat code selector. /
278	#define BS3_SEL_R3_DS64 0x0438 /*< ring-3: 64-bit flat data & stack selector. /
279	#define BS3_SEL_R3_CS16_EO 0x0440 /*< ring-3: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. /
280	#define BS3_SEL_R3_CS16_CNF 0x0448 /*< ring-3: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. /
281	#define BS3_SEL_R3_CS16_CNF_EO 0x0450 /*< ring-3: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. /
282	#define BS3_SEL_R3_CS32_EO 0x0458 /*< ring-3: 32-bit execute-only code selector, not accessed, flat. /
283	#define BS3_SEL_R3_CS32_CNF 0x0460 /*< ring-3: 32-bit conforming code selector, not accessed, flat. /
284	#define BS3_SEL_R3_CS32_CNF_EO 0x0468 /*< ring-3: 32-bit execute-only conforming code selector, not accessed, flat. /
285	#define BS3_SEL_R3_CS64_EO 0x0470 /*< ring-3: 64-bit execute-only code selector, not accessed, flat. /
286	#define BS3_SEL_R3_CS64_CNF 0x0478 /*< ring-3: 64-bit conforming code selector, not accessed, flat. /
287	#define BS3_SEL_R3_CS64_CNF_EO 0x0480 /*< ring-3: 64-bit execute-only conforming code selector, not accessed, flat. /
288
289	#define BS3_SEL_SPARE_FIRST 0x0500 /*< The first selector in the spare block /
290	#define BS3_SEL_SPARE_00 0x0500 /*< Spare selector number 00h. /
291	#define BS3_SEL_SPARE_01 0x0508 /*< Spare selector number 01h. /
292	#define BS3_SEL_SPARE_02 0x0510 /*< Spare selector number 02h. /
293	#define BS3_SEL_SPARE_03 0x0518 /*< Spare selector number 03h. /
294	#define BS3_SEL_SPARE_04 0x0520 /*< Spare selector number 04h. /
295	#define BS3_SEL_SPARE_05 0x0528 /*< Spare selector number 05h. /
296	#define BS3_SEL_SPARE_06 0x0530 /*< Spare selector number 06h. /
297	#define BS3_SEL_SPARE_07 0x0538 /*< Spare selector number 07h. /
298	#define BS3_SEL_SPARE_08 0x0540 /*< Spare selector number 08h. /
299	#define BS3_SEL_SPARE_09 0x0548 /*< Spare selector number 09h. /
300	#define BS3_SEL_SPARE_0a 0x0550 /*< Spare selector number 0ah. /
301	#define BS3_SEL_SPARE_0b 0x0558 /*< Spare selector number 0bh. /
302	#define BS3_SEL_SPARE_0c 0x0560 /*< Spare selector number 0ch. /
303	#define BS3_SEL_SPARE_0d 0x0568 /*< Spare selector number 0dh. /
304	#define BS3_SEL_SPARE_0e 0x0570 /*< Spare selector number 0eh. /
305	#define BS3_SEL_SPARE_0f 0x0578 /*< Spare selector number 0fh. /
306	#define BS3_SEL_SPARE_10 0x0580 /*< Spare selector number 10h. /
307	#define BS3_SEL_SPARE_11 0x0588 /*< Spare selector number 11h. /
308	#define BS3_SEL_SPARE_12 0x0590 /*< Spare selector number 12h. /
309	#define BS3_SEL_SPARE_13 0x0598 /*< Spare selector number 13h. /
310	#define BS3_SEL_SPARE_14 0x05a0 /*< Spare selector number 14h. /
311	#define BS3_SEL_SPARE_15 0x05a8 /*< Spare selector number 15h. /
312	#define BS3_SEL_SPARE_16 0x05b0 /*< Spare selector number 16h. /
313	#define BS3_SEL_SPARE_17 0x05b8 /*< Spare selector number 17h. /
314	#define BS3_SEL_SPARE_18 0x05c0 /*< Spare selector number 18h. /
315	#define BS3_SEL_SPARE_19 0x05c8 /*< Spare selector number 19h. /
316	#define BS3_SEL_SPARE_1a 0x05d0 /*< Spare selector number 1ah. /
317	#define BS3_SEL_SPARE_1b 0x05d8 /*< Spare selector number 1bh. /
318	#define BS3_SEL_SPARE_1c 0x05e0 /*< Spare selector number 1ch. /
319	#define BS3_SEL_SPARE_1d 0x05e8 /*< Spare selector number 1dh. /
320	#define BS3_SEL_SPARE_1e 0x05f0 /*< Spare selector number 1eh. /
321	#define BS3_SEL_SPARE_1f 0x05f8 /*< Spare selector number 1fh. /
322
323	#define BS3_SEL_TILED 0x0600 /*< 16-bit data tiling: First - base=0x00000000, limit=64KB. /
324	#define BS3_SEL_TILED_LAST 0x0df8 /*< 16-bit data tiling: Last - base=0x00ff0000, limit=64KB. /
325	#define BS3_SEL_TILED_AREA_SIZE 0x001000000 /*< 16-bit data tiling: Size of addressable area, in bytes. (16 MB) /
326
327	#define BS3_SEL_FREE_PART1 0x0e00 /*< Free selector space - part \#1. /
328	#define BS3_SEL_FREE_PART1_LAST 0x0ff8 /*< Free selector space - part \#1, last entry. /
329
330	#define BS3_SEL_TEXT16 0x1000 /*< The BS3TEXT16 selector. /
331
332	#define BS3_SEL_FREE_PART2 0x1008 /*< Free selector space - part \#2. /
333	#define BS3_SEL_FREE_PART2_LAST 0x1ff8 /*< Free selector space - part \#2, last entry. /
334
335	#define BS3_SEL_SYSTEM16 0x2000 /*< The BS3SYSTEM16 selector. /
336
337	#define BS3_SEL_FREE_PART3 0x2008 /*< Free selector space - part \#3. /
338	#define BS3_SEL_FREE_PART3_LAST 0x26f8 /*< Free selector space - part \#3, last entry. /
339
340	#define BS3_SEL_DATA16 0x2700 /*< The BS3DATA16 selector. /
341
342	#define BS3_SEL_GDT_LIMIT 0x2707 /*< The GDT limit. /
343	/** @} */
344
345
346	/** @def BS3_FAR
347	* For indicating far pointers in 16-bit code.
348	* Does nothing in 32-bit and 64-bit code. */
349	/** @def BS3_NEAR
350	* For indicating near pointers in 16-bit code.
351	* Does nothing in 32-bit and 64-bit code. */
352	/** @def BS3_FAR_CODE
353	* For indicating far 16-bit functions.
354	* Does nothing in 32-bit and 64-bit code. */
355	/** @def BS3_NEAR_CODE
356	* For indicating near 16-bit functions.
357	* Does nothing in 32-bit and 64-bit code. */
358	/** @def BS3_FAR_DATA
359	* For indicating far 16-bit external data, i.e. in a segment other than DATA16.
360	* Does nothing in 32-bit and 64-bit code. */
361	#ifdef M_I86
362	# define BS3_FAR __far
363	# define BS3_NEAR __near
364	# define BS3_FAR_CODE __far
365	# define BS3_NEAR_CODE __near
366	# define BS3_FAR_DATA __far
367	#else
368	# define BS3_FAR
369	# define BS3_NEAR
370	# define BS3_FAR_CODE
371	# define BS3_NEAR_CODE
372	# define BS3_FAR_DATA
373	#endif
374
375	#if ARCH_BITS == 16 \|\| defined(DOXYGEN_RUNNING)
376	/** @def BS3_FP_SEG
377	* Get the selector (segment) part of a far pointer.
378	* @returns selector.
379	* @param a_pv Far pointer.
380	*/
381	# define BS3_FP_SEG(a_pv) ((uint16_t)(__segment)(void BS3_FAR *)(a_pv))
382	/** @def BS3_FP_OFF
383	* Get the segment offset part of a far pointer.
384	* @returns offset.
385	* @param a_pv Far pointer.
386	*/
387	# define BS3_FP_OFF(a_pv) ((uint16_t)(void __near *)(a_pv))
388	/** @def BS3_FP_MAKE
389	* Create a far pointer.
390	* @returns selector.
391	* @param a_pv Far pointer.
392	*/
393	# define BS3_FP_MAKE(a_uSeg, a_off) (((__segment)(a_uSeg)) :> ((void __near *)(a_off)))
394	#endif
395
396	/** @def BS3_CALL
397	* The calling convension used by BS3 functions. */
398	#if ARCH_BITS != 64
399	# define BS3_CALL __cdecl
400	#elif !defined(_MSC_VER)
401	# define BS3_CALL __attribute__((__ms_abi__))
402	#else
403	# define BS3_CALL
404	#endif
405
406	/** @def IN_BS3KIT
407	* Indicates that we're in the same link job as the BS3Kit code. */
408	#ifdef DOXYGEN_RUNNING
409	# define IN_BS3KIT
410	#endif
411
412	/** @def BS3_DECL
413	* Declares a BS3Kit function.
414	*
415	* Until we outgrow BS3TEXT16, we use all near functions in 16-bit.
416	*
417	* @param a_Type The return type. */
418	#ifdef IN_BS3KIT
419	# define BS3_DECL(a_Type) DECLEXPORT(a_Type) BS3_NEAR_CODE BS3_CALL
420	#else
421	# define BS3_DECL(a_Type) DECLIMPORT(a_Type) BS3_NEAR_CODE BS3_CALL
422	#endif
423
424	/** @def BS3_DECL_CALLBACK
425	* Declares a BS3Kit callback function (typically static).
426	*
427	* Until we outgrow BS3TEXT16, we use all near functions in 16-bit.
428	*
429	* @param a_Type The return type. */
430	#ifdef IN_BS3KIT
431	# define BS3_DECL_CALLBACK(a_Type) a_Type BS3_NEAR_CODE BS3_CALL
432	#else
433	# define BS3_DECL_CALLBACK(a_Type) a_Type BS3_NEAR_CODE BS3_CALL
434	#endif
435
436	/**
437	* Constructs a common name.
438	*
439	* Example: BS3_CMN_NM(Bs3Shutdown)
440	*
441	* @param a_Name The name of the function or global variable.
442	*/
443	#define BS3_CMN_NM(a_Name) RT_CONCAT3(a_Name,_c,ARCH_BITS)
444
445	/**
446	* Constructs a data name.
447	*
448	* Example: extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdt)
449	*
450	* @param a_Name The name of the global variable.
451	*/
452	#if ARCH_BITS == 64
453	# define BS3_DATA_NM(a_Name) RT_CONCAT(_,a_Name)
454	#else
455	# define BS3_DATA_NM(a_Name) a_Name
456	#endif
457
458	/**
459	* Template for createing a pointer union type.
460	* @param a_BaseName The base type name.
461	* @param a_Modifier The type modifier.
462	*/
463	#define BS3_PTR_UNION_TEMPLATE(a_BaseName, a_Modifiers) \
464	typedef union a_BaseName \
465	{ \
466	/** Pointer into the void. */ \
467	a_Modifiers void BS3_FAR *pv; \
468	/** As a signed integer. */ \
469	intptr_t i; \
470	/** As an unsigned integer. */ \
471	uintptr_t u; \
472	/** Pointer to char value. */ \
473	a_Modifiers char BS3_FAR *pch; \
474	/** Pointer to char value. */ \
475	a_Modifiers unsigned char BS3_FAR *puch; \
476	/** Pointer to a int value. */ \
477	a_Modifiers int BS3_FAR *pi; \
478	/** Pointer to a unsigned int value. */ \
479	a_Modifiers unsigned int BS3_FAR *pu; \
480	/** Pointer to a long value. */ \
481	a_Modifiers long BS3_FAR *pl; \
482	/** Pointer to a long value. */ \
483	a_Modifiers unsigned long BS3_FAR *pul; \
484	/** Pointer to a memory size value. */ \
485	a_Modifiers size_t BS3_FAR *pcb; \
486	/** Pointer to a byte value. */ \
487	a_Modifiers uint8_t BS3_FAR *pb; \
488	/** Pointer to a 8-bit unsigned value. */ \
489	a_Modifiers uint8_t BS3_FAR *pu8; \
490	/** Pointer to a 16-bit unsigned value. */ \
491	a_Modifiers uint16_t BS3_FAR *pu16; \
492	/** Pointer to a 32-bit unsigned value. */ \
493	a_Modifiers uint32_t BS3_FAR *pu32; \
494	/** Pointer to a 64-bit unsigned value. */ \
495	a_Modifiers uint64_t BS3_FAR *pu64; \
496	/** Pointer to a UTF-16 character. */ \
497	a_Modifiers RTUTF16 BS3_FAR *pwc; \
498	/** Pointer to a UUID character. */ \
499	a_Modifiers RTUUID BS3_FAR *pUuid; \
500	} a_BaseName; \
501	/** Pointer to a pointer union. */ \
502	typedef a_BaseName *RT_CONCAT(P,a_BaseName)
503	BS3_PTR_UNION_TEMPLATE(BS3PTRUNION, RT_NOTHING);
504	BS3_PTR_UNION_TEMPLATE(BS3CPTRUNION, const);
505	BS3_PTR_UNION_TEMPLATE(BS3VPTRUNION, volatile);
506	BS3_PTR_UNION_TEMPLATE(BS3CVPTRUNION, const volatile);
507
508
509	/** The system call vector. */
510	#define BS3_TRAP_SYSCALL UINT8_C(0x20)
511
512	/** @name System call numbers (ax).
513	* Paramenters are generally passed in registers specific to each system call.
514	* @{ */
515	/** Print char (cl). */
516	#define BS3_SYSCALL_PRINT_CHR UINT16_C(0x0001)
517	/** Print string (pointer in ds:[e]si, length in cx). */
518	#define BS3_SYSCALL_PRINT_STR UINT16_C(0x0002)
519	/** Switch to ring-0. */
520	#define BS3_SYSCALL_TO_RING0 UINT16_C(0x0003)
521	/** Switch to ring-1. */
522	#define BS3_SYSCALL_TO_RING1 UINT16_C(0x0004)
523	/** Switch to ring-2. */
524	#define BS3_SYSCALL_TO_RING2 UINT16_C(0x0005)
525	/** Switch to ring-3. */
526	#define BS3_SYSCALL_TO_RING3 UINT16_C(0x0006)
527	/** @} */
528
529
530
531	/** @defgroup grp_bs3kit_system System structures
532	* @{ */
533	/** The GDT, indexed by BS3_SEL_XXX shifted by 3. */
534	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdt)[(BS3_SEL_GDT_LIMIT + 1) / 8];
535
536	extern X86DESC64 BS3_FAR_DATA BS3_DATA_NM(Bs3Gdt_Ldt); /*< @see BS3_SEL_LDT /
537	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss16); /*< @see BS3_SEL_TSS16 /
538	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss16DoubleFault); /*< @see BS3_SEL_TSS16_DF /
539	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss16Spare0); /*< @see BS3_SEL_TSS16_SPARE0 /
540	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss16Spare1); /*< @see BS3_SEL_TSS16_SPARE1 /
541	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss32); /*< @see BS3_SEL_TSS32 /
542	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss32DoubleFault); /*< @see BS3_SEL_TSS32_DF /
543	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss32Spare0); /*< @see BS3_SEL_TSS32_SPARE0 /
544	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss32Spare1); /*< @see BS3_SEL_TSS32_SPARE1 /
545	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss32IobpIntRedirBm); /*< @see BS3_SEL_TSS32_IOBP_IRB /
546	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss32IntRedirBm); /*< @see BS3_SEL_TSS32_IRB /
547	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss64); /*< @see BS3_SEL_TSS64 /
548	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss64Spare0); /*< @see BS3_SEL_TSS64_SPARE0 /
549	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss64Spare1); /*< @see BS3_SEL_TSS64_SPARE1 /
550	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_Tss64Iobp); /*< @see BS3_SEL_TSS64_IOBP /
551	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_MMIO16); /*< @see BS3_SEL_VMMDEV_MMIO16 /
552
553	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_First); /*< @see BS3_SEL_R0_FIRST /
554	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS16); /*< @see BS3_SEL_R0_CS16 /
555	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_DS16); /*< @see BS3_SEL_R0_DS16 /
556	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_SS16); /*< @see BS3_SEL_R0_SS16 /
557	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS32); /*< @see BS3_SEL_R0_CS32 /
558	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_DS32); /*< @see BS3_SEL_R0_DS32 /
559	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_SS32); /*< @see BS3_SEL_R0_SS32 /
560	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS64); /*< @see BS3_SEL_R0_CS64 /
561	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_DS64); /*< @see BS3_SEL_R0_DS64 /
562	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS16_EO); /*< @see BS3_SEL_R0_CS16_EO /
563	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS16_CNF); /*< @see BS3_SEL_R0_CS16_CNF /
564	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS16_CND_EO); /*< @see BS3_SEL_R0_CS16_CNF_EO /
565	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS32_EO); /*< @see BS3_SEL_R0_CS32_EO /
566	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS32_CNF); /*< @see BS3_SEL_R0_CS32_CNF /
567	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS32_CNF_EO); /*< @see BS3_SEL_R0_CS32_CNF_EO /
568	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS64_EO); /*< @see BS3_SEL_R0_CS64_EO /
569	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS64_CNF); /*< @see BS3_SEL_R0_CS64_CNF /
570	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R0_CS64_CNF_EO); /*< @see BS3_SEL_R0_CS64_CNF_EO /
571
572	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_First); /*< @see BS3_SEL_R1_FIRST /
573	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS16); /*< @see BS3_SEL_R1_CS16 /
574	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_DS16); /*< @see BS3_SEL_R1_DS16 /
575	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_SS16); /*< @see BS3_SEL_R1_SS16 /
576	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS32); /*< @see BS3_SEL_R1_CS32 /
577	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_DS32); /*< @see BS3_SEL_R1_DS32 /
578	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_SS32); /*< @see BS3_SEL_R1_SS32 /
579	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS64); /*< @see BS3_SEL_R1_CS64 /
580	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_DS64); /*< @see BS3_SEL_R1_DS64 /
581	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS16_EO); /*< @see BS3_SEL_R1_CS16_EO /
582	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS16_CNF); /*< @see BS3_SEL_R1_CS16_CNF /
583	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS16_CND_EO); /*< @see BS3_SEL_R1_CS16_CNF_EO /
584	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS32_EO); /*< @see BS3_SEL_R1_CS32_EO /
585	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS32_CNF); /*< @see BS3_SEL_R1_CS32_CNF /
586	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS32_CNF_EO); /*< @see BS3_SEL_R1_CS32_CNF_EO /
587	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS64_EO); /*< @see BS3_SEL_R1_CS64_EO /
588	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS64_CNF); /*< @see BS3_SEL_R1_CS64_CNF /
589	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R1_CS64_CNF_EO); /*< @see BS3_SEL_R1_CS64_CNF_EO /
590
591	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_First); /*< @see BS3_SEL_R2_FIRST /
592	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS16); /*< @see BS3_SEL_R2_CS16 /
593	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_DS16); /*< @see BS3_SEL_R2_DS16 /
594	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_SS16); /*< @see BS3_SEL_R2_SS16 /
595	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS32); /*< @see BS3_SEL_R2_CS32 /
596	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_DS32); /*< @see BS3_SEL_R2_DS32 /
597	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_SS32); /*< @see BS3_SEL_R2_SS32 /
598	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS64); /*< @see BS3_SEL_R2_CS64 /
599	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_DS64); /*< @see BS3_SEL_R2_DS64 /
600	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS16_EO); /*< @see BS3_SEL_R2_CS16_EO /
601	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS16_CNF); /*< @see BS3_SEL_R2_CS16_CNF /
602	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS16_CND_EO); /*< @see BS3_SEL_R2_CS16_CNF_EO /
603	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS32_EO); /*< @see BS3_SEL_R2_CS32_EO /
604	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS32_CNF); /*< @see BS3_SEL_R2_CS32_CNF /
605	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS32_CNF_EO); /*< @see BS3_SEL_R2_CS32_CNF_EO /
606	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS64_EO); /*< @see BS3_SEL_R2_CS64_EO /
607	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS64_CNF); /*< @see BS3_SEL_R2_CS64_CNF /
608	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R2_CS64_CNF_EO); /*< @see BS3_SEL_R2_CS64_CNF_EO /
609
610	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_First); /*< @see BS3_SEL_R3_FIRST /
611	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS16); /*< @see BS3_SEL_R3_CS16 /
612	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_DS16); /*< @see BS3_SEL_R3_DS16 /
613	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_SS16); /*< @see BS3_SEL_R3_SS16 /
614	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS32); /*< @see BS3_SEL_R3_CS32 /
615	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_DS32); /*< @see BS3_SEL_R3_DS32 /
616	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_SS32); /*< @see BS3_SEL_R3_SS32 /
617	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS64); /*< @see BS3_SEL_R3_CS64 /
618	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_DS64); /*< @see BS3_SEL_R3_DS64 /
619	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS16_EO); /*< @see BS3_SEL_R3_CS16_EO /
620	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS16_CNF); /*< @see BS3_SEL_R3_CS16_CNF /
621	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS16_CND_EO); /*< @see BS3_SEL_R3_CS16_CNF_EO /
622	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS32_EO); /*< @see BS3_SEL_R3_CS32_EO /
623	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS32_CNF); /*< @see BS3_SEL_R3_CS32_CNF /
624	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS32_CNF_EO); /*< @see BS3_SEL_R3_CS32_CNF_EO /
625	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS64_EO); /*< @see BS3_SEL_R3_CS64_EO /
626	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS64_CNF); /*< @see BS3_SEL_R3_CS64_CNF /
627	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_R3_CS64_CNF_EO); /*< @see BS3_SEL_R3_CS64_CNF_EO /
628
629	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare00); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_00 /
630	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare01); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_01 /
631	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare02); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_02 /
632	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare03); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_03 /
633	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare04); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_04 /
634	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare05); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_05 /
635	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare06); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_06 /
636	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare07); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_07 /
637	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare08); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_08 /
638	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare09); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_09 /
639	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare0a); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0a /
640	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare0b); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0b /
641	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare0c); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0c /
642	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare0d); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0d /
643	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare0e); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0e /
644	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare0f); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0f /
645	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare10); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_10 /
646	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare11); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_11 /
647	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare12); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_12 /
648	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare13); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_13 /
649	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare14); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_14 /
650	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare15); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_15 /
651	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare16); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_16 /
652	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare17); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_17 /
653	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare18); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_18 /
654	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare19); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_19 /
655	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare1a); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1a /
656	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare1b); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1b /
657	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare1c); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1c /
658	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare1d); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1d /
659	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare1e); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1e /
660	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteSpare1f); /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1f /
661
662	/** GDTs setting up the tiled 16-bit access to the first 16 MBs of memory.
663	* @see BS3_SEL_TILED, BS3_SEL_TILED_LAST, BS3_SEL_TILED_AREA_SIZE */
664	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteTiled)[256];
665	/** Free GDTes, part \#1. */
666	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteFreePart1)[64];
667	/** The BS3CODE16 GDT entry. @see BS3_SEL_TEXT16 */
668	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_CODE16);
669	/** Free GDTes, part \#2. */
670	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteFreePart2)[511];
671	/** The BS3SYSTEM16 GDT entry. */
672	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_SYSTEM16);
673	/** Free GDTes, part \#3. */
674	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdteFreePart3)[223];
675	/** The BS3DATA16 GDT entry. */
676	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Gdte_DATA16);
677	/** The end of the GDT (exclusive). */
678	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3GdtEnd);
679
680	/** The default 16-bit TSS. */
681	extern X86TSS16 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss16);
682	extern X86TSS16 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss16DoubleFault);
683	extern X86TSS16 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss16Spare0);
684	extern X86TSS16 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss16Spare1);
685	/** The default 32-bit TSS. */
686	extern X86TSS32 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss32);
687	extern X86TSS32 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss32DoubleFault);
688	extern X86TSS32 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss32Spare0);
689	extern X86TSS32 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss32Spare1);
690	/** The default 64-bit TSS. */
691	extern X86TSS64 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss64);
692	extern X86TSS64 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss64Spare0);
693	extern X86TSS64 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss64Spare1);
694	extern X86TSS64 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss64WithIopb);
695	extern X86TSS32 BS3_FAR_DATA BS3_DATA_NM(Bs3Tss32WithIopb);
696	/** Interrupt redirection bitmap used by Bs3Tss32WithIopb. */
697	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3SharedIntRedirBm)[32];
698	/** I/O permission bitmap used by Bs3Tss32WithIopb and Bs3Tss64WithIopb. */
699	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3SharedIobp)[8192+2];
700	/** End of the I/O permission bitmap (exclusive). */
701	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3SharedIobpEnd);
702	/** 16-bit IDT. */
703	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Idt16)[256];
704	/** 32-bit IDT. */
705	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Idt32)[256];
706	/** 64-bit IDT. */
707	extern X86DESC64 BS3_FAR_DATA BS3_DATA_NM(Bs3Idt64)[256];
708	/** Structure for the LIDT instruction for loading the 16-bit IDT. */
709	extern X86XDTR64 BS3_FAR_DATA BS3_DATA_NM(Bs3Lidt_Idt16);
710	/** Structure for the LIDT instruction for loading the 32-bit IDT. */
711	extern X86XDTR64 BS3_FAR_DATA BS3_DATA_NM(Bs3Lidt_Idt32);
712	/** Structure for the LIDT instruction for loading the 64-bit IDT. */
713	extern X86XDTR64 BS3_FAR_DATA BS3_DATA_NM(Bs3Lidt_Idt64);
714	/** Structure for the LIDT instruction for loading the real mode interrupt
715	* vector table.. */
716	extern X86XDTR64 BS3_FAR_DATA BS3_DATA_NM(Bs3Lidt_Ivt);
717	/** Structure for the LGDT instruction for loading the GDT. */
718	extern X86XDTR64 BS3_FAR_DATA BS3_DATA_NM(Bs3Lgdt_Gdt);
719	/** The LDT (all entries are empty, fill in for testing). */
720	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3Ldt)[118];
721	/** The end of the LDT (exclusive). */
722	extern X86DESC BS3_FAR_DATA BS3_DATA_NM(Bs3LdtEnd);
723
724	/** @} */
725
726
727	/** @name Segment start and end markers, sizes.
728	* @{ */
729	/** Start of the BS3TEXT16 segment. */
730	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Text16_StartOfSegment);
731	/** End of the BS3TEXT16 segment. */
732	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Text16_EndOfSegment);
733	/** The size of the BS3TEXT16 segment. */
734	extern uint16_t BS3_FAR_DATA BS3_DATA_NM(Bs3Text16_Size);
735
736	/** Start of the BS3SYSTEM16 segment. */
737	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3System16_StartOfSegment);
738	/** End of the BS3SYSTEM16 segment. */
739	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3System16_EndOfSegment);
740
741	/** Start of the BS3DATA16 segment. */
742	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Data16_StartOfSegment);
743	/** End of the BS3DATA16 segment. */
744	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Data16_EndOfSegment);
745
746	/** Start of the BS3TEXT32 segment. */
747	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Text32_StartOfSegment);
748	/** Start of the BS3TEXT32 segment. */
749	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Text32_EndOfSegment);
750
751	/** Start of the BS3DATA32 segment. */
752	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Data32_StartOfSegment);
753	/** Start of the BS3DATA32 segment. */
754	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Data32_EndOfSegment);
755
756	/** Start of the BS3TEXT64 segment. */
757	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Text64_StartOfSegment);
758	/** Start of the BS3TEXT64 segment. */
759	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Text64_EndOfSegment);
760
761	/** Start of the BS3DATA64 segment. */
762	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Data64_StartOfSegment);
763	/** Start of the BS3DATA64 segment. */
764	extern uint8_t BS3_FAR_DATA BS3_DATA_NM(Bs3Data64_EndOfSegment);
765
766	/** The size of the Data16, Text32, Text64, Data32 and Data64 blob. */
767	extern uint32_t BS3_FAR_DATA BS3_DATA_NM(Bs3Data16Thru64Text32And64_TotalSize);
768	/** The total image size (from Text16 thu Data64). */
769	extern uint32_t BS3_FAR_DATA BS3_DATA_NM(Bs3TotalImageSize);
770	/** @} */
771
772
773	/** Lower case hex digits. */
774	extern char const BS3_DATA_NM(g_achBs3HexDigits)[16+1];
775	/** Upper case hex digits. */
776	extern char const BS3_DATA_NM(g_achBs3HexDigitsUpper)[16+1];
777
778
779	/** The current mode (BS3_MODE_XXX) of CPU \#0. */
780	extern uint8_t BS3_DATA_NM(g_bBs3CurrentMode);
781
782
783	#ifdef __WATCOMC__
784	/**
785	* Executes the SMSW instruction and returns the value.
786	*
787	* @returns Machine status word.
788	*/
789	uint16_t Bs3AsmSmsw(void);
790	# pragma aux Bs3AsmSmsw = \
791	".286" \
792	"smsw ax" \
793	value [ax] modify exact [ax] nomemory;
794	#endif
795
796
797	/** @def BS3_IS_PROTECTED_MODE
798	* @returns true if protected mode, false if not. */
799	#if ARCH_BITS != 16
800	# define BS3_IS_PROTECTED_MODE() (true)
801	#else
802	# if 1
803	# define BS3_IS_PROTECTED_MODE() (!BS3_MODE_IS_RM_SYS(BS3_DATA_NM(g_bBs3CurrentMode)))
804	# else
805	# define BS3_IS_PROTECTED_MODE() (Bs3AsmSmsw() & 1 /PE/)
806	# endif
807	#endif
808
809
810	/** @defgroup bs3kit_cross_ptr Cross context pointer type
811	*
812	* The cross context pointer type is
813	*
814	* @{ */
815
816	/**
817	* Cross context pointer base type.
818	*/
819	#pragma pack(4)
820	typedef union BS3XPTR
821	{
822	/** The flat pointer. */
823	uint32_t uFlat;
824	/** 16-bit view. */
825	struct
826	{
827	uint16_t uLow;
828	uint16_t uHigh;
829	} u;
830	#if ARCH_BITS == 16
831	/** 16-bit near pointer. */
832	void __near *pvNear;
833	#elif ARCH_BITS == 32
834	/** 32-bit pointer. */
835	void *pvRaw;
836	#endif
837	} BS3XPTR;
838	#pragma pack()
839
840
841	/** @def BS3_XPTR_DEF_INTERNAL
842	* Internal worker.
843	*
844	* @param a_Scope RT_NOTHING if structure or global, static or extern
845	* otherwise.
846	* @param a_Type The type we're pointing to.
847	* @param a_Name The member or variable name.
848	* @internal
849	*/
850	#if ARCH_BITS == 16
851	# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
852	a_Scope union \
853	{ \
854	BS3XPTR XPtr; \
855	a_Type __near *pNearTyped; \
856	} a_Name
857	#elif ARCH_BITS == 32
858	# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
859	a_Scope union \
860	{ \
861	BS3XPTR XPtr; \
862	a_Type *pTyped; \
863	} a_Name
864	#elif ARCH_BITS == 64
865	# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
866	a_Scope union \
867	{ \
868	BS3XPTR XPtr; \
869	a_Type *pTyped; \
870	} a_Name
871	#else
872	# error "ARCH_BITS"
873	#endif
874
875	/** @def BS3_XPTR_DEF_MEMBER
876	* Defines a pointer member that can be shared by all CPU modes.
877	*
878	* @param a_Type The type we're pointing to.
879	* @param a_Name The member or variable name.
880	*/
881	#define BS3_XPTR_MEMBER(a_Type, a_Name) BS3_XPTR_DEF_INTERNAL(RT_NOTHING, a_Type, a_Name)
882
883	/** @def BS3_XPTR_DEF_AUTO
884	* Defines a pointer static variable for working with an XPTR.
885	*
886	* This is typically used to convert flat pointers into context specific
887	* pointers.
888	*
889	* @param a_Type The type we're pointing to.
890	* @param a_Name The member or variable name.
891	*/
892	#define BS3_XPTR_AUTO(a_Type, a_Name) BS3_XPTR_DEF_INTERNAL(RT_NOTHING, a_Type, a_Name)
893
894	/** @def BS3_XPTR_SET
895	* Sets a cross context pointer.
896	*
897	* @param a_Type The type we're pointing to.
898	* @param a_Name The member or variable name.
899	* @param a_uFlatPtr The flat pointer value to assign. If the x-pointer is
900	* used in real mode, this must be less than 1MB.
901	* Otherwise the limit is 16MB (due to selector tiling).
902	*/
903	#define BS3_XPTR_SET_FLAT(a_Type, a_Name, a_uFlatPtr) \
904	do { a_Name.XPtr.uFlat = (a_uFlatPtr); } while (0)
905
906	/** @def BS3_XPTR_GET_FLAT
907	* Gets the flat address of a cross context pointer.
908	*
909	* @returns 32-bit flat pointer.
910	* @param a_Type The type we're pointing to.
911	* @param a_Name The member or variable name.
912	*/
913	#define BS3_XPTR_GET_FLAT(a_Type, a_Name) (a_Name.XPtr.uFlat)
914
915	/** @def BS3_XPTR_GET_FLAT_LOW
916	* Gets the low 16 bits of the flat address.
917	*
918	* @returns Low 16 bits of the flat pointer.
919	* @param a_Type The type we're pointing to.
920	* @param a_Name The member or variable name.
921	*/
922	#define BS3_XPTR_GET_FLAT_LOW(a_Type, a_Name) (a_Name.XPtr.u.uLow)
923
924
925	#if ARCH_BITS == 16
926
927	/**
928	* Gets the current ring number.
929	* @returns Ring number.
930	*/
931	DECLINLINE(uint16_t) Bs3Sel16GetCurRing(void);
932	# pragma aux Bs3Sel16GetCurRing = \
933	"mov ax, ss" \
934	"and ax, 3" \
935	value [ax] modify exact [ax] nomemory;
936
937	/**
938	* Converts the high word of a flat pointer into a 16-bit selector.
939	*
940	* This makes use of the tiled area. It also handles real mode.
941	*
942	* @returns Segment selector value.
943	* @param uHigh The high part of flat pointer.
944	* @sa BS3_XPTR_GET, BS3_XPTR_SET
945	*/
946	DECLINLINE(__segment) Bs3Sel16HighFlatPtrToSelector(uint16_t uHigh)
947	{
948	if (BS3_IS_PROTECTED_MODE())
949	return (__segment)(((uHigh << 3) + BS3_SEL_TILED) \| Bs3Sel16GetCurRing());
950	return (__segment)(uHigh << 12);
951	}
952
953	#endif /* ARCH_BITS == 16*/
954
955	/** @def BS3_XPTR_GET
956	* Gets the current context pointer value.
957	*
958	* @returns Usable pointer.
959	* @param a_Type The type we're pointing to.
960	* @param a_Name The member or variable name.
961	*/
962	#if ARCH_BITS == 16
963	# define BS3_XPTR_GET(a_Type, a_Name) \
964	((a_Type BS3_FAR *)BS3_FP_MAKE(Bs3Sel16HighFlatPtrToSelector((a_Name).XPtr.u.uHigh), (a_Name).pNearTyped))
965	#elif ARCH_BITS == 32
966	# define BS3_XPTR_GET(a_Type, a_Name) ((a_Name).pTyped)
967	#elif ARCH_BITS == 64
968	# define BS3_XPTR_GET(a_Type, a_Name) ((a_Type *)(uintptr_t)(a_Name).XPtr.uFlat)
969	#else
970	# error "ARCH_BITS"
971	#endif
972
973	/** @def BS3_XPTR_SET
974	* Gets the current context pointer value.
975	*
976	* @returns Usable pointer.
977	* @param a_Type The type we're pointing to.
978	* @param a_Name The member or variable name.
979	* @param a_pValue The new pointer value, current context pointer.
980	*/
981	#if ARCH_BITS == 16
982	# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
983	do { \
984	a_Type BS3_FAR *pTypeCheck = (a_pValue); \
985	if (BS3_IS_PROTECTED_MODE()) \
986	{ \
987	(a_Name).XPtr.u.uLow = BS3_FP_OFF(pTypeCheck); \
988	(a_Name).XPtr.u.uHigh = ((BS3_FP_SEG(pTypeCheck) & UINT16_C(0xfff8)) - BS3_SEL_TILED) >> 3; \
989	} \
990	else \
991	(a_Name).XPtr.uFlat = BS3_FP_OFF(pTypeCheck) + ((uint32_t)BS3_FP_SEG(pTypeCheck) << 4); \
992	} while (0)
993	#elif ARCH_BITS == 32
994	# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
995	do { (a_Name).pTyped = (a_pValue); } while (0)
996	#elif ARCH_BITS == 64
997	# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
998	do { \
999	a_Type *pTypeCheck = (a_pValue); \
1000	(a_Name).XPtr.uFlat = (uint32_t)(uintptr_t)pTypeCheck; \
1001	} while (0)
1002	#else
1003	# error "ARCH_BITS"
1004	#endif
1005
1006
1007	/** @def BS3_XPTR_IS_NULL
1008	* Checks if the cross context pointer is NULL.
1009	*
1010	* @returns true if NULL, false if not.
1011	* @param a_Type The type we're pointing to.
1012	* @param a_Name The member or variable name.
1013	*/
1014	#define BS3_XPTR_IS_NULL(a_Type, a_Name) ((a_Name).XPtr.uFlat == 0)
1015	/** @} */
1016
1017
1018
1019	/** @defgroup grp_bs3kit_cmn Common Functions and Data
1020	*
1021	* The common functions comes in three variations: 16-bit, 32-bit and 64-bit.
1022	* Templated code uses the #BS3_CMN_NM macro to mangle the name according to the
1023	* desired
1024	*
1025	* @{
1026	*/
1027
1028	#ifdef BS3_STRICT
1029	# define BS3_ASSERT(a_Expr) do { if (!!(a_Expr)) { /* likely / } else { Bs3Panic(); } } while (0) /< @todo later /
1030	#else
1031	# define BS3_ASSERT(a_Expr) do { } while (0)
1032	#endif
1033
1034	/**
1035	* Panic, never return.
1036	*
1037	* The current implementation will only halt the CPU.
1038	*/
1039	BS3_DECL(void) Bs3Panic_c16(void);
1040	BS3_DECL(void) Bs3Panic_c32(void); /*< @copydoc Bs3Panic_c16 /
1041	BS3_DECL(void) Bs3Panic_c64(void); /*< @copydoc Bs3Panic_c16 /
1042	#define Bs3Panic BS3_CMN_NM(Bs3Panic) /*< Selects #Bs3Panic_c16, #Bs3Panic_c32 or #Bs3Panic_c64. /
1043
1044	/**
1045	* Shutdown the system, never returns.
1046	*
1047	* This currently only works for VMs. When running on real systems it will
1048	* just halt the CPU.
1049	*/
1050	BS3_DECL(void) Bs3Shutdown_c16(void);
1051	BS3_DECL(void) Bs3Shutdown_c32(void); /*< @copydoc Bs3Shutdown_c16 /
1052	BS3_DECL(void) Bs3Shutdown_c64(void); /*< @copydoc Bs3Shutdown_c16 /
1053	#define Bs3Shutdown BS3_CMN_NM(Bs3Shutdown) /*< Selects #Bs3Shutdown_c16, #Bs3Shutdown_c32 or #Bs3Shutdown_c64. /
1054
1055	/**
1056	* Prints a 32-bit unsigned value as decimal to the screen.
1057	*
1058	* @param uValue The 32-bit value.
1059	*/
1060	BS3_DECL(void) Bs3PrintU32_c16(uint32_t uValue);
1061	BS3_DECL(void) Bs3PrintU32_c32(uint32_t uValue); /*< @copydoc Bs3PrintU32_c16 /
1062	BS3_DECL(void) Bs3PrintU32_c64(uint32_t uValue); /*< @copydoc Bs3PrintU32_c16 /
1063	#define Bs3PrintU32 BS3_CMN_NM(Bs3PrintU32) /*< Selects #Bs3PrintU32_c16, #Bs3PrintU32_c32 or #Bs3PrintU32_c64. /
1064
1065	/**
1066	* Prints a 32-bit unsigned value as hex to the screen.
1067	*
1068	* @param uValue The 32-bit value.
1069	*/
1070	BS3_DECL(void) Bs3PrintX32_c16(uint32_t uValue);
1071	BS3_DECL(void) Bs3PrintX32_c32(uint32_t uValue); /*< @copydoc Bs3PrintX32_c16 /
1072	BS3_DECL(void) Bs3PrintX32_c64(uint32_t uValue); /*< @copydoc Bs3PrintX32_c16 /
1073	#define Bs3PrintX32 BS3_CMN_NM(Bs3PrintX32) /*< Selects #Bs3PrintX32_c16, #Bs3PrintX32_c32 or #Bs3PrintX32_c64. /
1074
1075	/**
1076	* Formats and prints a string to the screen.
1077	*
1078	* See #Bs3StrFormatV_c16 for supported format types.
1079	*
1080	* @param pszFormat The format string.
1081	* @param ... Format arguments.
1082	*/
1083	BS3_DECL(size_t) Bs3Printf_c16(const char BS3_FAR *pszFormat, ...);
1084	BS3_DECL(size_t) Bs3Printf_c32(const char BS3_FAR pszFormat, ...); /< @copydoc Bs3Printf_c16 /
1085	BS3_DECL(size_t) Bs3Printf_c64(const char BS3_FAR pszFormat, ...); /< @copydoc Bs3Printf_c16 /
1086	#define Bs3Printf BS3_CMN_NM(Bs3Printf) /*< Selects #Bs3Printf_c16, #Bs3Printf_c32 or #Bs3Printf_c64. /
1087
1088	/**
1089	* Formats and prints a string to the screen, va_list version.
1090	*
1091	* See #Bs3Format_c16 for supported format types.
1092	*
1093	* @param pszFormat The format string.
1094	* @param va Format arguments.
1095	*/
1096	BS3_DECL(size_t) Bs3PrintfV_c16(const char BS3_FAR *pszFormat, va_list va);
1097	BS3_DECL(size_t) Bs3PrintfV_c32(const char BS3_FAR pszFormat, va_list va); /< @copydoc Bs3PrintfV_c16 /
1098	BS3_DECL(size_t) Bs3PrintfV_c64(const char BS3_FAR pszFormat, va_list va); /< @copydoc Bs3PrintfV_c16 /
1099	#define Bs3PrintfV BS3_CMN_NM(Bs3PrintfV) /*< Selects #Bs3PrintfV_c16, #Bs3PrintfV_c32 or #Bs3PrintfV_c64. /
1100
1101	/**
1102	* Prints a string to the screen.
1103	*
1104	* @param pszString The string to print.
1105	*/
1106	BS3_DECL(void) Bs3PrintStr_c16(const char BS3_FAR *pszString);
1107	BS3_DECL(void) Bs3PrintStr_c32(const char BS3_FAR pszString); /< @copydoc Bs3PrintStr_c16 /
1108	BS3_DECL(void) Bs3PrintStr_c64(const char BS3_FAR pszString); /< @copydoc Bs3PrintStr_c16 /
1109	#define Bs3PrintStr BS3_CMN_NM(Bs3PrintStr) /*< Selects #Bs3PrintStr_c16, #Bs3PrintStr_c32 or #Bs3PrintStr_c64. /
1110
1111	/**
1112	* Prints a char to the screen.
1113	*
1114	* @param ch The character to print.
1115	*/
1116	BS3_DECL(void) Bs3PrintChr_c16(char ch);
1117	BS3_DECL(void) Bs3PrintChr_c32(char ch); /*< @copydoc Bs3PrintChr_c16 /
1118	BS3_DECL(void) Bs3PrintChr_c64(char ch); /*< @copydoc Bs3PrintChr_c16 /
1119	#define Bs3PrintChr BS3_CMN_NM(Bs3PrintChr) /*< Selects #Bs3PrintChr_c16, #Bs3PrintChr_c32 or #Bs3PrintChr_c64. /
1120
1121
1122	/**
1123	* An output function for #Bs3StrFormatV.
1124	*
1125	* @returns Number of characters written.
1126	* @param ch The character to write. Zero in the final call.
1127	* @param pvUser User argument supplied to #Bs3StrFormatV.
1128	*/
1129	typedef BS3_DECL_CALLBACK(size_t) FNBS3STRFORMATOUTPUT(char ch, void BS3_FAR *pvUser);
1130	/** Pointer to an output function for #Bs3StrFormatV. */
1131	typedef FNBS3STRFORMATOUTPUT *PFNBS3STRFORMATOUTPUT;
1132
1133	/**
1134	* Formats a string, sending the output to @a pfnOutput.
1135	*
1136	* Supported types:
1137	* - %RI8, %RI16, %RI32, %RI64
1138	* - %RU8, %RU16, %RU32, %RU64
1139	* - %RX8, %RX16, %RX32, %RX64
1140	* - %i, %d
1141	* - %u
1142	* - %x
1143	* - %c
1144	* - %p (far pointer)
1145	* - %s (far pointer)
1146	*
1147	* @returns Sum of @a pfnOutput return values.
1148	* @param pszFormat The format string.
1149	* @param va Format arguments.
1150	* @param pfnOutput The output function.
1151	* @param pvUser The user argument for the output function.
1152	*/
1153	BS3_DECL(size_t) Bs3StrFormatV_c16(const char BS3_FAR *pszFormat, va_list va,
1154	PFNBS3STRFORMATOUTPUT pfnOutput, void BS3_FAR *pvUser);
1155	/** @copydoc Bs3StrFormatV_c16 */
1156	BS3_DECL(size_t) Bs3StrFormatV_c32(const char BS3_FAR *pszFormat, va_list va,
1157	PFNBS3STRFORMATOUTPUT pfnOutput, void BS3_FAR *pvUser);
1158	/** @copydoc Bs3StrFormatV_c16 */
1159	BS3_DECL(size_t) Bs3StrFormatV_c64(const char BS3_FAR *pszFormat, va_list va,
1160	PFNBS3STRFORMATOUTPUT pfnOutput, void BS3_FAR *pvUser);
1161	#define Bs3StrFormatV BS3_CMN_NM(Bs3StrFormatV) /*< Selects #Bs3StrFormatV_c16, #Bs3StrFormatV_c32 or #Bs3StrFormatV_c64. /
1162
1163	/**
1164	* Formats a string into a buffer.
1165	*
1166	* See #Bs3Format_c16 for supported format types.
1167	*
1168	* @returns The length of the formatted string (excluding terminator).
1169	* This will be higher or equal to @c cbBuf in case of an overflow.
1170	* @param pszBuf The output buffer.
1171	* @param cbBuf The size of the output buffer.
1172	* @param pszFormat The format string.
1173	* @param va Format arguments.
1174	*/
1175	BS3_DECL(size_t) Bs3StrPrintfV_c16(char BS3_FAR pszBuf, size_t cbBuf, const char BS3_FAR pszFormat, va_list va);
1176	/** @copydoc Bs3StrPrintfV_c16 */
1177	BS3_DECL(size_t) Bs3StrPrintfV_c32(char BS3_FAR pszBuf, size_t cbBuf, const char BS3_FAR pszFormat, va_list va);
1178	/** @copydoc Bs3StrPrintfV_c16 */
1179	BS3_DECL(size_t) Bs3StrPrintfV_c64(char BS3_FAR pszBuf, size_t cbBuf, const char BS3_FAR pszFormat, va_list va);
1180	#define Bs3StrPrintfV BS3_CMN_NM(Bs3StrPrintfV) /*< Selects #Bs3StrPrintfV_c16, #Bs3StrPrintfV_c32 or #Bs3StrPrintfV_c64. /
1181
1182	/**
1183	* Formats a string into a buffer.
1184	*
1185	* See #Bs3Format_c16 for supported format types.
1186	*
1187	* @returns The length of the formatted string (excluding terminator).
1188	* This will be higher or equal to @c cbBuf in case of an overflow.
1189	* @param pszBuf The output buffer.
1190	* @param cbBuf The size of the output buffer.
1191	* @param pszFormat The format string.
1192	* @param ... Format arguments.
1193	*/
1194	BS3_DECL(size_t) Bs3StrPrintf_c16(char BS3_FAR pszBuf, size_t cbBuf, const char BS3_FAR pszFormat, ...);
1195	/** @copydoc Bs3StrPrintf_c16 */
1196	BS3_DECL(size_t) Bs3StrPrintf_c32(char BS3_FAR pszBuf, size_t cbBuf, const char BS3_FAR pszFormat, ...);
1197	/** @copydoc Bs3StrPrintf_c16 */
1198	BS3_DECL(size_t) Bs3StrPrintf_c64(char BS3_FAR pszBuf, size_t cbBuf, const char BS3_FAR pszFormat, ...);
1199	#define Bs3StrPrintf BS3_CMN_NM(Bs3StrPrintf) /*< Selects #Bs3StrPrintf_c16, #Bs3StrPrintf_c32 or #Bs3StrPrintf_c64. /
1200
1201
1202	/**
1203	* Finds the length of a zero terminated string.
1204	*
1205	* @returns String length in chars/bytes.
1206	* @param pszString The string to examine.
1207	*/
1208	BS3_DECL(size_t) Bs3StrLen_c16(const char BS3_FAR *pszString);
1209	BS3_DECL(size_t) Bs3StrLen_c32(const char BS3_FAR pszString); /* @copydoc Bs3StrLen_c16 */
1210	BS3_DECL(size_t) Bs3StrLen_c64(const char BS3_FAR pszString); /* @copydoc Bs3StrLen_c16 */
1211	#define Bs3StrLen BS3_CMN_NM(Bs3StrLen) /*< Selects #Bs3StrLen_c16, #Bs3StrLen_c32 or #Bs3StrLen_c64. /
1212
1213	/**
1214	* Finds the length of a zero terminated string, but with a max length.
1215	*
1216	* @returns String length in chars/bytes, or @a cchMax if no zero-terminator
1217	* was found before we reached the limit.
1218	* @param pszString The string to examine.
1219	* @param cchMax The max length to examine.
1220	*/
1221	BS3_DECL(size_t) Bs3StrNLen_c16(const char BS3_FAR *pszString, size_t cchMax);
1222	BS3_DECL(size_t) Bs3StrNLen_c32(const char BS3_FAR pszString, size_t cchMax); /* @copydoc Bs3StrNLen_c16 */
1223	BS3_DECL(size_t) Bs3StrNLen_c64(const char BS3_FAR pszString, size_t cchMax); /* @copydoc Bs3StrNLen_c16 */
1224	#define Bs3StrNLen BS3_CMN_NM(Bs3StrNLen) /*< Selects #Bs3StrNLen_c16, #Bs3StrNLen_c32 or #Bs3StrNLen_c64. /
1225
1226	/**
1227	* CRT style unsafe strcpy.
1228	*
1229	* @returns pszDst.
1230	* @param pszDst The destination buffer. Must be large enough to
1231	* hold the source string.
1232	* @param pszSrc The source string.
1233	*/
1234	BS3_DECL(char BS3_FAR ) Bs3StrCpy_c16(char BS3_FAR pszDst, const char BS3_FAR *pszSrc);
1235	BS3_DECL(char BS3_FAR ) Bs3StrCpy_c32(char BS3_FAR pszDst, const char BS3_FAR pszSrc); /* @copydoc Bs3StrCpy_c16 */
1236	BS3_DECL(char BS3_FAR ) Bs3StrCpy_c64(char BS3_FAR pszDst, const char BS3_FAR pszSrc); /* @copydoc Bs3StrCpy_c16 */
1237	#define Bs3StrCpy BS3_CMN_NM(Bs3StrCpy) /*< Selects #Bs3StrCpy_c16, #Bs3StrCpy_c32 or #Bs3StrCpy_c64. /
1238
1239	/**
1240	* CRT style memcpy.
1241	*
1242	* @returns pvDst
1243	* @param pvDst The destination buffer.
1244	* @param pvSrc The source buffer.
1245	* @param cbCopy The number of bytes to copy.
1246	*/
1247	BS3_DECL(void BS3_FAR ) Bs3MemCpy_c16(void BS3_FAR pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy);
1248	BS3_DECL(void BS3_FAR ) Bs3MemCpy_c32(void BS3_FAR pvDst, const void BS3_FAR pvSrc, size_t cbToCopy); /* @copydoc Bs3MemCpy_c16 */
1249	BS3_DECL(void BS3_FAR ) Bs3MemCpy_c64(void BS3_FAR pvDst, const void BS3_FAR pvSrc, size_t cbToCopy); /* @copydoc Bs3MemCpy_c16 */
1250	#define Bs3MemCpy BS3_CMN_NM(Bs3MemCpy) /*< Selects #Bs3MemCpy_c16, #Bs3MemCpy_c32 or #Bs3MemCpy_c64. /
1251
1252	/**
1253	* GNU (?) style mempcpy.
1254	*
1255	* @returns pvDst + cbCopy
1256	* @param pvDst The destination buffer.
1257	* @param pvSrc The source buffer.
1258	* @param cbCopy The number of bytes to copy.
1259	*/
1260	BS3_DECL(void BS3_FAR ) Bs3MemPCpy_c16(void BS3_FAR pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy);
1261	BS3_DECL(void BS3_FAR ) Bs3MemPCpy_c32(void BS3_FAR pvDst, const void BS3_FAR pvSrc, size_t cbToCopy); /* @copydoc Bs3MemPCpy_c16 */
1262	BS3_DECL(void BS3_FAR ) Bs3MemPCpy_c64(void BS3_FAR pvDst, const void BS3_FAR pvSrc, size_t cbToCopy); /* @copydoc Bs3MemPCpy_c16 */
1263	#define Bs3MemPCpy BS3_CMN_NM(Bs3MemPCpy) /*< Selects #Bs3MemPCpy_c16, #Bs3MemPCpy_c32 or #Bs3MemPCpy_c64. /
1264
1265	/**
1266	* CRT style memmove (overlapping buffers is fine).
1267	*
1268	* @returns pvDst
1269	* @param pvDst The destination buffer.
1270	* @param pvSrc The source buffer.
1271	* @param cbCopy The number of bytes to copy.
1272	*/
1273	BS3_DECL(void BS3_FAR ) Bs3MemMove_c16(void BS3_FAR pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy);
1274	BS3_DECL(void BS3_FAR ) Bs3MemMove_c32(void BS3_FAR pvDst, const void BS3_FAR pvSrc, size_t cbToCopy); /* @copydoc Bs3MemMove_c16 */
1275	BS3_DECL(void BS3_FAR ) Bs3MemMove_c64(void BS3_FAR pvDst, const void BS3_FAR pvSrc, size_t cbToCopy); /* @copydoc Bs3MemMove_c16 */
1276	#define Bs3MemMove BS3_CMN_NM(Bs3MemMove) /*< Selects #Bs3MemMove_c16, #Bs3MemMove_c32 or #Bs3MemMove_c64. /
1277
1278	/**
1279	* BSD style bzero.
1280	*
1281	* @param pvDst The buffer to be zeroed.
1282	* @param cbDst The number of bytes to zero.
1283	*/
1284	BS3_DECL(void) Bs3MemZero_c16(void BS3_FAR *pvDst, size_t cbDst);
1285	BS3_DECL(void) Bs3MemZero_c32(void BS3_FAR pvDst, size_t cbDst); /* @copydoc Bs3MemZero_c16 */
1286	BS3_DECL(void) Bs3MemZero_c64(void BS3_FAR pvDst, size_t cbDst); /* @copydoc Bs3MemZero_c16 */
1287	#define Bs3MemZero BS3_CMN_NM(Bs3MemZero) /*< Selects #Bs3MemZero_c16, #Bs3MemZero_c32 or #Bs3MemZero_c64. /
1288
1289
1290	/**
1291	* Converts a protected mode 32-bit far pointer to a 32-bit flat address.
1292	*
1293	* @returns 32-bit flat address.
1294	* @param off The segment offset.
1295	* @param uSel The protected mode segment selector.
1296	*/
1297	BS3_DECL(uint32_t) Bs3SelProtFar32ToFlat32_c16(uint32_t off, uint16_t uSel);
1298	BS3_DECL(uint32_t) Bs3SelProtFar32ToFlat32_c32(uint32_t off, uint16_t uSel); /*< @copydoc Bs3SelProtFar32ToFlat32_c16 /
1299	BS3_DECL(uint32_t) Bs3SelProtFar32ToFlat32_c64(uint32_t off, uint16_t uSel); /*< @copydoc Bs3SelProtFar32ToFlat32_c16 /
1300	#define Bs3SelProtFar32ToFlat32 BS3_CMN_NM(Bs3SelProtFar32ToFlat32) /*< Selects #Bs3SelProtFar32ToFlat32_c16, #Bs3SelProtFar32ToFlat32_c32 or #Bs3SelProtFar32ToFlat32_c64. /
1301
1302
1303	/**
1304	* Equivalent to RTTestCreate + RTTestBanner.
1305	*
1306	* @param pszTest The test name.
1307	*/
1308	BS3_DECL(void) Bs3TestInit_c16(const char BS3_FAR *pszTest);
1309	BS3_DECL(void) Bs3TestInit_c32(const char BS3_FAR pszTest); /< @copydoc Bs3TestInit_c16 /
1310	BS3_DECL(void) Bs3TestInit_c64(const char BS3_FAR pszTest); /< @copydoc Bs3TestInit_c16 /
1311	#define Bs3TestInit BS3_CMN_NM(Bs3TestInit) /*< Selects #Bs3TestInit_c16, #Bs3TestInit_c32 or #Bs3TestInit_c64. /
1312
1313
1314	/**
1315	* Equivalent to RTTestSummaryAndDestroy.
1316	*/
1317	BS3_DECL(void) Bs3TestTerm_c16(void);
1318	BS3_DECL(void) Bs3TestTerm_c32(void); /*< @copydoc Bs3TestTerm_c16 /
1319	BS3_DECL(void) Bs3TestTerm_c64(void); /*< @copydoc Bs3TestTerm_c16 /
1320	#define Bs3TestTerm BS3_CMN_NM(Bs3TestTerm) /*< Selects #Bs3TestTerm_c16, #Bs3TestTerm_c32 or #Bs3TestTerm_c64. /
1321
1322	/**
1323	* Equivalent to RTTestISub.
1324	*/
1325	BS3_DECL(void) Bs3TestSub_c16(const char BS3_FAR *pszSubTest);
1326	BS3_DECL(void) Bs3TestSub_c32(const char BS3_FAR pszSubTest); /< @copydoc Bs3TestSub_c16 /
1327	BS3_DECL(void) Bs3TestSub_c64(const char BS3_FAR pszSubTest); /< @copydoc Bs3TestSub_c16 /
1328	#define Bs3TestSub BS3_CMN_NM(Bs3TestSub) /*< Selects #Bs3TestSub_c16, #Bs3TestSub_c32 or #Bs3TestSub_c64. /
1329
1330	/**
1331	* Equivalent to RTTestIFailedF.
1332	*/
1333	BS3_DECL(void) Bs3TestSubF_c16(const char BS3_FAR *pszFormat, ...);
1334	BS3_DECL(void) Bs3TestSubF_c32(const char BS3_FAR pszFormat, ...); /< @copydoc Bs3TestSubF_c16 /
1335	BS3_DECL(void) Bs3TestSubF_c64(const char BS3_FAR pszFormat, ...); /< @copydoc Bs3TestSubF_c16 /
1336	#define Bs3TestSubF BS3_CMN_NM(Bs3TestSubF) /*< Selects #Bs3TestSubF_c16, #Bs3TestSubF_c32 or #Bs3TestSubF_c64. /
1337
1338	/**
1339	* Equivalent to RTTestISubV.
1340	*/
1341	BS3_DECL(void) Bs3TestSubV_c16(const char BS3_FAR *pszFormat, va_list va);
1342	BS3_DECL(void) Bs3TestSubV_c32(const char BS3_FAR pszFormat, va_list va); /< @copydoc Bs3TestSubV_c16 /
1343	BS3_DECL(void) Bs3TestSubV_c64(const char BS3_FAR pszFormat, va_list va); /< @copydoc Bs3TestSubV_c16 /
1344	#define Bs3TestSubV BS3_CMN_NM(Bs3TestSubV) /*< Selects #Bs3TestSubV_c16, #Bs3TestSubV_c32 or #Bs3TestSubV_c64. /
1345
1346	/**
1347	* Equivalent to RTTestISubDone.
1348	*/
1349	BS3_DECL(void) Bs3TestSubDone_c16(void);
1350	BS3_DECL(void) Bs3TestSubDone_c32(void); /*< @copydoc Bs3TestSubDone_c16 /
1351	BS3_DECL(void) Bs3TestSubDone_c64(void); /*< @copydoc Bs3TestSubDone_c16 /
1352	#define Bs3TestSubDone BS3_CMN_NM(Bs3TestSubDone) /*< Selects #Bs3TestSubDone_c16, #Bs3TestSubDone_c32 or #Bs3TestSubDone_c64. /
1353
1354	/**
1355	* Equivalent to RTTestSubErrorCount.
1356	*/
1357	BS3_DECL(uint16_t) Bs3TestSubErrorCount_c16(void);
1358	BS3_DECL(uint16_t) Bs3TestSubErrorCount_c32(void); /*< @copydoc Bs3TestSubErrorCount_c16 /
1359	BS3_DECL(uint16_t) Bs3TestSubErrorCount_c64(void); /*< @copydoc Bs3TestSubErrorCount_c16 /
1360	#define Bs3TestSubErrorCount BS3_CMN_NM(Bs3TestSubErrorCount) /*< Selects #Bs3TestSubErrorCount_c16, #Bs3TestSubErrorCount_c32 or #Bs3TestSubErrorCount_c64. /
1361
1362	/**
1363	* Equivalent to RTTestIFailed.
1364	*/
1365	BS3_DECL(void) Bs3TestFailed_c16(const char BS3_FAR *pszMessage);
1366	BS3_DECL(void) Bs3TestFailed_c32(const char BS3_FAR pszMessage); /< @copydoc Bs3TestFailed_c16 /
1367	BS3_DECL(void) Bs3TestFailed_c64(const char BS3_FAR pszMessage); /< @copydoc Bs3TestFailed_c16 /
1368	#define Bs3TestFailed BS3_CMN_NM(Bs3TestFailed) /*< Selects #Bs3TestFailed_c16, #Bs3TestFailed_c32 or #Bs3TestFailed_c64. /
1369
1370	/**
1371	* Equivalent to RTTestIFailedF.
1372	*/
1373	BS3_DECL(void) Bs3TestFailedF_c16(const char BS3_FAR *pszFormat, ...);
1374	BS3_DECL(void) Bs3TestFailedF_c32(const char BS3_FAR pszFormat, ...); /< @copydoc Bs3TestFailedF_c16 /
1375	BS3_DECL(void) Bs3TestFailedF_c64(const char BS3_FAR pszFormat, ...); /< @copydoc Bs3TestFailedF_c16 /
1376	#define Bs3TestFailedF BS3_CMN_NM(Bs3TestFailedF) /*< Selects #Bs3TestFailedF_c16, #Bs3TestFailedF_c32 or #Bs3TestFailedF_c64. /
1377
1378	/**
1379	* Equivalent to RTTestIFailedV.
1380	*/
1381	BS3_DECL(void) Bs3TestFailedV_c16(const char BS3_FAR *pszFormat, va_list va);
1382	BS3_DECL(void) Bs3TestFailedV_c32(const char BS3_FAR pszFormat, va_list va); /< @copydoc Bs3TestFailedV_c16 /
1383	BS3_DECL(void) Bs3TestFailedV_c64(const char BS3_FAR pszFormat, va_list va); /< @copydoc Bs3TestFailedV_c16 /
1384	#define Bs3TestFailedV BS3_CMN_NM(Bs3TestFailedV) /*< Selects #Bs3TestFailedV_c16, #Bs3TestFailedV_c32 or #Bs3TestFailedV_c64. /
1385
1386	/**
1387	* Equivalent to RTTestISkipped.
1388	*
1389	* @param pszWhy Optional reason why it's being skipped.
1390	*/
1391	BS3_DECL(void) Bs3TestSkipped_c16(const char BS3_FAR *pszWhy);
1392	BS3_DECL(void) Bs3TestSkipped_c32(const char BS3_FAR pszWhy); /< @copydoc Bs3TestSkipped_c16 /
1393	BS3_DECL(void) Bs3TestSkipped_c64(const char BS3_FAR pszWhy); /< @copydoc Bs3TestSkipped_c16 /
1394	#define Bs3TestSkipped BS3_CMN_NM(Bs3TestSkipped) /*< Selects #Bs3TestSkipped_c16, #Bs3TestSkipped_c32 or #Bs3TestSkipped_c64. /
1395
1396	/**
1397	* Equivalent to RTTestISkippedF.
1398	*
1399	* @param pszFormat Optional reason why it's being skipped.
1400	* @param ... Format arguments.
1401	*/
1402	BS3_DECL(void) Bs3TestSkippedF_c16(const char BS3_FAR *pszFormat, ...);
1403	BS3_DECL(void) Bs3TestSkippedF_c32(const char BS3_FAR pszFormat, ...); /< @copydoc Bs3TestSkippedF_c16 /
1404	BS3_DECL(void) Bs3TestSkippedF_c64(const char BS3_FAR pszFormat, ...); /< @copydoc Bs3TestSkippedF_c16 /
1405	#define Bs3TestSkippedF BS3_CMN_NM(Bs3TestSkippedF) /*< Selects #Bs3TestSkippedF_c16, #Bs3TestSkippedF_c32 or #Bs3TestSkippedF_c64. /
1406
1407	/**
1408	* Equivalent to RTTestISkippedV.
1409	*
1410	* @param pszFormat Optional reason why it's being skipped.
1411	* @param va Format arguments.
1412	*/
1413	BS3_DECL(void) Bs3TestSkippedV_c16(const char BS3_FAR *pszFormat, va_list va);
1414	BS3_DECL(void) Bs3TestSkippedV_c32(const char BS3_FAR pszFormat, va_list va); /< @copydoc Bs3TestSkippedV_c16 /
1415	BS3_DECL(void) Bs3TestSkippedV_c64(const char BS3_FAR pszFormat, va_list va); /< @copydoc Bs3TestSkippedV_c16 /
1416	#define Bs3TestSkippedV BS3_CMN_NM(Bs3TestSkippedV) /*< Selects #Bs3TestSkippedV_c16, #Bs3TestSkippedV_c32 or #Bs3TestSkippedV_c64. /
1417
1418
1419	/**
1420	* Performs the testing for the given mode.
1421	*
1422	* This is called with the CPU already switch to that mode.
1423	*
1424	* @returns 0 on success or directly Bs3TestFailed calls, non-zero to indicate
1425	* where the test when wrong.
1426	* @param bMode The current CPU mode.
1427	*/
1428	typedef BS3_DECL_CALLBACK(uint8_t) FNBS3TESTDOMODE(uint8_t bMode);
1429	/** Near pointer to a test (for 16-bit code). */
1430	typedef FNBS3TESTDOMODE *PFNBS3TESTDOMODE;
1431	/** Far pointer to a test (for 32-bit and 64-bit code, will be flatten). */
1432	typedef FNBS3TESTDOMODE BS3_FAR_CODE *FPFNBS3TESTDOMODE;
1433
1434	/**
1435	* Mode sub-test entry.
1436	*
1437	* This can only be passed around to functions with the same bit count, as it
1438	* contains function pointers. In 16-bit mode, the 16-bit pointers are near and
1439	* implies BS3TEXT16, whereas the 32-bit and 64-bit pointers are far real mode
1440	* addresses that will be converted to flat address prior to calling them.
1441	* Similarly, in 32-bit and 64-bit the addresses are all flat and the 16-bit
1442	* ones will be converted to BS3TEXT16 based addresses prior to calling.
1443	*/
1444	typedef struct BS3TESTMODEENTRY
1445	{
1446	const char * BS3_FAR pszSubTest;
1447
1448	PFNBS3TESTDOMODE pfnDoRM;
1449
1450	PFNBS3TESTDOMODE pfnDoPE16;
1451	FPFNBS3TESTDOMODE pfnDoPE16_32;
1452	PFNBS3TESTDOMODE pfnDoPE16_V86;
1453	FPFNBS3TESTDOMODE pfnDoPE32;
1454	PFNBS3TESTDOMODE pfnDoPE32_16;
1455	PFNBS3TESTDOMODE pfnDoPEV86;
1456
1457	PFNBS3TESTDOMODE pfnDoPP16;
1458	FPFNBS3TESTDOMODE pfnDoPP16_32;
1459	PFNBS3TESTDOMODE pfnDoPP16_V86;
1460	FPFNBS3TESTDOMODE pfnDoPP32;
1461	PFNBS3TESTDOMODE pfnDoPP32_16;
1462	PFNBS3TESTDOMODE pfnDoPPV86;
1463
1464	PFNBS3TESTDOMODE pfnDoPAE16;
1465	FPFNBS3TESTDOMODE pfnDoPAE16_32;
1466	PFNBS3TESTDOMODE pfnDoPAE16_V86;
1467	FPFNBS3TESTDOMODE pfnDoPAE32;
1468	PFNBS3TESTDOMODE pfnDoPAE32_16;
1469	PFNBS3TESTDOMODE pfnDoPAEV86;
1470
1471	PFNBS3TESTDOMODE pfnDoLM16;
1472	FPFNBS3TESTDOMODE pfnDoLM32;
1473	FPFNBS3TESTDOMODE pfnDoLM64;
1474
1475	} BS3TESTMODEENTRY;
1476	/** Pointer to a mode sub-test entry. */
1477	typedef BS3TESTMODEENTRY const *PCBS3TESTMODEENTRY;
1478
1479	/** Produces a BS3TESTMODEENTRY initializer for common (c16,c32,c64) test
1480	* functions. */
1481	#define BS3TESTMODEENTRY_CMN(a_szTest, a_BaseNm) \
1482	{ /pszSubTest =/ a_szTest, \
1483	/RM/ RT_CONCAT(a_BaseNm, _c16), \
1484	/PE16/ RT_CONCAT(a_BaseNm, _c16), \
1485	/PE16_32/ RT_CONCAT(a_BaseNm, _c32), \
1486	/PE16_V86/ RT_CONCAT(a_BaseNm, _c16), \
1487	/PE32/ RT_CONCAT(a_BaseNm, _c32), \
1488	/PE32_16/ RT_CONCAT(a_BaseNm, _c16), \
1489	/PEV86/ RT_CONCAT(a_BaseNm, _c16), \
1490	/PP16/ RT_CONCAT(a_BaseNm, _c16), \
1491	/PP16_32/ RT_CONCAT(a_BaseNm, _c32), \
1492	/PP16_V86/ RT_CONCAT(a_BaseNm, _c16), \
1493	/PP32/ RT_CONCAT(a_BaseNm, _c32), \
1494	/PP32_16/ RT_CONCAT(a_BaseNm, _c16), \
1495	/PPV86/ RT_CONCAT(a_BaseNm, _c16), \
1496	/PAE16/ RT_CONCAT(a_BaseNm, _c16), \
1497	/PAE16_32/ RT_CONCAT(a_BaseNm, _c32), \
1498	/PAE16_V86/ RT_CONCAT(a_BaseNm, _c16), \
1499	/PAE32/ RT_CONCAT(a_BaseNm, _c32), \
1500	/PAE32_16/ RT_CONCAT(a_BaseNm, _c16), \
1501	/PAEV86/ RT_CONCAT(a_BaseNm, _c16), \
1502	/LM16/ RT_CONCAT(a_BaseNm, _c16), \
1503	/LM32/ RT_CONCAT(a_BaseNm, _c32), \
1504	/LM64/ RT_CONCAT(a_BaseNm, _c64), \
1505	}
1506
1507	/** Produces a BS3TESTMODEENTRY initializer for a full set of mode test
1508	* functions. */
1509	#define BS3TESTMODEENTRY_MODE(a_szTest, a_BaseNm) \
1510	{ /pszSubTest =/ a_szTest, \
1511	/RM/ RT_CONCAT(a_BaseNm, _rm), \
1512	/PE16/ RT_CONCAT(a_BaseNm, _pe16), \
1513	/PE16_32/ RT_CONCAT(a_BaseNm, _pe16_32), \
1514	/PE16_V86/ RT_CONCAT(a_BaseNm, _pe16_v86), \
1515	/PE32/ RT_CONCAT(a_BaseNm, _pe32), \
1516	/PE32_16/ RT_CONCAT(a_BaseNm, _pe32_16), \
1517	/PEV86/ RT_CONCAT(a_BaseNm, _pev86), \
1518	/PP16/ RT_CONCAT(a_BaseNm, _pp16), \
1519	/PP16_32/ RT_CONCAT(a_BaseNm, _pp16_32), \
1520	/PP16_V86/ RT_CONCAT(a_BaseNm, _pp16_v86), \
1521	/PP32/ RT_CONCAT(a_BaseNm, _pp32), \
1522	/PP32_16/ RT_CONCAT(a_BaseNm, _pp32_16), \
1523	/PPV86/ RT_CONCAT(a_BaseNm, _ppev86), \
1524	/PAE16/ RT_CONCAT(a_BaseNm, _pae16), \
1525	/PAE16_32/ RT_CONCAT(a_BaseNm, _pae16_32), \
1526	/PAE16_V86/ RT_CONCAT(a_BaseNm, _pae16_v86), \
1527	/PAE32/ RT_CONCAT(a_BaseNm, _pae32), \
1528	/PAE32_16/ RT_CONCAT(a_BaseNm, _pae32_16), \
1529	/PAEV86/ RT_CONCAT(a_BaseNm, _paev86), \
1530	/LM16/ RT_CONCAT(a_BaseNm, _lm16), \
1531	/LM32/ RT_CONCAT(a_BaseNm, _lm32), \
1532	/LM64/ RT_CONCAT(a_BaseNm, _lm64), \
1533	}
1534
1535
1536	/**
1537	* Slab control structure list head.
1538	*
1539	* The slabs on the list must all have the same chunk size.
1540	*/
1541	typedef struct BS3SLABHEAD
1542	{
1543	/** Pointer to the first slab. */
1544	BS3_XPTR_MEMBER(struct BS3SLABCTL, pFirst);
1545	/** The allocation chunk size. */
1546	uint16_t cbChunk;
1547	/** Number of slabs in the list. */
1548	uint16_t cSlabs;
1549	/** Number of chunks in the list. */
1550	uint32_t cChunks;
1551	/** Number of free chunks. */
1552	uint32_t cFreeChunks;
1553	} BS3SLABHEAD;
1554	/** Pointer to a slab list head. */
1555	typedef BS3SLABHEAD BS3_FAR *PBS3SLABHEAD;
1556
1557	/**
1558	* Allocation slab control structure.
1559	*
1560	* This may live at the start of the slab for 4KB slabs, while in a separate
1561	* static location for the larger ones.
1562	*/
1563	typedef struct BS3SLABCTL
1564	{
1565	/** Pointer to the next slab control structure in this list. */
1566	BS3_XPTR_MEMBER(struct BS3SLABCTL, pNext);
1567	/** Pointer to the slab list head. */
1568	BS3_XPTR_MEMBER(BS3SLABHEAD, pHead);
1569	/** The base address of the slab. */
1570	BS3_XPTR_MEMBER(uint8_t, pbStart);
1571	/** Number of chunks in this slab. */
1572	uint16_t cChunks;
1573	/** Number of currently free chunks. */
1574	uint16_t cFreeChunks;
1575	/** The chunk size. */
1576	uint16_t cbChunk;
1577	/** The shift count corresponding to cbChunk.
1578	* This is for turning a chunk number into a byte offset and vice versa. */
1579	uint16_t cChunkShift;
1580	/** Bitmap where set bits indicates allocated blocks (variable size,
1581	* multiple of 4). */
1582	uint8_t bmAllocated[4];
1583	} BS3SLABCTL;
1584	/** Pointer to a bs3kit slab control structure. */
1585	typedef BS3SLABCTL BS3_FAR *PBS3SLABCTL;
1586
1587	/** The chunks must all be in the same 16-bit segment tile. */
1588	#define BS3_SLAB_ALLOC_F_SAME_TILE UINT16_C(0x0001)
1589
1590	/**
1591	* Initializes a slab.
1592	*
1593	* @param pSlabCtl The slab control structure to initialize.
1594	* @param cbSlabCtl The size of the slab control structure.
1595	* @param uFlatSlabPtr The base address of the slab.
1596	* @param cbSlab The size of the slab.
1597	* @param cbChunk The chunk size.
1598	*/
1599	BS3_DECL(void) Bs3SlabInit_c16(PBS3SLABCTL pSlabCtl, size_t cbSlabCtl, uint32_t uFlatSlabPtr, uint32_t cbSlab, uint16_t cbChunk);
1600	/** @copydoc Bs3SlabInit_c16 */
1601	BS3_DECL(void) Bs3SlabInit_c32(PBS3SLABCTL pSlabCtl, size_t cbSlabCtl, uint32_t uFlatSlabPtr, uint32_t cbSlab, uint16_t cbChunk);
1602	/** @copydoc Bs3SlabInit_c16 */
1603	BS3_DECL(void) Bs3SlabInit_c64(PBS3SLABCTL pSlabCtl, size_t cbSlabCtl, uint32_t uFlatSlabPtr, uint32_t cbSlab, uint16_t cbChunk);
1604	#define Bs3SlabInit BS3_CMN_NM(Bs3SlabInit) /*< Selects #Bs3SlabInit_c16, #Bs3SlabInit_c32 or #Bs3SlabInit_c64. /
1605
1606	/**
1607	* Allocates one chunk from a slab.
1608	*
1609	* @returns Pointer to a chunk on success, NULL if we're out of chunks.
1610	* @param pSlabCtl The slab constrol structure to allocate from.
1611	*/
1612	BS3_DECL(void BS3_FAR *) Bs3SlabAlloc_c16(PBS3SLABCTL pSlabCtl);
1613	BS3_DECL(void BS3_FAR ) Bs3SlabAlloc_c32(PBS3SLABCTL pSlabCtl); /< @copydoc Bs3SlabAlloc_c16 /
1614	BS3_DECL(void BS3_FAR ) Bs3SlabAlloc_c64(PBS3SLABCTL pSlabCtl); /< @copydoc Bs3SlabAlloc_c16 /
1615	#define Bs3SlabAlloc BS3_CMN_NM(Bs3SlabAlloc) /*< Selects #Bs3SlabAlloc_c16, #Bs3SlabAlloc_c32 or #Bs3SlabAlloc_c64. /
1616
1617	/**
1618	* Allocates one or more chunks rom a slab.
1619	*
1620	* @returns Pointer to the request number of chunks on success, NULL if we're
1621	* out of chunks.
1622	* @param pSlabCtl The slab constrol structure to allocate from.
1623	* @param cChunks The number of contiguous chunks we want.
1624	* @param fFlags Flags, see BS3_SLAB_ALLOC_F_XXX
1625	*/
1626	BS3_DECL(void BS3_FAR *) Bs3SlabAllocEx_c16(PBS3SLABCTL pSlabCtl, uint16_t cChunks, uint16_t fFlags);
1627	BS3_DECL(void BS3_FAR ) Bs3SlabAllocEx_c32(PBS3SLABCTL pSlabCtl, uint16_t cChunks, uint16_t fFlags); /< @copydoc Bs3SlabAllocEx_c16 /
1628	BS3_DECL(void BS3_FAR ) Bs3SlabAllocEx_c64(PBS3SLABCTL pSlabCtl, uint16_t cChunks, uint16_t fFlags); /< @copydoc Bs3SlabAllocEx_c16 /
1629	#define Bs3SlabAllocEx BS3_CMN_NM(Bs3SlabAllocEx) /*< Selects #Bs3SlabAllocEx_c16, #Bs3SlabAllocEx_c32 or #Bs3SlabAllocEx_c64. /
1630
1631	/**
1632	* Frees one or more chunks from a slab.
1633	*
1634	* @returns Number of chunks actually freed. When correctly used, this will
1635	* match the @a cChunks parameter, of course.
1636	* @param pSlabCtl The slab constrol structure to free from.
1637	* @param uFlatChunkPtr The flat address of the chunks to free.
1638	* @param cChunks The number of contiguous chunks to free.
1639	*/
1640	BS3_DECL(uint16_t) Bs3SlabFree_c16(PBS3SLABCTL pSlabCtl, uint32_t uFlatChunkPtr, uint16_t cChunks);
1641	BS3_DECL(uint16_t) Bs3SlabFree_c32(PBS3SLABCTL pSlabCtl, uint32_t uFlatChunkPtr, uint16_t cChunks); /*< @copydoc Bs3SlabFree_c16 /
1642	BS3_DECL(uint16_t) Bs3SlabFree_c64(PBS3SLABCTL pSlabCtl, uint32_t uFlatChunkPtr, uint16_t cChunks); /*< @copydoc Bs3SlabFree_c16 /
1643	#define Bs3SlabFree BS3_CMN_NM(Bs3SlabFree) /*< Selects #Bs3SlabFree_c16, #Bs3SlabFree_c32 or #Bs3SlabFree_c64. /
1644
1645
1646	/**
1647	* Initializes the given slab list head.
1648	*
1649	* @param pHead The slab list head.
1650	* @param cbChunk The chunk size.
1651	*/
1652	BS3_DECL(void) Bs3SlabListInit_c16(PBS3SLABHEAD pHead, uint16_t cbChunk);
1653	BS3_DECL(void) Bs3SlabListInit_c32(PBS3SLABHEAD pHead, uint16_t cbChunk); /*< @copydoc Bs3SlabListInit_c16 /
1654	BS3_DECL(void) Bs3SlabListInit_c64(PBS3SLABHEAD pHead, uint16_t cbChunk); /*< @copydoc Bs3SlabListInit_c16 /
1655	#define Bs3SlabListInit BS3_CMN_NM(Bs3SlabListInit) /*< Selects #Bs3SlabListInit_c16, #Bs3SlabListInit_c32 or #Bs3SlabListInit_c64. /
1656
1657	/**
1658	* Adds an initialized slab control structure to the list.
1659	*
1660	* @param pHead The slab list head to add it to.
1661	* @param pSlabCtl The slab control structure to add.
1662	*/
1663	BS3_DECL(void) Bs3SlabListAdd_c16(PBS3SLABHEAD pHead, PBS3SLABCTL pSlabCtl);
1664	/** @copydoc Bs3SlabListAdd_c16 */
1665	BS3_DECL(void) Bs3SlabListAdd_c32(PBS3SLABHEAD pHead, PBS3SLABCTL pSlabCtl);
1666	/** @copydoc Bs3SlabListAdd_c16 */
1667	BS3_DECL(void) Bs3SlabListAdd_c64(PBS3SLABHEAD pHead, PBS3SLABCTL pSlabCtl);
1668	#define Bs3SlabListAdd BS3_CMN_NM(Bs3SlabListAdd) /*< Selects #Bs3SlabListAdd_c16, #Bs3SlabListAdd_c32 or #Bs3SlabListAdd_c64. /
1669
1670	/**
1671	* Allocates one chunk.
1672	*
1673	* @returns Pointer to a chunk on success, NULL if we're out of chunks.
1674	* @param pHead The slab list to allocate from.
1675	*/
1676	BS3_DECL(void BS3_FAR *) Bs3SlabListAlloc_c16(PBS3SLABHEAD pHead);
1677	BS3_DECL(void BS3_FAR ) Bs3SlabListAlloc_c32(PBS3SLABHEAD pHead); /< @copydoc Bs3SlabListAlloc_c16 /
1678	BS3_DECL(void BS3_FAR ) Bs3SlabListAlloc_c64(PBS3SLABHEAD pHead); /< @copydoc Bs3SlabListAlloc_c16 /
1679	#define Bs3SlabListAlloc BS3_CMN_NM(Bs3SlabListAlloc) /*< Selects #Bs3SlabListAlloc_c16, #Bs3SlabListAlloc_c32 or #Bs3SlabListAlloc_c64. /
1680
1681	/**
1682	* Allocates one or more chunks.
1683	*
1684	* @returns Pointer to the request number of chunks on success, NULL if we're
1685	* out of chunks.
1686	* @param pHead The slab list to allocate from.
1687	* @param cChunks The number of contiguous chunks we want.
1688	* @param fFlags Flags, see BS3_SLAB_ALLOC_F_XXX
1689	*/
1690	BS3_DECL(void BS3_FAR *) Bs3SlabListAllocEx_c16(PBS3SLABHEAD pHead, uint16_t cChunks, uint16_t fFlags);
1691	BS3_DECL(void BS3_FAR ) Bs3SlabListAllocEx_c32(PBS3SLABHEAD pHead, uint16_t cChunks, uint16_t fFlags); /< @copydoc Bs3SlabListAllocEx_c16 /
1692	BS3_DECL(void BS3_FAR ) Bs3SlabListAllocEx_c64(PBS3SLABHEAD pHead, uint16_t cChunks, uint16_t fFlags); /< @copydoc Bs3SlabListAllocEx_c16 /
1693	#define Bs3SlabListAllocEx BS3_CMN_NM(Bs3SlabListAllocEx) /*< Selects #Bs3SlabListAllocEx_c16, #Bs3SlabListAllocEx_c32 or #Bs3SlabListAllocEx_c64. /
1694
1695	/**
1696	* Frees one or more chunks from a slab list.
1697	*
1698	* @param pHead The slab list to allocate from.
1699	* @param pvChunks Pointer to the first chunk to free.
1700	* @param cChunks The number of contiguous chunks to free.
1701	*/
1702	BS3_DECL(void) Bs3SlabListFree_c16(PBS3SLABHEAD pHead, void BS3_FAR *pvChunks, uint16_t cChunks);
1703	BS3_DECL(void) Bs3SlabListFree_c32(PBS3SLABHEAD pHead, void BS3_FAR pvChunks, uint16_t cChunks); /< @copydoc Bs3SlabListFree_c16 /
1704	BS3_DECL(void) Bs3SlabListFree_c64(PBS3SLABHEAD pHead, void BS3_FAR pvChunks, uint16_t cChunks); /< @copydoc Bs3SlabListFree_c16 /
1705	#define Bs3SlabListFree BS3_CMN_NM(Bs3SlabListFree) /*< Selects #Bs3SlabListFree_c16, #Bs3SlabListFree_c32 or #Bs3SlabListFree_c64. /
1706
1707	/**
1708	* Allocation addressing constraints.
1709	*/
1710	typedef enum BS3MEMKIND
1711	{
1712	/** Invalid zero type. */
1713	BS3MEMKIND_INVALID = 0,
1714	/** Real mode addressable memory. */
1715	BS3MEMKIND_REAL,
1716	/** Memory addressable using the 16-bit protected mode tiling. */
1717	BS3MEMKIND_TILED,
1718	/** Memory addressable using 32-bit flat addressing. */
1719	BS3MEMKIND_FLAT32,
1720	/** Memory addressable using 64-bit flat addressing. */
1721	BS3MEMKIND_FLAT64,
1722	/** End of valid types. */
1723	BS3MEMKIND_END,
1724	} BS3MEMKIND;
1725
1726	/**
1727	* Allocates low memory.
1728	*
1729	* @returns Pointer to a chunk on success, NULL if we're out of chunks.
1730	* @param enmKind The kind of addressing constraints imposed on the
1731	* allocation.
1732	* @param cb How much to allocate. Must be 4KB or less.
1733	*/
1734	BS3_DECL(void BS3_FAR *) Bs3MemAlloc_c16(BS3MEMKIND enmKind, size_t cb);
1735	BS3_DECL(void BS3_FAR ) Bs3MemAlloc_c32(BS3MEMKIND enmKind, size_t cb); /< @copydoc Bs3MemAlloc_c16 /
1736	BS3_DECL(void BS3_FAR ) Bs3MemAlloc_c64(BS3MEMKIND enmKind, size_t cb); /< @copydoc Bs3MemAlloc_c16 /
1737	#define Bs3MemAlloc BS3_CMN_NM(Bs3MemAlloc) /*< Selects #Bs3MemAlloc_c16, #Bs3MemAlloc_c32 or #Bs3MemAlloc_c64. /
1738
1739	/**
1740	* Allocates zero'ed memory.
1741	*
1742	* @param enmKind The kind of addressing constraints imposed on the
1743	* allocation.
1744	* @param cb How much to allocate. Must be 4KB or less.
1745	*/
1746	BS3_DECL(void BS3_FAR *) Bs3MemAllocZ_c16(BS3MEMKIND enmKind, size_t cb);
1747	BS3_DECL(void BS3_FAR ) Bs3MemAllocZ_c32(BS3MEMKIND enmKind, size_t cb); /< @copydoc Bs3MemAllocZ_c16 /
1748	BS3_DECL(void BS3_FAR ) Bs3MemAllocZ_c64(BS3MEMKIND enmKind, size_t cb); /< @copydoc Bs3MemAllocZ_c16 /
1749	#define Bs3MemAllocZ BS3_CMN_NM(Bs3MemAllocZ) /*< Selects #Bs3MemAllocZ_c16, #Bs3MemAllocZ_c32 or #Bs3MemAllocZ_c64. /
1750
1751	/**
1752	* Frees memory.
1753	*
1754	* @returns Pointer to a chunk on success, NULL if we're out of chunks.
1755	* @param pv The memory to free (returned by #Bs3MemAlloc).
1756	* @param cb The size of the allocation.
1757	*/
1758	BS3_DECL(void) Bs3MemFree_c16(void BS3_FAR *pv, size_t cb);
1759	BS3_DECL(void) Bs3MemFree_c32(void BS3_FAR pv, size_t cb); /< @copydoc Bs3MemFree_c16 /
1760	BS3_DECL(void) Bs3MemFree_c64(void BS3_FAR pv, size_t cb); /< @copydoc Bs3MemFree_c16 /
1761	#define Bs3MemFree BS3_CMN_NM(Bs3MemFree) /*< Selects #Bs3MemFree_c16, #Bs3MemFree_c32 or #Bs3MemFree_c64. /
1762
1763
1764	/**
1765	* Enables the A20 gate.
1766	*/
1767	BS3_DECL(void) Bs3A20Enable_c16(void);
1768	BS3_DECL(void) Bs3A20Enable_c32(void); /*< @copydoc Bs3A20Enable_c16 /
1769	BS3_DECL(void) Bs3A20Enable_c64(void); /*< @copydoc Bs3A20Enable_c16 /
1770	#define Bs3A20Enable BS3_CMN_NM(Bs3A20Enable) /*< Selects #Bs3A20Enable_c16, #Bs3A20Enable_c32 or #Bs3A20Enable_c64. /
1771
1772	/**
1773	* Enables the A20 gate via the keyboard controller
1774	*/
1775	BS3_DECL(void) Bs3A20EnableViaKbd_c16(void);
1776	BS3_DECL(void) Bs3A20EnableViaKbd_c32(void); /*< @copydoc Bs3A20EnableViaKbd_c16 /
1777	BS3_DECL(void) Bs3A20EnableViaKbd_c64(void); /*< @copydoc Bs3A20EnableViaKbd_c16 /
1778	#define Bs3A20EnableViaKbd BS3_CMN_NM(Bs3A20EnableViaKbd) /*< Selects #Bs3A20EnableViaKbd_c16, #Bs3A20EnableViaKbd_c32 or #Bs3A20EnableViaKbd_c64. /
1779
1780	/**
1781	* Enables the A20 gate via the PS/2 control port A.
1782	*/
1783	BS3_DECL(void) Bs3A20EnableViaPortA_c16(void);
1784	BS3_DECL(void) Bs3A20EnableViaPortA_c32(void); /*< @copydoc Bs3A20EnableViaPortA_c16 /
1785	BS3_DECL(void) Bs3A20EnableViaPortA_c64(void); /*< @copydoc Bs3A20EnableViaPortA_c16 /
1786	#define Bs3A20EnableViaPortA BS3_CMN_NM(Bs3A20EnableViaPortA) /*< Selects #Bs3A20EnableViaPortA_c16, #Bs3A20EnableViaPortA_c32 or #Bs3A20EnableViaPortA_c64. /
1787
1788	/**
1789	* Disables the A20 gate.
1790	*/
1791	BS3_DECL(void) Bs3A20Disable_c16(void);
1792	BS3_DECL(void) Bs3A20Disable_c32(void); /*< @copydoc Bs3A20Disable_c16 /
1793	BS3_DECL(void) Bs3A20Disable_c64(void); /*< @copydoc Bs3A20Disable_c16 /
1794	#define Bs3A20Disable BS3_CMN_NM(Bs3A20Disable) /*< Selects #Bs3A20Disable_c16, #Bs3A20Disable_c32 or #Bs3A20Disable_c64. /
1795
1796	/**
1797	* Disables the A20 gate via the keyboard controller
1798	*/
1799	BS3_DECL(void) Bs3A20DisableViaKbd_c16(void);
1800	BS3_DECL(void) Bs3A20DisableViaKbd_c32(void); /*< @copydoc Bs3A20DisableViaKbd_c16 /
1801	BS3_DECL(void) Bs3A20DisableViaKbd_c64(void); /*< @copydoc Bs3A20DisableViaKbd_c16 /
1802	#define Bs3A20DisableViaKbd BS3_CMN_NM(Bs3A20DisableViaKbd) /*< Selects #Bs3A20DisableViaKbd_c16, #Bs3A20DisableViaKbd_c32 or #Bs3A20DisableViaKbd_c64. /
1803
1804	/**
1805	* Disables the A20 gate via the PS/2 control port A.
1806	*/
1807	BS3_DECL(void) Bs3A20DisableViaPortA_c16(void);
1808	BS3_DECL(void) Bs3A20DisableViaPortA_c32(void); /*< @copydoc Bs3A20DisableViaPortA_c16 /
1809	BS3_DECL(void) Bs3A20DisableViaPortA_c64(void); /*< @copydoc Bs3A20DisableViaPortA_c16 /
1810	#define Bs3A20DisableViaPortA BS3_CMN_NM(Bs3A20DisableViaPortA) /*< Selects #Bs3A20DisableViaPortA_c16, #Bs3A20DisableViaPortA_c32 or #Bs3A20DisableViaPortA_c64. /
1811
1812
1813	/**
1814	* Initializes root page tables for page protected mode (PP16, PP32).
1815	*
1816	* @returns IPRT status code.
1817	* @remarks Must not be called in real-mode!
1818	*/
1819	BS3_DECL(int) Bs3PagingInitRootForPP_c16(void);
1820	BS3_DECL(int) Bs3PagingInitRootForPP_c32(void); /*< @copydoc Bs3PagingInitRootForPP_c16 /
1821	BS3_DECL(int) Bs3PagingInitRootForPP_c64(void); /*< @copydoc Bs3PagingInitRootForPP_c16 /
1822	#define Bs3PagingInitRootForPP BS3_CMN_NM(Bs3PagingInitRootForPP) /*< Selects #Bs3PagingInitRootForPP_c16, #Bs3PagingInitRootForPP_c32 or #Bs3PagingInitRootForPP_c64. /
1823
1824	/**
1825	* Initializes root page tables for PAE page protected mode (PAE16, PAE32).
1826	*
1827	* @returns IPRT status code.
1828	* @remarks The default long mode page tables depends on the PAE ones.
1829	* @remarks Must not be called in real-mode!
1830	*/
1831	BS3_DECL(int) Bs3PagingInitRootForPAE_c16(void);
1832	BS3_DECL(int) Bs3PagingInitRootForPAE_c32(void); /*< @copydoc Bs3PagingInitRootForPAE_c16 /
1833	BS3_DECL(int) Bs3PagingInitRootForPAE_c64(void); /*< @copydoc Bs3PagingInitRootForPAE_c16 /
1834	#define Bs3PagingInitRootForPAE BS3_CMN_NM(Bs3PagingInitRootForPAE) /*< Selects #Bs3PagingInitRootForPAE_c16, #Bs3PagingInitRootForPAE_c32 or #Bs3PagingInitRootForPAE_c64. /
1835
1836	/**
1837	* Initializes root page tables for long mode (LM16, LM32, LM64).
1838	*
1839	* @returns IPRT status code.
1840	* @remarks The default long mode page tables depends on the PAE ones.
1841	* @remarks Must not be called in real-mode!
1842	*/
1843	BS3_DECL(int) Bs3PagingInitRootForLM_c16(void);
1844	BS3_DECL(int) Bs3PagingInitRootForLM_c32(void); /*< @copydoc Bs3PagingInitRootForLM_c16 /
1845	BS3_DECL(int) Bs3PagingInitRootForLM_c64(void); /*< @copydoc Bs3PagingInitRootForLM_c16 /
1846	#define Bs3PagingInitRootForLM BS3_CMN_NM(Bs3PagingInitRootForLM) /*< Selects #Bs3PagingInitRootForLM_c16, #Bs3PagingInitRootForLM_c32 or #Bs3PagingInitRootForLM_c64. /
1847
1848
1849	/**
1850	* Waits for the keyboard controller to become ready.
1851	*/
1852	BS3_DECL(void) Bs3KbdWait_c16(void);
1853	BS3_DECL(void) Bs3KbdWait_c32(void); /*< @copydoc Bs3KbdWait_c16 /
1854	BS3_DECL(void) Bs3KbdWait_c64(void); /*< @copydoc Bs3KbdWait_c16 /
1855	#define Bs3KbdWait BS3_CMN_NM(Bs3KbdWait) /*< Selects #Bs3KbdWait_c16, #Bs3KbdWait_c32 or #Bs3KbdWait_c64. /
1856
1857	/**
1858	* Sends a read command to the keyboard controller and gets the result.
1859	*
1860	* The caller is responsible for making sure the keyboard controller is ready
1861	* for a command (call #Bs3KbdWait if unsure).
1862	*
1863	* @returns The value read is returned (in al).
1864	* @param bCmd The read command.
1865	*/
1866	BS3_DECL(uint8_t) Bs3KbdRead_c16(uint8_t bCmd);
1867	BS3_DECL(uint8_t) Bs3KbdRead_c32(uint8_t bCmd); /*< @copydoc Bs3KbdRead_c16 /
1868	BS3_DECL(uint8_t) Bs3KbdRead_c64(uint8_t bCmd); /*< @copydoc Bs3KbdRead_c16 /
1869	#define Bs3KbdRead BS3_CMN_NM(Bs3KbdRead) /*< Selects #Bs3KbdRead_c16, #Bs3KbdRead_c32 or #Bs3KbdRead_c64. /
1870
1871	/**
1872	* Sends a write command to the keyboard controller and then sends the data.
1873	*
1874	* The caller is responsible for making sure the keyboard controller is ready
1875	* for a command (call #Bs3KbdWait if unsure).
1876	*
1877	* @param bCmd The write command.
1878	* @param bData The data to write.
1879	*/
1880	BS3_DECL(void) Bs3KbdWrite_c16(uint8_t bCmd, uint8_t bData);
1881	BS3_DECL(void) Bs3KbdWrite_c32(uint8_t bCmd, uint8_t bData); /*< @copydoc Bs3KbdWrite_c16 /
1882	BS3_DECL(void) Bs3KbdWrite_c64(uint8_t bCmd, uint8_t bData); /*< @copydoc Bs3KbdWrite_c16 /
1883	#define Bs3KbdWrite BS3_CMN_NM(Bs3KbdWrite) /*< Selects #Bs3KbdWrite_c16, #Bs3KbdWrite_c32 or #Bs3KbdWrite_c64. /
1884
1885
1886	/**
1887	* BS3 integer register.
1888	*/
1889	typedef union BS3REG
1890	{
1891	/** 8-bit unsigned integer. */
1892	uint8_t u8;
1893	/** 16-bit unsigned integer. */
1894	uint16_t u16;
1895	/** 32-bit unsigned integer. */
1896	uint32_t u32;
1897	/** 64-bit unsigned integer. */
1898	uint64_t u64;
1899	/** Full unsigned integer. */
1900	uint64_t u;
1901	/** High/low byte view. */
1902	struct
1903	{
1904	uint8_t bLo;
1905	uint8_t bHi;
1906	} b;
1907	/** 8-bit view. */
1908	uint8_t au8[8];
1909	/** 16-bit view. */
1910	uint16_t au16[4];
1911	/** 32-bit view. */
1912	uint32_t au32[2];
1913	} BS3REG;
1914	/** Pointer to an integer register. */
1915	typedef BS3REG BS3_FAR *PBS3REG;
1916	/** Pointer to a const integer register. */
1917	typedef BS3REG const BS3_FAR *PCBS3REG;
1918
1919	/**
1920	* Register context (without FPU).
1921	*/
1922	typedef struct BS3REGCTX
1923	{
1924	BS3REG rax;
1925	BS3REG rcx;
1926	BS3REG rdx;
1927	BS3REG rbx;
1928	BS3REG rsp;
1929	BS3REG rbp;
1930	BS3REG rsi;
1931	BS3REG rdi;
1932	BS3REG r8;
1933	BS3REG r9;
1934	BS3REG r10;
1935	BS3REG r11;
1936	BS3REG r12;
1937	BS3REG r13;
1938	BS3REG r14;
1939	BS3REG r15;
1940	BS3REG rflags;
1941	BS3REG rip;
1942	uint16_t cs;
1943	uint16_t ds;
1944	uint16_t es;
1945	uint16_t fs;
1946	uint16_t gs;
1947	uint16_t ss;
1948	uint16_t tr;
1949	uint16_t ldtr;
1950	uint8_t cBits;
1951	uint8_t abPadding[7];
1952	BS3REG cr0;
1953	BS3REG cr2;
1954	BS3REG cr3;
1955	BS3REG cr4;
1956	} BS3REGCTX;
1957	/** Pointer to a register context. */
1958	typedef BS3REGCTX BS3_FAR *PBS3REGCTX;
1959	/** Pointer to a const register context. */
1960	typedef BS3REGCTX const BS3_FAR *PCBS3REGCTX;
1961
1962
1963	/**
1964	* Trap frame.
1965	*/
1966	typedef struct BS3TRAPFRAME
1967	{
1968	/** Exception/interrupt number. */
1969	uint8_t bXcpt;
1970	/** Explicit alignment. */
1971	uint8_t bAlignment;
1972	/** The handler CS. */
1973	uint16_t uHandlerCc;
1974	/** The handler SS. */
1975	uint16_t uHandlerSs;
1976	/** The handler RSP (top of iret frame). */
1977	uint64_t uHandlerRsp;
1978	/** The handler RFLAGS value. */
1979	uint64_t fHandlerRfl;
1980	/** The error code (if applicable). */
1981	uint64_t uErrCd;
1982	/** The register context. */
1983	BS3REGCTX Ctx;
1984	} BS3TRAPFRAME;
1985	/** Pointer to a trap frame. */
1986	typedef BS3TRAPFRAME BS3_FAR *PBS3TRAPFRAME;
1987	/** Pointer to a const trap frame. */
1988	typedef BS3TRAPFRAME const BS3_FAR *PCBS3TRAPFRAME;
1989
1990	/**
1991	* Resumes execution of a 32-bit trap frame.
1992	*
1993	* @param pTrapFrame Trap frame to resume.
1994	* @param fFlags Flags, BS3TRAPRESUME_F_XXX.
1995	*/
1996	BS3_DECL(void) Bs3Trap32ResumeFrame_c32(BS3TRAPFRAME BS3_FAR *pTrapFrame, uint16_t fFlags);
1997	#define Bs3Trap32ResumeFrame BS3_CMN_NM(Bs3Trap32ResumeFrame) /*< Selects Bs3Trap32ResumeFrame_c16 (not implemented), #Bs3Trap32ResumeFrame_c32 or Bs3Trap32ResumeFrame_c64 (not implemented). /
1998
1999	/** Skip restoring the CRx registers. */
2000	#define BS3TRAPRESUME_F_SKIP_CRX UINT16_C(0x0001)
2001
2002	/**
2003	* Initializes 16-bit (protected mode) trap handling.
2004	*
2005	* @remarks Does not install 16-bit trap handling, just initializes the
2006	* structures.
2007	*/
2008	BS3_DECL(void) Bs3Trap16Init_c16(void);
2009	BS3_DECL(void) Bs3Trap16Init_c32(void); /*< @copydoc Bs3Trap16Init_c16 /
2010	BS3_DECL(void) Bs3Trap16Init_c64(void); /*< @copydoc Bs3Trap16Init_c16 /
2011	#define Bs3Trap16Init BS3_CMN_NM(Bs3Trap16Init) /*< Selects #Bs3Trap16Init_c16, #Bs3Trap16Init_c32 or #Bs3Trap16Init_c64. /
2012
2013	/**
2014	* Initializes 32-bit trap handling.
2015	*
2016	* @remarks Does not install 32-bit trap handling, just initializes the
2017	* structures.
2018	*/
2019	BS3_DECL(void) Bs3Trap32Init_c16(void);
2020	BS3_DECL(void) Bs3Trap32Init_c32(void); /*< @copydoc Bs3Trap32Init_c16 /
2021	BS3_DECL(void) Bs3Trap32Init_c64(void); /*< @copydoc Bs3Trap32Init_c16 /
2022	#define Bs3Trap32Init BS3_CMN_NM(Bs3Trap32Init) /*< Selects #Bs3Trap32Init_c16, #Bs3Trap32Init_c32 or #Bs3Trap32Init_c64. /
2023
2024	/**
2025	* Initializes 64-bit trap handling
2026	*
2027	* @remarks Does not install 64-bit trap handling, just initializes the
2028	* structures.
2029	*/
2030	BS3_DECL(void) Bs3Trap64Init_c16(void);
2031	BS3_DECL(void) Bs3Trap64Init_c32(void); /*< @copydoc Bs3Trap64Init_c16 /
2032	BS3_DECL(void) Bs3Trap64Init_c64(void); /*< @copydoc Bs3Trap64Init_c16 /
2033	#define Bs3Trap64Init BS3_CMN_NM(Bs3Trap64Init) /*< Selects #Bs3Trap64Init_c16, #Bs3Trap64Init_c32 or #Bs3Trap64Init_c64. /
2034
2035	/**
2036	* Modifies the 16-bit IDT entry (protected mode) specified by @a iIdt.
2037	*
2038	* @param iIdt The index of the IDT entry to set.
2039	* @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
2040	* @param bDpl The DPL.
2041	* @param uSel The handler selector.
2042	* @param off The handler offset (if applicable).
2043	* @param cParams The parameter count (for call gates).
2044	*/
2045	BS3_DECL(void) Bs3Trap16SetGate_c16(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint16_t off, uint8_t cParams);
2046	BS3_DECL(void) Bs3Trap16SetGate_c32(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint16_t off, uint8_t cParams); /*< @copydoc Bs3Trap16SetGate_c16 /
2047	BS3_DECL(void) Bs3Trap16SetGate_c64(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint16_t off, uint8_t cParams); /*< @copydoc Bs3Trap16SetGate_c16 /
2048	#define Bs3Trap16SetGate BS3_CMN_NM(Bs3Trap16SetGate) /*< Selects #Bs3Trap16SetGate_c16, #Bs3Trap16SetGate_c32 or #Bs3Trap16SetGate_c64. /
2049
2050	/** The address of Bs3Trap16GenericEntries.
2051	* Bs3Trap16GenericEntries is an array of interrupt/trap/whatever entry
2052	* points, 8 bytes each, that will create a register frame and call the generic
2053	* C compatible trap handlers. */
2054	extern uint32_t BS3_DATA_NM(g_Bs3Trap16GenericEntriesFlatAddr);
2055
2056	/**
2057	* Modifies the 32-bit IDT entry specified by @a iIdt.
2058	*
2059	* @param iIdt The index of the IDT entry to set.
2060	* @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
2061	* @param bDpl The DPL.
2062	* @param uSel The handler selector.
2063	* @param off The handler offset (if applicable).
2064	* @param cParams The parameter count (for call gates).
2065	*/
2066	BS3_DECL(void) Bs3Trap32SetGate_c16(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint32_t off, uint8_t cParams);
2067	BS3_DECL(void) Bs3Trap32SetGate_c32(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint32_t off, uint8_t cParams); /*< @copydoc Bs3Trap32SetGate_c16 /
2068	BS3_DECL(void) Bs3Trap32SetGate_c64(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint32_t off, uint8_t cParams); /*< @copydoc Bs3Trap32SetGate_c16 /
2069	#define Bs3Trap32SetGate BS3_CMN_NM(Bs3Trap32SetGate) /*< Selects #Bs3Trap32SetGate_c16, #Bs3Trap32SetGate_c32 or #Bs3Trap32SetGate_c64. /
2070
2071	/** The address of Bs3Trap32GenericEntries.
2072	* Bs3Trap32GenericEntries is an array of interrupt/trap/whatever entry
2073	* points, 8 bytes each, that will create a register frame and call the generic
2074	* C compatible trap handlers. */
2075	extern uint32_t BS3_DATA_NM(g_Bs3Trap32GenericEntriesFlatAddr);
2076
2077	/**
2078	* Modifies the 64-bit IDT entry specified by @a iIdt.
2079	*
2080	* @param iIdt The index of the IDT entry to set.
2081	* @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
2082	* @param bDpl The DPL.
2083	* @param uSel The handler selector.
2084	* @param off The handler offset (if applicable).
2085	* @param bIst The interrupt stack to use.
2086	*/
2087	BS3_DECL(void) Bs3Trap64SetGate_c16(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint64_t off, uint8_t bIst);
2088	BS3_DECL(void) Bs3Trap64SetGate_c32(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint64_t off, uint8_t bIst); /*< @copydoc Bs3Trap64SetGate_c16 /
2089	BS3_DECL(void) Bs3Trap64SetGate_c64(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint64_t off, uint8_t bIst); /*< @copydoc Bs3Trap64SetGate_c16 /
2090	#define Bs3Trap64SetGate BS3_CMN_NM(Bs3Trap64SetGate) /*< Selects #Bs3Trap64SetGate_c16, #Bs3Trap64SetGate_c32 or #Bs3Trap64SetGate_c64. /
2091
2092	/** The address of Bs3Trap64GenericEntries.
2093	* Bs3Trap64GenericEntries is an array of interrupt/trap/whatever entry
2094	* points, 8 bytes each, that will create a register frame and call the generic
2095	* C compatible trap handlers. */
2096	extern uint32_t BS3_DATA_NM(g_Bs3Trap64GenericEntriesFlatAddr);
2097
2098	/**
2099	* C-style trap handler.
2100	*
2101	* Upon return Bs3Trap16ResumeFrame_c16, #Bs3Trap32ResumeFrame_c32, or
2102	* Bs3Trap64ResumeFrame_c64 will be called depending on the current template
2103	* context.
2104	*
2105	* @param pTrapFrame The trap frame. Registers can be modified.
2106	*/
2107	typedef BS3_DECL_CALLBACK(void) FNBS3TRAPHANDLER(PBS3TRAPFRAME pTrapFrame);
2108	/** Pointer to a trap handler (current template context). */
2109	typedef FNBS3TRAPHANDLER *PFNBS3TRAPHANDLER;
2110
2111	/**
2112	* Sets a trap handler (C/C++/assembly) for the current bitness.
2113	*
2114	* When using a 32-bit IDT, only #Bs3TrapSetHandler_c32 will have any effect.
2115	* Likewise, when using a 16-bit IDT, only Bs3TrapSetHandler_c16 will make any
2116	* difference. Ditto 64-bit.
2117	*
2118	* Rational: It's mainly a C API, can't easily mix function pointers from other
2119	* bit counts in C. Use assembly helpers or something if that is necessary.
2120	* Besides, most of the real trap handling goes thru the default handler with
2121	* help of trap records.
2122	*
2123	* @returns Previous handler.
2124	* @param iIdt The index of the IDT entry to set.
2125	* @param pfnHandler Pointer to the handler.
2126	*/
2127	BS3_DECL(PFNBS3TRAPHANDLER) Bs3TrapSetHandler_c16(uint8_t iIdt, PFNBS3TRAPHANDLER pfnHandler);
2128	BS3_DECL(PFNBS3TRAPHANDLER) Bs3TrapSetHandler_c32(uint8_t iIdt, PFNBS3TRAPHANDLER pfnHandler); /*< @copydoc Bs3Trap32SetHandler_c16 /
2129	BS3_DECL(PFNBS3TRAPHANDLER) Bs3TrapSetHandler_c64(uint8_t iIdt, PFNBS3TRAPHANDLER pfnHandler); /*< @copydoc Bs3Trap32SetHandler_c16 /
2130	#define Bs3Trap32SetHandler BS3_CMN_NM(Bs3Trap32SetHandler) /*< Selects #Bs3Trap32SetHandler_c16, #Bs3Trap32SetHandler_c32 or #Bs3Trap32SetHandler_c64. /
2131
2132	/**
2133	* Default C/C++ trap handler.
2134	*
2135	* This will check trap record and panic if no match was found.
2136	*
2137	* @param pTrapFrame Trap frame of the trap to handle.
2138	*/
2139	BS3_DECL(void) Bs3TrapDefaultHandler_c16(PBS3TRAPFRAME pTrapFrame);
2140	BS3_DECL(void) Bs3TrapDefaultHandler_c32(PBS3TRAPFRAME pTrapFrame); /*< @copydoc Bs3TrapDefaultHandler_c16 /
2141	BS3_DECL(void) Bs3TrapDefaultHandler_c64(PBS3TRAPFRAME pTrapFrame); /*< @copydoc Bs3TrapDefaultHandler_c16 /
2142	#define Bs3TrapDefaultHandler BS3_CMN_NM(Bs3TrapDefaultHandler) /*< Selects #Bs3TrapDefaultHandler_c16, #Bs3TrapDefaultHandler_c32 or #Bs3TrapDefaultHandler_c64. /
2143
2144	/**
2145	* Prints the trap frame (to screen).
2146	* @param pTrapFrame Trap frame to print.
2147	*/
2148	BS3_DECL(void) Bs3TrapPrintFrame_c16(PCBS3TRAPFRAME pTrapFrame);
2149	BS3_DECL(void) Bs3TrapPrintFrame_c32(PCBS3TRAPFRAME pTrapFrame); /*< @copydoc Bs3TrapPrintFrame_c16 /
2150	BS3_DECL(void) Bs3TrapPrintFrame_c64(PCBS3TRAPFRAME pTrapFrame); /*< @copydoc Bs3TrapPrintFrame_c16 /
2151	#define Bs3TrapPrintFrame BS3_CMN_NM(Bs3TrapPrintFrame) /*< Selects #Bs3TrapPrintFrame_c16, #Bs3TrapPrintFrame_c32 or #Bs3TrapPrintFrame_c64. /
2152
2153	/** @} */
2154
2155
2156	/**
2157	* Initializes all of boot sector kit \#3.
2158	*/
2159	BS3_DECL(void) Bs3InitAll_rm(void);
2160
2161	/**
2162	* Initializes the REAL and TILED memory pools.
2163	*
2164	* For proper operation on OLDer CPUs, call #Bs3CpuDetect_mmm first.
2165	*/
2166	BS3_DECL(void) Bs3InitMemory_rm(void);
2167
2168
2169
2170	/** @defgroup grp_bs3kit_mode Mode Specific Functions and Data
2171	*
2172	* The mode specific functions come in bit count variations and CPU mode
2173	* variations. The bs3kit-template-header.h/mac defines the BS3_NM macro to
2174	* mangle a function or variable name according to the target CPU mode. In
2175	* non-templated code, it's common to spell the name out in full.
2176	*
2177	* @{
2178	*/
2179
2180
2181	/**
2182	* Macro for reducing typing.
2183	*
2184	* Doxygen knows how to expand this, well, kind of.
2185	*/
2186	#define BS3_MODE_EXPAND_PROTOTYPES(a_RetType, a_BaseFnNm, a_Parameters) \
2187	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_rm) a_Parameters; \
2188	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pe16) a_Parameters; \
2189	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pe16_32) a_Parameters; \
2190	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pe16_v86) a_Parameters; \
2191	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pe32) a_Parameters; \
2192	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pe32_16) a_Parameters; \
2193	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pev86) a_Parameters; \
2194	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pp16) a_Parameters; \
2195	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pp16_32) a_Parameters; \
2196	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pp16_v86) a_Parameters; \
2197	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pp32) a_Parameters; \
2198	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pp32_16) a_Parameters; \
2199	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_ppv86) a_Parameters; \
2200	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pae16) a_Parameters; \
2201	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pae16_16) a_Parameters; \
2202	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pae16_v86)a_Parameters; \
2203	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pae32) a_Parameters; \
2204	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_pae32_16) a_Parameters; \
2205	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_paev86) a_Parameters; \
2206	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_lm16) a_Parameters; \
2207	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_lm32) a_Parameters; \
2208	BS3_DECL(a_RetType) RT_CONCAT(a_BaseFnNm,_lm64) a_Parameters
2209
2210	/**
2211	* Macro for reducing typing.
2212	*
2213	* Doxygen knows how to expand this, well, kind of.
2214	*/
2215	#define BS3_MODE_EXPAND_EXTERN_DATA16(a_VarType, a_VarName, a_Suffix) \
2216	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_rm)) a_Suffix; \
2217	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pe16)) a_Suffix; \
2218	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pe16_32)) a_Suffix; \
2219	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pe16_v86)) a_Suffix; \
2220	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pe32)) a_Suffix; \
2221	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pe32_16)) a_Suffix; \
2222	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pev86)) a_Suffix; \
2223	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pp16)) a_Suffix; \
2224	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pp16_32)) a_Suffix; \
2225	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pp16_v86)) a_Suffix; \
2226	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pp32)) a_Suffix; \
2227	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pp32_16)) a_Suffix; \
2228	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_ppv86)) a_Suffix; \
2229	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pae16)) a_Suffix; \
2230	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pae16_32)) a_Suffix; \
2231	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pae16_v86))a_Suffix; \
2232	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pae32)) a_Suffix; \
2233	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_pae32_16)) a_Suffix; \
2234	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_paev86)) a_Suffix; \
2235	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_lm16)) a_Suffix; \
2236	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_lm32)) a_Suffix; \
2237	extern a_VarType BS3_FAR_DATA BS3_DATA_NM(RT_CONCAT(a_VarName,_lm64)) a_Suffix
2238
2239
2240	/** The TMPL_MODE_STR value for each mode.
2241	* These are all in DATA16 so they can be accessed from any code. */
2242	BS3_MODE_EXPAND_EXTERN_DATA16(const char *, g_szBs3ModeName, []);
2243
2244	/**
2245	* Basic CPU detection.
2246	*
2247	* This sets the #g_bBs3CpuDetected global variable to the return value.
2248	*
2249	* @returns BS3CPU_XXX value with the BS3CPU_F_CPUID flag set depending on
2250	* capabilities.
2251	*/
2252	BS3_MODE_EXPAND_PROTOTYPES(uint8_t, Bs3CpuDetect,(void));
2253
2254	/** @name BS3CPU_XXX - CPU detected by BS3CpuDetect_c16() and friends.
2255	* @{ */
2256	#define BS3CPU_8086 UINT16_C(0x0001) /*< Both 8086 and 8088. /
2257	#define BS3CPU_V20 UINT16_C(0x0002) /*< Both NEC V20, V30 and relatives. /
2258	#define BS3CPU_80186 UINT16_C(0x0003) /*< Both 80186 and 80188. /
2259	#define BS3CPU_80286 UINT16_C(0x0004)
2260	#define BS3CPU_80386 UINT16_C(0x0005)
2261	#define BS3CPU_80486 UINT16_C(0x0006)
2262	#define BS3CPU_Pentium UINT16_C(0x0007)
2263	#define BS3CPU_PPro UINT16_C(0x0008)
2264	#define BS3CPU_PProOrNewer UINT16_C(0x0009)
2265	/** CPU type mask. This is a full byte so it's possible to use byte access
2266	* without and AND'ing to get the type value. */
2267	#define BS3CPU_TYPE_MASK UINT16_C(0x00ff)
2268	/** Flag indicating that the CPUID instruction is supported by the CPU. */
2269	#define BS3CPU_F_CPUID UINT16_C(0x0100)
2270	/** Flag indicating that extend CPUID leaves are available (at least two). */
2271	#define BS3CPU_F_CPUID_EXT_LEAVES UINT16_C(0x0200)
2272	/** Flag indicating that the CPU supports PAE. */
2273	#define BS3CPU_F_PAE UINT16_C(0x0400)
2274	/** Flag indicating that the CPU supports long mode. */
2275	#define BS3CPU_F_LONG_MODE UINT16_C(0x0800)
2276	/** @} */
2277
2278	/** The return value of #Bs3CpuDetect_mmm. (Initial value is BS3CPU_TYPE_MASK.) */
2279	extern uint16_t BS3_DATA_NM(g_uBs3CpuDetected);
2280
2281
2282	/**
2283	* Executes the array of tests in every possibly mode.
2284	*
2285	* @param paEntries The mode sub-test entries.
2286	* @param cEntries The number of sub-test entries.
2287	*/
2288	BS3_MODE_EXPAND_PROTOTYPES(void, Bs3TestDoModes, (PCBS3TESTMODEENTRY paEntries, size_t cEntries));
2289
2290	/** @} */
2291
2292	RT_C_DECLS_END
2293
2294
2295	#endif
2296

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit.h@ 59945

Download in other formats: