VirtualBox

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

最後變更 在這個檔案從59984是 59984,由 vboxsync 提交於 9 年 前

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

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette