[mirror_edk2.git] / MdePkg / Include / Protocol / DevicePath.h

/** @file\r
  The device path protocol as defined in EFI 1.0.\r
\r
  The device path represents a programatic path to a device. It's the view\r
  from a software point of view. It also must persist from boot to boot, so \r
  it can not contain things like PCI bus numbers that change from boot to boot.\r
\r
  Copyright (c) 2006, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __EFI_DEVICE_PATH_PROTOCOL_H__\r
#define __EFI_DEVICE_PATH_PROTOCOL_H__\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
  }\r
\r
//\r
// Protocol GUID defined in EFI1.1.\r
// \r
\r
//\r
// Device Path information\r
//\r
#define DEVICE_PATH_PROTOCOL  EFI_DEVICE_PATH_PROTOCOL_GUID\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT8 Type;\r
  UINT8 SubType;\r
  UINT8 Length[2];\r
} EFI_DEVICE_PATH_PROTOCOL;\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
#define HARDWARE_DEVICE_PATH      0x01\r
\r
#define HW_PCI_DP                 0x01\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT8                           Function;\r
  UINT8                           Device;\r
} PCI_DEVICE_PATH;\r
\r
#define HW_PCCARD_DP              0x02\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT8                           FunctionNumber;\r
} PCCARD_DEVICE_PATH;\r
\r
#define HW_MEMMAP_DP              0x03\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          MemoryType;\r
  EFI_PHYSICAL_ADDRESS            StartingAddress;\r
  EFI_PHYSICAL_ADDRESS            EndingAddress;\r
} MEMMAP_DEVICE_PATH;\r
\r
#define HW_VENDOR_DP              0x04\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_GUID                        Guid;\r
} VENDOR_DEVICE_PATH;\r
\r
#define HW_CONTROLLER_DP          0x05\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          ControllerNumber;\r
} CONTROLLER_DEVICE_PATH;\r
\r
//\r
// ACPI Device Paths\r
//\r
#define ACPI_DEVICE_PATH          0x02\r
\r
#define ACPI_DP                   0x01\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          HID;\r
  UINT32                          UID;\r
} ACPI_HID_DEVICE_PATH;\r
\r
#define ACPI_EXTENDED_DP          0x02\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          HID;\r
  UINT32                          UID;\r
  UINT32                          CID;\r
  //\r
  // Optional variable length _HIDSTR\r
  // Optional variable length _UIDSTR\r
  //\r
} ACPI_EXTENDED_HID_DEVICE_PATH;\r
\r
//\r
//  EISA ID Macro\r
//  EISA ID Definition 32-bits\r
//   bits[15:0] - three character compressed ASCII EISA ID.\r
//   bits[31:16] - binary number\r
//    Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'\r
//\r
#define PNP_EISA_ID_CONST         0x41d0\r
#define EISA_ID(_Name, _Num)      ((UINT32) ((_Name) | (_Num) << 16))\r
#define EISA_PNP_ID(_PNPId)       (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))\r
#define EFI_PNP_ID(_PNPId)        (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))\r
\r
#define PNP_EISA_ID_MASK          0xffff\r
#define EISA_ID_TO_NUM(_Id)       ((_Id) >> 16)\r
\r
\r
#define ACPI_ADR_DP               0x03\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          ADR;\r
} ACPI_ADR_DEVICE_PATH;\r
\r
\r
//\r
// Messaging Device Paths\r
//\r
#define MESSAGING_DEVICE_PATH     0x03\r
\r
#define MSG_ATAPI_DP              0x01\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT8                           PrimarySecondary;\r
  UINT8                           SlaveMaster;\r
  UINT16                          Lun;\r
} ATAPI_DEVICE_PATH;\r
\r
#define MSG_SCSI_DP               0x02\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT16                          Pun;\r
  UINT16                          Lun;\r
} SCSI_DEVICE_PATH;\r
\r
#define MSG_FIBRECHANNEL_DP       0x03\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          Reserved;\r
  UINT64                          WWN;\r
  UINT64                          Lun;\r
} FIBRECHANNEL_DEVICE_PATH;\r
\r
#define MSG_1394_DP               0x04\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          Reserved;\r
  UINT64                          Guid;\r
} F1394_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
} USB_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
} USB_CLASS_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
} USB_WWID_DEVICE_PATH;\r
\r
\r
#define MSG_DEVICE_LOGICAL_UNIT_DP  0x11\r
typedef struct {\r
    EFI_DEVICE_PATH_PROTOCOL      Header;\r
    UINT8                         Lun;\r
} DEVICE_LOGICAL_UNIT_DEVICE_PATH;\r
\r
#define MSG_SATA_DP               0x12\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT16                          HbaPortNumber;\r
  UINT16                          PortMultiplierPort;\r
  UINT16                          LogicalUnitNumber;\r
} SATA_DEVICE_PATH;\r
\r
#define MSG_I2O_DP                0x06\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          Tid;\r
} I2O_DEVICE_PATH;\r
\r
#define MSG_MAC_ADDR_DP           0x0b\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_MAC_ADDRESS                 MacAddress;\r
  UINT8                           IfType;\r
} MAC_ADDR_DEVICE_PATH;\r
\r
#define MSG_IPv4_DP               0x0c\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_IPv4_ADDRESS                LocalIpAddress;\r
  EFI_IPv4_ADDRESS                RemoteIpAddress;\r
  UINT16                          LocalPort;\r
  UINT16                          RemotePort;\r
  UINT16                          Protocol;\r
  BOOLEAN                         StaticIpAddress;\r
} IPv4_DEVICE_PATH;\r
\r
#define MSG_IPv6_DP               0x0d\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_IPv6_ADDRESS                LocalIpAddress;\r
  EFI_IPv6_ADDRESS                RemoteIpAddress;\r
  UINT16                          LocalPort;\r
  UINT16                          RemotePort;\r
  UINT16                          Protocol;\r
  BOOLEAN                         StaticIpAddress;\r
} IPv6_DEVICE_PATH;\r
\r
#define MSG_INFINIBAND_DP         0x09\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          ResourceFlags;\r
  UINT8                           PortGid[16];\r
  UINT64                          ServiceId;\r
  UINT64                          TargetPortId;\r
  UINT64                          DeviceId;\r
} INFINIBAND_DEVICE_PATH;\r
\r
#define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE                0x01\r
#define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT  0x02\r
#define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL           0x04\r
#define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL           0x08\r
#define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL           0x10\r
\r
#define MSG_UART_DP               0x0e\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          Reserved;\r
  UINT64                          BaudRate;\r
  UINT8                           DataBits;\r
  UINT8                           Parity;\r
  UINT8                           StopBits;\r
} UART_DEVICE_PATH;\r
\r
//\r
// Use VENDOR_DEVICE_PATH struct\r
//\r
#define MSG_VENDOR_DP             0x0a\r
typedef VENDOR_DEVICE_PATH        VENDOR_DEFINED_DEVICE_PATH;\r
\r
#define DEVICE_PATH_MESSAGING_PC_ANSI     EFI_PC_ANSI_GUID\r
#define DEVICE_PATH_MESSAGING_VT_100      EFI_VT_100_GUID\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
#define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL   EFI_UART_DEVICE_PATH_GUID\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_GUID                        Guid;\r
  UINT32                          FlowControlMap;\r
} UART_FLOW_CONTROL_DEVICE_PATH;\r
\r
#define DEVICE_PATH_MESSAGING_SAS                 EFI_SAS_DEVICE_PATH_GUID\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_GUID                        Guid;\r
  UINT32                          Reserved;\r
  UINT64                          SasAddress;\r
  UINT64                          Lun;\r
  UINT16                          DeviceTopology;\r
  UINT16                          RelativeTargetPort;\r
} SAS_DEVICE_PATH;\r
\r
#define MSG_ISCSI_DP              0x13\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT16                          NetworkProtocol;\r
  UINT16                          LoginOption;\r
  UINT16                          Reserved;\r
  UINT16                          TargetPortalGroupTag;\r
  UINT64                          LUN;\r
  // CHAR8                        iSCSI Target Name\r
} ISCSI_DEVICE_PATH;\r
\r
#define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST             0x0000\r
#define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C   0x0002\r
#define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST               0x0000\r
#define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C     0x0008\r
#define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP              0x0000\r
#define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON               0x1000\r
#define ISCSI_LOGIN_OPTION_CHAP_BI                      0x0000\r
#define ISCSI_LOGIN_OPTION_CHAP_UNI                     0x2000\r
\r
//\r
// Media Device Path\r
//\r
#define MEDIA_DEVICE_PATH         0x04\r
\r
#define MEDIA_HARDDRIVE_DP        0x01\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          PartitionNumber;\r
  UINT64                          PartitionStart;\r
  UINT64                          PartitionSize;\r
  UINT8                           Signature[16];\r
  UINT8                           MBRType;\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 SIGNATURE_TYPE_MBR        0x01\r
#define SIGNATURE_TYPE_GUID       0x02\r
\r
#define MEDIA_CDROM_DP            0x02\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  UINT32                          BootEntry;\r
  UINT64                          PartitionStart;\r
  UINT64                          PartitionSize;\r
} CDROM_DEVICE_PATH;\r
\r
//\r
// Use VENDOR_DEVICE_PATH struct\r
//\r
#define MEDIA_VENDOR_DP           0x03\r
\r
#define MEDIA_FILEPATH_DP         0x04\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\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
#define MEDIA_PROTOCOL_DP         0x05\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_GUID                        Protocol;\r
} MEDIA_PROTOCOL_DEVICE_PATH;\r
\r
\r
#define MEDIA_PIWG_FW_VOL_DP      0x6\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_GUID                        FvName;\r
} MEDIA_FW_VOL_DEVICE_PATH;\r
\r
\r
#define MEDIA_PIWG_FW_FILE_DP     0x7\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL        Header;\r
  EFI_GUID                        FvFileName;\r
} MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;\r
\r
//\r
// BBS 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
  UINT16                          DeviceType;\r
  UINT16                          StatusFlag;\r
  CHAR8                           String[1];\r
} BBS_BBS_DEVICE_PATH;\r
\r
//\r
// DeviceType definitions - from BBS specification\r
//\r
#define BBS_TYPE_FLOPPY           0x01\r
#define BBS_TYPE_HARDDRIVE        0x02\r
#define BBS_TYPE_CDROM            0x03\r
#define BBS_TYPE_PCMCIA           0x04\r
#define BBS_TYPE_USB              0x05\r
#define BBS_TYPE_EMBEDDED_NETWORK 0x06\r
#define BBS_TYPE_BEV              0x80\r
#define BBS_TYPE_UNKNOWN          0xFF\r
\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
  PCI_DEVICE_PATH                      Pci;\r
  PCCARD_DEVICE_PATH                   PcCard;\r
  MEMMAP_DEVICE_PATH                   MemMap;\r
  VENDOR_DEVICE_PATH                   Vendor;\r
\r
  CONTROLLER_DEVICE_PATH               Controller;\r
  ACPI_HID_DEVICE_PATH                 Acpi;\r
\r
  ATAPI_DEVICE_PATH                    Atapi;\r
  SCSI_DEVICE_PATH                     Scsi;\r
  FIBRECHANNEL_DEVICE_PATH             FibreChannel;\r
\r
  F1394_DEVICE_PATH                    F1394;\r
  USB_DEVICE_PATH                      Usb;\r
  SATA_DEVICE_PATH                     Sata;\r
  USB_CLASS_DEVICE_PATH                UsbClass;\r
  I2O_DEVICE_PATH                      I2O;\r
  MAC_ADDR_DEVICE_PATH                 MacAddr;\r
  IPv4_DEVICE_PATH                     Ipv4;\r
  IPv6_DEVICE_PATH                     Ipv6;\r
  INFINIBAND_DEVICE_PATH               InfiniBand;\r
  UART_DEVICE_PATH                     Uart;\r
\r
  HARDDRIVE_DEVICE_PATH                HardDrive;\r
  CDROM_DEVICE_PATH                    CD;\r
\r
  FILEPATH_DEVICE_PATH                 FilePath;\r
  MEDIA_PROTOCOL_DEVICE_PATH           MediaProtocol;\r
\r
  BBS_BBS_DEVICE_PATH                  Bbs;\r
} EFI_DEV_PATH;\r
\r
\r
\r
typedef union {\r
  EFI_DEVICE_PATH_PROTOCOL             *DevPath;\r
  PCI_DEVICE_PATH                      *Pci;\r
  PCCARD_DEVICE_PATH                   *PcCard;\r
  MEMMAP_DEVICE_PATH                   *MemMap;\r
  VENDOR_DEVICE_PATH                   *Vendor;\r
\r
  CONTROLLER_DEVICE_PATH               *Controller;\r
  ACPI_HID_DEVICE_PATH                 *Acpi;\r
  ACPI_EXTENDED_HID_DEVICE_PATH        *ExtendedAcpi;\r
\r
  ATAPI_DEVICE_PATH                    *Atapi;\r
  SCSI_DEVICE_PATH                     *Scsi;\r
  FIBRECHANNEL_DEVICE_PATH             *FibreChannel;\r
\r
  F1394_DEVICE_PATH                    *F1394;\r
  USB_DEVICE_PATH                      *Usb;\r
  SATA_DEVICE_PATH                     *Sata;\r
  USB_CLASS_DEVICE_PATH                *UsbClass;\r
  I2O_DEVICE_PATH                      *I2O;\r
  MAC_ADDR_DEVICE_PATH                 *MacAddr;\r
  IPv4_DEVICE_PATH                     *Ipv4;\r
  IPv6_DEVICE_PATH                     *Ipv6;\r
  INFINIBAND_DEVICE_PATH               *InfiniBand;\r
  UART_DEVICE_PATH                     *Uart;\r
\r
  HARDDRIVE_DEVICE_PATH                *HardDrive;\r
  CDROM_DEVICE_PATH                    *CD;\r
\r
  FILEPATH_DEVICE_PATH                 *FilePath;\r
  MEDIA_PROTOCOL_DEVICE_PATH           *MediaProtocol;\r
\r
  BBS_BBS_DEVICE_PATH                  *Bbs;\r
  UINT8                                *Raw;\r
} EFI_DEV_PATH_PTR;\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
\r
extern EFI_GUID gEfiDevicePathProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
d1f95000	1	/** @file\r
d1f95000	2	The device path protocol as defined in EFI 1.0.\r
959ccb23	3	\r
d1f95000	4	The device path represents a programatic path to a device. It's the view\r
	5	from a software point of view. It also must persist from boot to boot, so \r
	6	it can not contain things like PCI bus numbers that change from boot to boot.\r
959ccb23	7	\r
d1f95000	8	Copyright (c) 2006, Intel Corporation \r
	9	All rights reserved. This program and the accompanying materials \r
	10	are licensed and made available under the terms and conditions of the BSD License \r
	11	which accompanies this distribution. The full text of the license may be found at \r
	12	http://opensource.org/licenses/bsd-license.php \r
959ccb23	13	\r
d1f95000	14	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
d1f95000	15	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
959ccb23	16	\r
959ccb23	17	**/\r
959ccb23	18	\r
d1f95000	19	#ifndef __EFI_DEVICE_PATH_PROTOCOL_H__\r
	20	#define __EFI_DEVICE_PATH_PROTOCOL_H__\r
	21	\r
	22	//\r
	23	// Device Path protocol\r
	24	//\r
	25	#define EFI_DEVICE_PATH_PROTOCOL_GUID \\r
	26	{ \\r
	27	0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
	28	}\r
959ccb23	29	\r
a6508c05	30	//\r
	31	// Protocol GUID defined in EFI1.1.\r
	32	// \r
	33	\r
959ccb23	34	//\r
	35	// Device Path information\r
	36	//\r
a6508c05	37	#define DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID\r
959ccb23	38	\r
	39	#pragma pack(1)\r
	40	\r
d1f95000	41	typedef struct {\r
	42	UINT8 Type;\r
	43	UINT8 SubType;\r
	44	UINT8 Length[2];\r
	45	} EFI_DEVICE_PATH_PROTOCOL;\r
	46	\r
a6508c05	47	//\r
	48	// For backward-compatible with EFI1.1.\r
	49	// \r
	50	typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH;\r
	51	\r
959ccb23	52	//\r
	53	// Hardware Device Paths\r
	54	//\r
	55	#define HARDWARE_DEVICE_PATH 0x01\r
	56	\r
	57	#define HW_PCI_DP 0x01\r
	58	typedef struct {\r
	59	EFI_DEVICE_PATH_PROTOCOL Header;\r
	60	UINT8 Function;\r
	61	UINT8 Device;\r
	62	} PCI_DEVICE_PATH;\r
	63	\r
	64	#define HW_PCCARD_DP 0x02\r
	65	typedef struct {\r
	66	EFI_DEVICE_PATH_PROTOCOL Header;\r
	67	UINT8 FunctionNumber;\r
	68	} PCCARD_DEVICE_PATH;\r
	69	\r
	70	#define HW_MEMMAP_DP 0x03\r
	71	typedef struct {\r
	72	EFI_DEVICE_PATH_PROTOCOL Header;\r
	73	UINT32 MemoryType;\r
	74	EFI_PHYSICAL_ADDRESS StartingAddress;\r
	75	EFI_PHYSICAL_ADDRESS EndingAddress;\r
	76	} MEMMAP_DEVICE_PATH;\r
	77	\r
	78	#define HW_VENDOR_DP 0x04\r
	79	typedef struct {\r
	80	EFI_DEVICE_PATH_PROTOCOL Header;\r
	81	EFI_GUID Guid;\r
	82	} VENDOR_DEVICE_PATH;\r
	83	\r
	84	#define HW_CONTROLLER_DP 0x05\r
	85	typedef struct {\r
	86	EFI_DEVICE_PATH_PROTOCOL Header;\r
	87	UINT32 ControllerNumber;\r
	88	} CONTROLLER_DEVICE_PATH;\r
	89	\r
	90	//\r
	91	// ACPI Device Paths\r
	92	//\r
	93	#define ACPI_DEVICE_PATH 0x02\r
	94	\r
	95	#define ACPI_DP 0x01\r
	96	typedef struct {\r
	97	EFI_DEVICE_PATH_PROTOCOL Header;\r
	98	UINT32 HID;\r
	99	UINT32 UID;\r
	100	} ACPI_HID_DEVICE_PATH;\r
	101	\r
	102	#define ACPI_EXTENDED_DP 0x02\r
	103	typedef struct {\r
	104	EFI_DEVICE_PATH_PROTOCOL Header;\r
	105	UINT32 HID;\r
	106	UINT32 UID;\r
	107	UINT32 CID;\r
	108	//\r
	109	// Optional variable length _HIDSTR\r
	110	// Optional variable length _UIDSTR\r
	111	//\r
	112	} ACPI_EXTENDED_HID_DEVICE_PATH;\r
	113	\r
	114	//\r
	115	// EISA ID Macro\r
116	// EISA ID Definition 32-bits\r
117	// bits[15:0] - three character compressed ASCII EISA ID.\r
118	// bits[31:16] - binary number\r
119	// Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'\r
120	//\r
121	#define PNP_EISA_ID_CONST 0x41d0\r
122	#define EISA_ID(_Name, _Num) ((UINT32) ((_Name) \| (_Num) << 16))\r
123	#define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))\r
124	#define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))\r
125	\r
126	#define PNP_EISA_ID_MASK 0xffff\r
127	#define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)\r
128	\r
129	\r
130	#define ACPI_ADR_DP 0x03\r
131	typedef struct {\r
132	EFI_DEVICE_PATH_PROTOCOL Header;\r
133	UINT32 ADR;\r
134	} ACPI_ADR_DEVICE_PATH;\r
135	\r
136	\r
137	//\r
138	// Messaging Device Paths\r
139	//\r
140	#define MESSAGING_DEVICE_PATH 0x03\r
141	\r
142	#define MSG_ATAPI_DP 0x01\r
143	typedef struct {\r
144	EFI_DEVICE_PATH_PROTOCOL Header;\r
145	UINT8 PrimarySecondary;\r
146	UINT8 SlaveMaster;\r
147	UINT16 Lun;\r
148	} ATAPI_DEVICE_PATH;\r
149	\r
150	#define MSG_SCSI_DP 0x02\r
151	typedef struct {\r
152	EFI_DEVICE_PATH_PROTOCOL Header;\r
153	UINT16 Pun;\r
154	UINT16 Lun;\r
155	} SCSI_DEVICE_PATH;\r
156	\r
157	#define MSG_FIBRECHANNEL_DP 0x03\r
158	typedef struct {\r
159	EFI_DEVICE_PATH_PROTOCOL Header;\r
160	UINT32 Reserved;\r
161	UINT64 WWN;\r
162	UINT64 Lun;\r
163	} FIBRECHANNEL_DEVICE_PATH;\r
164	\r
165	#define MSG_1394_DP 0x04\r
166	typedef struct {\r
167	EFI_DEVICE_PATH_PROTOCOL Header;\r
168	UINT32 Reserved;\r
169	UINT64 Guid;\r
170	} F1394_DEVICE_PATH;\r
171	\r
172	#define MSG_USB_DP 0x05\r
173	typedef struct {\r
174	EFI_DEVICE_PATH_PROTOCOL Header;\r
175	UINT8 ParentPortNumber;\r
176	UINT8 InterfaceNumber;\r
177	} USB_DEVICE_PATH;\r
178	\r
179	#define MSG_USB_CLASS_DP 0x0f\r
180	typedef struct {\r
181	EFI_DEVICE_PATH_PROTOCOL Header;\r
182	UINT16 VendorId;\r
183	UINT16 ProductId;\r
184	UINT8 DeviceClass;\r
185	UINT8 DeviceSubClass;\r
186	UINT8 DeviceProtocol;\r
187	} USB_CLASS_DEVICE_PATH;\r
188	\r
189	#define MSG_USB_WWID_DP 0x10\r
190	typedef struct {\r
191	EFI_DEVICE_PATH_PROTOCOL Header;\r
192	UINT16 InterfaceNumber;\r
193	UINT16 VendorId;\r
194	UINT16 ProductId;\r
195	// CHAR16 SerialNumber[...];\r
196	} USB_WWID_DEVICE_PATH;\r
197	\r
198	\r
199	#define MSG_DEVICE_LOGICAL_UNIT_DP 0x11\r
200	typedef struct {\r
201	EFI_DEVICE_PATH_PROTOCOL Header;\r
202	UINT8 Lun;\r
203	} DEVICE_LOGICAL_UNIT_DEVICE_PATH;\r
204	\r
00edb218	205	#define MSG_SATA_DP 0x12\r
959ccb23	206	typedef struct {\r
00edb218 A	207	EFI_DEVICE_PATH_PROTOCOL Header;\r
	208	UINT16 HbaPortNumber;\r
	209	UINT16 PortMultiplierPort;\r
	210	UINT16 LogicalUnitNumber;\r
959ccb23	211	} SATA_DEVICE_PATH;\r
	212	\r
	213	#define MSG_I2O_DP 0x06\r
	214	typedef struct {\r
	215	EFI_DEVICE_PATH_PROTOCOL Header;\r
	216	UINT32 Tid;\r
	217	} I2O_DEVICE_PATH;\r
	218	\r
	219	#define MSG_MAC_ADDR_DP 0x0b\r
	220	typedef struct {\r
	221	EFI_DEVICE_PATH_PROTOCOL Header;\r
	222	EFI_MAC_ADDRESS MacAddress;\r
	223	UINT8 IfType;\r
	224	} MAC_ADDR_DEVICE_PATH;\r
	225	\r
	226	#define MSG_IPv4_DP 0x0c\r
	227	typedef struct {\r
	228	EFI_DEVICE_PATH_PROTOCOL Header;\r
	229	EFI_IPv4_ADDRESS LocalIpAddress;\r
	230	EFI_IPv4_ADDRESS RemoteIpAddress;\r
	231	UINT16 LocalPort;\r
	232	UINT16 RemotePort;\r
	233	UINT16 Protocol;\r
	234	BOOLEAN StaticIpAddress;\r
	235	} IPv4_DEVICE_PATH;\r
	236	\r
	237	#define MSG_IPv6_DP 0x0d\r
	238	typedef struct {\r
	239	EFI_DEVICE_PATH_PROTOCOL Header;\r
	240	EFI_IPv6_ADDRESS LocalIpAddress;\r
	241	EFI_IPv6_ADDRESS RemoteIpAddress;\r
	242	UINT16 LocalPort;\r
	243	UINT16 RemotePort;\r
	244	UINT16 Protocol;\r
	245	BOOLEAN StaticIpAddress;\r
	246	} IPv6_DEVICE_PATH;\r
	247	\r
	248	#define MSG_INFINIBAND_DP 0x09\r
	249	typedef struct {\r
	250	EFI_DEVICE_PATH_PROTOCOL Header;\r
	251	UINT32 ResourceFlags;\r
	252	UINT8 PortGid[16];\r
	253	UINT64 ServiceId;\r
	254	UINT64 TargetPortId;\r
	255	UINT64 DeviceId;\r
	256	} INFINIBAND_DEVICE_PATH;\r
	257	\r
	258	#define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01\r
	259	#define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02\r
	260	#define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04\r
	261	#define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08\r
	262	#define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10\r
	263	\r
	264	#define MSG_UART_DP 0x0e\r
	265	typedef struct {\r
	266	EFI_DEVICE_PATH_PROTOCOL Header;\r
	267	UINT32 Reserved;\r
	268	UINT64 BaudRate;\r
	269	UINT8 DataBits;\r
	270	UINT8 Parity;\r
	271	UINT8 StopBits;\r
	272	} UART_DEVICE_PATH;\r
	273	\r
	274	//\r
275	// Use VENDOR_DEVICE_PATH struct\r
276	//\r
277	#define MSG_VENDOR_DP 0x0a\r
00edb218	278	typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH;\r
959ccb23	279	\r
	280	#define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID\r
	281	#define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID\r
	282	#define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID\r
	283	#define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID\r
	284	\r
	285	#define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID\r
	286	\r
	287	typedef struct {\r
	288	EFI_DEVICE_PATH_PROTOCOL Header;\r
	289	EFI_GUID Guid;\r
	290	UINT32 FlowControlMap;\r
	291	} UART_FLOW_CONTROL_DEVICE_PATH;\r
	292	\r
	293	#define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID\r
	294	\r
	295	typedef struct {\r
	296	EFI_DEVICE_PATH_PROTOCOL Header;\r
	297	EFI_GUID Guid;\r
	298	UINT32 Reserved;\r
	299	UINT64 SasAddress;\r
	300	UINT64 Lun;\r
	301	UINT16 DeviceTopology;\r
	302	UINT16 RelativeTargetPort;\r
	303	} SAS_DEVICE_PATH;\r
	304	\r
	305	#define MSG_ISCSI_DP 0x13\r
	306	typedef struct {\r
	307	EFI_DEVICE_PATH_PROTOCOL Header;\r
	308	UINT16 NetworkProtocol;\r
	309	UINT16 LoginOption;\r
	310	UINT16 Reserved;\r
	311	UINT16 TargetPortalGroupTag;\r
	312	UINT64 LUN;\r
	313	// CHAR8 iSCSI Target Name\r
	314	} ISCSI_DEVICE_PATH;\r
	315	\r
	316	#define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000\r
	317	#define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002\r
	318	#define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000\r
	319	#define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008\r
	320	#define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000\r
	321	#define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000\r
	322	#define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000\r
	323	#define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000\r
	324	\r
	325	//\r
	326	// Media Device Path\r
	327	//\r
	328	#define MEDIA_DEVICE_PATH 0x04\r
	329	\r
	330	#define MEDIA_HARDDRIVE_DP 0x01\r
	331	typedef struct {\r
	332	EFI_DEVICE_PATH_PROTOCOL Header;\r
	333	UINT32 PartitionNumber;\r
	334	UINT64 PartitionStart;\r
	335	UINT64 PartitionSize;\r
	336	UINT8 Signature[16];\r
	337	UINT8 MBRType;\r
	338	UINT8 SignatureType;\r
	339	} HARDDRIVE_DEVICE_PATH;\r
	340	\r
	341	#define MBR_TYPE_PCAT 0x01\r
	342	#define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02\r
343	\r
344	#define SIGNATURE_TYPE_MBR 0x01\r
345	#define SIGNATURE_TYPE_GUID 0x02\r
346	\r
347	#define MEDIA_CDROM_DP 0x02\r
348	typedef struct {\r
349	EFI_DEVICE_PATH_PROTOCOL Header;\r
350	UINT32 BootEntry;\r
351	UINT64 PartitionStart;\r
352	UINT64 PartitionSize;\r
353	} CDROM_DEVICE_PATH;\r
354	\r
355	//\r
356	// Use VENDOR_DEVICE_PATH struct\r
357	//\r
358	#define MEDIA_VENDOR_DP 0x03\r
359	\r
360	#define MEDIA_FILEPATH_DP 0x04\r
361	typedef struct {\r
362	EFI_DEVICE_PATH_PROTOCOL Header;\r
363	CHAR16 PathName[1];\r
364	} FILEPATH_DEVICE_PATH;\r
365	\r
146332ae	366	#define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)\r
959ccb23	367	\r
	368	#define MEDIA_PROTOCOL_DP 0x05\r
	369	typedef struct {\r
	370	EFI_DEVICE_PATH_PROTOCOL Header;\r
	371	EFI_GUID Protocol;\r
	372	} MEDIA_PROTOCOL_DEVICE_PATH;\r
	373	\r
	374	\r
00edb218	375	#define MEDIA_PIWG_FW_VOL_DP 0x6\r
146332ae	376	typedef struct {\r
	377	EFI_DEVICE_PATH_PROTOCOL Header;\r
	378	EFI_GUID FvName;\r
	379	} MEDIA_FW_VOL_DEVICE_PATH;\r
959ccb23	380	\r
959ccb23	381	\r
00edb218	382	#define MEDIA_PIWG_FW_FILE_DP 0x7\r
146332ae	383	typedef struct {\r
	384	EFI_DEVICE_PATH_PROTOCOL Header;\r
	385	EFI_GUID FvFileName;\r
	386	} MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;\r
959ccb23	387	\r
	388	//\r
	389	// BBS Device Path\r
	390	//\r
	391	#define BBS_DEVICE_PATH 0x05\r
	392	#define BBS_BBS_DP 0x01\r
	393	typedef struct {\r
	394	EFI_DEVICE_PATH_PROTOCOL Header;\r
	395	UINT16 DeviceType;\r
	396	UINT16 StatusFlag;\r
	397	CHAR8 String[1];\r
	398	} BBS_BBS_DEVICE_PATH;\r
	399	\r
	400	//\r
	401	// DeviceType definitions - from BBS specification\r
	402	//\r
	403	#define BBS_TYPE_FLOPPY 0x01\r
	404	#define BBS_TYPE_HARDDRIVE 0x02\r
	405	#define BBS_TYPE_CDROM 0x03\r
	406	#define BBS_TYPE_PCMCIA 0x04\r
	407	#define BBS_TYPE_USB 0x05\r
	408	#define BBS_TYPE_EMBEDDED_NETWORK 0x06\r
	409	#define BBS_TYPE_BEV 0x80\r
	410	#define BBS_TYPE_UNKNOWN 0xFF\r
	411	\r
	412	\r
	413	//\r
	414	// Union of all possible Device Paths and pointers to Device Paths\r
	415	//\r
	416	\r
	417	typedef union {\r
	418	EFI_DEVICE_PATH_PROTOCOL DevPath;\r
	419	PCI_DEVICE_PATH Pci;\r
	420	PCCARD_DEVICE_PATH PcCard;\r
	421	MEMMAP_DEVICE_PATH MemMap;\r
	422	VENDOR_DEVICE_PATH Vendor;\r
	423	\r
	424	CONTROLLER_DEVICE_PATH Controller;\r
	425	ACPI_HID_DEVICE_PATH Acpi;\r
	426	\r
	427	ATAPI_DEVICE_PATH Atapi;\r
	428	SCSI_DEVICE_PATH Scsi;\r
	429	FIBRECHANNEL_DEVICE_PATH FibreChannel;\r
	430	\r
	431	F1394_DEVICE_PATH F1394;\r
	432	USB_DEVICE_PATH Usb;\r
	433	SATA_DEVICE_PATH Sata;\r
	434	USB_CLASS_DEVICE_PATH UsbClass;\r
	435	I2O_DEVICE_PATH I2O;\r
	436	MAC_ADDR_DEVICE_PATH MacAddr;\r
	437	IPv4_DEVICE_PATH Ipv4;\r
	438	IPv6_DEVICE_PATH Ipv6;\r
	439	INFINIBAND_DEVICE_PATH InfiniBand;\r
	440	UART_DEVICE_PATH Uart;\r
	441	\r
	442	HARDDRIVE_DEVICE_PATH HardDrive;\r
	443	CDROM_DEVICE_PATH CD;\r
	444	\r
	445	FILEPATH_DEVICE_PATH FilePath;\r
	446	MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol;\r
	447	\r
	448	BBS_BBS_DEVICE_PATH Bbs;\r
	449	} EFI_DEV_PATH;\r
	450	\r
451	\r
452	\r
453	typedef union {\r
454	EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
455	PCI_DEVICE_PATH *Pci;\r
456	PCCARD_DEVICE_PATH *PcCard;\r
457	MEMMAP_DEVICE_PATH *MemMap;\r
458	VENDOR_DEVICE_PATH *Vendor;\r
459	\r
460	CONTROLLER_DEVICE_PATH *Controller;\r
461	ACPI_HID_DEVICE_PATH *Acpi;\r
462	ACPI_EXTENDED_HID_DEVICE_PATH *ExtendedAcpi;\r
463	\r
464	ATAPI_DEVICE_PATH *Atapi;\r
465	SCSI_DEVICE_PATH *Scsi;\r
466	FIBRECHANNEL_DEVICE_PATH *FibreChannel;\r
467	\r
468	F1394_DEVICE_PATH *F1394;\r
469	USB_DEVICE_PATH *Usb;\r
470	SATA_DEVICE_PATH *Sata;\r
471	USB_CLASS_DEVICE_PATH *UsbClass;\r
472	I2O_DEVICE_PATH *I2O;\r
473	MAC_ADDR_DEVICE_PATH *MacAddr;\r
474	IPv4_DEVICE_PATH *Ipv4;\r
475	IPv6_DEVICE_PATH *Ipv6;\r
476	INFINIBAND_DEVICE_PATH *InfiniBand;\r
477	UART_DEVICE_PATH *Uart;\r
478	\r
479	HARDDRIVE_DEVICE_PATH *HardDrive;\r
480	CDROM_DEVICE_PATH *CD;\r
481	\r
482	FILEPATH_DEVICE_PATH *FilePath;\r
483	MEDIA_PROTOCOL_DEVICE_PATH *MediaProtocol;\r
484	\r
485	BBS_BBS_DEVICE_PATH *Bbs;\r
486	UINT8 *Raw;\r
487	} EFI_DEV_PATH_PTR;\r
488	\r
489	#pragma pack()\r
d1f95000	490	\r
	491	#define EFI_DP_TYPE_MASK 0x7F\r
	492	#define EFI_DP_TYPE_UNPACKED 0x80\r
	493	#define END_DEVICE_PATH_TYPE 0x7f\r
	494	\r
	495	#define EFI_END_ENTIRE_DEVICE_PATH 0xff\r
	496	#define EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff\r
	497	#define EFI_END_INSTANCE_DEVICE_PATH 0x01\r
	498	#define END_ENTIRE_DEVICE_PATH_SUBTYPE EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE\r
	499	#define END_INSTANCE_DEVICE_PATH_SUBTYPE EFI_END_INSTANCE_DEVICE_PATH\r
	500	\r
	501	#define EFI_END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))\r
	502	#define END_DEVICE_PATH_LENGTH EFI_END_DEVICE_PATH_LENGTH\r
	503	\r
	504	#define DP_IS_END_TYPE(a) \r
	505	#define DP_IS_END_SUBTYPE(a) (((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE)\r
	506	#define DevicePathSubType(a) ((a)->SubType)\r
	507	#define IsDevicePathUnpacked(a) ((a)->Type & EFI_DP_TYPE_UNPACKED)\r
	508	\r
	509	#define EfiDevicePathNodeLength(a) (((a)->Length[0]) \| ((a)->Length[1] << 8))\r
	510	#define DevicePathNodeLength(a) (EfiDevicePathNodeLength(a))\r
	511	#define EfiNextDevicePathNode(a) ((EFI_DEVICE_PATH_PROTOCOL ) (((UINT8 ) (a)) + EfiDevicePathNodeLength (a)))\r
	512	#define NextDevicePathNode(a) (EfiNextDevicePathNode(a)) \r
	513	\r
	514	#define EfiDevicePathType(a) (((a)->Type) & EFI_DP_TYPE_MASK)\r
	515	#define DevicePathType(a) (EfiDevicePathType(a))\r
	516	#define EfiIsDevicePathEndType(a) (EfiDevicePathType (a) == END_DEVICE_PATH_TYPE)\r
	517	#define IsDevicePathEndType(a) (EfiIsDevicePathEndType(a)) \r
	518	\r
	519	\r
	520	#define EfiIsDevicePathEndSubType(a) ((a)->SubType == EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE)\r
	521	#define IsDevicePathEndSubType(a) (EfiIsDevicePathEndSubType(a))\r
	522	#define EfiIsDevicePathEndInstanceSubType(a) ((a)->SubType == EFI_END_INSTANCE_DEVICE_PATH)\r
	523	\r
	524	#define EfiIsDevicePathEnd(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndSubType (a))\r
	525	#define IsDevicePathEnd(a) (EfiIsDevicePathEnd(a))\r
	526	#define EfiIsDevicePathEndInstance(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndInstanceSubType (a))\r
	527	\r
	528	\r
	529	#define SetDevicePathNodeLength(a,l) { \\r
	530	(a)->Length[0] = (UINT8) (l); \\r
	531	(a)->Length[1] = (UINT8) ((l) >> 8); \\r
	532	}\r
	533	\r
	534	#define SetDevicePathEndNode(a) { \\r
	535	(a)->Type = END_DEVICE_PATH_TYPE; \\r
	536	(a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \\r
	537	(a)->Length[0] = sizeof(EFI_DEVICE_PATH_PROTOCOL); \\r
	538	(a)->Length[1] = 0; \\r
	539	}\r
	540	\r
	541	extern EFI_GUID gEfiDevicePathProtocolGuid;\r
959ccb23	542	\r
959ccb23	543	#endif\r