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