VirtualBox

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

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

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

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