MdePkg/Include/Protocol/DevicePath.h

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