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