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, 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
47 } EFI_DEVICE_PATH_PROTOCOL
;
50 // For backward-compatible with EFI1.1.
52 typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH
;
55 // Hardware Device Paths
57 #define HARDWARE_DEVICE_PATH 0x01
59 #define HW_PCI_DP 0x01
61 EFI_DEVICE_PATH_PROTOCOL Header
;
66 #define HW_PCCARD_DP 0x02
68 EFI_DEVICE_PATH_PROTOCOL Header
;
72 #define HW_MEMMAP_DP 0x03
74 EFI_DEVICE_PATH_PROTOCOL Header
;
76 EFI_PHYSICAL_ADDRESS StartingAddress
;
77 EFI_PHYSICAL_ADDRESS EndingAddress
;
80 #define HW_VENDOR_DP 0x04
82 EFI_DEVICE_PATH_PROTOCOL Header
;
86 #define HW_CONTROLLER_DP 0x05
88 EFI_DEVICE_PATH_PROTOCOL Header
;
89 UINT32 ControllerNumber
;
90 } CONTROLLER_DEVICE_PATH
;
95 #define ACPI_DEVICE_PATH 0x02
99 EFI_DEVICE_PATH_PROTOCOL Header
;
102 } ACPI_HID_DEVICE_PATH
;
104 #define ACPI_EXTENDED_DP 0x02
106 EFI_DEVICE_PATH_PROTOCOL Header
;
111 // Optional variable length _HIDSTR
112 // Optional variable length _UIDSTR
114 } ACPI_EXTENDED_HID_DEVICE_PATH
;
118 // EISA ID Definition 32-bits
119 // bits[15:0] - three character compressed ASCII EISA ID.
120 // bits[31:16] - binary number
121 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
123 #define PNP_EISA_ID_CONST 0x41d0
124 #define EISA_ID(_Name, _Num) ((UINT32) ((_Name) | (_Num) << 16))
125 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
126 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
128 #define PNP_EISA_ID_MASK 0xffff
129 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
132 #define ACPI_ADR_DP 0x03
134 EFI_DEVICE_PATH_PROTOCOL Header
;
136 } ACPI_ADR_DEVICE_PATH
;
138 #define ACPI_ADR_DISPLAY_TYPE_OTHER 0
139 #define ACPI_ADR_DISPLAY_TYPE_VGA 1
140 #define ACPI_ADR_DISPLAY_TYPE_TV 2
141 #define ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL 3
142 #define ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL 4
144 #define ACPI_DISPLAY_ADR(_DeviceIdScheme, _HeadId, _NonVgaOutput, _BiosCanDetect, _VendorInfo, _Type, _Port, _Index) \
145 ((UINT32) ( (((_DeviceIdScheme) & 0x1) << 31) | \
146 (((_HeadId) & 0x7) << 18) | \
147 (((_NonVgaOutput) & 0x1) << 17) | \
148 (((_BiosCanDetect) & 0x1) << 16) | \
149 (((_VendorInfo) & 0xf) << 12) | \
150 (((_Type) & 0xf) << 8) | \
151 (((_Port) & 0xf) << 4) | \
155 // Messaging Device Paths
157 #define MESSAGING_DEVICE_PATH 0x03
159 #define MSG_ATAPI_DP 0x01
161 EFI_DEVICE_PATH_PROTOCOL Header
;
162 UINT8 PrimarySecondary
;
167 #define MSG_SCSI_DP 0x02
169 EFI_DEVICE_PATH_PROTOCOL Header
;
174 #define MSG_FIBRECHANNEL_DP 0x03
176 EFI_DEVICE_PATH_PROTOCOL Header
;
180 } FIBRECHANNEL_DEVICE_PATH
;
182 #define MSG_1394_DP 0x04
184 EFI_DEVICE_PATH_PROTOCOL Header
;
189 #define MSG_USB_DP 0x05
191 EFI_DEVICE_PATH_PROTOCOL Header
;
192 UINT8 ParentPortNumber
;
193 UINT8 InterfaceNumber
;
196 #define MSG_USB_CLASS_DP 0x0f
198 EFI_DEVICE_PATH_PROTOCOL Header
;
202 UINT8 DeviceSubClass
;
203 UINT8 DeviceProtocol
;
204 } USB_CLASS_DEVICE_PATH
;
206 #define MSG_USB_WWID_DP 0x10
208 EFI_DEVICE_PATH_PROTOCOL Header
;
209 UINT16 InterfaceNumber
;
212 // CHAR16 SerialNumber[...];
213 } USB_WWID_DEVICE_PATH
;
216 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
218 EFI_DEVICE_PATH_PROTOCOL Header
;
220 } DEVICE_LOGICAL_UNIT_DEVICE_PATH
;
222 #define MSG_SATA_DP 0x12
224 EFI_DEVICE_PATH_PROTOCOL Header
;
225 UINT16 HBAPortNumber
;
226 UINT16 PortMultiplierPortNumber
;
230 #define MSG_I2O_DP 0x06
232 EFI_DEVICE_PATH_PROTOCOL Header
;
236 #define MSG_MAC_ADDR_DP 0x0b
238 EFI_DEVICE_PATH_PROTOCOL Header
;
239 EFI_MAC_ADDRESS MacAddress
;
241 } MAC_ADDR_DEVICE_PATH
;
243 #define MSG_IPv4_DP 0x0c
245 EFI_DEVICE_PATH_PROTOCOL Header
;
246 EFI_IPv4_ADDRESS LocalIpAddress
;
247 EFI_IPv4_ADDRESS RemoteIpAddress
;
251 BOOLEAN StaticIpAddress
;
254 #define MSG_IPv6_DP 0x0d
256 EFI_DEVICE_PATH_PROTOCOL Header
;
257 EFI_IPv6_ADDRESS LocalIpAddress
;
258 EFI_IPv6_ADDRESS RemoteIpAddress
;
262 BOOLEAN StaticIpAddress
;
265 #define MSG_INFINIBAND_DP 0x09
267 EFI_DEVICE_PATH_PROTOCOL Header
;
268 UINT32 ResourceFlags
;
273 } INFINIBAND_DEVICE_PATH
;
275 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
276 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
277 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
278 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
279 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
281 #define MSG_UART_DP 0x0e
283 EFI_DEVICE_PATH_PROTOCOL Header
;
292 // Use VENDOR_DEVICE_PATH struct
294 #define MSG_VENDOR_DP 0x0a
295 typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH
;
297 #define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID
298 #define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID
299 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
300 #define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID
302 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID
305 EFI_DEVICE_PATH_PROTOCOL Header
;
307 UINT32 FlowControlMap
;
308 } UART_FLOW_CONTROL_DEVICE_PATH
;
310 #define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID
313 EFI_DEVICE_PATH_PROTOCOL Header
;
318 UINT16 DeviceTopology
;
319 UINT16 RelativeTargetPort
;
322 #define MSG_ISCSI_DP 0x13
324 EFI_DEVICE_PATH_PROTOCOL Header
;
325 UINT16 NetworkProtocol
;
328 UINT16 TargetPortalGroupTag
;
329 // CHAR8 iSCSI Target Name
332 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
333 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
334 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
335 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
336 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
337 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
338 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
339 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
344 #define MEDIA_DEVICE_PATH 0x04
346 #define MEDIA_HARDDRIVE_DP 0x01
348 EFI_DEVICE_PATH_PROTOCOL Header
;
349 UINT32 PartitionNumber
;
350 UINT64 PartitionStart
;
351 UINT64 PartitionSize
;
355 } HARDDRIVE_DEVICE_PATH
;
357 #define MBR_TYPE_PCAT 0x01
358 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
360 #define SIGNATURE_TYPE_MBR 0x01
361 #define SIGNATURE_TYPE_GUID 0x02
363 #define MEDIA_CDROM_DP 0x02
365 EFI_DEVICE_PATH_PROTOCOL Header
;
367 UINT64 PartitionStart
;
368 UINT64 PartitionSize
;
372 // Use VENDOR_DEVICE_PATH struct
374 #define MEDIA_VENDOR_DP 0x03
376 #define MEDIA_FILEPATH_DP 0x04
378 EFI_DEVICE_PATH_PROTOCOL Header
;
380 } FILEPATH_DEVICE_PATH
;
382 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
384 #define MEDIA_PROTOCOL_DP 0x05
386 EFI_DEVICE_PATH_PROTOCOL Header
;
388 } MEDIA_PROTOCOL_DEVICE_PATH
;
391 #define MEDIA_PIWG_FW_VOL_DP 0x7
393 EFI_DEVICE_PATH_PROTOCOL Header
;
395 } MEDIA_FW_VOL_DEVICE_PATH
;
398 #define MEDIA_PIWG_FW_FILE_DP 0x6
400 EFI_DEVICE_PATH_PROTOCOL Header
;
402 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
;
407 #define BBS_DEVICE_PATH 0x05
408 #define BBS_BBS_DP 0x01
410 EFI_DEVICE_PATH_PROTOCOL Header
;
414 } BBS_BBS_DEVICE_PATH
;
417 // DeviceType definitions - from BBS specification
419 #define BBS_TYPE_FLOPPY 0x01
420 #define BBS_TYPE_HARDDRIVE 0x02
421 #define BBS_TYPE_CDROM 0x03
422 #define BBS_TYPE_PCMCIA 0x04
423 #define BBS_TYPE_USB 0x05
424 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
425 #define BBS_TYPE_BEV 0x80
426 #define BBS_TYPE_UNKNOWN 0xFF
430 // Union of all possible Device Paths and pointers to Device Paths
434 EFI_DEVICE_PATH_PROTOCOL DevPath
;
436 PCCARD_DEVICE_PATH PcCard
;
437 MEMMAP_DEVICE_PATH MemMap
;
438 VENDOR_DEVICE_PATH Vendor
;
440 CONTROLLER_DEVICE_PATH Controller
;
441 ACPI_HID_DEVICE_PATH Acpi
;
443 ATAPI_DEVICE_PATH Atapi
;
444 SCSI_DEVICE_PATH Scsi
;
445 ISCSI_DEVICE_PATH Iscsi
;
446 FIBRECHANNEL_DEVICE_PATH FibreChannel
;
448 F1394_DEVICE_PATH F1394
;
450 SATA_DEVICE_PATH Sata
;
451 USB_CLASS_DEVICE_PATH UsbClass
;
453 MAC_ADDR_DEVICE_PATH MacAddr
;
454 IPv4_DEVICE_PATH Ipv4
;
455 IPv6_DEVICE_PATH Ipv6
;
456 INFINIBAND_DEVICE_PATH InfiniBand
;
457 UART_DEVICE_PATH Uart
;
459 HARDDRIVE_DEVICE_PATH HardDrive
;
460 CDROM_DEVICE_PATH CD
;
462 FILEPATH_DEVICE_PATH FilePath
;
463 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol
;
465 BBS_BBS_DEVICE_PATH Bbs
;
471 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
472 PCI_DEVICE_PATH
*Pci
;
473 PCCARD_DEVICE_PATH
*PcCard
;
474 MEMMAP_DEVICE_PATH
*MemMap
;
475 VENDOR_DEVICE_PATH
*Vendor
;
477 CONTROLLER_DEVICE_PATH
*Controller
;
478 ACPI_HID_DEVICE_PATH
*Acpi
;
479 ACPI_EXTENDED_HID_DEVICE_PATH
*ExtendedAcpi
;
481 ATAPI_DEVICE_PATH
*Atapi
;
482 SCSI_DEVICE_PATH
*Scsi
;
483 FIBRECHANNEL_DEVICE_PATH
*FibreChannel
;
485 F1394_DEVICE_PATH
*F1394
;
486 USB_DEVICE_PATH
*Usb
;
487 SATA_DEVICE_PATH
*Sata
;
488 USB_CLASS_DEVICE_PATH
*UsbClass
;
489 I2O_DEVICE_PATH
*I2O
;
490 MAC_ADDR_DEVICE_PATH
*MacAddr
;
491 IPv4_DEVICE_PATH
*Ipv4
;
492 IPv6_DEVICE_PATH
*Ipv6
;
493 INFINIBAND_DEVICE_PATH
*InfiniBand
;
494 UART_DEVICE_PATH
*Uart
;
496 HARDDRIVE_DEVICE_PATH
*HardDrive
;
497 CDROM_DEVICE_PATH
*CD
;
499 FILEPATH_DEVICE_PATH
*FilePath
;
500 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProtocol
;
502 BBS_BBS_DEVICE_PATH
*Bbs
;
508 #define EFI_DP_TYPE_MASK 0x7F
509 #define EFI_DP_TYPE_UNPACKED 0x80
510 #define END_DEVICE_PATH_TYPE 0x7f
512 #define EFI_END_ENTIRE_DEVICE_PATH 0xff
513 #define EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
514 #define EFI_END_INSTANCE_DEVICE_PATH 0x01
515 #define END_ENTIRE_DEVICE_PATH_SUBTYPE EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE
516 #define END_INSTANCE_DEVICE_PATH_SUBTYPE EFI_END_INSTANCE_DEVICE_PATH
518 #define EFI_END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))
519 #define END_DEVICE_PATH_LENGTH EFI_END_DEVICE_PATH_LENGTH
521 #define DP_IS_END_TYPE(a)
522 #define DP_IS_END_SUBTYPE(a) (((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE)
523 #define DevicePathSubType(a) ((a)->SubType)
524 #define IsDevicePathUnpacked(a) ((a)->Type & EFI_DP_TYPE_UNPACKED)
526 #define EfiDevicePathNodeLength(a) (((a)->Length[0]) | ((a)->Length[1] << 8))
527 #define DevicePathNodeLength(a) (EfiDevicePathNodeLength(a))
528 #define EfiNextDevicePathNode(a) ((EFI_DEVICE_PATH_PROTOCOL *) (((UINT8 *) (a)) + EfiDevicePathNodeLength (a)))
529 #define NextDevicePathNode(a) (EfiNextDevicePathNode(a))
531 #define EfiDevicePathType(a) (((a)->Type) & EFI_DP_TYPE_MASK)
532 #define DevicePathType(a) (EfiDevicePathType(a))
533 #define EfiIsDevicePathEndType(a) (EfiDevicePathType (a) == END_DEVICE_PATH_TYPE)
534 #define IsDevicePathEndType(a) (EfiIsDevicePathEndType(a))
537 #define EfiIsDevicePathEndSubType(a) ((a)->SubType == EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE)
538 #define IsDevicePathEndSubType(a) (EfiIsDevicePathEndSubType(a))
539 #define EfiIsDevicePathEndInstanceSubType(a) ((a)->SubType == EFI_END_INSTANCE_DEVICE_PATH)
541 #define EfiIsDevicePathEnd(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndSubType (a))
542 #define IsDevicePathEnd(a) (EfiIsDevicePathEnd(a))
543 #define EfiIsDevicePathEndInstance(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndInstanceSubType (a))
546 #define SetDevicePathNodeLength(a,l) { \
547 (a)->Length[0] = (UINT8) (l); \
548 (a)->Length[1] = (UINT8) ((l) >> 8); \
551 #define SetDevicePathEndNode(a) { \
552 (a)->Type = END_DEVICE_PATH_TYPE; \
553 (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \
554 (a)->Length[0] = sizeof(EFI_DEVICE_PATH_PROTOCOL); \
555 (a)->Length[1] = 0; \
558 extern EFI_GUID gEfiDevicePathProtocolGuid
;