\r
#include <Guid/PcAnsi.h>\r
\r
-//\r
-// Device Path protocol\r
-//\r
+///\r
+/// Device Path protocol\r
+///\r
#define EFI_DEVICE_PATH_PROTOCOL_GUID \\r
{ \\r
0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
// Protocol GUID defined in EFI1.1.\r
// \r
\r
-//\r
-// Device Path information\r
-//\r
+///\r
+/// Device Path information\r
+///\r
#define DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID\r
\r
#pragma pack(1)\r
\r
+/**\r
+ This protocol can be used on any device handle to obtain generic path/location \r
+ information concerning the physical device or logical device. If the handle does \r
+ not logically map to a physical device, the handle may not necessarily support \r
+ the device path protocol. The device path describes the location of the device \r
+ the handle is for. The size of the Device Path can be determined from the structures \r
+ that make up the Device Path.\r
+**/\r
typedef struct {\r
- UINT8 Type;\r
- UINT8 SubType;\r
- UINT8 Length[2];\r
+ UINT8 Type; ///< 0x01 Hardware Device Path\r
+ ///< 0x02 ACPI Device Path\r
+ ///< 0x03 Messaging Device Path\r
+ ///< 0x04 Media Device Path\r
+ ///< 0x05 BIOS Boot Specification Device Path\r
+ ///< 0x7F End of Hardware Device Path\r
+ \r
+ UINT8 SubType; ///< Varies by Type\r
+ ///< 0xFF End Entire Device Path, or\r
+ ///< 0x01 End This Instance of a Device Path and start a new\r
+ ///< Device Path\r
+ \r
+ UINT8 Length[2]; ///< Specific Device Path data. Type and Sub-Type define\r
+ ///< type of data. Size of data is included in Length.\r
+ \r
} EFI_DEVICE_PATH_PROTOCOL;\r
\r
-//\r
-// For backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// For backward-compatible with EFI1.1.\r
+/// \r
typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH;\r
\r
-//\r
-// Hardware Device Paths\r
-//\r
+///\r
+/// Hardware Device Paths\r
+///\r
#define HARDWARE_DEVICE_PATH 0x01\r
\r
+///\r
+/// PCI Device Path SubType\r
+///\r
#define HW_PCI_DP 0x01\r
+\r
+///\r
+/// PCI Device Path\r
+///\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 SubType\r
+///\r
#define HW_PCCARD_DP 0x02\r
+\r
+///\r
+/// PCCARD Device Path\r
+///\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
-// ACPI Device Paths\r
-//\r
+///\r
+/// ACPI Device Paths\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
- // Optional variable length _UIDSTR\r
- //\r
+ ///\r
+ /// Optional variable length _HIDSTR\r
+ /// Optional variable length _UIDSTR\r
+ /// Optional variable length _CIDSTR\r
+ ///\r
} ACPI_EXTENDED_HID_DEVICE_PATH;\r
\r
//\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
(((_Port) & 0xf) << 4) | \\r
((_Index) & 0xf) ))\r
\r
-//\r
-// Messaging Device Paths\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 - IOC/Service (0b = IOC, 1b = Service)\r
+ /// Bit 1 - Extend Boot Environment\r
+ /// Bit 2 - Console Protocol\r
+ /// Bit 3 - Storage Protocol\r
+ /// Bit 4 - 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 - PC-AT compatible legacy MBR\r
+ /// 0x02 - GUID Partition Table\r
+ ///\r
UINT8 MBRType;\r
+ ///\r
+ /// Type of Disk Signature: (Unused values reserved)\r
+ /// 0x00 - No Disk Signature.\r
+ /// 0x01 - 32-bit signature from address 0x1b8 of the type 0x01 MBR.\r
+ /// 0x02 - 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
#define BBS_TYPE_UNKNOWN 0xFF\r
\r
\r
-//\r
-// Union of all possible Device Paths and pointers to Device Paths\r
-//\r
+///\r
+/// Union of all possible Device Paths and pointers to Device Paths\r
+///\r
\r
typedef union {\r
EFI_DEVICE_PATH_PROTOCOL DevPath;\r
\r
#pragma pack()\r
\r
-#define EFI_DP_TYPE_MASK 0x7F\r
-#define EFI_DP_TYPE_UNPACKED 0x80\r
#define END_DEVICE_PATH_TYPE 0x7f\r
- \r
-#define EFI_END_ENTIRE_DEVICE_PATH 0xff\r
-#define EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff\r
-#define EFI_END_INSTANCE_DEVICE_PATH 0x01\r
-#define END_ENTIRE_DEVICE_PATH_SUBTYPE EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE\r
-#define END_INSTANCE_DEVICE_PATH_SUBTYPE EFI_END_INSTANCE_DEVICE_PATH\r
- \r
-#define EFI_END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))\r
-#define END_DEVICE_PATH_LENGTH EFI_END_DEVICE_PATH_LENGTH\r
- \r
-#define DP_IS_END_TYPE(a) \r
-#define DP_IS_END_SUBTYPE(a) (((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE)\r
-#define DevicePathSubType(a) ((a)->SubType)\r
-#define IsDevicePathUnpacked(a) ((a)->Type & EFI_DP_TYPE_UNPACKED)\r
- \r
-#define EfiDevicePathNodeLength(a) (((a)->Length[0]) | ((a)->Length[1] << 8))\r
-#define DevicePathNodeLength(a) (EfiDevicePathNodeLength(a))\r
-#define EfiNextDevicePathNode(a) ((EFI_DEVICE_PATH_PROTOCOL *) (((UINT8 *) (a)) + EfiDevicePathNodeLength (a)))\r
-#define NextDevicePathNode(a) (EfiNextDevicePathNode(a)) \r
- \r
-#define EfiDevicePathType(a) (((a)->Type) & EFI_DP_TYPE_MASK)\r
-#define DevicePathType(a) (EfiDevicePathType(a))\r
-#define EfiIsDevicePathEndType(a) (EfiDevicePathType (a) == END_DEVICE_PATH_TYPE)\r
-#define IsDevicePathEndType(a) (EfiIsDevicePathEndType(a)) \r
- \r
- \r
-#define EfiIsDevicePathEndSubType(a) ((a)->SubType == EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE)\r
-#define IsDevicePathEndSubType(a) (EfiIsDevicePathEndSubType(a))\r
-#define EfiIsDevicePathEndInstanceSubType(a) ((a)->SubType == EFI_END_INSTANCE_DEVICE_PATH)\r
- \r
-#define EfiIsDevicePathEnd(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndSubType (a))\r
-#define IsDevicePathEnd(a) (EfiIsDevicePathEnd(a))\r
-#define EfiIsDevicePathEndInstance(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndInstanceSubType (a))\r
-\r
-\r
-#define SetDevicePathNodeLength(a,l) { \\r
- (a)->Length[0] = (UINT8) (l); \\r
- (a)->Length[1] = (UINT8) ((l) >> 8); \\r
- }\r
-\r
-#define SetDevicePathEndNode(a) { \\r
- (a)->Type = END_DEVICE_PATH_TYPE; \\r
- (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \\r
- (a)->Length[0] = sizeof(EFI_DEVICE_PATH_PROTOCOL); \\r
- (a)->Length[1] = 0; \\r
- }\r
+#define END_ENTIRE_DEVICE_PATH_SUBTYPE 0xFF\r
+#define END_INSTANCE_DEVICE_PATH_SUBTYPE 0x01\r
\r
extern EFI_GUID gEfiDevicePathProtocolGuid;\r
\r
projects / mirror_edk2.git / blobdiff