3 Copyright (c) 2004 - 2010, 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] = (UINT8) 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 #define MSG_USB_WWID_DP 0x10
219 EFI_DEVICE_PATH_PROTOCOL Header
;
220 UINT16 InterfaceNumber
;
224 // CHAR16 SerialNumber[];
226 } USB_WWID_DEVICE_PATH
;
228 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
230 EFI_DEVICE_PATH_PROTOCOL Header
;
232 } DEVICE_LOGICAL_UNIT_DEVICE_PATH
;
234 #define MSG_SATA_DP 0x12
236 EFI_DEVICE_PATH_PROTOCOL Header
;
237 UINT16 HBAPortNumber
;
238 UINT16 PortMultiplierPortNumber
;
242 #define SATA_HBA_DIRECT_CONNECT_FLAG 0x8000
244 #define MSG_I2O_DP 0x06
246 EFI_DEVICE_PATH_PROTOCOL Header
;
250 #define MSG_MAC_ADDR_DP 0x0b
252 EFI_DEVICE_PATH_PROTOCOL Header
;
253 EFI_MAC_ADDRESS MacAddress
;
255 } MAC_ADDR_DEVICE_PATH
;
257 #define MSG_IPv4_DP 0x0c
259 EFI_DEVICE_PATH_PROTOCOL Header
;
260 EFI_IPv4_ADDRESS LocalIpAddress
;
261 EFI_IPv4_ADDRESS RemoteIpAddress
;
265 BOOLEAN StaticIpAddress
;
268 #define MSG_IPv6_DP 0x0d
270 EFI_DEVICE_PATH_PROTOCOL Header
;
271 EFI_IPv6_ADDRESS LocalIpAddress
;
272 EFI_IPv6_ADDRESS RemoteIpAddress
;
276 BOOLEAN StaticIpAddress
;
279 #define MSG_INFINIBAND_DP 0x09
281 EFI_DEVICE_PATH_PROTOCOL Header
;
282 UINT32 ResourceFlags
;
287 } INFINIBAND_DEVICE_PATH
;
289 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
290 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
291 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
292 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
293 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
295 #define MSG_UART_DP 0x0e
297 EFI_DEVICE_PATH_PROTOCOL Header
;
306 // Use VENDOR_DEVICE_PATH struct
308 #define MSG_VENDOR_DP 0x0a
310 #define DEVICE_PATH_MESSAGING_PC_ANSI \
311 { 0xe0c14753, 0xf9be, 0x11d2, {0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
313 #define DEVICE_PATH_MESSAGING_VT_100 \
314 { 0xdfa66065, 0xb419, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
316 #define DEVICE_PATH_MESSAGING_VT_100_PLUS \
317 { 0x7baec70b, 0x57e0, 0x4c76, {0x8e, 0x87, 0x2f, 0x9e, 0x28, 0x08, 0x83, 0x43} }
319 #define DEVICE_PATH_MESSAGING_VT_UTF8 \
320 { 0xad15a0d6, 0x8bec, 0x4acf, {0xa0, 0x73, 0xd0, 0x1d, 0xe7, 0x7e, 0x2d, 0x88} }
322 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL \
323 { 0x37499a9d, 0x542f, 0x4c89, {0xa0, 0x26, 0x35, 0xda, 0x14, 0x20, 0x94, 0xe4} }
326 EFI_DEVICE_PATH_PROTOCOL Header
;
328 UINT32 FlowControlMap
;
329 } UART_FLOW_CONTROL_DEVICE_PATH
;
331 #define DEVICE_PATH_MESSAGING_SAS \
332 { 0xd487ddb4, 0x008b, 0x11d9, {0xaf, 0xdc, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d} }
335 EFI_DEVICE_PATH_PROTOCOL Header
;
340 UINT16 DeviceTopology
;
341 UINT16 RelativeTargetPort
;
344 #define MSG_ISCSI_DP 0x13
346 EFI_DEVICE_PATH_PROTOCOL Header
;
347 UINT16 NetworkProtocol
;
350 UINT16 TargetPortalGroupTag
;
351 // CHAR8 iSCSI Target Name
354 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
355 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
356 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
357 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
358 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
359 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
360 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
361 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
364 /// VLAN Device Path SubType.
366 #define MSG_VLAN_DP 0x14
368 EFI_DEVICE_PATH_PROTOCOL Header
;
370 /// VLAN identifier (0-4094).
379 #define MEDIA_DEVICE_PATH 0x04
381 #define MEDIA_HARDDRIVE_DP 0x01
383 EFI_DEVICE_PATH_PROTOCOL Header
;
384 UINT32 PartitionNumber
;
385 UINT64 PartitionStart
;
386 UINT64 PartitionSize
;
390 } HARDDRIVE_DEVICE_PATH
;
392 #define MBR_TYPE_PCAT 0x01
393 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
395 #define SIGNATURE_TYPE_MBR 0x01
396 #define SIGNATURE_TYPE_GUID 0x02
398 #define MEDIA_CDROM_DP 0x02
400 EFI_DEVICE_PATH_PROTOCOL Header
;
402 UINT64 PartitionStart
;
403 UINT64 PartitionSize
;
407 // Use VENDOR_DEVICE_PATH struct
409 #define MEDIA_VENDOR_DP 0x03
411 #define MEDIA_FILEPATH_DP 0x04
413 EFI_DEVICE_PATH_PROTOCOL Header
;
415 } FILEPATH_DEVICE_PATH
;
417 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
419 #define MEDIA_PROTOCOL_DP 0x05
421 EFI_DEVICE_PATH_PROTOCOL Header
;
423 } MEDIA_PROTOCOL_DEVICE_PATH
;
425 #define MEDIA_FV_DP 0x07
427 EFI_DEVICE_PATH_PROTOCOL Header
;
429 } MEDIA_FW_VOL_DEVICE_PATH
;
431 #define MEDIA_FV_FILEPATH_DP 0x06
433 EFI_DEVICE_PATH_PROTOCOL Header
;
435 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
;
437 #define MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08
439 EFI_DEVICE_PATH_PROTOCOL Header
;
441 UINT64 StartingOffset
;
443 } MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH
;
448 #define BBS_DEVICE_PATH 0x05
449 #define BBS_BBS_DP 0x01
451 EFI_DEVICE_PATH_PROTOCOL Header
;
455 } BBS_BBS_DEVICE_PATH
;
458 // DeviceType definitions - from BBS specification
460 #define BBS_TYPE_FLOPPY 0x01
461 #define BBS_TYPE_HARDDRIVE 0x02
462 #define BBS_TYPE_CDROM 0x03
463 #define BBS_TYPE_PCMCIA 0x04
464 #define BBS_TYPE_USB 0x05
465 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
466 #define BBS_TYPE_BEV 0x80
467 #define BBS_TYPE_UNKNOWN 0xFF
469 #define UNKNOWN_DEVICE_GUID \
470 { 0xcf31fac5, 0xc24e, 0x11d2, {0x85, 0xf3, 0x0, 0xa0, 0xc9, 0x3e, 0xc9, 0x3b} }
473 VENDOR_DEVICE_PATH DevicePath
;
474 UINT8 LegacyDriveLetter
;
475 } UNKNOWN_DEVICE_VENDOR_DEVICE_PATH
;
479 // Union of all possible Device Paths and pointers to Device Paths
483 EFI_DEVICE_PATH_PROTOCOL DevPath
;
485 PCCARD_DEVICE_PATH PcCard
;
486 MEMMAP_DEVICE_PATH MemMap
;
487 VENDOR_DEVICE_PATH Vendor
;
489 UNKNOWN_DEVICE_VENDOR_DEVICE_PATH UnknownVendor
;
491 CONTROLLER_DEVICE_PATH Controller
;
492 ACPI_HID_DEVICE_PATH Acpi
;
493 ACPI_EXTENDED_HID_DEVICE_PATH ExtendedAcpi
;
495 ATAPI_DEVICE_PATH Atapi
;
496 SCSI_DEVICE_PATH Scsi
;
497 FIBRECHANNEL_DEVICE_PATH FibreChannel
;
498 SATA_DEVICE_PATH Sata
;
500 F1394_DEVICE_PATH F1394
;
502 USB_CLASS_DEVICE_PATH UsbClass
;
503 USB_WWID_DEVICE_PATH UsbWwid
;
504 DEVICE_LOGICAL_UNIT_DEVICE_PATH LogicUnit
;
506 MAC_ADDR_DEVICE_PATH MacAddr
;
507 IPv4_DEVICE_PATH Ipv4
;
508 IPv6_DEVICE_PATH Ipv6
;
509 INFINIBAND_DEVICE_PATH InfiniBand
;
510 UART_DEVICE_PATH Uart
;
511 UART_FLOW_CONTROL_DEVICE_PATH UartFlowControl
;
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 MEDIA_FW_VOL_DEVICE_PATH PiwgFirmwareVolume
;
521 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH PiwgFirmwareFile
;
522 MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH
525 BBS_BBS_DEVICE_PATH Bbs
;
531 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
532 PCI_DEVICE_PATH
*Pci
;
533 PCCARD_DEVICE_PATH
*PcCard
;
534 MEMMAP_DEVICE_PATH
*MemMap
;
535 VENDOR_DEVICE_PATH
*Vendor
;
537 UNKNOWN_DEVICE_VENDOR_DEVICE_PATH
*UnknownVendor
;
539 CONTROLLER_DEVICE_PATH
*Controller
;
540 ACPI_HID_DEVICE_PATH
*Acpi
;
541 ACPI_EXTENDED_HID_DEVICE_PATH
*ExtendedAcpi
;
543 ATAPI_DEVICE_PATH
*Atapi
;
544 SCSI_DEVICE_PATH
*Scsi
;
545 FIBRECHANNEL_DEVICE_PATH
*FibreChannel
;
546 SATA_DEVICE_PATH
*Sata
;
548 F1394_DEVICE_PATH
*F1394
;
549 USB_DEVICE_PATH
*Usb
;
550 USB_CLASS_DEVICE_PATH
*UsbClass
;
551 USB_WWID_DEVICE_PATH
*UsbWwid
;
552 DEVICE_LOGICAL_UNIT_DEVICE_PATH
*LogicUnit
;
553 I2O_DEVICE_PATH
*I2O
;
554 MAC_ADDR_DEVICE_PATH
*MacAddr
;
555 IPv4_DEVICE_PATH
*Ipv4
;
556 IPv6_DEVICE_PATH
*Ipv6
;
557 INFINIBAND_DEVICE_PATH
*InfiniBand
;
558 UART_DEVICE_PATH
*Uart
;
559 UART_FLOW_CONTROL_DEVICE_PATH
*UartFlowControl
;
561 SAS_DEVICE_PATH
*Sas
;
562 ISCSI_DEVICE_PATH
*Iscsi
;
564 HARDDRIVE_DEVICE_PATH
*HardDrive
;
565 CDROM_DEVICE_PATH
*CD
;
567 FILEPATH_DEVICE_PATH
*FilePath
;
568 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProtocol
;
570 MEDIA_FW_VOL_DEVICE_PATH
*PiwgFirmwareVolume
;
571 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*PiwgFirmwareFile
;
572 MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH
575 BBS_BBS_DEVICE_PATH
*Bbs
;