2 The device path protocol as defined in EFI 1.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.
17 Module Name: DevicePath.h
21 #ifndef __EFI_DEVICE_PATH_PROTOCOL_H__
22 #define __EFI_DEVICE_PATH_PROTOCOL_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 // Device Path information
42 } EFI_DEVICE_PATH_PROTOCOL
;
45 // Hardware Device Paths
47 #define HARDWARE_DEVICE_PATH 0x01
49 #define HW_PCI_DP 0x01
51 EFI_DEVICE_PATH_PROTOCOL Header
;
56 #define HW_PCCARD_DP 0x02
58 EFI_DEVICE_PATH_PROTOCOL Header
;
62 #define HW_MEMMAP_DP 0x03
64 EFI_DEVICE_PATH_PROTOCOL Header
;
66 EFI_PHYSICAL_ADDRESS StartingAddress
;
67 EFI_PHYSICAL_ADDRESS EndingAddress
;
70 #define HW_VENDOR_DP 0x04
72 EFI_DEVICE_PATH_PROTOCOL Header
;
76 #define HW_CONTROLLER_DP 0x05
78 EFI_DEVICE_PATH_PROTOCOL Header
;
79 UINT32 ControllerNumber
;
80 } CONTROLLER_DEVICE_PATH
;
85 #define ACPI_DEVICE_PATH 0x02
89 EFI_DEVICE_PATH_PROTOCOL Header
;
92 } ACPI_HID_DEVICE_PATH
;
94 #define ACPI_EXTENDED_DP 0x02
96 EFI_DEVICE_PATH_PROTOCOL Header
;
101 // Optional variable length _HIDSTR
102 // Optional variable length _UIDSTR
104 } ACPI_EXTENDED_HID_DEVICE_PATH
;
108 // EISA ID Definition 32-bits
109 // bits[15:0] - three character compressed ASCII EISA ID.
110 // bits[31:16] - binary number
111 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
113 #define PNP_EISA_ID_CONST 0x41d0
114 #define EISA_ID(_Name, _Num) ((UINT32) ((_Name) | (_Num) << 16))
115 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
116 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
118 #define PNP_EISA_ID_MASK 0xffff
119 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
122 #define ACPI_ADR_DP 0x03
124 EFI_DEVICE_PATH_PROTOCOL Header
;
126 } ACPI_ADR_DEVICE_PATH
;
130 // Messaging Device Paths
132 #define MESSAGING_DEVICE_PATH 0x03
134 #define MSG_ATAPI_DP 0x01
136 EFI_DEVICE_PATH_PROTOCOL Header
;
137 UINT8 PrimarySecondary
;
142 #define MSG_SCSI_DP 0x02
144 EFI_DEVICE_PATH_PROTOCOL Header
;
149 #define MSG_FIBRECHANNEL_DP 0x03
151 EFI_DEVICE_PATH_PROTOCOL Header
;
155 } FIBRECHANNEL_DEVICE_PATH
;
157 #define MSG_1394_DP 0x04
159 EFI_DEVICE_PATH_PROTOCOL Header
;
164 #define MSG_USB_DP 0x05
166 EFI_DEVICE_PATH_PROTOCOL Header
;
167 UINT8 ParentPortNumber
;
168 UINT8 InterfaceNumber
;
171 #define MSG_USB_CLASS_DP 0x0f
173 EFI_DEVICE_PATH_PROTOCOL Header
;
177 UINT8 DeviceSubClass
;
178 UINT8 DeviceProtocol
;
179 } USB_CLASS_DEVICE_PATH
;
181 #define MSG_USB_WWID_DP 0x10
183 EFI_DEVICE_PATH_PROTOCOL Header
;
184 UINT16 InterfaceNumber
;
187 // CHAR16 SerialNumber[...];
188 } USB_WWID_DEVICE_PATH
;
191 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
193 EFI_DEVICE_PATH_PROTOCOL Header
;
195 } DEVICE_LOGICAL_UNIT_DEVICE_PATH
;
197 #define MSG_SATA_DP 0x12
199 EFI_DEVICE_PATH_PROTOCOL Header
;
200 UINT16 HbaPortNumber
;
201 UINT16 PortMultiplierPort
;
202 UINT16 LogicalUnitNumber
;
205 #define MSG_I2O_DP 0x06
207 EFI_DEVICE_PATH_PROTOCOL Header
;
211 #define MSG_MAC_ADDR_DP 0x0b
213 EFI_DEVICE_PATH_PROTOCOL Header
;
214 EFI_MAC_ADDRESS MacAddress
;
216 } MAC_ADDR_DEVICE_PATH
;
218 #define MSG_IPv4_DP 0x0c
220 EFI_DEVICE_PATH_PROTOCOL Header
;
221 EFI_IPv4_ADDRESS LocalIpAddress
;
222 EFI_IPv4_ADDRESS RemoteIpAddress
;
226 BOOLEAN StaticIpAddress
;
229 #define MSG_IPv6_DP 0x0d
231 EFI_DEVICE_PATH_PROTOCOL Header
;
232 EFI_IPv6_ADDRESS LocalIpAddress
;
233 EFI_IPv6_ADDRESS RemoteIpAddress
;
237 BOOLEAN StaticIpAddress
;
240 #define MSG_INFINIBAND_DP 0x09
242 EFI_DEVICE_PATH_PROTOCOL Header
;
243 UINT32 ResourceFlags
;
248 } INFINIBAND_DEVICE_PATH
;
250 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
251 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
252 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
253 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
254 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
256 #define MSG_UART_DP 0x0e
258 EFI_DEVICE_PATH_PROTOCOL Header
;
267 // Use VENDOR_DEVICE_PATH struct
269 #define MSG_VENDOR_DP 0x0a
270 typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH
;
272 #define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID
273 #define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID
274 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
275 #define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID
277 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID
280 EFI_DEVICE_PATH_PROTOCOL Header
;
282 UINT32 FlowControlMap
;
283 } UART_FLOW_CONTROL_DEVICE_PATH
;
285 #define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID
288 EFI_DEVICE_PATH_PROTOCOL Header
;
293 UINT16 DeviceTopology
;
294 UINT16 RelativeTargetPort
;
297 #define MSG_ISCSI_DP 0x13
299 EFI_DEVICE_PATH_PROTOCOL Header
;
300 UINT16 NetworkProtocol
;
303 UINT16 TargetPortalGroupTag
;
305 // CHAR8 iSCSI Target Name
308 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
309 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
310 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
311 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
312 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
313 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
314 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
315 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
320 #define MEDIA_DEVICE_PATH 0x04
322 #define MEDIA_HARDDRIVE_DP 0x01
324 EFI_DEVICE_PATH_PROTOCOL Header
;
325 UINT32 PartitionNumber
;
326 UINT64 PartitionStart
;
327 UINT64 PartitionSize
;
331 } HARDDRIVE_DEVICE_PATH
;
333 #define MBR_TYPE_PCAT 0x01
334 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
336 #define SIGNATURE_TYPE_MBR 0x01
337 #define SIGNATURE_TYPE_GUID 0x02
339 #define MEDIA_CDROM_DP 0x02
341 EFI_DEVICE_PATH_PROTOCOL Header
;
343 UINT64 PartitionStart
;
344 UINT64 PartitionSize
;
348 // Use VENDOR_DEVICE_PATH struct
350 #define MEDIA_VENDOR_DP 0x03
352 #define MEDIA_FILEPATH_DP 0x04
354 EFI_DEVICE_PATH_PROTOCOL Header
;
356 } FILEPATH_DEVICE_PATH
;
358 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
360 #define MEDIA_PROTOCOL_DP 0x05
362 EFI_DEVICE_PATH_PROTOCOL Header
;
364 } MEDIA_PROTOCOL_DEVICE_PATH
;
367 #define MEDIA_PIWG_FW_VOL_DP 0x6
368 typedef MEDIA_PROTOCOL_DEVICE_PATH MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
;
371 #define MEDIA_PIWG_FW_FILE_DP 0x7
372 typedef MEDIA_PROTOCOL_DEVICE_PATH MEDIA_FW_VOL_DEVICE_PATH
;
377 #define BBS_DEVICE_PATH 0x05
378 #define BBS_BBS_DP 0x01
380 EFI_DEVICE_PATH_PROTOCOL Header
;
384 } BBS_BBS_DEVICE_PATH
;
387 // DeviceType definitions - from BBS specification
389 #define BBS_TYPE_FLOPPY 0x01
390 #define BBS_TYPE_HARDDRIVE 0x02
391 #define BBS_TYPE_CDROM 0x03
392 #define BBS_TYPE_PCMCIA 0x04
393 #define BBS_TYPE_USB 0x05
394 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
395 #define BBS_TYPE_BEV 0x80
396 #define BBS_TYPE_UNKNOWN 0xFF
400 // Union of all possible Device Paths and pointers to Device Paths
404 EFI_DEVICE_PATH_PROTOCOL DevPath
;
406 PCCARD_DEVICE_PATH PcCard
;
407 MEMMAP_DEVICE_PATH MemMap
;
408 VENDOR_DEVICE_PATH Vendor
;
410 CONTROLLER_DEVICE_PATH Controller
;
411 ACPI_HID_DEVICE_PATH Acpi
;
413 ATAPI_DEVICE_PATH Atapi
;
414 SCSI_DEVICE_PATH Scsi
;
415 FIBRECHANNEL_DEVICE_PATH FibreChannel
;
417 F1394_DEVICE_PATH F1394
;
419 SATA_DEVICE_PATH Sata
;
420 USB_CLASS_DEVICE_PATH UsbClass
;
422 MAC_ADDR_DEVICE_PATH MacAddr
;
423 IPv4_DEVICE_PATH Ipv4
;
424 IPv6_DEVICE_PATH Ipv6
;
425 INFINIBAND_DEVICE_PATH InfiniBand
;
426 UART_DEVICE_PATH Uart
;
428 HARDDRIVE_DEVICE_PATH HardDrive
;
429 CDROM_DEVICE_PATH CD
;
431 FILEPATH_DEVICE_PATH FilePath
;
432 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol
;
434 BBS_BBS_DEVICE_PATH Bbs
;
440 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
441 PCI_DEVICE_PATH
*Pci
;
442 PCCARD_DEVICE_PATH
*PcCard
;
443 MEMMAP_DEVICE_PATH
*MemMap
;
444 VENDOR_DEVICE_PATH
*Vendor
;
446 CONTROLLER_DEVICE_PATH
*Controller
;
447 ACPI_HID_DEVICE_PATH
*Acpi
;
448 ACPI_EXTENDED_HID_DEVICE_PATH
*ExtendedAcpi
;
450 ATAPI_DEVICE_PATH
*Atapi
;
451 SCSI_DEVICE_PATH
*Scsi
;
452 FIBRECHANNEL_DEVICE_PATH
*FibreChannel
;
454 F1394_DEVICE_PATH
*F1394
;
455 USB_DEVICE_PATH
*Usb
;
456 SATA_DEVICE_PATH
*Sata
;
457 USB_CLASS_DEVICE_PATH
*UsbClass
;
458 I2O_DEVICE_PATH
*I2O
;
459 MAC_ADDR_DEVICE_PATH
*MacAddr
;
460 IPv4_DEVICE_PATH
*Ipv4
;
461 IPv6_DEVICE_PATH
*Ipv6
;
462 INFINIBAND_DEVICE_PATH
*InfiniBand
;
463 UART_DEVICE_PATH
*Uart
;
465 HARDDRIVE_DEVICE_PATH
*HardDrive
;
466 CDROM_DEVICE_PATH
*CD
;
468 FILEPATH_DEVICE_PATH
*FilePath
;
469 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProtocol
;
471 BBS_BBS_DEVICE_PATH
*Bbs
;
477 #define EFI_DP_TYPE_MASK 0x7F
478 #define EFI_DP_TYPE_UNPACKED 0x80
479 #define END_DEVICE_PATH_TYPE 0x7f
481 #define EFI_END_ENTIRE_DEVICE_PATH 0xff
482 #define EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
483 #define EFI_END_INSTANCE_DEVICE_PATH 0x01
484 #define END_ENTIRE_DEVICE_PATH_SUBTYPE EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE
485 #define END_INSTANCE_DEVICE_PATH_SUBTYPE EFI_END_INSTANCE_DEVICE_PATH
487 #define EFI_END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))
488 #define END_DEVICE_PATH_LENGTH EFI_END_DEVICE_PATH_LENGTH
490 #define DP_IS_END_TYPE(a)
491 #define DP_IS_END_SUBTYPE(a) (((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE)
492 #define DevicePathSubType(a) ((a)->SubType)
493 #define IsDevicePathUnpacked(a) ((a)->Type & EFI_DP_TYPE_UNPACKED)
495 #define EfiDevicePathNodeLength(a) (((a)->Length[0]) | ((a)->Length[1] << 8))
496 #define DevicePathNodeLength(a) (EfiDevicePathNodeLength(a))
497 #define EfiNextDevicePathNode(a) ((EFI_DEVICE_PATH_PROTOCOL *) (((UINT8 *) (a)) + EfiDevicePathNodeLength (a)))
498 #define NextDevicePathNode(a) (EfiNextDevicePathNode(a))
500 #define EfiDevicePathType(a) (((a)->Type) & EFI_DP_TYPE_MASK)
501 #define DevicePathType(a) (EfiDevicePathType(a))
502 #define EfiIsDevicePathEndType(a) (EfiDevicePathType (a) == END_DEVICE_PATH_TYPE)
503 #define IsDevicePathEndType(a) (EfiIsDevicePathEndType(a))
506 #define EfiIsDevicePathEndSubType(a) ((a)->SubType == EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE)
507 #define IsDevicePathEndSubType(a) (EfiIsDevicePathEndSubType(a))
508 #define EfiIsDevicePathEndInstanceSubType(a) ((a)->SubType == EFI_END_INSTANCE_DEVICE_PATH)
510 #define EfiIsDevicePathEnd(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndSubType (a))
511 #define IsDevicePathEnd(a) (EfiIsDevicePathEnd(a))
512 #define EfiIsDevicePathEndInstance(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndInstanceSubType (a))
515 #define SetDevicePathNodeLength(a,l) { \
516 (a)->Length[0] = (UINT8) (l); \
517 (a)->Length[1] = (UINT8) ((l) >> 8); \
520 #define SetDevicePathEndNode(a) { \
521 (a)->Type = END_DEVICE_PATH_TYPE; \
522 (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \
523 (a)->Length[0] = sizeof(EFI_DEVICE_PATH_PROTOCOL); \
524 (a)->Length[1] = 0; \
527 extern EFI_GUID gEfiDevicePathProtocolGuid
;