7 Copyright (c) 1999 - 2002 Intel Corporation. All rights reserved
8 This software and associated documentation (if any) is furnished
9 under a license and may only be used or copied in accordance
10 with the terms of the license. Except as permitted by such
11 license, no part of this software or documentation may be
12 reproduced, stored in a retrieval system, or transmitted in any
13 form or by any means without the express written consent of
22 Defines for parsing the EFI Device Path structures
31 // Device Path structures - Section C
36 typedef struct _EFI_DEVICE_PATH {
42 #define EFI_DP_TYPE_MASK 0x7F
43 #define EFI_DP_TYPE_UNPACKED 0x80
45 #define END_DEVICE_PATH_TYPE 0x7f
47 #define END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
48 #define END_INSTANCE_DEVICE_PATH_SUBTYPE 0x01
49 #define END_DEVICE_PATH_LENGTH (sizeof(EFI_DEVICE_PATH))
52 #define DP_IS_END_TYPE(a)
53 #define DP_IS_END_SUBTYPE(a) ( ((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
55 #define DevicePathType(a) ( ((a)->Type) & EFI_DP_TYPE_MASK )
56 #define DevicePathSubType(a) ( (a)->SubType )
57 #define DevicePathNodeLength(a) ((size_t)(((a)->Length[0]) | ((a)->Length[1] << 8)))
58 #define NextDevicePathNode(a) ( (EFI_DEVICE_PATH *) ( ((UINT8 *) (a)) + DevicePathNodeLength(a)))
59 #define IsDevicePathType(a, t) ( DevicePathType(a) == t )
60 #define IsDevicePathEndType(a) IsDevicePathType(a, END_DEVICE_PATH_TYPE)
61 #define IsDevicePathEndSubType(a) ( (a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
62 #define IsDevicePathEnd(a) ( IsDevicePathEndType(a) && IsDevicePathEndSubType(a) )
63 #define IsDevicePathUnpacked(a) ( (a)->Type & EFI_DP_TYPE_UNPACKED )
66 #define SetDevicePathNodeLength(a,l) { \
67 (a)->Length[0] = (UINT8) (l); \
68 (a)->Length[1] = (UINT8) ((l) >> 8); \
71 #define SetDevicePathEndNode(a) { \
72 (a)->Type = END_DEVICE_PATH_TYPE; \
73 (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \
74 (a)->Length[0] = sizeof(EFI_DEVICE_PATH); \
81 #define HARDWARE_DEVICE_PATH 0x01
83 #define HW_PCI_DP 0x01
84 typedef struct _PCI_DEVICE_PATH {
85 EFI_DEVICE_PATH Header;
90 #define HW_PCCARD_DP 0x02
91 typedef struct _PCCARD_DEVICE_PATH {
92 EFI_DEVICE_PATH Header;
96 #define HW_MEMMAP_DP 0x03
97 typedef struct _MEMMAP_DEVICE_PATH {
98 EFI_DEVICE_PATH Header;
100 EFI_PHYSICAL_ADDRESS StartingAddress;
101 EFI_PHYSICAL_ADDRESS EndingAddress;
102 } MEMMAP_DEVICE_PATH;
104 #define HW_VENDOR_DP 0x04
105 typedef struct _VENDOR_DEVICE_PATH {
106 EFI_DEVICE_PATH Header;
108 } VENDOR_DEVICE_PATH;
110 #define UNKNOWN_DEVICE_GUID \
111 { 0xcf31fac5, 0xc24e, 0x11d2, {0x85, 0xf3, 0x0, 0xa0, 0xc9, 0x3e, 0xc9, 0x3b} }
113 typedef struct _UKNOWN_DEVICE_VENDOR_DP {
114 VENDOR_DEVICE_PATH DevicePath;
115 UINT8 LegacyDriveLetter;
116 } UNKNOWN_DEVICE_VENDOR_DEVICE_PATH;
118 #define HW_CONTROLLER_DP 0x05
119 typedef struct _CONTROLLER_DEVICE_PATH {
120 EFI_DEVICE_PATH Header;
122 } CONTROLLER_DEVICE_PATH;
127 #define ACPI_DEVICE_PATH 0x02
130 typedef struct _ACPI_HID_DEVICE_PATH {
131 EFI_DEVICE_PATH Header;
134 } ACPI_HID_DEVICE_PATH;
136 #define ACPI_EXTENDED_DP 0x02
137 typedef struct _ACPI_EXTENDED_HID_DEVICE_PATH {
138 EFI_DEVICE_PATH Header;
142 } ACPI_EXTENDED_HID_DEVICE_PATH;
144 #define ACPI_ADR_DP 0x03
145 /* ACPI_ADR_DEVICE_PATH not defined */
149 // EISA ID Definition 32-bits
150 // bits[15:0] - three character compressed ASCII EISA ID.
151 // bits[31:16] - binary number
152 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
154 #define PNP_EISA_ID_CONST 0x41d0
155 #define EISA_ID(_Name, _Num) ((UINT32) ((_Name) | (_Num) << 16))
156 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
157 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
159 #define PNP_EISA_ID_MASK 0xffff
160 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
164 #define MESSAGING_DEVICE_PATH 0x03
166 #define MSG_ATAPI_DP 0x01
167 typedef struct _ATAPI_DEVICE_PATH {
168 EFI_DEVICE_PATH Header;
169 UINT8 PrimarySecondary;
174 #define MSG_SCSI_DP 0x02
175 typedef struct _SCSI_DEVICE_PATH {
176 EFI_DEVICE_PATH Header;
181 #define MSG_FIBRECHANNEL_DP 0x03
182 typedef struct _FIBRECHANNEL_DEVICE_PATH {
183 EFI_DEVICE_PATH Header;
187 } FIBRECHANNEL_DEVICE_PATH;
189 #define MSG_1394_DP 0x04
190 typedef struct _F1394_DEVICE_PATH {
191 EFI_DEVICE_PATH Header;
196 #define MSG_USB_DP 0x05
197 typedef struct _USB_DEVICE_PATH {
198 EFI_DEVICE_PATH Header;
199 UINT8 ParentPortNumber;
200 UINT8 InterfaceNumber;
203 #define MSG_USB_CLASS_DP 0x0F
204 typedef struct _USB_CLASS_DEVICE_PATH {
205 EFI_DEVICE_PATH Header;
209 UINT8 DeviceSubClass;
210 UINT8 DeviceProtocol;
211 } USB_CLASS_DEVICE_PATH;
213 #define MSG_I2O_DP 0x06
214 typedef struct _I2O_DEVICE_PATH {
215 EFI_DEVICE_PATH Header;
219 #define MSG_MAC_ADDR_DP 0x0b
220 typedef struct _MAC_ADDR_DEVICE_PATH {
221 EFI_DEVICE_PATH Header;
222 EFI_MAC_ADDRESS MacAddress;
224 } MAC_ADDR_DEVICE_PATH;
226 #define MSG_IPv4_DP 0x0c
227 typedef struct _IPv4_DEVICE_PATH {
228 EFI_DEVICE_PATH Header;
229 EFI_IPv4_ADDRESS LocalIpAddress;
230 EFI_IPv4_ADDRESS RemoteIpAddress;
234 BOOLEAN StaticIpAddress;
237 #define MSG_IPv6_DP 0x0d
238 typedef struct _IPv6_DEVICE_PATH {
239 EFI_DEVICE_PATH Header;
240 EFI_IPv6_ADDRESS LocalIpAddress;
241 EFI_IPv6_ADDRESS RemoteIpAddress;
245 BOOLEAN StaticIpAddress;
248 #define MSG_INFINIBAND_DP 0x09
249 typedef struct _INFINIBAND_DEVICE_PATH {
250 EFI_DEVICE_PATH Header;
251 UINT32 ResourceFlags;
256 } INFINIBAND_DEVICE_PATH;
258 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
259 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
260 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
261 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
262 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
264 #define MSG_UART_DP 0x0e
265 typedef struct _UART_DEVICE_PATH {
266 EFI_DEVICE_PATH Header;
274 #define MSG_VENDOR_DP 0x0A
275 /* Use VENDOR_DEVICE_PATH struct */
277 #define DEVICE_PATH_MESSAGING_PC_ANSI \
278 { 0xe0c14753, 0xf9be, 0x11d2, {0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
280 #define DEVICE_PATH_MESSAGING_VT_100 \
281 { 0xdfa66065, 0xb419, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
283 #define DEVICE_PATH_MESSAGING_VT_100_PLUS \
284 { 0x7baec70b, 0x57e0, 0x4c76, {0x8e, 0x87, 0x2f, 0x9e, 0x28, 0x08, 0x83, 0x43} }
286 #define DEVICE_PATH_MESSAGING_VT_UTF8 \
287 { 0xad15a0d6, 0x8bec, 0x4acf, {0xa0, 0x73, 0xd0, 0x1d, 0xe7, 0x7e, 0x2d, 0x88} }
289 #define MSG_SATA_DP 0x12
290 typedef struct _SATA_DEVICE_PATH {
291 EFI_DEVICE_PATH Header;
292 UINT16 HBAPortNumber;
293 UINT16 PortMultiplierPortNumber;
297 #define MEDIA_DEVICE_PATH 0x04
299 #define MEDIA_HARDDRIVE_DP 0x01
300 typedef struct _HARDDRIVE_DEVICE_PATH {
301 EFI_DEVICE_PATH Header;
302 UINT32 PartitionNumber;
303 UINT64 PartitionStart;
304 UINT64 PartitionSize;
308 } HARDDRIVE_DEVICE_PATH;
310 #define MBR_TYPE_PCAT 0x01
311 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
313 #define SIGNATURE_TYPE_MBR 0x01
314 #define SIGNATURE_TYPE_GUID 0x02
316 #define MEDIA_CDROM_DP 0x02
317 typedef struct _CDROM_DEVICE_PATH {
318 EFI_DEVICE_PATH Header;
320 UINT64 PartitionStart;
321 UINT64 PartitionSize;
324 #define MEDIA_VENDOR_DP 0x03
325 /* Use VENDOR_DEVICE_PATH struct */
327 #define MEDIA_FILEPATH_DP 0x04
328 typedef struct _FILEPATH_DEVICE_PATH {
329 EFI_DEVICE_PATH Header;
331 } FILEPATH_DEVICE_PATH;
333 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
335 #define MEDIA_PROTOCOL_DP 0x05
336 typedef struct _MEDIA_PROTOCOL_DEVICE_PATH {
337 EFI_DEVICE_PATH Header;
339 } MEDIA_PROTOCOL_DEVICE_PATH;
342 #define BBS_DEVICE_PATH 0x05
343 #define BBS_BBS_DP 0x01
344 typedef struct _BBS_BBS_DEVICE_PATH {
345 EFI_DEVICE_PATH Header;
349 } BBS_BBS_DEVICE_PATH;
351 /* DeviceType definitions - from BBS specification */
352 #define BBS_TYPE_FLOPPY 0x01
353 #define BBS_TYPE_HARDDRIVE 0x02
354 #define BBS_TYPE_CDROM 0x03
355 #define BBS_TYPE_PCMCIA 0x04
356 #define BBS_TYPE_USB 0x05
357 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
358 #define BBS_TYPE_DEV 0x80
359 #define BBS_TYPE_UNKNOWN 0xFF
362 EFI_DEVICE_PATH DevPath;
364 PCCARD_DEVICE_PATH PcCard;
365 MEMMAP_DEVICE_PATH MemMap;
366 VENDOR_DEVICE_PATH Vendor;
367 UNKNOWN_DEVICE_VENDOR_DEVICE_PATH UnknownVendor;
368 CONTROLLER_DEVICE_PATH Controller;
369 ACPI_HID_DEVICE_PATH Acpi;
371 ATAPI_DEVICE_PATH Atapi;
372 SCSI_DEVICE_PATH Scsi;
373 FIBRECHANNEL_DEVICE_PATH FibreChannel;
375 F1394_DEVICE_PATH F1394;
377 USB_CLASS_DEVICE_PATH UsbClass;
379 MAC_ADDR_DEVICE_PATH MacAddr;
380 IPv4_DEVICE_PATH Ipv4;
381 IPv6_DEVICE_PATH Ipv6;
382 INFINIBAND_DEVICE_PATH InfiniBand;
383 UART_DEVICE_PATH Uart;
385 HARDDRIVE_DEVICE_PATH HardDrive;
386 CDROM_DEVICE_PATH CD;
388 FILEPATH_DEVICE_PATH FilePath;
389 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol;
391 BBS_BBS_DEVICE_PATH Bbs;
396 EFI_DEVICE_PATH *DevPath;
397 PCI_DEVICE_PATH *Pci;
398 PCCARD_DEVICE_PATH *PcCard;
399 MEMMAP_DEVICE_PATH *MemMap;
400 VENDOR_DEVICE_PATH *Vendor;
401 UNKNOWN_DEVICE_VENDOR_DEVICE_PATH *UnknownVendor;
402 CONTROLLER_DEVICE_PATH *Controller;
403 ACPI_HID_DEVICE_PATH *Acpi;
404 ACPI_EXTENDED_HID_DEVICE_PATH *ExtendedAcpi;
406 ATAPI_DEVICE_PATH *Atapi;
407 SCSI_DEVICE_PATH *Scsi;
408 FIBRECHANNEL_DEVICE_PATH *FibreChannel;
410 F1394_DEVICE_PATH *F1394;
411 USB_DEVICE_PATH *Usb;
412 USB_CLASS_DEVICE_PATH *UsbClass;
413 I2O_DEVICE_PATH *I2O;
414 MAC_ADDR_DEVICE_PATH *MacAddr;
415 IPv4_DEVICE_PATH *Ipv4;
416 IPv6_DEVICE_PATH *Ipv6;
417 INFINIBAND_DEVICE_PATH *InfiniBand;
418 UART_DEVICE_PATH *Uart;
420 HARDDRIVE_DEVICE_PATH *HardDrive;
422 FILEPATH_DEVICE_PATH *FilePath;
423 MEDIA_PROTOCOL_DEVICE_PATH *MediaProtocol;
425 CDROM_DEVICE_PATH *CD;
426 BBS_BBS_DEVICE_PATH *Bbs;
430 #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
431 { 0xbc62157e, 0x3e33, 0x4fec, { 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf } }
433 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
434 { 0x8b843e20, 0x8132, 0x4852, { 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c } }
436 INTERFACE_DECL(_EFI_DEVICE_PATH_PROTOCOL);
440 (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_NODE) (
441 IN struct _EFI_DEVICE_PATH *This,
442 IN BOOLEAN DisplayOnly,
443 IN BOOLEAN AllowShortCuts
448 (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_PATH) (
449 IN struct _EFI_DEVICE_PATH *This,
450 IN BOOLEAN DisplayOnly,
451 IN BOOLEAN AllowShortCuts
454 typedef struct _EFI_DEVICE_PATH_TO_TEXT_PROTOCOL {
455 EFI_DEVICE_PATH_TO_TEXT_NODE ConvertDeviceNodeToText;
456 EFI_DEVICE_PATH_TO_TEXT_PATH ConvertDevicePathToText;
457 } EFI_DEVICE_PATH_TO_TEXT_PROTOCOL;