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