bs3kit.h@ 70693

Last change on this file since 70693 was 69111, checked in by vboxsync, 7 years ago
(C) year
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 157.5 KB

Line
1	/* $Id: bs3kit.h 69111 2017-10-17 14:26:02Z vboxsync $ */
2	/** @file
3	* BS3Kit - structures, symbols, macros and stuff.
4	*/
5
6	/*
7	* Copyright (C) 2007-2017 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	# undef IN_RING0
32	# define IN_RING0
33	#endif
34
35	#define RT_NO_STRICT /* Don't drag in IPRT assertion code in inline code we may use (asm.h). */
36	#include <iprt/cdefs.h>
37	#include <iprt/types.h>
38
39	#ifndef DOXYGEN_RUNNING
40	# undef IN_RING0
41	#endif
42
43	/*
44	* Make asm.h and friend compatible with our 64-bit assembly config (ASM_CALL64_MSC).
45	*/
46	#if defined(__GNUC__) && ARCH_BITS == 64
47	# undef DECLASM
48	# ifdef __cplusplus
49	# define DECLASM(type) extern "C" type BS3_CALL
50	# else
51	# define DECLASM(type) type BS3_CALL
52	# endif
53	#endif
54
55
56	/*
57	* Work around ms_abi trouble in the gcc camp (gcc bugzilla #50818).
58	* ASSUMES all va_lists are in functions with
59	*/
60	#if defined(__GNUC__) && ARCH_BITS == 64
61	# undef va_list
62	# undef va_start
63	# undef va_end
64	# undef va_copy
65	# define va_list __builtin_ms_va_list
66	# define va_start(a_Va, a_Arg) __builtin_ms_va_start(a_Va, a_Arg)
67	# define va_end(a_Va) __builtin_ms_va_end(a_Va)
68	# define va_copy(a_DstVa, a_SrcVa) __builtin_ms_va_copy(a_DstVa, a_SrcVa)
69	#endif
70
71
72	/** @def BS3_USE_ALT_16BIT_TEXT_SEG
73	* @ingroup grp_bs3kit
74	* Combines the BS3_USE_RM_TEXT_SEG, BS3_USE_X0_TEXT_SEG, and
75	* BS3_USE_X1_TEXT_SEG indicators into a single one.
76	*/
77	#if defined(BS3_USE_RM_TEXT_SEG) \|\| defined(BS3_USE_X0_TEXT_SEG) \|\| defined(BS3_USE_X1_TEXT_SEG) \|\| defined(DOXYGEN_RUNNING)
78	# define BS3_USE_ALT_16BIT_TEXT_SEG
79	#else
80	# undef BS3_USE_ALT_16BIT_TEXT_SEG
81	#endif
82
83	/** @def BS3_USE_X0_TEXT_SEG
84	* @ingroup grp_bs3kit
85	* Emit 16-bit code to the BS3X0TEXT16 segment - ignored for 32-bit and 64-bit.
86	*
87	* Calling directly into the BS3X0TEXT16 segment is only possible in real-mode
88	* and v8086 mode. In protected mode the real far pointer have to be converted
89	* to a protected mode pointer that uses BS3_SEL_X0TEXT16_CS, Bs3TestDoModes and
90	* associates does this automatically.
91	*/
92	#ifdef DOXYGEN_RUNNING
93	# define BS3_USE_X0_TEXT_SEG
94	#endif
95
96	/** @def BS3_USE_X1_TEXT_SEG
97	* @ingroup grp_bs3kit
98	* Emit 16-bit code to the BS3X1TEXT16 segment - ignored for 32-bit and 64-bit.
99	*
100	* Calling directly into the BS3X1TEXT16 segment is only possible in real-mode
101	* and v8086 mode. In protected mode the real far pointer have to be converted
102	* to a protected mode pointer that uses BS3_SEL_X1TEXT16_CS, Bs3TestDoModes and
103	* associates does this automatically.
104	*/
105	#ifdef DOXYGEN_RUNNING
106	# define BS3_USE_X1_TEXT_SEG
107	#endif
108
109	/** @def BS3_USE_RM_TEXT_SEG
110	* @ingroup grp_bs3kit
111	* Emit 16-bit code to the BS3RMTEXT16 segment - ignored for 32-bit and 64-bit.
112	*
113	* This segment is normally used for real-mode only code, though
114	* BS3_SEL_RMTEXT16_CS can be used to call it from protected mode. Unlike the
115	* BS3X0TEXT16 and BS3X1TEXT16 segments which are empty by default, this segment
116	* is used by common BS3Kit code.
117	*/
118	#ifdef DOXYGEN_RUNNING
119	# define BS3_USE_X0_TEXT_SEG
120	#endif
121
122	/** @def BS3_MODEL_FAR_CODE
123	* @ingroup grp_bs3kit
124	* Default compiler model indicates far code.
125	*/
126	#ifdef DOXYGEN_RUNNING
127	# define BS3_MODEL_FAR_CODE
128	#elif !defined(BS3_MODEL_FAR_CODE) && (defined(__LARGE__) \|\| defined(__MEDIUM__) \|\| defined(__HUGE__)) && ARCH_BITS == 16
129	# define BS3_MODEL_FAR_CODE
130	#endif
131
132
133	/*
134	* We normally don't want the noreturn / aborts attributes as they mess up stack traces.
135	*
136	* Note! pragma aux <fnname> aborts can only be used with functions
137	* implemented in C and functions that does not have parameters.
138	*/
139	#define BS3_KIT_WITH_NO_RETURN
140	#ifndef BS3_KIT_WITH_NO_RETURN
141	# undef DECL_NO_RETURN
142	# define DECL_NO_RETURN(type) type
143	#endif
144
145
146	/*
147	* We may want to reuse some IPRT code in the common name space, so we
148	* redefine the RT_MANGLER to work like BS3_CMN_NM. (We cannot use
149	* BS3_CMN_NM yet, as we need to include IPRT headers with function
150	* declarations before we can define it. Thus the duplciate effort.)
151	*/
152	#if ARCH_BITS == 16
153	# undef RTCALL
154	# if defined(BS3_USE_ALT_16BIT_TEXT_SEG)
155	# define RTCALL __cdecl __far
156	# define RT_MANGLER(a_Name) RT_CONCAT(a_Name,_f16)
157	# else
158	# define RTCALL __cdecl __near
159	# define RT_MANGLER(a_Name) RT_CONCAT(a_Name,_c16)
160	# endif
161	#else
162	# define RT_MANGLER(a_Name) RT_CONCAT3(a_Name,_c,ARCH_BITS)
163	#endif
164	#include <iprt/mangling.h>
165	#include <iprt/x86.h>
166	#include <iprt/err.h>
167
168	/*
169	* Include data symbol mangling (function mangling/mapping must be done
170	* after the protypes).
171	*/
172	#include "bs3kit-mangling-data.h"
173
174
175
176	RT_C_DECLS_BEGIN
177
178	/** @defgroup grp_bs3kit BS3Kit - Boot Sector Kit \#3
179	*
180	* The BS3Kit is a framework for bare metal floppy/usb image tests,
181	* see the @ref pg_bs3kit "doc page" for more.
182	*
183	* @{ */
184
185	/** @name Execution modes.
186	* @{ */
187	#define BS3_MODE_INVALID UINT8_C(0x00)
188	#define BS3_MODE_RM UINT8_C(0x01) /*< real mode. /
189	#define BS3_MODE_PE16 UINT8_C(0x11) /*< 16-bit protected mode kernel+tss, running 16-bit code, unpaged. /
190	#define BS3_MODE_PE16_32 UINT8_C(0x12) /*< 16-bit protected mode kernel+tss, running 32-bit code, unpaged. /
191	#define BS3_MODE_PE16_V86 UINT8_C(0x18) /*< 16-bit protected mode kernel+tss, running virtual 8086 mode code, unpaged. /
192	#define BS3_MODE_PE32 UINT8_C(0x22) /*< 32-bit protected mode kernel+tss, running 32-bit code, unpaged. /
193	#define BS3_MODE_PE32_16 UINT8_C(0x21) /*< 32-bit protected mode kernel+tss, running 16-bit code, unpaged. /
194	#define BS3_MODE_PEV86 UINT8_C(0x28) /*< 32-bit protected mode kernel+tss, running virtual 8086 mode code, unpaged. /
195	#define BS3_MODE_PP16 UINT8_C(0x31) /*< 16-bit protected mode kernel+tss, running 16-bit code, paged. /
196	#define BS3_MODE_PP16_32 UINT8_C(0x32) /*< 16-bit protected mode kernel+tss, running 32-bit code, paged. /
197	#define BS3_MODE_PP16_V86 UINT8_C(0x38) /*< 16-bit protected mode kernel+tss, running virtual 8086 mode code, paged. /
198	#define BS3_MODE_PP32 UINT8_C(0x42) /*< 32-bit protected mode kernel+tss, running 32-bit code, paged. /
199	#define BS3_MODE_PP32_16 UINT8_C(0x41) /*< 32-bit protected mode kernel+tss, running 16-bit code, paged. /
200	#define BS3_MODE_PPV86 UINT8_C(0x48) /*< 32-bit protected mode kernel+tss, running virtual 8086 mode code, paged. /
201	#define BS3_MODE_PAE16 UINT8_C(0x51) /*< 16-bit protected mode kernel+tss, running 16-bit code, PAE paging. /
202	#define BS3_MODE_PAE16_32 UINT8_C(0x52) /*< 16-bit protected mode kernel+tss, running 32-bit code, PAE paging. /
203	#define BS3_MODE_PAE16_V86 UINT8_C(0x58) /*< 16-bit protected mode kernel+tss, running virtual 8086 mode, PAE paging. /
204	#define BS3_MODE_PAE32 UINT8_C(0x62) /*< 32-bit protected mode kernel+tss, running 32-bit code, PAE paging. /
205	#define BS3_MODE_PAE32_16 UINT8_C(0x61) /*< 32-bit protected mode kernel+tss, running 16-bit code, PAE paging. /
206	#define BS3_MODE_PAEV86 UINT8_C(0x68) /*< 32-bit protected mode kernel+tss, running virtual 8086 mode, PAE paging. /
207	#define BS3_MODE_LM16 UINT8_C(0x71) /*< 16-bit long mode (paged), kernel+tss always 64-bit. /
208	#define BS3_MODE_LM32 UINT8_C(0x72) /*< 32-bit long mode (paged), kernel+tss always 64-bit. /
209	#define BS3_MODE_LM64 UINT8_C(0x74) /*< 64-bit long mode (paged), kernel+tss always 64-bit. /
210
211	#define BS3_MODE_CODE_MASK UINT8_C(0x0f) /*< Running code mask. /
212	#define BS3_MODE_CODE_16 UINT8_C(0x01) /*< Running 16-bit code. /
213	#define BS3_MODE_CODE_32 UINT8_C(0x02) /*< Running 32-bit code. /
214	#define BS3_MODE_CODE_64 UINT8_C(0x04) /*< Running 64-bit code. /
215	#define BS3_MODE_CODE_V86 UINT8_C(0x08) /*< Running 16-bit virtual 8086 code. /
216
217	#define BS3_MODE_SYS_MASK UINT8_C(0xf0) /*< kernel+tss mask. /
218	#define BS3_MODE_SYS_RM UINT8_C(0x00) /*< Real mode kernel+tss. /
219	#define BS3_MODE_SYS_PE16 UINT8_C(0x10) /*< 16-bit protected mode kernel+tss. /
220	#define BS3_MODE_SYS_PE32 UINT8_C(0x20) /*< 32-bit protected mode kernel+tss. /
221	#define BS3_MODE_SYS_PP16 UINT8_C(0x30) /*< 16-bit paged protected mode kernel+tss. /
222	#define BS3_MODE_SYS_PP32 UINT8_C(0x40) /*< 32-bit paged protected mode kernel+tss. /
223	#define BS3_MODE_SYS_PAE16 UINT8_C(0x50) /*< 16-bit PAE paged protected mode kernel+tss. /
224	#define BS3_MODE_SYS_PAE32 UINT8_C(0x60) /*< 32-bit PAE paged protected mode kernel+tss. /
225	#define BS3_MODE_SYS_LM UINT8_C(0x70) /*< 64-bit (paged) long mode protected mode kernel+tss. /
226
227	/** Whether the mode has paging enabled. */
228	#define BS3_MODE_IS_PAGED(a_fMode) ((a_fMode) >= BS3_MODE_PP16)
229	/** Whether the mode has legacy paging enabled (legacy as opposed to PAE or
230	* long mode). */
231	#define BS3_MODE_IS_LEGACY_PAGING(a_fMode) ((a_fMode) >= BS3_MODE_PP16 && (a_fMode) < BS3_MODE_PAE16)
232
233	/** Whether the mode is running v8086 code. */
234	#define BS3_MODE_IS_V86(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_V86)
235	/** Whether the we're executing in real mode or v8086 mode. */
236	#define BS3_MODE_IS_RM_OR_V86(a_fMode) ((a_fMode) == BS3_MODE_RM \|\| BS3_MODE_IS_V86(a_fMode))
237	/** Whether the mode is running 16-bit code, except v8086. */
238	#define BS3_MODE_IS_16BIT_CODE_NO_V86(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_16)
239	/** Whether the mode is running 16-bit code (includes v8086). */
240	#define BS3_MODE_IS_16BIT_CODE(a_fMode) (BS3_MODE_IS_16BIT_CODE_NO_V86(a_fMode) \|\| BS3_MODE_IS_V86(a_fMode))
241	/** Whether the mode is running 32-bit code. */
242	#define BS3_MODE_IS_32BIT_CODE(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_32)
243	/** Whether the mode is running 64-bit code. */
244	#define BS3_MODE_IS_64BIT_CODE(a_fMode) (((a_fMode) & BS3_MODE_CODE_MASK) == BS3_MODE_CODE_64)
245
246	/** Whether the system is in real mode. */
247	#define BS3_MODE_IS_RM_SYS(a_fMode) (((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_RM)
248	/** Whether the system is some 16-bit mode that isn't real mode. */
249	#define BS3_MODE_IS_16BIT_SYS_NO_RM(a_fMode) ( ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PE16 \
250	\|\| ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PP16 \
251	\|\| ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PAE16)
252	/** Whether the system is some 16-bit mode (includes real mode). */
253	#define BS3_MODE_IS_16BIT_SYS(a_fMode) (BS3_MODE_IS_16BIT_SYS_NO_RM(a_fMode) \|\| BS3_MODE_IS_RM_SYS(a_fMode))
254	/** Whether the system is some 32-bit mode. */
255	#define BS3_MODE_IS_32BIT_SYS(a_fMode) ( ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PE32 \
256	\|\| ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PP32 \
257	\|\| ((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_PAE32)
258	/** Whether the system is long mode. */
259	#define BS3_MODE_IS_64BIT_SYS(a_fMode) (((a_fMode) & BS3_MODE_SYS_MASK) == BS3_MODE_SYS_LM)
260
261	/** Whether the system is in protected mode (with or without paging).
262	* @note Long mode is not included. */
263	#define BS3_MODE_IS_PM_SYS(a_fMode) ((a_fMode) >= BS3_MODE_SYS_PE16 && (a_fMode) < BS3_MODE_SYS_LM)
264
265	/** @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? */
266	/** @} */
267
268
269	/** @name BS3_ADDR_XXX - Static Memory Allocation
270	* @{ */
271	/** The flat load address for the code after the bootsector. */
272	#define BS3_ADDR_LOAD 0x10000
273	/** Where we save the boot registers during init.
274	* Located right before the code. */
275	#define BS3_ADDR_REG_SAVE (BS3_ADDR_LOAD - sizeof(BS3REGCTX) - 8)
276	/** Where the stack starts (initial RSP value).
277	* Located 16 bytes (assumed by boot sector) before the saved registers.
278	* SS.BASE=0. The size is a little short of 32KB */
279	#define BS3_ADDR_STACK (BS3_ADDR_REG_SAVE - 16)
280	/** The ring-0 stack (8KB) for ring transitions. */
281	#define BS3_ADDR_STACK_R0 0x06000
282	/** The ring-1 stack (8KB) for ring transitions. */
283	#define BS3_ADDR_STACK_R1 0x04000
284	/** The ring-2 stack (8KB) for ring transitions. */
285	#define BS3_ADDR_STACK_R2 0x02000
286	/** IST1 ring-0 stack for long mode (4KB), used for double faults elsewhere. */
287	#define BS3_ADDR_STACK_R0_IST1 0x09000
288	/** IST2 ring-0 stack for long mode (3KB), used for spare 0 stack elsewhere. */
289	#define BS3_ADDR_STACK_R0_IST2 0x08000
290	/** IST3 ring-0 stack for long mode (1KB). */
291	#define BS3_ADDR_STACK_R0_IST3 0x07400
292	/** IST4 ring-0 stack for long mode (1KB), used for spare 1 stack elsewhere. */
293	#define BS3_ADDR_STACK_R0_IST4 0x07000
294	/** IST5 ring-0 stack for long mode (1KB). */
295	#define BS3_ADDR_STACK_R0_IST5 0x06c00
296	/** IST6 ring-0 stack for long mode (1KB). */
297	#define BS3_ADDR_STACK_R0_IST6 0x06800
298	/** IST7 ring-0 stack for long mode (1KB). */
299	#define BS3_ADDR_STACK_R0_IST7 0x06400
300
301	/** The base address of the BS3TEXT16 segment (same as BS3_LOAD_ADDR).
302	* @sa BS3_SEL_TEXT16 */
303	#define BS3_ADDR_BS3TEXT16 0x10000
304	/** The base address of the BS3SYSTEM16 segment.
305	* @sa BS3_SEL_SYSTEM16 */
306	#define BS3_ADDR_BS3SYSTEM16 0x20000
307	/** The base address of the BS3DATA16/BS3KIT_GRPNM_DATA16 segment.
308	* @sa BS3_SEL_DATA16 */
309	#define BS3_ADDR_BS3DATA16 0x29000
310	/** @} */
311
312	/** @name BS3_SEL_XXX - GDT selector assignments.
313	*
314	* The real mode segment numbers for BS16TEXT, BS16DATA and BS16SYSTEM are
315	* present in the GDT, this allows the 16-bit C/C++ and assembly code to
316	* continue using the real mode segment values in ring-0 protected mode.
317	*
318	* The three segments have fixed locations:
319	* \| segment \| flat address \| real mode segment \|
320	* \| ----------- \| ------------ \| ----------------- \|
321	* \| BS3TEXT16 \| 0x00010000 \| 1000h \|
322	* \| BS3SYSTEM16 \| 0x00020000 \| 2000h \|
323	* \| BS3DATA16 \| 0x00029000 \| 2900h \|
324	*
325	* This means that we've got a lot of GDT space to play around with.
326	*
327	* @{ */
328	#define BS3_SEL_LDT 0x0010 /*< The LDT selector for Bs3Ldt. /
329	#define BS3_SEL_TSS16 0x0020 /*< The 16-bit TSS selector. /
330	#define BS3_SEL_TSS16_DF 0x0028 /*< The 16-bit TSS selector for double faults. /
331	#define BS3_SEL_TSS16_SPARE0 0x0030 /*< The 16-bit TSS selector for testing. /
332	#define BS3_SEL_TSS16_SPARE1 0x0038 /*< The 16-bit TSS selector for testing. /
333	#define BS3_SEL_TSS32 0x0040 /*< The 32-bit TSS selector. /
334	#define BS3_SEL_TSS32_DF 0x0048 /*< The 32-bit TSS selector for double faults. /
335	#define BS3_SEL_TSS32_SPARE0 0x0050 /*< The 32-bit TSS selector for testing. /
336	#define BS3_SEL_TSS32_SPARE1 0x0058 /*< The 32-bit TSS selector for testing. /
337	#define BS3_SEL_TSS32_IOBP_IRB 0x0060 /*< The 32-bit TSS selector with I/O permission and interrupt redirection bitmaps. /
338	#define BS3_SEL_TSS32_IRB 0x0068 /*< The 32-bit TSS selector with only interrupt redirection bitmap (IOPB stripped by limit). /
339	#define BS3_SEL_TSS64 0x0070 /*< The 64-bit TSS selector. /
340	#define BS3_SEL_TSS64_SPARE0 0x0080 /*< The 64-bit TSS selector. /
341	#define BS3_SEL_TSS64_SPARE1 0x0090 /*< The 64-bit TSS selector. /
342	#define BS3_SEL_TSS64_IOBP 0x00a0 /*< The 64-bit TSS selector. /
343
344	#define BS3_SEL_RMTEXT16_CS 0x00e0 /*< Conforming code selector for accessing the BS3RMTEXT16 segment. Runtime config. /
345	#define BS3_SEL_X0TEXT16_CS 0x00e8 /*< Conforming code selector for accessing the BS3X0TEXT16 segment. Runtime config. /
346	#define BS3_SEL_X1TEXT16_CS 0x00f0 /*< Conforming code selector for accessing the BS3X1TEXT16 segment. Runtime config. /
347	#define BS3_SEL_VMMDEV_MMIO16 0x00f8 /*< Selector for accessing the VMMDev MMIO segment at 0100000h from 16-bit code. /
348
349	/** Checks if @a uSel is in the BS3_SEL_RX_XXX range. */
350	#define BS3_SEL_IS_IN_RING_RANGE(uSel) ( (unsigned)(uSel - BS3_SEL_R0_FIRST) < (unsigned)(4 << BS3_SEL_RING_SHIFT) )
351	#define BS3_SEL_RING_SHIFT 8 /*< For the formula: BS3_SEL_R0_XXX + ((cs & 3) << BS3_SEL_RING_SHIFT) /
352	#define BS3_SEL_RING_SUB_MASK 0x00f8 /*< Mask for getting the sub-selector. For use with BS3_SEL_R_FIRST. */
353
354	/** Checks if @a uSel is in the BS3_SEL_R0_XXX range. */
355	#define BS3_SEL_IS_IN_R0_RANGE(uSel) ( (unsigned)(uSel - BS3_SEL_R0_FIRST) < (unsigned)(1 << BS3_SEL_RING_SHIFT) )
356	#define BS3_SEL_R0_FIRST 0x0100 /*< The first selector in the ring-0 block. /
357	#define BS3_SEL_R0_CS16 0x0100 /*< ring-0: 16-bit code selector, base 0x10000. /
358	#define BS3_SEL_R0_DS16 0x0108 /*< ring-0: 16-bit data selector, base 0x23000. /
359	#define BS3_SEL_R0_SS16 0x0110 /*< ring-0: 16-bit stack selector, base 0x00000. /
360	#define BS3_SEL_R0_CS32 0x0118 /*< ring-0: 32-bit flat code selector. /
361	#define BS3_SEL_R0_DS32 0x0120 /*< ring-0: 32-bit flat data selector. /
362	#define BS3_SEL_R0_SS32 0x0128 /*< ring-0: 32-bit flat stack selector. /
363	#define BS3_SEL_R0_CS64 0x0130 /*< ring-0: 64-bit flat code selector. /
364	#define BS3_SEL_R0_DS64 0x0138 /*< ring-0: 64-bit flat data & stack selector. /
365	#define BS3_SEL_R0_CS16_EO 0x0140 /*< ring-0: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. /
366	#define BS3_SEL_R0_CS16_CNF 0x0148 /*< ring-0: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. /
367	#define BS3_SEL_R0_CS16_CNF_EO 0x0150 /*< ring-0: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. /
368	#define BS3_SEL_R0_CS32_EO 0x0158 /*< ring-0: 32-bit execute-only code selector, not accessed, flat. /
369	#define BS3_SEL_R0_CS32_CNF 0x0160 /*< ring-0: 32-bit conforming code selector, not accessed, flat. /
370	#define BS3_SEL_R0_CS32_CNF_EO 0x0168 /*< ring-0: 32-bit execute-only conforming code selector, not accessed, flat. /
371	#define BS3_SEL_R0_CS64_EO 0x0170 /*< ring-0: 64-bit execute-only code selector, not accessed, flat. /
372	#define BS3_SEL_R0_CS64_CNF 0x0178 /*< ring-0: 64-bit conforming code selector, not accessed, flat. /
373	#define BS3_SEL_R0_CS64_CNF_EO 0x0180 /*< ring-0: 64-bit execute-only conforming code selector, not accessed, flat. /
374
375	#define BS3_SEL_R1_FIRST 0x0200 /*< The first selector in the ring-1 block. /
376	#define BS3_SEL_R1_CS16 0x0200 /*< ring-1: 16-bit code selector, base 0x10000. /
377	#define BS3_SEL_R1_DS16 0x0208 /*< ring-1: 16-bit data selector, base 0x23000. /
378	#define BS3_SEL_R1_SS16 0x0210 /*< ring-1: 16-bit stack selector, base 0x00000. /
379	#define BS3_SEL_R1_CS32 0x0218 /*< ring-1: 32-bit flat code selector. /
380	#define BS3_SEL_R1_DS32 0x0220 /*< ring-1: 32-bit flat data selector. /
381	#define BS3_SEL_R1_SS32 0x0228 /*< ring-1: 32-bit flat stack selector. /
382	#define BS3_SEL_R1_CS64 0x0230 /*< ring-1: 64-bit flat code selector. /
383	#define BS3_SEL_R1_DS64 0x0238 /*< ring-1: 64-bit flat data & stack selector. /
384	#define BS3_SEL_R1_CS16_EO 0x0240 /*< ring-1: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. /
385	#define BS3_SEL_R1_CS16_CNF 0x0248 /*< ring-1: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. /
386	#define BS3_SEL_R1_CS16_CNF_EO 0x0250 /*< ring-1: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. /
387	#define BS3_SEL_R1_CS32_EO 0x0258 /*< ring-1: 32-bit execute-only code selector, not accessed, flat. /
388	#define BS3_SEL_R1_CS32_CNF 0x0260 /*< ring-1: 32-bit conforming code selector, not accessed, flat. /
389	#define BS3_SEL_R1_CS32_CNF_EO 0x0268 /*< ring-1: 32-bit execute-only conforming code selector, not accessed, flat. /
390	#define BS3_SEL_R1_CS64_EO 0x0270 /*< ring-1: 64-bit execute-only code selector, not accessed, flat. /
391	#define BS3_SEL_R1_CS64_CNF 0x0278 /*< ring-1: 64-bit conforming code selector, not accessed, flat. /
392	#define BS3_SEL_R1_CS64_CNF_EO 0x0280 /*< ring-1: 64-bit execute-only conforming code selector, not accessed, flat. /
393
394	#define BS3_SEL_R2_FIRST 0x0300 /*< The first selector in the ring-2 block. /
395	#define BS3_SEL_R2_CS16 0x0300 /*< ring-2: 16-bit code selector, base 0x10000. /
396	#define BS3_SEL_R2_DS16 0x0308 /*< ring-2: 16-bit data selector, base 0x23000. /
397	#define BS3_SEL_R2_SS16 0x0310 /*< ring-2: 16-bit stack selector, base 0x00000. /
398	#define BS3_SEL_R2_CS32 0x0318 /*< ring-2: 32-bit flat code selector. /
399	#define BS3_SEL_R2_DS32 0x0320 /*< ring-2: 32-bit flat data selector. /
400	#define BS3_SEL_R2_SS32 0x0328 /*< ring-2: 32-bit flat stack selector. /
401	#define BS3_SEL_R2_CS64 0x0330 /*< ring-2: 64-bit flat code selector. /
402	#define BS3_SEL_R2_DS64 0x0338 /*< ring-2: 64-bit flat data & stack selector. /
403	#define BS3_SEL_R2_CS16_EO 0x0340 /*< ring-2: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. /
404	#define BS3_SEL_R2_CS16_CNF 0x0348 /*< ring-2: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. /
405	#define BS3_SEL_R2_CS16_CNF_EO 0x0350 /*< ring-2: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. /
406	#define BS3_SEL_R2_CS32_EO 0x0358 /*< ring-2: 32-bit execute-only code selector, not accessed, flat. /
407	#define BS3_SEL_R2_CS32_CNF 0x0360 /*< ring-2: 32-bit conforming code selector, not accessed, flat. /
408	#define BS3_SEL_R2_CS32_CNF_EO 0x0368 /*< ring-2: 32-bit execute-only conforming code selector, not accessed, flat. /
409	#define BS3_SEL_R2_CS64_EO 0x0370 /*< ring-2: 64-bit execute-only code selector, not accessed, flat. /
410	#define BS3_SEL_R2_CS64_CNF 0x0378 /*< ring-2: 64-bit conforming code selector, not accessed, flat. /
411	#define BS3_SEL_R2_CS64_CNF_EO 0x0380 /*< ring-2: 64-bit execute-only conforming code selector, not accessed, flat. /
412
413	#define BS3_SEL_R3_FIRST 0x0400 /*< The first selector in the ring-3 block. /
414	#define BS3_SEL_R3_CS16 0x0400 /*< ring-3: 16-bit code selector, base 0x10000. /
415	#define BS3_SEL_R3_DS16 0x0408 /*< ring-3: 16-bit data selector, base 0x23000. /
416	#define BS3_SEL_R3_SS16 0x0410 /*< ring-3: 16-bit stack selector, base 0x00000. /
417	#define BS3_SEL_R3_CS32 0x0418 /*< ring-3: 32-bit flat code selector. /
418	#define BS3_SEL_R3_DS32 0x0420 /*< ring-3: 32-bit flat data selector. /
419	#define BS3_SEL_R3_SS32 0x0428 /*< ring-3: 32-bit flat stack selector. /
420	#define BS3_SEL_R3_CS64 0x0430 /*< ring-3: 64-bit flat code selector. /
421	#define BS3_SEL_R3_DS64 0x0438 /*< ring-3: 64-bit flat data & stack selector. /
422	#define BS3_SEL_R3_CS16_EO 0x0440 /*< ring-3: 16-bit execute-only code selector, not accessed, 0xfffe limit, CS16 base. /
423	#define BS3_SEL_R3_CS16_CNF 0x0448 /*< ring-3: 16-bit conforming code selector, not accessed, 0xfffe limit, CS16 base. /
424	#define BS3_SEL_R3_CS16_CNF_EO 0x0450 /*< ring-3: 16-bit execute-only conforming code selector, not accessed, 0xfffe limit, CS16 base. /
425	#define BS3_SEL_R3_CS32_EO 0x0458 /*< ring-3: 32-bit execute-only code selector, not accessed, flat. /
426	#define BS3_SEL_R3_CS32_CNF 0x0460 /*< ring-3: 32-bit conforming code selector, not accessed, flat. /
427	#define BS3_SEL_R3_CS32_CNF_EO 0x0468 /*< ring-3: 32-bit execute-only conforming code selector, not accessed, flat. /
428	#define BS3_SEL_R3_CS64_EO 0x0470 /*< ring-3: 64-bit execute-only code selector, not accessed, flat. /
429	#define BS3_SEL_R3_CS64_CNF 0x0478 /*< ring-3: 64-bit conforming code selector, not accessed, flat. /
430	#define BS3_SEL_R3_CS64_CNF_EO 0x0480 /*< ring-3: 64-bit execute-only conforming code selector, not accessed, flat. /
431
432	#define BS3_SEL_R3_LAST 0x04f8 /*< ring-3: Last of the BS3_SEL_RX_XXX range. /
433
434	#define BS3_SEL_SPARE_FIRST 0x0500 /*< The first selector in the spare block /
435	#define BS3_SEL_SPARE_00 0x0500 /*< Spare selector number 00h. /
436	#define BS3_SEL_SPARE_01 0x0508 /*< Spare selector number 01h. /
437	#define BS3_SEL_SPARE_02 0x0510 /*< Spare selector number 02h. /
438	#define BS3_SEL_SPARE_03 0x0518 /*< Spare selector number 03h. /
439	#define BS3_SEL_SPARE_04 0x0520 /*< Spare selector number 04h. /
440	#define BS3_SEL_SPARE_05 0x0528 /*< Spare selector number 05h. /
441	#define BS3_SEL_SPARE_06 0x0530 /*< Spare selector number 06h. /
442	#define BS3_SEL_SPARE_07 0x0538 /*< Spare selector number 07h. /
443	#define BS3_SEL_SPARE_08 0x0540 /*< Spare selector number 08h. /
444	#define BS3_SEL_SPARE_09 0x0548 /*< Spare selector number 09h. /
445	#define BS3_SEL_SPARE_0a 0x0550 /*< Spare selector number 0ah. /
446	#define BS3_SEL_SPARE_0b 0x0558 /*< Spare selector number 0bh. /
447	#define BS3_SEL_SPARE_0c 0x0560 /*< Spare selector number 0ch. /
448	#define BS3_SEL_SPARE_0d 0x0568 /*< Spare selector number 0dh. /
449	#define BS3_SEL_SPARE_0e 0x0570 /*< Spare selector number 0eh. /
450	#define BS3_SEL_SPARE_0f 0x0578 /*< Spare selector number 0fh. /
451	#define BS3_SEL_SPARE_10 0x0580 /*< Spare selector number 10h. /
452	#define BS3_SEL_SPARE_11 0x0588 /*< Spare selector number 11h. /
453	#define BS3_SEL_SPARE_12 0x0590 /*< Spare selector number 12h. /
454	#define BS3_SEL_SPARE_13 0x0598 /*< Spare selector number 13h. /
455	#define BS3_SEL_SPARE_14 0x05a0 /*< Spare selector number 14h. /
456	#define BS3_SEL_SPARE_15 0x05a8 /*< Spare selector number 15h. /
457	#define BS3_SEL_SPARE_16 0x05b0 /*< Spare selector number 16h. /
458	#define BS3_SEL_SPARE_17 0x05b8 /*< Spare selector number 17h. /
459	#define BS3_SEL_SPARE_18 0x05c0 /*< Spare selector number 18h. /
460	#define BS3_SEL_SPARE_19 0x05c8 /*< Spare selector number 19h. /
461	#define BS3_SEL_SPARE_1a 0x05d0 /*< Spare selector number 1ah. /
462	#define BS3_SEL_SPARE_1b 0x05d8 /*< Spare selector number 1bh. /
463	#define BS3_SEL_SPARE_1c 0x05e0 /*< Spare selector number 1ch. /
464	#define BS3_SEL_SPARE_1d 0x05e8 /*< Spare selector number 1dh. /
465	#define BS3_SEL_SPARE_1e 0x05f0 /*< Spare selector number 1eh. /
466	#define BS3_SEL_SPARE_1f 0x05f8 /*< Spare selector number 1fh. /
467
468	#define BS3_SEL_TILED 0x0600 /*< 16-bit data tiling: First - base=0x00000000, limit=64KB, DPL=3. /
469	#define BS3_SEL_TILED_LAST 0x0df8 /*< 16-bit data tiling: Last - base=0x00ff0000, limit=64KB, DPL=3. /
470	#define BS3_SEL_TILED_AREA_SIZE 0x001000000 /*< 16-bit data tiling: Size of addressable area, in bytes. (16 MB) /
471
472	#define BS3_SEL_FREE_PART1 0x0e00 /*< Free selector space - part \#1. /
473	#define BS3_SEL_FREE_PART1_LAST 0x0ff8 /*< Free selector space - part \#1, last entry. /
474
475	#define BS3_SEL_TEXT16 0x1000 /*< The BS3TEXT16 selector. /
476
477	#define BS3_SEL_FREE_PART2 0x1008 /*< Free selector space - part \#2. /
478	#define BS3_SEL_FREE_PART2_LAST 0x17f8 /*< Free selector space - part \#2, last entry. /
479
480	#define BS3_SEL_TILED_R0 0x1800 /*< 16-bit data/stack tiling: First - base=0x00000000, limit=64KB, DPL=0. /
481	#define BS3_SEL_TILED_R0_LAST 0x1ff8 /*< 16-bit data/stack tiling: Last - base=0x00ff0000, limit=64KB, DPL=0. /
482
483	#define BS3_SEL_SYSTEM16 0x2000 /*< The BS3SYSTEM16 selector. /
484
485	#define BS3_SEL_FREE_PART3 0x2008 /*< Free selector space - part \#3. /
486	#define BS3_SEL_FREE_PART3_LAST 0x28f8 /*< Free selector space - part \#3, last entry. /
487
488	#define BS3_SEL_DATA16 0x2900 /*< The BS3DATA16/BS3KIT_GRPNM_DATA16 selector. /
489
490	#define BS3_SEL_FREE_PART4 0x2908 /*< Free selector space - part \#4. /
491	#define BS3_SEL_FREE_PART4_LAST 0x2f98 /*< Free selector space - part \#4, last entry. /
492
493	#define BS3_SEL_PRE_TEST_PAGE_08 0x2fa0 /*< Selector located 8 selectors before the test page. /
494	#define BS3_SEL_PRE_TEST_PAGE_07 0x2fa8 /*< Selector located 7 selectors before the test page. /
495	#define BS3_SEL_PRE_TEST_PAGE_06 0x2fb0 /*< Selector located 6 selectors before the test page. /
496	#define BS3_SEL_PRE_TEST_PAGE_05 0x2fb8 /*< Selector located 5 selectors before the test page. /
497	#define BS3_SEL_PRE_TEST_PAGE_04 0x2fc0 /*< Selector located 4 selectors before the test page. /
498	#define BS3_SEL_PRE_TEST_PAGE_03 0x2fc8 /*< Selector located 3 selectors before the test page. /
499	#define BS3_SEL_PRE_TEST_PAGE_02 0x2fd0 /*< Selector located 2 selectors before the test page. /
500	#define BS3_SEL_PRE_TEST_PAGE_01 0x2fd8 /*< Selector located 1 selector before the test page. /
501	#define BS3_SEL_TEST_PAGE 0x2fe0 /*< Start of the test page intended for playing around with paging and GDT. /
502	#define BS3_SEL_TEST_PAGE_00 0x2fe0 /*< Test page selector number 00h (convenience). /
503	#define BS3_SEL_TEST_PAGE_01 0x2fe8 /*< Test page selector number 01h (convenience). /
504	#define BS3_SEL_TEST_PAGE_02 0x2ff0 /*< Test page selector number 02h (convenience). /
505	#define BS3_SEL_TEST_PAGE_03 0x2ff8 /*< Test page selector number 03h (convenience). /
506	#define BS3_SEL_TEST_PAGE_04 0x3000 /*< Test page selector number 04h (convenience). /
507	#define BS3_SEL_TEST_PAGE_05 0x3008 /*< Test page selector number 05h (convenience). /
508	#define BS3_SEL_TEST_PAGE_06 0x3010 /*< Test page selector number 06h (convenience). /
509	#define BS3_SEL_TEST_PAGE_07 0x3018 /*< Test page selector number 07h (convenience). /
510	#define BS3_SEL_TEST_PAGE_LAST 0x3fd0 /*< The last selector in the spare page. /
511
512	#define BS3_SEL_GDT_LIMIT 0x3fd8 /*< The GDT limit. /
513	/** @} */
514
515
516	/** @def BS3_FAR
517	* For indicating far pointers in 16-bit code.
518	* Does nothing in 32-bit and 64-bit code. */
519	/** @def BS3_NEAR
520	* For indicating near pointers in 16-bit code.
521	* Does nothing in 32-bit and 64-bit code. */
522	/** @def BS3_FAR_CODE
523	* For indicating far 16-bit functions.
524	* Does nothing in 32-bit and 64-bit code. */
525	/** @def BS3_NEAR_CODE
526	* For indicating near 16-bit functions.
527	* Does nothing in 32-bit and 64-bit code. */
528	/** @def BS3_FAR_DATA
529	* For indicating far 16-bit external data, i.e. in a segment other than DATA16.
530	* Does nothing in 32-bit and 64-bit code. */
531	#ifdef M_I86
532	# define BS3_FAR __far
533	# define BS3_NEAR __near
534	# define BS3_FAR_CODE __far
535	# define BS3_NEAR_CODE __near
536	# define BS3_FAR_DATA __far
537	#else
538	# define BS3_FAR
539	# define BS3_NEAR
540	# define BS3_FAR_CODE
541	# define BS3_NEAR_CODE
542	# define BS3_FAR_DATA
543	#endif
544
545	#if ARCH_BITS == 16 \|\| defined(DOXYGEN_RUNNING)
546	/** @def BS3_FP_SEG
547	* Get the selector (segment) part of a far pointer.
548	*
549	* @returns selector.
550	* @param a_pv Far pointer.
551	*/
552	# define BS3_FP_SEG(a_pv) ((uint16_t)(__segment)(void BS3_FAR *)(a_pv))
553	/** @def BS3_FP_OFF
554	* Get the segment offset part of a far pointer.
555	*
556	* For sake of convenience, this works like a uintptr_t cast in 32-bit and
557	* 64-bit code.
558	*
559	* @returns offset.
560	* @param a_pv Far pointer.
561	*/
562	# define BS3_FP_OFF(a_pv) ((uint16_t)(void __near *)(a_pv))
563	/** @def BS3_FP_MAKE
564	* Create a far pointer.
565	*
566	* @returns Far pointer.
567	* @param a_uSeg The selector/segment.
568	* @param a_off The offset into the segment.
569	*/
570	# define BS3_FP_MAKE(a_uSeg, a_off) (((__segment)(a_uSeg)) :> ((void __near *)(a_off)))
571	#else
572	# define BS3_FP_OFF(a_pv) ((uintptr_t)(a_pv))
573	#endif
574
575	/** @def BS3_MAKE_PROT_R0PTR_FROM_FLAT
576	* Creates a protected mode pointer from a flat address.
577	*
578	* For sake of convenience, this macro also works in 32-bit and 64-bit mode,
579	* only there it doesn't return a far pointer but a flat point.
580	*
581	* @returns far void pointer if 16-bit code, near/flat void pointer in 32-bit
582	* and 64-bit.
583	* @param a_uFlat Flat address in the first 16MB. */
584	#if ARCH_BITS == 16
585	# define BS3_MAKE_PROT_R0PTR_FROM_FLAT(a_uFlat) \
586	BS3_FP_MAKE(((uint16_t)(a_uFlat >> 16) << 3) + BS3_SEL_TILED, (uint16_t)(a_uFlat))
587	#else
588	# define BS3_MAKE_PROT_R0PTR_FROM_FLAT(a_uFlat) ((void *)(uintptr_t)(a_uFlat))
589	#endif
590
591	/** @def BS3_MAKE_PROT_R0PTR_FROM_REAL
592	* Creates a protected mode pointer from a far real mode address.
593	*
594	* For sake of convenience, this macro also works in 32-bit and 64-bit mode,
595	* only there it doesn't return a far pointer but a flat point.
596	*
597	* @returns far void pointer if 16-bit code, near/flat void pointer in 32-bit
598	* and 64-bit.
599	* @param a_uSeg The selector/segment.
600	* @param a_off The offset into the segment.
601	*/
602	#if ARCH_BITS == 16
603	# define BS3_MAKE_PROT_R0PTR_FROM_REAL(a_uSeg, a_off) BS3_MAKE_PROT_R0PTR_FROM_FLAT(((uint32_t)(a_uSeg) << 4) + (uint16_t)(a_off))
604	#else
605	# define BS3_MAKE_PROT_R0PTR_FROM_REAL(a_uSeg, a_off) ( (void *)(uintptr_t)(((uint32_t)(a_uSeg) << 4) + (uint16_t)(a_off)) )
606	#endif
607
608
609	/** @def BS3_CALL
610	* The calling convension used by BS3 functions. */
611	#if ARCH_BITS != 64
612	# define BS3_CALL __cdecl
613	#elif !defined(_MSC_VER)
614	# define BS3_CALL __attribute__((__ms_abi__))
615	#else
616	# define BS3_CALL
617	#endif
618
619	/** @def IN_BS3KIT
620	* Indicates that we're in the same link job as the BS3Kit code. */
621	#ifdef DOXYGEN_RUNNING
622	# define IN_BS3KIT
623	#endif
624
625	/** @def BS3_DECL
626	* Declares a BS3Kit function with default far/near.
627	*
628	* Until we outgrow BS3TEXT16, we use all near functions in 16-bit.
629	*
630	* @param a_Type The return type. */
631	#if ARCH_BITS != 16 \|\| !defined(BS3_USE_ALT_16BIT_TEXT_SEG)
632	# define BS3_DECL(a_Type) BS3_DECL_NEAR(a_Type)
633	#else
634	# define BS3_DECL(a_Type) BS3_DECL_FAR(a_Type)
635	#endif
636
637	/** @def BS3_DECL_NEAR
638	* Declares a BS3Kit function, always near everywhere.
639	*
640	* Until we outgrow BS3TEXT16, we use all near functions in 16-bit.
641	*
642	* @param a_Type The return type. */
643	#ifdef IN_BS3KIT
644	# define BS3_DECL_NEAR(a_Type) DECLEXPORT(a_Type) BS3_NEAR_CODE BS3_CALL
645	#else
646	# define BS3_DECL_NEAR(a_Type) DECLIMPORT(a_Type) BS3_NEAR_CODE BS3_CALL
647	#endif
648
649	/** @def BS3_DECL_FAR
650	* Declares a BS3Kit function, far 16-bit, otherwise near.
651	*
652	* Until we outgrow BS3TEXT16, we use all near functions in 16-bit.
653	*
654	* @param a_Type The return type. */
655	#ifdef IN_BS3KIT
656	# define BS3_DECL_FAR(a_Type) DECLEXPORT(a_Type) BS3_FAR_CODE BS3_CALL
657	#else
658	# define BS3_DECL_FAR(a_Type) DECLIMPORT(a_Type) BS3_FAR_CODE BS3_CALL
659	#endif
660
661	/** @def BS3_DECL_CALLBACK
662	* Declares a BS3Kit callback function (typically static).
663	*
664	* @param a_Type The return type. */
665	#ifdef IN_BS3KIT
666	# define BS3_DECL_CALLBACK(a_Type) a_Type BS3_FAR_CODE BS3_CALL
667	#else
668	# define BS3_DECL_CALLBACK(a_Type) a_Type BS3_FAR_CODE BS3_CALL
669	#endif
670
671	/** @def BS3_DECL_NEAR_CALLBACK
672	* Declares a near BS3Kit callback function (typically static).
673	*
674	* 16-bit users must be in CGROUP16!
675	*
676	* @param a_Type The return type. */
677	#ifdef IN_BS3KIT
678	# define BS3_DECL_NEAR_CALLBACK(a_Type) a_Type BS3_NEAR_CODE BS3_CALL
679	#else
680	# define BS3_DECL_NEAR_CALLBACK(a_Type) a_Type BS3_NEAR_CODE BS3_CALL
681	#endif
682
683	/**
684	* Constructs a common name.
685	*
686	* Example: BS3_CMN_NM(Bs3Shutdown)
687	*
688	* @param a_Name The name of the function or global variable.
689	*/
690	#define BS3_CMN_NM(a_Name) RT_CONCAT3(a_Name,_c,ARCH_BITS)
691
692	/**
693	* Constructs a common function name, far in 16-bit code.
694	*
695	* Example: BS3_CMN_FAR_NM(Bs3Shutdown)
696	*
697	* @param a_Name The name of the function.
698	*/
699	#if ARCH_BITS == 16
700	# define BS3_CMN_FAR_NM(a_Name) RT_CONCAT(a_Name,_f16)
701	#else
702	# define BS3_CMN_FAR_NM(a_Name) RT_CONCAT3(a_Name,_c,ARCH_BITS)
703	#endif
704
705	/**
706	* Constructs a common function name, far or near as defined by the source.
707	*
708	* Which to use in 16-bit mode is defined by BS3_USE_ALT_16BIT_TEXT_SEG. In
709	* 32-bit and 64-bit mode there are no far symbols, only near ones.
710	*
711	* Example: BS3_CMN_FN_NM(Bs3Shutdown)
712	*
713	* @param a_Name The name of the function.
714	*/
715	#if ARCH_BITS != 16 \|\| !defined(BS3_USE_ALT_16BIT_TEXT_SEG)
716	# define BS3_CMN_FN_NM(a_Name) BS3_CMN_NM(a_Name)
717	#else
718	# define BS3_CMN_FN_NM(a_Name) BS3_CMN_FAR_NM(a_Name)
719	#endif
720
721
722	/**
723	* Constructs a data name.
724	*
725	* This glosses over the underscore prefix usage of our 16-bit, 32-bit and
726	* 64-bit compilers.
727	*
728	* Example: @code{.c}
729	* \#define Bs3Gdt BS3_DATA_NM(Bs3Gdt)
730	* extern X86DESC BS3_FAR_DATA Bs3Gdt
731	* @endcode
732	*
733	* @param a_Name The name of the global variable.
734	* @remarks Mainly used in bs3kit-mangling.h, internal headers and templates.
735	*/
736	//converter does this now//#if ARCH_BITS == 64
737	//converter does this now//# define BS3_DATA_NM(a_Name) RT_CONCAT(_,a_Name)
738	//converter does this now//#else
739	# define BS3_DATA_NM(a_Name) a_Name
740	//converter does this now//#endif
741
742	/**
743	* Template for creating a pointer union type.
744	* @param a_BaseName The base type name.
745	* @param a_Modifiers The type modifier.
746	*/
747	#define BS3_PTR_UNION_TEMPLATE(a_BaseName, a_Modifiers) \
748	typedef union a_BaseName \
749	{ \
750	/** Pointer into the void. */ \
751	a_Modifiers void BS3_FAR *pv; \
752	/** As a signed integer. */ \
753	intptr_t i; \
754	/** As an unsigned integer. */ \
755	uintptr_t u; \
756	/** Pointer to char value. */ \
757	a_Modifiers char BS3_FAR *pch; \
758	/** Pointer to char value. */ \
759	a_Modifiers unsigned char BS3_FAR *puch; \
760	/** Pointer to a int value. */ \
761	a_Modifiers int BS3_FAR *pi; \
762	/** Pointer to a unsigned int value. */ \
763	a_Modifiers unsigned int BS3_FAR *pu; \
764	/** Pointer to a long value. */ \
765	a_Modifiers long BS3_FAR *pl; \
766	/** Pointer to a long value. */ \
767	a_Modifiers unsigned long BS3_FAR *pul; \
768	/** Pointer to a memory size value. */ \
769	a_Modifiers size_t BS3_FAR *pcb; \
770	/** Pointer to a byte value. */ \
771	a_Modifiers uint8_t BS3_FAR *pb; \
772	/** Pointer to a 8-bit unsigned value. */ \
773	a_Modifiers uint8_t BS3_FAR *pu8; \
774	/** Pointer to a 16-bit unsigned value. */ \
775	a_Modifiers uint16_t BS3_FAR *pu16; \
776	/** Pointer to a 32-bit unsigned value. */ \
777	a_Modifiers uint32_t BS3_FAR *pu32; \
778	/** Pointer to a 64-bit unsigned value. */ \
779	a_Modifiers uint64_t BS3_FAR *pu64; \
780	/** Pointer to a UTF-16 character. */ \
781	a_Modifiers RTUTF16 BS3_FAR *pwc; \
782	/** Pointer to a UUID character. */ \
783	a_Modifiers RTUUID BS3_FAR *pUuid; \
784	} a_BaseName; \
785	/** Pointer to a pointer union. */ \
786	typedef a_BaseName *RT_CONCAT(P,a_BaseName)
787	BS3_PTR_UNION_TEMPLATE(BS3PTRUNION, RT_NOTHING);
788	BS3_PTR_UNION_TEMPLATE(BS3CPTRUNION, const);
789	BS3_PTR_UNION_TEMPLATE(BS3VPTRUNION, volatile);
790	BS3_PTR_UNION_TEMPLATE(BS3CVPTRUNION, const volatile);
791
792	/** Generic far function type. */
793	typedef BS3_DECL_FAR(void) FNBS3FAR(void);
794	/** Generic far function pointer type. */
795	typedef FNBS3FAR *FPFNBS3FAR;
796
797	/** Generic near function type. */
798	typedef BS3_DECL_NEAR(void) FNBS3NEAR(void);
799	/** Generic near function pointer type. */
800	typedef FNBS3NEAR *PFNBS3NEAR;
801
802	/** Generic far 16:16 function pointer type for address conversion functions. */
803	#if ARCH_BITS == 16
804	typedef FPFNBS3FAR PFNBS3FARADDRCONV;
805	#else
806	typedef uint32_t PFNBS3FARADDRCONV;
807	#endif
808
809	/** The system call vector. */
810	#define BS3_TRAP_SYSCALL UINT8_C(0x20)
811
812	/** @name System call numbers (ax).
813	* Paramenters are generally passed in registers specific to each system call,
814	* however cx:xSI is used for passing a pointer parameter.
815	* @{ */
816	/** Print char (cl). */
817	#define BS3_SYSCALL_PRINT_CHR UINT16_C(0x0001)
818	/** Print string (pointer in cx:xSI, length in dx). */
819	#define BS3_SYSCALL_PRINT_STR UINT16_C(0x0002)
820	/** Switch to ring-0. */
821	#define BS3_SYSCALL_TO_RING0 UINT16_C(0x0003)
822	/** Switch to ring-1. */
823	#define BS3_SYSCALL_TO_RING1 UINT16_C(0x0004)
824	/** Switch to ring-2. */
825	#define BS3_SYSCALL_TO_RING2 UINT16_C(0x0005)
826	/** Switch to ring-3. */
827	#define BS3_SYSCALL_TO_RING3 UINT16_C(0x0006)
828	/** Restore context (pointer in cx:xSI, flags in dx). */
829	#define BS3_SYSCALL_RESTORE_CTX UINT16_C(0x0007)
830	/** @} */
831
832
833
834	/** @defgroup grp_bs3kit_system System Structures
835	* @{ */
836	/** The GDT, indexed by BS3_SEL_XXX shifted by 3. */
837	extern X86DESC BS3_FAR_DATA Bs3Gdt[(BS3_SEL_GDT_LIMIT + 1) / 8];
838
839	extern X86DESC64 BS3_FAR_DATA Bs3Gdt_Ldt; /*< @see BS3_SEL_LDT /
840	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss16; /*< @see BS3_SEL_TSS16 /
841	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss16DoubleFault; /*< @see BS3_SEL_TSS16_DF /
842	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss16Spare0; /*< @see BS3_SEL_TSS16_SPARE0 /
843	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss16Spare1; /*< @see BS3_SEL_TSS16_SPARE1 /
844	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32; /*< @see BS3_SEL_TSS32 /
845	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32DoubleFault; /*< @see BS3_SEL_TSS32_DF /
846	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32Spare0; /*< @see BS3_SEL_TSS32_SPARE0 /
847	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32Spare1; /*< @see BS3_SEL_TSS32_SPARE1 /
848	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32IobpIntRedirBm; /*< @see BS3_SEL_TSS32_IOBP_IRB /
849	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss32IntRedirBm; /*< @see BS3_SEL_TSS32_IRB /
850	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss64; /*< @see BS3_SEL_TSS64 /
851	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss64Spare0; /*< @see BS3_SEL_TSS64_SPARE0 /
852	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss64Spare1; /*< @see BS3_SEL_TSS64_SPARE1 /
853	extern X86DESC BS3_FAR_DATA Bs3Gdte_Tss64Iobp; /*< @see BS3_SEL_TSS64_IOBP /
854	extern X86DESC BS3_FAR_DATA Bs3Gdte_RMTEXT16_CS; /*< @see BS3_SEL_RMTEXT16_CS /
855	extern X86DESC BS3_FAR_DATA Bs3Gdte_X0TEXT16_CS; /*< @see BS3_SEL_X0TEXT16_CS /
856	extern X86DESC BS3_FAR_DATA Bs3Gdte_X1TEXT16_CS; /*< @see BS3_SEL_X1TEXT16_CS /
857	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_MMIO16; /*< @see BS3_SEL_VMMDEV_MMIO16 /
858
859	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_First; /*< @see BS3_SEL_R0_FIRST /
860	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS16; /*< @see BS3_SEL_R0_CS16 /
861	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_DS16; /*< @see BS3_SEL_R0_DS16 /
862	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_SS16; /*< @see BS3_SEL_R0_SS16 /
863	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS32; /*< @see BS3_SEL_R0_CS32 /
864	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_DS32; /*< @see BS3_SEL_R0_DS32 /
865	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_SS32; /*< @see BS3_SEL_R0_SS32 /
866	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS64; /*< @see BS3_SEL_R0_CS64 /
867	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_DS64; /*< @see BS3_SEL_R0_DS64 /
868	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS16_EO; /*< @see BS3_SEL_R0_CS16_EO /
869	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS16_CNF; /*< @see BS3_SEL_R0_CS16_CNF /
870	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS16_CND_EO; /*< @see BS3_SEL_R0_CS16_CNF_EO /
871	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS32_EO; /*< @see BS3_SEL_R0_CS32_EO /
872	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS32_CNF; /*< @see BS3_SEL_R0_CS32_CNF /
873	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS32_CNF_EO; /*< @see BS3_SEL_R0_CS32_CNF_EO /
874	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS64_EO; /*< @see BS3_SEL_R0_CS64_EO /
875	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS64_CNF; /*< @see BS3_SEL_R0_CS64_CNF /
876	extern X86DESC BS3_FAR_DATA Bs3Gdte_R0_CS64_CNF_EO; /*< @see BS3_SEL_R0_CS64_CNF_EO /
877
878	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_First; /*< @see BS3_SEL_R1_FIRST /
879	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS16; /*< @see BS3_SEL_R1_CS16 /
880	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_DS16; /*< @see BS3_SEL_R1_DS16 /
881	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_SS16; /*< @see BS3_SEL_R1_SS16 /
882	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS32; /*< @see BS3_SEL_R1_CS32 /
883	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_DS32; /*< @see BS3_SEL_R1_DS32 /
884	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_SS32; /*< @see BS3_SEL_R1_SS32 /
885	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS64; /*< @see BS3_SEL_R1_CS64 /
886	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_DS64; /*< @see BS3_SEL_R1_DS64 /
887	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS16_EO; /*< @see BS3_SEL_R1_CS16_EO /
888	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS16_CNF; /*< @see BS3_SEL_R1_CS16_CNF /
889	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS16_CND_EO; /*< @see BS3_SEL_R1_CS16_CNF_EO /
890	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS32_EO; /*< @see BS3_SEL_R1_CS32_EO /
891	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS32_CNF; /*< @see BS3_SEL_R1_CS32_CNF /
892	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS32_CNF_EO; /*< @see BS3_SEL_R1_CS32_CNF_EO /
893	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS64_EO; /*< @see BS3_SEL_R1_CS64_EO /
894	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS64_CNF; /*< @see BS3_SEL_R1_CS64_CNF /
895	extern X86DESC BS3_FAR_DATA Bs3Gdte_R1_CS64_CNF_EO; /*< @see BS3_SEL_R1_CS64_CNF_EO /
896
897	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_First; /*< @see BS3_SEL_R2_FIRST /
898	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS16; /*< @see BS3_SEL_R2_CS16 /
899	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_DS16; /*< @see BS3_SEL_R2_DS16 /
900	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_SS16; /*< @see BS3_SEL_R2_SS16 /
901	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS32; /*< @see BS3_SEL_R2_CS32 /
902	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_DS32; /*< @see BS3_SEL_R2_DS32 /
903	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_SS32; /*< @see BS3_SEL_R2_SS32 /
904	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS64; /*< @see BS3_SEL_R2_CS64 /
905	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_DS64; /*< @see BS3_SEL_R2_DS64 /
906	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS16_EO; /*< @see BS3_SEL_R2_CS16_EO /
907	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS16_CNF; /*< @see BS3_SEL_R2_CS16_CNF /
908	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS16_CND_EO; /*< @see BS3_SEL_R2_CS16_CNF_EO /
909	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS32_EO; /*< @see BS3_SEL_R2_CS32_EO /
910	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS32_CNF; /*< @see BS3_SEL_R2_CS32_CNF /
911	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS32_CNF_EO; /*< @see BS3_SEL_R2_CS32_CNF_EO /
912	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS64_EO; /*< @see BS3_SEL_R2_CS64_EO /
913	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS64_CNF; /*< @see BS3_SEL_R2_CS64_CNF /
914	extern X86DESC BS3_FAR_DATA Bs3Gdte_R2_CS64_CNF_EO; /*< @see BS3_SEL_R2_CS64_CNF_EO /
915
916	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_First; /*< @see BS3_SEL_R3_FIRST /
917	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS16; /*< @see BS3_SEL_R3_CS16 /
918	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_DS16; /*< @see BS3_SEL_R3_DS16 /
919	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_SS16; /*< @see BS3_SEL_R3_SS16 /
920	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS32; /*< @see BS3_SEL_R3_CS32 /
921	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_DS32; /*< @see BS3_SEL_R3_DS32 /
922	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_SS32; /*< @see BS3_SEL_R3_SS32 /
923	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS64; /*< @see BS3_SEL_R3_CS64 /
924	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_DS64; /*< @see BS3_SEL_R3_DS64 /
925	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS16_EO; /*< @see BS3_SEL_R3_CS16_EO /
926	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS16_CNF; /*< @see BS3_SEL_R3_CS16_CNF /
927	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS16_CND_EO; /*< @see BS3_SEL_R3_CS16_CNF_EO /
928	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS32_EO; /*< @see BS3_SEL_R3_CS32_EO /
929	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS32_CNF; /*< @see BS3_SEL_R3_CS32_CNF /
930	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS32_CNF_EO; /*< @see BS3_SEL_R3_CS32_CNF_EO /
931	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS64_EO; /*< @see BS3_SEL_R3_CS64_EO /
932	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS64_CNF; /*< @see BS3_SEL_R3_CS64_CNF /
933	extern X86DESC BS3_FAR_DATA Bs3Gdte_R3_CS64_CNF_EO; /*< @see BS3_SEL_R3_CS64_CNF_EO /
934
935	extern X86DESC BS3_FAR_DATA Bs3GdteSpare00; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_00 /
936	extern X86DESC BS3_FAR_DATA Bs3GdteSpare01; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_01 /
937	extern X86DESC BS3_FAR_DATA Bs3GdteSpare02; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_02 /
938	extern X86DESC BS3_FAR_DATA Bs3GdteSpare03; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_03 /
939	extern X86DESC BS3_FAR_DATA Bs3GdteSpare04; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_04 /
940	extern X86DESC BS3_FAR_DATA Bs3GdteSpare05; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_05 /
941	extern X86DESC BS3_FAR_DATA Bs3GdteSpare06; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_06 /
942	extern X86DESC BS3_FAR_DATA Bs3GdteSpare07; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_07 /
943	extern X86DESC BS3_FAR_DATA Bs3GdteSpare08; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_08 /
944	extern X86DESC BS3_FAR_DATA Bs3GdteSpare09; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_09 /
945	extern X86DESC BS3_FAR_DATA Bs3GdteSpare0a; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0a /
946	extern X86DESC BS3_FAR_DATA Bs3GdteSpare0b; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0b /
947	extern X86DESC BS3_FAR_DATA Bs3GdteSpare0c; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0c /
948	extern X86DESC BS3_FAR_DATA Bs3GdteSpare0d; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0d /
949	extern X86DESC BS3_FAR_DATA Bs3GdteSpare0e; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0e /
950	extern X86DESC BS3_FAR_DATA Bs3GdteSpare0f; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_0f /
951	extern X86DESC BS3_FAR_DATA Bs3GdteSpare10; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_10 /
952	extern X86DESC BS3_FAR_DATA Bs3GdteSpare11; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_11 /
953	extern X86DESC BS3_FAR_DATA Bs3GdteSpare12; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_12 /
954	extern X86DESC BS3_FAR_DATA Bs3GdteSpare13; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_13 /
955	extern X86DESC BS3_FAR_DATA Bs3GdteSpare14; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_14 /
956	extern X86DESC BS3_FAR_DATA Bs3GdteSpare15; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_15 /
957	extern X86DESC BS3_FAR_DATA Bs3GdteSpare16; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_16 /
958	extern X86DESC BS3_FAR_DATA Bs3GdteSpare17; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_17 /
959	extern X86DESC BS3_FAR_DATA Bs3GdteSpare18; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_18 /
960	extern X86DESC BS3_FAR_DATA Bs3GdteSpare19; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_19 /
961	extern X86DESC BS3_FAR_DATA Bs3GdteSpare1a; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1a /
962	extern X86DESC BS3_FAR_DATA Bs3GdteSpare1b; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1b /
963	extern X86DESC BS3_FAR_DATA Bs3GdteSpare1c; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1c /
964	extern X86DESC BS3_FAR_DATA Bs3GdteSpare1d; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1d /
965	extern X86DESC BS3_FAR_DATA Bs3GdteSpare1e; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1e /
966	extern X86DESC BS3_FAR_DATA Bs3GdteSpare1f; /*< GDT entry for playing with in testcases. @see BS3_SEL_SPARE_1f /
967
968	/** GDTs setting up the tiled 16-bit access to the first 16 MBs of memory.
969	* @see BS3_SEL_TILED, BS3_SEL_TILED_LAST, BS3_SEL_TILED_AREA_SIZE */
970	extern X86DESC BS3_FAR_DATA Bs3GdteTiled[256];
971	/** Free GDTes, part \#1. */
972	extern X86DESC BS3_FAR_DATA Bs3GdteFreePart1[64];
973	/** The BS3TEXT16/BS3CLASS16CODE GDT entry. @see BS3_SEL_TEXT16 */
974	extern X86DESC BS3_FAR_DATA Bs3Gdte_CODE16;
975	/** Free GDTes, part \#2. */
976	extern X86DESC BS3_FAR_DATA Bs3GdteFreePart2[511];
977	/** The BS3SYSTEM16 GDT entry. */
978	extern X86DESC BS3_FAR_DATA Bs3Gdte_SYSTEM16;
979	/** Free GDTes, part \#3. */
980	extern X86DESC BS3_FAR_DATA Bs3GdteFreePart3[223];
981	/** The BS3DATA16/BS3KIT_GRPNM_DATA16 GDT entry. */
982	extern X86DESC BS3_FAR_DATA Bs3Gdte_DATA16;
983
984	/** Free GDTes, part \#4. */
985	extern X86DESC BS3_FAR_DATA Bs3GdteFreePart4[211];
986
987	extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage08; /*< GDT entry 8 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_08 /
988	extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage07; /*< GDT entry 7 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_07 /
989	extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage06; /*< GDT entry 6 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_06 /
990	extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage05; /*< GDT entry 5 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_05 /
991	extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage04; /*< GDT entry 4 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_04 /
992	extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage03; /*< GDT entry 3 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_03 /
993	extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage02; /*< GDT entry 2 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_02 /
994	extern X86DESC BS3_FAR_DATA Bs3GdtePreTestPage01; /*< GDT entry 1 selectors prior to the test page, testcase resource. @see BS3_SEL_PRE_TEST_PAGE_01 /
995	/** Array of GDT entries starting on a page boundrary and filling (almost) the
996	* whole page. This is for playing with paging and GDT usage.
997	* @see BS3_SEL_TEST_PAGE */
998	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage[2043];
999	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage00; /*< GDT entry 0 on the test page (convenience). @see BS3_SEL_TEST_PAGE_00 /
1000	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage01; /*< GDT entry 1 on the test page (convenience). @see BS3_SEL_TEST_PAGE_01 /
1001	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage02; /*< GDT entry 2 on the test page (convenience). @see BS3_SEL_TEST_PAGE_02 /
1002	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage03; /*< GDT entry 3 on the test page (convenience). @see BS3_SEL_TEST_PAGE_03 /
1003	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage04; /*< GDT entry 4 on the test page (convenience). @see BS3_SEL_TEST_PAGE_04 /
1004	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage05; /*< GDT entry 5 on the test page (convenience). @see BS3_SEL_TEST_PAGE_05 /
1005	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage06; /*< GDT entry 6 on the test page (convenience). @see BS3_SEL_TEST_PAGE_06 /
1006	extern X86DESC BS3_FAR_DATA Bs3GdteTestPage07; /*< GDT entry 7 on the test page (convenience). @see BS3_SEL_TEST_PAGE_07 /
1007
1008	/** The end of the GDT (exclusive - contains eye-catcher string). */
1009	extern X86DESC BS3_FAR_DATA Bs3GdtEnd;
1010
1011	/** The default 16-bit TSS. */
1012	extern X86TSS16 BS3_FAR_DATA Bs3Tss16;
1013	extern X86TSS16 BS3_FAR_DATA Bs3Tss16DoubleFault;
1014	extern X86TSS16 BS3_FAR_DATA Bs3Tss16Spare0;
1015	extern X86TSS16 BS3_FAR_DATA Bs3Tss16Spare1;
1016	/** The default 32-bit TSS. */
1017	extern X86TSS32 BS3_FAR_DATA Bs3Tss32;
1018	extern X86TSS32 BS3_FAR_DATA Bs3Tss32DoubleFault;
1019	extern X86TSS32 BS3_FAR_DATA Bs3Tss32Spare0;
1020	extern X86TSS32 BS3_FAR_DATA Bs3Tss32Spare1;
1021	/** The default 64-bit TSS. */
1022	extern X86TSS64 BS3_FAR_DATA Bs3Tss64;
1023	extern X86TSS64 BS3_FAR_DATA Bs3Tss64Spare0;
1024	extern X86TSS64 BS3_FAR_DATA Bs3Tss64Spare1;
1025	extern X86TSS64 BS3_FAR_DATA Bs3Tss64WithIopb;
1026	extern X86TSS32 BS3_FAR_DATA Bs3Tss32WithIopb;
1027	/** Interrupt redirection bitmap used by Bs3Tss32WithIopb. */
1028	extern uint8_t BS3_FAR_DATA Bs3SharedIntRedirBm[32];
1029	/** I/O permission bitmap used by Bs3Tss32WithIopb and Bs3Tss64WithIopb. */
1030	extern uint8_t BS3_FAR_DATA Bs3SharedIobp[8192+2];
1031	/** End of the I/O permission bitmap (exclusive). */
1032	extern uint8_t BS3_FAR_DATA Bs3SharedIobpEnd;
1033	/** 16-bit IDT. */
1034	extern X86DESC BS3_FAR_DATA Bs3Idt16[256];
1035	/** 32-bit IDT. */
1036	extern X86DESC BS3_FAR_DATA Bs3Idt32[256];
1037	/** 64-bit IDT. */
1038	extern X86DESC64 BS3_FAR_DATA Bs3Idt64[256];
1039	/** Structure for the LIDT instruction for loading the 16-bit IDT. */
1040	extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Idt16;
1041	/** Structure for the LIDT instruction for loading the 32-bit IDT. */
1042	extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Idt32;
1043	/** Structure for the LIDT instruction for loading the 64-bit IDT. */
1044	extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Idt64;
1045	/** Structure for the LIDT instruction for loading the real mode interrupt
1046	* vector table. */
1047	extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Ivt;
1048	/** Structure for the LGDT instruction for loading the current GDT. */
1049	extern X86XDTR64 BS3_FAR_DATA Bs3Lgdt_Gdt;
1050	/** Structure for the LGDT instruction for loading the default GDT. */
1051	extern X86XDTR64 BS3_FAR_DATA Bs3LgdtDef_Gdt;
1052	/** The LDT (all entries are empty, fill in for testing). */
1053	extern X86DESC BS3_FAR_DATA Bs3Ldt[116];
1054	/** The end of the LDT (exclusive). */
1055	extern X86DESC BS3_FAR_DATA Bs3LdtEnd;
1056
1057	/** @} */
1058
1059
1060	/** @name Segment start and end markers, sizes.
1061	* @{ */
1062	/** Start of the BS3TEXT16 segment. */
1063	extern uint8_t BS3_FAR_DATA Bs3Text16_StartOfSegment;
1064	/** End of the BS3TEXT16 segment. */
1065	extern uint8_t BS3_FAR_DATA Bs3Text16_EndOfSegment;
1066	/** The size of the BS3TEXT16 segment. */
1067	extern uint16_t BS3_FAR_DATA Bs3Text16_Size;
1068
1069	/** Start of the BS3SYSTEM16 segment. */
1070	extern uint8_t BS3_FAR_DATA Bs3System16_StartOfSegment;
1071	/** End of the BS3SYSTEM16 segment. */
1072	extern uint8_t BS3_FAR_DATA Bs3System16_EndOfSegment;
1073
1074	/** Start of the BS3DATA16/BS3KIT_GRPNM_DATA16 segment. */
1075	extern uint8_t BS3_FAR_DATA Bs3Data16_StartOfSegment;
1076	/** End of the BS3DATA16/BS3KIT_GRPNM_DATA16 segment. */
1077	extern uint8_t BS3_FAR_DATA Bs3Data16_EndOfSegment;
1078
1079	/** Start of the BS3RMTEXT16 segment. */
1080	extern uint8_t BS3_FAR_DATA Bs3RmText16_StartOfSegment;
1081	/** End of the BS3RMTEXT16 segment. */
1082	extern uint8_t BS3_FAR_DATA Bs3RmText16_EndOfSegment;
1083	/** The size of the BS3RMTEXT16 segment. */
1084	extern uint16_t BS3_FAR_DATA Bs3RmText16_Size;
1085	/** The flat start address of the BS3X0TEXT16 segment. */
1086	extern uint32_t BS3_FAR_DATA Bs3RmText16_FlatAddr;
1087
1088	/** Start of the BS3X0TEXT16 segment. */
1089	extern uint8_t BS3_FAR_DATA Bs3X0Text16_StartOfSegment;
1090	/** End of the BS3X0TEXT16 segment. */
1091	extern uint8_t BS3_FAR_DATA Bs3X0Text16_EndOfSegment;
1092	/** The size of the BS3X0TEXT16 segment. */
1093	extern uint16_t BS3_FAR_DATA Bs3X0Text16_Size;
1094	/** The flat start address of the BS3X0TEXT16 segment. */
1095	extern uint32_t BS3_FAR_DATA Bs3X0Text16_FlatAddr;
1096
1097	/** Start of the BS3X1TEXT16 segment. */
1098	extern uint8_t BS3_FAR_DATA Bs3X1Text16_StartOfSegment;
1099	/** End of the BS3X1TEXT16 segment. */
1100	extern uint8_t BS3_FAR_DATA Bs3X1Text16_EndOfSegment;
1101	/** The size of the BS3X1TEXT16 segment. */
1102	extern uint16_t BS3_FAR_DATA Bs3X1Text16_Size;
1103	/** The flat start address of the BS3X1TEXT16 segment. */
1104	extern uint32_t BS3_FAR_DATA Bs3X1Text16_FlatAddr;
1105
1106	/** Start of the BS3TEXT32 segment. */
1107	extern uint8_t BS3_FAR_DATA Bs3Text32_StartOfSegment;
1108	/** Start of the BS3TEXT32 segment. */
1109	extern uint8_t BS3_FAR_DATA Bs3Text32_EndOfSegment;
1110
1111	/** Start of the BS3DATA32 segment. */
1112	extern uint8_t BS3_FAR_DATA Bs3Data32_StartOfSegment;
1113	/** Start of the BS3DATA32 segment. */
1114	extern uint8_t BS3_FAR_DATA Bs3Data32_EndOfSegment;
1115
1116	/** Start of the BS3TEXT64 segment. */
1117	extern uint8_t BS3_FAR_DATA Bs3Text64_StartOfSegment;
1118	/** Start of the BS3TEXT64 segment. */
1119	extern uint8_t BS3_FAR_DATA Bs3Text64_EndOfSegment;
1120
1121	/** Start of the BS3DATA64 segment. */
1122	extern uint8_t BS3_FAR_DATA Bs3Data64_StartOfSegment;
1123	/** Start of the BS3DATA64 segment. */
1124	extern uint8_t BS3_FAR_DATA Bs3Data64_EndOfSegment;
1125
1126	/** The size of the Data16, Text32, Text64, Data32 and Data64 blob. */
1127	extern uint32_t BS3_FAR_DATA Bs3Data16Thru64Text32And64_TotalSize;
1128	/** The total image size (from Text16 thu Data64). */
1129	extern uint32_t BS3_FAR_DATA Bs3TotalImageSize;
1130	/** @} */
1131
1132
1133	/** Lower case hex digits. */
1134	extern char const g_achBs3HexDigits[16+1];
1135	/** Upper case hex digits. */
1136	extern char const g_achBs3HexDigitsUpper[16+1];
1137
1138
1139	/** The current mode (BS3_MODE_XXX) of CPU \#0. */
1140	extern uint8_t g_bBs3CurrentMode;
1141
1142	/** Hint for 16-bit trap handlers regarding the high word of EIP. */
1143	extern uint32_t g_uBs3TrapEipHint;
1144
1145	/** Copy of the original real-mode interrupt vector table. */
1146	extern RTFAR16 g_aBs3RmIvtOriginal[256];
1147
1148
1149	#ifdef __WATCOMC__
1150	/**
1151	* Executes the SMSW instruction and returns the value.
1152	*
1153	* @returns Machine status word.
1154	*/
1155	uint16_t Bs3AsmSmsw(void);
1156	# pragma aux Bs3AsmSmsw = \
1157	".286" \
1158	"smsw ax" \
1159	value [ax] modify exact [ax] nomemory;
1160	#endif
1161
1162
1163	/** @defgroup bs3kit_cross_ptr Cross Context Pointer Type
1164	*
1165	* The cross context pointer type is
1166	*
1167	* @{ */
1168
1169	/**
1170	* Cross context pointer base type.
1171	*/
1172	typedef union BS3XPTR
1173	{
1174	/** The flat pointer. */
1175	uint32_t uFlat;
1176	/** 16-bit view. */
1177	struct
1178	{
1179	uint16_t uLow;
1180	uint16_t uHigh;
1181	} u;
1182	#if ARCH_BITS == 16
1183	/** 16-bit near pointer. */
1184	void __near *pvNear;
1185	#elif ARCH_BITS == 32
1186	/** 32-bit pointer. */
1187	void *pvRaw;
1188	#endif
1189	} BS3XPTR;
1190	AssertCompileSize(BS3XPTR, 4);
1191
1192
1193	/** @def BS3_XPTR_DEF_INTERNAL
1194	* Internal worker.
1195	*
1196	* @param a_Scope RT_NOTHING if structure or global, static or extern
1197	* otherwise.
1198	* @param a_Type The type we're pointing to.
1199	* @param a_Name The member or variable name.
1200	* @internal
1201	*/
1202	#if ARCH_BITS == 16
1203	# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
1204	a_Scope union \
1205	{ \
1206	BS3XPTR XPtr; \
1207	a_Type __near *pNearTyped; \
1208	} a_Name
1209	#elif ARCH_BITS == 32
1210	# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
1211	a_Scope union \
1212	{ \
1213	BS3XPTR XPtr; \
1214	a_Type *pTyped; \
1215	} a_Name
1216	#elif ARCH_BITS == 64
1217	# define BS3_XPTR_DEF_INTERNAL(a_Scope, a_Type, a_Name) \
1218	a_Scope union \
1219	{ \
1220	BS3XPTR XPtr; \
1221	} a_Name
1222	#else
1223	# error "ARCH_BITS"
1224	#endif
1225
1226	/** @def BS3_XPTR_MEMBER
1227	* Defines a pointer member that can be shared by all CPU modes.
1228	*
1229	* @param a_Type The type we're pointing to.
1230	* @param a_Name The member or variable name.
1231	*/
1232	#define BS3_XPTR_MEMBER(a_Type, a_Name) BS3_XPTR_DEF_INTERNAL(RT_NOTHING, a_Type, a_Name)
1233
1234	/** @def BS3_XPTR_AUTO
1235	* Defines a pointer static variable for working with an XPTR.
1236	*
1237	* This is typically used to convert flat pointers into context specific
1238	* pointers.
1239	*
1240	* @param a_Type The type we're pointing to.
1241	* @param a_Name The member or variable name.
1242	*/
1243	#define BS3_XPTR_AUTO(a_Type, a_Name) BS3_XPTR_DEF_INTERNAL(RT_NOTHING, a_Type, a_Name)
1244
1245	/** @def BS3_XPTR_SET_FLAT
1246	* Sets a cross context pointer.
1247	*
1248	* @param a_Type The type we're pointing to.
1249	* @param a_Name The member or variable name.
1250	* @param a_uFlatPtr The flat pointer value to assign. If the x-pointer is
1251	* used in real mode, this must be less than 1MB.
1252	* Otherwise the limit is 16MB (due to selector tiling).
1253	*/
1254	#define BS3_XPTR_SET_FLAT(a_Type, a_Name, a_uFlatPtr) \
1255	do { a_Name.XPtr.uFlat = (a_uFlatPtr); } while (0)
1256
1257	/** @def BS3_XPTR_GET_FLAT
1258	* Gets the flat address of a cross context pointer.
1259	*
1260	* @returns 32-bit flat pointer.
1261	* @param a_Type The type we're pointing to.
1262	* @param a_Name The member or variable name.
1263	*/
1264	#define BS3_XPTR_GET_FLAT(a_Type, a_Name) (a_Name.XPtr.uFlat)
1265
1266	/** @def BS3_XPTR_GET_FLAT_LOW
1267	* Gets the low 16 bits of the flat address.
1268	*
1269	* @returns Low 16 bits of the flat pointer.
1270	* @param a_Type The type we're pointing to.
1271	* @param a_Name The member or variable name.
1272	*/
1273	#define BS3_XPTR_GET_FLAT_LOW(a_Type, a_Name) (a_Name.XPtr.u.uLow)
1274
1275
1276	#if ARCH_BITS == 16
1277
1278	/**
1279	* Gets the current ring number.
1280	* @returns Ring number.
1281	*/
1282	DECLINLINE(uint16_t) Bs3Sel16GetCurRing(void);
1283	# pragma aux Bs3Sel16GetCurRing = \
1284	"mov ax, ss" \
1285	"and ax, 3" \
1286	value [ax] modify exact [ax] nomemory;
1287
1288	/**
1289	* Converts the high word of a flat pointer into a 16-bit selector.
1290	*
1291	* This makes use of the tiled area. It also handles real mode.
1292	*
1293	* @returns Segment selector value.
1294	* @param uHigh The high part of flat pointer.
1295	* @sa BS3_XPTR_GET, BS3_XPTR_SET
1296	*/
1297	DECLINLINE(__segment) Bs3Sel16HighFlatPtrToSelector(uint16_t uHigh)
1298	{
1299	if (!BS3_MODE_IS_RM_OR_V86(g_bBs3CurrentMode))
1300	return (__segment)(((uHigh << 3) + BS3_SEL_TILED) \| Bs3Sel16GetCurRing());
1301	return (__segment)(uHigh << 12);
1302	}
1303
1304	#endif /* ARCH_BITS == 16 */
1305
1306	/** @def BS3_XPTR_GET
1307	* Gets the current context pointer value.
1308	*
1309	* @returns Usable pointer.
1310	* @param a_Type The type we're pointing to.
1311	* @param a_Name The member or variable name.
1312	*/
1313	#if ARCH_BITS == 16
1314	# define BS3_XPTR_GET(a_Type, a_Name) \
1315	((a_Type BS3_FAR *)BS3_FP_MAKE(Bs3Sel16HighFlatPtrToSelector((a_Name).XPtr.u.uHigh), (a_Name).pNearTyped))
1316	#elif ARCH_BITS == 32
1317	# define BS3_XPTR_GET(a_Type, a_Name) ((a_Name).pTyped)
1318	#elif ARCH_BITS == 64
1319	# define BS3_XPTR_GET(a_Type, a_Name) ((a_Type *)(uintptr_t)(a_Name).XPtr.uFlat)
1320	#else
1321	# error "ARCH_BITS"
1322	#endif
1323
1324	/** @def BS3_XPTR_SET
1325	* Gets the current context pointer value.
1326	*
1327	* @returns Usable pointer.
1328	* @param a_Type The type we're pointing to.
1329	* @param a_Name The member or variable name.
1330	* @param a_pValue The new pointer value, current context pointer.
1331	*/
1332	#if ARCH_BITS == 16
1333	# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
1334	do { \
1335	a_Type BS3_FAR *pTypeCheck = (a_pValue); \
1336	if (BS3_MODE_IS_RM_OR_V86(g_bBs3CurrentMode)) \
1337	(a_Name).XPtr.uFlat = BS3_FP_OFF(pTypeCheck) + ((uint32_t)BS3_FP_SEG(pTypeCheck) << 4); \
1338	else \
1339	{ \
1340	(a_Name).XPtr.u.uLow = BS3_FP_OFF(pTypeCheck); \
1341	(a_Name).XPtr.u.uHigh = ((BS3_FP_SEG(pTypeCheck) & UINT16_C(0xfff8)) - BS3_SEL_TILED) >> 3; \
1342	} \
1343	} while (0)
1344	#elif ARCH_BITS == 32
1345	# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
1346	do { (a_Name).pTyped = (a_pValue); } while (0)
1347	#elif ARCH_BITS == 64
1348	# define BS3_XPTR_SET(a_Type, a_Name, a_pValue) \
1349	do { \
1350	a_Type *pTypeCheck = (a_pValue); \
1351	(a_Name).XPtr.uFlat = (uint32_t)(uintptr_t)pTypeCheck; \
1352	} while (0)
1353	#else
1354	# error "ARCH_BITS"
1355	#endif
1356
1357
1358	/** @def BS3_XPTR_IS_NULL
1359	* Checks if the cross context pointer is NULL.
1360	*
1361	* @returns true if NULL, false if not.
1362	* @param a_Type The type we're pointing to.
1363	* @param a_Name The member or variable name.
1364	*/
1365	#define BS3_XPTR_IS_NULL(a_Type, a_Name) ((a_Name).XPtr.uFlat == 0)
1366
1367	/**
1368	* Gets a working pointer from a flat address.
1369	*
1370	* @returns Current context pointer.
1371	* @param uFlatPtr The flat address to convert (32-bit or 64-bit).
1372	*/
1373	DECLINLINE(void BS3_FAR *) Bs3XptrFlatToCurrent(RTCCUINTXREG uFlatPtr)
1374	{
1375	BS3_XPTR_AUTO(void, pTmp);
1376	BS3_XPTR_SET_FLAT(void, pTmp, uFlatPtr);
1377	return BS3_XPTR_GET(void, pTmp);
1378	}
1379
1380	/** @} */
1381
1382
1383
1384	/** @defgroup grp_bs3kit_cmn Common Functions and Data
1385	*
1386	* The common functions comes in three variations: 16-bit, 32-bit and 64-bit.
1387	* Templated code uses the #BS3_CMN_NM macro to mangle the name according to the
1388	* desired
1389	*
1390	* @{
1391	*/
1392
1393	/** @def BS3_CMN_PROTO_INT
1394	* Internal macro for prototyping all the variations of a common function.
1395	* @param a_RetType The return type.
1396	* @param a_Name The function basename.
1397	* @param a_Params The parameter list (in parentheses).
1398	* @sa BS3_CMN_PROTO_STUB, BS3_CMN_PROTO_NOSB
1399	*/
1400	#if ARCH_BITS == 16
1401	# ifndef BS3_USE_ALT_16BIT_TEXT_SEG
1402	# define BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params) \
1403	BS3_DECL_NEAR(a_RetType) BS3_CMN_NM(a_Name) a_Params; \
1404	BS3_DECL_FAR(a_RetType) BS3_CMN_FAR_NM(a_Name) a_Params
1405	# else
1406	# define BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params) \
1407	BS3_DECL_FAR(a_RetType) BS3_CMN_FAR_NM(a_Name) a_Params
1408	# endif
1409	#else
1410	# define BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params) \
1411	BS3_DECL_NEAR(a_RetType) BS3_CMN_NM(a_Name) a_Params
1412	#endif
1413
1414	/** @def BS3_CMN_PROTO_STUB
1415	* Macro for prototyping all the variations of a common function with automatic
1416	* near -> far stub.
1417	*
1418	* @param a_RetType The return type.
1419	* @param a_Name The function basename.
1420	* @param a_Params The parameter list (in parentheses).
1421	* @sa BS3_CMN_PROTO_NOSB
1422	*/
1423	#define BS3_CMN_PROTO_STUB(a_RetType, a_Name, a_Params) BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params)
1424
1425	/** @def BS3_CMN_PROTO_NOSB
1426	* Macro for prototyping all the variations of a common function without any
1427	* near > far stub.
1428	*
1429	* @param a_RetType The return type.
1430	* @param a_Name The function basename.
1431	* @param a_Params The parameter list (in parentheses).
1432	* @sa BS3_CMN_PROTO_STUB
1433	*/
1434	#define BS3_CMN_PROTO_NOSB(a_RetType, a_Name, a_Params) BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params)
1435
1436	/** @def BS3_CMN_PROTO_FARSTUB
1437	* Macro for prototyping all the variations of a common function with automatic
1438	* far -> near stub.
1439	*
1440	* @param a_cbParam16 The size of the 16-bit parameter list in bytes.
1441	* @param a_RetType The return type.
1442	* @param a_Name The function basename.
1443	* @param a_Params The parameter list (in parentheses).
1444	* @sa BS3_CMN_PROTO_STUB
1445	*/
1446	#define BS3_CMN_PROTO_FARSTUB(a_cbParam16, a_RetType, a_Name, a_Params) BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params)
1447
1448
1449	/** @def BS3_CMN_DEF
1450	* Macro for defining a common function.
1451	*
1452	* This makes 16-bit common function far, while 32-bit and 64-bit are near.
1453	*
1454	* @param a_RetType The return type.
1455	* @param a_Name The function basename.
1456	* @param a_Params The parameter list (in parentheses).
1457	*/
1458	#if ARCH_BITS == 16
1459	# define BS3_CMN_DEF(a_RetType, a_Name, a_Params) \
1460	BS3_DECL_FAR(a_RetType) BS3_CMN_FAR_NM(a_Name) a_Params
1461	#else
1462	# define BS3_CMN_DEF(a_RetType, a_Name, a_Params) \
1463	BS3_DECL_NEAR(a_RetType) BS3_CMN_NM(a_Name) a_Params
1464	#endif
1465
1466	/** @def BS3_ASSERT
1467	* Assert that an expression is true.
1468	*
1469	* Calls Bs3Panic if false and it's a strict build. Does nothing in
1470	* non-strict builds. */
1471	#ifdef BS3_STRICT
1472	# define BS3_ASSERT(a_Expr) do { if (!!(a_Expr)) { /* likely / } else { Bs3Panic(); } } while (0) /< @todo later /
1473	#else
1474	# define BS3_ASSERT(a_Expr) do { } while (0)
1475	#endif
1476
1477	/**
1478	* Panic, never return.
1479	*
1480	* The current implementation will only halt the CPU.
1481	*/
1482	BS3_CMN_PROTO_NOSB(DECL_NO_RETURN(void), Bs3Panic,(void));
1483	#if !defined(BS3_KIT_WITH_NO_RETURN) && defined(__WATCOMC__)
1484	# pragma aux Bs3Panic_c16 __aborts
1485	# pragma aux Bs3Panic_f16 __aborts
1486	# pragma aux Bs3Panic_c32 __aborts
1487	#endif
1488
1489
1490	/**
1491	* Translate a mode into a string.
1492	*
1493	* @returns Pointer to read-only mode name string.
1494	* @param bMode The mode value (BS3_MODE_XXX).
1495	*/
1496	BS3_CMN_PROTO_STUB(const char BS3_FAR *, Bs3GetModeName,(uint8_t bMode));
1497
1498	/**
1499	* Translate a mode into a short lower case string.
1500	*
1501	* @returns Pointer to read-only short mode name string.
1502	* @param bMode The mode value (BS3_MODE_XXX).
1503	*/
1504	BS3_CMN_PROTO_STUB(const char BS3_FAR *, Bs3GetModeNameShortLower,(uint8_t bMode));
1505
1506	/** CPU vendors. */
1507	typedef enum BS3CPUVENDOR
1508	{
1509	BS3CPUVENDOR_INVALID = 0,
1510	BS3CPUVENDOR_INTEL,
1511	BS3CPUVENDOR_AMD,
1512	BS3CPUVENDOR_VIA,
1513	BS3CPUVENDOR_CYRIX,
1514	BS3CPUVENDOR_UNKNOWN,
1515	BS3CPUVENDOR_END
1516	} BS3CPUVENDOR;
1517
1518	/**
1519	* Tries to detect the CPU vendor.
1520	*
1521	* @returns CPU vendor.
1522	*/
1523	BS3_CMN_PROTO_STUB(BS3CPUVENDOR, Bs3GetCpuVendor,(void));
1524
1525	/**
1526	* Shutdown the system, never returns.
1527	*
1528	* This currently only works for VMs. When running on real systems it will
1529	* just halt the CPU.
1530	*/
1531	BS3_CMN_PROTO_NOSB(void, Bs3Shutdown,(void));
1532
1533	/**
1534	* Prints a 32-bit unsigned value as decimal to the screen.
1535	*
1536	* @param uValue The 32-bit value.
1537	*/
1538	BS3_CMN_PROTO_NOSB(void, Bs3PrintU32,(uint32_t uValue));
1539
1540	/**
1541	* Prints a 32-bit unsigned value as hex to the screen.
1542	*
1543	* @param uValue The 32-bit value.
1544	*/
1545	BS3_CMN_PROTO_NOSB(void, Bs3PrintX32,(uint32_t uValue));
1546
1547	/**
1548	* Formats and prints a string to the screen.
1549	*
1550	* See #Bs3StrFormatV for supported format types.
1551	*
1552	* @param pszFormat The format string.
1553	* @param ... Format arguments.
1554	*/
1555	BS3_CMN_PROTO_STUB(size_t, Bs3Printf,(const char BS3_FAR *pszFormat, ...));
1556
1557	/**
1558	* Formats and prints a string to the screen, va_list version.
1559	*
1560	* See #Bs3StrFormatV for supported format types.
1561	*
1562	* @param pszFormat The format string.
1563	* @param va Format arguments.
1564	*/
1565	BS3_CMN_PROTO_STUB(size_t, Bs3PrintfV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
1566
1567	/**
1568	* Prints a string to the screen.
1569	*
1570	* @param pszString The string to print.
1571	*/
1572	BS3_CMN_PROTO_STUB(void, Bs3PrintStr,(const char BS3_FAR *pszString));
1573
1574	/**
1575	* Prints a string to the screen.
1576	*
1577	* @param pszString The string to print. Any terminator charss will be printed.
1578	* @param cchString The exact number of characters to print.
1579	*/
1580	BS3_CMN_PROTO_NOSB(void, Bs3PrintStrN,(const char BS3_FAR *pszString, size_t cchString));
1581
1582	/**
1583	* Prints a char to the screen.
1584	*
1585	* @param ch The character to print.
1586	*/
1587	BS3_CMN_PROTO_NOSB(void, Bs3PrintChr,(char ch));
1588
1589
1590	/**
1591	* An output function for #Bs3StrFormatV.
1592	*
1593	* @returns Number of characters written.
1594	* @param ch The character to write. Zero in the final call.
1595	* @param pvUser User argument supplied to #Bs3StrFormatV.
1596	*/
1597	typedef BS3_DECL_CALLBACK(size_t) FNBS3STRFORMATOUTPUT(char ch, void BS3_FAR *pvUser);
1598	/** Pointer to an output function for #Bs3StrFormatV. */
1599	typedef FNBS3STRFORMATOUTPUT *PFNBS3STRFORMATOUTPUT;
1600
1601	/**
1602	* Formats a string, sending the output to @a pfnOutput.
1603	*
1604	* Supported types:
1605	* - %RI8, %RI16, %RI32, %RI64
1606	* - %RU8, %RU16, %RU32, %RU64
1607	* - %RX8, %RX16, %RX32, %RX64
1608	* - %i, %d
1609	* - %u
1610	* - %x
1611	* - %c
1612	* - %p (far pointer)
1613	* - %s (far pointer)
1614	*
1615	* @returns Sum of @a pfnOutput return values.
1616	* @param pszFormat The format string.
1617	* @param va Format arguments.
1618	* @param pfnOutput The output function.
1619	* @param pvUser The user argument for the output function.
1620	*/
1621	BS3_CMN_PROTO_STUB(size_t, Bs3StrFormatV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va,
1622	PFNBS3STRFORMATOUTPUT pfnOutput, void BS3_FAR *pvUser));
1623
1624	/**
1625	* Formats a string into a buffer.
1626	*
1627	* See #Bs3StrFormatV for supported format types.
1628	*
1629	* @returns The length of the formatted string (excluding terminator).
1630	* This will be higher or equal to @c cbBuf in case of an overflow.
1631	* @param pszBuf The output buffer.
1632	* @param cbBuf The size of the output buffer.
1633	* @param pszFormat The format string.
1634	* @param va Format arguments.
1635	*/
1636	BS3_CMN_PROTO_STUB(size_t, Bs3StrPrintfV,(char BS3_FAR pszBuf, size_t cbBuf, const char BS3_FAR pszFormat, va_list BS3_FAR va));
1637
1638	/**
1639	* Formats a string into a buffer.
1640	*
1641	* See #Bs3StrFormatV for supported format types.
1642	*
1643	* @returns The length of the formatted string (excluding terminator).
1644	* This will be higher or equal to @c cbBuf in case of an overflow.
1645	* @param pszBuf The output buffer.
1646	* @param cbBuf The size of the output buffer.
1647	* @param pszFormat The format string.
1648	* @param ... Format arguments.
1649	*/
1650	BS3_CMN_PROTO_STUB(size_t, Bs3StrPrintf,(char BS3_FAR pszBuf, size_t cbBuf, const char BS3_FAR pszFormat, ...));
1651
1652
1653	/**
1654	* Finds the length of a zero terminated string.
1655	*
1656	* @returns String length in chars/bytes.
1657	* @param pszString The string to examine.
1658	*/
1659	BS3_CMN_PROTO_STUB(size_t, Bs3StrLen,(const char BS3_FAR *pszString));
1660
1661	/**
1662	* Finds the length of a zero terminated string, but with a max length.
1663	*
1664	* @returns String length in chars/bytes, or @a cchMax if no zero-terminator
1665	* was found before we reached the limit.
1666	* @param pszString The string to examine.
1667	* @param cchMax The max length to examine.
1668	*/
1669	BS3_CMN_PROTO_STUB(size_t, Bs3StrNLen,(const char BS3_FAR *pszString, size_t cchMax));
1670
1671	/**
1672	* CRT style unsafe strcpy.
1673	*
1674	* @returns pszDst.
1675	* @param pszDst The destination buffer. Must be large enough to
1676	* hold the source string.
1677	* @param pszSrc The source string.
1678	*/
1679	BS3_CMN_PROTO_STUB(char BS3_FAR , Bs3StrCpy,(char BS3_FAR pszDst, const char BS3_FAR *pszSrc));
1680
1681	/**
1682	* CRT style memcpy.
1683	*
1684	* @returns pvDst
1685	* @param pvDst The destination buffer.
1686	* @param pvSrc The source buffer.
1687	* @param cbToCopy The number of bytes to copy.
1688	*/
1689	BS3_CMN_PROTO_STUB(void BS3_FAR , Bs3MemCpy,(void BS3_FAR pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
1690
1691	/**
1692	* GNU (?) style mempcpy.
1693	*
1694	* @returns pvDst + cbCopy
1695	* @param pvDst The destination buffer.
1696	* @param pvSrc The source buffer.
1697	* @param cbToCopy The number of bytes to copy.
1698	*/
1699	BS3_CMN_PROTO_STUB(void BS3_FAR , Bs3MemPCpy,(void BS3_FAR pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
1700
1701	/**
1702	* CRT style memmove (overlapping buffers is fine).
1703	*
1704	* @returns pvDst
1705	* @param pvDst The destination buffer.
1706	* @param pvSrc The source buffer.
1707	* @param cbToCopy The number of bytes to copy.
1708	*/
1709	BS3_CMN_PROTO_STUB(void BS3_FAR , Bs3MemMove,(void BS3_FAR pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
1710
1711	/**
1712	* BSD style bzero.
1713	*
1714	* @param pvDst The buffer to be zeroed.
1715	* @param cbDst The number of bytes to zero.
1716	*/
1717	BS3_CMN_PROTO_NOSB(void, Bs3MemZero,(void BS3_FAR *pvDst, size_t cbDst));
1718
1719	/**
1720	* CRT style memset.
1721	*
1722	* @param pvDst The buffer to be fill.
1723	* @param bFiller The filler byte.
1724	* @param cbDst The number of bytes to fill.
1725	*/
1726	BS3_CMN_PROTO_NOSB(void, Bs3MemSet,(void BS3_FAR *pvDst, uint8_t bFiller, size_t cbDst));
1727
1728	/**
1729	* CRT style memchr.
1730	*
1731	* @param pvHaystack The memory to scan for @a bNeedle.
1732	* @param bNeedle The byte to search for.
1733	* @param cbHaystack The amount of memory to search.
1734	*/
1735	BS3_CMN_PROTO_NOSB(void BS3_FAR , Bs3MemChr,(void const BS3_FAR pvHaystack, uint8_t bNeedle, size_t cbHaystack));
1736
1737	/**
1738	* CRT style memcmp.
1739	*
1740	* @returns 0 if equal. Negative if the left side is 'smaller' than the right
1741	* side, and positive in the other case.
1742	* @param pv1 The left hand memory.
1743	* @param pv2 The right hand memory.
1744	* @param cb The number of bytes to compare.
1745	*/
1746	BS3_CMN_PROTO_NOSB(int, Bs3MemCmp,(void const BS3_FAR pv1, void const BS3_FAR pv2, size_t cb));
1747
1748	BS3_CMN_PROTO_STUB(void, Bs3UInt64Div,(RTUINT64U uDividend, RTUINT64U uDivisor, RTUINT64U BS3_FAR *paQuotientReminder));
1749	BS3_CMN_PROTO_STUB(void, Bs3UInt32Div,(RTUINT32U uDividend, RTUINT32U uDivisor, RTUINT32U BS3_FAR *paQuotientReminder));
1750
1751
1752	/**
1753	* Converts a protected mode 32-bit far pointer to a 32-bit flat address.
1754	*
1755	* @returns 32-bit flat address.
1756	* @param off The segment offset.
1757	* @param uSel The protected mode segment selector.
1758	*/
1759	BS3_CMN_PROTO_STUB(uint32_t, Bs3SelProtFar32ToFlat32,(uint32_t off, uint16_t uSel));
1760
1761	/**
1762	* Converts a current mode 32-bit far pointer to a 32-bit flat address.
1763	*
1764	* @returns 32-bit flat address.
1765	* @param off The segment offset.
1766	* @param uSel The current mode segment selector.
1767	*/
1768	BS3_CMN_PROTO_STUB(uint32_t, Bs3SelFar32ToFlat32,(uint32_t off, uint16_t uSel));
1769
1770	/**
1771	* Wrapper around Bs3SelFar32ToFlat32 that makes it easier to use in tight
1772	* assembly spots.
1773	*
1774	* @returns 32-bit flat address.
1775	* @param off The segment offset.
1776	* @param uSel The current mode segment selector.
1777	* @remarks All register are preserved, except return.
1778	* @remarks No 20h scratch space required in 64-bit mode.
1779	*/
1780	BS3_CMN_PROTO_FARSTUB(6, uint32_t, Bs3SelFar32ToFlat32NoClobber,(uint32_t off, uint16_t uSel));
1781
1782	/**
1783	* Converts a real mode code segment to a protected mode code segment selector.
1784	*
1785	* @returns protected mode segment selector.
1786	* @param uRealSeg Real mode code segment.
1787	* @remarks All register are preserved, except return and parameter.
1788	*/
1789	BS3_CMN_PROTO_NOSB(uint16_t, Bs3SelRealModeCodeToProtMode,(uint16_t uRealSeg));
1790
1791	/**
1792	* Converts a real mode code segment to a protected mode code segment selector.
1793	*
1794	* @returns protected mode segment selector.
1795	* @param uProtSel Real mode code segment.
1796	* @remarks All register are preserved, except return and parameter.
1797	*/
1798	BS3_CMN_PROTO_NOSB(uint16_t, Bs3SelProtModeCodeToRealMode,(uint16_t uProtSel));
1799
1800	/**
1801	* Converts a flat code address to a real mode segment and offset.
1802	*
1803	* @returns Far real mode address (high 16-bit is segment, low is offset).
1804	* @param uFlatAddr Flat code address.
1805	* @remarks All register are preserved, except return and parameter.
1806	*/
1807	BS3_CMN_PROTO_NOSB(uint32_t, Bs3SelFlatCodeToRealMode,(uint32_t uFlatAddr));
1808
1809	/**
1810	* Converts a flat code address to a protected mode 16-bit far pointer (ring-0).
1811	*
1812	* @returns Far 16-bit protected mode address (high 16-bit is segment selector,
1813	* low is segment offset).
1814	* @param uFlatAddr Flat code address.
1815	* @remarks All register are preserved, except return and parameter.
1816	*/
1817	BS3_CMN_PROTO_NOSB(uint32_t, Bs3SelFlatCodeToProtFar16,(uint32_t uFlatAddr));
1818
1819	/**
1820	* Converts a far 16:16 real mode (code) address to a flat address.
1821	*
1822	* @returns 32-bit flat address.
1823	* @param uFar1616 Far real mode address (high 16-bit is segment, low
1824	* is offset).
1825	* @remarks All register are preserved, except return.
1826	* @remarks No 20h scratch space required in 64-bit mode.
1827	* @remarks Exactly the same as Bs3SelRealModeDataToFlat, except for param.
1828	*/
1829	BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelRealModeCodeToFlat,(PFNBS3FARADDRCONV uFar1616));
1830
1831	/**
1832	* Converts a flat data address to a real mode segment and offset.
1833	*
1834	* @returns Far real mode address (high 16-bit is segment, low is offset)
1835	* @param uFlatAddr Flat code address.
1836	* @remarks All register are preserved, except return.
1837	* @remarks No 20h scratch space required in 64-bit mode.
1838	*/
1839	BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelFlatDataToRealMode,(uint32_t uFlatAddr));
1840
1841	/**
1842	* Converts a flat data address to a real mode segment and offset.
1843	*
1844	* @returns Far 16-bit protected mode address (high 16-bit is segment selector,
1845	* low is segment offset).
1846	* @param uFlatAddr Flat code address.
1847	* @remarks All register are preserved, except return.
1848	* @remarks No 20h scratch space required in 64-bit mode.
1849	*/
1850	BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelFlatDataToProtFar16,(uint32_t uFlatAddr));
1851
1852	/**
1853	* Converts a far 16:16 data address to a real mode segment and offset.
1854	*
1855	* @returns Far real mode address (high 16-bit is segment, low is offset)
1856	* @param uFar1616 Far 16-bit protected mode address (high 16-bit is
1857	* segment selector, low is segment offset).
1858	* @remarks All register are preserved, except return.
1859	* @remarks No 20h scratch space required in 64-bit mode.
1860	*/
1861	BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelProtFar16DataToRealMode,(uint32_t uFar1616));
1862
1863	/**
1864	* Converts a far 16:16 real mode address to a 16-bit protected mode address.
1865	*
1866	* @returns Far real mode address (high 16-bit is segment, low is offset)
1867	* @param uFar1616 Far real mode address (high 16-bit is segment, low
1868	* is offset).
1869	* @remarks All register are preserved, except return.
1870	* @remarks No 20h scratch space required in 64-bit mode.
1871	*/
1872	BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelRealModeDataToProtFar16,(uint32_t uFar1616));
1873
1874	/**
1875	* Converts a far 16:16 data address to a flat 32-bit address.
1876	*
1877	* @returns 32-bit flat address.
1878	* @param uFar1616 Far 16-bit protected mode address (high 16-bit is
1879	* segment selector, low is segment offset).
1880	* @remarks All register are preserved, except return.
1881	* @remarks No 20h scratch space required in 64-bit mode.
1882	*/
1883	BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelProtFar16DataToFlat,(uint32_t uFar1616));
1884
1885	/**
1886	* Converts a far 16:16 real mode address to a flat address.
1887	*
1888	* @returns 32-bit flat address.
1889	* @param uFar1616 Far real mode address (high 16-bit is segment, low
1890	* is offset).
1891	* @remarks All register are preserved, except return.
1892	* @remarks No 20h scratch space required in 64-bit mode.
1893	*/
1894	BS3_CMN_PROTO_FARSTUB(4, uint32_t, Bs3SelRealModeDataToFlat,(uint32_t uFar1616));
1895
1896	/**
1897	* Gets a flat address from a working poitner.
1898	*
1899	* @returns flat address (32-bit or 64-bit).
1900	* @param pv Current context pointer.
1901	*/
1902	DECLINLINE(RTCCUINTXREG) Bs3SelPtrToFlat(void BS3_FAR *pv)
1903	{
1904	#if ARCH_BITS == 16
1905	return BS3_CMN_FN_NM(Bs3SelFar32ToFlat32)(BS3_FP_OFF(pv), BS3_FP_SEG(pv));
1906	#else
1907	return (uintptr_t)pv;
1908	#endif
1909	}
1910
1911	/**
1912	* Sets up a 16-bit read-write data selector with ring-3 access and 64KB limit.
1913	*
1914	* @param pDesc Pointer to the descriptor table entry.
1915	* @param uBaseAddr The base address of the descriptor.
1916	*/
1917	BS3_CMN_PROTO_STUB(void, Bs3SelSetup16BitData,(X86DESC BS3_FAR *pDesc, uint32_t uBaseAddr));
1918
1919	/**
1920	* Sets up a 16-bit execute-read selector with a 64KB limit.
1921	*
1922	* @param pDesc Pointer to the descriptor table entry.
1923	* @param uBaseAddr The base address of the descriptor.
1924	* @param bDpl The descriptor privilege level.
1925	*/
1926	BS3_CMN_PROTO_STUB(void, Bs3SelSetup16BitCode,(X86DESC BS3_FAR *pDesc, uint32_t uBaseAddr, uint8_t bDpl));
1927
1928
1929	/**
1930	* Slab control structure list head.
1931	*
1932	* The slabs on the list must all have the same chunk size.
1933	*/
1934	typedef struct BS3SLABHEAD
1935	{
1936	/** Pointer to the first slab. */
1937	BS3_XPTR_MEMBER(struct BS3SLABCTL, pFirst);
1938	/** The allocation chunk size. */
1939	uint16_t cbChunk;
1940	/** Number of slabs in the list. */
1941	uint16_t cSlabs;
1942	/** Number of chunks in the list. */
1943	uint32_t cChunks;
1944	/** Number of free chunks. */
1945	uint32_t cFreeChunks;
1946	} BS3SLABHEAD;
1947	AssertCompileSize(BS3SLABHEAD, 16);
1948	/** Pointer to a slab list head. */
1949	typedef BS3SLABHEAD BS3_FAR *PBS3SLABHEAD;
1950
1951	/**
1952	* Allocation slab control structure.
1953	*
1954	* This may live at the start of the slab for 4KB slabs, while in a separate
1955	* static location for the larger ones.
1956	*/
1957	typedef struct BS3SLABCTL
1958	{
1959	/** Pointer to the next slab control structure in this list. */
1960	BS3_XPTR_MEMBER(struct BS3SLABCTL, pNext);
1961	/** Pointer to the slab list head. */
1962	BS3_XPTR_MEMBER(BS3SLABHEAD, pHead);
1963	/** The base address of the slab. */
1964	BS3_XPTR_MEMBER(uint8_t, pbStart);
1965	/** Number of chunks in this slab. */
1966	uint16_t cChunks;
1967	/** Number of currently free chunks. */
1968	uint16_t cFreeChunks;
1969	/** The chunk size. */
1970	uint16_t cbChunk;
1971	/** The shift count corresponding to cbChunk.
1972	* This is for turning a chunk number into a byte offset and vice versa. */
1973	uint16_t cChunkShift;
1974	/** Bitmap where set bits indicates allocated blocks (variable size,
1975	* multiple of 4). */
1976	uint8_t bmAllocated[4];
1977	} BS3SLABCTL;
1978	/** Pointer to a bs3kit slab control structure. */
1979	typedef BS3SLABCTL BS3_FAR *PBS3SLABCTL;
1980
1981	/** The chunks must all be in the same 16-bit segment tile. */
1982	#define BS3_SLAB_ALLOC_F_SAME_TILE UINT16_C(0x0001)
1983
1984	/**
1985	* Initializes a slab.
1986	*
1987	* @param pSlabCtl The slab control structure to initialize.
1988	* @param cbSlabCtl The size of the slab control structure.
1989	* @param uFlatSlabPtr The base address of the slab.
1990	* @param cbSlab The size of the slab.
1991	* @param cbChunk The chunk size.
1992	*/
1993	BS3_CMN_PROTO_STUB(void, Bs3SlabInit,(PBS3SLABCTL pSlabCtl, size_t cbSlabCtl, uint32_t uFlatSlabPtr,
1994	uint32_t cbSlab, uint16_t cbChunk));
1995
1996	/**
1997	* Allocates one chunk from a slab.
1998	*
1999	* @returns Pointer to a chunk on success, NULL if we're out of chunks.
2000	* @param pSlabCtl The slab constrol structure to allocate from.
2001	*/
2002	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3SlabAlloc,(PBS3SLABCTL pSlabCtl));
2003
2004	/**
2005	* Allocates one or more chunks rom a slab.
2006	*
2007	* @returns Pointer to the request number of chunks on success, NULL if we're
2008	* out of chunks.
2009	* @param pSlabCtl The slab constrol structure to allocate from.
2010	* @param cChunks The number of contiguous chunks we want.
2011	* @param fFlags Flags, see BS3_SLAB_ALLOC_F_XXX
2012	*/
2013	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3SlabAllocEx,(PBS3SLABCTL pSlabCtl, uint16_t cChunks, uint16_t fFlags));
2014
2015	/**
2016	* Frees one or more chunks from a slab.
2017	*
2018	* @returns Number of chunks actually freed. When correctly used, this will
2019	* match the @a cChunks parameter, of course.
2020	* @param pSlabCtl The slab constrol structure to free from.
2021	* @param uFlatChunkPtr The flat address of the chunks to free.
2022	* @param cChunks The number of contiguous chunks to free.
2023	*/
2024	BS3_CMN_PROTO_STUB(uint16_t, Bs3SlabFree,(PBS3SLABCTL pSlabCtl, uint32_t uFlatChunkPtr, uint16_t cChunks));
2025
2026
2027	/**
2028	* Initializes the given slab list head.
2029	*
2030	* @param pHead The slab list head.
2031	* @param cbChunk The chunk size.
2032	*/
2033	BS3_CMN_PROTO_STUB(void, Bs3SlabListInit,(PBS3SLABHEAD pHead, uint16_t cbChunk));
2034
2035	/**
2036	* Adds an initialized slab control structure to the list.
2037	*
2038	* @param pHead The slab list head to add it to.
2039	* @param pSlabCtl The slab control structure to add.
2040	*/
2041	BS3_CMN_PROTO_STUB(void, Bs3SlabListAdd,(PBS3SLABHEAD pHead, PBS3SLABCTL pSlabCtl));
2042
2043	/**
2044	* Allocates one chunk.
2045	*
2046	* @returns Pointer to a chunk on success, NULL if we're out of chunks.
2047	* @param pHead The slab list to allocate from.
2048	*/
2049	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3SlabListAlloc,(PBS3SLABHEAD pHead));
2050
2051	/**
2052	* Allocates one or more chunks.
2053	*
2054	* @returns Pointer to the request number of chunks on success, NULL if we're
2055	* out of chunks.
2056	* @param pHead The slab list to allocate from.
2057	* @param cChunks The number of contiguous chunks we want.
2058	* @param fFlags Flags, see BS3_SLAB_ALLOC_F_XXX
2059	*/
2060	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3SlabListAllocEx,(PBS3SLABHEAD pHead, uint16_t cChunks, uint16_t fFlags));
2061
2062	/**
2063	* Frees one or more chunks from a slab list.
2064	*
2065	* @param pHead The slab list to allocate from.
2066	* @param pvChunks Pointer to the first chunk to free.
2067	* @param cChunks The number of contiguous chunks to free.
2068	*/
2069	BS3_CMN_PROTO_STUB(void, Bs3SlabListFree,(PBS3SLABHEAD pHead, void BS3_FAR *pvChunks, uint16_t cChunks));
2070
2071	/**
2072	* Allocation addressing constraints.
2073	*/
2074	typedef enum BS3MEMKIND
2075	{
2076	/** Invalid zero type. */
2077	BS3MEMKIND_INVALID = 0,
2078	/** Real mode addressable memory. */
2079	BS3MEMKIND_REAL,
2080	/** Memory addressable using the 16-bit protected mode tiling. */
2081	BS3MEMKIND_TILED,
2082	/** Memory addressable using 32-bit flat addressing. */
2083	BS3MEMKIND_FLAT32,
2084	/** Memory addressable using 64-bit flat addressing. */
2085	BS3MEMKIND_FLAT64,
2086	/** End of valid types. */
2087	BS3MEMKIND_END,
2088	} BS3MEMKIND;
2089
2090	/**
2091	* Allocates low memory.
2092	*
2093	* @returns Pointer to a chunk on success, NULL if we're out of chunks.
2094	* @param enmKind The kind of addressing constraints imposed on the
2095	* allocation.
2096	* @param cb How much to allocate. Must be 4KB or less.
2097	*/
2098	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemAlloc,(BS3MEMKIND enmKind, size_t cb));
2099
2100	/**
2101	* Allocates zero'ed memory.
2102	*
2103	* @param enmKind The kind of addressing constraints imposed on the
2104	* allocation.
2105	* @param cb How much to allocate. Must be 4KB or less.
2106	*/
2107	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemAllocZ,(BS3MEMKIND enmKind, size_t cb));
2108
2109	/**
2110	* Frees memory.
2111	*
2112	* @returns Pointer to a chunk on success, NULL if we're out of chunks.
2113	* @param pv The memory to free (returned by #Bs3MemAlloc).
2114	* @param cb The size of the allocation.
2115	*/
2116	BS3_CMN_PROTO_STUB(void, Bs3MemFree,(void BS3_FAR *pv, size_t cb));
2117
2118	/**
2119	* Allocates a page with non-present pages on each side.
2120	*
2121	* @returns Pointer to the usable page. NULL on failure. Use
2122	* Bs3MemGuardedTestPageFree to free the allocation.
2123	* @param enmKind The kind of addressing constraints imposed on the
2124	* allocation.
2125	*/
2126	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemGuardedTestPageAlloc,(BS3MEMKIND enmKind));
2127
2128	/**
2129	* Allocates a page with pages on each side to the @a fPte specification.
2130	*
2131	* @returns Pointer to the usable page. NULL on failure. Use
2132	* Bs3MemGuardedTestPageFree to free the allocation.
2133	* @param enmKind The kind of addressing constraints imposed on the
2134	* allocation.
2135	* @param fPte The page table entry specification for the guard pages.
2136	*/
2137	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemGuardedTestPageAllocEx,(BS3MEMKIND enmKind, uint64_t fPte));
2138
2139	/**
2140	* Frees guarded page allocated by Bs3MemGuardedTestPageAlloc or
2141	* Bs3MemGuardedTestPageAllocEx.
2142	*
2143	* @param pvGuardedPage Pointer returned by Bs3MemGuardedTestPageAlloc or
2144	* Bs3MemGuardedTestPageAllocEx. NULL is ignored.
2145	*/
2146	BS3_CMN_PROTO_STUB(void, Bs3MemGuardedTestPageFree,(void BS3_FAR *pvGuardedPage));
2147
2148	/**
2149	* Print all heap info.
2150	*/
2151	BS3_CMN_PROTO_STUB(void, Bs3MemPrintInfo, (void));
2152
2153	/** Highes RAM byte below 4G. */
2154	extern uint32_t g_uBs3EndOfRamBelow4G;
2155
2156
2157	/**
2158	* Enables the A20 gate.
2159	*/
2160	BS3_CMN_PROTO_NOSB(void, Bs3A20Enable,(void));
2161
2162	/**
2163	* Enables the A20 gate via the keyboard controller
2164	*/
2165	BS3_CMN_PROTO_NOSB(void, Bs3A20EnableViaKbd,(void));
2166
2167	/**
2168	* Enables the A20 gate via the PS/2 control port A.
2169	*/
2170	BS3_CMN_PROTO_NOSB(void, Bs3A20EnableViaPortA,(void));
2171
2172	/**
2173	* Disables the A20 gate.
2174	*/
2175	BS3_CMN_PROTO_NOSB(void, Bs3A20Disable,(void));
2176
2177	/**
2178	* Disables the A20 gate via the keyboard controller
2179	*/
2180	BS3_CMN_PROTO_NOSB(void, Bs3A20DisableViaKbd,(void));
2181
2182	/**
2183	* Disables the A20 gate via the PS/2 control port A.
2184	*/
2185	BS3_CMN_PROTO_NOSB(void, Bs3A20DisableViaPortA,(void));
2186
2187
2188	/**
2189	* Initializes root page tables for page protected mode (PP16, PP32).
2190	*
2191	* @returns IPRT status code.
2192	* @remarks Must not be called in real-mode!
2193	*/
2194	BS3_CMN_PROTO_STUB(int, Bs3PagingInitRootForPP,(void));
2195
2196	/**
2197	* Initializes root page tables for PAE page protected mode (PAE16, PAE32).
2198	*
2199	* @returns IPRT status code.
2200	* @remarks The default long mode page tables depends on the PAE ones.
2201	* @remarks Must not be called in real-mode!
2202	*/
2203	BS3_CMN_PROTO_STUB(int, Bs3PagingInitRootForPAE,(void));
2204
2205	/**
2206	* Initializes root page tables for long mode (LM16, LM32, LM64).
2207	*
2208	* @returns IPRT status code.
2209	* @remarks The default long mode page tables depends on the PAE ones.
2210	* @remarks Must not be called in real-mode!
2211	*/
2212	BS3_CMN_PROTO_STUB(int, Bs3PagingInitRootForLM,(void));
2213
2214	/**
2215	* Modifies the page table protection of an address range.
2216	*
2217	* This only works on the lowest level of the page tables in the current mode.
2218	*
2219	* Since we generally use the largest pages available when setting up the
2220	* initial page tables, this function will usually have to allocate and create
2221	* more tables. This may fail if we're low on memory.
2222	*
2223	* @returns IPRT status code.
2224	* @param uFlat The flat address of the first page in the range (rounded
2225	* down nearest page boundrary).
2226	* @param cb The range size from @a pv (rounded up to nearest page boundrary).
2227	* @param fSet Mask of zero or more X86_PTE_XXX values to set for the range.
2228	* @param fClear Mask of zero or more X86_PTE_XXX values to clear for the range.
2229	*/
2230	BS3_CMN_PROTO_STUB(int, Bs3PagingProtect,(uint64_t uFlat, uint64_t cb, uint64_t fSet, uint64_t fClear));
2231
2232	/**
2233	* Modifies the page table protection of an address range.
2234	*
2235	* This only works on the lowest level of the page tables in the current mode.
2236	*
2237	* Since we generally use the largest pages available when setting up the
2238	* initial page tables, this function will usually have to allocate and create
2239	* more tables. This may fail if we're low on memory.
2240	*
2241	* @returns IPRT status code.
2242	* @param pv The address of the first page in the range (rounded
2243	* down nearest page boundrary).
2244	* @param cb The range size from @a pv (rounded up to nearest page boundrary).
2245	* @param fSet Mask of zero or more X86_PTE_XXX values to set for the range.
2246	* @param fClear Mask of zero or more X86_PTE_XXX values to clear for the range.
2247	*/
2248	BS3_CMN_PROTO_STUB(int, Bs3PagingProtectPtr,(void BS3_FAR *pv, size_t cb, uint64_t fSet, uint64_t fClear));
2249
2250	/**
2251	* Aliases (maps) one or more contiguous physical pages to a virtual range.
2252	*
2253	* @returns VBox status code.
2254	* @retval VERR_INVALID_PARAMETER if we're in legacy paging mode and @a uDst or
2255	* @a uPhysToAlias are not compatible with legacy paging.
2256	* @retval VERR_OUT_OF_RANGE if we cannot traverse the page tables in this mode
2257	* (typically real mode or v86, maybe 16-bit PE).
2258	* @retval VERR_NO_MEMORY if we cannot allocate page tables for splitting up
2259	* the necessary large pages. No aliasing was performed.
2260	*
2261	* @param uDst The virtual address to map it at. Rounded down
2262	* to the nearest page (@a cbHowMuch is adjusted
2263	* up).
2264	* @param uPhysToAlias The physical address of the first page in the
2265	* (contiguous) range to map. Chopped down to
2266	* nearest page boundrary (@a cbHowMuch is not
2267	* adjusted).
2268	* @param cbHowMuch How much to map. Rounded up to nearest page.
2269	* @param fPte The PTE flags.
2270	*/
2271	BS3_CMN_PROTO_STUB(int, Bs3PagingAlias,(uint64_t uDst, uint64_t uPhysToAlias, uint32_t cbHowMuch, uint64_t fPte));
2272
2273	/**
2274	* Unaliases memory, i.e. restores the 1:1 mapping.
2275	*
2276	* @returns VBox status code. Cannot fail if @a uDst and @a cbHowMuch specify
2277	* the range of a successful Bs3PagingAlias call, however it may run
2278	* out of memory if it's breaking new ground.
2279	*
2280	* @param uDst The virtual address to restore to 1:1 mapping.
2281	* Rounded down to the nearest page (@a cbHowMuch
2282	* is adjusted up).
2283	* @param cbHowMuch How much to restore. Rounded up to nearest page.
2284	*/
2285	BS3_CMN_PROTO_STUB(int, Bs3PagingUnalias,(uint64_t uDst, uint32_t cbHowMuch));
2286
2287	/**
2288	* Get the pointer to the PTE for the given address.
2289	*
2290	* @returns Pointer to the PTE.
2291	* @param uFlat The flat address of the page which PTE we want.
2292	* @param prc Where to return additional error info. Optional.
2293	*/
2294	BS3_CMN_PROTO_STUB(void BS3_FAR , Bs3PagingGetPte,(uint64_t uFlat, int prc));
2295
2296	/**
2297	* Paging information for an address.
2298	*/
2299	typedef struct BS3PAGINGINFO4ADDR
2300	{
2301	/** The depth of the system's paging mode.
2302	* This is always 2 for legacy, 3 for PAE and 4 for long mode. */
2303	uint8_t cEntries;
2304	/** The size of the page structures (the entires). */
2305	uint8_t cbEntry;
2306	/** Flags defined for future fun, currently zero. */
2307	uint16_t fFlags;
2308	/** Union display different view on the entry pointers. */
2309	union
2310	{
2311	/** Pointer to the page structure entries, starting with the PTE as 0.
2312	* If large pages are involved, the first entry will be NULL (first two if 1GB
2313	* page). Same if the address is invalid on a higher level. */
2314	uint8_t BS3_FAR *apbEntries[4];
2315	/** Alternative view for legacy mode. */
2316	struct
2317	{
2318	X86PTE BS3_FAR *pPte;
2319	X86PDE BS3_FAR *pPde;
2320	void *pvUnused2;
2321	void *pvUnused3;
2322	} Legacy;
2323	/** Alternative view for PAE and Long mode. */
2324	struct
2325	{
2326	X86PTEPAE BS3_FAR *pPte;
2327	X86PDEPAE BS3_FAR *pPde;
2328	X86PDPE BS3_FAR *pPdpe;
2329	X86PML4E BS3_FAR *pPml4e;
2330	} Pae;
2331	} u;
2332	} BS3PAGINGINFO4ADDR;
2333	/** Pointer to paging information for and address. */
2334	typedef BS3PAGINGINFO4ADDR BS3_FAR *PBS3PAGINGINFO4ADDR;
2335
2336	/**
2337	* Queries paging information about the given virtual address.
2338	*
2339	* @returns VBox status code.
2340	* @param uFlat The flat address to query information about.
2341	* @param pPgInfo Where to return the information.
2342	*/
2343	BS3_CMN_PROTO_STUB(int, Bs3PagingQueryAddressInfo,(uint64_t uFlat, PBS3PAGINGINFO4ADDR pPgInfo));
2344
2345
2346	/** The physical / flat address of the buffer backing the canonical traps.
2347	* This buffer is spread equally on each side of the 64-bit non-canonical
2348	* address divide. Non-64-bit code can use this to setup trick shots and
2349	* inspect their results. */
2350	extern uint32_t g_uBs3PagingCanonicalTrapsAddr;
2351	/** The size of the buffer at g_uPagingCanonicalTraps (both sides). */
2352	extern uint16_t g_cbBs3PagingCanonicalTraps;
2353	/** The size of one trap buffer (low or high).
2354	* This is g_cbBs3PagingCanonicalTraps divided by two. */
2355	extern uint16_t g_cbBs3PagingOneCanonicalTrap;
2356
2357	/**
2358	* Sets up the 64-bit canonical address space trap buffers, if neceessary.
2359	*
2360	* @returns Pointer to the buffers (i.e. the first page of the low one) on
2361	* success. NULL on failure.
2362	*/
2363	BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3PagingSetupCanonicalTraps,(void));
2364
2365	/**
2366	* Waits for the keyboard controller to become ready.
2367	*/
2368	BS3_CMN_PROTO_NOSB(void, Bs3KbdWait,(void));
2369
2370	/**
2371	* Sends a read command to the keyboard controller and gets the result.
2372	*
2373	* The caller is responsible for making sure the keyboard controller is ready
2374	* for a command (call #Bs3KbdWait if unsure).
2375	*
2376	* @returns The value read is returned (in al).
2377	* @param bCmd The read command.
2378	*/
2379	BS3_CMN_PROTO_NOSB(uint8_t, Bs3KbdRead,(uint8_t bCmd));
2380
2381	/**
2382	* Sends a write command to the keyboard controller and then sends the data.
2383	*
2384	* The caller is responsible for making sure the keyboard controller is ready
2385	* for a command (call #Bs3KbdWait if unsure).
2386	*
2387	* @param bCmd The write command.
2388	* @param bData The data to write.
2389	*/
2390	BS3_CMN_PROTO_NOSB(void, Bs3KbdWrite,(uint8_t bCmd, uint8_t bData));
2391
2392
2393	/**
2394	* Configures the PIC, once only.
2395	*
2396	* Subsequent calls to this function will not do anything.
2397	*
2398	* The PIC will be programmed to use IDT/IVT vectors 0x70 thru 0x7f, auto
2399	* end-of-interrupt, and all IRQs masked. The individual PIC users will have to
2400	* use #Bs3PicUpdateMask unmask their IRQ once they've got all the handlers
2401	* installed.
2402	*/
2403	BS3_CMN_PROTO_STUB(void, Bs3PicSetup,(void));
2404
2405	/**
2406	* Updates the PIC masks.
2407	*
2408	* @returns The new mask - master in low, slave in high byte.
2409	* @param fAndMask Things to keep as-is. Master in low, slave in high byte.
2410	* @param fOrMask Things to start masking. Ditto wrt bytes.
2411	*/
2412	BS3_CMN_PROTO_STUB(uint16_t, Bs3PicUpdateMask,(uint16_t fAndMask, uint16_t fOrMask));
2413
2414	/**
2415	* Disables all IRQs on the PIC.
2416	*/
2417	BS3_CMN_PROTO_STUB(void, Bs3PicMaskAll,(void));
2418
2419
2420	/**
2421	* Sets up the PIT for periodic callback.
2422	*
2423	* @param cHzDesired The desired Hz. Zero means max interval length
2424	* (18.2Hz). Plase check the various PIT globals for
2425	* the actual interval length.
2426	*/
2427	BS3_CMN_PROTO_STUB(void, Bs3PitSetupAndEnablePeriodTimer,(uint16_t cHzDesired));
2428
2429	/**
2430	* Disables the PIT if active.
2431	*/
2432	BS3_CMN_PROTO_STUB(void, Bs3PitDisable,(void));
2433
2434	/** Nano seconds (approx) since last the PIT timer was started. */
2435	extern uint64_t volatile g_cBs3PitNs;
2436	/** Milliseconds seconds (very approx) since last the PIT timer was started. */
2437	extern uint64_t volatile g_cBs3PitMs;
2438	/** Number of ticks since last the PIT timer was started. */
2439	extern uint32_t volatile g_cBs3PitTicks;
2440	/** The current interval in nanon seconds. */
2441	extern uint32_t g_cBs3PitIntervalNs;
2442	/** The current interval in milliseconds (approximately).
2443	* This is 0 if not yet started (used for checking the state internally). */
2444	extern uint16_t volatile g_cBs3PitIntervalMs;
2445	/** The current PIT frequency (approximately). 0 if not yet started. */
2446	extern uint16_t g_cBs3PitIntervalHz;
2447
2448
2449	/**
2450	* Call 16-bit prot mode function from v8086 mode.
2451	*
2452	* This switches from v8086 mode to 16-bit protected mode (code) and executed
2453	* @a fpfnCall with @a cbParams bytes of parameters pushed on the stack.
2454	* Afterwards it switches back to v8086 mode and returns a 16-bit status code.
2455	*
2456	* @returns 16-bit status code if the function returned anything.
2457	* @param fpfnCall Far real mode pointer to the function to call.
2458	* @param cbParams The size of the parameter list, in bytes.
2459	* @param ... The parameters.
2460	* @sa Bs3SwitchTo32BitAndCallC
2461	*/
2462	BS3_CMN_PROTO_STUB(int, Bs3SwitchFromV86To16BitAndCallC,(FPFNBS3FAR fpfnCall, unsigned cbParams, ...));
2463
2464
2465	/**
2466	* BS3 integer register.
2467	*/
2468	typedef union BS3REG
2469	{
2470	/** 8-bit unsigned integer. */
2471	uint8_t u8;
2472	/** 16-bit unsigned integer. */
2473	uint16_t u16;
2474	/** 32-bit unsigned integer. */
2475	uint32_t u32;
2476	/** 64-bit unsigned integer. */
2477	uint64_t u64;
2478	/** Full unsigned integer. */
2479	uint64_t u;
2480	/** High/low byte view. */
2481	struct
2482	{
2483	uint8_t bLo;
2484	uint8_t bHi;
2485	} b;
2486	/** 8-bit view. */
2487	uint8_t au8[8];
2488	/** 16-bit view. */
2489	uint16_t au16[4];
2490	/** 32-bit view. */
2491	uint32_t au32[2];
2492	} BS3REG;
2493	/** Pointer to an integer register. */
2494	typedef BS3REG BS3_FAR *PBS3REG;
2495	/** Pointer to a const integer register. */
2496	typedef BS3REG const BS3_FAR *PCBS3REG;
2497
2498	/**
2499	* Register context (without FPU).
2500	*/
2501	typedef struct BS3REGCTX
2502	{
2503	BS3REG rax; /*< 0x00 /
2504	BS3REG rcx; /*< 0x08 /
2505	BS3REG rdx; /*< 0x10 /
2506	BS3REG rbx; /*< 0x18 /
2507	BS3REG rsp; /*< 0x20 /
2508	BS3REG rbp; /*< 0x28 /
2509	BS3REG rsi; /*< 0x30 /
2510	BS3REG rdi; /*< 0x38 /
2511	BS3REG r8; /*< 0x40 /
2512	BS3REG r9; /*< 0x48 /
2513	BS3REG r10; /*< 0x50 /
2514	BS3REG r11; /*< 0x58 /
2515	BS3REG r12; /*< 0x60 /
2516	BS3REG r13; /*< 0x68 /
2517	BS3REG r14; /*< 0x70 /
2518	BS3REG r15; /*< 0x78 /
2519	BS3REG rflags; /*< 0x80 /
2520	BS3REG rip; /*< 0x88 /
2521	uint16_t cs; /*< 0x90 /
2522	uint16_t ds; /*< 0x92 /
2523	uint16_t es; /*< 0x94 /
2524	uint16_t fs; /*< 0x96 /
2525	uint16_t gs; /*< 0x98 /
2526	uint16_t ss; /*< 0x9a /
2527	uint16_t tr; /*< 0x9c /
2528	uint16_t ldtr; /*< 0x9e /
2529	uint8_t bMode; /*< 0xa0: BS3_MODE_XXX. /
2530	uint8_t bCpl; /*< 0xa1: 0-3, 0 is used for real mode. /
2531	uint8_t fbFlags; /*< 0xa2: BS3REG_CTX_F_XXX /
2532	uint8_t abPadding[5]; /*< 0xa3 /
2533	BS3REG cr0; /*< 0xa8 /
2534	BS3REG cr2; /*< 0xb0 /
2535	BS3REG cr3; /*< 0xb8 /
2536	BS3REG cr4; /*< 0xc0 /
2537	uint64_t uUnused; /*< 0xc8 /
2538	} BS3REGCTX;
2539	AssertCompileSize(BS3REGCTX, 0xd0);
2540	/** Pointer to a register context. */
2541	typedef BS3REGCTX BS3_FAR *PBS3REGCTX;
2542	/** Pointer to a const register context. */
2543	typedef BS3REGCTX const BS3_FAR *PCBS3REGCTX;
2544
2545	/** @name BS3REG_CTX_F_XXX - BS3REGCTX::fbFlags masks.
2546	* @{ */
2547	/** The CR0 is MSW (only low 16-bit). */
2548	#define BS3REG_CTX_F_NO_CR0_IS_MSW UINT8_C(0x01)
2549	/** No CR2 and CR3 values. Not in CPL 0 or CPU too old for CR2 & CR3. */
2550	#define BS3REG_CTX_F_NO_CR2_CR3 UINT8_C(0x02)
2551	/** No CR4 value. The CPU is too old for CR4. */
2552	#define BS3REG_CTX_F_NO_CR4 UINT8_C(0x04)
2553	/** No TR and LDTR values. Context gathered in real mode or v8086 mode. */
2554	#define BS3REG_CTX_F_NO_TR_LDTR UINT8_C(0x08)
2555	/** The context doesn't have valid values for AMD64 GPR extensions. */
2556	#define BS3REG_CTX_F_NO_AMD64 UINT8_C(0x10)
2557	/** @} */
2558
2559	/**
2560	* Saves the current register context.
2561	*
2562	* @param pRegCtx Where to store the register context.
2563	*/
2564	BS3_CMN_PROTO_NOSB(void, Bs3RegCtxSave,(PBS3REGCTX pRegCtx));
2565
2566	/**
2567	* Switch to the specified CPU bitcount, reserve additional stack and save the
2568	* CPU context.
2569	*
2570	* This is for writing more flexible test drivers that can test more than the
2571	* CPU bitcount (16-bit, 32-bit, 64-bit, and virtual 8086) of the driver itself.
2572	* For instance a 32-bit driver can do V86 and 16-bit testing, thus saving more
2573	* precious and problematic 16-bit code.
2574	*
2575	* @param pRegCtx Where to store the register context.
2576	* @param bBitMode Bit mode to switch to, BS3_MODE_CODE_XXX. Only
2577	* BS3_MODE_CODE_MASK is used, other bits are ignored
2578	* to make it possible to pass a full mode value.
2579	* @param cbExtraStack Number of bytes of additional stack to allocate.
2580	*/
2581	BS3_CMN_PROTO_FARSTUB(8, void, Bs3RegCtxSaveEx,(PBS3REGCTX pRegCtx, uint8_t bBitMode, uint16_t cbExtraStack));
2582
2583	/**
2584	* Transforms a register context to a different ring.
2585	*
2586	* @param pRegCtx The register context.
2587	* @param bRing The target ring (0..3).
2588	*/
2589	BS3_CMN_PROTO_STUB(void, Bs3RegCtxConvertToRingX,(PBS3REGCTX pRegCtx, uint8_t bRing));
2590
2591	/**
2592	* Restores a register context.
2593	*
2594	* @param pRegCtx The register context to be restored and resumed.
2595	* @param fFlags BS3REGCTXRESTORE_F_XXX.
2596	*
2597	* @remarks Will switch to ring-0.
2598	* @remarks Does not return.
2599	*/
2600	BS3_CMN_PROTO_NOSB(DECL_NO_RETURN(void), Bs3RegCtxRestore,(PCBS3REGCTX pRegCtx, uint16_t fFlags));
2601	#if !defined(BS3_KIT_WITH_NO_RETURN) && defined(__WATCOMC__)
2602	# pragma aux Bs3RegCtxRestore_c16 "_Bs3RegCtxRestore_aborts_c16" __aborts
2603	# pragma aux Bs3RegCtxRestore_f16 "_Bs3RegCtxRestore_aborts_f16" __aborts
2604	# pragma aux Bs3RegCtxRestore_c32 "_Bs3RegCtxRestore_aborts_c32" __aborts
2605	#endif
2606
2607	/** Skip restoring the CRx registers. */
2608	#define BS3REGCTXRESTORE_F_SKIP_CRX UINT16_C(0x0001)
2609
2610	/**
2611	* Prints the register context.
2612	*
2613	* @param pRegCtx The register context to be printed.
2614	*/
2615	BS3_CMN_PROTO_STUB(void, Bs3RegCtxPrint,(PCBS3REGCTX pRegCtx));
2616
2617	/**
2618	* Sets a GPR and segment register to point at the same location as @a uFlat.
2619	*
2620	* @param pRegCtx The register context.
2621	* @param pGpr The general purpose register to set (points within
2622	* @a pRegCtx).
2623	* @param pSel The selector register (points within @a pRegCtx).
2624	* @param uFlat Flat location address.
2625	*/
2626	BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetGrpSegFromFlat,(PBS3REGCTX pRegCtx, PBS3REG pGpr, PRTSEL pSel, RTCCUINTXREG uFlat));
2627
2628	/**
2629	* Sets a GPR and segment register to point at the same location as @a ovPtr.
2630	*
2631	* @param pRegCtx The register context.
2632	* @param pGpr The general purpose register to set (points within
2633	* @a pRegCtx).
2634	* @param pSel The selector register (points within @a pRegCtx).
2635	* @param pvPtr Current context pointer.
2636	*/
2637	BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetGrpSegFromCurPtr,(PBS3REGCTX pRegCtx, PBS3REG pGpr, PRTSEL pSel, void BS3_FAR *pvPtr));
2638
2639	/**
2640	* Sets a GPR and DS to point at the same location as @a ovPtr.
2641	*
2642	* @param pRegCtx The register context.
2643	* @param pGpr The general purpose register to set (points within
2644	* @a pRegCtx).
2645	* @param pvPtr Current context pointer.
2646	*/
2647	BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetGrpDsFromCurPtr,(PBS3REGCTX pRegCtx, PBS3REG pGpr, void BS3_FAR *pvPtr));
2648
2649	/**
2650	* Sets CS:RIP to point at the same piece of code as @a uFlatCode.
2651	*
2652	* @param pRegCtx The register context.
2653	* @param uFlatCode Flat code pointer
2654	* @sa Bs3RegCtxSetRipCsFromLnkPtr, Bs3RegCtxSetRipCsFromCurPtr
2655	*/
2656	BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetRipCsFromFlat,(PBS3REGCTX pRegCtx, RTCCUINTXREG uFlatCode));
2657
2658	/**
2659	* Sets CS:RIP to point at the same piece of code as @a pfnCode.
2660	*
2661	* The 16-bit edition of this function expects a far 16:16 address as written by
2662	* the linker (i.e. real mode).
2663	*
2664	* @param pRegCtx The register context.
2665	* @param pfnCode Pointer to the code. In 32-bit and 64-bit mode this is a
2666	* flat address, while in 16-bit it's a far 16:16 address
2667	* as fixed up by the linker (real mode selector). This
2668	* address is converted to match the mode of the context.
2669	* @sa Bs3RegCtxSetRipCsFromCurPtr, Bs3RegCtxSetRipCsFromFlat
2670	*/
2671	BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetRipCsFromLnkPtr,(PBS3REGCTX pRegCtx, FPFNBS3FAR pfnCode));
2672
2673	/**
2674	* Sets CS:RIP to point at the same piece of code as @a pfnCode.
2675	*
2676	* @param pRegCtx The register context.
2677	* @param pfnCode Pointer to the code. Current mode pointer.
2678	* @sa Bs3RegCtxSetRipCsFromLnkPtr, Bs3RegCtxSetRipCsFromFlat
2679	*/
2680	BS3_CMN_PROTO_STUB(void, Bs3RegCtxSetRipCsFromCurPtr,(PBS3REGCTX pRegCtx, FPFNBS3FAR pfnCode));
2681
2682
2683	/**
2684	* The method to be used to save and restore the extended context.
2685	*/
2686	typedef enum BS3EXTCTXMETHOD
2687	{
2688	BS3EXTCTXMETHOD_INVALID = 0,
2689	BS3EXTCTXMETHOD_ANCIENT, /*< Ancient fnsave/frstor format. /
2690	BS3EXTCTXMETHOD_FXSAVE, /*< fxsave/fxrstor format. /
2691	BS3EXTCTXMETHOD_XSAVE, /*< xsave/xrstor format. /
2692	BS3EXTCTXMETHOD_END,
2693	} BS3EXTCTXMETHOD;
2694
2695
2696	/**
2697	* Extended CPU context (FPU, SSE, AVX, ++).
2698	*
2699	* @remarks Also in bs3kit.inc
2700	*/
2701	typedef struct BS3EXTCTX
2702	{
2703	/** Dummy/magic value. */
2704	uint16_t u16Magic;
2705	/** The size of the structure. */
2706	uint16_t cb;
2707	/** The method used to save and restore the context (BS3EXTCTXMETHOD). */
2708	uint8_t enmMethod;
2709	uint8_t abPadding0[3];
2710	/** Nominal XSAVE_C_XXX. */
2711	uint64_t fXcr0Nominal;
2712	/** The saved XCR0 mask (restored after xrstor). */
2713	uint64_t fXcr0Saved;
2714
2715	/** Explicit alignment padding. */
2716	uint8_t abPadding[64 - 2 - 2 - 1 - 3 - 8 - 8];
2717
2718	/** The context, variable size (see above).
2719	* This must be aligned on a 64 byte boundrary. */
2720	union
2721	{
2722	/** fnsave/frstor. */
2723	X86FPUSTATE Ancient;
2724	/** fxsave/fxrstor */
2725	X86FXSTATE x87;
2726	/** xsave/xrstor */
2727	X86XSAVEAREA x;
2728	/** Byte array view. */
2729	uint8_t ab[sizeof(X86XSAVEAREA)];
2730	} Ctx;
2731	} BS3EXTCTX;
2732	AssertCompileMemberAlignment(BS3EXTCTX, Ctx, 64);
2733	/** Pointer to an extended CPU context. */
2734	typedef BS3EXTCTX BS3_FAR *PBS3EXTCTX;
2735	/** Pointer to a const extended CPU context. */
2736	typedef BS3EXTCTX const BS3_FAR *PCBS3EXTCTX;
2737
2738	/** Magic value for BS3EXTCTX. */
2739	#define BS3EXTCTX_MAGIC UINT16_C(0x1980)
2740
2741	/**
2742	* Allocates and initializes the extended CPU context structure.
2743	*
2744	* @returns The new extended CPU context structure.
2745	* @param enmKind The kind of allocation to make.
2746	*/
2747	BS3_CMN_PROTO_STUB(PBS3EXTCTX, Bs3ExtCtxAlloc,(BS3MEMKIND enmKind));
2748
2749	/**
2750	* Frees an extended CPU context structure.
2751	*
2752	* @param pExtCtx The extended CPU context (returned by
2753	* Bs3ExtCtxAlloc).
2754	*/
2755	BS3_CMN_PROTO_STUB(void, Bs3ExtCtxFree,(PBS3EXTCTX pExtCtx));
2756
2757	/**
2758	* Get the size required for a BS3EXTCTX structure.
2759	*
2760	* @returns size in bytes of the whole structure.
2761	* @param pfFlags Where to return flags for Bs3ExtCtxInit.
2762	* @note Use Bs3ExtCtxAlloc when possible.
2763	*/
2764	BS3_CMN_PROTO_STUB(uint16_t, Bs3ExtCtxGetSize,(uint64_t *pfFlags));
2765
2766	/**
2767	* Initializes the extended CPU context structure.
2768	* @returns pExtCtx
2769	* @param pExtCtx The extended CPU context.
2770	* @param cbExtCtx The size of the @a pExtCtx allocation.
2771	* @param fFlags XSAVE_C_XXX flags.
2772	*/
2773	BS3_CMN_PROTO_STUB(PBS3EXTCTX, Bs3ExtCtxInit,(PBS3EXTCTX pExtCtx, uint16_t cbExtCtx, uint64_t fFlags));
2774
2775	/**
2776	* Saves the extended CPU state to the given structure.
2777	*
2778	* @param pExtCtx The extended CPU context.
2779	* @remarks All GPRs preserved.
2780	*/
2781	BS3_CMN_PROTO_FARSTUB(4, void, Bs3ExtCtxSave,(PBS3EXTCTX pExtCtx));
2782
2783	/**
2784	* Restores the extended CPU state from the given structure.
2785	*
2786	* @param pExtCtx The extended CPU context.
2787	* @remarks All GPRs preserved.
2788	*/
2789	BS3_CMN_PROTO_FARSTUB(4, void, Bs3ExtCtxRestore,(PBS3EXTCTX pExtCtx));
2790
2791	/**
2792	* Copies the state from one context to another.
2793	*
2794	* @returns pDst
2795	* @param pDst The destination extended CPU context.
2796	* @param pSrc The source extended CPU context.
2797	*/
2798	BS3_CMN_PROTO_STUB(PBS3EXTCTX, Bs3ExtCtxCopy,(PBS3EXTCTX pDst, PCBS3EXTCTX pSrc));
2799
2800
2801
2802	/**
2803	* Trap frame.
2804	*/
2805	typedef struct BS3TRAPFRAME
2806	{
2807	/** 0x00: Exception/interrupt number. */
2808	uint8_t bXcpt;
2809	/** 0x01: The size of the IRET frame. */
2810	uint8_t cbIretFrame;
2811	/** 0x02: The handler CS. */
2812	uint16_t uHandlerCs;
2813	/** 0x04: The handler SS. */
2814	uint16_t uHandlerSs;
2815	/** 0x06: Explicit alignment. */
2816	uint16_t usAlignment;
2817	/** 0x08: The handler RSP (pointer to the iret frame, skipping ErrCd). */
2818	uint64_t uHandlerRsp;
2819	/** 0x10: The handler RFLAGS value. */
2820	uint64_t fHandlerRfl;
2821	/** 0x18: The error code (if applicable). */
2822	uint64_t uErrCd;
2823	/** 0x20: The register context. */
2824	BS3REGCTX Ctx;
2825	} BS3TRAPFRAME;
2826	AssertCompileSize(BS3TRAPFRAME, 0x20 + 0xd0);
2827	/** Pointer to a trap frame. */
2828	typedef BS3TRAPFRAME BS3_FAR *PBS3TRAPFRAME;
2829	/** Pointer to a const trap frame. */
2830	typedef BS3TRAPFRAME const BS3_FAR *PCBS3TRAPFRAME;
2831
2832
2833	/**
2834	* Re-initializes the trap handling for the current mode.
2835	*
2836	* Useful after a test that messes with the IDT/IVT.
2837	*
2838	* @sa Bs3TrapInit
2839	*/
2840	BS3_CMN_PROTO_STUB(void, Bs3TrapReInit,(void));
2841
2842	/**
2843	* Initializes real mode and v8086 trap handling.
2844	*
2845	* @remarks Does not install RM/V86 trap handling, just initializes the
2846	* structures.
2847	*/
2848	BS3_CMN_PROTO_STUB(void, Bs3TrapRmV86Init,(void));
2849
2850	/**
2851	* Initializes real mode and v8086 trap handling, extended version.
2852	*
2853	* @param f386Plus Set if the CPU is 80386 or later and
2854	* extended registers should be saved. Once initialized
2855	* with this parameter set to @a true, the effect cannot be
2856	* reversed.
2857	*
2858	* @remarks Does not install RM/V86 trap handling, just initializes the
2859	* structures.
2860	*/
2861	BS3_CMN_PROTO_STUB(void, Bs3TrapRmV86InitEx,(bool f386Plus));
2862
2863	/**
2864	* Initializes 16-bit (protected mode) trap handling.
2865	*
2866	* @remarks Does not install 16-bit trap handling, just initializes the
2867	* structures.
2868	*/
2869	BS3_CMN_PROTO_STUB(void, Bs3Trap16Init,(void));
2870
2871	/**
2872	* Initializes 16-bit (protected mode) trap handling, extended version.
2873	*
2874	* @param f386Plus Set if the CPU is 80386 or later and
2875	* extended registers should be saved. Once initialized
2876	* with this parameter set to @a true, the effect cannot be
2877	* reversed.
2878	*
2879	* @remarks Does not install 16-bit trap handling, just initializes the
2880	* structures.
2881	*/
2882	BS3_CMN_PROTO_STUB(void, Bs3Trap16InitEx,(bool f386Plus));
2883
2884	/**
2885	* Initializes 32-bit trap handling.
2886	*
2887	* @remarks Does not install 32-bit trap handling, just initializes the
2888	* structures.
2889	*/
2890	BS3_CMN_PROTO_STUB(void, Bs3Trap32Init,(void));
2891
2892	/**
2893	* Initializes 64-bit trap handling
2894	*
2895	* @remarks Does not install 64-bit trap handling, just initializes the
2896	* structures.
2897	*/
2898	BS3_CMN_PROTO_STUB(void, Bs3Trap64Init,(void));
2899
2900	/**
2901	* Modifies the real-mode / V86 IVT entry specified by @a iIvt.
2902	*
2903	* @param iIvt The index of the IDT entry to set.
2904	* @param uSeg The handler real-mode segment.
2905	* @param off The handler offset.
2906	*/
2907	BS3_CMN_PROTO_STUB(void, Bs3TrapRmV86SetGate,(uint8_t iIvt, uint16_t uSeg, uint16_t off));
2908
2909	/**
2910	* Modifies the 16-bit IDT entry (protected mode) specified by @a iIdt.
2911	*
2912	* @param iIdt The index of the IDT entry to set.
2913	* @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
2914	* @param bDpl The DPL.
2915	* @param uSel The handler selector.
2916	* @param off The handler offset (if applicable).
2917	* @param cParams The parameter count (for call gates).
2918	*/
2919	BS3_CMN_PROTO_STUB(void, Bs3Trap16SetGate,(uint8_t iIdt, uint8_t bType, uint8_t bDpl,
2920	uint16_t uSel, uint16_t off, uint8_t cParams));
2921
2922	/** The address of Bs3Trap16GenericEntries.
2923	* Bs3Trap16GenericEntries is an array of interrupt/trap/whatever entry
2924	* points, 8 bytes each, that will create a register frame and call the generic
2925	* C compatible trap handlers. */
2926	extern uint32_t g_Bs3Trap16GenericEntriesFlatAddr;
2927
2928	/**
2929	* Modifies the 32-bit IDT entry specified by @a iIdt.
2930	*
2931	* @param iIdt The index of the IDT entry to set.
2932	* @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
2933	* @param bDpl The DPL.
2934	* @param uSel The handler selector.
2935	* @param off The handler offset (if applicable).
2936	* @param cParams The parameter count (for call gates).
2937	*/
2938	BS3_CMN_PROTO_STUB(void, Bs3Trap32SetGate,(uint8_t iIdt, uint8_t bType, uint8_t bDpl,
2939	uint16_t uSel, uint32_t off, uint8_t cParams));
2940
2941	/** The address of Bs3Trap32GenericEntries.
2942	* Bs3Trap32GenericEntries is an array of interrupt/trap/whatever entry
2943	* points, 10 bytes each, that will create a register frame and call the generic
2944	* C compatible trap handlers. */
2945	extern uint32_t g_Bs3Trap32GenericEntriesFlatAddr;
2946
2947	/**
2948	* Modifies the 64-bit IDT entry specified by @a iIdt.
2949	*
2950	* @param iIdt The index of the IDT entry to set.
2951	* @param bType The gate type (X86_SEL_TYPE_SYS_XXX).
2952	* @param bDpl The DPL.
2953	* @param uSel The handler selector.
2954	* @param off The handler offset (if applicable).
2955	* @param bIst The interrupt stack to use.
2956	*/
2957	BS3_CMN_PROTO_STUB(void, Bs3Trap64SetGate,(uint8_t iIdt, uint8_t bType, uint8_t bDpl, uint16_t uSel, uint64_t off, uint8_t bIst));
2958
2959	/** The address of Bs3Trap64GenericEntries.
2960	* Bs3Trap64GenericEntries is an array of interrupt/trap/whatever entry
2961	* points, 8 bytes each, that will create a register frame and call the generic
2962	* C compatible trap handlers. */
2963	extern uint32_t g_Bs3Trap64GenericEntriesFlatAddr;
2964
2965	/**
2966	* C-style trap handler.
2967	*
2968	* The caller will resume the context in @a pTrapFrame upon return.
2969	*
2970	* @param pTrapFrame The trap frame. Registers can be modified.
2971	* @note The 16-bit versions must be in CGROUP16!
2972	*/
2973	typedef BS3_DECL_NEAR_CALLBACK(void) FNBS3TRAPHANDLER(PBS3TRAPFRAME pTrapFrame);
2974	/** Pointer to a trap handler (current template context). */
2975	typedef FNBS3TRAPHANDLER *PFNBS3TRAPHANDLER;
2976
2977	#if ARCH_BITS == 16
2978	/** @copydoc FNBS3TRAPHANDLER */
2979	typedef FNBS3FAR FNBS3TRAPHANDLER32;
2980	/** @copydoc FNBS3TRAPHANDLER */
2981	typedef FNBS3FAR FNBS3TRAPHANDLER64;
2982	#else
2983	/** @copydoc FNBS3TRAPHANDLER */
2984	typedef FNBS3TRAPHANDLER FNBS3TRAPHANDLER32;
2985	/** @copydoc FNBS3TRAPHANDLER */
2986	typedef FNBS3TRAPHANDLER FNBS3TRAPHANDLER64;
2987	#endif
2988	/** @copydoc PFNBS3TRAPHANDLER */
2989	typedef FNBS3TRAPHANDLER32 *PFNBS3TRAPHANDLER32;
2990	/** @copydoc PFNBS3TRAPHANDLER */
2991	typedef FNBS3TRAPHANDLER64 *PFNBS3TRAPHANDLER64;
2992
2993
2994	/**
2995	* C-style trap handler, near 16-bit (CGROUP16).
2996	*
2997	* The caller will resume the context in @a pTrapFrame upon return.
2998	*
2999	* @param pTrapFrame The trap frame. Registers can be modified.
3000	*/
3001	typedef BS3_DECL_NEAR_CALLBACK(void) FNBS3TRAPHANDLER16(PBS3TRAPFRAME pTrapFrame);
3002	/** Pointer to a trap handler (current template context). */
3003	typedef FNBS3TRAPHANDLER16 *PFNBS3TRAPHANDLER16;
3004
3005	/**
3006	* C-style trap handler, near 16-bit (CGROUP16).
3007	*
3008	* The caller will resume the context in @a pTrapFrame upon return.
3009	*
3010	* @param pTrapFrame The trap frame. Registers can be modified.
3011	*/
3012	typedef BS3_DECL_CALLBACK(void) FNBS3TRAPHANDLER3264(PBS3TRAPFRAME pTrapFrame);
3013	/** Pointer to a trap handler (current template context). */
3014	typedef FNBS3TRAPHANDLER3264 *FPFNBS3TRAPHANDLER3264;
3015
3016
3017	/**
3018	* Sets a trap handler (C/C++/assembly) for the current bitcount.
3019	*
3020	* @returns Previous handler.
3021	* @param iIdt The index of the IDT entry to set.
3022	* @param pfnHandler Pointer to the handler.
3023	* @sa Bs3TrapSetHandlerEx
3024	*/
3025	BS3_CMN_PROTO_STUB(PFNBS3TRAPHANDLER, Bs3TrapSetHandler,(uint8_t iIdt, PFNBS3TRAPHANDLER pfnHandler));
3026
3027	/**
3028	* Sets a trap handler (C/C++/assembly) for all the bitcounts.
3029	*
3030	* @param iIdt The index of the IDT and IVT entry to set.
3031	* @param pfnHandler16 Pointer to the 16-bit handler. (Assumes linker addresses.)
3032	* @param pfnHandler32 Pointer to the 32-bit handler. (Assumes linker addresses.)
3033	* @param pfnHandler64 Pointer to the 64-bit handler. (Assumes linker addresses.)
3034	* @sa Bs3TrapSetHandler
3035	*/
3036	BS3_CMN_PROTO_STUB(void, Bs3TrapSetHandlerEx,(uint8_t iIdt, PFNBS3TRAPHANDLER16 pfnHandler16,
3037	PFNBS3TRAPHANDLER32 pfnHandler32, PFNBS3TRAPHANDLER64 pfnHandler64));
3038
3039	/**
3040	* Default C/C++ trap handler.
3041	*
3042	* This will check trap record and panic if no match was found.
3043	*
3044	* @param pTrapFrame Trap frame of the trap to handle.
3045	*/
3046	BS3_CMN_PROTO_STUB(void, Bs3TrapDefaultHandler,(PBS3TRAPFRAME pTrapFrame));
3047
3048	/**
3049	* Prints the trap frame (to screen).
3050	* @param pTrapFrame Trap frame to print.
3051	*/
3052	BS3_CMN_PROTO_STUB(void, Bs3TrapPrintFrame,(PCBS3TRAPFRAME pTrapFrame));
3053
3054	/**
3055	* Sets up a long jump from a trap handler.
3056	*
3057	* The long jump will only be performed onced, but will catch any kind of trap,
3058	* fault, interrupt or irq.
3059	*
3060	* @retval true on the initial call.
3061	* @retval false on trap return.
3062	* @param pTrapFrame Where to store the trap information when
3063	* returning @c false.
3064	* @sa #Bs3TrapUnsetJmp
3065	*/
3066	BS3_CMN_PROTO_NOSB(DECL_RETURNS_TWICE(bool),Bs3TrapSetJmp,(PBS3TRAPFRAME pTrapFrame));
3067
3068	/**
3069	* Combination of #Bs3TrapSetJmp and #Bs3RegCtxRestore.
3070	*
3071	* @param pCtxRestore The context to restore.
3072	* @param pTrapFrame Where to store the trap information.
3073	*/
3074	BS3_CMN_PROTO_STUB(void, Bs3TrapSetJmpAndRestore,(PCBS3REGCTX pCtxRestore, PBS3TRAPFRAME pTrapFrame));
3075
3076	/**
3077	* Disables a previous #Bs3TrapSetJmp call.
3078	*/
3079	BS3_CMN_PROTO_STUB(void, Bs3TrapUnsetJmp,(void));
3080
3081
3082	/**
3083	* The current test step.
3084	*/
3085	extern uint16_t g_usBs3TestStep;
3086
3087	/**
3088	* Equivalent to RTTestCreate + RTTestBanner.
3089	*
3090	* @param pszTest The test name.
3091	*/
3092	BS3_CMN_PROTO_STUB(void, Bs3TestInit,(const char BS3_FAR *pszTest));
3093
3094
3095	/**
3096	* Equivalent to RTTestSummaryAndDestroy.
3097	*/
3098	BS3_CMN_PROTO_STUB(void, Bs3TestTerm,(void));
3099
3100	/**
3101	* Equivalent to RTTestISub.
3102	*/
3103	BS3_CMN_PROTO_STUB(void, Bs3TestSub,(const char BS3_FAR *pszSubTest));
3104
3105	/**
3106	* Equivalent to RTTestIFailedF.
3107	*/
3108	BS3_CMN_PROTO_STUB(void, Bs3TestSubF,(const char BS3_FAR *pszFormat, ...));
3109
3110	/**
3111	* Equivalent to RTTestISubV.
3112	*/
3113	BS3_CMN_PROTO_STUB(void, Bs3TestSubV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3114
3115	/**
3116	* Equivalent to RTTestISubDone.
3117	*/
3118	BS3_CMN_PROTO_STUB(void, Bs3TestSubDone,(void));
3119
3120	/**
3121	* Equivalent to RTTestSubErrorCount.
3122	*/
3123	BS3_CMN_PROTO_STUB(uint16_t, Bs3TestSubErrorCount,(void));
3124
3125	/**
3126	* Equivalent to RTTestIPrintf with RTTESTLVL_ALWAYS.
3127	*
3128	* @param pszFormat What to print, format string. Explicit newline char.
3129	* @param ... String format arguments.
3130	*/
3131	BS3_CMN_PROTO_STUB(void, Bs3TestPrintf,(const char BS3_FAR *pszFormat, ...));
3132
3133	/**
3134	* Equivalent to RTTestIPrintfV with RTTESTLVL_ALWAYS.
3135	*
3136	* @param pszFormat What to print, format string. Explicit newline char.
3137	* @param va String format arguments.
3138	*/
3139	BS3_CMN_PROTO_STUB(void, Bs3TestPrintfV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3140
3141	/**
3142	* Equivalent to RTTestIFailed.
3143	* @returns false.
3144	*/
3145	BS3_CMN_PROTO_STUB(bool, Bs3TestFailed,(const char BS3_FAR *pszMessage));
3146
3147	/**
3148	* Equivalent to RTTestIFailedF.
3149	* @returns false.
3150	*/
3151	BS3_CMN_PROTO_STUB(bool, Bs3TestFailedF,(const char BS3_FAR *pszFormat, ...));
3152
3153	/**
3154	* Equivalent to RTTestIFailedV.
3155	* @returns false.
3156	*/
3157	BS3_CMN_PROTO_STUB(bool, Bs3TestFailedV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3158
3159	/**
3160	* Equivalent to RTTestISkipped.
3161	*
3162	* @param pszWhy Optional reason why it's being skipped.
3163	*/
3164	BS3_CMN_PROTO_STUB(void, Bs3TestSkipped,(const char BS3_FAR *pszWhy));
3165
3166	/**
3167	* Equivalent to RTTestISkippedF.
3168	*
3169	* @param pszFormat Optional reason why it's being skipped.
3170	* @param ... Format arguments.
3171	*/
3172	BS3_CMN_PROTO_STUB(void, Bs3TestSkippedF,(const char BS3_FAR *pszFormat, ...));
3173
3174	/**
3175	* Equivalent to RTTestISkippedV.
3176	*
3177	* @param pszFormat Optional reason why it's being skipped.
3178	* @param va Format arguments.
3179	*/
3180	BS3_CMN_PROTO_STUB(void, Bs3TestSkippedV,(const char BS3_FAR *pszFormat, va_list BS3_FAR va));
3181
3182	/**
3183	* Compares two register contexts, with PC and SP adjustments.
3184	*
3185	* Differences will be reported as test failures.
3186	*
3187	* @returns true if equal, false if not.
3188	* @param pActualCtx The actual register context.
3189	* @param pExpectedCtx Expected register context.
3190	* @param cbPcAdjust Program counter adjustment (applied to @a pExpectedCtx).
3191	* @param cbSpAdjust Stack pointer adjustment (applied to @a pExpectedCtx).
3192	* @param fExtraEfl Extra EFLAGS to OR into @a pExepctedCtx.
3193	* @param pszMode CPU mode or some other helpful text.
3194	* @param idTestStep Test step identifier.
3195	*/
3196	BS3_CMN_PROTO_STUB(bool, Bs3TestCheckRegCtxEx,(PCBS3REGCTX pActualCtx, PCBS3REGCTX pExpectedCtx, uint16_t cbPcAdjust,
3197	int16_t cbSpAdjust, uint32_t fExtraEfl, const char *pszMode, uint16_t idTestStep));
3198
3199	/**
3200	* Performs the testing for the given mode.
3201	*
3202	* This is called with the CPU already switch to that mode.
3203	*
3204	* @returns 0 on success or directly Bs3TestFailed calls, non-zero to indicate
3205	* where the test when wrong. Special value BS3TESTDOMODE_SKIPPED
3206	* should be returned to indicate that the test has been skipped.
3207	* @param bMode The current CPU mode.
3208	*/
3209	typedef BS3_DECL_CALLBACK(uint8_t) FNBS3TESTDOMODE(uint8_t bMode);
3210	/** Pointer (far) to a test (for 32-bit and 64-bit code, will be flatten). */
3211	typedef FNBS3TESTDOMODE *PFNBS3TESTDOMODE;
3212
3213	/** Special FNBS3TESTDOMODE return code for indicating a skipped mode test. */
3214	#define BS3TESTDOMODE_SKIPPED UINT8_MAX
3215
3216	/**
3217	* Mode sub-test entry.
3218	*
3219	* This can only be passed around to functions with the same bit count, as it
3220	* contains function pointers. In 16-bit mode, the 16-bit pointers are near and
3221	* implies BS3TEXT16, whereas the 32-bit and 64-bit pointers are far real mode
3222	* addresses that will be converted to flat address prior to calling them.
3223	* Similarly, in 32-bit and 64-bit the addresses are all flat and the 16-bit
3224	* ones will be converted to BS3TEXT16 based addresses prior to calling.
3225	*/
3226	typedef struct BS3TESTMODEENTRY
3227	{
3228	/** The sub-test name to be passed to Bs3TestSub if not NULL. */
3229	const char * BS3_FAR pszSubTest;
3230
3231	PFNBS3TESTDOMODE pfnDoRM;
3232
3233	PFNBS3TESTDOMODE pfnDoPE16;
3234	PFNBS3TESTDOMODE pfnDoPE16_32;
3235	PFNBS3TESTDOMODE pfnDoPE16_V86;
3236	PFNBS3TESTDOMODE pfnDoPE32;
3237	PFNBS3TESTDOMODE pfnDoPE32_16;
3238	PFNBS3TESTDOMODE pfnDoPEV86;
3239
3240	PFNBS3TESTDOMODE pfnDoPP16;
3241	PFNBS3TESTDOMODE pfnDoPP16_32;
3242	PFNBS3TESTDOMODE pfnDoPP16_V86;
3243	PFNBS3TESTDOMODE pfnDoPP32;
3244	PFNBS3TESTDOMODE pfnDoPP32_16;
3245	PFNBS3TESTDOMODE pfnDoPPV86;
3246
3247	PFNBS3TESTDOMODE pfnDoPAE16;
3248	PFNBS3TESTDOMODE pfnDoPAE16_32;
3249	PFNBS3TESTDOMODE pfnDoPAE16_V86;
3250	PFNBS3TESTDOMODE pfnDoPAE32;
3251	PFNBS3TESTDOMODE pfnDoPAE32_16;
3252	PFNBS3TESTDOMODE pfnDoPAEV86;
3253
3254	PFNBS3TESTDOMODE pfnDoLM16;
3255	PFNBS3TESTDOMODE pfnDoLM32;
3256	PFNBS3TESTDOMODE pfnDoLM64;
3257
3258	} BS3TESTMODEENTRY;
3259	/** Pointer to a mode sub-test entry. */
3260	typedef BS3TESTMODEENTRY const *PCBS3TESTMODEENTRY;
3261
3262	/** @def BS3TESTMODEENTRY_CMN
3263	* Produces a BS3TESTMODEENTRY initializer for common (c16,c32,c64) test
3264	* functions. */
3265	#define BS3TESTMODEENTRY_CMN(a_szTest, a_BaseNm) \
3266	{ /pszSubTest =/ a_szTest, \
3267	/RM/ RT_CONCAT(a_BaseNm, _c16), \
3268	/PE16/ RT_CONCAT(a_BaseNm, _c16), \
3269	/PE16_32/ RT_CONCAT(a_BaseNm, _c32), \
3270	/PE16_V86/ RT_CONCAT(a_BaseNm, _c16), \
3271	/PE32/ RT_CONCAT(a_BaseNm, _c32), \
3272	/PE32_16/ RT_CONCAT(a_BaseNm, _c16), \
3273	/PEV86/ RT_CONCAT(a_BaseNm, _c16), \
3274	/PP16/ RT_CONCAT(a_BaseNm, _c16), \
3275	/PP16_32/ RT_CONCAT(a_BaseNm, _c32), \
3276	/PP16_V86/ RT_CONCAT(a_BaseNm, _c16), \
3277	/PP32/ RT_CONCAT(a_BaseNm, _c32), \
3278	/PP32_16/ RT_CONCAT(a_BaseNm, _c16), \
3279	/PPV86/ RT_CONCAT(a_BaseNm, _c16), \
3280	/PAE16/ RT_CONCAT(a_BaseNm, _c16), \
3281	/PAE16_32/ RT_CONCAT(a_BaseNm, _c32), \
3282	/PAE16_V86/ RT_CONCAT(a_BaseNm, _c16), \
3283	/PAE32/ RT_CONCAT(a_BaseNm, _c32), \
3284	/PAE32_16/ RT_CONCAT(a_BaseNm, _c16), \
3285	/PAEV86/ RT_CONCAT(a_BaseNm, _c16), \
3286	/LM16/ RT_CONCAT(a_BaseNm, _c16), \
3287	/LM32/ RT_CONCAT(a_BaseNm, _c32), \
3288	/LM64/ RT_CONCAT(a_BaseNm, _c64), \
3289	}
3290
3291	/** @def BS3TESTMODE_PROTOTYPES_CMN
3292	* A set of standard protypes to go with #BS3TESTMODEENTRY_CMN. */
3293	#define BS3TESTMODE_PROTOTYPES_CMN(a_BaseNm) \
3294	FNBS3TESTDOMODE /BS3_FAR_CODE/ RT_CONCAT(a_BaseNm, _c16); \
3295	FNBS3TESTDOMODE /BS3_FAR_CODE/ RT_CONCAT(a_BaseNm, _c32); \
3296	FNBS3TESTDOMODE /BS3_FAR_CODE/ RT_CONCAT(a_BaseNm, _c64)
3297
3298	/** @def BS3TESTMODEENTRY_CMN_64
3299	* Produces a BS3TESTMODEENTRY initializer for common 64-bit test functions. */
3300	#define BS3TESTMODEENTRY_CMN_64(a_szTest, a_BaseNm) \
3301	{ /pszSubTest =/ a_szTest, \
3302	/RM/ NULL, \
3303	/PE16/ NULL, \
3304	/PE16_32/ NULL, \
3305	/PE16_V86/ NULL, \
3306	/PE32/ NULL, \
3307	/PE32_16/ NULL, \
3308	/PEV86/ NULL, \
3309	/PP16/ NULL, \
3310	/PP16_32/ NULL, \
3311	/PP16_V86/ NULL, \
3312	/PP32/ NULL, \
3313	/PP32_16/ NULL, \
3314	/PPV86/ NULL, \
3315	/PAE16/ NULL, \
3316	/PAE16_32/ NULL, \
3317	/PAE16_V86/ NULL, \
3318	/PAE32/ NULL, \
3319	/PAE32_16/ NULL, \
3320	/PAEV86/ NULL, \
3321	/LM16/ NULL, \
3322	/LM32/ NULL, \
3323	/LM64/ RT_CONCAT(a_BaseNm, _c64), \
3324	}
3325
3326	/** @def BS3TESTMODE_PROTOTYPES_CMN
3327	* Standard protype to go with #BS3TESTMODEENTRY_CMN_64. */
3328	#define BS3TESTMODE_PROTOTYPES_CMN_64(a_BaseNm) \
3329	FNBS3TESTDOMODE /BS3_FAR_CODE/ RT_CONCAT(a_BaseNm, _c64)
3330
3331	/** @def BS3TESTMODEENTRY_MODE
3332	* Produces a BS3TESTMODEENTRY initializer for a full set of mode test
3333	* functions. */
3334	#define BS3TESTMODEENTRY_MODE(a_szTest, a_BaseNm) \
3335	{ /pszSubTest =/ a_szTest, \
3336	/RM/ RT_CONCAT(a_BaseNm, _rm), \
3337	/PE16/ RT_CONCAT(a_BaseNm, _pe16), \
3338	/PE16_32/ RT_CONCAT(a_BaseNm, _pe16_32), \
3339	/PE16_V86/ RT_CONCAT(a_BaseNm, _pe16_v86), \
3340	/PE32/ RT_CONCAT(a_BaseNm, _pe32), \
3341	/PE32_16/ RT_CONCAT(a_BaseNm, _pe32_16), \
3342	/PEV86/ RT_CONCAT(a_BaseNm, _pev86), \
3343	/PP16/ RT_CONCAT(a_BaseNm, _pp16), \
3344	/PP16_32/ RT_CONCAT(a_BaseNm, _pp16_32), \
3345	/PP16_V86/ RT_CONCAT(a_BaseNm, _pp16_v86), \
3346	/PP32/ RT_CONCAT(a_BaseNm, _pp32), \
3347	/PP32_16/ RT_CONCAT(a_BaseNm, _pp32_16), \
3348	/PPV86/ RT_CONCAT(a_BaseNm, _ppv86), \
3349	/PAE16/ RT_CONCAT(a_BaseNm, _pae16), \
3350	/PAE16_32/ RT_CONCAT(a_BaseNm, _pae16_32), \
3351	/PAE16_V86/ RT_CONCAT(a_BaseNm, _pae16_v86), \
3352	/PAE32/ RT_CONCAT(a_BaseNm, _pae32), \
3353	/PAE32_16/ RT_CONCAT(a_BaseNm, _pae32_16), \
3354	/PAEV86/ RT_CONCAT(a_BaseNm, _paev86), \
3355	/LM16/ RT_CONCAT(a_BaseNm, _lm16), \
3356	/LM32/ RT_CONCAT(a_BaseNm, _lm32), \
3357	/LM64/ RT_CONCAT(a_BaseNm, _lm64), \
3358	}
3359
3360	/** @def BS3TESTMODE_PROTOTYPES_MODE
3361	* A set of standard protypes to go with #BS3TESTMODEENTRY_MODE. */
3362	#define BS3TESTMODE_PROTOTYPES_MODE(a_BaseNm) \
3363	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _rm); \
3364	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16); \
3365	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16_32); \
3366	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16_v86); \
3367	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe32); \
3368	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe32_16); \
3369	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pev86); \
3370	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp16); \
3371	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp16_32); \
3372	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp16_v86); \
3373	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp32); \
3374	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp32_16); \
3375	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _ppv86); \
3376	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae16); \
3377	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae16_32); \
3378	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae16_v86); \
3379	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae32); \
3380	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae32_16); \
3381	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _paev86); \
3382	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _lm16); \
3383	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _lm32); \
3384	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _lm64)
3385
3386
3387	/**
3388	* Mode sub-test entry, max bit-count driven
3389	*
3390	* This is an alternative to BS3TESTMODEENTRY where a few workers (test drivers)
3391	* does all the work, using faster 32-bit and 64-bit code where possible. This
3392	* avoids executing workers in V8086 mode. It allows for modifying and checking
3393	* 64-bit register content when testing LM16 and LM32.
3394	*
3395	* The 16-bit workers are only used for real mode and 16-bit protected mode.
3396	* So, the 16-bit version of the code template can be stripped of anything
3397	* related to paging and/or v8086, saving code space.
3398	*/
3399	typedef struct BS3TESTMODEBYMAXENTRY
3400	{
3401	/** The sub-test name to be passed to Bs3TestSub if not NULL. */
3402	const char * BS3_FAR pszSubTest;
3403
3404	PFNBS3TESTDOMODE pfnDoRM;
3405	PFNBS3TESTDOMODE pfnDoPE16;
3406	PFNBS3TESTDOMODE pfnDoPE16_32;
3407	PFNBS3TESTDOMODE pfnDoPE32;
3408	PFNBS3TESTDOMODE pfnDoPP16_32;
3409	PFNBS3TESTDOMODE pfnDoPP32;
3410	PFNBS3TESTDOMODE pfnDoPAE16_32;
3411	PFNBS3TESTDOMODE pfnDoPAE32;
3412	PFNBS3TESTDOMODE pfnDoLM64;
3413
3414	bool fDoRM : 1;
3415
3416	bool fDoPE16 : 1;
3417	bool fDoPE16_32 : 1;
3418	bool fDoPE16_V86 : 1;
3419	bool fDoPE32 : 1;
3420	bool fDoPE32_16 : 1;
3421	bool fDoPEV86 : 1;
3422
3423	bool fDoPP16 : 1;
3424	bool fDoPP16_32 : 1;
3425	bool fDoPP16_V86 : 1;
3426	bool fDoPP32 : 1;
3427	bool fDoPP32_16 : 1;
3428	bool fDoPPV86 : 1;
3429
3430	bool fDoPAE16 : 1;
3431	bool fDoPAE16_32 : 1;
3432	bool fDoPAE16_V86 : 1;
3433	bool fDoPAE32 : 1;
3434	bool fDoPAE32_16 : 1;
3435	bool fDoPAEV86 : 1;
3436
3437	bool fDoLM16 : 1;
3438	bool fDoLM32 : 1;
3439	bool fDoLM64 : 1;
3440
3441	} BS3TESTMODEBYMAXENTRY;
3442	/** Pointer to a mode-by-max sub-test entry. */
3443	typedef BS3TESTMODEBYMAXENTRY const *PCBS3TESTMODEBYMAXENTRY;
3444
3445	/** @def BS3TESTMODEBYMAXENTRY_CMN
3446	* Produces a BS3TESTMODEBYMAXENTRY initializer for common (c16,c32,c64) test
3447	* functions. */
3448	#define BS3TESTMODEBYMAXENTRY_CMN(a_szTest, a_BaseNm) \
3449	{ /pszSubTest =/ a_szTest, \
3450	/RM/ RT_CONCAT(a_BaseNm, _c16), \
3451	/PE16/ RT_CONCAT(a_BaseNm, _c16), \
3452	/PE16_32/ RT_CONCAT(a_BaseNm, _c32), \
3453	/PE32/ RT_CONCAT(a_BaseNm, _c32), \
3454	/PP16_32/ RT_CONCAT(a_BaseNm, _c32), \
3455	/PP32/ RT_CONCAT(a_BaseNm, _c32), \
3456	/PAE16_32/ RT_CONCAT(a_BaseNm, _c32), \
3457	/PAE32/ RT_CONCAT(a_BaseNm, _c32), \
3458	/LM64/ RT_CONCAT(a_BaseNm, _c64), \
3459	/fDoRM/ true, \
3460	/fDoPE16/ true, \
3461	/fDoPE16_32/ true, \
3462	/fDoPE16_V86/ true, \
3463	/fDoPE32/ true, \
3464	/fDoPE32_16/ true, \
3465	/fDoPEV86/ true, \
3466	/fDoPP16/ true, \
3467	/fDoPP16_32/ true, \
3468	/fDoPP16_V86/ true, \
3469	/fDoPP32/ true, \
3470	/fDoPP32_16/ true, \
3471	/fDoPPV86/ true, \
3472	/fDoPAE16/ true, \
3473	/fDoPAE16_32/ true, \
3474	/fDoPAE16_V86/ true, \
3475	/fDoPAE32/ true, \
3476	/fDoPAE32_16/ true, \
3477	/fDoPAEV86/ true, \
3478	/fDoLM16/ true, \
3479	/fDoLM32/ true, \
3480	/fDoLM64/ true, \
3481	}
3482
3483	/** @def BS3TESTMODEBYMAX_PROTOTYPES_CMN
3484	* A set of standard protypes to go with #BS3TESTMODEBYMAXENTRY_CMN. */
3485	#define BS3TESTMODEBYMAX_PROTOTYPES_CMN(a_BaseNm) \
3486	FNBS3TESTDOMODE /BS3_FAR_CODE/ RT_CONCAT(a_BaseNm, _c16); \
3487	FNBS3TESTDOMODE /BS3_FAR_CODE/ RT_CONCAT(a_BaseNm, _c32); \
3488	FNBS3TESTDOMODE /BS3_FAR_CODE/ RT_CONCAT(a_BaseNm, _c64)
3489
3490
3491	/** @def BS3TESTMODEBYMAXENTRY_MODE
3492	* Produces a BS3TESTMODEBYMAXENTRY initializer for a full set of mode test
3493	* functions. */
3494	#define BS3TESTMODEBYMAXENTRY_MODE(a_szTest, a_BaseNm) \
3495	{ /pszSubTest =/ a_szTest, \
3496	/RM/ RT_CONCAT(a_BaseNm, _rm), \
3497	/PE16/ RT_CONCAT(a_BaseNm, _pe16), \
3498	/PE16_32/ RT_CONCAT(a_BaseNm, _pe16_32), \
3499	/PE32/ RT_CONCAT(a_BaseNm, _pe32), \
3500	/PP16_32/ RT_CONCAT(a_BaseNm, _pp16_32), \
3501	/PP32/ RT_CONCAT(a_BaseNm, _pp32), \
3502	/PAE16_32/ RT_CONCAT(a_BaseNm, _pae16_32), \
3503	/PAE32/ RT_CONCAT(a_BaseNm, _pae32), \
3504	/LM64/ RT_CONCAT(a_BaseNm, _lm64), \
3505	/fDoRM/ true, \
3506	/fDoPE16/ true, \
3507	/fDoPE16_32/ true, \
3508	/fDoPE16_V86/ true, \
3509	/fDoPE32/ true, \
3510	/fDoPE32_16/ true, \
3511	/fDoPEV86/ true, \
3512	/fDoPP16/ true, \
3513	/fDoPP16_32/ true, \
3514	/fDoPP16_V86/ true, \
3515	/fDoPP32/ true, \
3516	/fDoPP32_16/ true, \
3517	/fDoPPV86/ true, \
3518	/fDoPAE16/ true, \
3519	/fDoPAE16_32/ true, \
3520	/fDoPAE16_V86/ true, \
3521	/fDoPAE32/ true, \
3522	/fDoPAE32_16/ true, \
3523	/fDoPAEV86/ true, \
3524	/fDoLM16/ true, \
3525	/fDoLM32/ true, \
3526	/fDoLM64/ true, \
3527	}
3528
3529	/** @def BS3TESTMODEBYMAX_PROTOTYPES_MODE
3530	* A set of standard protypes to go with #BS3TESTMODEBYMAXENTRY_MODE. */
3531	#define BS3TESTMODEBYMAX_PROTOTYPES_MODE(a_BaseNm) \
3532	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _rm); \
3533	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16); \
3534	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe16_32); \
3535	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pe32); \
3536	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp16_32); \
3537	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pp32); \
3538	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae16_32); \
3539	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _pae32); \
3540	FNBS3TESTDOMODE RT_CONCAT(a_BaseNm, _lm64)
3541
3542
3543	/**
3544	* One worker drives all modes.
3545	*
3546	* This is an alternative to BS3TESTMODEENTRY where one worker, typically
3547	* 16-bit, does all the test driver work. It's called repeatedly from all
3548	* the modes being tested.
3549	*/
3550	typedef struct BS3TESTMODEBYONEENTRY
3551	{
3552	const char * BS3_FAR pszSubTest;
3553	PFNBS3TESTDOMODE pfnWorker;
3554	/** BS3TESTMODEBYONEENTRY_F_XXX. */
3555	uint32_t fFlags;
3556	} BS3TESTMODEBYONEENTRY;
3557	/** Pointer to a mode-by-one sub-test entry. */
3558	typedef BS3TESTMODEBYONEENTRY const *PCBS3TESTMODEBYONEENTRY;
3559
3560	/** @name BS3TESTMODEBYONEENTRY_F_XXX - flags.
3561	* @{ */
3562	/** Only test modes that has paging enabled. */
3563	#define BS3TESTMODEBYONEENTRY_F_ONLY_PAGING RT_BIT_32(0)
3564	/** @} */
3565
3566
3567	/**
3568	* Sets the full GDTR register.
3569	*
3570	* @param cbLimit The limit.
3571	* @param uBase The base address - 24, 32 or 64 bit depending on the
3572	* CPU mode.
3573	*/
3574	BS3_CMN_PROTO_NOSB(void, Bs3UtilSetFullGdtr,(uint16_t cbLimit, uint64_t uBase));
3575
3576	/**
3577	* Sets the full IDTR register.
3578	*
3579	* @param cbLimit The limit.
3580	* @param uBase The base address - 24, 32 or 64 bit depending on the
3581	* CPU mode.
3582	*/
3583	BS3_CMN_PROTO_NOSB(void, Bs3UtilSetFullIdtr,(uint16_t cbLimit, uint64_t uBase));
3584
3585
3586	/** @} */
3587
3588
3589	/**
3590	* Initializes all of boot sector kit \#3.
3591	*/
3592	BS3_DECL(void) Bs3InitAll_rm(void);
3593
3594	/**
3595	* Initializes the REAL and TILED memory pools.
3596	*
3597	* For proper operation on OLDer CPUs, call #Bs3CpuDetect_mmm first.
3598	*/
3599	BS3_DECL_FAR(void) Bs3InitMemory_rm_far(void);
3600
3601	/**
3602	* Initialized the X0TEXT16 and X1TEXT16 GDT entries.
3603	*/
3604	BS3_DECL_FAR(void) Bs3InitGdt_rm_far(void);
3605
3606
3607
3608	/** @defgroup grp_bs3kit_mode Mode Specific Functions and Data
3609	*
3610	* The mode specific functions come in bit count variations and CPU mode
3611	* variations. The bs3kit-template-header.h/mac defines the BS3_NM macro to
3612	* mangle a function or variable name according to the target CPU mode. In
3613	* non-templated code, it's common to spell the name out in full.
3614	*
3615	* @{
3616	*/
3617
3618
3619	/** @def BS3_MODE_PROTO_INT
3620	* Internal macro for emitting prototypes for mode functions.
3621	*
3622	* @param a_RetType The return type.
3623	* @param a_Name The function basename.
3624	* @param a_Params The parameter list (in parentheses).
3625	* @sa BS3_MODE_PROTO_STUB, BS3_MODE_PROTO_NOSB
3626	*/
3627	#define BS3_MODE_PROTO_INT(a_RetType, a_Name, a_Params) \
3628	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_rm) a_Params; \
3629	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe16) a_Params; \
3630	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe16_32) a_Params; \
3631	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe16_v86) a_Params; \
3632	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe32) a_Params; \
3633	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pe32_16) a_Params; \
3634	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pev86) a_Params; \
3635	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp16) a_Params; \
3636	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp16_32) a_Params; \
3637	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp16_v86) a_Params; \
3638	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp32) a_Params; \
3639	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pp32_16) a_Params; \
3640	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_ppv86) a_Params; \
3641	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae16) a_Params; \
3642	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae16_32) a_Params; \
3643	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae16_v86) a_Params; \
3644	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae32) a_Params; \
3645	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_pae32_16) a_Params; \
3646	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_paev86) a_Params; \
3647	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_lm16) a_Params; \
3648	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_lm32) a_Params; \
3649	BS3_DECL_NEAR(a_RetType) RT_CONCAT(a_Name,_lm64) a_Params; \
3650	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_rm_far) a_Params; \
3651	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pe16_far) a_Params; \
3652	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pe16_v86_far) a_Params; \
3653	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pe32_16_far) a_Params; \
3654	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pev86_far) a_Params; \
3655	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pp16_far) a_Params; \
3656	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pp16_v86_far) a_Params; \
3657	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pp32_16_far) a_Params; \
3658	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_ppv86_far) a_Params; \
3659	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pae16_far) a_Params; \
3660	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pae16_v86_far)a_Params; \
3661	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_pae32_16_far) a_Params; \
3662	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_paev86_far) a_Params; \
3663	BS3_DECL_FAR(a_RetType) RT_CONCAT(a_Name,_lm16_far) a_Params
3664
3665	/** @def BS3_MODE_PROTO_STUB
3666	* Macro for prototyping all the variations of a mod function with automatic
3667	* near -> far stub.
3668	*
3669	* @param a_RetType The return type.
3670	* @param a_Name The function basename.
3671	* @param a_Params The parameter list (in parentheses).
3672	* @sa BS3_MODE_PROTO_STUB, BS3_MODE_PROTO_NOSB
3673	*/
3674	#define BS3_MODE_PROTO_STUB(a_RetType, a_Name, a_Params) BS3_MODE_PROTO_INT(a_RetType, a_Name, a_Params)
3675
3676	/** @def BS3_MODE_PROTO_STUB
3677	* Macro for prototyping all the variations of a mod function without any
3678	* near -> far stub.
3679	*
3680	* @param a_RetType The return type.
3681	* @param a_Name The function basename.
3682	* @param a_Params The parameter list (in parentheses).
3683	* @sa BS3_MODE_PROTO_STUB, BS3_MODE_PROTO_NOSB
3684	*/
3685	#define BS3_MODE_PROTO_NOSB(a_RetType, a_Name, a_Params) BS3_MODE_PROTO_INT(a_RetType, a_Name, a_Params)
3686
3687
3688	/**
3689	* Macro for reducing typing.
3690	*
3691	* Doxygen knows how to expand this, well, kind of.
3692	*
3693	* @remarks Variables instantiated in assembly code should define two labels,
3694	* with and without leading underscore. Variables instantiated from
3695	* C/C++ code doesn't need to as the object file convert does this for
3696	* 64-bit object files.
3697	*/
3698	#define BS3_MODE_EXPAND_EXTERN_DATA16(a_VarType, a_VarName, a_Suffix) \
3699	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_rm) a_Suffix; \
3700	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe16) a_Suffix; \
3701	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe16_32) a_Suffix; \
3702	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe16_v86) a_Suffix; \
3703	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe32) a_Suffix; \
3704	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pe32_16) a_Suffix; \
3705	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pev86) a_Suffix; \
3706	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp16) a_Suffix; \
3707	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp16_32) a_Suffix; \
3708	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp16_v86) a_Suffix; \
3709	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp32) a_Suffix; \
3710	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pp32_16) a_Suffix; \
3711	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_ppv86) a_Suffix; \
3712	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae16) a_Suffix; \
3713	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae16_32) a_Suffix; \
3714	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae16_v86)a_Suffix; \
3715	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae32) a_Suffix; \
3716	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_pae32_16) a_Suffix; \
3717	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_paev86) a_Suffix; \
3718	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_lm16) a_Suffix; \
3719	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_lm32) a_Suffix; \
3720	extern a_VarType BS3_FAR_DATA RT_CONCAT(a_VarName,_lm64) a_Suffix
3721
3722
3723	/** The TMPL_MODE_STR value for each mode.
3724	* These are all in DATA16 so they can be accessed from any code. */
3725	BS3_MODE_EXPAND_EXTERN_DATA16(const char, g_szBs3ModeName, []);
3726	/** The TMPL_MODE_LNAME value for each mode.
3727	* These are all in DATA16 so they can be accessed from any code. */
3728	BS3_MODE_EXPAND_EXTERN_DATA16(const char, g_szBs3ModeNameShortLower, []);
3729
3730
3731	/**
3732	* Basic CPU detection.
3733	*
3734	* This sets the #g_uBs3CpuDetected global variable to the return value.
3735	*
3736	* @returns BS3CPU_XXX value with the BS3CPU_F_CPUID flag set depending on
3737	* capabilities.
3738	*/
3739	BS3_MODE_PROTO_NOSB(uint8_t, Bs3CpuDetect,(void));
3740
3741	/** @name BS3CPU_XXX - CPU detected by BS3CpuDetect_c16() and friends.
3742	* @{ */
3743	#define BS3CPU_8086 UINT16_C(0x0001) /*< Both 8086 and 8088. /
3744	#define BS3CPU_V20 UINT16_C(0x0002) /*< Both NEC V20, V30 and relatives. /
3745	#define BS3CPU_80186 UINT16_C(0x0003) /*< Both 80186 and 80188. /
3746	#define BS3CPU_80286 UINT16_C(0x0004)
3747	#define BS3CPU_80386 UINT16_C(0x0005)
3748	#define BS3CPU_80486 UINT16_C(0x0006)
3749	#define BS3CPU_Pentium UINT16_C(0x0007)
3750	#define BS3CPU_PPro UINT16_C(0x0008)
3751	#define BS3CPU_PProOrNewer UINT16_C(0x0009)
3752	/** CPU type mask. This is a full byte so it's possible to use byte access
3753	* without and AND'ing to get the type value. */
3754	#define BS3CPU_TYPE_MASK UINT16_C(0x00ff)
3755	/** Flag indicating that the CPUID instruction is supported by the CPU. */
3756	#define BS3CPU_F_CPUID UINT16_C(0x0100)
3757	/** Flag indicating that extend CPUID leaves are available (at least two). */
3758	#define BS3CPU_F_CPUID_EXT_LEAVES UINT16_C(0x0200)
3759	/** Flag indicating that the CPU supports PAE. */
3760	#define BS3CPU_F_PAE UINT16_C(0x0400)
3761	/** Flag indicating that the CPU supports the page size extension (4MB pages). */
3762	#define BS3CPU_F_PSE UINT16_C(0x0800)
3763	/** Flag indicating that the CPU supports long mode. */
3764	#define BS3CPU_F_LONG_MODE UINT16_C(0x1000)
3765	/** Flag indicating that the CPU supports NX. */
3766	#define BS3CPU_F_NX UINT16_C(0x2000)
3767	/** @} */
3768
3769	/** The return value of #Bs3CpuDetect_mmm. (Initial value is BS3CPU_TYPE_MASK.) */
3770	extern uint16_t g_uBs3CpuDetected;
3771
3772	/**
3773	* Call 32-bit prot mode C function.
3774	*
3775	* This switches to 32-bit mode and calls the 32-bit @a fpfnCall C code with @a
3776	* cbParams on the stack, then returns in the original mode. When called in
3777	* real mode, this will switch to PE32.
3778	*
3779	* @returns 32-bit status code if the function returned anything.
3780	* @param fpfnCall Address of the 32-bit C function to call. When
3781	* called from 16-bit code, this is a far real mode
3782	* function pointer, i.e. as fixed up by the linker.
3783	* In 32-bit and 64-bit code, this is a flat address.
3784	* @param cbParams The size of the parameter list, in bytes.
3785	* @param ... The parameters.
3786	* @sa Bs3SwitchFromV86To16BitAndCallC
3787	*
3788	* @remarks WARNING! This probably doesn't work in 64-bit mode yet.
3789	* Only tested for 16-bit real mode.
3790	*/
3791	BS3_MODE_PROTO_STUB(int32_t, Bs3SwitchTo32BitAndCallC,(FPFNBS3FAR fpfnCall, unsigned cbParams, ...));
3792
3793	/**
3794	* Initializes trap handling for the current system.
3795	*
3796	* Calls the appropriate Bs3Trap16Init, Bs3Trap32Init or Bs3Trap64Init function.
3797	*/
3798	BS3_MODE_PROTO_STUB(void, Bs3TrapInit,(void));
3799
3800	/**
3801	* Executes the array of tests in every possibly mode.
3802	*
3803	* @param paEntries The mode sub-test entries.
3804	* @param cEntries The number of sub-test entries.
3805	*/
3806	BS3_MODE_PROTO_NOSB(void, Bs3TestDoModes,(PCBS3TESTMODEENTRY paEntries, size_t cEntries));
3807
3808	/**
3809	* Executes the array of tests in every possibly mode, unified driver.
3810	*
3811	* This requires much less code space than Bs3TestDoModes as there is only one
3812	* instace of each sub-test driver code, instead of 3 (cmn) or 22 (per-mode)
3813	* copies.
3814	*
3815	* @param paEntries The mode sub-test-by-one entries.
3816	* @param cEntries The number of sub-test-by-one entries.
3817	* @param fFlags Reserved for the future, MBZ.
3818	*/
3819	BS3_MODE_PROTO_NOSB(void, Bs3TestDoModesByOne,(PCBS3TESTMODEBYONEENTRY paEntries, size_t cEntries, uint32_t fFlags));
3820
3821	/**
3822	* Executes the array of tests in every possibly mode, using the max bit-count
3823	* worker for each.
3824	*
3825	* @param paEntries The mode sub-test entries.
3826	* @param cEntries The number of sub-test entries.
3827	*/
3828	BS3_MODE_PROTO_NOSB(void, Bs3TestDoModesByMax,(PCBS3TESTMODEBYMAXENTRY paEntries, size_t cEntries));
3829
3830
3831	/** @} */
3832
3833	/** @} */
3834
3835	RT_C_DECLS_END
3836
3837
3838	/*
3839	* Include default function symbol mangling.
3840	*/
3841	#include "bs3kit-mangling-code.h"
3842
3843	/*
3844	* Change 16-bit text segment if requested.
3845	*/
3846	#if defined(BS3_USE_ALT_16BIT_TEXT_SEG) && ARCH_BITS == 16 && !defined(BS3_DONT_CHANGE_TEXT_SEG)
3847	# if (defined(BS3_USE_RM_TEXT_SEG) + defined(BS3_USE_X0_TEXT_SEG) + defined(BS3_USE_X1_TEXT_SEG)) != 1
3848	# error "Cannot set more than one alternative 16-bit text segment!"
3849	# elif defined(BS3_USE_RM_TEXT_SEG)
3850	# pragma code_seg("BS3RMTEXT16", "BS3CLASS16RMCODE")
3851	# elif defined(BS3_USE_X0_TEXT_SEG)
3852	# pragma code_seg("BS3X0TEXT16", "BS3CLASS16X0CODE")
3853	# elif defined(BS3_USE_X1_TEXT_SEG)
3854	# pragma code_seg("BS3X1TEXT16", "BS3CLASS16X1CODE")
3855	# else
3856	# error "Huh? Which alternative text segment did you want again?"
3857	# endif
3858	#endif
3859
3860	#endif
3861

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

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

Download in other formats: