xref: /freebsd/sys/contrib/edk2/Include/Protocol/DevicePath.h (revision 580fcf642ea2d5a1e60f24947d1c2e97007e44e9)
1 /** @file
2   The device path protocol as defined in UEFI 2.0.
3 
4   The device path represents a programmatic path to a device,
5   from a software point of view. The path must persist from boot to boot, so
6   it can not contain things like PCI bus numbers that change from boot to boot.
7 
8 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
9 SPDX-License-Identifier: BSD-2-Clause-Patent
10 
11 **/
12 
13 #ifndef __EFI_DEVICE_PATH_PROTOCOL_H__
14 #define __EFI_DEVICE_PATH_PROTOCOL_H__
15 
16 #include <Guid/PcAnsi.h>
17 #include <IndustryStandard/Bluetooth.h>
18 #include <IndustryStandard/Acpi60.h>
19 
20 ///
21 /// Device Path protocol.
22 ///
23 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
24   { \
25     0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
26   }
27 
28 ///
29 /// Device Path guid definition for backward-compatible with EFI1.1.
30 ///
31 #define DEVICE_PATH_PROTOCOL  EFI_DEVICE_PATH_PROTOCOL_GUID
32 
33 #pragma pack(1)
34 
35 /**
36   This protocol can be used on any device handle to obtain generic path/location
37   information concerning the physical device or logical device. If the handle does
38   not logically map to a physical device, the handle may not necessarily support
39   the device path protocol. The device path describes the location of the device
40   the handle is for. The size of the Device Path can be determined from the structures
41   that make up the Device Path.
42 **/
43 typedef struct {
44   UINT8    Type;    ///< 0x01 Hardware Device Path.
45                     ///< 0x02 ACPI Device Path.
46                     ///< 0x03 Messaging Device Path.
47                     ///< 0x04 Media Device Path.
48                     ///< 0x05 BIOS Boot Specification Device Path.
49                     ///< 0x7F End of Hardware Device Path.
50 
51   UINT8    SubType; ///< Varies by Type
52                     ///< 0xFF End Entire Device Path, or
53                     ///< 0x01 End This Instance of a Device Path and start a new
54                     ///< Device Path.
55 
56   UINT8    Length[2]; ///< Specific Device Path data. Type and Sub-Type define
57                       ///< type of data. Size of data is included in Length.
58 } EFI_DEVICE_PATH_PROTOCOL;
59 
60 ///
61 /// Device Path protocol definition for backward-compatible with EFI1.1.
62 ///
63 typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH;
64 
65 ///
66 /// Hardware Device Paths.
67 ///
68 #define HARDWARE_DEVICE_PATH  0x01
69 
70 ///
71 /// PCI Device Path SubType.
72 ///
73 #define HW_PCI_DP  0x01
74 
75 ///
76 /// PCI Device Path.
77 ///
78 typedef struct {
79   EFI_DEVICE_PATH_PROTOCOL    Header;
80   ///
81   /// PCI Function Number.
82   ///
83   UINT8                       Function;
84   ///
85   /// PCI Device Number.
86   ///
87   UINT8                       Device;
88 } PCI_DEVICE_PATH;
89 
90 ///
91 /// PCCARD Device Path SubType.
92 ///
93 #define HW_PCCARD_DP  0x02
94 
95 ///
96 /// PCCARD Device Path.
97 ///
98 typedef struct {
99   EFI_DEVICE_PATH_PROTOCOL    Header;
100   ///
101   /// Function Number (0 = First Function).
102   ///
103   UINT8                       FunctionNumber;
104 } PCCARD_DEVICE_PATH;
105 
106 ///
107 /// Memory Mapped Device Path SubType.
108 ///
109 #define HW_MEMMAP_DP  0x03
110 
111 ///
112 /// Memory Mapped Device Path.
113 ///
114 typedef struct {
115   EFI_DEVICE_PATH_PROTOCOL    Header;
116   ///
117   /// EFI_MEMORY_TYPE
118   ///
119   UINT32                      MemoryType;
120   ///
121   /// Starting Memory Address.
122   ///
123   EFI_PHYSICAL_ADDRESS        StartingAddress;
124   ///
125   /// Ending Memory Address.
126   ///
127   EFI_PHYSICAL_ADDRESS        EndingAddress;
128 } MEMMAP_DEVICE_PATH;
129 
130 ///
131 /// Hardware Vendor Device Path SubType.
132 ///
133 #define HW_VENDOR_DP  0x04
134 
135 ///
136 /// The Vendor Device Path allows the creation of vendor-defined Device Paths. A vendor must
137 /// allocate a Vendor GUID for a Device Path. The Vendor GUID can then be used to define the
138 /// contents on the n bytes that follow in the Vendor Device Path node.
139 ///
140 typedef struct {
141   EFI_DEVICE_PATH_PROTOCOL    Header;
142   ///
143   /// Vendor-assigned GUID that defines the data that follows.
144   ///
145   EFI_GUID                    Guid;
146   ///
147   /// Vendor-defined variable size data.
148   ///
149 } VENDOR_DEVICE_PATH;
150 
151 ///
152 /// Controller Device Path SubType.
153 ///
154 #define HW_CONTROLLER_DP  0x05
155 
156 ///
157 /// Controller Device Path.
158 ///
159 typedef struct {
160   EFI_DEVICE_PATH_PROTOCOL    Header;
161   ///
162   /// Controller number.
163   ///
164   UINT32                      ControllerNumber;
165 } CONTROLLER_DEVICE_PATH;
166 
167 ///
168 /// BMC Device Path SubType.
169 ///
170 #define HW_BMC_DP  0x06
171 
172 ///
173 /// BMC Device Path.
174 ///
175 typedef struct {
176   EFI_DEVICE_PATH_PROTOCOL    Header;
177   ///
178   /// Interface Type.
179   ///
180   UINT8                       InterfaceType;
181   ///
182   /// Base Address.
183   ///
184   UINT8                       BaseAddress[8];
185 } BMC_DEVICE_PATH;
186 
187 ///
188 /// ACPI Device Paths.
189 ///
190 #define ACPI_DEVICE_PATH  0x02
191 
192 ///
193 /// ACPI Device Path SubType.
194 ///
195 #define ACPI_DP  0x01
196 typedef struct {
197   EFI_DEVICE_PATH_PROTOCOL    Header;
198   ///
199   /// Device's PnP hardware ID stored in a numeric 32-bit
200   /// compressed EISA-type ID. This value must match the
201   /// corresponding _HID in the ACPI name space.
202   ///
203   UINT32                      HID;
204   ///
205   /// Unique ID that is required by ACPI if two devices have the
206   /// same _HID. This value must also match the corresponding
207   /// _UID/_HID pair in the ACPI name space. Only the 32-bit
208   /// numeric value type of _UID is supported. Thus, strings must
209   /// not be used for the _UID in the ACPI name space.
210   ///
211   UINT32                      UID;
212 } ACPI_HID_DEVICE_PATH;
213 
214 ///
215 /// Expanded ACPI Device Path SubType.
216 ///
217 #define ACPI_EXTENDED_DP  0x02
218 typedef struct {
219   EFI_DEVICE_PATH_PROTOCOL    Header;
220   ///
221   /// Device's PnP hardware ID stored in a numeric 32-bit
222   /// compressed EISA-type ID. This value must match the
223   /// corresponding _HID in the ACPI name space.
224   ///
225   UINT32                      HID;
226   ///
227   /// Unique ID that is required by ACPI if two devices have the
228   /// same _HID. This value must also match the corresponding
229   /// _UID/_HID pair in the ACPI name space.
230   ///
231   UINT32                      UID;
232   ///
233   /// Device's compatible PnP hardware ID stored in a numeric
234   /// 32-bit compressed EISA-type ID. This value must match at
235   /// least one of the compatible device IDs returned by the
236   /// corresponding _CID in the ACPI name space.
237   ///
238   UINT32                      CID;
239   ///
240   /// Optional variable length _HIDSTR.
241   /// Optional variable length _UIDSTR.
242   /// Optional variable length _CIDSTR.
243   ///
244 } ACPI_EXTENDED_HID_DEVICE_PATH;
245 
246 //
247 //  EISA ID Macro
248 //  EISA ID Definition 32-bits
249 //   bits[15:0] - three character compressed ASCII EISA ID.
250 //   bits[31:16] - binary number
251 //    Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
252 //
253 #define PNP_EISA_ID_CONST  0x41d0
254 #define EISA_ID(_Name, _Num)  ((UINT32)((_Name) | (_Num) << 16))
255 #define EISA_PNP_ID(_PNPId)   (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
256 #define EFI_PNP_ID(_PNPId)    (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
257 
258 #define PNP_EISA_ID_MASK  0xffff
259 #define EISA_ID_TO_NUM(_Id)  ((_Id) >> 16)
260 
261 ///
262 /// ACPI _ADR Device Path SubType.
263 ///
264 #define ACPI_ADR_DP  0x03
265 
266 ///
267 /// The _ADR device path is used to contain video output device attributes to support the Graphics
268 /// Output Protocol. The device path can contain multiple _ADR entries if multiple video output
269 /// devices are displaying the same output.
270 ///
271 typedef struct {
272   EFI_DEVICE_PATH_PROTOCOL    Header;
273   ///
274   /// _ADR value. For video output devices the value of this
275   /// field comes from Table B-2 of the ACPI 3.0 specification. At
276   /// least one _ADR value is required.
277   ///
278   UINT32                      ADR;
279   //
280   // This device path may optionally contain more than one _ADR entry.
281   //
282 } ACPI_ADR_DEVICE_PATH;
283 
284 ///
285 /// ACPI NVDIMM Device Path SubType.
286 ///
287 #define ACPI_NVDIMM_DP  0x04
288 ///
289 ///
290 typedef struct {
291   EFI_DEVICE_PATH_PROTOCOL    Header;
292   ///
293   /// NFIT Device Handle, the _ADR of the NVDIMM device.
294   /// The value of this field comes from Section 9.20.3 of the ACPI 6.2A specification.
295   ///
296   UINT32                      NFITDeviceHandle;
297 } ACPI_NVDIMM_DEVICE_PATH;
298 
299 #define ACPI_ADR_DISPLAY_TYPE_OTHER             0
300 #define ACPI_ADR_DISPLAY_TYPE_VGA               1
301 #define ACPI_ADR_DISPLAY_TYPE_TV                2
302 #define ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL  3
303 #define ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL  4
304 
305 #define ACPI_DISPLAY_ADR(_DeviceIdScheme, _HeadId, _NonVgaOutput, _BiosCanDetect, _VendorInfo, _Type, _Port, _Index) \
306           ((UINT32)(  ((UINT32)((_DeviceIdScheme) & 0x1) << 31) |  \
307                       (((_HeadId)                 & 0x7) << 18) |  \
308                       (((_NonVgaOutput)           & 0x1) << 17) |  \
309                       (((_BiosCanDetect)          & 0x1) << 16) |  \
310                       (((_VendorInfo)             & 0xf) << 12) |  \
311                       (((_Type)                   & 0xf) << 8)  |  \
312                       (((_Port)                   & 0xf) << 4)  |  \
313                        ((_Index)                  & 0xf) ))
314 
315 ///
316 /// Messaging Device Paths.
317 /// This Device Path is used to describe the connection of devices outside the resource domain of the
318 /// system. This Device Path can describe physical messaging information like SCSI ID, or abstract
319 /// information like networking protocol IP addresses.
320 ///
321 #define MESSAGING_DEVICE_PATH  0x03
322 
323 ///
324 /// ATAPI Device Path SubType
325 ///
326 #define MSG_ATAPI_DP  0x01
327 typedef struct {
328   EFI_DEVICE_PATH_PROTOCOL    Header;
329   ///
330   /// Set to zero for primary, or one for secondary.
331   ///
332   UINT8                       PrimarySecondary;
333   ///
334   /// Set to zero for master, or one for slave mode.
335   ///
336   UINT8                       SlaveMaster;
337   ///
338   /// Logical Unit Number.
339   ///
340   UINT16                      Lun;
341 } ATAPI_DEVICE_PATH;
342 
343 ///
344 /// SCSI Device Path SubType.
345 ///
346 #define MSG_SCSI_DP  0x02
347 typedef struct {
348   EFI_DEVICE_PATH_PROTOCOL    Header;
349   ///
350   /// Target ID on the SCSI bus (PUN).
351   ///
352   UINT16                      Pun;
353   ///
354   /// Logical Unit Number (LUN).
355   ///
356   UINT16                      Lun;
357 } SCSI_DEVICE_PATH;
358 
359 ///
360 /// Fibre Channel SubType.
361 ///
362 #define MSG_FIBRECHANNEL_DP  0x03
363 typedef struct {
364   EFI_DEVICE_PATH_PROTOCOL    Header;
365   ///
366   /// Reserved for the future.
367   ///
368   UINT32                      Reserved;
369   ///
370   /// Fibre Channel World Wide Number.
371   ///
372   UINT64                      WWN;
373   ///
374   /// Fibre Channel Logical Unit Number.
375   ///
376   UINT64                      Lun;
377 } FIBRECHANNEL_DEVICE_PATH;
378 
379 ///
380 /// Fibre Channel Ex SubType.
381 ///
382 #define MSG_FIBRECHANNELEX_DP  0x15
383 typedef struct {
384   EFI_DEVICE_PATH_PROTOCOL    Header;
385   ///
386   /// Reserved for the future.
387   ///
388   UINT32                      Reserved;
389   ///
390   /// 8 byte array containing Fibre Channel End Device Port Name.
391   ///
392   UINT8                       WWN[8];
393   ///
394   /// 8 byte array containing Fibre Channel Logical Unit Number.
395   ///
396   UINT8                       Lun[8];
397 } FIBRECHANNELEX_DEVICE_PATH;
398 
399 ///
400 /// 1394 Device Path SubType
401 ///
402 #define MSG_1394_DP  0x04
403 typedef struct {
404   EFI_DEVICE_PATH_PROTOCOL    Header;
405   ///
406   /// Reserved for the future.
407   ///
408   UINT32                      Reserved;
409   ///
410   /// 1394 Global Unique ID (GUID).
411   ///
412   UINT64                      Guid;
413 } F1394_DEVICE_PATH;
414 
415 ///
416 /// USB Device Path SubType.
417 ///
418 #define MSG_USB_DP  0x05
419 typedef struct {
420   EFI_DEVICE_PATH_PROTOCOL    Header;
421   ///
422   /// USB Parent Port Number.
423   ///
424   UINT8                       ParentPortNumber;
425   ///
426   /// USB Interface Number.
427   ///
428   UINT8                       InterfaceNumber;
429 } USB_DEVICE_PATH;
430 
431 ///
432 /// USB Class Device Path SubType.
433 ///
434 #define MSG_USB_CLASS_DP  0x0f
435 typedef struct {
436   EFI_DEVICE_PATH_PROTOCOL    Header;
437   ///
438   /// Vendor ID assigned by USB-IF. A value of 0xFFFF will
439   /// match any Vendor ID.
440   ///
441   UINT16                      VendorId;
442   ///
443   /// Product ID assigned by USB-IF. A value of 0xFFFF will
444   /// match any Product ID.
445   ///
446   UINT16                      ProductId;
447   ///
448   /// The class code assigned by the USB-IF. A value of 0xFF
449   /// will match any class code.
450   ///
451   UINT8                       DeviceClass;
452   ///
453   /// The subclass code assigned by the USB-IF. A value of
454   /// 0xFF will match any subclass code.
455   ///
456   UINT8                       DeviceSubClass;
457   ///
458   /// The protocol code assigned by the USB-IF. A value of
459   /// 0xFF will match any protocol code.
460   ///
461   UINT8                       DeviceProtocol;
462 } USB_CLASS_DEVICE_PATH;
463 
464 ///
465 /// USB WWID Device Path SubType.
466 ///
467 #define MSG_USB_WWID_DP  0x10
468 
469 ///
470 /// This device path describes a USB device using its serial number.
471 ///
472 typedef struct {
473   EFI_DEVICE_PATH_PROTOCOL    Header;
474   ///
475   /// USB interface number.
476   ///
477   UINT16                      InterfaceNumber;
478   ///
479   /// USB vendor id of the device.
480   ///
481   UINT16                      VendorId;
482   ///
483   /// USB product id of the device.
484   ///
485   UINT16                      ProductId;
486   ///
487   /// Last 64-or-fewer UTF-16 characters of the USB
488   /// serial number. The length of the string is
489   /// determined by the Length field less the offset of the
490   /// Serial Number field (10)
491   ///
492   /// CHAR16                     SerialNumber[...];
493 } USB_WWID_DEVICE_PATH;
494 
495 ///
496 /// Device Logical Unit SubType.
497 ///
498 #define MSG_DEVICE_LOGICAL_UNIT_DP  0x11
499 typedef struct {
500   EFI_DEVICE_PATH_PROTOCOL    Header;
501   ///
502   /// Logical Unit Number for the interface.
503   ///
504   UINT8                       Lun;
505 } DEVICE_LOGICAL_UNIT_DEVICE_PATH;
506 
507 ///
508 /// SATA Device Path SubType.
509 ///
510 #define MSG_SATA_DP  0x12
511 typedef struct {
512   EFI_DEVICE_PATH_PROTOCOL    Header;
513   ///
514   /// The HBA port number that facilitates the connection to the
515   /// device or a port multiplier. The value 0xFFFF is reserved.
516   ///
517   UINT16                      HBAPortNumber;
518   ///
519   /// The Port multiplier port number that facilitates the connection
520   /// to the device. Must be set to 0xFFFF if the device is directly
521   /// connected to the HBA.
522   ///
523   UINT16                      PortMultiplierPortNumber;
524   ///
525   /// Logical Unit Number.
526   ///
527   UINT16                      Lun;
528 } SATA_DEVICE_PATH;
529 
530 ///
531 /// Flag for if the device is directly connected to the HBA.
532 ///
533 #define SATA_HBA_DIRECT_CONNECT_FLAG  0x8000
534 
535 ///
536 /// I2O Device Path SubType.
537 ///
538 #define MSG_I2O_DP  0x06
539 typedef struct {
540   EFI_DEVICE_PATH_PROTOCOL    Header;
541   ///
542   /// Target ID (TID) for a device.
543   ///
544   UINT32                      Tid;
545 } I2O_DEVICE_PATH;
546 
547 ///
548 /// MAC Address Device Path SubType.
549 ///
550 #define MSG_MAC_ADDR_DP  0x0b
551 typedef struct {
552   EFI_DEVICE_PATH_PROTOCOL    Header;
553   ///
554   /// The MAC address for a network interface padded with 0s.
555   ///
556   EFI_MAC_ADDRESS             MacAddress;
557   ///
558   /// Network interface type(i.e. 802.3, FDDI).
559   ///
560   UINT8                       IfType;
561 } MAC_ADDR_DEVICE_PATH;
562 
563 ///
564 /// IPv4 Device Path SubType
565 ///
566 #define MSG_IPv4_DP  0x0c
567 typedef struct {
568   EFI_DEVICE_PATH_PROTOCOL    Header;
569   ///
570   /// The local IPv4 address.
571   ///
572   EFI_IPv4_ADDRESS            LocalIpAddress;
573   ///
574   /// The remote IPv4 address.
575   ///
576   EFI_IPv4_ADDRESS            RemoteIpAddress;
577   ///
578   /// The local port number.
579   ///
580   UINT16                      LocalPort;
581   ///
582   /// The remote port number.
583   ///
584   UINT16                      RemotePort;
585   ///
586   /// The network protocol(i.e. UDP, TCP).
587   ///
588   UINT16                      Protocol;
589   ///
590   /// 0x00 - The Source IP Address was assigned though DHCP.
591   /// 0x01 - The Source IP Address is statically bound.
592   ///
593   BOOLEAN                     StaticIpAddress;
594   ///
595   /// The gateway IP address
596   ///
597   EFI_IPv4_ADDRESS            GatewayIpAddress;
598   ///
599   /// The subnet mask
600   ///
601   EFI_IPv4_ADDRESS            SubnetMask;
602 } IPv4_DEVICE_PATH;
603 
604 ///
605 /// IPv6 Device Path SubType.
606 ///
607 #define MSG_IPv6_DP  0x0d
608 typedef struct {
609   EFI_DEVICE_PATH_PROTOCOL    Header;
610   ///
611   /// The local IPv6 address.
612   ///
613   EFI_IPv6_ADDRESS            LocalIpAddress;
614   ///
615   /// The remote IPv6 address.
616   ///
617   EFI_IPv6_ADDRESS            RemoteIpAddress;
618   ///
619   /// The local port number.
620   ///
621   UINT16                      LocalPort;
622   ///
623   /// The remote port number.
624   ///
625   UINT16                      RemotePort;
626   ///
627   /// The network protocol(i.e. UDP, TCP).
628   ///
629   UINT16                      Protocol;
630   ///
631   /// 0x00 - The Local IP Address was manually configured.
632   /// 0x01 - The Local IP Address is assigned through IPv6
633   /// stateless auto-configuration.
634   /// 0x02 - The Local IP Address is assigned through IPv6
635   /// stateful configuration.
636   ///
637   UINT8                       IpAddressOrigin;
638   ///
639   /// The prefix length
640   ///
641   UINT8                       PrefixLength;
642   ///
643   /// The gateway IP address
644   ///
645   EFI_IPv6_ADDRESS            GatewayIpAddress;
646 } IPv6_DEVICE_PATH;
647 
648 ///
649 /// InfiniBand Device Path SubType.
650 ///
651 #define MSG_INFINIBAND_DP  0x09
652 typedef struct {
653   EFI_DEVICE_PATH_PROTOCOL    Header;
654   ///
655   /// Flags to help identify/manage InfiniBand device path elements:
656   /// Bit 0 - IOC/Service (0b = IOC, 1b = Service).
657   /// Bit 1 - Extend Boot Environment.
658   /// Bit 2 - Console Protocol.
659   /// Bit 3 - Storage Protocol.
660   /// Bit 4 - Network Protocol.
661   /// All other bits are reserved.
662   ///
663   UINT32    ResourceFlags;
664   ///
665   /// 128-bit Global Identifier for remote fabric port.
666   ///
667   UINT8     PortGid[16];
668   ///
669   /// 64-bit unique identifier to remote IOC or server process.
670   /// Interpretation of field specified by Resource Flags (bit 0).
671   ///
672   UINT64    ServiceId;
673   ///
674   /// 64-bit persistent ID of remote IOC port.
675   ///
676   UINT64    TargetPortId;
677   ///
678   /// 64-bit persistent ID of remote device.
679   ///
680   UINT64    DeviceId;
681 } INFINIBAND_DEVICE_PATH;
682 
683 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE                0x01
684 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT  0x02
685 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL           0x04
686 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL           0x08
687 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL           0x10
688 
689 ///
690 /// UART Device Path SubType.
691 ///
692 #define MSG_UART_DP  0x0e
693 typedef struct {
694   EFI_DEVICE_PATH_PROTOCOL    Header;
695   ///
696   /// Reserved.
697   ///
698   UINT32                      Reserved;
699   ///
700   /// The baud rate setting for the UART style device. A value of 0
701   /// means that the device's default baud rate will be used.
702   ///
703   UINT64                      BaudRate;
704   ///
705   /// The number of data bits for the UART style device. A value
706   /// of 0 means that the device's default number of data bits will be used.
707   ///
708   UINT8                       DataBits;
709   ///
710   /// The parity setting for the UART style device.
711   /// Parity 0x00 - Default Parity.
712   /// Parity 0x01 - No Parity.
713   /// Parity 0x02 - Even Parity.
714   /// Parity 0x03 - Odd Parity.
715   /// Parity 0x04 - Mark Parity.
716   /// Parity 0x05 - Space Parity.
717   ///
718   UINT8    Parity;
719   ///
720   /// The number of stop bits for the UART style device.
721   /// Stop Bits 0x00 - Default Stop Bits.
722   /// Stop Bits 0x01 - 1 Stop Bit.
723   /// Stop Bits 0x02 - 1.5 Stop Bits.
724   /// Stop Bits 0x03 - 2 Stop Bits.
725   ///
726   UINT8    StopBits;
727 } UART_DEVICE_PATH;
728 
729 ///
730 /// NVDIMM Namespace Device Path SubType.
731 ///
732 #define NVDIMM_NAMESPACE_DP  0x20
733 typedef struct {
734   EFI_DEVICE_PATH_PROTOCOL    Header;
735   ///
736   /// Namespace unique label identifier UUID.
737   ///
738   EFI_GUID                    Uuid;
739 } NVDIMM_NAMESPACE_DEVICE_PATH;
740 
741 //
742 // Use VENDOR_DEVICE_PATH struct
743 //
744 #define MSG_VENDOR_DP  0x0a
745 typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH;
746 
747 #define DEVICE_PATH_MESSAGING_PC_ANSI      EFI_PC_ANSI_GUID
748 #define DEVICE_PATH_MESSAGING_VT_100       EFI_VT_100_GUID
749 #define DEVICE_PATH_MESSAGING_VT_100_PLUS  EFI_VT_100_PLUS_GUID
750 #define DEVICE_PATH_MESSAGING_VT_UTF8      EFI_VT_UTF8_GUID
751 
752 ///
753 /// A new device path node is defined to declare flow control characteristics.
754 /// UART Flow Control Messaging Device Path
755 ///
756 typedef struct {
757   EFI_DEVICE_PATH_PROTOCOL    Header;
758   ///
759   /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID.
760   ///
761   EFI_GUID                    Guid;
762   ///
763   /// Bitmap of supported flow control types.
764   /// Bit 0 set indicates hardware flow control.
765   /// Bit 1 set indicates Xon/Xoff flow control.
766   /// All other bits are reserved and are clear.
767   ///
768   UINT32                      FlowControlMap;
769 } UART_FLOW_CONTROL_DEVICE_PATH;
770 
771 #define UART_FLOW_CONTROL_HARDWARE  0x00000001
772 #define UART_FLOW_CONTROL_XON_XOFF  0x00000010
773 
774 #define DEVICE_PATH_MESSAGING_SAS  EFI_SAS_DEVICE_PATH_GUID
775 ///
776 /// Serial Attached SCSI (SAS) Device Path.
777 ///
778 typedef struct {
779   EFI_DEVICE_PATH_PROTOCOL    Header;
780   ///
781   /// DEVICE_PATH_MESSAGING_SAS GUID.
782   ///
783   EFI_GUID                    Guid;
784   ///
785   /// Reserved for future use.
786   ///
787   UINT32                      Reserved;
788   ///
789   /// SAS Address for Serial Attached SCSI Target.
790   ///
791   UINT64                      SasAddress;
792   ///
793   /// SAS Logical Unit Number.
794   ///
795   UINT64                      Lun;
796   ///
797   /// More Information about the device and its interconnect.
798   ///
799   UINT16                      DeviceTopology;
800   ///
801   /// Relative Target Port (RTP).
802   ///
803   UINT16                      RelativeTargetPort;
804 } SAS_DEVICE_PATH;
805 
806 ///
807 /// Serial Attached SCSI (SAS) Ex Device Path SubType
808 ///
809 #define MSG_SASEX_DP  0x16
810 typedef struct {
811   EFI_DEVICE_PATH_PROTOCOL    Header;
812   ///
813   /// 8-byte array of the SAS Address for Serial Attached SCSI Target Port.
814   ///
815   UINT8                       SasAddress[8];
816   ///
817   /// 8-byte array of the SAS Logical Unit Number.
818   ///
819   UINT8                       Lun[8];
820   ///
821   /// More Information about the device and its interconnect.
822   ///
823   UINT16                      DeviceTopology;
824   ///
825   /// Relative Target Port (RTP).
826   ///
827   UINT16                      RelativeTargetPort;
828 } SASEX_DEVICE_PATH;
829 
830 ///
831 /// NvmExpress Namespace Device Path SubType.
832 ///
833 #define MSG_NVME_NAMESPACE_DP  0x17
834 typedef struct {
835   EFI_DEVICE_PATH_PROTOCOL    Header;
836   UINT32                      NamespaceId;
837   UINT64                      NamespaceUuid;
838 } NVME_NAMESPACE_DEVICE_PATH;
839 
840 ///
841 /// NVMe over Fabric (NVMe-oF) Namespace Device Path SubType.
842 ///
843 #define MSG_NVME_OF_NAMESPACE_DP  0x22
844 typedef struct {
845   EFI_DEVICE_PATH_PROTOCOL    Header;
846   ///
847   /// Namespace Identifier Type (NIDT)
848   ///
849   UINT8                       NamespaceIdType;
850   ///
851   /// Namespace Identifier (NID)
852   ///
853   UINT8                       NamespaceId[16];
854   ///
855   /// Unique identifier of an NVM subsystem
856   ///
857   CHAR8                       SubsystemNqn[];
858 } NVME_OF_NAMESPACE_DEVICE_PATH;
859 
860 ///
861 /// DNS Device Path SubType
862 ///
863 #define MSG_DNS_DP  0x1F
864 typedef struct {
865   EFI_DEVICE_PATH_PROTOCOL    Header;
866   ///
867   /// Indicates the DNS server address is IPv4 or IPv6 address.
868   ///
869   UINT8                       IsIPv6;
870   ///
871   /// Instance of the DNS server address.
872   ///
873   EFI_IP_ADDRESS              DnsServerIp[];
874 } DNS_DEVICE_PATH;
875 
876 ///
877 /// Uniform Resource Identifiers (URI) Device Path SubType
878 ///
879 #define MSG_URI_DP  0x18
880 typedef struct {
881   EFI_DEVICE_PATH_PROTOCOL    Header;
882   ///
883   /// Instance of the URI pursuant to RFC 3986.
884   ///
885   CHAR8                       Uri[];
886 } URI_DEVICE_PATH;
887 
888 ///
889 /// Universal Flash Storage (UFS) Device Path SubType.
890 ///
891 #define MSG_UFS_DP  0x19
892 typedef struct {
893   EFI_DEVICE_PATH_PROTOCOL    Header;
894   ///
895   /// Target ID on the UFS bus (PUN).
896   ///
897   UINT8                       Pun;
898   ///
899   /// Logical Unit Number (LUN).
900   ///
901   UINT8                       Lun;
902 } UFS_DEVICE_PATH;
903 
904 ///
905 /// SD (Secure Digital) Device Path SubType.
906 ///
907 #define MSG_SD_DP  0x1A
908 typedef struct {
909   EFI_DEVICE_PATH_PROTOCOL    Header;
910   UINT8                       SlotNumber;
911 } SD_DEVICE_PATH;
912 
913 ///
914 /// EMMC (Embedded MMC) Device Path SubType.
915 ///
916 #define MSG_EMMC_DP  0x1D
917 typedef struct {
918   EFI_DEVICE_PATH_PROTOCOL    Header;
919   UINT8                       SlotNumber;
920 } EMMC_DEVICE_PATH;
921 
922 ///
923 /// iSCSI Device Path SubType
924 ///
925 #define MSG_ISCSI_DP  0x13
926 typedef struct {
927   EFI_DEVICE_PATH_PROTOCOL    Header;
928   ///
929   /// Network Protocol (0 = TCP, 1+ = reserved).
930   ///
931   UINT16                      NetworkProtocol;
932   ///
933   /// iSCSI Login Options.
934   ///
935   UINT16                      LoginOption;
936   ///
937   /// iSCSI Logical Unit Number.
938   ///
939   UINT64                      Lun;
940   ///
941   /// iSCSI Target Portal group tag the initiator intends
942   /// to establish a session with.
943   ///
944   UINT16                      TargetPortalGroupTag;
945   ///
946   /// iSCSI NodeTarget Name. The length of the name
947   /// is determined by subtracting the offset of this field from Length.
948   ///
949   /// CHAR8                        iSCSI Target Name.
950 } ISCSI_DEVICE_PATH;
951 
952 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST            0x0000
953 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C  0x0002
954 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST              0x0000
955 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C    0x0008
956 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP             0x0000
957 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON              0x1000
958 #define ISCSI_LOGIN_OPTION_CHAP_BI                     0x0000
959 #define ISCSI_LOGIN_OPTION_CHAP_UNI                    0x2000
960 
961 ///
962 /// VLAN Device Path SubType.
963 ///
964 #define MSG_VLAN_DP  0x14
965 typedef struct {
966   EFI_DEVICE_PATH_PROTOCOL    Header;
967   ///
968   /// VLAN identifier (0-4094).
969   ///
970   UINT16                      VlanId;
971 } VLAN_DEVICE_PATH;
972 
973 ///
974 /// Bluetooth Device Path SubType.
975 ///
976 #define MSG_BLUETOOTH_DP  0x1b
977 typedef struct {
978   EFI_DEVICE_PATH_PROTOCOL    Header;
979   ///
980   /// 48bit Bluetooth device address.
981   ///
982   BLUETOOTH_ADDRESS           BD_ADDR;
983 } BLUETOOTH_DEVICE_PATH;
984 
985 ///
986 /// Wi-Fi Device Path SubType.
987 ///
988 #define MSG_WIFI_DP  0x1C
989 typedef struct {
990   EFI_DEVICE_PATH_PROTOCOL    Header;
991   ///
992   /// Service set identifier. A 32-byte octets string.
993   ///
994   UINT8                       SSId[32];
995 } WIFI_DEVICE_PATH;
996 
997 ///
998 /// Bluetooth LE Device Path SubType.
999 ///
1000 #define MSG_BLUETOOTH_LE_DP  0x1E
1001 typedef struct {
1002   EFI_DEVICE_PATH_PROTOCOL    Header;
1003   BLUETOOTH_LE_ADDRESS        Address;
1004 } BLUETOOTH_LE_DEVICE_PATH;
1005 
1006 //
1007 // Media Device Path
1008 //
1009 #define MEDIA_DEVICE_PATH  0x04
1010 
1011 ///
1012 /// Hard Drive Media Device Path SubType.
1013 ///
1014 #define MEDIA_HARDDRIVE_DP  0x01
1015 
1016 ///
1017 /// The Hard Drive Media Device Path is used to represent a partition on a hard drive.
1018 ///
1019 typedef struct {
1020   EFI_DEVICE_PATH_PROTOCOL    Header;
1021   ///
1022   /// Describes the entry in a partition table, starting with entry 1.
1023   /// Partition number zero represents the entire device. Valid
1024   /// partition numbers for a MBR partition are [1, 4]. Valid
1025   /// partition numbers for a GPT partition are [1, NumberOfPartitionEntries].
1026   ///
1027   UINT32                      PartitionNumber;
1028   ///
1029   /// Starting LBA of the partition on the hard drive.
1030   ///
1031   UINT64                      PartitionStart;
1032   ///
1033   /// Size of the partition in units of Logical Blocks.
1034   ///
1035   UINT64                      PartitionSize;
1036   ///
1037   /// Signature unique to this partition:
1038   /// If SignatureType is 0, this field has to be initialized with 16 zeros.
1039   /// If SignatureType is 1, the MBR signature is stored in the first 4 bytes of this field.
1040   /// The other 12 bytes are initialized with zeros.
1041   /// If SignatureType is 2, this field contains a 16 byte signature.
1042   ///
1043   UINT8                       Signature[16];
1044   ///
1045   /// Partition Format: (Unused values reserved).
1046   /// 0x01 - PC-AT compatible legacy MBR.
1047   /// 0x02 - GUID Partition Table.
1048   ///
1049   UINT8                       MBRType;
1050   ///
1051   /// Type of Disk Signature: (Unused values reserved).
1052   /// 0x00 - No Disk Signature.
1053   /// 0x01 - 32-bit signature from address 0x1b8 of the type 0x01 MBR.
1054   /// 0x02 - GUID signature.
1055   ///
1056   UINT8                       SignatureType;
1057 } HARDDRIVE_DEVICE_PATH;
1058 
1059 #define MBR_TYPE_PCAT                        0x01
1060 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER  0x02
1061 
1062 #define NO_DISK_SIGNATURE    0x00
1063 #define SIGNATURE_TYPE_MBR   0x01
1064 #define SIGNATURE_TYPE_GUID  0x02
1065 
1066 ///
1067 /// CD-ROM Media Device Path SubType.
1068 ///
1069 #define MEDIA_CDROM_DP  0x02
1070 
1071 ///
1072 /// The CD-ROM Media Device Path is used to define a system partition that exists on a CD-ROM.
1073 ///
1074 typedef struct {
1075   EFI_DEVICE_PATH_PROTOCOL    Header;
1076   ///
1077   /// Boot Entry number from the Boot Catalog. The Initial/Default entry is defined as zero.
1078   ///
1079   UINT32                      BootEntry;
1080   ///
1081   /// Starting RBA of the partition on the medium. CD-ROMs use Relative logical Block Addressing.
1082   ///
1083   UINT64                      PartitionStart;
1084   ///
1085   /// Size of the partition in units of Blocks, also called Sectors.
1086   ///
1087   UINT64                      PartitionSize;
1088 } CDROM_DEVICE_PATH;
1089 
1090 //
1091 // Use VENDOR_DEVICE_PATH struct
1092 //
1093 #define MEDIA_VENDOR_DP  0x03           ///< Media vendor device path subtype.
1094 
1095 ///
1096 /// File Path Media Device Path SubType
1097 ///
1098 #define MEDIA_FILEPATH_DP  0x04
1099 typedef struct {
1100   EFI_DEVICE_PATH_PROTOCOL    Header;
1101   ///
1102   /// A NULL-terminated Path string including directory and file names.
1103   ///
1104   CHAR16                      PathName[1];
1105 } FILEPATH_DEVICE_PATH;
1106 
1107 #define SIZE_OF_FILEPATH_DEVICE_PATH  OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)
1108 
1109 ///
1110 /// Media Protocol Device Path SubType.
1111 ///
1112 #define MEDIA_PROTOCOL_DP  0x05
1113 
1114 ///
1115 /// The Media Protocol Device Path is used to denote the protocol that is being
1116 /// used in a device path at the location of the path specified.
1117 /// Many protocols are inherent to the style of device path.
1118 ///
1119 typedef struct {
1120   EFI_DEVICE_PATH_PROTOCOL    Header;
1121   ///
1122   /// The ID of the protocol.
1123   ///
1124   EFI_GUID                    Protocol;
1125 } MEDIA_PROTOCOL_DEVICE_PATH;
1126 
1127 ///
1128 /// PIWG Firmware File SubType.
1129 ///
1130 #define MEDIA_PIWG_FW_FILE_DP  0x06
1131 
1132 ///
1133 /// This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware file.
1134 ///
1135 typedef struct {
1136   EFI_DEVICE_PATH_PROTOCOL    Header;
1137   ///
1138   /// Firmware file name
1139   ///
1140   EFI_GUID                    FvFileName;
1141 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;
1142 
1143 ///
1144 /// PIWG Firmware Volume Device Path SubType.
1145 ///
1146 #define MEDIA_PIWG_FW_VOL_DP  0x07
1147 
1148 ///
1149 /// This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware volume.
1150 ///
1151 typedef struct {
1152   EFI_DEVICE_PATH_PROTOCOL    Header;
1153   ///
1154   /// Firmware volume name.
1155   ///
1156   EFI_GUID                    FvName;
1157 } MEDIA_FW_VOL_DEVICE_PATH;
1158 
1159 ///
1160 /// Media relative offset range device path.
1161 ///
1162 #define MEDIA_RELATIVE_OFFSET_RANGE_DP  0x08
1163 
1164 ///
1165 /// Used to describe the offset range of media relative.
1166 ///
1167 typedef struct {
1168   EFI_DEVICE_PATH_PROTOCOL    Header;
1169   UINT32                      Reserved;
1170   UINT64                      StartingOffset;
1171   UINT64                      EndingOffset;
1172 } MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH;
1173 
1174 ///
1175 /// This GUID defines a RAM Disk supporting a raw disk format in volatile memory.
1176 ///
1177 #define EFI_VIRTUAL_DISK_GUID  EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_VOLATILE
1178 
1179 extern  EFI_GUID  gEfiVirtualDiskGuid;
1180 
1181 ///
1182 /// This GUID defines a RAM Disk supporting an ISO image in volatile memory.
1183 ///
1184 #define EFI_VIRTUAL_CD_GUID  EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_VOLATILE
1185 
1186 extern  EFI_GUID  gEfiVirtualCdGuid;
1187 
1188 ///
1189 /// This GUID defines a RAM Disk supporting a raw disk format in persistent memory.
1190 ///
1191 #define EFI_PERSISTENT_VIRTUAL_DISK_GUID  EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_PERSISTENT
1192 
1193 extern  EFI_GUID  gEfiPersistentVirtualDiskGuid;
1194 
1195 ///
1196 /// This GUID defines a RAM Disk supporting an ISO image in persistent memory.
1197 ///
1198 #define EFI_PERSISTENT_VIRTUAL_CD_GUID  EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_PERSISTENT
1199 
1200 extern  EFI_GUID  gEfiPersistentVirtualCdGuid;
1201 
1202 ///
1203 /// Media ram disk device path.
1204 ///
1205 #define MEDIA_RAM_DISK_DP  0x09
1206 
1207 ///
1208 /// Used to describe the ram disk device path.
1209 ///
1210 typedef struct {
1211   EFI_DEVICE_PATH_PROTOCOL    Header;
1212   ///
1213   /// Starting Memory Address.
1214   ///
1215   UINT32                      StartingAddr[2];
1216   ///
1217   /// Ending Memory Address.
1218   ///
1219   UINT32                      EndingAddr[2];
1220   ///
1221   /// GUID that defines the type of the RAM Disk.
1222   ///
1223   EFI_GUID                    TypeGuid;
1224   ///
1225   /// RAM Diskinstance number, if supported. The default value is zero.
1226   ///
1227   UINT16                      Instance;
1228 } MEDIA_RAM_DISK_DEVICE_PATH;
1229 
1230 ///
1231 /// BIOS Boot Specification Device Path.
1232 ///
1233 #define BBS_DEVICE_PATH  0x05
1234 
1235 ///
1236 /// BIOS Boot Specification Device Path SubType.
1237 ///
1238 #define BBS_BBS_DP  0x01
1239 
1240 ///
1241 /// This Device Path is used to describe the booting of non-EFI-aware operating systems.
1242 ///
1243 typedef struct {
1244   EFI_DEVICE_PATH_PROTOCOL    Header;
1245   ///
1246   /// Device Type as defined by the BIOS Boot Specification.
1247   ///
1248   UINT16                      DeviceType;
1249   ///
1250   /// Status Flags as defined by the BIOS Boot Specification.
1251   ///
1252   UINT16                      StatusFlag;
1253   ///
1254   /// Null-terminated ASCII string that describes the boot device to a user.
1255   ///
1256   CHAR8                       String[1];
1257 } BBS_BBS_DEVICE_PATH;
1258 
1259 //
1260 // DeviceType definitions - from BBS specification
1261 //
1262 #define BBS_TYPE_FLOPPY            0x01
1263 #define BBS_TYPE_HARDDRIVE         0x02
1264 #define BBS_TYPE_CDROM             0x03
1265 #define BBS_TYPE_PCMCIA            0x04
1266 #define BBS_TYPE_USB               0x05
1267 #define BBS_TYPE_EMBEDDED_NETWORK  0x06
1268 #define BBS_TYPE_BEV               0x80
1269 #define BBS_TYPE_UNKNOWN           0xFF
1270 
1271 ///
1272 /// Union of all possible Device Paths and pointers to Device Paths.
1273 ///
1274 typedef union {
1275   EFI_DEVICE_PATH_PROTOCOL                   DevPath;
1276   PCI_DEVICE_PATH                            Pci;
1277   PCCARD_DEVICE_PATH                         PcCard;
1278   MEMMAP_DEVICE_PATH                         MemMap;
1279   VENDOR_DEVICE_PATH                         Vendor;
1280 
1281   CONTROLLER_DEVICE_PATH                     Controller;
1282   BMC_DEVICE_PATH                            Bmc;
1283   ACPI_HID_DEVICE_PATH                       Acpi;
1284   ACPI_EXTENDED_HID_DEVICE_PATH              ExtendedAcpi;
1285   ACPI_ADR_DEVICE_PATH                       AcpiAdr;
1286 
1287   ATAPI_DEVICE_PATH                          Atapi;
1288   SCSI_DEVICE_PATH                           Scsi;
1289   ISCSI_DEVICE_PATH                          Iscsi;
1290   FIBRECHANNEL_DEVICE_PATH                   FibreChannel;
1291   FIBRECHANNELEX_DEVICE_PATH                 FibreChannelEx;
1292 
1293   F1394_DEVICE_PATH                          F1394;
1294   USB_DEVICE_PATH                            Usb;
1295   SATA_DEVICE_PATH                           Sata;
1296   USB_CLASS_DEVICE_PATH                      UsbClass;
1297   USB_WWID_DEVICE_PATH                       UsbWwid;
1298   DEVICE_LOGICAL_UNIT_DEVICE_PATH            LogicUnit;
1299   I2O_DEVICE_PATH                            I2O;
1300   MAC_ADDR_DEVICE_PATH                       MacAddr;
1301   IPv4_DEVICE_PATH                           Ipv4;
1302   IPv6_DEVICE_PATH                           Ipv6;
1303   VLAN_DEVICE_PATH                           Vlan;
1304   INFINIBAND_DEVICE_PATH                     InfiniBand;
1305   UART_DEVICE_PATH                           Uart;
1306   UART_FLOW_CONTROL_DEVICE_PATH              UartFlowControl;
1307   SAS_DEVICE_PATH                            Sas;
1308   SASEX_DEVICE_PATH                          SasEx;
1309   NVME_NAMESPACE_DEVICE_PATH                 NvmeNamespace;
1310   NVME_OF_NAMESPACE_DEVICE_PATH              NvmeOfNamespace;
1311   DNS_DEVICE_PATH                            Dns;
1312   URI_DEVICE_PATH                            Uri;
1313   BLUETOOTH_DEVICE_PATH                      Bluetooth;
1314   WIFI_DEVICE_PATH                           WiFi;
1315   UFS_DEVICE_PATH                            Ufs;
1316   SD_DEVICE_PATH                             Sd;
1317   EMMC_DEVICE_PATH                           Emmc;
1318   HARDDRIVE_DEVICE_PATH                      HardDrive;
1319   CDROM_DEVICE_PATH                          CD;
1320 
1321   FILEPATH_DEVICE_PATH                       FilePath;
1322   MEDIA_PROTOCOL_DEVICE_PATH                 MediaProtocol;
1323 
1324   MEDIA_FW_VOL_DEVICE_PATH                   FirmwareVolume;
1325   MEDIA_FW_VOL_FILEPATH_DEVICE_PATH          FirmwareFile;
1326   MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH    Offset;
1327   MEDIA_RAM_DISK_DEVICE_PATH                 RamDisk;
1328   BBS_BBS_DEVICE_PATH                        Bbs;
1329 } EFI_DEV_PATH;
1330 
1331 typedef union {
1332   EFI_DEVICE_PATH_PROTOCOL                   *DevPath;
1333   PCI_DEVICE_PATH                            *Pci;
1334   PCCARD_DEVICE_PATH                         *PcCard;
1335   MEMMAP_DEVICE_PATH                         *MemMap;
1336   VENDOR_DEVICE_PATH                         *Vendor;
1337 
1338   CONTROLLER_DEVICE_PATH                     *Controller;
1339   BMC_DEVICE_PATH                            *Bmc;
1340   ACPI_HID_DEVICE_PATH                       *Acpi;
1341   ACPI_EXTENDED_HID_DEVICE_PATH              *ExtendedAcpi;
1342   ACPI_ADR_DEVICE_PATH                       *AcpiAdr;
1343 
1344   ATAPI_DEVICE_PATH                          *Atapi;
1345   SCSI_DEVICE_PATH                           *Scsi;
1346   ISCSI_DEVICE_PATH                          *Iscsi;
1347   FIBRECHANNEL_DEVICE_PATH                   *FibreChannel;
1348   FIBRECHANNELEX_DEVICE_PATH                 *FibreChannelEx;
1349 
1350   F1394_DEVICE_PATH                          *F1394;
1351   USB_DEVICE_PATH                            *Usb;
1352   SATA_DEVICE_PATH                           *Sata;
1353   USB_CLASS_DEVICE_PATH                      *UsbClass;
1354   USB_WWID_DEVICE_PATH                       *UsbWwid;
1355   DEVICE_LOGICAL_UNIT_DEVICE_PATH            *LogicUnit;
1356   I2O_DEVICE_PATH                            *I2O;
1357   MAC_ADDR_DEVICE_PATH                       *MacAddr;
1358   IPv4_DEVICE_PATH                           *Ipv4;
1359   IPv6_DEVICE_PATH                           *Ipv6;
1360   VLAN_DEVICE_PATH                           *Vlan;
1361   INFINIBAND_DEVICE_PATH                     *InfiniBand;
1362   UART_DEVICE_PATH                           *Uart;
1363   UART_FLOW_CONTROL_DEVICE_PATH              *UartFlowControl;
1364   SAS_DEVICE_PATH                            *Sas;
1365   SASEX_DEVICE_PATH                          *SasEx;
1366   NVME_NAMESPACE_DEVICE_PATH                 *NvmeNamespace;
1367   NVME_OF_NAMESPACE_DEVICE_PATH              *NvmeOfNamespace;
1368   DNS_DEVICE_PATH                            *Dns;
1369   URI_DEVICE_PATH                            *Uri;
1370   BLUETOOTH_DEVICE_PATH                      *Bluetooth;
1371   WIFI_DEVICE_PATH                           *WiFi;
1372   UFS_DEVICE_PATH                            *Ufs;
1373   SD_DEVICE_PATH                             *Sd;
1374   EMMC_DEVICE_PATH                           *Emmc;
1375   HARDDRIVE_DEVICE_PATH                      *HardDrive;
1376   CDROM_DEVICE_PATH                          *CD;
1377 
1378   FILEPATH_DEVICE_PATH                       *FilePath;
1379   MEDIA_PROTOCOL_DEVICE_PATH                 *MediaProtocol;
1380 
1381   MEDIA_FW_VOL_DEVICE_PATH                   *FirmwareVolume;
1382   MEDIA_FW_VOL_FILEPATH_DEVICE_PATH          *FirmwareFile;
1383   MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH    *Offset;
1384   MEDIA_RAM_DISK_DEVICE_PATH                 *RamDisk;
1385   BBS_BBS_DEVICE_PATH                        *Bbs;
1386   UINT8                                      *Raw;
1387 } EFI_DEV_PATH_PTR;
1388 
1389 #pragma pack()
1390 
1391 #define END_DEVICE_PATH_TYPE              0x7f
1392 #define END_ENTIRE_DEVICE_PATH_SUBTYPE    0xFF
1393 #define END_INSTANCE_DEVICE_PATH_SUBTYPE  0x01
1394 
1395 extern EFI_GUID  gEfiDevicePathProtocolGuid;
1396 
1397 #endif
1398