[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / Legacy16.h

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