usr/src/boot/sys/boot/efi/include/efidevp.h

   1 #ifndef _DEVPATH_H
   2 #define _DEVPATH_H
   3
   4 /*++
   5
   6 Copyright (c)  1999 - 2002 Intel Corporation. All rights reserved
   7 This software and associated documentation (if any) is furnished
   8 under a license and may only be used or copied in accordance
   9 with the terms of the license. Except as permitted by such
  10 license, no part of this software or documentation may be
  11 reproduced, stored in a retrieval system, or transmitted in any
  12 form or by any means without the express written consent of
  13 Intel Corporation.
  14
  15 Module Name:
  16
  17     devpath.h
  18
  19 Abstract:
  20
  21     Defines for parsing the EFI Device Path structures
  22
  23
  24
  25 Revision History
  26
  27 --*/
  28
  29 //
  30 // Device Path structures - Section C
  31 //
  32
  33 #pragma pack(1)
  34
  35 typedef struct _EFI_DEVICE_PATH {
  36         UINT8                           Type;
  37         UINT8                           SubType;
  38         UINT8                           Length[2];
  39 } EFI_DEVICE_PATH;
  40
  41 #define EFI_DP_TYPE_MASK                    0x7F
  42 #define EFI_DP_TYPE_UNPACKED                0x80
  43
  44 #define END_DEVICE_PATH_TYPE                0x7f
  45
  46 #define END_ENTIRE_DEVICE_PATH_SUBTYPE      0xff
  47 #define END_INSTANCE_DEVICE_PATH_SUBTYPE    0x01
  48 #define END_DEVICE_PATH_LENGTH              (sizeof(EFI_DEVICE_PATH))
  49
  50
  51 #define DP_IS_END_TYPE(a)
  52 #define DP_IS_END_SUBTYPE(a)        ( ((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
  53
  54 #define DevicePathType(a)           ( ((a)->Type) & EFI_DP_TYPE_MASK )
  55 #define DevicePathSubType(a)        ( (a)->SubType )
  56 #define DevicePathNodeLength(a)     ((size_t)(((a)->Length[0]) | ((a)->Length[1] << 8)))
  57 #define NextDevicePathNode(a)       ( (EFI_DEVICE_PATH *) ( ((UINT8 *) (a)) + DevicePathNodeLength(a)))
  58 #define IsDevicePathType(a, t)      ( DevicePathType(a) == t )
  59 #define IsDevicePathEndType(a)      IsDevicePathType(a, END_DEVICE_PATH_TYPE)
  60 #define IsDevicePathEndSubType(a)   ( (a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
  61 #define IsDevicePathEnd(a)          ( IsDevicePathEndType(a) && IsDevicePathEndSubType(a) )
  62 #define IsDevicePathUnpacked(a)     ( (a)->Type & EFI_DP_TYPE_UNPACKED )
  63
  64
  65 #define SetDevicePathNodeLength(a,l) {                  \
  66             (a)->Length[0] = (UINT8) (l);               \
  67             (a)->Length[1] = (UINT8) ((l) >> 8);        \
  68             }
  69
  70 #define SetDevicePathEndNode(a)  {                      \
  71             (a)->Type = END_DEVICE_PATH_TYPE;           \
  72             (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE;     \
  73             (a)->Length[0] = sizeof(EFI_DEVICE_PATH);   \
  74             (a)->Length[1] = 0;                         \
  75             }
  76
  77 /*
  78  *
  79  */
  80 #define HARDWARE_DEVICE_PATH            0x01
  81
  82 #define HW_PCI_DP                       0x01
  83 typedef struct _PCI_DEVICE_PATH {
  84         EFI_DEVICE_PATH                 Header;
  85         UINT8                           Function;
  86         UINT8                           Device;
  87 } PCI_DEVICE_PATH;
  88
  89 #define HW_PCCARD_DP                    0x02
  90 typedef struct _PCCARD_DEVICE_PATH {
  91         EFI_DEVICE_PATH                 Header;
  92         UINT8                           FunctionNumber;
  93 } PCCARD_DEVICE_PATH;
  94
  95 #define HW_MEMMAP_DP                    0x03
  96 typedef struct _MEMMAP_DEVICE_PATH {
  97         EFI_DEVICE_PATH                 Header;
  98         UINT32                          MemoryType;
  99         EFI_PHYSICAL_ADDRESS            StartingAddress;
 100         EFI_PHYSICAL_ADDRESS            EndingAddress;
 101 } MEMMAP_DEVICE_PATH;
 102
 103 #define HW_VENDOR_DP                    0x04
 104 typedef struct _VENDOR_DEVICE_PATH {
 105         EFI_DEVICE_PATH                 Header;
 106         EFI_GUID                        Guid;
 107 } VENDOR_DEVICE_PATH;
 108
 109 #define UNKNOWN_DEVICE_GUID \
 110     { 0xcf31fac5, 0xc24e, 0x11d2, {0x85, 0xf3, 0x0, 0xa0, 0xc9, 0x3e, 0xc9, 0x3b} }
 111
 112 typedef struct _UKNOWN_DEVICE_VENDOR_DP {
 113     VENDOR_DEVICE_PATH      DevicePath;
 114     UINT8                   LegacyDriveLetter;
 115 } UNKNOWN_DEVICE_VENDOR_DEVICE_PATH;
 116
 117 #define HW_CONTROLLER_DP            0x05
 118 typedef struct _CONTROLLER_DEVICE_PATH {
 119         EFI_DEVICE_PATH     Header;
 120         UINT32              Controller;
 121 } CONTROLLER_DEVICE_PATH;
 122
 123 /*
 124  *
 125  */
 126 #define ACPI_DEVICE_PATH                 0x02
 127
 128 #define ACPI_DP                         0x01
 129 typedef struct _ACPI_HID_DEVICE_PATH {
 130         EFI_DEVICE_PATH                 Header;
 131         UINT32                          HID;
 132         UINT32                          UID;
 133 } ACPI_HID_DEVICE_PATH;
 134
 135 #define ACPI_EXTENDED_DP          0x02
 136 typedef struct _ACPI_EXTENDED_HID_DEVICE_PATH {
 137   EFI_DEVICE_PATH                 Header;
 138   UINT32                          HID;
 139   UINT32                          UID;
 140   UINT32                          CID;
 141 } ACPI_EXTENDED_HID_DEVICE_PATH;
 142
 143 //
 144 // EISA ID Macro
 145 // EISA ID Definition 32-bits
 146 //  bits[15:0] - three character compressed ASCII EISA ID.
 147 //  bits[31:16] - binary number
 148 //   Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
 149 //
 150 #define PNP_EISA_ID_CONST       0x41d0
 151 #define EISA_ID(_Name, _Num)    ((UINT32) ((_Name) | (_Num) << 16))
 152 #define EISA_PNP_ID(_PNPId)     (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
 153 #define EFI_PNP_ID(_PNPId)      (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
 154
 155 #define PNP_EISA_ID_MASK        0xffff
 156 #define EISA_ID_TO_NUM(_Id)     ((_Id) >> 16)
 157 /*
 158  *
 159  */
 160 #define MESSAGING_DEVICE_PATH           0x03
 161
 162 #define MSG_ATAPI_DP                    0x01
 163 typedef struct _ATAPI_DEVICE_PATH {
 164         EFI_DEVICE_PATH                 Header;
 165         UINT8                           PrimarySecondary;
 166         UINT8                           SlaveMaster;
 167         UINT16                          Lun;
 168 } ATAPI_DEVICE_PATH;
 169
 170 #define MSG_SCSI_DP                     0x02
 171 typedef struct _SCSI_DEVICE_PATH {
 172         EFI_DEVICE_PATH                 Header;
 173         UINT16                          Pun;
 174         UINT16                          Lun;
 175 } SCSI_DEVICE_PATH;
 176
 177 #define MSG_FIBRECHANNEL_DP             0x03
 178 typedef struct _FIBRECHANNEL_DEVICE_PATH {
 179         EFI_DEVICE_PATH                 Header;
 180         UINT32                          Reserved;
 181         UINT64                          WWN;
 182         UINT64                          Lun;
 183 } FIBRECHANNEL_DEVICE_PATH;
 184
 185 #define MSG_1394_DP                     0x04
 186 typedef struct _F1394_DEVICE_PATH {
 187         EFI_DEVICE_PATH                 Header;
 188         UINT32                          Reserved;
 189         UINT64                          Guid;
 190 } F1394_DEVICE_PATH;
 191
 192 #define MSG_USB_DP                      0x05
 193 typedef struct _USB_DEVICE_PATH {
 194     EFI_DEVICE_PATH                     Header;
 195     UINT8                                                             ParentPortNumber;
 196     UINT8                                                             InterfaceNumber;
 197 } USB_DEVICE_PATH;
 198
 199 #define MSG_USB_CLASS_DP                0x0F
 200 typedef struct _USB_CLASS_DEVICE_PATH {
 201         EFI_DEVICE_PATH                 Header;
 202         UINT16                          VendorId;
 203         UINT16                          ProductId;
 204         UINT8                           DeviceClass;
 205         UINT8                           DeviceSubClass;
 206         UINT8                           DeviceProtocol;
 207 } USB_CLASS_DEVICE_PATH;
 208
 209 #define MSG_I2O_DP                      0x06
 210 typedef struct _I2O_DEVICE_PATH {
 211         EFI_DEVICE_PATH                 Header;
 212         UINT32                          Tid;
 213 } I2O_DEVICE_PATH;
 214
 215 #define MSG_MAC_ADDR_DP                 0x0b
 216 typedef struct _MAC_ADDR_DEVICE_PATH {
 217         EFI_DEVICE_PATH                 Header;
 218         EFI_MAC_ADDRESS                 MacAddress;
 219         UINT8                           IfType;
 220 } MAC_ADDR_DEVICE_PATH;
 221
 222 #define MSG_IPv4_DP                     0x0c
 223 typedef struct _IPv4_DEVICE_PATH {
 224         EFI_DEVICE_PATH                 Header;
 225         EFI_IPv4_ADDRESS                LocalIpAddress;
 226         EFI_IPv4_ADDRESS                RemoteIpAddress;
 227         UINT16                          LocalPort;
 228         UINT16                          RemotePort;
 229         UINT16                          Protocol;
 230         BOOLEAN                         StaticIpAddress;
 231 } IPv4_DEVICE_PATH;
 232
 233 #define MSG_IPv6_DP                     0x0d
 234 typedef struct _IPv6_DEVICE_PATH {
 235         EFI_DEVICE_PATH                 Header;
 236         EFI_IPv6_ADDRESS                LocalIpAddress;
 237         EFI_IPv6_ADDRESS                RemoteIpAddress;
 238         UINT16                          LocalPort;
 239         UINT16                          RemotePort;
 240         UINT16                          Protocol;
 241         BOOLEAN                         StaticIpAddress;
 242 } IPv6_DEVICE_PATH;
 243
 244 #define MSG_INFINIBAND_DP               0x09
 245 typedef struct _INFINIBAND_DEVICE_PATH {
 246   EFI_DEVICE_PATH                       Header;
 247   UINT32                                ResourceFlags;
 248   UINT8                                 PortGid[16];
 249   UINT64                                ServiceId;
 250   UINT64                                TargetPortId;
 251   UINT64                                DeviceId;
 252 } INFINIBAND_DEVICE_PATH;
 253
 254 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE                0x01
 255 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT  0x02
 256 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL           0x04
 257 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL           0x08
 258 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL           0x10
 259
 260 #define MSG_UART_DP                     0x0e
 261 typedef struct _UART_DEVICE_PATH {
 262         EFI_DEVICE_PATH                 Header;
 263         UINT32                          Reserved;
 264         UINT64                          BaudRate;
 265         UINT8                           DataBits;
 266         UINT8                           Parity;
 267         UINT8                           StopBits;
 268 } UART_DEVICE_PATH;
 269
 270 #define MSG_VENDOR_DP                   0x0A
 271 /* Use VENDOR_DEVICE_PATH struct */
 272
 273 #define DEVICE_PATH_MESSAGING_PC_ANSI \
 274     { 0xe0c14753, 0xf9be, 0x11d2, {0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
 275
 276 #define DEVICE_PATH_MESSAGING_VT_100 \
 277     { 0xdfa66065, 0xb419, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
 278
 279 #define DEVICE_PATH_MESSAGING_VT_100_PLUS \
 280     { 0x7baec70b, 0x57e0, 0x4c76, {0x8e, 0x87, 0x2f, 0x9e, 0x28, 0x08, 0x83, 0x43} }
 281
 282 #define DEVICE_PATH_MESSAGING_VT_UTF8 \
 283     { 0xad15a0d6, 0x8bec, 0x4acf, {0xa0, 0x73, 0xd0, 0x1d, 0xe7, 0x7e, 0x2d, 0x88} }
 284
 285 #define MSG_SATA_DP                     0x12
 286 typedef struct _SATA_DEVICE_PATH {
 287         EFI_DEVICE_PATH                 Header;
 288         UINT16                          HBAPortNumber;
 289         UINT16                          PortMultiplierPortNumber;
 290         UINT16                          Lun;
 291 } SATA_DEVICE_PATH;
 292
 293 #define MEDIA_DEVICE_PATH               0x04
 294
 295 #define MEDIA_HARDDRIVE_DP              0x01
 296 typedef struct _HARDDRIVE_DEVICE_PATH {
 297         EFI_DEVICE_PATH                 Header;
 298         UINT32                          PartitionNumber;
 299         UINT64                          PartitionStart;
 300         UINT64                          PartitionSize;
 301         UINT8                           Signature[16];
 302         UINT8                           MBRType;
 303         UINT8                           SignatureType;
 304 } HARDDRIVE_DEVICE_PATH;
 305
 306 #define MBR_TYPE_PCAT                       0x01
 307 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
 308
 309 #define SIGNATURE_TYPE_MBR                  0x01
 310 #define SIGNATURE_TYPE_GUID                 0x02
 311
 312 #define MEDIA_CDROM_DP                  0x02
 313 typedef struct _CDROM_DEVICE_PATH {
 314         EFI_DEVICE_PATH                 Header;
 315         UINT32                          BootEntry;
 316         UINT64                          PartitionStart;
 317         UINT64                          PartitionSize;
 318 } CDROM_DEVICE_PATH;
 319
 320 #define MEDIA_VENDOR_DP                 0x03
 321 /* Use VENDOR_DEVICE_PATH struct */
 322
 323 #define MEDIA_FILEPATH_DP               0x04
 324 typedef struct _FILEPATH_DEVICE_PATH {
 325         EFI_DEVICE_PATH                 Header;
 326         CHAR16                          PathName[1];
 327 } FILEPATH_DEVICE_PATH;
 328
 329 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
 330
 331 #define MEDIA_PROTOCOL_DP               0x05
 332 typedef struct _MEDIA_PROTOCOL_DEVICE_PATH {
 333         EFI_DEVICE_PATH                 Header;
 334         EFI_GUID                        Protocol;
 335 } MEDIA_PROTOCOL_DEVICE_PATH;
 336
 337
 338 #define BBS_DEVICE_PATH                 0x05
 339 #define BBS_BBS_DP                      0x01
 340 typedef struct _BBS_BBS_DEVICE_PATH {
 341         EFI_DEVICE_PATH                 Header;
 342         UINT16                          DeviceType;
 343         UINT16                          StatusFlag;
 344         CHAR8                           String[1];
 345 } BBS_BBS_DEVICE_PATH;
 346
 347 /* DeviceType definitions - from BBS specification */
 348 #define BBS_TYPE_FLOPPY                 0x01
 349 #define BBS_TYPE_HARDDRIVE              0x02
 350 #define BBS_TYPE_CDROM                  0x03
 351 #define BBS_TYPE_PCMCIA                 0x04
 352 #define BBS_TYPE_USB                    0x05
 353 #define BBS_TYPE_EMBEDDED_NETWORK       0x06
 354 #define BBS_TYPE_DEV                    0x80
 355 #define BBS_TYPE_UNKNOWN                0xFF
 356
 357 typedef union {
 358     EFI_DEVICE_PATH                      DevPath;
 359     PCI_DEVICE_PATH                      Pci;
 360     PCCARD_DEVICE_PATH                   PcCard;
 361     MEMMAP_DEVICE_PATH                   MemMap;
 362     VENDOR_DEVICE_PATH                   Vendor;
 363     UNKNOWN_DEVICE_VENDOR_DEVICE_PATH    UnknownVendor;
 364     CONTROLLER_DEVICE_PATH               Controller;
 365     ACPI_HID_DEVICE_PATH                 Acpi;
 366
 367     ATAPI_DEVICE_PATH                    Atapi;
 368     SCSI_DEVICE_PATH                     Scsi;
 369     FIBRECHANNEL_DEVICE_PATH             FibreChannel;
 370
 371     F1394_DEVICE_PATH                    F1394;
 372     USB_DEVICE_PATH                      Usb;
 373     USB_CLASS_DEVICE_PATH                UsbClass;
 374     I2O_DEVICE_PATH                      I2O;
 375     MAC_ADDR_DEVICE_PATH                 MacAddr;
 376     IPv4_DEVICE_PATH                     Ipv4;
 377     IPv6_DEVICE_PATH                     Ipv6;
 378     INFINIBAND_DEVICE_PATH               InfiniBand;
 379     UART_DEVICE_PATH                     Uart;
 380
 381     HARDDRIVE_DEVICE_PATH                HardDrive;
 382     CDROM_DEVICE_PATH                    CD;
 383
 384     FILEPATH_DEVICE_PATH                 FilePath;
 385     MEDIA_PROTOCOL_DEVICE_PATH           MediaProtocol;
 386
 387     BBS_BBS_DEVICE_PATH                  Bbs;
 388
 389 } EFI_DEV_PATH;
 390
 391 typedef union {
 392     EFI_DEVICE_PATH                      *DevPath;
 393     PCI_DEVICE_PATH                      *Pci;
 394     PCCARD_DEVICE_PATH                   *PcCard;
 395     MEMMAP_DEVICE_PATH                   *MemMap;
 396     VENDOR_DEVICE_PATH                   *Vendor;
 397     UNKNOWN_DEVICE_VENDOR_DEVICE_PATH    *UnknownVendor;
 398     CONTROLLER_DEVICE_PATH               *Controller;
 399     ACPI_HID_DEVICE_PATH                 *Acpi;
 400     ACPI_EXTENDED_HID_DEVICE_PATH        *ExtendedAcpi;
 401
 402     ATAPI_DEVICE_PATH                    *Atapi;
 403     SCSI_DEVICE_PATH                     *Scsi;
 404     FIBRECHANNEL_DEVICE_PATH             *FibreChannel;
 405
 406     F1394_DEVICE_PATH                    *F1394;
 407     USB_DEVICE_PATH                      *Usb;
 408     USB_CLASS_DEVICE_PATH                *UsbClass;
 409     I2O_DEVICE_PATH                      *I2O;
 410     MAC_ADDR_DEVICE_PATH                 *MacAddr;
 411     IPv4_DEVICE_PATH                     *Ipv4;
 412     IPv6_DEVICE_PATH                     *Ipv6;
 413     INFINIBAND_DEVICE_PATH               *InfiniBand;
 414     UART_DEVICE_PATH                     *Uart;
 415
 416     HARDDRIVE_DEVICE_PATH                *HardDrive;
 417
 418     FILEPATH_DEVICE_PATH                 *FilePath;
 419     MEDIA_PROTOCOL_DEVICE_PATH           *MediaProtocol;
 420
 421     CDROM_DEVICE_PATH                    *CD;
 422     BBS_BBS_DEVICE_PATH                  *Bbs;
 423
 424 } EFI_DEV_PATH_PTR;
 425
 426 #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID      \
 427     { 0xbc62157e, 0x3e33, 0x4fec, { 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf } }
 428
 429 #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID         \
 430     { 0x5c99a21, 0xc70f, 0x4ad2, { 0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e } }
 431
 432 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID           \
 433     { 0x8b843e20, 0x8132, 0x4852, { 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c } }
 434
 435 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID         \
 436     { 0x379be4e, 0xd706, 0x437d, { 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4 } }
 437
 438 INTERFACE_DECL(_EFI_DEVICE_PATH_PROTOCOL);
 439
 440 typedef
 441 CHAR16*
 442 (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_NODE) (
 443     IN struct _EFI_DEVICE_PATH *This,
 444     IN BOOLEAN                  DisplayOnly,
 445     IN BOOLEAN                  AllowShortCuts
 446     );
 447
 448 typedef
 449 CHAR16*
 450 (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_PATH) (
 451     IN struct _EFI_DEVICE_PATH *This,
 452     IN BOOLEAN                  DisplayOnly,
 453     IN BOOLEAN                  AllowShortCuts
 454     );
 455
 456 typedef struct _EFI_DEVICE_PATH_TO_TEXT_PROTOCOL {
 457         EFI_DEVICE_PATH_TO_TEXT_NODE ConvertDeviceNodeToText;
 458         EFI_DEVICE_PATH_TO_TEXT_PATH ConvertDevicePathToText;
 459 } EFI_DEVICE_PATH_TO_TEXT_PROTOCOL;
 460
 461 #pragma pack()
 462
 463 #endif