3 Copyright (c) 2004 - 2009, Intel Corporation. All rights reserved.<BR>
4 This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 EFI Device Path definitions
22 #ifndef _EFI_DEVICE_PATH_H
23 #define _EFI_DEVICE_PATH_H
31 // Device Path defines and macros
33 #define EFI_DP_TYPE_MASK 0x7F
34 #define EFI_DP_TYPE_UNPACKED 0x80
35 #define END_DEVICE_PATH_TYPE 0x7f
36 #define END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
37 #define END_INSTANCE_DEVICE_PATH_SUBTYPE 0x01
38 #define END_DEVICE_PATH_LENGTH (sizeof(EFI_DEVICE_PATH_PROTOCOL))
40 #define DP_IS_END_TYPE(a)
41 #define DP_IS_END_SUBTYPE(a) ( ((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
43 #define DevicePathType(a) ( ((a)->Type) & EFI_DP_TYPE_MASK )
44 #define DevicePathSubType(a) ( (a)->SubType )
45 #define DevicePathNodeLength(a) ( ((a)->Length[0]) | ((a)->Length[1] << 8) )
46 #define NextDevicePathNode(a) ( (EFI_DEVICE_PATH_PROTOCOL *) ( ((UINT8 *) (a)) + DevicePathNodeLength(a)))
47 #define IsDevicePathEndType(a) ( DevicePathType(a) == END_DEVICE_PATH_TYPE )
48 #define IsDevicePathEndSubType(a) ( (a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE )
49 #define IsDevicePathEnd(a) ( IsDevicePathEndType(a) && IsDevicePathEndSubType(a) )
50 #define IsDevicePathUnpacked(a) ( (a)->Type & EFI_DP_TYPE_UNPACKED )
53 #define SetDevicePathNodeLength(a,l) { \
54 (a)->Length[0] = (UINT8) (l); \
55 (a)->Length[1] = (UINT8) ((l) >> 8); \
58 #define SetDevicePathEndNode(a) { \
59 (a)->Type = END_DEVICE_PATH_TYPE; \
60 (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \
61 (a)->Length[0] = sizeof(EFI_DEVICE_PATH_PROTOCOL); \
66 // Hardware Device Paths
68 #define HARDWARE_DEVICE_PATH 0x01
70 #define HW_PCI_DP 0x01
72 EFI_DEVICE_PATH_PROTOCOL Header
;
77 #define HW_PCCARD_DP 0x02
79 EFI_DEVICE_PATH_PROTOCOL Header
;
83 #define HW_MEMMAP_DP 0x03
85 EFI_DEVICE_PATH_PROTOCOL Header
;
87 EFI_PHYSICAL_ADDRESS StartingAddress
;
88 EFI_PHYSICAL_ADDRESS EndingAddress
;
91 #define HW_VENDOR_DP 0x04
93 EFI_DEVICE_PATH_PROTOCOL Header
;
97 #define HW_CONTROLLER_DP 0x05
99 EFI_DEVICE_PATH_PROTOCOL Header
;
101 } CONTROLLER_DEVICE_PATH
;
106 #define ACPI_DEVICE_PATH 0x02
110 EFI_DEVICE_PATH_PROTOCOL Header
;
113 } ACPI_HID_DEVICE_PATH
;
115 #define ACPI_EXTENDED_DP 0x02
117 EFI_DEVICE_PATH_PROTOCOL Header
;
122 // Optional variable length _HIDSTR
123 // Optional variable length _UIDSTR
125 } ACPI_EXTENDED_HID_DEVICE_PATH
;
127 #define ACPI_ADR_DP 0x03
130 EFI_DEVICE_PATH_PROTOCOL Header
;
132 } ACPI_ADR_DEVICE_PATH
;
134 #define ACPI_ADR_DISPLAY_TYPE_OTHER 0
135 #define ACPI_ADR_DISPLAY_TYPE_VGA 1
136 #define ACPI_ADR_DISPLAY_TYPE_TV 2
137 #define ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL 3
138 #define ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL 4
140 #define ACPI_DISPLAY_ADR(_DeviceIdScheme, _HeadId, _NonVgaOutput, _BiosCanDetect, _VendorInfo, _Type, _Port, _Index) \
141 ((UINT32) ( (((_DeviceIdScheme) & 0x1) << 31) | \
142 (((_HeadId) & 0x7) << 18) | \
143 (((_NonVgaOutput) & 0x1) << 17) | \
144 (((_BiosCanDetect) & 0x1) << 16) | \
145 (((_VendorInfo) & 0xf) << 12) | \
146 (((_Type) & 0xf) << 8) | \
147 (((_Port) & 0xf) << 4) | \
152 // EISA ID Definition 32-bits
153 // bits[15:0] - three character compressed ASCII EISA ID.
154 // bits[31:16] - binary number
155 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
157 #define PNP_EISA_ID_CONST 0x41d0
158 #define EISA_ID(_Name, _Num) ((UINT32) ((_Name) | (_Num) << 16))
159 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
160 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
162 #define PNP_EISA_ID_MASK 0xffff
163 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
166 // Messaging Device Paths
168 #define MESSAGING_DEVICE_PATH 0x03
170 #define MSG_ATAPI_DP 0x01
172 EFI_DEVICE_PATH_PROTOCOL Header
;
173 UINT8 PrimarySecondary
;
178 #define MSG_SCSI_DP 0x02
180 EFI_DEVICE_PATH_PROTOCOL Header
;
185 #define MSG_FIBRECHANNEL_DP 0x03
187 EFI_DEVICE_PATH_PROTOCOL Header
;
191 } FIBRECHANNEL_DEVICE_PATH
;
193 #define MSG_1394_DP 0x04
195 EFI_DEVICE_PATH_PROTOCOL Header
;
200 #define MSG_USB_DP 0x05
202 EFI_DEVICE_PATH_PROTOCOL Header
;
203 UINT8 ParentPortNumber
;
204 UINT8 InterfaceNumber
;
207 #define MSG_USB_CLASS_DP 0x0f
209 EFI_DEVICE_PATH_PROTOCOL Header
;
213 UINT8 DeviceSubClass
;
214 UINT8 DeviceProtocol
;
215 } USB_CLASS_DEVICE_PATH
;
217 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
218 #define MSG_USB_WWID_DP 0x10
220 EFI_DEVICE_PATH_PROTOCOL Header
;
221 UINT16 InterfaceNumber
;
225 // CHAR16 SerialNumber[];
227 } USB_WWID_DEVICE_PATH
;
229 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
231 EFI_DEVICE_PATH_PROTOCOL Header
;
233 } DEVICE_LOGICAL_UNIT_DEVICE_PATH
;
236 #define MSG_SATA_DP 0x12
238 EFI_DEVICE_PATH_PROTOCOL Header
;
239 UINT16 HBAPortNumber
;
240 UINT16 PortMultiplierPortNumber
;
244 #define SATA_HBA_DIRECT_CONNECT_FLAG 0x8000
246 #define MSG_I2O_DP 0x06
248 EFI_DEVICE_PATH_PROTOCOL Header
;
252 #define MSG_MAC_ADDR_DP 0x0b
254 EFI_DEVICE_PATH_PROTOCOL Header
;
255 EFI_MAC_ADDRESS MacAddress
;
257 } MAC_ADDR_DEVICE_PATH
;
259 #define MSG_IPv4_DP 0x0c
261 EFI_DEVICE_PATH_PROTOCOL Header
;
262 EFI_IPv4_ADDRESS LocalIpAddress
;
263 EFI_IPv4_ADDRESS RemoteIpAddress
;
267 BOOLEAN StaticIpAddress
;
270 #define MSG_IPv6_DP 0x0d
272 EFI_DEVICE_PATH_PROTOCOL Header
;
273 EFI_IPv6_ADDRESS LocalIpAddress
;
274 EFI_IPv6_ADDRESS RemoteIpAddress
;
278 BOOLEAN StaticIpAddress
;
281 #define MSG_INFINIBAND_DP 0x09
283 EFI_DEVICE_PATH_PROTOCOL Header
;
284 UINT32 ResourceFlags
;
289 } INFINIBAND_DEVICE_PATH
;
291 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
292 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
293 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
294 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
295 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
297 #define MSG_UART_DP 0x0e
299 EFI_DEVICE_PATH_PROTOCOL Header
;
308 // Use VENDOR_DEVICE_PATH struct
310 #define MSG_VENDOR_DP 0x0a
312 #define DEVICE_PATH_MESSAGING_PC_ANSI \
313 { 0xe0c14753, 0xf9be, 0x11d2, {0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
315 #define DEVICE_PATH_MESSAGING_VT_100 \
316 { 0xdfa66065, 0xb419, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
318 #define DEVICE_PATH_MESSAGING_VT_100_PLUS \
319 { 0x7baec70b, 0x57e0, 0x4c76, {0x8e, 0x87, 0x2f, 0x9e, 0x28, 0x08, 0x83, 0x43} }
321 #define DEVICE_PATH_MESSAGING_VT_UTF8 \
322 { 0xad15a0d6, 0x8bec, 0x4acf, {0xa0, 0x73, 0xd0, 0x1d, 0xe7, 0x7e, 0x2d, 0x88} }
324 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL \
325 { 0x37499a9d, 0x542f, 0x4c89, {0xa0, 0x26, 0x35, 0xda, 0x14, 0x20, 0x94, 0xe4} }
328 EFI_DEVICE_PATH_PROTOCOL Header
;
330 UINT32 FlowControlMap
;
331 } UART_FLOW_CONTROL_DEVICE_PATH
;
333 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
335 #define DEVICE_PATH_MESSAGING_SAS \
336 { 0xd487ddb4, 0x008b, 0x11d9, {0xaf, 0xdc, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d} }
339 EFI_DEVICE_PATH_PROTOCOL Header
;
344 UINT16 DeviceTopology
;
345 UINT16 RelativeTargetPort
;
350 #define MSG_ISCSI_DP 0x13
352 EFI_DEVICE_PATH_PROTOCOL Header
;
353 UINT16 NetworkProtocol
;
356 UINT16 TargetPortalGroupTag
;
357 // CHAR8 iSCSI Target Name
360 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
361 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
362 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
363 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
364 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
365 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
366 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
367 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
372 #define MEDIA_DEVICE_PATH 0x04
374 #define MEDIA_HARDDRIVE_DP 0x01
376 EFI_DEVICE_PATH_PROTOCOL Header
;
377 UINT32 PartitionNumber
;
378 UINT64 PartitionStart
;
379 UINT64 PartitionSize
;
383 } HARDDRIVE_DEVICE_PATH
;
385 #define MBR_TYPE_PCAT 0x01
386 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
388 #define SIGNATURE_TYPE_MBR 0x01
389 #define SIGNATURE_TYPE_GUID 0x02
391 #define MEDIA_CDROM_DP 0x02
393 EFI_DEVICE_PATH_PROTOCOL Header
;
395 UINT64 PartitionStart
;
396 UINT64 PartitionSize
;
400 // Use VENDOR_DEVICE_PATH struct
402 #define MEDIA_VENDOR_DP 0x03
404 #define MEDIA_FILEPATH_DP 0x04
406 EFI_DEVICE_PATH_PROTOCOL Header
;
408 } FILEPATH_DEVICE_PATH
;
410 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
412 #define MEDIA_PROTOCOL_DP 0x05
414 EFI_DEVICE_PATH_PROTOCOL Header
;
416 } MEDIA_PROTOCOL_DEVICE_PATH
;
418 #if (EFI_SPECIFICATION_VERSION >= 0x0002000A)
420 #define MEDIA_FV_DP 0x07
422 EFI_DEVICE_PATH_PROTOCOL Header
;
424 } MEDIA_FW_VOL_DEVICE_PATH
;
426 #define MEDIA_FV_FILEPATH_DP 0x06
428 EFI_DEVICE_PATH_PROTOCOL Header
;
430 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
;
432 #define MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08
434 EFI_DEVICE_PATH_PROTOCOL Header
;
436 UINT64 StartingOffset
;
438 } MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH
;
444 #define BBS_DEVICE_PATH 0x05
445 #define BBS_BBS_DP 0x01
447 EFI_DEVICE_PATH_PROTOCOL Header
;
451 } BBS_BBS_DEVICE_PATH
;
454 // DeviceType definitions - from BBS specification
456 #define BBS_TYPE_FLOPPY 0x01
457 #define BBS_TYPE_HARDDRIVE 0x02
458 #define BBS_TYPE_CDROM 0x03
459 #define BBS_TYPE_PCMCIA 0x04
460 #define BBS_TYPE_USB 0x05
461 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
462 #define BBS_TYPE_BEV 0x80
463 #define BBS_TYPE_UNKNOWN 0xFF
465 #define UNKNOWN_DEVICE_GUID \
466 { 0xcf31fac5, 0xc24e, 0x11d2, {0x85, 0xf3, 0x0, 0xa0, 0xc9, 0x3e, 0xc9, 0x3b} }
469 VENDOR_DEVICE_PATH DevicePath
;
470 UINT8 LegacyDriveLetter
;
471 } UNKNOWN_DEVICE_VENDOR_DEVICE_PATH
;
475 // Union of all possible Device Paths and pointers to Device Paths
479 EFI_DEVICE_PATH_PROTOCOL DevPath
;
481 PCCARD_DEVICE_PATH PcCard
;
482 MEMMAP_DEVICE_PATH MemMap
;
483 VENDOR_DEVICE_PATH Vendor
;
485 UNKNOWN_DEVICE_VENDOR_DEVICE_PATH UnknownVendor
;
487 CONTROLLER_DEVICE_PATH Controller
;
488 ACPI_HID_DEVICE_PATH Acpi
;
489 ACPI_EXTENDED_HID_DEVICE_PATH ExtendedAcpi
;
491 ATAPI_DEVICE_PATH Atapi
;
492 SCSI_DEVICE_PATH Scsi
;
493 FIBRECHANNEL_DEVICE_PATH FibreChannel
;
494 SATA_DEVICE_PATH Sata
;
496 F1394_DEVICE_PATH F1394
;
498 USB_CLASS_DEVICE_PATH UsbClass
;
499 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
500 USB_WWID_DEVICE_PATH UsbWwid
;
501 DEVICE_LOGICAL_UNIT_DEVICE_PATH LogicUnit
;
504 MAC_ADDR_DEVICE_PATH MacAddr
;
505 IPv4_DEVICE_PATH Ipv4
;
506 IPv6_DEVICE_PATH Ipv6
;
507 INFINIBAND_DEVICE_PATH InfiniBand
;
508 UART_DEVICE_PATH Uart
;
509 UART_FLOW_CONTROL_DEVICE_PATH UartFlowControl
;
510 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
513 ISCSI_DEVICE_PATH Iscsi
;
514 HARDDRIVE_DEVICE_PATH HardDrive
;
515 CDROM_DEVICE_PATH CD
;
517 FILEPATH_DEVICE_PATH FilePath
;
518 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol
;
520 #if (EFI_SPECIFICATION_VERSION >= 0x0002000A)
521 MEDIA_FW_VOL_DEVICE_PATH PiwgFirmwareVolume
;
522 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH PiwgFirmwareFile
;
523 MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH
527 BBS_BBS_DEVICE_PATH Bbs
;
533 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
534 PCI_DEVICE_PATH
*Pci
;
535 PCCARD_DEVICE_PATH
*PcCard
;
536 MEMMAP_DEVICE_PATH
*MemMap
;
537 VENDOR_DEVICE_PATH
*Vendor
;
539 UNKNOWN_DEVICE_VENDOR_DEVICE_PATH
*UnknownVendor
;
541 CONTROLLER_DEVICE_PATH
*Controller
;
542 ACPI_HID_DEVICE_PATH
*Acpi
;
543 ACPI_EXTENDED_HID_DEVICE_PATH
*ExtendedAcpi
;
545 ATAPI_DEVICE_PATH
*Atapi
;
546 SCSI_DEVICE_PATH
*Scsi
;
547 FIBRECHANNEL_DEVICE_PATH
*FibreChannel
;
548 SATA_DEVICE_PATH
*Sata
;
550 F1394_DEVICE_PATH
*F1394
;
551 USB_DEVICE_PATH
*Usb
;
552 USB_CLASS_DEVICE_PATH
*UsbClass
;
553 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
554 USB_WWID_DEVICE_PATH
*UsbWwid
;
555 DEVICE_LOGICAL_UNIT_DEVICE_PATH
*LogicUnit
;
557 I2O_DEVICE_PATH
*I2O
;
558 MAC_ADDR_DEVICE_PATH
*MacAddr
;
559 IPv4_DEVICE_PATH
*Ipv4
;
560 IPv6_DEVICE_PATH
*Ipv6
;
561 INFINIBAND_DEVICE_PATH
*InfiniBand
;
562 UART_DEVICE_PATH
*Uart
;
563 UART_FLOW_CONTROL_DEVICE_PATH
*UartFlowControl
;
565 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
566 SAS_DEVICE_PATH
*Sas
;
568 ISCSI_DEVICE_PATH
*Iscsi
;
570 HARDDRIVE_DEVICE_PATH
*HardDrive
;
571 CDROM_DEVICE_PATH
*CD
;
573 FILEPATH_DEVICE_PATH
*FilePath
;
574 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProtocol
;
576 #if (EFI_SPECIFICATION_VERSION >= 0x0002000A)
577 MEDIA_FW_VOL_DEVICE_PATH
*PiwgFirmwareVolume
;
578 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*PiwgFirmwareFile
;
581 BBS_BBS_DEVICE_PATH
*Bbs
;