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

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