tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-27 15:44:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated copyright. Deleted erroneous "Module Name" line. Changed preceding macro, enum, and structure comments to Doxygen style. Changed existing structure member comments to Doxygen style. Cleaned up some comment blocks to conform to the coding specification. Changed @bug comments on structure members to the postfix style so that the correct members are documented. Removed duplicate, orphan, EFI_TO_COMPATIBILITY16_BOOT_TABLE comment and move remaining comment to the correct location. Add descriptive comment to terminating #endif.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8672 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
darylm503 2009-06-26 19:36:51 +00:00
parent c7ab4e83a6
commit 8d129536f9
1 changed files with 414 additions and 420 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

154
IntelFrameworkPkg/Include/Framework/Legacy16.h
View File

@ -4,7 +4,7 @@
We need to figure out what the 16-bit code is going to use to We need to figure out what the 16-bit code is going to use to
represent these data structures. Is a pointer SEG:OFF or 32-bit... represent these data structures. Is a pointer SEG:OFF or 32-bit...
Copyright (c) 2007, Intel Corporation Copyright (c) 2007-2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -13,8 +13,6 @@
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: FrameworkLegacy16.h
@par Revision Reference: @par Revision Reference:
These definitions are from Compatibility Support Module Spec These definitions are from Compatibility Support Module Spec
Version 0.97. Version 0.97.
@ -31,11 +29,12 @@
typedef UINT8 SERIAL_MODE; typedef UINT8 SERIAL_MODE;
typedef UINT8 PARALLEL_MODE; typedef UINT8 PARALLEL_MODE;
//
// EFI_COMPATIBILITY16_TABLE is located at a 16-byte boundary starting with the
// signature "$EFI"
//
#define EFI_COMPATIBILITY16_TABLE_SIGNATURE SIGNATURE_32 ('I', 'F', 'E', '$') #define EFI_COMPATIBILITY16_TABLE_SIGNATURE SIGNATURE_32 ('I', 'F', 'E', '$')
///
/// EFI_COMPATIBILITY16_TABLE is located at a 16-byte boundary starting with the
/// signature "$EFI"
///
typedef struct { typedef struct {
UINT32 Signature; UINT32 Signature;
UINT8 TableChecksum; UINT8 TableChecksum;
@ -49,7 +48,7 @@ typedef struct {
UINT16 Compatibility16CallOffset; UINT16 Compatibility16CallOffset;
UINT16 PnPInstallationCheckSegment; UINT16 PnPInstallationCheckSegment;
UINT16 PnPInstallationCheckOffset; UINT16 PnPInstallationCheckOffset;
UINT32 EfiSystemTable; // The physical address of EFI_SYSTEM_TABLE UINT32 EfiSystemTable; ///< The physical address of EFI_SYSTEM_TABLE
UINT32 OemIdStringPointer; UINT32 OemIdStringPointer;
UINT32 AcpiRsdPtrPointer; UINT32 AcpiRsdPtrPointer;
UINT16 OemRevision; UINT16 OemRevision;
@ -72,9 +71,9 @@ typedef struct {
UINT8 LastPciBus; UINT8 LastPciBus;
} EFI_COMPATIBILITY16_TABLE; } EFI_COMPATIBILITY16_TABLE;
// ///
// Functions provided by the CSM binary /// Functions provided by the CSM binary
// ///
typedef enum { typedef enum {
Legacy16InitializeYourself = 0x0000, Legacy16InitializeYourself = 0x0000,
Legacy16UpdateBbs = 0x0001, Legacy16UpdateBbs = 0x0001,
@ -88,10 +87,9 @@ typedef enum {
} EFI_COMPATIBILITY_FUNCTIONS; } EFI_COMPATIBILITY_FUNCTIONS;
/////////////////////////////////////////////////////////////////////////////// ///
// EFI_DISPATCH_OPROM_TABLE /// EFI_DISPATCH_OPROM_TABLE
/////////////////////////////////////////////////////////////////////////////// ///
typedef struct { typedef struct {
UINT16 PnPInstallationCheckSegment; UINT16 PnPInstallationCheckSegment;
UINT16 PnPInstallationCheckOffset; UINT16 PnPInstallationCheckOffset;
@ -99,13 +97,13 @@ typedef struct {
UINT8 PciBus; UINT8 PciBus;
UINT8 PciDeviceFunction; UINT8 PciDeviceFunction;
UINT8 NumberBbsEntries; UINT8 NumberBbsEntries;
VOID *BbsTablePointer; /// @bug: variable size on 32/64-bit systems. VOID *BbsTablePointer; ///< @bug: variable size on 32/64-bit systems.
UINT16 RuntimeSegment; UINT16 RuntimeSegment;
} EFI_DISPATCH_OPROM_TABLE; } EFI_DISPATCH_OPROM_TABLE;
// ///
// EFI_TO_COMPATIBILITY16_INIT_TABLE /// EFI_TO_COMPATIBILITY16_INIT_TABLE
// ///
typedef struct { typedef struct {
UINT32 BiosLessThan1MB; UINT32 BiosLessThan1MB;
UINT32 HiPmmMemory; UINT32 HiPmmMemory;
@ -120,13 +118,9 @@ typedef struct {
UINT32 LowPmmMemorySizeInBytes; UINT32 LowPmmMemorySizeInBytes;
} EFI_TO_COMPATIBILITY16_INIT_TABLE; } EFI_TO_COMPATIBILITY16_INIT_TABLE;
// ///
// EFI_TO_COMPATIBILITY16_BOOT_TABLE /// DEVICE_PRODUCER_SERIAL & its modes
// ///
//
// DEVICE_PRODUCER_SERIAL & its modes
//
typedef struct { typedef struct {
UINT16 Address; UINT16 Address;
UINT8 Irq; UINT8 Irq;
@ -139,9 +133,9 @@ typedef struct {
#define DEVICE_SERIAL_MODE_DUPLEX_HALF 0x00 #define DEVICE_SERIAL_MODE_DUPLEX_HALF 0x00
#define DEVICE_SERIAL_MODE_DUPLEX_FULL 0x10 #define DEVICE_SERIAL_MODE_DUPLEX_FULL 0x10
// ///
// DEVICE_PRODUCER_PARALLEL & its modes /// DEVICE_PRODUCER_PARALLEL & its modes
// ///
typedef struct { typedef struct {
UINT16 Address; UINT16 Address;
UINT8 Irq; UINT8 Irq;
@ -154,9 +148,9 @@ typedef struct {
#define DEVICE_PARALLEL_MODE_MODE_EPP 0x02 #define DEVICE_PARALLEL_MODE_MODE_EPP 0x02
#define DEVICE_PARALLEL_MODE_MODE_ECP 0x03 #define DEVICE_PARALLEL_MODE_MODE_ECP 0x03
// ///
// DEVICE_PRODUCER_FLOPPY /// DEVICE_PRODUCER_FLOPPY
// ///
typedef struct { typedef struct {
UINT16 Address; UINT16 Address;
UINT8 Irq; UINT8 Irq;
@ -164,18 +158,18 @@ typedef struct {
UINT8 NumberOfFloppy; UINT8 NumberOfFloppy;
} DEVICE_PRODUCER_FLOPPY; } DEVICE_PRODUCER_FLOPPY;
// ///
// LEGACY_DEVICE_FLAGS /// LEGACY_DEVICE_FLAGS
// ///
typedef struct { typedef struct {
UINT32 A20Kybd : 1; UINT32 A20Kybd : 1;
UINT32 A20Port90 : 1; UINT32 A20Port90 : 1;
UINT32 Reserved : 30; UINT32 Reserved : 30;
} LEGACY_DEVICE_FLAGS; } LEGACY_DEVICE_FLAGS;
// ///
// DEVICE_PRODUCER_DATA_HEADER /// DEVICE_PRODUCER_DATA_HEADER
// ///
typedef struct { typedef struct {
DEVICE_PRODUCER_SERIAL Serial[4]; DEVICE_PRODUCER_SERIAL Serial[4];
DEVICE_PRODUCER_PARALLEL Parallel[3]; DEVICE_PRODUCER_PARALLEL Parallel[3];
@ -184,16 +178,16 @@ typedef struct {
LEGACY_DEVICE_FLAGS Flags; LEGACY_DEVICE_FLAGS Flags;
} DEVICE_PRODUCER_DATA_HEADER; } DEVICE_PRODUCER_DATA_HEADER;
// ///
// ATAPI_IDENTIFY /// ATAPI_IDENTIFY
// ///
typedef struct { typedef struct {
UINT16 Raw[256]; UINT16 Raw[256];
} ATAPI_IDENTIFY; } ATAPI_IDENTIFY;
// ///
// HDD_INFO & its status /// HDD_INFO & its status
// ///
typedef struct { typedef struct {
UINT16 Status; UINT16 Status;
UINT32 Bus; UINT32 Bus;
@ -215,9 +209,9 @@ typedef struct {
#define HDD_MASTER_ATAPI_ZIPDISK 0x10 #define HDD_MASTER_ATAPI_ZIPDISK 0x10
#define HDD_SLAVE_ATAPI_ZIPDISK 0x80 #define HDD_SLAVE_ATAPI_ZIPDISK 0x80
// ///
// BBS_STATUS_FLAGS /// BBS_STATUS_FLAGS
// ///
typedef struct { typedef struct {
UINT16 OldPosition : 4; UINT16 OldPosition : 4;
UINT16 Reserved1 : 4; UINT16 Reserved1 : 4;
@ -227,9 +221,9 @@ typedef struct {
UINT16 Reserved2 : 4; UINT16 Reserved2 : 4;
} BBS_STATUS_FLAGS; } BBS_STATUS_FLAGS;
// ///
// BBS_TABLE, device type values & boot priority values /// BBS_TABLE, device type values & boot priority values
// ///
typedef struct { typedef struct {
UINT16 BootPriority; UINT16 BootPriority;
UINT32 Bus; UINT32 Bus;
@ -271,9 +265,9 @@ typedef struct {
#define BBS_UNPRIORITIZED_ENTRY 0xFFFE #define BBS_UNPRIORITIZED_ENTRY 0xFFFE
#define BBS_IGNORE_ENTRY 0xFFFF #define BBS_IGNORE_ENTRY 0xFFFF
// ///
// SMM_ATTRIBUTES & relating type, port and data size constants /// SMM_ATTRIBUTES & relating type, port and data size constants
// ///
typedef struct { typedef struct {
UINT16 Type : 3; UINT16 Type : 3;
UINT16 PortGranularity : 3; UINT16 PortGranularity : 3;
@ -294,9 +288,9 @@ typedef struct {
#define DATA_SIZE_32 0x02 #define DATA_SIZE_32 0x02
#define DATA_SIZE_64 0x03 #define DATA_SIZE_64 0x03
// ///
// SMM_FUNCTION & relating constants /// SMM_FUNCTION & relating constants
// ///
typedef struct { typedef struct {
UINT16 Function : 15; UINT16 Function : 15;
UINT16 Owner : 1; UINT16 Owner : 1;
@ -309,12 +303,12 @@ typedef struct {
#define STANDARD_OWNER 0x0 #define STANDARD_OWNER 0x0
#define OEM_OWNER 0x1 #define OEM_OWNER 0x1
// /**
// SMM_ENTRY * SMM_ENTRY
// *
// This structure assumes both port and data sizes are 1. SmmAttribute must be * This structure assumes both port and data sizes are 1. SmmAttribute must be
// properly to reflect that assumption. * properly to reflect that assumption.
// **/
typedef struct { typedef struct {
SMM_ATTRIBUTES SmmAttributes; SMM_ATTRIBUTES SmmAttributes;
SMM_FUNCTION SmmFunction; SMM_FUNCTION SmmFunction;
@ -322,17 +316,17 @@ typedef struct {
UINT8 SmmData; UINT8 SmmData;
} SMM_ENTRY; } SMM_ENTRY;
// ///
// SMM_TABLE /// SMM_TABLE
// ///
typedef struct { typedef struct {
UINT16 NumSmmEntries; UINT16 NumSmmEntries;
SMM_ENTRY SmmEntry; SMM_ENTRY SmmEntry;
} SMM_TABLE; } SMM_TABLE;
// ///
// UDC_ATTRIBUTES /// UDC_ATTRIBUTES
// ///
typedef struct { typedef struct {
UINT8 DirectoryServiceValidity : 1; UINT8 DirectoryServiceValidity : 1;
UINT8 RabcaUsedFlag : 1; UINT8 RabcaUsedFlag : 1;
@ -340,9 +334,9 @@ typedef struct {
UINT8 Reserved : 5; UINT8 Reserved : 5;
} UDC_ATTRIBUTES; } UDC_ATTRIBUTES;
// ///
// UD_TABLE /// UD_TABLE
// ///
typedef struct { typedef struct {
UDC_ATTRIBUTES Attributes; UDC_ATTRIBUTES Attributes;
UINT8 DeviceNumber; UINT8 DeviceNumber;
@ -353,18 +347,18 @@ typedef struct {
UINT8 ServiceAreaData[64]; UINT8 ServiceAreaData[64];
} UD_TABLE; } UD_TABLE;
//
// EFI_TO_COMPATIBILITY16_BOOT_TABLE
//
#define EFI_TO_LEGACY_MAJOR_VERSION 0x02 #define EFI_TO_LEGACY_MAJOR_VERSION 0x02
#define EFI_TO_LEGACY_MINOR_VERSION 0x00 #define EFI_TO_LEGACY_MINOR_VERSION 0x00
#define MAX_IDE_CONTROLLER 8 #define MAX_IDE_CONTROLLER 8
///
/// EFI_TO_COMPATIBILITY16_BOOT_TABLE
///
typedef struct { typedef struct {
UINT16 MajorVersion; UINT16 MajorVersion;
UINT16 MinorVersion; UINT16 MinorVersion;
UINT32 AcpiTable; // 4 GB range UINT32 AcpiTable; ///< 4 GB range
UINT32 SmbiosTable; // 4 GB range UINT32 SmbiosTable; ///< 4 GB range
UINT32 SmbiosTableLength; UINT32 SmbiosTableLength;
// //
// Legacy SIO state // Legacy SIO state
@ -384,9 +378,9 @@ typedef struct {
UINT32 UnconventionalDeviceTable; UINT32 UnconventionalDeviceTable;
} EFI_TO_COMPATIBILITY16_BOOT_TABLE; } EFI_TO_COMPATIBILITY16_BOOT_TABLE;
// ///
// EFI_LEGACY_INSTALL_PCI_HANDLER /// EFI_LEGACY_INSTALL_PCI_HANDLER
// ///
typedef struct { typedef struct {
UINT8 PciBus; UINT8 PciBus;
UINT8 PciDeviceFun; UINT8 PciDeviceFun;
@ -417,4 +411,4 @@ typedef struct {
// //
#pragma pack() #pragma pack()
#endif #endif /* _FRAMEWORK_LEGACY_16_H_ */