2 The device path protocol as defined in UEFI 2.0.
4 The device path represents a programmatic path to a device,
5 from a software point of view. The path must persist from boot to boot, so
6 it can not contain things like PCI bus numbers that change from boot to boot.
8 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials are licensed and made available under
10 the terms and conditions of the BSD License that accompanies this distribution.
11 The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php.
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #ifndef __EFI_DEVICE_PATH_PROTOCOL_H__
20 #define __EFI_DEVICE_PATH_PROTOCOL_H__
22 #include <Guid/PcAnsi.h>
23 #include <IndustryStandard/Bluetooth.h>
25 /// Device Path protocol.
27 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
29 0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
33 /// Device Path guid definition for backward-compatible with EFI1.1.
35 #define DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID
40 This protocol can be used on any device handle to obtain generic path/location
41 information concerning the physical device or logical device. If the handle does
42 not logically map to a physical device, the handle may not necessarily support
43 the device path protocol. The device path describes the location of the device
44 the handle is for. The size of the Device Path can be determined from the structures
45 that make up the Device Path.
48 UINT8 Type
; ///< 0x01 Hardware Device Path.
49 ///< 0x02 ACPI Device Path.
50 ///< 0x03 Messaging Device Path.
51 ///< 0x04 Media Device Path.
52 ///< 0x05 BIOS Boot Specification Device Path.
53 ///< 0x7F End of Hardware Device Path.
55 UINT8 SubType
; ///< Varies by Type
56 ///< 0xFF End Entire Device Path, or
57 ///< 0x01 End This Instance of a Device Path and start a new
60 UINT8 Length
[2]; ///< Specific Device Path data. Type and Sub-Type define
61 ///< type of data. Size of data is included in Length.
63 } EFI_DEVICE_PATH_PROTOCOL
;
66 /// Device Path protocol definition for backward-compatible with EFI1.1.
68 typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH
;
71 /// Hardware Device Paths.
73 #define HARDWARE_DEVICE_PATH 0x01
76 /// PCI Device Path SubType.
78 #define HW_PCI_DP 0x01
84 EFI_DEVICE_PATH_PROTOCOL Header
;
86 /// PCI Function Number.
90 /// PCI Device Number.
96 /// PCCARD Device Path SubType.
98 #define HW_PCCARD_DP 0x02
101 /// PCCARD Device Path.
104 EFI_DEVICE_PATH_PROTOCOL Header
;
106 /// Function Number (0 = First Function).
108 UINT8 FunctionNumber
;
109 } PCCARD_DEVICE_PATH
;
112 /// Memory Mapped Device Path SubType.
114 #define HW_MEMMAP_DP 0x03
117 /// Memory Mapped Device Path.
120 EFI_DEVICE_PATH_PROTOCOL Header
;
126 /// Starting Memory Address.
128 EFI_PHYSICAL_ADDRESS StartingAddress
;
130 /// Ending Memory Address.
132 EFI_PHYSICAL_ADDRESS EndingAddress
;
133 } MEMMAP_DEVICE_PATH
;
136 /// Hardware Vendor Device Path SubType.
138 #define HW_VENDOR_DP 0x04
141 /// The Vendor Device Path allows the creation of vendor-defined Device Paths. A vendor must
142 /// allocate a Vendor GUID for a Device Path. The Vendor GUID can then be used to define the
143 /// contents on the n bytes that follow in the Vendor Device Path node.
146 EFI_DEVICE_PATH_PROTOCOL Header
;
148 /// Vendor-assigned GUID that defines the data that follows.
152 /// Vendor-defined variable size data.
154 } VENDOR_DEVICE_PATH
;
157 /// Controller Device Path SubType.
159 #define HW_CONTROLLER_DP 0x05
162 /// Controller Device Path.
165 EFI_DEVICE_PATH_PROTOCOL Header
;
167 /// Controller number.
169 UINT32 ControllerNumber
;
170 } CONTROLLER_DEVICE_PATH
;
173 /// ACPI Device Paths.
175 #define ACPI_DEVICE_PATH 0x02
178 /// ACPI Device Path SubType.
182 EFI_DEVICE_PATH_PROTOCOL Header
;
184 /// Device's PnP hardware ID stored in a numeric 32-bit
185 /// compressed EISA-type ID. This value must match the
186 /// corresponding _HID in the ACPI name space.
190 /// Unique ID that is required by ACPI if two devices have the
191 /// same _HID. This value must also match the corresponding
192 /// _UID/_HID pair in the ACPI name space. Only the 32-bit
193 /// numeric value type of _UID is supported. Thus, strings must
194 /// not be used for the _UID in the ACPI name space.
197 } ACPI_HID_DEVICE_PATH
;
200 /// Expanded ACPI Device Path SubType.
202 #define ACPI_EXTENDED_DP 0x02
204 EFI_DEVICE_PATH_PROTOCOL Header
;
206 /// Device's PnP hardware ID stored in a numeric 32-bit
207 /// compressed EISA-type ID. This value must match the
208 /// corresponding _HID in the ACPI name space.
212 /// Unique ID that is required by ACPI if two devices have the
213 /// same _HID. This value must also match the corresponding
214 /// _UID/_HID pair in the ACPI name space.
218 /// Device's compatible PnP hardware ID stored in a numeric
219 /// 32-bit compressed EISA-type ID. This value must match at
220 /// least one of the compatible device IDs returned by the
221 /// corresponding _CID in the ACPI name space.
225 /// Optional variable length _HIDSTR.
226 /// Optional variable length _UIDSTR.
227 /// Optional variable length _CIDSTR.
229 } ACPI_EXTENDED_HID_DEVICE_PATH
;
233 // EISA ID Definition 32-bits
234 // bits[15:0] - three character compressed ASCII EISA ID.
235 // bits[31:16] - binary number
236 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
238 #define PNP_EISA_ID_CONST 0x41d0
239 #define EISA_ID(_Name, _Num) ((UINT32)((_Name) | (_Num) << 16))
240 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
241 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
243 #define PNP_EISA_ID_MASK 0xffff
244 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
247 /// ACPI _ADR Device Path SubType.
249 #define ACPI_ADR_DP 0x03
252 /// The _ADR device path is used to contain video output device attributes to support the Graphics
253 /// Output Protocol. The device path can contain multiple _ADR entries if multiple video output
254 /// devices are displaying the same output.
257 EFI_DEVICE_PATH_PROTOCOL Header
;
259 /// _ADR value. For video output devices the value of this
260 /// field comes from Table B-2 of the ACPI 3.0 specification. At
261 /// least one _ADR value is required.
265 // This device path may optionally contain more than one _ADR entry.
267 } ACPI_ADR_DEVICE_PATH
;
269 #define ACPI_ADR_DISPLAY_TYPE_OTHER 0
270 #define ACPI_ADR_DISPLAY_TYPE_VGA 1
271 #define ACPI_ADR_DISPLAY_TYPE_TV 2
272 #define ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL 3
273 #define ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL 4
275 #define ACPI_DISPLAY_ADR(_DeviceIdScheme, _HeadId, _NonVgaOutput, _BiosCanDetect, _VendorInfo, _Type, _Port, _Index) \
276 ((UINT32)( ((UINT32)((_DeviceIdScheme) & 0x1) << 31) | \
277 (((_HeadId) & 0x7) << 18) | \
278 (((_NonVgaOutput) & 0x1) << 17) | \
279 (((_BiosCanDetect) & 0x1) << 16) | \
280 (((_VendorInfo) & 0xf) << 12) | \
281 (((_Type) & 0xf) << 8) | \
282 (((_Port) & 0xf) << 4) | \
286 /// Messaging Device Paths.
287 /// This Device Path is used to describe the connection of devices outside the resource domain of the
288 /// system. This Device Path can describe physical messaging information like SCSI ID, or abstract
289 /// information like networking protocol IP addresses.
291 #define MESSAGING_DEVICE_PATH 0x03
294 /// ATAPI Device Path SubType
296 #define MSG_ATAPI_DP 0x01
298 EFI_DEVICE_PATH_PROTOCOL Header
;
300 /// Set to zero for primary, or one for secondary.
302 UINT8 PrimarySecondary
;
304 /// Set to zero for master, or one for slave mode.
308 /// Logical Unit Number.
314 /// SCSI Device Path SubType.
316 #define MSG_SCSI_DP 0x02
318 EFI_DEVICE_PATH_PROTOCOL Header
;
320 /// Target ID on the SCSI bus (PUN).
324 /// Logical Unit Number (LUN).
330 /// Fibre Channel SubType.
332 #define MSG_FIBRECHANNEL_DP 0x03
334 EFI_DEVICE_PATH_PROTOCOL Header
;
336 /// Reserved for the future.
340 /// Fibre Channel World Wide Number.
344 /// Fibre Channel Logical Unit Number.
347 } FIBRECHANNEL_DEVICE_PATH
;
350 /// Fibre Channel Ex SubType.
352 #define MSG_FIBRECHANNELEX_DP 0x15
354 EFI_DEVICE_PATH_PROTOCOL Header
;
356 /// Reserved for the future.
360 /// 8 byte array containing Fibre Channel End Device Port Name.
364 /// 8 byte array containing Fibre Channel Logical Unit Number.
367 } FIBRECHANNELEX_DEVICE_PATH
;
370 /// 1394 Device Path SubType
372 #define MSG_1394_DP 0x04
374 EFI_DEVICE_PATH_PROTOCOL Header
;
376 /// Reserved for the future.
380 /// 1394 Global Unique ID (GUID).
386 /// USB Device Path SubType.
388 #define MSG_USB_DP 0x05
390 EFI_DEVICE_PATH_PROTOCOL Header
;
392 /// USB Parent Port Number.
394 UINT8 ParentPortNumber
;
396 /// USB Interface Number.
398 UINT8 InterfaceNumber
;
402 /// USB Class Device Path SubType.
404 #define MSG_USB_CLASS_DP 0x0f
406 EFI_DEVICE_PATH_PROTOCOL Header
;
408 /// Vendor ID assigned by USB-IF. A value of 0xFFFF will
409 /// match any Vendor ID.
413 /// Product ID assigned by USB-IF. A value of 0xFFFF will
414 /// match any Product ID.
418 /// The class code assigned by the USB-IF. A value of 0xFF
419 /// will match any class code.
423 /// The subclass code assigned by the USB-IF. A value of
424 /// 0xFF will match any subclass code.
426 UINT8 DeviceSubClass
;
428 /// The protocol code assigned by the USB-IF. A value of
429 /// 0xFF will match any protocol code.
431 UINT8 DeviceProtocol
;
432 } USB_CLASS_DEVICE_PATH
;
435 /// USB WWID Device Path SubType.
437 #define MSG_USB_WWID_DP 0x10
440 /// This device path describes a USB device using its serial number.
443 EFI_DEVICE_PATH_PROTOCOL Header
;
445 /// USB interface number.
447 UINT16 InterfaceNumber
;
449 /// USB vendor id of the device.
453 /// USB product id of the device.
457 /// Last 64-or-fewer UTF-16 characters of the USB
458 /// serial number. The length of the string is
459 /// determined by the Length field less the offset of the
460 /// Serial Number field (10)
462 /// CHAR16 SerialNumber[...];
463 } USB_WWID_DEVICE_PATH
;
466 /// Device Logical Unit SubType.
468 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
470 EFI_DEVICE_PATH_PROTOCOL Header
;
472 /// Logical Unit Number for the interface.
475 } DEVICE_LOGICAL_UNIT_DEVICE_PATH
;
478 /// SATA Device Path SubType.
480 #define MSG_SATA_DP 0x12
482 EFI_DEVICE_PATH_PROTOCOL Header
;
484 /// The HBA port number that facilitates the connection to the
485 /// device or a port multiplier. The value 0xFFFF is reserved.
487 UINT16 HBAPortNumber
;
489 /// The Port multiplier port number that facilitates the connection
490 /// to the device. Bit 15 should be set if the device is directly
491 /// connected to the HBA.
493 UINT16 PortMultiplierPortNumber
;
495 /// Logical Unit Number.
501 /// Flag for if the device is directly connected to the HBA.
503 #define SATA_HBA_DIRECT_CONNECT_FLAG 0x8000
506 /// I2O Device Path SubType.
508 #define MSG_I2O_DP 0x06
510 EFI_DEVICE_PATH_PROTOCOL Header
;
512 /// Target ID (TID) for a device.
518 /// MAC Address Device Path SubType.
520 #define MSG_MAC_ADDR_DP 0x0b
522 EFI_DEVICE_PATH_PROTOCOL Header
;
524 /// The MAC address for a network interface padded with 0s.
526 EFI_MAC_ADDRESS MacAddress
;
528 /// Network interface type(i.e. 802.3, FDDI).
531 } MAC_ADDR_DEVICE_PATH
;
534 /// IPv4 Device Path SubType
536 #define MSG_IPv4_DP 0x0c
538 EFI_DEVICE_PATH_PROTOCOL Header
;
540 /// The local IPv4 address.
542 EFI_IPv4_ADDRESS LocalIpAddress
;
544 /// The remote IPv4 address.
546 EFI_IPv4_ADDRESS RemoteIpAddress
;
548 /// The local port number.
552 /// The remote port number.
556 /// The network protocol(i.e. UDP, TCP).
560 /// 0x00 - The Source IP Address was assigned though DHCP.
561 /// 0x01 - The Source IP Address is statically bound.
563 BOOLEAN StaticIpAddress
;
565 /// The gateway IP address
567 EFI_IPv4_ADDRESS GatewayIpAddress
;
571 EFI_IPv4_ADDRESS SubnetMask
;
575 /// IPv6 Device Path SubType.
577 #define MSG_IPv6_DP 0x0d
579 EFI_DEVICE_PATH_PROTOCOL Header
;
581 /// The local IPv6 address.
583 EFI_IPv6_ADDRESS LocalIpAddress
;
585 /// The remote IPv6 address.
587 EFI_IPv6_ADDRESS RemoteIpAddress
;
589 /// The local port number.
593 /// The remote port number.
597 /// The network protocol(i.e. UDP, TCP).
601 /// 0x00 - The Local IP Address was manually configured.
602 /// 0x01 - The Local IP Address is assigned through IPv6
603 /// stateless auto-configuration.
604 /// 0x02 - The Local IP Address is assigned through IPv6
605 /// stateful configuration.
607 UINT8 IpAddressOrigin
;
609 /// The prefix length
613 /// The gateway IP address
615 EFI_IPv6_ADDRESS GatewayIpAddress
;
619 /// InfiniBand Device Path SubType.
621 #define MSG_INFINIBAND_DP 0x09
623 EFI_DEVICE_PATH_PROTOCOL Header
;
625 /// Flags to help identify/manage InfiniBand device path elements:
626 /// Bit 0 - IOC/Service (0b = IOC, 1b = Service).
627 /// Bit 1 - Extend Boot Environment.
628 /// Bit 2 - Console Protocol.
629 /// Bit 3 - Storage Protocol.
630 /// Bit 4 - Network Protocol.
631 /// All other bits are reserved.
633 UINT32 ResourceFlags
;
635 /// 128-bit Global Identifier for remote fabric port.
639 /// 64-bit unique identifier to remote IOC or server process.
640 /// Interpretation of field specified by Resource Flags (bit 0).
644 /// 64-bit persistent ID of remote IOC port.
648 /// 64-bit persistent ID of remote device.
651 } INFINIBAND_DEVICE_PATH
;
653 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
654 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
655 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
656 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
657 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
660 /// UART Device Path SubType.
662 #define MSG_UART_DP 0x0e
664 EFI_DEVICE_PATH_PROTOCOL Header
;
670 /// The baud rate setting for the UART style device. A value of 0
671 /// means that the device's default baud rate will be used.
675 /// The number of data bits for the UART style device. A value
676 /// of 0 means that the device's default number of data bits will be used.
680 /// The parity setting for the UART style device.
681 /// Parity 0x00 - Default Parity.
682 /// Parity 0x01 - No Parity.
683 /// Parity 0x02 - Even Parity.
684 /// Parity 0x03 - Odd Parity.
685 /// Parity 0x04 - Mark Parity.
686 /// Parity 0x05 - Space Parity.
690 /// The number of stop bits for the UART style device.
691 /// Stop Bits 0x00 - Default Stop Bits.
692 /// Stop Bits 0x01 - 1 Stop Bit.
693 /// Stop Bits 0x02 - 1.5 Stop Bits.
694 /// Stop Bits 0x03 - 2 Stop Bits.
700 // Use VENDOR_DEVICE_PATH struct
702 #define MSG_VENDOR_DP 0x0a
703 typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH
;
705 #define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID
706 #define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID
707 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
708 #define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID
711 /// A new device path node is defined to declare flow control characteristics.
712 /// UART Flow Control Messaging Device Path
715 EFI_DEVICE_PATH_PROTOCOL Header
;
717 /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID.
721 /// Bitmap of supported flow control types.
722 /// Bit 0 set indicates hardware flow control.
723 /// Bit 1 set indicates Xon/Xoff flow control.
724 /// All other bits are reserved and are clear.
726 UINT32 FlowControlMap
;
727 } UART_FLOW_CONTROL_DEVICE_PATH
;
729 #define UART_FLOW_CONTROL_HARDWARE 0x00000001
730 #define UART_FLOW_CONTROL_XON_XOFF 0x00000010
732 #define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID
734 /// Serial Attached SCSI (SAS) Device Path.
737 EFI_DEVICE_PATH_PROTOCOL Header
;
739 /// DEVICE_PATH_MESSAGING_SAS GUID.
743 /// Reserved for future use.
747 /// SAS Address for Serial Attached SCSI Target.
751 /// SAS Logical Unit Number.
755 /// More Information about the device and its interconnect.
757 UINT16 DeviceTopology
;
759 /// Relative Target Port (RTP).
761 UINT16 RelativeTargetPort
;
765 /// Serial Attached SCSI (SAS) Ex Device Path SubType
767 #define MSG_SASEX_DP 0x16
769 EFI_DEVICE_PATH_PROTOCOL Header
;
771 /// 8-byte array of the SAS Address for Serial Attached SCSI Target Port.
775 /// 8-byte array of the SAS Logical Unit Number.
779 /// More Information about the device and its interconnect.
781 UINT16 DeviceTopology
;
783 /// Relative Target Port (RTP).
785 UINT16 RelativeTargetPort
;
789 /// NvmExpress Namespace Device Path SubType.
791 #define MSG_NVME_NAMESPACE_DP 0x17
793 EFI_DEVICE_PATH_PROTOCOL Header
;
795 UINT64 NamespaceUuid
;
796 } NVME_NAMESPACE_DEVICE_PATH
;
799 /// Uniform Resource Identifiers (URI) Device Path SubType
801 #define MSG_URI_DP 0x18
803 EFI_DEVICE_PATH_PROTOCOL Header
;
805 /// Instance of the URI pursuant to RFC 3986.
811 /// Universal Flash Storage (UFS) Device Path SubType.
813 #define MSG_UFS_DP 0x19
815 EFI_DEVICE_PATH_PROTOCOL Header
;
817 /// Target ID on the UFS bus (PUN).
821 /// Logical Unit Number (LUN).
827 /// SD (Secure Digital) Device Path SubType.
829 #define MSG_SD_DP 0x1A
831 EFI_DEVICE_PATH_PROTOCOL Header
;
836 /// iSCSI Device Path SubType
838 #define MSG_ISCSI_DP 0x13
840 EFI_DEVICE_PATH_PROTOCOL Header
;
842 /// Network Protocol (0 = TCP, 1+ = reserved).
844 UINT16 NetworkProtocol
;
846 /// iSCSI Login Options.
850 /// iSCSI Logical Unit Number.
854 /// iSCSI Target Portal group tag the initiator intends
855 /// to establish a session with.
857 UINT16 TargetPortalGroupTag
;
859 /// iSCSI NodeTarget Name. The length of the name
860 /// is determined by subtracting the offset of this field from Length.
862 /// CHAR8 iSCSI Target Name.
865 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
866 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
867 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
868 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
869 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
870 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
871 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
872 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
875 /// VLAN Device Path SubType.
877 #define MSG_VLAN_DP 0x14
879 EFI_DEVICE_PATH_PROTOCOL Header
;
881 /// VLAN identifier (0-4094).
887 /// Bluetooth Device Path SubType.
889 #define MSG_BLUETOOTH_DP 0x1b
891 EFI_DEVICE_PATH_PROTOCOL Header
;
893 /// 48bit Bluetooth device address.
895 BLUETOOTH_ADDRESS BD_ADDR
;
896 } BLUETOOTH_DEVICE_PATH
;
899 /// Wi-Fi Device Path SubType.
901 #define MSG_WIFI_DP 0x1C
903 EFI_DEVICE_PATH_PROTOCOL Header
;
905 /// Service set identifier. A 32-byte octets string.
913 #define MEDIA_DEVICE_PATH 0x04
916 /// Hard Drive Media Device Path SubType.
918 #define MEDIA_HARDDRIVE_DP 0x01
921 /// The Hard Drive Media Device Path is used to represent a partition on a hard drive.
924 EFI_DEVICE_PATH_PROTOCOL Header
;
926 /// Describes the entry in a partition table, starting with entry 1.
927 /// Partition number zero represents the entire device. Valid
928 /// partition numbers for a MBR partition are [1, 4]. Valid
929 /// partition numbers for a GPT partition are [1, NumberOfPartitionEntries].
931 UINT32 PartitionNumber
;
933 /// Starting LBA of the partition on the hard drive.
935 UINT64 PartitionStart
;
937 /// Size of the partition in units of Logical Blocks.
939 UINT64 PartitionSize
;
941 /// Signature unique to this partition:
942 /// If SignatureType is 0, this field has to be initialized with 16 zeros.
943 /// If SignatureType is 1, the MBR signature is stored in the first 4 bytes of this field.
944 /// The other 12 bytes are initialized with zeros.
945 /// If SignatureType is 2, this field contains a 16 byte signature.
949 /// Partition Format: (Unused values reserved).
950 /// 0x01 - PC-AT compatible legacy MBR.
951 /// 0x02 - GUID Partition Table.
955 /// Type of Disk Signature: (Unused values reserved).
956 /// 0x00 - No Disk Signature.
957 /// 0x01 - 32-bit signature from address 0x1b8 of the type 0x01 MBR.
958 /// 0x02 - GUID signature.
961 } HARDDRIVE_DEVICE_PATH
;
963 #define MBR_TYPE_PCAT 0x01
964 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
966 #define NO_DISK_SIGNATURE 0x00
967 #define SIGNATURE_TYPE_MBR 0x01
968 #define SIGNATURE_TYPE_GUID 0x02
971 /// CD-ROM Media Device Path SubType.
973 #define MEDIA_CDROM_DP 0x02
976 /// The CD-ROM Media Device Path is used to define a system partition that exists on a CD-ROM.
979 EFI_DEVICE_PATH_PROTOCOL Header
;
981 /// Boot Entry number from the Boot Catalog. The Initial/Default entry is defined as zero.
985 /// Starting RBA of the partition on the medium. CD-ROMs use Relative logical Block Addressing.
987 UINT64 PartitionStart
;
989 /// Size of the partition in units of Blocks, also called Sectors.
991 UINT64 PartitionSize
;
995 // Use VENDOR_DEVICE_PATH struct
997 #define MEDIA_VENDOR_DP 0x03 ///< Media vendor device path subtype.
1000 /// File Path Media Device Path SubType
1002 #define MEDIA_FILEPATH_DP 0x04
1004 EFI_DEVICE_PATH_PROTOCOL Header
;
1006 /// A NULL-terminated Path string including directory and file names.
1009 } FILEPATH_DEVICE_PATH
;
1011 #define SIZE_OF_FILEPATH_DEVICE_PATH OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)
1014 /// Media Protocol Device Path SubType.
1016 #define MEDIA_PROTOCOL_DP 0x05
1019 /// The Media Protocol Device Path is used to denote the protocol that is being
1020 /// used in a device path at the location of the path specified.
1021 /// Many protocols are inherent to the style of device path.
1024 EFI_DEVICE_PATH_PROTOCOL Header
;
1026 /// The ID of the protocol.
1029 } MEDIA_PROTOCOL_DEVICE_PATH
;
1032 /// PIWG Firmware File SubType.
1034 #define MEDIA_PIWG_FW_FILE_DP 0x06
1037 /// This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware file.
1040 EFI_DEVICE_PATH_PROTOCOL Header
;
1042 /// Firmware file name
1044 EFI_GUID FvFileName
;
1045 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
;
1048 /// PIWG Firmware Volume Device Path SubType.
1050 #define MEDIA_PIWG_FW_VOL_DP 0x07
1053 /// This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware volume.
1056 EFI_DEVICE_PATH_PROTOCOL Header
;
1058 /// Firmware volume name.
1061 } MEDIA_FW_VOL_DEVICE_PATH
;
1064 /// Media relative offset range device path.
1066 #define MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08
1069 /// Used to describe the offset range of media relative.
1072 EFI_DEVICE_PATH_PROTOCOL Header
;
1074 UINT64 StartingOffset
;
1075 UINT64 EndingOffset
;
1076 } MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH
;
1079 /// BIOS Boot Specification Device Path.
1081 #define BBS_DEVICE_PATH 0x05
1084 /// BIOS Boot Specification Device Path SubType.
1086 #define BBS_BBS_DP 0x01
1089 /// This Device Path is used to describe the booting of non-EFI-aware operating systems.
1092 EFI_DEVICE_PATH_PROTOCOL Header
;
1094 /// Device Type as defined by the BIOS Boot Specification.
1098 /// Status Flags as defined by the BIOS Boot Specification.
1102 /// Null-terminated ASCII string that describes the boot device to a user.
1105 } BBS_BBS_DEVICE_PATH
;
1108 // DeviceType definitions - from BBS specification
1110 #define BBS_TYPE_FLOPPY 0x01
1111 #define BBS_TYPE_HARDDRIVE 0x02
1112 #define BBS_TYPE_CDROM 0x03
1113 #define BBS_TYPE_PCMCIA 0x04
1114 #define BBS_TYPE_USB 0x05
1115 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
1116 #define BBS_TYPE_BEV 0x80
1117 #define BBS_TYPE_UNKNOWN 0xFF
1121 /// Union of all possible Device Paths and pointers to Device Paths.
1124 EFI_DEVICE_PATH_PROTOCOL DevPath
;
1125 PCI_DEVICE_PATH Pci
;
1126 PCCARD_DEVICE_PATH PcCard
;
1127 MEMMAP_DEVICE_PATH MemMap
;
1128 VENDOR_DEVICE_PATH Vendor
;
1130 CONTROLLER_DEVICE_PATH Controller
;
1131 ACPI_HID_DEVICE_PATH Acpi
;
1132 ACPI_EXTENDED_HID_DEVICE_PATH ExtendedAcpi
;
1133 ACPI_ADR_DEVICE_PATH AcpiAdr
;
1135 ATAPI_DEVICE_PATH Atapi
;
1136 SCSI_DEVICE_PATH Scsi
;
1137 ISCSI_DEVICE_PATH Iscsi
;
1138 FIBRECHANNEL_DEVICE_PATH FibreChannel
;
1139 FIBRECHANNELEX_DEVICE_PATH FibreChannelEx
;
1141 F1394_DEVICE_PATH F1394
;
1142 USB_DEVICE_PATH Usb
;
1143 SATA_DEVICE_PATH Sata
;
1144 USB_CLASS_DEVICE_PATH UsbClass
;
1145 USB_WWID_DEVICE_PATH UsbWwid
;
1146 DEVICE_LOGICAL_UNIT_DEVICE_PATH LogicUnit
;
1147 I2O_DEVICE_PATH I2O
;
1148 MAC_ADDR_DEVICE_PATH MacAddr
;
1149 IPv4_DEVICE_PATH Ipv4
;
1150 IPv6_DEVICE_PATH Ipv6
;
1151 VLAN_DEVICE_PATH Vlan
;
1152 INFINIBAND_DEVICE_PATH InfiniBand
;
1153 UART_DEVICE_PATH Uart
;
1154 UART_FLOW_CONTROL_DEVICE_PATH UartFlowControl
;
1155 SAS_DEVICE_PATH Sas
;
1156 SASEX_DEVICE_PATH SasEx
;
1157 NVME_NAMESPACE_DEVICE_PATH NvmeNamespace
;
1158 URI_DEVICE_PATH Uri
;
1159 BLUETOOTH_DEVICE_PATH Bluetooth
;
1160 WIFI_DEVICE_PATH WiFi
;
1161 UFS_DEVICE_PATH Ufs
;
1163 HARDDRIVE_DEVICE_PATH HardDrive
;
1164 CDROM_DEVICE_PATH CD
;
1166 FILEPATH_DEVICE_PATH FilePath
;
1167 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol
;
1169 MEDIA_FW_VOL_DEVICE_PATH FirmwareVolume
;
1170 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FirmwareFile
;
1171 MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH Offset
;
1173 BBS_BBS_DEVICE_PATH Bbs
;
1179 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1180 PCI_DEVICE_PATH
*Pci
;
1181 PCCARD_DEVICE_PATH
*PcCard
;
1182 MEMMAP_DEVICE_PATH
*MemMap
;
1183 VENDOR_DEVICE_PATH
*Vendor
;
1185 CONTROLLER_DEVICE_PATH
*Controller
;
1186 ACPI_HID_DEVICE_PATH
*Acpi
;
1187 ACPI_EXTENDED_HID_DEVICE_PATH
*ExtendedAcpi
;
1188 ACPI_ADR_DEVICE_PATH
*AcpiAdr
;
1190 ATAPI_DEVICE_PATH
*Atapi
;
1191 SCSI_DEVICE_PATH
*Scsi
;
1192 ISCSI_DEVICE_PATH
*Iscsi
;
1193 FIBRECHANNEL_DEVICE_PATH
*FibreChannel
;
1194 FIBRECHANNELEX_DEVICE_PATH
*FibreChannelEx
;
1196 F1394_DEVICE_PATH
*F1394
;
1197 USB_DEVICE_PATH
*Usb
;
1198 SATA_DEVICE_PATH
*Sata
;
1199 USB_CLASS_DEVICE_PATH
*UsbClass
;
1200 USB_WWID_DEVICE_PATH
*UsbWwid
;
1201 DEVICE_LOGICAL_UNIT_DEVICE_PATH
*LogicUnit
;
1202 I2O_DEVICE_PATH
*I2O
;
1203 MAC_ADDR_DEVICE_PATH
*MacAddr
;
1204 IPv4_DEVICE_PATH
*Ipv4
;
1205 IPv6_DEVICE_PATH
*Ipv6
;
1206 VLAN_DEVICE_PATH
*Vlan
;
1207 INFINIBAND_DEVICE_PATH
*InfiniBand
;
1208 UART_DEVICE_PATH
*Uart
;
1209 UART_FLOW_CONTROL_DEVICE_PATH
*UartFlowControl
;
1210 SAS_DEVICE_PATH
*Sas
;
1211 SASEX_DEVICE_PATH
*SasEx
;
1212 NVME_NAMESPACE_DEVICE_PATH
*NvmeNamespace
;
1213 URI_DEVICE_PATH
*Uri
;
1214 BLUETOOTH_DEVICE_PATH
*Bluetooth
;
1215 WIFI_DEVICE_PATH
*WiFi
;
1216 UFS_DEVICE_PATH
*Ufs
;
1218 HARDDRIVE_DEVICE_PATH
*HardDrive
;
1219 CDROM_DEVICE_PATH
*CD
;
1221 FILEPATH_DEVICE_PATH
*FilePath
;
1222 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProtocol
;
1224 MEDIA_FW_VOL_DEVICE_PATH
*FirmwareVolume
;
1225 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*FirmwareFile
;
1226 MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH
*Offset
;
1228 BBS_BBS_DEVICE_PATH
*Bbs
;
1234 #define END_DEVICE_PATH_TYPE 0x7f
1235 #define END_ENTIRE_DEVICE_PATH_SUBTYPE 0xFF
1236 #define END_INSTANCE_DEVICE_PATH_SUBTYPE 0x01
1238 extern EFI_GUID gEfiDevicePathProtocolGuid
;