copy into the RSDT/XSDT. InstallAcpiTable() must insert the new \r
table at the end of the RSDT/XSDT. To prevent namespace \r
collision, ACPI tables may be created using UEFI ACPI table \r
- format. See Appendix O. On successful output, TableKey is \r
+ format. On successful output, TableKey is \r
initialized with a unique key. Its value may be used in a \r
subsequent call to UninstallAcpiTable to remove an ACPI table. \r
If an EFI application is running at the time of this call, the \r
typedef struct _EFI_ARP_PROTOCOL EFI_ARP_PROTOCOL;\r
\r
typedef struct {\r
+ ///\r
+ /// Length in bytes of this entry.\r
+ ///\r
UINT32 Size;\r
+\r
+ ///\r
+ /// Set to TRUE if this entry is a "deny" entry.\r
+ /// Set to FALSE if this entry is a "normal" entry.\r
+ ///\r
BOOLEAN DenyFlag;\r
+\r
+ ///\r
+ /// Set to TRUE if this entry will not time out.\r
+ /// Set to FALSE if this entry will time out.\r
+ ///\r
BOOLEAN StaticFlag;\r
+\r
+ ///\r
+ /// 16-bit ARP hardware identifier number.\r
+ ///\r
UINT16 HwAddressType;\r
+\r
+ ///\r
+ /// 16-bit protocol type number.\r
+ ///\r
UINT16 SwAddressType;\r
+\r
+ ///\r
+ /// Length of the hardware address.\r
+ ///\r
UINT8 HwAddressLength;\r
+\r
+ ///\r
+ /// Length of the protocol address.\r
+ ///\r
UINT8 SwAddressLength;\r
} EFI_ARP_FIND_DATA;\r
\r
typedef struct {\r
+ ///\r
+ /// 16-bit protocol type number in host byte order.\r
+ ///\r
UINT16 SwAddressType; ///< Host byte order\r
+\r
+ ///\r
+ /// Length in bytes of the station's protocol address to register.\r
+ ///\r
UINT8 SwAddressLength;\r
+\r
+ ///\r
+ /// Pointer to the first byte of the protocol address to register. For\r
+ /// example, if SwAddressType is 0x0800 (IP), then\r
+ /// StationAddress points to the first byte of this station¡¯s IP\r
+ /// address stored in network byte order.\r
+ ///\r
VOID *StationAddress; ///< Network byte order\r
+\r
+ ///\r
+ /// The timeout value in 100-ns units that is associated with each\r
+ /// new dynamic ARP cache entry. If it is set to zero, the value is\r
+ /// implementation-specific.\r
+ ///\r
UINT32 EntryTimeOut;\r
+\r
+ ///\r
+ /// The number of retries before a MAC address is resolved. If it is\r
+ /// set to zero, the value is implementation-specific.\r
+ ///\r
UINT32 RetryCount;\r
+\r
+ ///\r
+ /// The timeout value in 100-ns units that is used to wait for the ARP\r
+ /// reply packet or the timeout value between two retries. Set to zero\r
+ /// to use implementation-specific value.\r
+ ///\r
UINT32 RetryTimeOut;\r
} EFI_ARP_CONFIG_DATA;\r
\r
\r
@retval EFI_SUCCESS The new station address was successfully registered.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ SwAddressLength is zero when ConfigData is not NULL.\r
+ StationAddress is NULL when ConfigData is not NULL.\r
@retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or\r
StationAddress is different from the one that is already\r
registered.\r
@retval EFI_SUCCESS The pending request session(s) is/are aborted and corresponding\r
event(s) is/are signaled.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ TargetSwAddress is not NULL and ResolvedEvent is NULL.\r
+ TargetSwAddress is NULL and ResolvedEvent is not NULL\r
@retval EFI_NOT_STARTED The ARP driver instance has not been configured.\r
@retval EFI_NOT_FOUND The request is not issued by\r
EFI_ARP_PROTOCOL.Request().\r
typedef struct _EFI_AUTHENTICATION_INFO_PROTOCOL EFI_AUTHENTICATION_INFO_PROTOCOL;\r
\r
typedef struct {\r
+ ///\r
+ /// Authentication Type GUID.\r
+ ///\r
EFI_GUID Guid;\r
+\r
+ ///\r
+ /// Length of this structure in bytes.\r
+ ///\r
UINT16 Length;\r
} AUTH_NODE_HEADER;\r
\r
typedef struct {\r
AUTH_NODE_HEADER Header;\r
+\r
+ ///\r
+ /// RADIUS Server IPv4 or IPv6 Address\r
+ ///\r
EFI_IPv6_ADDRESS RadiusIpAddr; ///< IPv4 or IPv6 address\r
+\r
+ ///\r
+ /// Reserved for future use\r
+ ///\r
UINT16 Reserved;\r
+\r
+ ///\r
+ /// Network Access Server IPv4 or IPv6 Address (OPTIONAL)\r
+ ///\r
EFI_IPv6_ADDRESS NasIpAddr; ///< IPv4 or IPv6 address\r
+\r
+ ///\r
+ /// Network Access Server Secret Length in bytes (OPTIONAL)\r
+ ///\r
UINT16 NasSecretLength; \r
+\r
+ ///\r
+ /// Network Access Server secret (OPTIONAL)\r
+ ///\r
UINT8 *NasSecret; \r
+\r
+ ///\r
+ /// CHAP Initiator Secret length in bytes\r
+ ///\r
UINT16 ChapSecretLength;\r
+\r
+ ///\r
+ /// CHAP Initiator Secret\r
+ ///\r
UINT8 *ChapSecret;\r
+\r
+ ///\r
+ /// CHAP Initiator Name Length in bytes\r
+ ///\r
UINT16 ChapNameLength;\r
+\r
+ ///\r
+ /// CHAP Initiator Name\r
+ ///\r
UINT8 *ChapName;\r
} CHAP_RADIUS_AUTH_NODE;\r
\r
typedef struct {\r
AUTH_NODE_HEADER Header;\r
+\r
+ ///\r
+ /// Reserved for future use\r
+ ///\r
UINT16 Reserved;\r
+\r
+ ///\r
+ /// User Secret Length in bytes\r
+ ///\r
UINT16 UserSecretLength;\r
+\r
+ ///\r
+ /// User Secret\r
+ ///\r
UINT8 *UserSecret; \r
+\r
+ ///\r
+ /// User Name Length in bytes\r
+ ///\r
UINT16 UserNameLength;\r
+\r
+ ///\r
+ /// User Name\r
+ ///\r
UINT8 *UserName;\r
+\r
+ ///\r
+ /// CHAP Initiator Secret length in bytes\r
+ ///\r
UINT16 ChapSecretLength;\r
+\r
+ ///\r
+ /// CHAP Initiator Secret\r
+ ///\r
UINT8 *ChapSecret;\r
+\r
+ ///\r
+ /// CHAP Initiator Name Length in bytes\r
+ ///\r
UINT16 ChapNameLength;\r
+\r
+ ///\r
+ /// CHAP Initiator Name\r
+ ///\r
UINT8 *ChapName;\r
} CHAP_LOCAL_AUTH_NODE;\r
\r
/// EFI_BIS_VERSION type.\r
///\r
typedef struct {\r
- UINT32 Major; ///< BIS Interface version number.\r
- UINT32 Minor; ///< Build number.\r
+ UINT32 Major; ///< the major BIS version number.\r
+ UINT32 Minor; ///< a minor BIS version number.\r
} EFI_BIS_VERSION;\r
\r
//\r
interface version desired. \r
On output, both the major and minor \r
version numbers are updated with the major and minor version\r
- numbers of the interface \r
+ numbers of the interface. This update is done whether or not the\r
+ initialization was successful. \r
@param TargetAddress Indicates a network or device address of the BIS platform to connect to. \r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_INCOMPATIBLE_VERSION The InterfaceVersion.Major requested by the \r
caller was not compatible with the interface version of the\r
+ implementation. The InterfaceVersion.Major has\r
+ been updated with the current interface version.\r
@retval EFI_UNSUPPORTED This is a local-platform implementation and \r
TargetAddress.Data was not NULL, or \r
TargetAddress.Data was any other value that was not\r
supported by the implementation. \r
@retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. \r
- @retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure.\r
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure while\r
+ initializing a cryptographic software module, or\r
+ No cryptographic software module with compatible version was\r
+ found, or A resource limitation was encountered while using a\r
+ cryptographic software module.\r
+ @retval EFI_INVALID_PARAMETER The This parameter supplied by the caller is NULL or does not\r
+ reference a valid EFI_BIS_PROTOCOL object, or\r
+ The AppHandle parameter supplied by the caller is NULL or\r
+ an invalid memory reference, or\r
+ The InterfaceVersion parameter supplied by the caller\r
+ is NULL or an invalid memory reference, or\r
+ The TargetAddress parameter supplied by the caller is\r
+ NULL or an invalid memory reference.\r
\r
**/ \r
typedef\r
\r
@param AppHandle An opaque handle that identifies the caller's instance of initialization\r
of the BIS service. \r
- @param ToFree An EFI_BIS_DATA* and associated memory block to be freed.\r
+ @param ToFree An EFI_BIS_DATA* and associated memory block to be freed. \r
+ This EFI_BIS_DATA* must have been allocated by one of the other BIS functions.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid\r
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid\r
application instance handle associated with the EFI_BIS protocol. \r
@retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. \r
- @retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure. \r
- \r
-**/ \r
+ @retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure while\r
+ returning resources associated with a cryptographic software module, or\r
+ while trying to shut down a cryptographic software module.\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_BIS_SHUTDOWN)(\r
@param AppHandle An opaque handle that identifies the caller's instance of initialization\r
of the BIS service. \r
@param Certificate The function writes an allocated EFI_BIS_DATA* containing the Boot\r
- Object Authorization Certificate object. \r
+ Object Authorization Certificate object. The caller must\r
+ eventually free the memory allocated by this function using the function Free().\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid\r
@param AppHandle An opaque handle that identifies the caller's instance of initialization\r
of the BIS service. \r
@param UpdateToken The function writes an allocated EFI_BIS_DATA* containing the new\r
- unique update token value. \r
+ unique update token value. The caller must\r
+ eventually free the memory allocated by this function using the function Free().\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid\r
@param RequestCredential This is a Signed Manifest with embedded attributes that carry the details\r
of the requested update. \r
@param NewUpdateToken The function writes an allocated EFI_BIS_DATA* containing the new \r
- unique update token value. \r
+ unique update token value. The caller must\r
+ eventually free the memory allocated by this function using the function Free().\r
\r
@retval EFI_SUCCESS The function completed successfully. \r
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid \r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid. \r
@retval EFI_SECURITY_VIOLATION The signed manifest supplied as the RequestCredential parameter \r
was invalid (could not be parsed) or Platform-specific authorization failed, etc. \r
- @retval EFI_DEVICE_ERROR An unexpected internal error occurred. \r
+ @retval EFI_DEVICE_ERROR An unexpected internal error occurred while analyzing the new\r
+ certificate's key algorithm, or while attempting to retrieve\r
+ the public key algorithm of the manifest's signer's certificate,\r
+ or An unexpected internal error occurred in a cryptographic software module. \r
\r
**/ \r
typedef\r
or the AuthorityCertificate supplied by the caller was \r
invalid (could not be parsed), \r
or Platform-specific authorization failed, etc. \r
- @retval EFI_DEVICE_ERROR An unexpected internal error occurred. \r
- \r
+ @retval EFI_DEVICE_ERROR An unexpected internal error occurred while attempting to retrieve\r
+ the public key algorithm of the manifest¡¯s signer¡¯s certificate,\r
+ or An unexpected internal error occurred in a cryptographic software module. \r
**/ \r
typedef\r
EFI_STATUS\r
/** \r
Retrieves a list of digital certificate identifier, digital signature algorithm, hash algorithm, and keylength\r
combinations that the platform supports. \r
- \r
+\r
@param AppHandle An opaque handle that identifies the caller's instance of initialization\r
of the BIS service. \r
@param SignatureInfo The function writes an allocated EFI_BIS_DATA* containing the array\r
of EFI_BIS_SIGNATURE_INFO structures representing the supported \r
- digital certificate identifier, algorithm, and key length combinations. \r
- \r
+ digital certificate identifier, algorithm, and key length combinations.\r
+ The caller must eventually free the memory allocated by this function using the function Free().\r
+\r
@retval EFI_SUCCESS The function completed successfully. \r
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid \r
application instance handle associated with the EFI_BIS protocol. \r
@retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. \r
@retval EFI_INVALID_PARAMETER The SignatureInfo parameter supplied by the caller is NULL\r
- or an invalid memory reference. \r
- @retval EFI_DEVICE_ERROR An unexpected internal error occurred. \r
- \r
+ or an invalid memory reference.\r
+ @retval EFI_DEVICE_ERROR An unexpected internal error occurred in a\r
+ cryptographic software module, or\r
+ The function encountered an unexpected internal consistency check\r
+ failure (possible corruption of stored Boot Object Authorization Certificate).\r
+\r
**/\r
typedef\r
EFI_STATUS\r
/**\r
Reset the Block Device.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Indicates a pointer to the calling context.\r
@param ExtendedVerification Driver may perform diagnostics on reset.\r
\r
@retval EFI_SUCCESS The device was reset.\r
/**\r
Read BufferSize bytes from Lba into Buffer.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Indicates a pointer to the calling context.\r
@param MediaId Id of the media, changes every time the media is replaced.\r
@param Lba The starting Logical Block Address to read from\r
@param BufferSize Size of Buffer, must be a multiple of device block size.\r
- @param Buffer Buffer containing read data\r
+ @param Buffer A pointer to the destination buffer for the data. The caller is\r
+ responsible for either having implicit or explicit ownership of the buffer.\r
\r
@retval EFI_SUCCESS The data was read correctly from the device.\r
@retval EFI_DEVICE_ERROR The device reported an error while performing the read.\r
@retval EFI_NO_MEDIA There is no media in the device.\r
@retval EFI_MEDIA_CHANGED The MediaId does not matched the current device.\r
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.\r
- @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not\r
- valid for the device.\r
+ @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, \r
+ or the buffer is not on proper alignment.\r
\r
**/\r
typedef\r
/**\r
Write BufferSize bytes from Lba into Buffer.\r
\r
- @param This Protocol instance pointer.\r
- @param MediaId Id of the media, changes every time the media is replaced.\r
- @param Lba The starting Logical Block Address to read from\r
+ @param This Indicates a pointer to the calling context.\r
+ @param MediaId The media ID that the write request is for.\r
+ @param Lba The starting logical block address to be written. The caller is\r
+ responsible for writing to only legitimate locations.\r
@param BufferSize Size of Buffer, must be a multiple of device block size.\r
- @param Buffer Buffer containing read data\r
+ @param Buffer A pointer to the source buffer for the data.\r
\r
@retval EFI_SUCCESS The data was written correctly to the device.\r
@retval EFI_WRITE_PROTECTED The device can not be written to.\r
@retval EFI_NO_MEDIA There is no media in the device.\r
@retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.\r
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.\r
- @retval EFI_INVALID_PARAMETER The write request contains a LBA that is not\r
- valid for the device.\r
+ @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, \r
+ or the buffer is not on proper alignment.\r
\r
**/\r
typedef\r
/**\r
Flush the Block Device.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Indicates a pointer to the calling context.\r
\r
@retval EFI_SUCCESS All outstanding data was written to the device\r
@retval EFI_DEVICE_ERROR The device reported an error while writting back the data\r
@param DriverImageHandle On input, a pointer to the previous driver image handle returned\r
by GetDriver(). On output, a pointer to the next driver \r
image handle. Passing in a NULL, will return the first driver \r
- image handle. \r
- \r
+ image handle.\r
+\r
@retval EFI_SUCCESS A bus specific override driver is returned in DriverImageHandle.\r
@retval EFI_NOT_FOUND The end of the list of override drivers was reached.\r
+ A bus specific override driver is not returned in DriverImageHandle.\r
@retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a\r
- previous call to GetDriver(). \r
- \r
-**/ \r
+ previous call to GetDriver().\r
+\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER)(\r
must be between 0 and NumberOfTimers-1.\r
@param TimerValue Pointer to the returned timer value.\r
@param TimerPeriod A pointer to the amount of time that passes in femtoseconds for each increment\r
- of TimerValue.\r
+ of TimerValue. If TimerValue does not increment at a predictable rate, then 0 is\r
+ returned. This parameter is optional and may be NULL.\r
\r
@retval EFI_SUCCESS The processor timer value specified by TimerIndex was returned in TimerValue.\r
@retval EFI_DEVICE_ERROR An error occurred attempting to read one of the processor's timers.\r
output it as DestinationSize. And ScratchSize is specific to the decompression\r
implementation.\r
\r
- @param This The protocol instance pointer\r
+ @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r
@param Source The source buffer containing the compressed data.\r
@param SourceSize The size, in bytes, of source buffer.\r
@param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer\r
If the compressed source data specified by Source and SourceSize is not in \r
a valid compressed data format, then EFI_INVALID_PARAMETER is returned.\r
\r
- @param This The protocol instance pointer\r
+ @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r
@param Source The source buffer containing the compressed data.\r
@param SourceSize The size of source data.\r
@param Destination On output, the destination buffer that contains\r
typedef EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_INTERFACE;\r
\r
typedef enum {\r
- IO_UINT8,\r
- IO_UINT16,\r
- IO_UINT32,\r
- IO_UINT64,\r
- MMIO_COPY_UINT8,\r
- MMIO_COPY_UINT16,\r
- MMIO_COPY_UINT32,\r
- MMIO_COPY_UINT64\r
+ IO_UINT8 = 0,\r
+ IO_UINT16 = 1,\r
+ IO_UINT32 = 2,\r
+ IO_UINT64 = 3\r
} EFI_IO_WIDTH;\r
\r
/** \r
);\r
\r
typedef enum {\r
+ ///\r
+ /// A read operation from system memory by a bus master.\r
+ ///\r
EfiBusMasterRead,\r
+\r
+ ///\r
+ /// A write operation to system memory by a bus master.\r
+ ///\r
EfiBusMasterWrite,\r
+ \r
+ ///\r
+ /// Provides both read and write access to system memory\r
+ /// by both the processor and a bus master. The buffer is\r
+ /// coherent from both the processor¡¯s and the bus master¡¯s\r
+ /// point of view.\r
+ ///\r
EfiBusMasterCommonBuffer\r
} EFI_IO_OPERATION_TYPE;\r
\r
///\r
#define HARDWARE_DEVICE_PATH 0x01\r
\r
+///\r
+/// PCI Device Path\r
+///\r
#define HW_PCI_DP 0x01\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// PCI Function Number\r
+ ///\r
UINT8 Function;\r
+ ///\r
+ /// PCI Device Number\r
+ ///\r
UINT8 Device;\r
} PCI_DEVICE_PATH;\r
\r
+///\r
+/// PCCARD Device Path\r
+///\r
#define HW_PCCARD_DP 0x02\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Function Number (0 = First Function)\r
+ ///\r
UINT8 FunctionNumber;\r
} PCCARD_DEVICE_PATH;\r
\r
+///\r
+/// Memory Mapped Device Path\r
+///\r
#define HW_MEMMAP_DP 0x03\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// EFI_MEMORY_TYPE\r
+ ///\r
UINT32 MemoryType;\r
+ ///\r
+ /// Starting Memory Address.\r
+ ///\r
EFI_PHYSICAL_ADDRESS StartingAddress;\r
+ ///\r
+ /// Ending Memory Address\r
+ ///\r
EFI_PHYSICAL_ADDRESS EndingAddress;\r
} MEMMAP_DEVICE_PATH;\r
\r
+///\r
+/// The Vendor Device Path allows the creation of vendor-defined Device Paths. A vendor must\r
+/// allocate a Vendor GUID for a Device Path. The Vendor GUID can then be used to define the\r
+/// contents on the n bytes that follow in the Vendor Device Path node.\r
+///\r
#define HW_VENDOR_DP 0x04\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Vendor-assigned GUID that defines the data that follows.\r
+ ///\r
EFI_GUID Guid;\r
+ ///\r
+ /// Vendor-defined variable size data.\r
+ ///\r
} VENDOR_DEVICE_PATH;\r
\r
+///\r
+/// Controller Device Path\r
+///\r
#define HW_CONTROLLER_DP 0x05\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Controller number.\r
+ ///\r
UINT32 ControllerNumber;\r
} CONTROLLER_DEVICE_PATH;\r
\r
///\r
#define ACPI_DEVICE_PATH 0x02\r
\r
+///\r
+/// ACPI Device Path\r
+///\r
#define ACPI_DP 0x01\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Device's PnP hardware ID stored in a numeric 32-bit\r
+ /// compressed EISA-type ID. This value must match the\r
+ /// corresponding _HID in the ACPI name space.\r
+ ///\r
UINT32 HID;\r
+ ///\r
+ /// Unique ID that is required by ACPI if two devices have the\r
+ /// same _HID. This value must also match the corresponding\r
+ /// _UID/_HID pair in the ACPI name space. Only the 32-bit\r
+ /// numeric value type of _UID is supported; thus strings must\r
+ /// not be used for the _UID in the ACPI name space.\r
+ ///\r
UINT32 UID;\r
} ACPI_HID_DEVICE_PATH;\r
\r
+///\r
+/// Expanded ACPI Device Path.\r
+///\r
#define ACPI_EXTENDED_DP 0x02\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Device's PnP hardware ID stored in a numeric 32-bit\r
+ /// compressed EISA-type ID. This value must match the\r
+ /// corresponding _HID in the ACPI name space.\r
+ ///\r
UINT32 HID;\r
+ ///\r
+ /// Unique ID that is required by ACPI if two devices have the\r
+ /// same _HID. This value must also match the corresponding\r
+ /// _UID/_HID pair in the ACPI name space.\r
+ ///\r
UINT32 UID;\r
+ ///\r
+ /// Device¡¯s compatible PnP hardware ID stored in a numeric\r
+ /// 32-bit compressed EISA-type ID. This value must match at\r
+ /// least one of the compatible device IDs returned by the\r
+ /// corresponding _CID in the ACPI name space.\r
+ ///\r
UINT32 CID;\r
///\r
/// Optional variable length _HIDSTR\r
#define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)\r
\r
\r
+///\r
+/// The _ADR device path is used to contain video output device attributes to support the Graphics\r
+/// Output Protocol. The device path can contain multiple _ADR entries if multiple video output\r
+/// devices are displaying the same output.\r
+///\r
#define ACPI_ADR_DP 0x03\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// _ADR value. For video output devices the value of this\r
+ /// field comes from Table B-2 ACPI 3.0 specification. At\r
+ /// least one _ADR value is required.\r
+ ///\r
UINT32 ADR;\r
+ ///\r
+ /// This device path may optionally contain more than one _ADR entry.\r
+ ///\r
} ACPI_ADR_DEVICE_PATH;\r
\r
#define ACPI_ADR_DISPLAY_TYPE_OTHER 0\r
\r
///\r
/// Messaging Device Paths\r
+/// This Device Path is used to describe the connection of devices outside the resource domain of the\r
+/// system. This Device Path can describe physical messaging information like SCSI ID, or abstract\r
+/// information like networking protocol IP addresses.\r
///\r
#define MESSAGING_DEVICE_PATH 0x03\r
\r
+///\r
+/// ATAPI Device Path\r
+///\r
#define MSG_ATAPI_DP 0x01\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Set to zero for primary or one for secondary\r
+ ///\r
UINT8 PrimarySecondary;\r
+ ///\r
+ /// Set to zero for master or one for slave mode\r
+ ///\r
UINT8 SlaveMaster;\r
+ ///\r
+ /// Logical Unit Number\r
+ ///\r
UINT16 Lun;\r
} ATAPI_DEVICE_PATH;\r
\r
+///\r
+/// SCSI Device Path\r
+///\r
#define MSG_SCSI_DP 0x02\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Target ID on the SCSI bus (PUN)\r
+ ///\r
UINT16 Pun;\r
+ ///\r
+ /// Logical Unit Number (LUN)\r
+ ///\r
UINT16 Lun;\r
} SCSI_DEVICE_PATH;\r
\r
+///\r
+/// Fibre Channel\r
+///\r
#define MSG_FIBRECHANNEL_DP 0x03\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Reserved for the future.\r
+ ///\r
UINT32 Reserved;\r
+ ///\r
+ /// Fibre Channel World Wide Number.\r
+ ///\r
UINT64 WWN;\r
+ ///\r
+ /// Fibre Channel Logical Unit Number.\r
+ ///\r
UINT64 Lun;\r
} FIBRECHANNEL_DEVICE_PATH;\r
\r
+///\r
+/// 1394 Device Path\r
+///\r
#define MSG_1394_DP 0x04\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Reserved for the future.\r
+ ///\r
UINT32 Reserved;\r
+ ///\r
+ /// 1394 Global Unique ID (GUID).\r
+ ///\r
UINT64 Guid;\r
} F1394_DEVICE_PATH;\r
\r
+///\r
+/// USB Device Path\r
+///\r
#define MSG_USB_DP 0x05\r
typedef struct {\r
- EFI_DEVICE_PATH_PROTOCOL Header;\r
- UINT8 ParentPortNumber;\r
- UINT8 InterfaceNumber;\r
+ EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// USB Parent Port Number\r
+ ///\r
+ UINT8 ParentPortNumber;\r
+ ///\r
+ /// USB Interface Number\r
+ ///\r
+ UINT8 InterfaceNumber;\r
} USB_DEVICE_PATH;\r
\r
+///\r
+/// USB Class Device Path\r
+///\r
#define MSG_USB_CLASS_DP 0x0f\r
typedef struct {\r
- EFI_DEVICE_PATH_PROTOCOL Header;\r
- UINT16 VendorId;\r
- UINT16 ProductId;\r
- UINT8 DeviceClass;\r
- UINT8 DeviceSubClass;\r
- UINT8 DeviceProtocol;\r
+ EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Vendor ID assigned by USB-IF. A value of 0xFFFF will\r
+ /// match any Vendor ID.\r
+ ///\r
+ UINT16 VendorId;\r
+ ///\r
+ /// Product ID assigned by USB-IF. A value of 0xFFFF will\r
+ /// match any Product ID.\r
+ ///\r
+ UINT16 ProductId;\r
+ ///\r
+ /// The class code assigned by the USB-IF. A value of 0xFF\r
+ /// will match any class code.\r
+ ///\r
+ UINT8 DeviceClass;\r
+ ///\r
+ /// The subclass code assigned by the USB-IF. A value of\r
+ /// 0xFF will match any subclass code.\r
+ ///\r
+ UINT8 DeviceSubClass;\r
+ ///\r
+ /// The protocol code assigned by the USB-IF. A value of\r
+ /// 0xFF will match any protocol code.\r
+ ///\r
+ UINT8 DeviceProtocol;\r
} USB_CLASS_DEVICE_PATH;\r
\r
+///\r
+/// This device path describes a USB device using its serial number.\r
+/// USB WWID Device Path\r
+///\r
#define MSG_USB_WWID_DP 0x10\r
typedef struct {\r
- EFI_DEVICE_PATH_PROTOCOL Header;\r
- UINT16 InterfaceNumber;\r
- UINT16 VendorId;\r
- UINT16 ProductId;\r
- // CHAR16 SerialNumber[...];\r
+ EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// USB interface number\r
+ ///\r
+ UINT16 InterfaceNumber;\r
+ ///\r
+ /// USB vendor id of the device\r
+ ///\r
+ UINT16 VendorId;\r
+ ///\r
+ /// USB product id of the device\r
+ ///\r
+ UINT16 ProductId;\r
+ ///\r
+ /// Last 64-or-fewer UTF-16 characters of the USB\r
+ /// serial number. The length of the string is\r
+ /// determined by the Length field less the offset of the\r
+ /// Serial Number field (10)\r
+ ///\r
+ /// CHAR16 SerialNumber[...];\r
} USB_WWID_DEVICE_PATH;\r
\r
-\r
+///\r
+/// Device Logical Unit\r
+///\r
#define MSG_DEVICE_LOGICAL_UNIT_DP 0x11\r
typedef struct {\r
- EFI_DEVICE_PATH_PROTOCOL Header;\r
- UINT8 Lun;\r
+ EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Logical Unit Number for the interface\r
+ ///\r
+ UINT8 Lun;\r
} DEVICE_LOGICAL_UNIT_DEVICE_PATH;\r
\r
+///\r
+/// SATA Device Path\r
+///\r
#define MSG_SATA_DP 0x12\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// The HBA port number that facilitates the connection to the\r
+ /// device or a port multiplier. The value 0xFFFF is reserved.\r
+ ///\r
UINT16 HBAPortNumber;\r
+ ///\r
+ /// The Port multiplier port number that facilitates the connection\r
+ /// to the device. Bit 15 should be set if the device is directly\r
+ /// connected to the HBA.\r
+ ///\r
UINT16 PortMultiplierPortNumber;\r
+ ///\r
+ /// Logical Unit Number.\r
+ ///\r
UINT16 Lun;\r
} SATA_DEVICE_PATH;\r
\r
+///\r
+/// I2O Device Path \r
+///\r
#define MSG_I2O_DP 0x06\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Target ID (TID) for a device\r
+ ///\r
UINT32 Tid;\r
} I2O_DEVICE_PATH;\r
\r
+///\r
+/// MAC Address Device Path\r
+///\r
#define MSG_MAC_ADDR_DP 0x0b\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// The MAC address for a network interface padded with 0s\r
+ ///\r
EFI_MAC_ADDRESS MacAddress;\r
+ ///\r
+ /// Network interface type(i.e. 802.3, FDDI).\r
+ ///\r
UINT8 IfType;\r
} MAC_ADDR_DEVICE_PATH;\r
\r
+///\r
+/// IPv4 Device Path\r
+///\r
#define MSG_IPv4_DP 0x0c\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// The local IPv4 address\r
+ ///\r
EFI_IPv4_ADDRESS LocalIpAddress;\r
+ ///\r
+ /// The remote IPv4 address\r
+ ///\r
EFI_IPv4_ADDRESS RemoteIpAddress;\r
+ ///\r
+ /// The local port number\r
+ ///\r
UINT16 LocalPort;\r
+ ///\r
+ /// The remote port number\r
+ ///\r
UINT16 RemotePort;\r
+ ///\r
+ /// The network protocol(i.e. UDP, TCP).\r
+ ///\r
UINT16 Protocol;\r
+ ///\r
+ /// 0x00 - The Source IP Address was assigned though DHCP\r
+ /// 0x01 - The Source IP Address is statically bound\r
+ ///\r
BOOLEAN StaticIpAddress;\r
} IPv4_DEVICE_PATH;\r
\r
+///\r
+/// IPv6 Device Path\r
+///\r
#define MSG_IPv6_DP 0x0d\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// The local IPv6 address\r
+ ///\r
EFI_IPv6_ADDRESS LocalIpAddress;\r
+ ///\r
+ /// The remote IPv6 address\r
+ ///\r
EFI_IPv6_ADDRESS RemoteIpAddress;\r
+ ///\r
+ /// The local port number\r
+ ///\r
UINT16 LocalPort;\r
+ ///\r
+ /// The remote port number\r
+ ///\r
UINT16 RemotePort;\r
+ ///\r
+ /// The network protocol(i.e. UDP, TCP).\r
+ ///\r
UINT16 Protocol;\r
+ ///\r
+ /// 0x00 - The Source IP Address was assigned though DHCP\r
+ /// 0x01 - The Source IP Address is statically bound\r
+ ///\r
BOOLEAN StaticIpAddress;\r
} IPv6_DEVICE_PATH;\r
\r
+///\r
+/// InfiniBand Device Path\r
+///\r
#define MSG_INFINIBAND_DP 0x09\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Flags to help identify/manage InfiniBand device path elements:\r
+ /// Bit 0 ¨C IOC/Service (0b = IOC, 1b = Service)\r
+ /// Bit 1 ¨C Extend Boot Environment\r
+ /// Bit 2 ¨C Console Protocol\r
+ /// Bit 3 ¨C Storage Protocol\r
+ /// Bit 4 ¨C Network Protocol\r
+ /// All other bits are reserved.\r
+ ///\r
UINT32 ResourceFlags;\r
+ ///\r
+ /// 128-bit Global Identifier for remote fabric port\r
+ ///\r
UINT8 PortGid[16];\r
+ ///\r
+ /// 64-bit unique identifier to remote IOC or server process.\r
+ /// Interpretation of field specified by Resource Flags (bit 0)\r
+ ///\r
UINT64 ServiceId;\r
+ ///\r
+ /// 64-bit persistent ID of remote IOC port\r
+ ///\r
UINT64 TargetPortId;\r
+ ///\r
+ /// 64-bit persistent ID of remote device\r
+ ///\r
UINT64 DeviceId;\r
} INFINIBAND_DEVICE_PATH;\r
\r
#define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08\r
#define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10\r
\r
+///\r
+/// UART Device Path\r
+///\r
#define MSG_UART_DP 0x0e\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Reserved\r
+ ///\r
UINT32 Reserved;\r
+ ///\r
+ /// The baud rate setting for the UART style device. A value of 0\r
+ /// means that the device's default baud rate will be used.\r
+ ///\r
UINT64 BaudRate;\r
+ ///\r
+ /// The number of data bits for the UART style device. A value\r
+ /// of 0 means that the device's default number of data bits will be used.\r
+ ///\r
UINT8 DataBits;\r
+ ///\r
+ /// The parity setting for the UART style device.\r
+ /// Parity 0x00 - Default Parity\r
+ /// Parity 0x01 - No Parity\r
+ /// Parity 0x02 - Even Parity\r
+ /// Parity 0x03 - Odd Parity\r
+ /// Parity 0x04 - Mark Parity\r
+ /// Parity 0x05 - Space Parity\r
+ ///\r
UINT8 Parity;\r
+ ///\r
+ /// The number of stop bits for the UART style device.\r
+ /// Stop Bits 0x00 - Default Stop Bits\r
+ /// Stop Bits 0x01 - 1 Stop Bit\r
+ /// Stop Bits 0x02 - 1.5 Stop Bits\r
+ /// Stop Bits 0x03 - 2 Stop Bits\r
+ ///\r
UINT8 StopBits;\r
} UART_DEVICE_PATH;\r
\r
#define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID\r
#define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID\r
\r
+///\r
+/// A new device path node is defined to declare flow control characteristics.\r
+/// UART Flow Control Messaging Device Path\r
+///\r
#define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID\r
-\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL\r
+ ///\r
EFI_GUID Guid;\r
+ ///\r
+ /// Bitmap of supported flow control types.\r
+ /// Bit 0 set indicates hardware flow control.\r
+ /// Bit 1 set indicates Xon/Xoff flow control.\r
+ /// All other bits are reserved and are clear.\r
+ ///\r
UINT32 FlowControlMap;\r
} UART_FLOW_CONTROL_DEVICE_PATH;\r
\r
+///\r
+/// Serial Attached SCSI (SAS) devices.\r
+///\r
#define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID\r
-\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// DEVICE_PATH_MESSAGING_SAS\r
+ ///\r
EFI_GUID Guid;\r
+ ///\r
+ /// Reserved for future use.\r
+ ///\r
UINT32 Reserved;\r
+ ///\r
+ /// SAS Address for Serial Attached SCSI Target.\r
+ ///\r
UINT64 SasAddress;\r
+ ///\r
+ /// SAS Logical Unit Number.\r
+ ///\r
UINT64 Lun;\r
+ ///\r
+ /// More Information about the device and its interconnect\r
+ ///\r
UINT16 DeviceTopology;\r
+ ///\r
+ /// Relative Target Port (RTP)\r
+ ///\r
UINT16 RelativeTargetPort;\r
} SAS_DEVICE_PATH;\r
\r
+///\r
+/// iSCSI Device Path Node (Base Information)\r
+///\r
#define MSG_ISCSI_DP 0x13\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Network Protocol (0 = TCP, 1+ = reserved)\r
+ ///\r
UINT16 NetworkProtocol;\r
+ ///\r
+ /// iSCSI Login Options\r
+ ///\r
UINT16 LoginOption;\r
+ ///\r
+ /// iSCSI Logical Unit Number\r
+ ///\r
UINT64 Lun;\r
+ ///\r
+ /// iSCSI Target Portal group tag the initiator intends\r
+ /// to establish a session with.\r
+ ///\r
UINT16 TargetPortalGroupTag;\r
- // CHAR8 iSCSI Target Name\r
+ ///\r
+ /// iSCSI NodeTarget Name. The length of the name\r
+ /// is determined by subtracting the offset of this field from Length.\r
+ ///\r
+ /// CHAR8 iSCSI Target Name\r
} ISCSI_DEVICE_PATH;\r
\r
#define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000\r
//\r
#define MEDIA_DEVICE_PATH 0x04\r
\r
+///\r
+/// The Hard Drive Media Device Path is used to represent a partition on a hard drive.\r
+/// Hard Drive Media Device Path\r
+///\r
#define MEDIA_HARDDRIVE_DP 0x01\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Describes the entry in a partition table, starting with entry 1.\r
+ /// Partition number zero represents the entire device. Valid\r
+ /// partition numbers for a MBR partition are [1, 4]. Valid\r
+ /// partition numbers for a GPT partition are [1,\r
+ /// NumberOfPartitionEntries].\r
+ ///\r
UINT32 PartitionNumber;\r
+ ///\r
+ /// Starting LBA of the partition on the hard drive\r
+ ///\r
UINT64 PartitionStart;\r
+ ///\r
+ /// Size of the partition in units of Logical Blocks\r
+ ///\r
UINT64 PartitionSize;\r
+ ///\r
+ /// Signature unique to this partition\r
+ ///\r
UINT8 Signature[16];\r
+ ///\r
+ /// Partition Format: (Unused values reserved)\r
+ /// 0x01 ¨C PC-AT compatible legacy MBR\r
+ /// 0x02 ¨C GUID Partition Table\r
+ ///\r
UINT8 MBRType;\r
+ ///\r
+ /// Type of Disk Signature: (Unused values reserved)\r
+ /// 0x00 ¨C No Disk Signature.\r
+ /// 0x01 ¨C 32-bit signature from address 0x1b8 of the type 0x01 MBR.\r
+ /// 0x02 ¨C GUID signature.\r
+ ///\r
UINT8 SignatureType;\r
} HARDDRIVE_DEVICE_PATH;\r
\r
#define MBR_TYPE_PCAT 0x01\r
#define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02\r
\r
+#define NO_DISK_SIGNATURE 0x00\r
#define SIGNATURE_TYPE_MBR 0x01\r
#define SIGNATURE_TYPE_GUID 0x02\r
\r
+///\r
+/// The CD-ROM Media Device Path is used to define a system partition that exists on a CD-ROM.\r
+/// CD-ROM Media Device Path\r
+///\r
#define MEDIA_CDROM_DP 0x02\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Boot Entry number from the Boot Catalog. The Initial/Default entry is defined as zero.\r
+ ///\r
UINT32 BootEntry;\r
+ ///\r
+ /// Starting RBA of the partition on the medium. CD-ROMs use Relative logical Block Addressing.\r
+ ///\r
UINT64 PartitionStart;\r
+ ///\r
+ /// Size of the partition in units of Blocks, also called Sectors.\r
+ ///\r
UINT64 PartitionSize;\r
} CDROM_DEVICE_PATH;\r
\r
-//\r
-// Use VENDOR_DEVICE_PATH struct\r
-//\r
+///\r
+/// Use VENDOR_DEVICE_PATH struct\r
+///\r
#define MEDIA_VENDOR_DP 0x03\r
\r
+///\r
+/// File Path Media Device Path\r
+///\r
#define MEDIA_FILEPATH_DP 0x04\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// A NULL-terminated Unicode Path string including directory and file names.\r
+ ///\r
CHAR16 PathName[1];\r
} FILEPATH_DEVICE_PATH;\r
\r
#define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)\r
\r
+///\r
+/// The Media Protocol Device Path is used to denote the protocol that is being \r
+/// used in a device path at the location of the path specified. \r
+/// Many protocols are inherent to the style of device path.\r
+///\r
#define MEDIA_PROTOCOL_DP 0x05\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// The ID of the protocol.\r
+ ///\r
EFI_GUID Protocol;\r
} MEDIA_PROTOCOL_DEVICE_PATH;\r
\r
-\r
+///\r
+/// This type is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware volume.\r
+/// PIWG Firmware Volume Device Path.\r
+///\r
#define MEDIA_PIWG_FW_VOL_DP 0x7\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Firmware volume name.\r
+ ///\r
EFI_GUID FvName;\r
} MEDIA_FW_VOL_DEVICE_PATH;\r
\r
-\r
+///\r
+/// This type is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware file.\r
+/// PIWG Firmware Volume Device Path\r
+///\r
#define MEDIA_PIWG_FW_FILE_DP 0x6\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Firmware file name\r
+ ///\r
EFI_GUID FvFileName;\r
} MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;\r
\r
-//\r
-// BBS Device Path\r
-//\r
+///\r
+/// This Device Path is used to describe the booting of non-EFI-aware operating systems.\r
+/// BIOS Boot Specification Device Path\r
+///\r
#define BBS_DEVICE_PATH 0x05\r
#define BBS_BBS_DP 0x01\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
+ ///\r
+ /// Device Type as defined by the BIOS Boot Specification.\r
+ ///\r
UINT16 DeviceType;\r
+ ///\r
+ /// Status Flags as defined by the BIOS Boot Specification\r
+ ///\r
UINT16 StatusFlag;\r
+ ///\r
+ /// ASCIIZ string that describes the boot device to a user. \r
+ ///\r
CHAR8 String[1];\r
} BBS_BBS_DEVICE_PATH;\r
\r
\r
@param DevicePath Points to the start of the EFI device path.\r
\r
- @retval Size Size of the specified device path, in bytes, including the end-of-path tag.\r
+ @return Size Size of the specified device path, in bytes, including the end-of-path tag.\r
+ @retval 0 DevicePath is NULL \r
\r
**/\r
typedef\r
@param DevicePath Points to the source EFI device path.\r
\r
@retval Pointer A pointer to the duplicate device path.\r
- @retval NULL insufficient memory\r
+ @retval NULL insufficient memory or DevicePath is NULL\r
\r
**/\r
typedef\r
\r
/**\r
Create a new path by appending the second device path to the first.\r
+ If Src1 is NULL and Src2 is non-NULL, then a duplicate of Src2 is returned. \r
+ If Src1 is non-NULL and Src2 is NULL, then a duplicate of Src1 is returned.\r
+ If Src1 and Src2 are both NULL, then a copy of an end-of-device-path is returned.\r
\r
- @param Src1 Points to the first device path. If NULL, then it is ignored.\r
- @param Src2 Points to the second device path. If NULL, then it is ignored.\r
+ @param Src1 Points to the first device path.\r
+ @param Src2 Points to the second device path.\r
\r
@retval Pointer A pointer to the newly created device path.\r
@retval NULL Memory could not be allocated\r
- or either DevicePath or DeviceNode is NULL.\r
\r
**/\r
typedef\r
\r
/**\r
Creates a new path by appending the device node to the device path.\r
+ If DeviceNode is NULL then a copy of DevicePath is returned. \r
+ If DevicePath is NULL then a copy of DeviceNode, followed by an end-of-device path device node is returned.\r
+ If both DeviceNode and DevicePath are NULL then a copy of an end-of-device-path device node is returned.\r
\r
@param DevicePath Points to the device path.\r
@param DeviceNode Points to the device node.\r
\r
@retval Pointer A pointer to the allocated device node.\r
- @retval NULL Memory could not be allocated\r
- or either DevicePath or DeviceNode is NULL.\r
+ @retval NULL There was insufficient memory.\r
\r
**/\r
typedef\r
device path instance or NULL if there are no more device\r
path instances in the device path. \r
@param DevicePathInstanceSize On output, this holds the size of the device path instance,\r
- in bytes or zero, if DevicePathInstance is zero.\r
+ in bytes or zero, if DevicePathInstance is NULL.\r
+ If NULL, then the instance size is not output.\r
\r
@retval Pointer A pointer to the copy of the current device path instance.\r
@retval NULL DevicePathInstace was NULL on entry or there was insufficient memory.\r
/** @file\r
- The file provides the protocol to retrieve configuration\r
- information for a device that a UEFI driver is about to start.\r
+ UEFI Platform to Driver Configuration Protocol is defined in UEFI specification.\r
+ \r
+ This is a protocol that is optionally produced by the platform and optionally consumed \r
+ by a UEFI Driver in its Start() function. This protocol allows the driver to receive \r
+ configuration information as part of being started.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
}\r
\r
//\r
-// Revision Number\r
+// UEFI Revision Number Definition\r
//\r
#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000\r
+\r
+//\r
+// EFI 1.1 Revision Number defintion\r
+//\r
#define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION \\r
EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION\r
\r
The ResetSystem () UEFI 2.0 service is added to the EFI system table and the \r
EFI_RESET_ARCH_PROTOCOL_GUID protocol is registered with a NULL pointer.\r
\r
- No CRC of the EFI system table is required, as it is done in the DXE core.\r
-\r
Copyright (c) 2006 - 2008, 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
/** @file\r
Runtime Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
\r
- This code is used to produce the UEFI 2.0 runtime virtual switch over\r
-\r
- This driver must add SetVirtualAddressMap () and ConvertPointer () to\r
- the EFI system table. This driver is not responcible for CRCing the \r
- EFI system table.\r
-\r
- This driver will add EFI_RUNTIME_ARCH_PROTOCOL_GUID protocol with a \r
- pointer to the Runtime Arch Protocol instance structure. The protocol\r
- member functions are used by the DXE core to export information need\r
- by this driver to produce the runtime transition to virtual mode\r
- calling.\r
+ Allows the runtime functionality of the DXE Foundation to be contained \r
+ in a separate driver. It also provides hooks for the DXE Foundation to \r
+ export information that is needed at runtime. As such, this protocol allows \r
+ services to the DXE Foundation to manage runtime drivers and events. \r
+ This protocol also implies that the runtime services required to transition \r
+ to virtual mode, SetVirtualAddressMap() and ConvertPointer(), have been \r
+ registered into the UEFI Runtime Table in the UEFI System Table. This protocol \r
+ must be produced by a runtime DXE driver and may only be consumed by the DXE Foundation.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
\r
typedef struct _EFI_RUNTIME_IMAGE_ENTRY EFI_RUNTIME_IMAGE_ENTRY;\r
\r
+///\r
+/// EFI_RUNTIME_IMAGE_ENTRY\r
+///\r
struct _EFI_RUNTIME_IMAGE_ENTRY {\r
+ ///\r
+ /// Start of image that has been loaded in memory. It is a pointer \r
+ /// to either the DOS header or PE header of the image.\r
+ ///\r
VOID *ImageBase;\r
+ ///\r
+ /// Size in bytes of the image represented by ImageBase.\r
+ ///\r
UINT64 ImageSize;\r
+ ///\r
+ /// Information about the fix-ups that were performed on ImageBase when it was\r
+ /// loaded into memory.\r
+ ///\r
VOID *RelocationData;\r
+ ///\r
+ /// The ImageHandle passed into ImageBase when it was loaded.\r
+ ///\r
EFI_HANDLE Handle;\r
+ ///\r
+ /// Entry for this node in the EFI_RUNTIME_ARCHITECTURE_PROTOCOL.ImageHead list.\r
+ ///\r
EFI_LIST_ENTRY Link;\r
};\r
\r
typedef struct _EFI_RUNTIME_EVENT_ENTRY EFI_RUNTIME_EVENT_ENTRY;\r
\r
+///\r
+/// EFI_RUNTIME_EVENT_ENTRY\r
+///\r
struct _EFI_RUNTIME_EVENT_ENTRY {\r
+ ///\r
+ /// The same as Type passed into CreateEvent().\r
+ ///\r
UINT32 Type;\r
+ ///\r
+ /// The same as NotifyTpl passed into CreateEvent().\r
+ ///\r
EFI_TPL NotifyTpl;\r
+ ///\r
+ /// The same as NotifyFunction passed into CreateEvent().\r
+ ///\r
EFI_EVENT_NOTIFY NotifyFunction;\r
+ ///\r
+ /// The same as NotifyContext passed into CreateEvent().\r
+ ///\r
VOID *NotifyContext;\r
+ ///\r
+ /// The EFI_EVENT returned by CreateEvent(). Event must be in runtime memory.\r
+ ///\r
EFI_EVENT *Event;\r
+ ///\r
+ /// Entry for this node in the\r
+ /// EFI_RUNTIME_ARCHITECTURE_PROTOCOL.EventHead list.\r
+ ///\r
EFI_LIST_ENTRY Link;\r
};\r
\r
typedef \r
EFI_STATUS\r
(EFIAPI *EFI_SECURITY_FILE_AUTHENTICATION_STATE)(\r
- IN EFI_SECURITY_ARCH_PROTOCOL *This,\r
- IN UINT32 AuthenticationStatus,\r
- IN EFI_DEVICE_PATH_PROTOCOL *File\r
+ IN CONST EFI_SECURITY_ARCH_PROTOCOL *This,\r
+ IN UINT32 AuthenticationStatus,\r
+ IN CONST EFI_DEVICE_PATH_PROTOCOL *File\r
);\r
\r
///\r
-/** @file\r
+/** @file \r
+ UEFI Service Binding Protocol is defined in UEFI specification.\r
\r
The file defines the generic Service Binding Protocol functions.\r
It provides services that are required to create and destroy child \r
typedef struct _EFI_SERVICE_BINDING_PROTOCOL EFI_SERVICE_BINDING_PROTOCOL;\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is not NULL, then the\r
- I/O services are added to the existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
the child\r
);\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
- I/O services are being used.\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
@retval other The child handle was not destroyed\r
\r
**/\r
projects / mirror_edk2.git / commitdiff