2 The device path protocol as defined in UEFI 2.0.
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.
8 Copyright (c) 2006 - 2008, 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
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.
19 #ifndef __EFI_DEVICE_PATH_PROTOCOL_H__
20 #define __EFI_DEVICE_PATH_PROTOCOL_H__
22 #include <Guid/PcAnsi.h>
25 /// Device Path protocol
27 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
29 0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
33 // Protocol GUID defined in EFI1.1.
37 /// Device Path information
39 #define DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID
44 This protocol can be used on any device handle to obtain generic path/location
45 information concerning the physical device or logical device. If the handle does
46 not logically map to a physical device, the handle may not necessarily support
47 the device path protocol. The device path describes the location of the device
48 the handle is for. The size of the Device Path can be determined from the structures
49 that make up the Device Path.
52 UINT8 Type
; ///< 0x01 Hardware Device Path
53 ///< 0x02 ACPI Device Path
54 ///< 0x03 Messaging Device Path
55 ///< 0x04 Media Device Path
56 ///< 0x05 BIOS Boot Specification Device Path
57 ///< 0x7F End of Hardware Device Path
59 UINT8 SubType
; ///< Varies by Type
60 ///< 0xFF End Entire Device Path, or
61 ///< 0x01 End This Instance of a Device Path and start a new
64 UINT8 Length
[2]; ///< Specific Device Path data. Type and Sub-Type define
65 ///< type of data. Size of data is included in Length.
67 } EFI_DEVICE_PATH_PROTOCOL
;
70 /// For backward-compatible with EFI1.1.
72 typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH
;
75 /// Hardware Device Paths
77 #define HARDWARE_DEVICE_PATH 0x01
79 #define HW_PCI_DP 0x01
81 EFI_DEVICE_PATH_PROTOCOL Header
;
86 #define HW_PCCARD_DP 0x02
88 EFI_DEVICE_PATH_PROTOCOL Header
;
92 #define HW_MEMMAP_DP 0x03
94 EFI_DEVICE_PATH_PROTOCOL Header
;
96 EFI_PHYSICAL_ADDRESS StartingAddress
;
97 EFI_PHYSICAL_ADDRESS EndingAddress
;
100 #define HW_VENDOR_DP 0x04
102 EFI_DEVICE_PATH_PROTOCOL Header
;
104 } VENDOR_DEVICE_PATH
;
106 #define HW_CONTROLLER_DP 0x05
108 EFI_DEVICE_PATH_PROTOCOL Header
;
109 UINT32 ControllerNumber
;
110 } CONTROLLER_DEVICE_PATH
;
113 /// ACPI Device Paths
115 #define ACPI_DEVICE_PATH 0x02
119 EFI_DEVICE_PATH_PROTOCOL Header
;
122 } ACPI_HID_DEVICE_PATH
;
124 #define ACPI_EXTENDED_DP 0x02
126 EFI_DEVICE_PATH_PROTOCOL Header
;
131 /// Optional variable length _HIDSTR
132 /// Optional variable length _UIDSTR
133 /// Optional variable length _CIDSTR
135 } ACPI_EXTENDED_HID_DEVICE_PATH
;
139 // EISA ID Definition 32-bits
140 // bits[15:0] - three character compressed ASCII EISA ID.
141 // bits[31:16] - binary number
142 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
144 #define PNP_EISA_ID_CONST 0x41d0
145 #define EISA_ID(_Name, _Num) ((UINT32)((_Name) | (_Num) << 16))
146 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
147 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
149 #define PNP_EISA_ID_MASK 0xffff
150 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
153 #define ACPI_ADR_DP 0x03
155 EFI_DEVICE_PATH_PROTOCOL Header
;
157 } ACPI_ADR_DEVICE_PATH
;
159 #define ACPI_ADR_DISPLAY_TYPE_OTHER 0
160 #define ACPI_ADR_DISPLAY_TYPE_VGA 1
161 #define ACPI_ADR_DISPLAY_TYPE_TV 2
162 #define ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL 3
163 #define ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL 4
165 #define ACPI_DISPLAY_ADR(_DeviceIdScheme, _HeadId, _NonVgaOutput, _BiosCanDetect, _VendorInfo, _Type, _Port, _Index) \
166 ((UINT32)( (((_DeviceIdScheme) & 0x1) << 31) | \
167 (((_HeadId) & 0x7) << 18) | \
168 (((_NonVgaOutput) & 0x1) << 17) | \
169 (((_BiosCanDetect) & 0x1) << 16) | \
170 (((_VendorInfo) & 0xf) << 12) | \
171 (((_Type) & 0xf) << 8) | \
172 (((_Port) & 0xf) << 4) | \
176 /// Messaging Device Paths
178 #define MESSAGING_DEVICE_PATH 0x03
180 #define MSG_ATAPI_DP 0x01
182 EFI_DEVICE_PATH_PROTOCOL Header
;
183 UINT8 PrimarySecondary
;
188 #define MSG_SCSI_DP 0x02
190 EFI_DEVICE_PATH_PROTOCOL Header
;
195 #define MSG_FIBRECHANNEL_DP 0x03
197 EFI_DEVICE_PATH_PROTOCOL Header
;
201 } FIBRECHANNEL_DEVICE_PATH
;
203 #define MSG_1394_DP 0x04
205 EFI_DEVICE_PATH_PROTOCOL Header
;
210 #define MSG_USB_DP 0x05
212 EFI_DEVICE_PATH_PROTOCOL Header
;
213 UINT8 ParentPortNumber
;
214 UINT8 InterfaceNumber
;
217 #define MSG_USB_CLASS_DP 0x0f
219 EFI_DEVICE_PATH_PROTOCOL Header
;
223 UINT8 DeviceSubClass
;
224 UINT8 DeviceProtocol
;
225 } USB_CLASS_DEVICE_PATH
;
227 #define MSG_USB_WWID_DP 0x10
229 EFI_DEVICE_PATH_PROTOCOL Header
;
230 UINT16 InterfaceNumber
;
233 // CHAR16 SerialNumber[...];
234 } USB_WWID_DEVICE_PATH
;
237 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
239 EFI_DEVICE_PATH_PROTOCOL Header
;
241 } DEVICE_LOGICAL_UNIT_DEVICE_PATH
;
243 #define MSG_SATA_DP 0x12
245 EFI_DEVICE_PATH_PROTOCOL Header
;
246 UINT16 HBAPortNumber
;
247 UINT16 PortMultiplierPortNumber
;
251 #define MSG_I2O_DP 0x06
253 EFI_DEVICE_PATH_PROTOCOL Header
;
257 #define MSG_MAC_ADDR_DP 0x0b
259 EFI_DEVICE_PATH_PROTOCOL Header
;
260 EFI_MAC_ADDRESS MacAddress
;
262 } MAC_ADDR_DEVICE_PATH
;
264 #define MSG_IPv4_DP 0x0c
266 EFI_DEVICE_PATH_PROTOCOL Header
;
267 EFI_IPv4_ADDRESS LocalIpAddress
;
268 EFI_IPv4_ADDRESS RemoteIpAddress
;
272 BOOLEAN StaticIpAddress
;
275 #define MSG_IPv6_DP 0x0d
277 EFI_DEVICE_PATH_PROTOCOL Header
;
278 EFI_IPv6_ADDRESS LocalIpAddress
;
279 EFI_IPv6_ADDRESS RemoteIpAddress
;
283 BOOLEAN StaticIpAddress
;
286 #define MSG_INFINIBAND_DP 0x09
288 EFI_DEVICE_PATH_PROTOCOL Header
;
289 UINT32 ResourceFlags
;
294 } INFINIBAND_DEVICE_PATH
;
296 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
297 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
298 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
299 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
300 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
302 #define MSG_UART_DP 0x0e
304 EFI_DEVICE_PATH_PROTOCOL Header
;
313 // Use VENDOR_DEVICE_PATH struct
315 #define MSG_VENDOR_DP 0x0a
316 typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH
;
318 #define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID
319 #define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID
320 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
321 #define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID
323 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID
326 EFI_DEVICE_PATH_PROTOCOL Header
;
328 UINT32 FlowControlMap
;
329 } UART_FLOW_CONTROL_DEVICE_PATH
;
331 #define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID
334 EFI_DEVICE_PATH_PROTOCOL Header
;
339 UINT16 DeviceTopology
;
340 UINT16 RelativeTargetPort
;
343 #define MSG_ISCSI_DP 0x13
345 EFI_DEVICE_PATH_PROTOCOL Header
;
346 UINT16 NetworkProtocol
;
349 UINT16 TargetPortalGroupTag
;
350 // CHAR8 iSCSI Target Name
353 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
354 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
355 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
356 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
357 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
358 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
359 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
360 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
365 #define MEDIA_DEVICE_PATH 0x04
367 #define MEDIA_HARDDRIVE_DP 0x01
369 EFI_DEVICE_PATH_PROTOCOL Header
;
370 UINT32 PartitionNumber
;
371 UINT64 PartitionStart
;
372 UINT64 PartitionSize
;
376 } HARDDRIVE_DEVICE_PATH
;
378 #define MBR_TYPE_PCAT 0x01
379 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
381 #define SIGNATURE_TYPE_MBR 0x01
382 #define SIGNATURE_TYPE_GUID 0x02
384 #define MEDIA_CDROM_DP 0x02
386 EFI_DEVICE_PATH_PROTOCOL Header
;
388 UINT64 PartitionStart
;
389 UINT64 PartitionSize
;
393 // Use VENDOR_DEVICE_PATH struct
395 #define MEDIA_VENDOR_DP 0x03
397 #define MEDIA_FILEPATH_DP 0x04
399 EFI_DEVICE_PATH_PROTOCOL Header
;
401 } FILEPATH_DEVICE_PATH
;
403 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
405 #define MEDIA_PROTOCOL_DP 0x05
407 EFI_DEVICE_PATH_PROTOCOL Header
;
409 } MEDIA_PROTOCOL_DEVICE_PATH
;
412 #define MEDIA_PIWG_FW_VOL_DP 0x7
414 EFI_DEVICE_PATH_PROTOCOL Header
;
416 } MEDIA_FW_VOL_DEVICE_PATH
;
419 #define MEDIA_PIWG_FW_FILE_DP 0x6
421 EFI_DEVICE_PATH_PROTOCOL Header
;
423 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
;
428 #define BBS_DEVICE_PATH 0x05
429 #define BBS_BBS_DP 0x01
431 EFI_DEVICE_PATH_PROTOCOL Header
;
435 } BBS_BBS_DEVICE_PATH
;
438 // DeviceType definitions - from BBS specification
440 #define BBS_TYPE_FLOPPY 0x01
441 #define BBS_TYPE_HARDDRIVE 0x02
442 #define BBS_TYPE_CDROM 0x03
443 #define BBS_TYPE_PCMCIA 0x04
444 #define BBS_TYPE_USB 0x05
445 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
446 #define BBS_TYPE_BEV 0x80
447 #define BBS_TYPE_UNKNOWN 0xFF
451 /// Union of all possible Device Paths and pointers to Device Paths
455 EFI_DEVICE_PATH_PROTOCOL DevPath
;
457 PCCARD_DEVICE_PATH PcCard
;
458 MEMMAP_DEVICE_PATH MemMap
;
459 VENDOR_DEVICE_PATH Vendor
;
461 CONTROLLER_DEVICE_PATH Controller
;
462 ACPI_HID_DEVICE_PATH Acpi
;
464 ATAPI_DEVICE_PATH Atapi
;
465 SCSI_DEVICE_PATH Scsi
;
466 ISCSI_DEVICE_PATH Iscsi
;
467 FIBRECHANNEL_DEVICE_PATH FibreChannel
;
469 F1394_DEVICE_PATH F1394
;
471 SATA_DEVICE_PATH Sata
;
472 USB_CLASS_DEVICE_PATH UsbClass
;
474 MAC_ADDR_DEVICE_PATH MacAddr
;
475 IPv4_DEVICE_PATH Ipv4
;
476 IPv6_DEVICE_PATH Ipv6
;
477 INFINIBAND_DEVICE_PATH InfiniBand
;
478 UART_DEVICE_PATH Uart
;
480 HARDDRIVE_DEVICE_PATH HardDrive
;
481 CDROM_DEVICE_PATH CD
;
483 FILEPATH_DEVICE_PATH FilePath
;
484 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol
;
486 BBS_BBS_DEVICE_PATH Bbs
;
492 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
493 PCI_DEVICE_PATH
*Pci
;
494 PCCARD_DEVICE_PATH
*PcCard
;
495 MEMMAP_DEVICE_PATH
*MemMap
;
496 VENDOR_DEVICE_PATH
*Vendor
;
498 CONTROLLER_DEVICE_PATH
*Controller
;
499 ACPI_HID_DEVICE_PATH
*Acpi
;
500 ACPI_EXTENDED_HID_DEVICE_PATH
*ExtendedAcpi
;
502 ATAPI_DEVICE_PATH
*Atapi
;
503 SCSI_DEVICE_PATH
*Scsi
;
504 FIBRECHANNEL_DEVICE_PATH
*FibreChannel
;
506 F1394_DEVICE_PATH
*F1394
;
507 USB_DEVICE_PATH
*Usb
;
508 SATA_DEVICE_PATH
*Sata
;
509 USB_CLASS_DEVICE_PATH
*UsbClass
;
510 I2O_DEVICE_PATH
*I2O
;
511 MAC_ADDR_DEVICE_PATH
*MacAddr
;
512 IPv4_DEVICE_PATH
*Ipv4
;
513 IPv6_DEVICE_PATH
*Ipv6
;
514 INFINIBAND_DEVICE_PATH
*InfiniBand
;
515 UART_DEVICE_PATH
*Uart
;
517 HARDDRIVE_DEVICE_PATH
*HardDrive
;
518 CDROM_DEVICE_PATH
*CD
;
520 FILEPATH_DEVICE_PATH
*FilePath
;
521 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProtocol
;
523 BBS_BBS_DEVICE_PATH
*Bbs
;
529 #define EFI_DP_TYPE_MASK 0x7F
530 #define EFI_DP_TYPE_UNPACKED 0x80
531 #define END_DEVICE_PATH_TYPE 0x7f
533 #define EFI_END_ENTIRE_DEVICE_PATH 0xff
534 #define EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
535 #define EFI_END_INSTANCE_DEVICE_PATH 0x01
536 #define END_ENTIRE_DEVICE_PATH_SUBTYPE EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE
537 #define END_INSTANCE_DEVICE_PATH_SUBTYPE EFI_END_INSTANCE_DEVICE_PATH
539 #define EFI_END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))
540 #define END_DEVICE_PATH_LENGTH EFI_END_DEVICE_PATH_LENGTH
542 #define DP_IS_END_TYPE(a)
543 #define DP_IS_END_SUBTYPE(a) (((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE)
544 #define DevicePathSubType(a) ((a)->SubType)
545 #define IsDevicePathUnpacked(a) ((a)->Type & EFI_DP_TYPE_UNPACKED)
547 #define EfiDevicePathNodeLength(a) (((a)->Length[0]) | ((a)->Length[1] << 8))
548 #define DevicePathNodeLength(a) (EfiDevicePathNodeLength(a))
549 #define EfiNextDevicePathNode(a) ((EFI_DEVICE_PATH_PROTOCOL *) (((UINT8 *) (a)) + EfiDevicePathNodeLength (a)))
550 #define NextDevicePathNode(a) (EfiNextDevicePathNode(a))
552 #define EfiDevicePathType(a) (((a)->Type) & EFI_DP_TYPE_MASK)
553 #define DevicePathType(a) (EfiDevicePathType(a))
554 #define EfiIsDevicePathEndType(a) (EfiDevicePathType (a) == END_DEVICE_PATH_TYPE)
555 #define IsDevicePathEndType(a) (EfiIsDevicePathEndType(a))
558 #define EfiIsDevicePathEndSubType(a) ((a)->SubType == EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE)
559 #define IsDevicePathEndSubType(a) (EfiIsDevicePathEndSubType(a))
560 #define EfiIsDevicePathEndInstanceSubType(a) ((a)->SubType == EFI_END_INSTANCE_DEVICE_PATH)
562 #define EfiIsDevicePathEnd(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndSubType (a))
563 #define IsDevicePathEnd(a) (EfiIsDevicePathEnd(a))
564 #define EfiIsDevicePathEndInstance(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndInstanceSubType (a))
567 #define SetDevicePathNodeLength(a,l) { \
568 (a)->Length[0] = (UINT8) (l); \
569 (a)->Length[1] = (UINT8) ((l) >> 8); \
572 #define SetDevicePathEndNode(a) { \
573 (a)->Type = END_DEVICE_PATH_TYPE; \
574 (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \
575 (a)->Length[0] = sizeof(EFI_DEVICE_PATH_PROTOCOL); \
576 (a)->Length[1] = 0; \
579 extern EFI_GUID gEfiDevicePathProtocolGuid
;