MdePkg/Include/Uefi/UefiDevicePath.h

   1 /* @file
   2   Device Path definitions introduced in UEFI.
   3
   4   This include file must only contain things defined in the UEFI 2.0 specification.
   5   If a code construct is defined in the UEFI 2.0 specification it must be included
   6   by this include file.
   7
   8   Copyright (c) 2006 - 2007, 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   Module Name:    UefiDevicePath.h
  18
  19 **/
  20
  21 #ifndef __UEFI_DEVICE_PATH_H__
  22 #define __UEFI_DEVICE_PATH_H__
  23
  24 //
  25 // Device Path information
  26 //
  27
  28 #pragma pack(1)
  29
  30 //
  31 // Hardware Device Paths
  32 //
  33 #define HARDWARE_DEVICE_PATH      0x01
  34
  35 #define HW_PCI_DP                 0x01
  36 typedef struct {
  37   EFI_DEVICE_PATH_PROTOCOL        Header;
  38   UINT8                           Function;
  39   UINT8                           Device;
  40 } PCI_DEVICE_PATH;
  41
  42 #define HW_PCCARD_DP              0x02
  43 typedef struct {
  44   EFI_DEVICE_PATH_PROTOCOL        Header;
  45   UINT8                           FunctionNumber;
  46 } PCCARD_DEVICE_PATH;
  47
  48 #define HW_MEMMAP_DP              0x03
  49 typedef struct {
  50   EFI_DEVICE_PATH_PROTOCOL        Header;
  51   UINT32                          MemoryType;
  52   EFI_PHYSICAL_ADDRESS            StartingAddress;
  53   EFI_PHYSICAL_ADDRESS            EndingAddress;
  54 } MEMMAP_DEVICE_PATH;
  55
  56 #define HW_VENDOR_DP              0x04
  57 typedef struct {
  58   EFI_DEVICE_PATH_PROTOCOL        Header;
  59   EFI_GUID                        Guid;
  60 } VENDOR_DEVICE_PATH;
  61
  62 #define HW_CONTROLLER_DP          0x05
  63 typedef struct {
  64   EFI_DEVICE_PATH_PROTOCOL        Header;
  65   UINT32                          ControllerNumber;
  66 } CONTROLLER_DEVICE_PATH;
  67
  68 //
  69 // ACPI Device Paths
  70 //
  71 #define ACPI_DEVICE_PATH          0x02
  72
  73 #define ACPI_DP                   0x01
  74 typedef struct {
  75   EFI_DEVICE_PATH_PROTOCOL        Header;
  76   UINT32                          HID;
  77   UINT32                          UID;
  78 } ACPI_HID_DEVICE_PATH;
  79
  80 #define ACPI_EXTENDED_DP          0x02
  81 typedef struct {
  82   EFI_DEVICE_PATH_PROTOCOL        Header;
  83   UINT32                          HID;
  84   UINT32                          UID;
  85   UINT32                          CID;
  86   //
  87   // Optional variable length _HIDSTR
  88   // Optional variable length _UIDSTR
  89   //
  90 } ACPI_EXTENDED_HID_DEVICE_PATH;
  91
  92 //
  93 //  EISA ID Macro
  94 //  EISA ID Definition 32-bits
  95 //   bits[15:0] - three character compressed ASCII EISA ID.
  96 //   bits[31:16] - binary number
  97 //    Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
  98 //
  99 #define PNP_EISA_ID_CONST         0x41d0
 100 #define EISA_ID(_Name, _Num)      ((UINT32) ((_Name) | (_Num) << 16))
 101 #define EISA_PNP_ID(_PNPId)       (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
 102 #define EFI_PNP_ID(_PNPId)        (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
 103
 104 #define PNP_EISA_ID_MASK          0xffff
 105 #define EISA_ID_TO_NUM(_Id)       ((_Id) >> 16)
 106
 107
 108 #define ACPI_ADR_DP               0x03
 109 typedef struct {
 110   EFI_DEVICE_PATH_PROTOCOL        Header;
 111   UINT32                          ADR;
 112 } ACPI_ADR_DEVICE_PATH;
 113
 114
 115 //
 116 // Messaging Device Paths
 117 //
 118 #define MESSAGING_DEVICE_PATH     0x03
 119
 120 #define MSG_ATAPI_DP              0x01
 121 typedef struct {
 122   EFI_DEVICE_PATH_PROTOCOL        Header;
 123   UINT8                           PrimarySecondary;
 124   UINT8                           SlaveMaster;
 125   UINT16                          Lun;
 126 } ATAPI_DEVICE_PATH;
 127
 128 #define MSG_SCSI_DP               0x02
 129 typedef struct {
 130   EFI_DEVICE_PATH_PROTOCOL        Header;
 131   UINT16                          Pun;
 132   UINT16                          Lun;
 133 } SCSI_DEVICE_PATH;
 134
 135 #define MSG_FIBRECHANNEL_DP       0x03
 136 typedef struct {
 137   EFI_DEVICE_PATH_PROTOCOL        Header;
 138   UINT32                          Reserved;
 139   UINT64                          WWN;
 140   UINT64                          Lun;
 141 } FIBRECHANNEL_DEVICE_PATH;
 142
 143 #define MSG_1394_DP               0x04
 144 typedef struct {
 145   EFI_DEVICE_PATH_PROTOCOL        Header;
 146   UINT32                          Reserved;
 147   UINT64                          Guid;
 148 } F1394_DEVICE_PATH;
 149
 150 #define MSG_USB_DP                0x05
 151 typedef struct {
 152     EFI_DEVICE_PATH_PROTOCOL      Header;
 153     UINT8                         ParentPortNumber;
 154     UINT8                         InterfaceNumber;
 155 } USB_DEVICE_PATH;
 156
 157 #define MSG_USB_CLASS_DP          0x0f
 158 typedef struct {
 159     EFI_DEVICE_PATH_PROTOCOL      Header;
 160     UINT16                        VendorId;
 161     UINT16                        ProductId;
 162     UINT8                         DeviceClass;
 163     UINT8                         DeviceSubClass;
 164     UINT8                         DeviceProtocol;
 165 } USB_CLASS_DEVICE_PATH;
 166
 167 #define MSG_USB_WWID_DP           0x10
 168 typedef struct {
 169     EFI_DEVICE_PATH_PROTOCOL      Header;
 170     UINT16                        InterfaceNumber;
 171     UINT16                        VendorId;
 172     UINT16                        ProductId;
 173     // CHAR16                     SerialNumber[...];
 174 } USB_WWID_DEVICE_PATH;
 175
 176
 177 #define MSG_DEVICE_LOGICAL_UNIT_DP  0x11
 178 typedef struct {
 179     EFI_DEVICE_PATH_PROTOCOL      Header;
 180     UINT8                         Lun;
 181 } DEVICE_LOGICAL_UNIT_DEVICE_PATH;
 182
 183 #define MSG_SATA_DP                                                             0x12
 184 typedef struct {
 185         EFI_DEVICE_PATH_PROTOCOL        Header;
 186         UINT16                                                                                                  HbaPortNumber;
 187         UINT16                          PortMultiplierPort;
 188         UINT16                          LogicalUnitNumber;
 189 } SATA_DEVICE_PATH;
 190
 191 #define MSG_I2O_DP                0x06
 192 typedef struct {
 193   EFI_DEVICE_PATH_PROTOCOL        Header;
 194   UINT32                          Tid;
 195 } I2O_DEVICE_PATH;
 196
 197 #define MSG_MAC_ADDR_DP           0x0b
 198 typedef struct {
 199   EFI_DEVICE_PATH_PROTOCOL        Header;
 200   EFI_MAC_ADDRESS                 MacAddress;
 201   UINT8                           IfType;
 202 } MAC_ADDR_DEVICE_PATH;
 203
 204 #define MSG_IPv4_DP               0x0c
 205 typedef struct {
 206   EFI_DEVICE_PATH_PROTOCOL        Header;
 207   EFI_IPv4_ADDRESS                LocalIpAddress;
 208   EFI_IPv4_ADDRESS                RemoteIpAddress;
 209   UINT16                          LocalPort;
 210   UINT16                          RemotePort;
 211   UINT16                          Protocol;
 212   BOOLEAN                         StaticIpAddress;
 213 } IPv4_DEVICE_PATH;
 214
 215 #define MSG_IPv6_DP               0x0d
 216 typedef struct {
 217   EFI_DEVICE_PATH_PROTOCOL        Header;
 218   EFI_IPv6_ADDRESS                LocalIpAddress;
 219   EFI_IPv6_ADDRESS                RemoteIpAddress;
 220   UINT16                          LocalPort;
 221   UINT16                          RemotePort;
 222   UINT16                          Protocol;
 223   BOOLEAN                         StaticIpAddress;
 224 } IPv6_DEVICE_PATH;
 225
 226 #define MSG_INFINIBAND_DP         0x09
 227 typedef struct {
 228   EFI_DEVICE_PATH_PROTOCOL        Header;
 229   UINT32                          ResourceFlags;
 230   UINT8                           PortGid[16];
 231   UINT64                          ServiceId;
 232   UINT64                          TargetPortId;
 233   UINT64                          DeviceId;
 234 } INFINIBAND_DEVICE_PATH;
 235
 236 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE                0x01
 237 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT  0x02
 238 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL           0x04
 239 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL           0x08
 240 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL           0x10
 241
 242 #define MSG_UART_DP               0x0e
 243 typedef struct {
 244   EFI_DEVICE_PATH_PROTOCOL        Header;
 245   UINT32                          Reserved;
 246   UINT64                          BaudRate;
 247   UINT8                           DataBits;
 248   UINT8                           Parity;
 249   UINT8                           StopBits;
 250 } UART_DEVICE_PATH;
 251
 252 //
 253 // Use VENDOR_DEVICE_PATH struct
 254 //
 255 #define MSG_VENDOR_DP             0x0a
 256 typedef VENDOR_DEVICE_PATH                              VENDOR_DEFINED_DEVICE_PATH;
 257
 258 #define DEVICE_PATH_MESSAGING_PC_ANSI     EFI_PC_ANSI_GUID
 259 #define DEVICE_PATH_MESSAGING_VT_100      EFI_VT_100_GUID
 260 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
 261 #define DEVICE_PATH_MESSAGING_VT_UTF8     EFI_VT_UTF8_GUID
 262
 263 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL   EFI_UART_DEVICE_PATH_GUID
 264
 265 typedef struct {
 266   EFI_DEVICE_PATH_PROTOCOL        Header;
 267   EFI_GUID                        Guid;
 268   UINT32                          FlowControlMap;
 269 } UART_FLOW_CONTROL_DEVICE_PATH;
 270
 271 #define DEVICE_PATH_MESSAGING_SAS                 EFI_SAS_DEVICE_PATH_GUID
 272
 273 typedef struct {
 274   EFI_DEVICE_PATH_PROTOCOL        Header;
 275   EFI_GUID                        Guid;
 276   UINT32                          Reserved;
 277   UINT64                          SasAddress;
 278   UINT64                          Lun;
 279   UINT16                          DeviceTopology;
 280   UINT16                          RelativeTargetPort;
 281 } SAS_DEVICE_PATH;
 282
 283 #define MSG_ISCSI_DP              0x13
 284 typedef struct {
 285   EFI_DEVICE_PATH_PROTOCOL        Header;
 286   UINT16                          NetworkProtocol;
 287   UINT16                          LoginOption;
 288   UINT16                          Reserved;
 289   UINT16                          TargetPortalGroupTag;
 290   UINT64                          LUN;
 291   // CHAR8                        iSCSI Target Name
 292 } ISCSI_DEVICE_PATH;
 293
 294 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST             0x0000
 295 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C   0x0002
 296 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST               0x0000
 297 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C     0x0008
 298 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP              0x0000
 299 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON               0x1000
 300 #define ISCSI_LOGIN_OPTION_CHAP_BI                      0x0000
 301 #define ISCSI_LOGIN_OPTION_CHAP_UNI                     0x2000
 302
 303 //
 304 // Media Device Path
 305 //
 306 #define MEDIA_DEVICE_PATH         0x04
 307
 308 #define MEDIA_HARDDRIVE_DP        0x01
 309 typedef struct {
 310   EFI_DEVICE_PATH_PROTOCOL        Header;
 311   UINT32                          PartitionNumber;
 312   UINT64                          PartitionStart;
 313   UINT64                          PartitionSize;
 314   UINT8                           Signature[16];
 315   UINT8                           MBRType;
 316   UINT8                           SignatureType;
 317 } HARDDRIVE_DEVICE_PATH;
 318
 319 #define MBR_TYPE_PCAT             0x01
 320 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
 321
 322 #define SIGNATURE_TYPE_MBR        0x01
 323 #define SIGNATURE_TYPE_GUID       0x02
 324
 325 #define MEDIA_CDROM_DP            0x02
 326 typedef struct {
 327   EFI_DEVICE_PATH_PROTOCOL        Header;
 328   UINT32                          BootEntry;
 329   UINT64                          PartitionStart;
 330   UINT64                          PartitionSize;
 331 } CDROM_DEVICE_PATH;
 332
 333 //
 334 // Use VENDOR_DEVICE_PATH struct
 335 //
 336 #define MEDIA_VENDOR_DP           0x03
 337
 338 #define MEDIA_FILEPATH_DP         0x04
 339 typedef struct {
 340   EFI_DEVICE_PATH_PROTOCOL        Header;
 341   CHAR16                          PathName[1];
 342 } FILEPATH_DEVICE_PATH;
 343
 344 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
 345
 346 #define MEDIA_PROTOCOL_DP         0x05
 347 typedef struct {
 348   EFI_DEVICE_PATH_PROTOCOL        Header;
 349   EFI_GUID                        Protocol;
 350 } MEDIA_PROTOCOL_DEVICE_PATH;
 351
 352
 353 #define MEDIA_PIWG_FW_VOL_DP                    0x6
 354 typedef MEDIA_PROTOCOL_DEVICE_PATH MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;
 355
 356
 357 #define MEDIA_PIWG_FW_FILE_DP                   0x7
 358 typedef MEDIA_PROTOCOL_DEVICE_PATH MEDIA_FW_VOL_DEVICE_PATH;
 359
 360 //
 361 // BBS Device Path
 362 //
 363 #define BBS_DEVICE_PATH           0x05
 364 #define BBS_BBS_DP                0x01
 365 typedef struct {
 366   EFI_DEVICE_PATH_PROTOCOL        Header;
 367   UINT16                          DeviceType;
 368   UINT16                          StatusFlag;
 369   CHAR8                           String[1];
 370 } BBS_BBS_DEVICE_PATH;
 371
 372 //
 373 // DeviceType definitions - from BBS specification
 374 //
 375 #define BBS_TYPE_FLOPPY           0x01
 376 #define BBS_TYPE_HARDDRIVE        0x02
 377 #define BBS_TYPE_CDROM            0x03
 378 #define BBS_TYPE_PCMCIA           0x04
 379 #define BBS_TYPE_USB              0x05
 380 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
 381 #define BBS_TYPE_BEV              0x80
 382 #define BBS_TYPE_UNKNOWN          0xFF
 383
 384
 385 //
 386 // Union of all possible Device Paths and pointers to Device Paths
 387 //
 388
 389 typedef union {
 390   EFI_DEVICE_PATH_PROTOCOL             DevPath;
 391   PCI_DEVICE_PATH                      Pci;
 392   PCCARD_DEVICE_PATH                   PcCard;
 393   MEMMAP_DEVICE_PATH                   MemMap;
 394   VENDOR_DEVICE_PATH                   Vendor;
 395
 396   CONTROLLER_DEVICE_PATH               Controller;
 397   ACPI_HID_DEVICE_PATH                 Acpi;
 398
 399   ATAPI_DEVICE_PATH                    Atapi;
 400   SCSI_DEVICE_PATH                     Scsi;
 401   FIBRECHANNEL_DEVICE_PATH             FibreChannel;
 402
 403   F1394_DEVICE_PATH                    F1394;
 404   USB_DEVICE_PATH                      Usb;
 405   SATA_DEVICE_PATH                     Sata;
 406   USB_CLASS_DEVICE_PATH                UsbClass;
 407   I2O_DEVICE_PATH                      I2O;
 408   MAC_ADDR_DEVICE_PATH                 MacAddr;
 409   IPv4_DEVICE_PATH                     Ipv4;
 410   IPv6_DEVICE_PATH                     Ipv6;
 411   INFINIBAND_DEVICE_PATH               InfiniBand;
 412   UART_DEVICE_PATH                     Uart;
 413
 414   HARDDRIVE_DEVICE_PATH                HardDrive;
 415   CDROM_DEVICE_PATH                    CD;
 416
 417   FILEPATH_DEVICE_PATH                 FilePath;
 418   MEDIA_PROTOCOL_DEVICE_PATH           MediaProtocol;
 419
 420   BBS_BBS_DEVICE_PATH                  Bbs;
 421 } EFI_DEV_PATH;
 422
 423
 424
 425 typedef union {
 426   EFI_DEVICE_PATH_PROTOCOL             *DevPath;
 427   PCI_DEVICE_PATH                      *Pci;
 428   PCCARD_DEVICE_PATH                   *PcCard;
 429   MEMMAP_DEVICE_PATH                   *MemMap;
 430   VENDOR_DEVICE_PATH                   *Vendor;
 431
 432   CONTROLLER_DEVICE_PATH               *Controller;
 433   ACPI_HID_DEVICE_PATH                 *Acpi;
 434   ACPI_EXTENDED_HID_DEVICE_PATH        *ExtendedAcpi;
 435
 436   ATAPI_DEVICE_PATH                    *Atapi;
 437   SCSI_DEVICE_PATH                     *Scsi;
 438   FIBRECHANNEL_DEVICE_PATH             *FibreChannel;
 439
 440   F1394_DEVICE_PATH                    *F1394;
 441   USB_DEVICE_PATH                      *Usb;
 442   SATA_DEVICE_PATH                     *Sata;
 443   USB_CLASS_DEVICE_PATH                *UsbClass;
 444   I2O_DEVICE_PATH                      *I2O;
 445   MAC_ADDR_DEVICE_PATH                 *MacAddr;
 446   IPv4_DEVICE_PATH                     *Ipv4;
 447   IPv6_DEVICE_PATH                     *Ipv6;
 448   INFINIBAND_DEVICE_PATH               *InfiniBand;
 449   UART_DEVICE_PATH                     *Uart;
 450
 451   HARDDRIVE_DEVICE_PATH                *HardDrive;
 452   CDROM_DEVICE_PATH                    *CD;
 453
 454   FILEPATH_DEVICE_PATH                 *FilePath;
 455   MEDIA_PROTOCOL_DEVICE_PATH           *MediaProtocol;
 456
 457   BBS_BBS_DEVICE_PATH                  *Bbs;
 458   UINT8                                *Raw;
 459 } EFI_DEV_PATH_PTR;
 460
 461 #pragma pack()
 462
 463
 464 #endif
 465
 466