Home | History | Annotate | Line # | Download | only in inc
efidevp.h revision 1.1 
      1 /*	$NetBSD: efidevp.h,v 1.1 2014/04/01 16:16:07 jakllsch Exp $	*/
      2 
      3 #ifndef _DEVPATH_H
      4 #define _DEVPATH_H
      5 
      6 /*++
      7 
      8 Copyright (c) 1998  Intel Corporation
      9 
     10 Module Name:
     11 
     12     devpath.h
     13 
     14 Abstract:
     15 
     16     Defines for parsing the EFI Device Path structures
     17 
     18 
     19 
     20 Revision History
     21 
     22 --*/
     23 
     24 //
     25 // Device Path structures - Section C
     26 //
     27 
     28 typedef struct _EFI_DEVICE_PATH {
     29         UINT8                           Type;
     30         UINT8                           SubType;
     31         UINT8                           Length[2];
     32 } EFI_DEVICE_PATH;
     33 
     34 #define EFI_DP_TYPE_MASK                    0x7F
     35 #define EFI_DP_TYPE_UNPACKED                0x80
     36 
     37 //#define END_DEVICE_PATH_TYPE                0xff
     38 #define END_DEVICE_PATH_TYPE                0x7f
     39 //#define END_DEVICE_PATH_TYPE_UNPACKED       0x7f
     40 
     41 #define END_ENTIRE_DEVICE_PATH_SUBTYPE      0xff
     42 #define END_INSTANCE_DEVICE_PATH_SUBTYPE    0x01
     43 #define END_DEVICE_PATH_LENGTH              (sizeof(EFI_DEVICE_PATH))
     44 
     45 
     46 #define DP_IS_END_TYPE(a)
     47 #define DP_IS_END_SUBTYPE(a)        ( ((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
     48 
     49 #define DevicePathType(a)           ( ((a)->Type) & EFI_DP_TYPE_MASK )
     50 #define DevicePathSubType(a)        ( (a)->SubType )
     51 #define DevicePathNodeLength(a)     ( ((a)->Length[0]) | ((a)->Length[1] << 8) )
     52 #define NextDevicePathNode(a)       ( (EFI_DEVICE_PATH *) ( ((UINT8 *) (a)) + DevicePathNodeLength(a)))
     53 //#define IsDevicePathEndType(a)      ( DevicePathType(a) == END_DEVICE_PATH_TYPE_UNPACKED )
     54 #define IsDevicePathEndType(a)      ( DevicePathType(a) == END_DEVICE_PATH_TYPE )
     55 #define IsDevicePathEndSubType(a)   ( (a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
     56 #define IsDevicePathEnd(a)          ( IsDevicePathEndType(a) && IsDevicePathEndSubType(a) )
     57 #define IsDevicePathUnpacked(a)     ( (a)->Type & EFI_DP_TYPE_UNPACKED )
     58 
     59 
     60 #define SetDevicePathNodeLength(a,l) {                  \
     61             (a)->Length[0] = (UINT8) (l);               \
     62             (a)->Length[1] = (UINT8) ((l) >> 8);        \
     63             }
     64 
     65 #define SetDevicePathEndNode(a)  {                      \
     66             (a)->Type = END_DEVICE_PATH_TYPE;           \
     67             (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE;     \
     68             (a)->Length[0] = sizeof(EFI_DEVICE_PATH);   \
     69             (a)->Length[1] = 0;                         \
     70             }
     71 
     72 
     73 
     74 /*
     75  *
     76  */
     77 #define HARDWARE_DEVICE_PATH            0x01
     78 
     79 #define HW_PCI_DP                       0x01
     80 typedef struct _PCI_DEVICE_PATH {
     81         EFI_DEVICE_PATH                 Header;
     82         UINT8                           Function;
     83         UINT8                           Device;
     84 } PCI_DEVICE_PATH;
     85 
     86 #define HW_PCCARD_DP                    0x02
     87 typedef struct _PCCARD_DEVICE_PATH {
     88         EFI_DEVICE_PATH                 Header;
     89         UINT8                           SocketNumber;
     90 } PCCARD_DEVICE_PATH;
     91 
     92 #define HW_MEMMAP_DP                    0x03
     93 typedef struct _MEMMAP_DEVICE_PATH {
     94         EFI_DEVICE_PATH                 Header;
     95         UINT32                          MemoryType;
     96         EFI_PHYSICAL_ADDRESS            StartingAddress;
     97         EFI_PHYSICAL_ADDRESS            EndingAddress;
     98 } MEMMAP_DEVICE_PATH;
     99 
    100 #define HW_VENDOR_DP                    0x04
    101 typedef struct _VENDOR_DEVICE_PATH {
    102         EFI_DEVICE_PATH                 Header;
    103         EFI_GUID                        Guid;
    104 } VENDOR_DEVICE_PATH;
    105 
    106 #define UNKNOWN_DEVICE_GUID \
    107     { 0xcf31fac5, 0xc24e, 0x11d2,  {0x85, 0xf3, 0x0, 0xa0, 0xc9, 0x3e, 0xc9, 0x3b}  }
    108 
    109 typedef struct _UKNOWN_DEVICE_VENDOR_DP {
    110     VENDOR_DEVICE_PATH      DevicePath;
    111     UINT8                   LegacyDriveLetter;
    112 } UNKNOWN_DEVICE_VENDOR_DEVICE_PATH;
    113 
    114 #define HW_CONTROLLER_DP            0x05
    115 typedef struct _CONTROLLER_DEVICE_PATH {
    116         EFI_DEVICE_PATH     Header;
    117         UINT32              Controller;
    118 } CONTROLLER_DEVICE_PATH;
    119 
    120 /*
    121  *
    122  */
    123 #define ACPI_DEVICE_PATH                 0x02
    124 
    125 #define ACPI_DP                         0x01
    126 typedef struct _ACPI_HID_DEVICE_PATH {
    127         EFI_DEVICE_PATH                 Header;
    128         UINT32                          HID;
    129         UINT32                          UID;
    130 } ACPI_HID_DEVICE_PATH;
    131 
    132 #define EXPANDED_ACPI_DP		0x02
    133 typedef struct _EXPANDED_ACPI_HID_DEVICE_PATH {
    134 	EFI_DEVICE_PATH			Header;
    135 	UINT32				HID;
    136 	UINT32				UID;
    137 	UINT32				CID;
    138 	UINT8				HidStr[1];
    139 } EXPANDED_ACPI_HID_DEVICE_PATH;
    140 
    141 //
    142 // EISA ID Macro
    143 // EISA ID Definition 32-bits
    144 //  bits[15:0] - three character compressed ASCII EISA ID.
    145 //  bits[31:16] - binary number
    146 //   Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
    147 //
    148 #define PNP_EISA_ID_CONST       0x41d0
    149 #define EISA_ID(_Name, _Num)    ((UINT32) ((_Name) | (_Num) << 16))
    150 #define EISA_PNP_ID(_PNPId)     (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
    151 
    152 #define PNP_EISA_ID_MASK        0xffff
    153 #define EISA_ID_TO_NUM(_Id)     ((_Id) >> 16)
    154 /*
    155  *
    156  */
    157 #define MESSAGING_DEVICE_PATH           0x03
    158 
    159 #define MSG_ATAPI_DP                    0x01
    160 typedef struct _ATAPI_DEVICE_PATH {
    161         EFI_DEVICE_PATH                 Header;
    162         UINT8                           PrimarySecondary;
    163         UINT8                           SlaveMaster;
    164         UINT16                          Lun;
    165 } ATAPI_DEVICE_PATH;
    166 
    167 #define MSG_SCSI_DP                     0x02
    168 typedef struct _SCSI_DEVICE_PATH {
    169         EFI_DEVICE_PATH                 Header;
    170         UINT16                          Pun;
    171         UINT16                          Lun;
    172 } SCSI_DEVICE_PATH;
    173 
    174 #define MSG_FIBRECHANNEL_DP             0x03
    175 typedef struct _FIBRECHANNEL_DEVICE_PATH {
    176         EFI_DEVICE_PATH                 Header;
    177         UINT32                          Reserved;
    178         UINT64                          WWN;
    179         UINT64                          Lun;
    180 } FIBRECHANNEL_DEVICE_PATH;
    181 
    182 #define MSG_1394_DP                     0x04
    183 typedef struct _F1394_DEVICE_PATH {
    184         EFI_DEVICE_PATH                 Header;
    185         UINT32                          Reserved;
    186         UINT64                          Guid;
    187 } F1394_DEVICE_PATH;
    188 
    189 #define MSG_USB_DP                      0x05
    190 typedef struct _USB_DEVICE_PATH {
    191         EFI_DEVICE_PATH                 Header;
    192         UINT8                           Port;
    193         UINT8                           Endpoint;
    194 } USB_DEVICE_PATH;
    195 
    196 #define MSG_USB_CLASS_DP                0x0F
    197 typedef struct _USB_CLASS_DEVICE_PATH {
    198         EFI_DEVICE_PATH                 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_I2O_DP                      0x06
    207 typedef struct _I2O_DEVICE_PATH {
    208         EFI_DEVICE_PATH                 Header;
    209         UINT32                          Tid;
    210 } I2O_DEVICE_PATH;
    211 
    212 #define MSG_MAC_ADDR_DP                 0x0b
    213 typedef struct _MAC_ADDR_DEVICE_PATH {
    214         EFI_DEVICE_PATH                 Header;
    215         EFI_MAC_ADDRESS                 MacAddress;
    216         UINT8                           IfType;
    217 } MAC_ADDR_DEVICE_PATH;
    218 
    219 #define MSG_IPv4_DP                     0x0c
    220 typedef struct _IPv4_DEVICE_PATH {
    221         EFI_DEVICE_PATH                 Header;
    222         EFI_IPv4_ADDRESS                LocalIpAddress;
    223         EFI_IPv4_ADDRESS                RemoteIpAddress;
    224         UINT16                          LocalPort;
    225         UINT16                          RemotePort;
    226         UINT16                          Protocol;
    227         BOOLEAN                         StaticIpAddress;
    228 } IPv4_DEVICE_PATH;
    229 
    230 #define MSG_IPv6_DP                     0x0d
    231 typedef struct _IPv6_DEVICE_PATH {
    232         EFI_DEVICE_PATH                 Header;
    233         EFI_IPv6_ADDRESS                LocalIpAddress;
    234         EFI_IPv6_ADDRESS                RemoteIpAddress;
    235         UINT16                          LocalPort;
    236         UINT16                          RemotePort;
    237         UINT16                          Protocol;
    238         BOOLEAN                         StaticIpAddress;
    239 } IPv6_DEVICE_PATH;
    240 
    241 #define MSG_INFINIBAND_DP               0x09
    242 typedef struct _INFINIBAND_DEVICE_PATH {
    243         EFI_DEVICE_PATH                 Header;
    244         UINT32                          Reserved;
    245         UINT64                          NodeGuid;
    246         UINT64                          IocGuid;
    247         UINT64                          DeviceId;
    248 } INFINIBAND_DEVICE_PATH;
    249 
    250 #define MSG_UART_DP                     0x0e
    251 typedef struct _UART_DEVICE_PATH {
    252         EFI_DEVICE_PATH                 Header;
    253         UINT32                          Reserved;
    254         UINT64                          BaudRate;
    255         UINT8                           DataBits;
    256         UINT8                           Parity;
    257         UINT8                           StopBits;
    258 } UART_DEVICE_PATH;
    259 
    260 #define MSG_VENDOR_DP                   0x0A
    261 /* Use VENDOR_DEVICE_PATH struct */
    262 
    263 #define DEVICE_PATH_MESSAGING_PC_ANSI \
    264     { 0xe0c14753, 0xf9be, 0x11d2,  {0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d}  }
    265 
    266 #define DEVICE_PATH_MESSAGING_VT_100 \
    267     { 0xdfa66065, 0xb419, 0x11d3,  {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d}  }
    268 
    269 
    270 
    271 #define MEDIA_DEVICE_PATH               0x04
    272 
    273 #define MEDIA_HARDDRIVE_DP              0x01
    274 typedef struct _HARDDRIVE_DEVICE_PATH {
    275         EFI_DEVICE_PATH                 Header;
    276         UINT32                          PartitionNumber;
    277         UINT64                          PartitionStart;
    278         UINT64                          PartitionSize;
    279         UINT8                           Signature[16];
    280         UINT8                           MBRType;
    281         UINT8                           SignatureType;
    282 } HARDDRIVE_DEVICE_PATH;
    283 
    284 #define MBR_TYPE_PCAT                       0x01
    285 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
    286 
    287 #define SIGNATURE_TYPE_MBR                  0x01
    288 #define SIGNATURE_TYPE_GUID                 0x02
    289 
    290 #define MEDIA_CDROM_DP                  0x02
    291 typedef struct _CDROM_DEVICE_PATH {
    292         EFI_DEVICE_PATH                 Header;
    293         UINT32                          BootEntry;
    294         UINT64                          PartitionStart;
    295         UINT64                          PartitionSize;
    296 } CDROM_DEVICE_PATH;
    297 
    298 #define MEDIA_VENDOR_DP                 0x03
    299 /* Use VENDOR_DEVICE_PATH struct */
    300 
    301 #define MEDIA_FILEPATH_DP               0x04
    302 typedef struct _FILEPATH_DEVICE_PATH {
    303         EFI_DEVICE_PATH                 Header;
    304         CHAR16                          PathName[1];
    305 } FILEPATH_DEVICE_PATH;
    306 
    307 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
    308 
    309 #define MEDIA_PROTOCOL_DP               0x05
    310 typedef struct _MEDIA_PROTOCOL_DEVICE_PATH {
    311         EFI_DEVICE_PATH                 Header;
    312         EFI_GUID                        Protocol;
    313 } MEDIA_PROTOCOL_DEVICE_PATH;
    314 
    315 
    316 #define BBS_DEVICE_PATH                 0x05
    317 #define BBS_BBS_DP                      0x01
    318 typedef struct _BBS_BBS_DEVICE_PATH {
    319         EFI_DEVICE_PATH                 Header;
    320         UINT16                          DeviceType;
    321         UINT16                          StatusFlag;
    322         CHAR8                           String[1];
    323 } BBS_BBS_DEVICE_PATH;
    324 
    325 /* DeviceType definitions - from BBS specification */
    326 #define BBS_TYPE_FLOPPY                 0x01
    327 #define BBS_TYPE_HARDDRIVE              0x02
    328 #define BBS_TYPE_CDROM                  0x03
    329 #define BBS_TYPE_PCMCIA                 0x04
    330 #define BBS_TYPE_USB                    0x05
    331 #define BBS_TYPE_EMBEDDED_NETWORK       0x06
    332 #define BBS_TYPE_DEV                    0x80
    333 #define BBS_TYPE_UNKNOWN                0xFF
    334 
    335 typedef union {
    336     EFI_DEVICE_PATH                      DevPath;
    337     PCI_DEVICE_PATH                      Pci;
    338     PCCARD_DEVICE_PATH                   PcCard;
    339     MEMMAP_DEVICE_PATH                   MemMap;
    340     VENDOR_DEVICE_PATH                   Vendor;
    341     UNKNOWN_DEVICE_VENDOR_DEVICE_PATH    UnknownVendor;
    342     CONTROLLER_DEVICE_PATH               Controller;
    343     ACPI_HID_DEVICE_PATH                 Acpi;
    344 
    345     ATAPI_DEVICE_PATH                    Atapi;
    346     SCSI_DEVICE_PATH                     Scsi;
    347     FIBRECHANNEL_DEVICE_PATH             FibreChannel;
    348 
    349     F1394_DEVICE_PATH                    F1394;
    350     USB_DEVICE_PATH                      Usb;
    351     USB_CLASS_DEVICE_PATH                UsbClass;
    352     I2O_DEVICE_PATH                      I2O;
    353     MAC_ADDR_DEVICE_PATH                 MacAddr;
    354     IPv4_DEVICE_PATH                     Ipv4;
    355     IPv6_DEVICE_PATH                     Ipv6;
    356     INFINIBAND_DEVICE_PATH               InfiniBand;
    357     UART_DEVICE_PATH                     Uart;
    358 
    359     HARDDRIVE_DEVICE_PATH                HardDrive;
    360     CDROM_DEVICE_PATH                    CD;
    361 
    362     FILEPATH_DEVICE_PATH                 FilePath;
    363     MEDIA_PROTOCOL_DEVICE_PATH           MediaProtocol;
    364 
    365     BBS_BBS_DEVICE_PATH                  Bbs;
    366 
    367 } EFI_DEV_PATH;
    368 
    369 typedef union {
    370     EFI_DEVICE_PATH                      *DevPath;
    371     PCI_DEVICE_PATH                      *Pci;
    372     PCCARD_DEVICE_PATH                   *PcCard;
    373     MEMMAP_DEVICE_PATH                   *MemMap;
    374     VENDOR_DEVICE_PATH                   *Vendor;
    375     UNKNOWN_DEVICE_VENDOR_DEVICE_PATH    *UnknownVendor;
    376     CONTROLLER_DEVICE_PATH               *Controller;
    377     ACPI_HID_DEVICE_PATH                 *Acpi;
    378 
    379     ATAPI_DEVICE_PATH                    *Atapi;
    380     SCSI_DEVICE_PATH                     *Scsi;
    381     FIBRECHANNEL_DEVICE_PATH             *FibreChannel;
    382 
    383     F1394_DEVICE_PATH                    *F1394;
    384     USB_DEVICE_PATH                      *Usb;
    385     USB_CLASS_DEVICE_PATH                *UsbClass;
    386     I2O_DEVICE_PATH                      *I2O;
    387     MAC_ADDR_DEVICE_PATH                 *MacAddr;
    388     IPv4_DEVICE_PATH                     *Ipv4;
    389     IPv6_DEVICE_PATH                     *Ipv6;
    390     INFINIBAND_DEVICE_PATH               *InfiniBand;
    391     UART_DEVICE_PATH                     *Uart;
    392 
    393     HARDDRIVE_DEVICE_PATH                *HardDrive;
    394 
    395     FILEPATH_DEVICE_PATH                 *FilePath;
    396     MEDIA_PROTOCOL_DEVICE_PATH           *MediaProtocol;
    397 
    398     CDROM_DEVICE_PATH                    *CD;
    399     BBS_BBS_DEVICE_PATH                  *Bbs;
    400 
    401 } EFI_DEV_PATH_PTR;
    402 
    403 
    404 #endif
    405