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
;
140 // Messaging Device Paths
142 #define MESSAGING_DEVICE_PATH 0x03
144 #define MSG_ATAPI_DP 0x01
146 EFI_DEVICE_PATH_PROTOCOL Header
;
147 UINT8 PrimarySecondary
;
152 #define MSG_SCSI_DP 0x02
154 EFI_DEVICE_PATH_PROTOCOL Header
;
159 #define MSG_FIBRECHANNEL_DP 0x03
161 EFI_DEVICE_PATH_PROTOCOL Header
;
165 } FIBRECHANNEL_DEVICE_PATH
;
167 #define MSG_1394_DP 0x04
169 EFI_DEVICE_PATH_PROTOCOL Header
;
174 #define MSG_USB_DP 0x05
176 EFI_DEVICE_PATH_PROTOCOL Header
;
177 UINT8 ParentPortNumber
;
178 UINT8 InterfaceNumber
;
181 #define MSG_USB_CLASS_DP 0x0f
183 EFI_DEVICE_PATH_PROTOCOL Header
;
187 UINT8 DeviceSubClass
;
188 UINT8 DeviceProtocol
;
189 } USB_CLASS_DEVICE_PATH
;
191 #define MSG_USB_WWID_DP 0x10
193 EFI_DEVICE_PATH_PROTOCOL Header
;
194 UINT16 InterfaceNumber
;
197 // CHAR16 SerialNumber[...];
198 } USB_WWID_DEVICE_PATH
;
201 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
203 EFI_DEVICE_PATH_PROTOCOL Header
;
205 } DEVICE_LOGICAL_UNIT_DEVICE_PATH
;
207 #define MSG_SATA_DP 0x12
209 EFI_DEVICE_PATH_PROTOCOL Header
;
210 UINT16 HBAPortNumber
;
211 UINT16 PortMultiplierPortNumber
;
215 #define MSG_I2O_DP 0x06
217 EFI_DEVICE_PATH_PROTOCOL Header
;
221 #define MSG_MAC_ADDR_DP 0x0b
223 EFI_DEVICE_PATH_PROTOCOL Header
;
224 EFI_MAC_ADDRESS MacAddress
;
226 } MAC_ADDR_DEVICE_PATH
;
228 #define MSG_IPv4_DP 0x0c
230 EFI_DEVICE_PATH_PROTOCOL Header
;
231 EFI_IPv4_ADDRESS LocalIpAddress
;
232 EFI_IPv4_ADDRESS RemoteIpAddress
;
236 BOOLEAN StaticIpAddress
;
239 #define MSG_IPv6_DP 0x0d
241 EFI_DEVICE_PATH_PROTOCOL Header
;
242 EFI_IPv6_ADDRESS LocalIpAddress
;
243 EFI_IPv6_ADDRESS RemoteIpAddress
;
247 BOOLEAN StaticIpAddress
;
250 #define MSG_INFINIBAND_DP 0x09
252 EFI_DEVICE_PATH_PROTOCOL Header
;
253 UINT32 ResourceFlags
;
258 } INFINIBAND_DEVICE_PATH
;
260 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
261 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
262 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
263 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
264 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
266 #define MSG_UART_DP 0x0e
268 EFI_DEVICE_PATH_PROTOCOL Header
;
277 // Use VENDOR_DEVICE_PATH struct
279 #define MSG_VENDOR_DP 0x0a
280 typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH
;
282 #define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID
283 #define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID
284 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
285 #define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID
287 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID
290 EFI_DEVICE_PATH_PROTOCOL Header
;
292 UINT32 FlowControlMap
;
293 } UART_FLOW_CONTROL_DEVICE_PATH
;
295 #define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID
298 EFI_DEVICE_PATH_PROTOCOL Header
;
303 UINT16 DeviceTopology
;
304 UINT16 RelativeTargetPort
;
307 #define MSG_ISCSI_DP 0x13
309 EFI_DEVICE_PATH_PROTOCOL Header
;
310 UINT16 NetworkProtocol
;
313 UINT16 TargetPortalGroupTag
;
314 // CHAR8 iSCSI Target Name
317 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
318 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
319 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
320 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
321 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
322 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
323 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
324 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
329 #define MEDIA_DEVICE_PATH 0x04
331 #define MEDIA_HARDDRIVE_DP 0x01
333 EFI_DEVICE_PATH_PROTOCOL Header
;
334 UINT32 PartitionNumber
;
335 UINT64 PartitionStart
;
336 UINT64 PartitionSize
;
340 } HARDDRIVE_DEVICE_PATH
;
342 #define MBR_TYPE_PCAT 0x01
343 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
345 #define SIGNATURE_TYPE_MBR 0x01
346 #define SIGNATURE_TYPE_GUID 0x02
348 #define MEDIA_CDROM_DP 0x02
350 EFI_DEVICE_PATH_PROTOCOL Header
;
352 UINT64 PartitionStart
;
353 UINT64 PartitionSize
;
357 // Use VENDOR_DEVICE_PATH struct
359 #define MEDIA_VENDOR_DP 0x03
361 #define MEDIA_FILEPATH_DP 0x04
363 EFI_DEVICE_PATH_PROTOCOL Header
;
365 } FILEPATH_DEVICE_PATH
;
367 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
369 #define MEDIA_PROTOCOL_DP 0x05
371 EFI_DEVICE_PATH_PROTOCOL Header
;
373 } MEDIA_PROTOCOL_DEVICE_PATH
;
376 #define MEDIA_PIWG_FW_VOL_DP 0x6
378 EFI_DEVICE_PATH_PROTOCOL Header
;
380 } MEDIA_FW_VOL_DEVICE_PATH
;
383 #define MEDIA_PIWG_FW_FILE_DP 0x7
385 EFI_DEVICE_PATH_PROTOCOL Header
;
387 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
;
392 #define BBS_DEVICE_PATH 0x05
393 #define BBS_BBS_DP 0x01
395 EFI_DEVICE_PATH_PROTOCOL Header
;
399 } BBS_BBS_DEVICE_PATH
;
402 // DeviceType definitions - from BBS specification
404 #define BBS_TYPE_FLOPPY 0x01
405 #define BBS_TYPE_HARDDRIVE 0x02
406 #define BBS_TYPE_CDROM 0x03
407 #define BBS_TYPE_PCMCIA 0x04
408 #define BBS_TYPE_USB 0x05
409 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
410 #define BBS_TYPE_BEV 0x80
411 #define BBS_TYPE_UNKNOWN 0xFF
415 // Union of all possible Device Paths and pointers to Device Paths
419 EFI_DEVICE_PATH_PROTOCOL DevPath
;
421 PCCARD_DEVICE_PATH PcCard
;
422 MEMMAP_DEVICE_PATH MemMap
;
423 VENDOR_DEVICE_PATH Vendor
;
425 CONTROLLER_DEVICE_PATH Controller
;
426 ACPI_HID_DEVICE_PATH Acpi
;
428 ATAPI_DEVICE_PATH Atapi
;
429 SCSI_DEVICE_PATH Scsi
;
430 ISCSI_DEVICE_PATH Iscsi
;
431 FIBRECHANNEL_DEVICE_PATH FibreChannel
;
433 F1394_DEVICE_PATH F1394
;
435 SATA_DEVICE_PATH Sata
;
436 USB_CLASS_DEVICE_PATH UsbClass
;
438 MAC_ADDR_DEVICE_PATH MacAddr
;
439 IPv4_DEVICE_PATH Ipv4
;
440 IPv6_DEVICE_PATH Ipv6
;
441 INFINIBAND_DEVICE_PATH InfiniBand
;
442 UART_DEVICE_PATH Uart
;
444 HARDDRIVE_DEVICE_PATH HardDrive
;
445 CDROM_DEVICE_PATH CD
;
447 FILEPATH_DEVICE_PATH FilePath
;
448 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol
;
450 BBS_BBS_DEVICE_PATH Bbs
;
456 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
457 PCI_DEVICE_PATH
*Pci
;
458 PCCARD_DEVICE_PATH
*PcCard
;
459 MEMMAP_DEVICE_PATH
*MemMap
;
460 VENDOR_DEVICE_PATH
*Vendor
;
462 CONTROLLER_DEVICE_PATH
*Controller
;
463 ACPI_HID_DEVICE_PATH
*Acpi
;
464 ACPI_EXTENDED_HID_DEVICE_PATH
*ExtendedAcpi
;
466 ATAPI_DEVICE_PATH
*Atapi
;
467 SCSI_DEVICE_PATH
*Scsi
;
468 FIBRECHANNEL_DEVICE_PATH
*FibreChannel
;
470 F1394_DEVICE_PATH
*F1394
;
471 USB_DEVICE_PATH
*Usb
;
472 SATA_DEVICE_PATH
*Sata
;
473 USB_CLASS_DEVICE_PATH
*UsbClass
;
474 I2O_DEVICE_PATH
*I2O
;
475 MAC_ADDR_DEVICE_PATH
*MacAddr
;
476 IPv4_DEVICE_PATH
*Ipv4
;
477 IPv6_DEVICE_PATH
*Ipv6
;
478 INFINIBAND_DEVICE_PATH
*InfiniBand
;
479 UART_DEVICE_PATH
*Uart
;
481 HARDDRIVE_DEVICE_PATH
*HardDrive
;
482 CDROM_DEVICE_PATH
*CD
;
484 FILEPATH_DEVICE_PATH
*FilePath
;
485 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProtocol
;
487 BBS_BBS_DEVICE_PATH
*Bbs
;
493 #define EFI_DP_TYPE_MASK 0x7F
494 #define EFI_DP_TYPE_UNPACKED 0x80
495 #define END_DEVICE_PATH_TYPE 0x7f
497 #define EFI_END_ENTIRE_DEVICE_PATH 0xff
498 #define EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
499 #define EFI_END_INSTANCE_DEVICE_PATH 0x01
500 #define END_ENTIRE_DEVICE_PATH_SUBTYPE EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE
501 #define END_INSTANCE_DEVICE_PATH_SUBTYPE EFI_END_INSTANCE_DEVICE_PATH
503 #define EFI_END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))
504 #define END_DEVICE_PATH_LENGTH EFI_END_DEVICE_PATH_LENGTH
506 #define DP_IS_END_TYPE(a)
507 #define DP_IS_END_SUBTYPE(a) (((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE)
508 #define DevicePathSubType(a) ((a)->SubType)
509 #define IsDevicePathUnpacked(a) ((a)->Type & EFI_DP_TYPE_UNPACKED)
511 #define EfiDevicePathNodeLength(a) (((a)->Length[0]) | ((a)->Length[1] << 8))
512 #define DevicePathNodeLength(a) (EfiDevicePathNodeLength(a))
513 #define EfiNextDevicePathNode(a) ((EFI_DEVICE_PATH_PROTOCOL *) (((UINT8 *) (a)) + EfiDevicePathNodeLength (a)))
514 #define NextDevicePathNode(a) (EfiNextDevicePathNode(a))
516 #define EfiDevicePathType(a) (((a)->Type) & EFI_DP_TYPE_MASK)
517 #define DevicePathType(a) (EfiDevicePathType(a))
518 #define EfiIsDevicePathEndType(a) (EfiDevicePathType (a) == END_DEVICE_PATH_TYPE)
519 #define IsDevicePathEndType(a) (EfiIsDevicePathEndType(a))
522 #define EfiIsDevicePathEndSubType(a) ((a)->SubType == EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE)
523 #define IsDevicePathEndSubType(a) (EfiIsDevicePathEndSubType(a))
524 #define EfiIsDevicePathEndInstanceSubType(a) ((a)->SubType == EFI_END_INSTANCE_DEVICE_PATH)
526 #define EfiIsDevicePathEnd(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndSubType (a))
527 #define IsDevicePathEnd(a) (EfiIsDevicePathEnd(a))
528 #define EfiIsDevicePathEndInstance(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndInstanceSubType (a))
531 #define SetDevicePathNodeLength(a,l) { \
532 (a)->Length[0] = (UINT8) (l); \
533 (a)->Length[1] = (UINT8) ((l) >> 8); \
536 #define SetDevicePathEndNode(a) { \
537 (a)->Type = END_DEVICE_PATH_TYPE; \
538 (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \
539 (a)->Length[0] = sizeof(EFI_DEVICE_PATH_PROTOCOL); \
540 (a)->Length[1] = 0; \
543 extern EFI_GUID gEfiDevicePathProtocolGuid
;