]>
Commit | Line | Data |
---|---|---|
79964ac8 | 1 | /** @file\r |
2 | API between 16-bit Legacy BIOS and EFI\r | |
3 | \r | |
4 | We need to figure out what the 16-bit code is going to use to\r | |
5 | represent these data structures. Is a pointer SEG:OFF or 32-bit...\r | |
6 | \r | |
7 | Copyright (c) 2007, Intel Corporation\r | |
8 | All rights reserved. This program and the accompanying materials\r | |
9 | are licensed and made available under the terms and conditions of the BSD License\r | |
10 | which accompanies this distribution. The full text of the license may be found at\r | |
11 | http://opensource.org/licenses/bsd-license.php\r | |
12 | \r | |
13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
15 | \r | |
16 | Module Name: FrameworkLegacy16.h\r | |
17 | \r | |
18 | @par Revision Reference:\r | |
19 | These definitions are from Compatibility Support Module Spec Version 0.96.\r | |
20 | \r | |
21 | **/\r | |
22 | \r | |
23 | #ifndef _FRAMEWORK_LEGACY_16_H_\r | |
24 | #define _FRAMEWORK_LEGACY_16_H_\r | |
25 | \r | |
26 | #include <Base.h>\r | |
27 | \r | |
28 | //\r | |
29 | // All structures defined in this header file are packed on byte boundary\r | |
30 | //\r | |
31 | #pragma pack(1)\r | |
32 | \r | |
33 | ///////////////////////////////////////////////////////////////////////////////\r | |
34 | // EFI_COMPATIBILITY16_TABLE is located at a 16-byte boundary starting with the\r | |
35 | // signature "$EFI"\r | |
36 | ///////////////////////////////////////////////////////////////////////////////\r | |
37 | \r | |
38 | #define EFI_COMPATIBILITY16_TABLE_SIGNATURE EFI_SIGNATURE_32('$', 'E', 'F', 'I')\r | |
39 | \r | |
40 | typedef struct {\r | |
41 | UINT32 Signature; // "$EFI"\r | |
42 | UINT8 TableChecksum;\r | |
43 | UINT8 TableLength;\r | |
44 | UINT8 EfiMajorRevision;\r | |
45 | UINT8 EfiMinorRevision;\r | |
46 | UINT8 TableMajorRevision;\r | |
47 | UINT8 TableMinorRevision;\r | |
48 | UINT16 Reserved;\r | |
49 | UINT16 Compatibility16CallSegment;\r | |
50 | UINT16 Compatibility16CallOffset;\r | |
51 | UINT16 PnPInstallationCheckSegment;\r | |
52 | UINT16 PnPInstallationCheckOffset;\r | |
53 | UINT32 EfiSystemTable; // The physical address of EFI_SYSTEM_TABLE\r | |
54 | UINT32 OemIdStringPointer;\r | |
55 | UINT32 AcpiRsdPtrPointer;\r | |
56 | UINT16 OemRevision;\r | |
57 | UINT32 E820Pointer;\r | |
58 | UINT32 E820Length;\r | |
59 | UINT32 IrqRoutingTablePointer;\r | |
60 | UINT32 IrqRoutingTableLength;\r | |
61 | UINT32 MpTablePtr;\r | |
62 | UINT32 MpTableLength;\r | |
63 | UINT16 OemIntSegment;\r | |
64 | UINT16 OemIntOffset;\r | |
65 | UINT16 Oem32Segment;\r | |
66 | UINT16 Oem32Offset;\r | |
67 | UINT16 Oem16Segment;\r | |
68 | UINT16 Oem16Offset;\r | |
69 | UINT16 TpmSegment;\r | |
70 | UINT16 TpmOffset;\r | |
71 | UINT32 IbvPointer;\r | |
72 | UINT32 PciExpressBase;\r | |
73 | UINT8 LastPciBus;\r | |
74 | } EFI_COMPATIBILITY16_TABLE;\r | |
75 | \r | |
76 | ///////////////////////////////////////////////////////////////////////////////\r | |
77 | // Functions provided by the CSM binary\r | |
78 | ///////////////////////////////////////////////////////////////////////////////\r | |
79 | typedef enum {\r | |
80 | Legacy16InitializeYourself = 0x0000,\r | |
81 | Legacy16UpdateBbs = 0x0001,\r | |
82 | Legacy16PrepareToBoot = 0x0002,\r | |
83 | Legacy16Boot = 0x0003,\r | |
84 | Legacy16RetrieveLastBootDevice= 0x0004,\r | |
85 | Legacy16DispatchOprom = 0x0005,\r | |
86 | Legacy16GetTableAddress = 0x0006,\r | |
87 | Legacy16SetKeyboardLeds = 0x0007,\r | |
88 | Legacy16InstallPciHandler = 0x0008\r | |
89 | } EFI_COMPATIBILITY_FUNCTIONS;\r | |
90 | \r | |
91 | ///////////////////////////////////////////////////////////////////////////////\r | |
92 | // EFI_TO_COMPATIBILITY16_INIT_TABLE\r | |
93 | ///////////////////////////////////////////////////////////////////////////////\r | |
94 | typedef struct {\r | |
95 | UINT32 BiosLessThan1MB;\r | |
96 | UINT32 HiPmmMemory;\r | |
97 | UINT32 HiPmmMemorySizeInBytes;\r | |
98 | UINT16 ReverseThunkCallSegment;\r | |
99 | UINT16 ReverseThunkCallOffset;\r | |
100 | UINT32 NumberE820Entries;\r | |
101 | UINT32 OsMemoryAbove1Mb;\r | |
102 | UINT32 ThunkStart;\r | |
103 | UINT32 ThunkSizeInBytes;\r | |
104 | UINT32 LowPmmMemory;\r | |
105 | UINT32 LowPmmMemorySizeInBytes;\r | |
106 | } EFI_TO_COMPATIBILITY16_INIT_TABLE;\r | |
107 | \r | |
108 | ///////////////////////////////////////////////////////////////////////////////\r | |
109 | // EFI_TO_COMPATIBILITY16_BOOT_TABLE\r | |
110 | ///////////////////////////////////////////////////////////////////////////////\r | |
111 | \r | |
112 | //\r | |
113 | // DEVICE_PRODUCER_SERIAL & its modes\r | |
114 | //\r | |
115 | typedef struct {\r | |
116 | UINT16 Address;\r | |
117 | UINT8 Irq;\r | |
118 | SERIAL_MODE Mode;\r | |
119 | } DEVICE_PRODUCER_SERIAL;\r | |
120 | \r | |
121 | #define DEVICE_SERIAL_MODE_NORMAL 0x00\r | |
122 | #define DEVICE_SERIAL_MODE_IRDA 0x01\r | |
123 | #define DEVICE_SERIAL_MODE_ASK_IR 0x02\r | |
124 | #define DEVICE_SERIAL_MODE_DUPLEX_HALF 0x00\r | |
125 | #define DEVICE_SERIAL_MODE_DUPLEX_FULL 0x10\r | |
126 | \r | |
127 | //\r | |
128 | // DEVICE_PRODUCER_PARALLEL & its modes\r | |
129 | //\r | |
130 | typedef struct {\r | |
131 | UINT16 Address;\r | |
132 | UINT8 Irq;\r | |
133 | UINT8 Dma;\r | |
134 | PARALLEL_MODE Mode;\r | |
135 | } DEVICE_PRODUCER_PARALLEL;\r | |
136 | \r | |
137 | #define DEVICE_PARALLEL_MODE_MODE_OUTPUT_ONLY 0x00\r | |
138 | #define DEVICE_PARALLEL_MODE_MODE_BIDIRECTIONAL 0x01\r | |
139 | #define DEVICE_PARALLEL_MODE_MODE_EPP 0x02\r | |
140 | #define DEVICE_PARALLEL_MODE_MODE_ECP 0x03\r | |
141 | \r | |
142 | //\r | |
143 | // DEVICE_PRODUCER_FLOPPY\r | |
144 | //\r | |
145 | typedef struct {\r | |
146 | UINT16 Address;\r | |
147 | UINT8 Irq;\r | |
148 | UINT8 Dma;\r | |
149 | UINT8 NumberOfFloppy;\r | |
150 | } DEVICE_PRODUCER_FLOPPY;\r | |
151 | \r | |
152 | //\r | |
153 | // LEGACY_DEVICE_FLAGS\r | |
154 | //\r | |
155 | typedef struct {\r | |
156 | UINT32 A20Kybd : 1;\r | |
157 | UINT32 A20Port90 : 1;\r | |
158 | UINT32 Reserved : 30;\r | |
159 | } LEGACY_DEVICE_FLAGS;\r | |
160 | \r | |
161 | //\r | |
162 | // DEVICE_PRODUCER_DATA_HEADER\r | |
163 | //\r | |
164 | typedef struct {\r | |
165 | DEVICE_PRODUCER_SERIAL Serial[4];\r | |
166 | DEVICE_PRODUCER_PARALLEL Parallel[3];\r | |
167 | DEVICE_PRODUCER_FLOPPY Floppy;\r | |
168 | UINT8 MousePresent;\r | |
169 | LEGACY_DEVICE_FLAGS Flags;\r | |
170 | } DEVICE_PRODUCER_DATA_HEADER;\r | |
171 | \r | |
172 | //\r | |
173 | // ATAPI_IDENTIFY\r | |
174 | //\r | |
175 | typedef struct {\r | |
176 | UINT16 Raw[256];\r | |
177 | } ATAPI_IDENTIFY;\r | |
178 | \r | |
179 | //\r | |
180 | // HDD_INFO & its status\r | |
181 | //\r | |
182 | typedef struct {\r | |
183 | UINT16 Status;\r | |
184 | UINT32 Bus;\r | |
185 | UINT32 Device;\r | |
186 | UINT32 Function;\r | |
187 | UINT16 CommandBaseAddress;\r | |
188 | UINT16 ControlBaseAddress;\r | |
189 | UINT16 BusMasterAddress;\r | |
190 | UINT8 HddIrq;\r | |
191 | ATAPI_IDENTIFY IdentifyDrive[2];\r | |
192 | } HDD_INFO;\r | |
193 | \r | |
194 | #define HDD_PRIMARY 0x01\r | |
195 | #define HDD_SECONDARY 0x02\r | |
196 | #define HDD_MASTER_ATAPI_CDROM 0x04\r | |
197 | #define HDD_SLAVE_ATAPI_CDROM 0x08\r | |
198 | #define HDD_MASTER_IDE 0x20\r | |
199 | #define HDD_SLAVE_IDE 0x40\r | |
200 | #define HDD_MASTER_ATAPI_ZIPDISK 0x10\r | |
201 | #define HDD_SLAVE_ATAPI_ZIPDISK 0x80\r | |
202 | \r | |
203 | //\r | |
204 | // BBS_STATUS_FLAGS\r | |
205 | //\r | |
206 | typedef struct {\r | |
207 | UINT16 OldPosition : 4;\r | |
208 | UINT16 Reserved1 : 4;\r | |
209 | UINT16 Enabled : 1;\r | |
210 | UINT16 Failed : 1;\r | |
211 | UINT16 MediaPresent : 2;\r | |
212 | UINT16 Reserved2 : 4;\r | |
213 | } BBS_STATUS_FLAGS;\r | |
214 | \r | |
215 | //\r | |
216 | // BBS_TABLE, device type values & boot priority values\r | |
217 | //\r | |
218 | typedef struct {\r | |
219 | UINT16 BootPriority;\r | |
220 | UINT32 Bus;\r | |
221 | UINT32 Device;\r | |
222 | UINT32 Function;\r | |
223 | UINT8 Class;\r | |
224 | UINT8 SubClass;\r | |
225 | UINT16 MfgStringOffset;\r | |
226 | UINT16 MfgStringSegment;\r | |
227 | UINT16 DeviceType;\r | |
228 | BBS_STATUS_FLAGS StatusFlags;\r | |
229 | UINT16 BootHandlerOffset;\r | |
230 | UINT16 BootHandlerSegment;\r | |
231 | UINT16 DescStringOffset;\r | |
232 | UINT16 DescStringSegment;\r | |
233 | UINT32 InitPerReserved;\r | |
234 | UINT32 AdditionalIrq13Handler;\r | |
235 | UINT32 AdditionalIrq18Handler;\r | |
236 | UINT32 AdditionalIrq19Handler;\r | |
237 | UINT32 AdditionalIrq40Handler;\r | |
238 | UINT8 AssignedDriveNumber;\r | |
239 | UINT32 AdditionalIrq41Handler;\r | |
240 | UINT32 AdditionalIrq46Handler;\r | |
241 | UINT32 IBV1;\r | |
242 | UINT32 IBV2;\r | |
243 | } BBS_TABLE;\r | |
244 | \r | |
245 | #define BBS_FLOPPY 0x01\r | |
246 | #define BBS_HARDDISK 0x02\r | |
247 | #define BBS_CDROM 0x03\r | |
248 | #define BBS_PCMCIA 0x04\r | |
249 | #define BBS_USB 0x05\r | |
250 | #define BBS_EMBED_NETWORK 0x06\r | |
251 | #define BBS_BEV_DEVICE 0x80\r | |
252 | #define BBS_UNKNOWN 0xff\r | |
253 | \r | |
254 | #define BBS_DO_NOT_BOOT_FROM 0xFFFC\r | |
255 | #define BBS_LOWEST_PRIORITY 0xFFFD\r | |
256 | #define BBS_UNPRIORITIZED_ENTRY 0xFFFE\r | |
257 | #define BBS_IGNORE_ENTRY 0xFFFF\r | |
258 | \r | |
259 | //\r | |
260 | // SMM_ATTRIBUTES & relating type, port and data size constants\r | |
261 | //\r | |
262 | typedef struct {\r | |
263 | UINT16 Type : 3;\r | |
264 | UINT16 PortGranularity : 3;\r | |
265 | UINT16 DataGranularity : 3;\r | |
266 | UINT16 Reserved : 7;\r | |
267 | } SMM_ATTRIBUTES;\r | |
268 | \r | |
269 | #define STANDARD_IO 0x00\r | |
270 | #define STANDARD_MEMORY 0x01\r | |
271 | \r | |
272 | #define PORT_SIZE_8 0x00\r | |
273 | #define PORT_SIZE_16 0x01\r | |
274 | #define PORT_SIZE_32 0x02\r | |
275 | #define PORT_SIZE_64 0x03\r | |
276 | \r | |
277 | #define DATA_SIZE_8 0x00\r | |
278 | #define DATA_SIZE_16 0x01\r | |
279 | #define DATA_SIZE_32 0x02\r | |
280 | #define DATA_SIZE_64 0x03\r | |
281 | \r | |
282 | //\r | |
283 | // SMM_FUNCTION & relating constants\r | |
284 | //\r | |
285 | typedef struct {\r | |
286 | UINT16 Function : 15;\r | |
287 | UINT16 Owner : 1;\r | |
288 | } SMM_FUNCTION;\r | |
289 | \r | |
290 | #define INT15_D042 0x0000\r | |
291 | #define GET_USB_BOOT_INFO 0x0001\r | |
292 | #define DMI_PNP_50_57 0x0002\r | |
293 | \r | |
294 | #define STANDARD_OWNER 0x0\r | |
295 | #define OEM_OWNER 0x1\r | |
296 | \r | |
297 | //\r | |
298 | // SMM_ENTRY\r | |
299 | //\r | |
300 | // This structure assumes both port and data sizes are 1. SmmAttribute must be\r | |
301 | // properly to reflect that assumption.\r | |
302 | //\r | |
303 | typedef struct {\r | |
304 | SMM_ATTRIBUTES SmmAttributes;\r | |
305 | SMM_FUNCTION SmmFunction;\r | |
306 | UINT8 SmmPort;\r | |
307 | UINT8 SmmData;\r | |
308 | } SMM_ENTRY;\r | |
309 | \r | |
310 | //\r | |
311 | // SMM_TABLE\r | |
312 | //\r | |
313 | typedef struct {\r | |
314 | UINT16 NumSmmEntries;\r | |
315 | SMM_ENTRY SmmEntry;\r | |
316 | } SMM_TABLE;\r | |
317 | \r | |
318 | //\r | |
319 | // UDC_ATTRIBUTES\r | |
320 | //\r | |
321 | typedef struct {\r | |
322 | UINT8 DirectoryServiceValidity : 1;\r | |
323 | UINT8 RabcaUsedFlag : 1;\r | |
324 | UINT8 ExecuteHddDiagnosticsFlag : 1;\r | |
325 | UINT8 Reserved : 5;\r | |
326 | } UDC_ATTRIBUTES;\r | |
327 | \r | |
328 | //\r | |
329 | // UD_TABLE\r | |
330 | //\r | |
331 | typedef struct {\r | |
332 | UDC_ATTRIBUTES Attributes;\r | |
333 | UINT8 DeviceNumber;\r | |
334 | UINT8 BbsTableEntryNumberForParentDevice;\r | |
335 | UINT8 BbsTableEntryNumberForBoot;\r | |
336 | UINT8 BbsTableEntryNumberForHddDiag;\r | |
337 | UINT8 BeerData[128];\r | |
338 | UINT8 ServiceAreaData[64];\r | |
339 | } UD_TABLE;\r | |
340 | \r | |
341 | //\r | |
342 | // EFI_TO_COMPATIBILITY16_BOOT_TABLE\r | |
343 | //\r | |
344 | #define EFI_TO_LEGACY_MAJOR_VERSION 0x02\r | |
345 | #define EFI_TO_LEGACY_MINOR_VERSION 0x00\r | |
346 | #define MAX_IDE_CONTROLLER 8\r | |
347 | \r | |
348 | typedef struct {\r | |
349 | UINT16 MajorVersion;\r | |
350 | UINT16 MinorVersion;\r | |
351 | UINT32 AcpiTable; // 4 GB range\r | |
352 | UINT32 SmbiosTable; // 4 GB range\r | |
353 | UINT32 SmbiosTableLength;\r | |
354 | \r | |
355 | //\r | |
356 | // Legacy SIO state\r | |
357 | //\r | |
358 | DEVICE_PRODUCER_DATA_HEADER SioData;\r | |
359 | \r | |
360 | UINT16 DevicePathType;\r | |
361 | UINT16 PciIrqMask;\r | |
362 | UINT32 NumberE820Entries;\r | |
363 | \r | |
364 | //\r | |
365 | // Controller & Drive Identify[2] per controller information\r | |
366 | //\r | |
367 | HDD_INFO HddInfo[MAX_IDE_CONTROLLER];\r | |
368 | \r | |
369 | UINT32 NumberBbsEntries;\r | |
370 | UINT32 BbsTable;\r | |
371 | UINT32 SmmTable;\r | |
372 | UINT32 OsMemoryAbove1Mb;\r | |
373 | UINT32 UnconventionalDeviceTable;\r | |
374 | } EFI_TO_COMPATIBILITY16_BOOT_TABLE;\r | |
375 | \r | |
376 | ///////////////////////////////////////////////////////////////////////////////\r | |
377 | // EFI_DISPATCH_OPROM_TABLE\r | |
378 | ///////////////////////////////////////////////////////////////////////////////\r | |
379 | \r | |
380 | typedef struct {\r | |
381 | UINT16 PnPInstallationCheckSegment;\r | |
382 | UINT16 PnPInstallationCheckOffset;\r | |
383 | UINT16 OpromSegment;\r | |
384 | UINT8 PciBus;\r | |
385 | UINT8 PciDeviceFunction;\r | |
386 | UINT8 NumberBbsEntries;\r | |
387 | VOID *BbsTablePointer; /// @bug: variable size on 32/64-bit systems.\r | |
388 | } EFI_DISPATCH_OPROM_TABLE;\r | |
389 | \r | |
390 | ///////////////////////////////////////////////////////////////////////////////\r | |
391 | // EFI_LEGACY_INSTALL_PCI_HANDLER\r | |
392 | ///////////////////////////////////////////////////////////////////////////////\r | |
393 | typedef struct {\r | |
394 | UINT8 PciBus;\r | |
395 | UINT8 PciDeviceFun;\r | |
396 | UINT8 PciSegment;\r | |
397 | UINT8 PciClass;\r | |
398 | UINT8 PciSubclass;\r | |
399 | UINT8 PciInterface;\r | |
400 | \r | |
401 | //\r | |
402 | // Primary section\r | |
403 | //\r | |
404 | UINT8 PrimaryIrq;\r | |
405 | UINT8 PrimaryReserved;\r | |
406 | UINT16 PrimaryControl;\r | |
407 | UINT16 PrimaryBase;\r | |
408 | UINT16 PrimaryBusMaster;\r | |
409 | \r | |
410 | //\r | |
411 | // Secondary Section\r | |
412 | //\r | |
413 | UINT8 SecondaryIrq;\r | |
414 | UINT8 SecondaryReserved;\r | |
415 | UINT16 SecondaryControl;\r | |
416 | UINT16 SecondaryBase;\r | |
417 | UINT16 SecondaryBusMaster;\r | |
418 | } EFI_LEGACY_INSTALL_PCI_HANDLER;\r | |
419 | \r | |
420 | //\r | |
421 | // Restore default pack value\r | |
422 | //\r | |
423 | #pragma pack()\r | |
424 | \r | |
425 | #endif\r |