[efi] Update UEFI header files with latest version from TianoCore
[people/peper/gpxe.git] / src / include / gpxe / efi / Protocol / DevicePath.h
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 - 2010, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials are licensed and made available under
10 the terms and conditions of the BSD License that accompanies this distribution.
11 The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php.
13
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.
16
17 **/
18
19 #ifndef __EFI_DEVICE_PATH_PROTOCOL_H__
20 #define __EFI_DEVICE_PATH_PROTOCOL_H__
21
22 #include <gpxe/efi/Guid/PcAnsi.h>
23
24 ///
25 /// Device Path protocol.
26 ///
27 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
28   { \
29     0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
30   }
31
32 ///
33 /// Device Path guid definition for backward-compatible with EFI1.1.
34 ///
35 #define DEVICE_PATH_PROTOCOL  EFI_DEVICE_PATH_PROTOCOL_GUID
36
37 #pragma pack(1)
38
39 /**
40   This protocol can be used on any device handle to obtain generic path/location
41   information concerning the physical device or logical device. If the handle does
42   not logically map to a physical device, the handle may not necessarily support
43   the device path protocol. The device path describes the location of the device
44   the handle is for. The size of the Device Path can be determined from the structures
45   that make up the Device Path.
46 **/
47 typedef struct {
48   UINT8 Type;       ///< 0x01 Hardware Device Path.
49                     ///< 0x02 ACPI Device Path.
50                     ///< 0x03 Messaging Device Path.
51                     ///< 0x04 Media Device Path.
52                     ///< 0x05 BIOS Boot Specification Device Path.
53                     ///< 0x7F End of Hardware Device Path.
54
55   UINT8 SubType;    ///< Varies by Type
56                     ///< 0xFF End Entire Device Path, or
57                     ///< 0x01 End This Instance of a Device Path and start a new
58                     ///< Device Path.
59
60   UINT8 Length[2];  ///< Specific Device Path data. Type and Sub-Type define
61                     ///< type of data. Size of data is included in Length.
62
63 } EFI_DEVICE_PATH_PROTOCOL;
64
65 ///
66 /// Device Path protocol definition for backward-compatible with EFI1.1.
67 ///
68 typedef EFI_DEVICE_PATH_PROTOCOL  EFI_DEVICE_PATH;
69
70 ///
71 /// Hardware Device Paths.
72 ///
73 #define HARDWARE_DEVICE_PATH      0x01
74
75 ///
76 /// PCI Device Path SubType.
77 ///
78 #define HW_PCI_DP                 0x01
79
80 ///
81 /// PCI Device Path.
82 ///
83 typedef struct {
84   EFI_DEVICE_PATH_PROTOCOL        Header;
85   ///
86   /// PCI Function Number.
87   ///
88   UINT8                           Function;
89   ///
90   /// PCI Device Number.
91   ///
92   UINT8                           Device;
93 } PCI_DEVICE_PATH;
94
95 ///
96 /// PCCARD Device Path SubType.
97 ///
98 #define HW_PCCARD_DP              0x02
99
100 ///
101 /// PCCARD Device Path.
102 ///
103 typedef struct {
104   EFI_DEVICE_PATH_PROTOCOL        Header;
105   ///
106   /// Function Number (0 = First Function).
107   ///
108   UINT8                           FunctionNumber;
109 } PCCARD_DEVICE_PATH;
110
111 ///
112 /// Memory Mapped Device Path SubType.
113 ///
114 #define HW_MEMMAP_DP              0x03
115
116 ///
117 /// Memory Mapped Device Path.
118 ///
119 typedef struct {
120   EFI_DEVICE_PATH_PROTOCOL        Header;
121   ///
122   /// EFI_MEMORY_TYPE
123   ///
124   UINT32                          MemoryType;
125   ///
126   /// Starting Memory Address.
127   ///
128   EFI_PHYSICAL_ADDRESS            StartingAddress;
129   ///
130   /// Ending Memory Address.
131   ///
132   EFI_PHYSICAL_ADDRESS            EndingAddress;
133 } MEMMAP_DEVICE_PATH;
134
135 ///
136 /// Hardware Vendor Device Path SubType.
137 ///
138 #define HW_VENDOR_DP              0x04
139
140 ///
141 /// The Vendor Device Path allows the creation of vendor-defined Device Paths. A vendor must
142 /// allocate a Vendor GUID for a Device Path. The Vendor GUID can then be used to define the
143 /// contents on the n bytes that follow in the Vendor Device Path node.
144 ///
145 typedef struct {
146   EFI_DEVICE_PATH_PROTOCOL        Header;
147   ///
148   /// Vendor-assigned GUID that defines the data that follows.
149   ///
150   EFI_GUID                        Guid;
151   ///
152   /// Vendor-defined variable size data.
153   ///
154 } VENDOR_DEVICE_PATH;
155
156 ///
157 /// Controller Device Path SubType.
158 ///
159 #define HW_CONTROLLER_DP          0x05
160
161 ///
162 /// Controller Device Path.
163 ///
164 typedef struct {
165   EFI_DEVICE_PATH_PROTOCOL        Header;
166   ///
167   /// Controller number.
168   ///
169   UINT32                          ControllerNumber;
170 } CONTROLLER_DEVICE_PATH;
171
172 ///
173 /// ACPI Device Paths.
174 ///
175 #define ACPI_DEVICE_PATH          0x02
176
177 ///
178 /// ACPI Device Path SubType.
179 ///
180 #define ACPI_DP                   0x01
181 typedef struct {
182   EFI_DEVICE_PATH_PROTOCOL        Header;
183   ///
184   /// Device's PnP hardware ID stored in a numeric 32-bit
185   /// compressed EISA-type ID. This value must match the
186   /// corresponding _HID in the ACPI name space.
187   ///
188   UINT32                          HID;
189   ///
190   /// Unique ID that is required by ACPI if two devices have the
191   /// same _HID. This value must also match the corresponding
192   /// _UID/_HID pair in the ACPI name space. Only the 32-bit
193   /// numeric value type of _UID is supported. Thus, strings must
194   /// not be used for the _UID in the ACPI name space.
195   ///
196   UINT32                          UID;
197 } ACPI_HID_DEVICE_PATH;
198
199 ///
200 /// Expanded ACPI Device Path SubType.
201 ///
202 #define ACPI_EXTENDED_DP          0x02
203 typedef struct {
204   EFI_DEVICE_PATH_PROTOCOL        Header;
205   ///
206   /// Device's PnP hardware ID stored in a numeric 32-bit
207   /// compressed EISA-type ID. This value must match the
208   /// corresponding _HID in the ACPI name space.
209   ///
210   UINT32                          HID;
211   ///
212   /// Unique ID that is required by ACPI if two devices have the
213   /// same _HID. This value must also match the corresponding
214   /// _UID/_HID pair in the ACPI name space.
215   ///
216   UINT32                          UID;
217   ///
218   /// Device's compatible PnP hardware ID stored in a numeric
219   /// 32-bit compressed EISA-type ID. This value must match at
220   /// least one of the compatible device IDs returned by the
221   /// corresponding _CID in the ACPI name space.
222   ///
223   UINT32                          CID;
224   ///
225   /// Optional variable length _HIDSTR.
226   /// Optional variable length _UIDSTR.
227   /// Optional variable length _CIDSTR.
228   ///
229 } ACPI_EXTENDED_HID_DEVICE_PATH;
230
231 //
232 //  EISA ID Macro
233 //  EISA ID Definition 32-bits
234 //   bits[15:0] - three character compressed ASCII EISA ID.
235 //   bits[31:16] - binary number
236 //    Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
237 //
238 #define PNP_EISA_ID_CONST         0x41d0
239 #define EISA_ID(_Name, _Num)      ((UINT32)((_Name) | (_Num) << 16))
240 #define EISA_PNP_ID(_PNPId)       (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
241 #define EFI_PNP_ID(_PNPId)        (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
242
243 #define PNP_EISA_ID_MASK          0xffff
244 #define EISA_ID_TO_NUM(_Id)       ((_Id) >> 16)
245
246 ///
247 /// ACPI _ADR Device Path SubType.
248 ///
249 #define ACPI_ADR_DP               0x03
250
251 ///
252 /// The _ADR device path is used to contain video output device attributes to support the Graphics
253 /// Output Protocol. The device path can contain multiple _ADR entries if multiple video output
254 /// devices are displaying the same output.
255 ///
256 typedef struct {
257   EFI_DEVICE_PATH_PROTOCOL        Header;
258   ///
259   /// _ADR value. For video output devices the value of this
260   /// field comes from Table B-2 of the ACPI 3.0 specification. At
261   /// least one _ADR value is required.
262   ///
263   UINT32                          ADR;
264   //
265   // This device path may optionally contain more than one _ADR entry.
266   //
267 } ACPI_ADR_DEVICE_PATH;
268
269 #define ACPI_ADR_DISPLAY_TYPE_OTHER             0
270 #define ACPI_ADR_DISPLAY_TYPE_VGA               1
271 #define ACPI_ADR_DISPLAY_TYPE_TV                2
272 #define ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL  3
273 #define ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL  4
274
275 #define ACPI_DISPLAY_ADR(_DeviceIdScheme, _HeadId, _NonVgaOutput, _BiosCanDetect, _VendorInfo, _Type, _Port, _Index) \
276           ((UINT32)( (((_DeviceIdScheme) & 0x1) << 31) |  \
277                       (((_HeadId)         & 0x7) << 18) |  \
278                       (((_NonVgaOutput)   & 0x1) << 17) |  \
279                       (((_BiosCanDetect)  & 0x1) << 16) |  \
280                       (((_VendorInfo)     & 0xf) << 12) |  \
281                       (((_Type)           & 0xf) << 8)  |  \
282                       (((_Port)           & 0xf) << 4)  |  \
283                        ((_Index)          & 0xf) ))
284
285 ///
286 /// Messaging Device Paths.
287 /// This Device Path is used to describe the connection of devices outside the resource domain of the
288 /// system. This Device Path can describe physical messaging information like SCSI ID, or abstract
289 /// information like networking protocol IP addresses.
290 ///
291 #define MESSAGING_DEVICE_PATH     0x03
292
293 ///
294 /// ATAPI Device Path SubType
295 ///
296 #define MSG_ATAPI_DP              0x01
297 typedef struct {
298   EFI_DEVICE_PATH_PROTOCOL        Header;
299   ///
300   /// Set to zero for primary, or one for secondary.
301   ///
302   UINT8                           PrimarySecondary;
303   ///
304   /// Set to zero for master, or one for slave mode.
305   ///
306   UINT8                           SlaveMaster;
307   ///
308   /// Logical Unit Number.
309   ///
310   UINT16                          Lun;
311 } ATAPI_DEVICE_PATH;
312
313 ///
314 /// SCSI Device Path SubType.
315 ///
316 #define MSG_SCSI_DP               0x02
317 typedef struct {
318   EFI_DEVICE_PATH_PROTOCOL        Header;
319   ///
320   /// Target ID on the SCSI bus (PUN).
321   ///
322   UINT16                          Pun;
323   ///
324   /// Logical Unit Number (LUN).
325   ///
326   UINT16                          Lun;
327 } SCSI_DEVICE_PATH;
328
329 ///
330 /// Fibre Channel SubType.
331 ///
332 #define MSG_FIBRECHANNEL_DP       0x03
333 typedef struct {
334   EFI_DEVICE_PATH_PROTOCOL        Header;
335   ///
336   /// Reserved for the future.
337   ///
338   UINT32                          Reserved;
339   ///
340   /// Fibre Channel World Wide Number.
341   ///
342   UINT64                          WWN;
343   ///
344   /// Fibre Channel Logical Unit Number.
345   ///
346   UINT64                          Lun;
347 } FIBRECHANNEL_DEVICE_PATH;
348
349 ///
350 /// 1394 Device Path SubType
351 ///
352 #define MSG_1394_DP               0x04
353 typedef struct {
354   EFI_DEVICE_PATH_PROTOCOL        Header;
355   ///
356   /// Reserved for the future.
357   ///
358   UINT32                          Reserved;
359   ///
360   /// 1394 Global Unique ID (GUID).
361   ///
362   UINT64                          Guid;
363 } F1394_DEVICE_PATH;
364
365 ///
366 /// USB Device Path SubType.
367 ///
368 #define MSG_USB_DP                0x05
369 typedef struct {
370   EFI_DEVICE_PATH_PROTOCOL      Header;
371   ///
372   /// USB Parent Port Number.
373   ///
374   UINT8                         ParentPortNumber;
375   ///
376   /// USB Interface Number.
377   ///
378   UINT8                         InterfaceNumber;
379 } USB_DEVICE_PATH;
380
381 ///
382 /// USB Class Device Path SubType.
383 ///
384 #define MSG_USB_CLASS_DP          0x0f
385 typedef struct {
386   EFI_DEVICE_PATH_PROTOCOL      Header;
387   ///
388   /// Vendor ID assigned by USB-IF. A value of 0xFFFF will
389   /// match any Vendor ID.
390   ///
391   UINT16                        VendorId;
392   ///
393   /// Product ID assigned by USB-IF. A value of 0xFFFF will
394   /// match any Product ID.
395   ///
396   UINT16                        ProductId;
397   ///
398   /// The class code assigned by the USB-IF. A value of 0xFF
399   /// will match any class code.
400   ///
401   UINT8                         DeviceClass;
402   ///
403   /// The subclass code assigned by the USB-IF. A value of
404   /// 0xFF will match any subclass code.
405   ///
406   UINT8                         DeviceSubClass;
407   ///
408   /// The protocol code assigned by the USB-IF. A value of
409   /// 0xFF will match any protocol code.
410   ///
411   UINT8                         DeviceProtocol;
412 } USB_CLASS_DEVICE_PATH;
413
414 ///
415 /// USB WWID Device Path SubType.
416 ///
417 #define MSG_USB_WWID_DP           0x10
418
419 ///
420 /// This device path describes a USB device using its serial number.
421 ///
422 typedef struct {
423   EFI_DEVICE_PATH_PROTOCOL      Header;
424   ///
425   /// USB interface number.
426   ///
427   UINT16                        InterfaceNumber;
428   ///
429   /// USB vendor id of the device.
430   ///
431   UINT16                        VendorId;
432   ///
433   /// USB product id of the device.
434   ///
435   UINT16                        ProductId;
436   ///
437   /// Last 64-or-fewer UTF-16 characters of the USB
438   /// serial number. The length of the string is
439   /// determined by the Length field less the offset of the
440   /// Serial Number field (10)
441   ///
442   /// CHAR16                     SerialNumber[...];
443 } USB_WWID_DEVICE_PATH;
444
445 ///
446 /// Device Logical Unit SubType.
447 ///
448 #define MSG_DEVICE_LOGICAL_UNIT_DP  0x11
449 typedef struct {
450   EFI_DEVICE_PATH_PROTOCOL      Header;
451   ///
452   /// Logical Unit Number for the interface.
453   ///
454   UINT8                         Lun;
455 } DEVICE_LOGICAL_UNIT_DEVICE_PATH;
456
457 ///
458 /// SATA Device Path SubType.
459 ///
460 #define MSG_SATA_DP               0x12
461 typedef struct {
462   EFI_DEVICE_PATH_PROTOCOL        Header;
463   ///
464   /// The HBA port number that facilitates the connection to the
465   /// device or a port multiplier. The value 0xFFFF is reserved.
466   ///
467   UINT16                          HBAPortNumber;
468   ///
469   /// The Port multiplier port number that facilitates the connection
470   /// to the device. Bit 15 should be set if the device is directly
471   /// connected to the HBA.
472   ///
473   UINT16                          PortMultiplierPortNumber;
474   ///
475   /// Logical Unit Number.
476   ///
477   UINT16                          Lun;
478 } SATA_DEVICE_PATH;
479
480 ///
481 /// Flag for if the device is directly connected to the HBA.
482 ///
483 #define SATA_HBA_DIRECT_CONNECT_FLAG 0x8000
484
485 ///
486 /// I2O Device Path SubType.
487 ///
488 #define MSG_I2O_DP                0x06
489 typedef struct {
490   EFI_DEVICE_PATH_PROTOCOL        Header;
491   ///
492   /// Target ID (TID) for a device.
493   ///
494   UINT32                          Tid;
495 } I2O_DEVICE_PATH;
496
497 ///
498 /// MAC Address Device Path SubType.
499 ///
500 #define MSG_MAC_ADDR_DP           0x0b
501 typedef struct {
502   EFI_DEVICE_PATH_PROTOCOL        Header;
503   ///
504   /// The MAC address for a network interface padded with 0s.
505   ///
506   EFI_MAC_ADDRESS                 MacAddress;
507   ///
508   /// Network interface type(i.e. 802.3, FDDI).
509   ///
510   UINT8                           IfType;
511 } MAC_ADDR_DEVICE_PATH;
512
513 ///
514 /// IPv4 Device Path SubType
515 ///
516 #define MSG_IPv4_DP               0x0c
517 typedef struct {
518   EFI_DEVICE_PATH_PROTOCOL        Header;
519   ///
520   /// The local IPv4 address.
521   ///
522   EFI_IPv4_ADDRESS                LocalIpAddress;
523   ///
524   /// The remote IPv4 address.
525   ///
526   EFI_IPv4_ADDRESS                RemoteIpAddress;
527   ///
528   /// The local port number.
529   ///
530   UINT16                          LocalPort;
531   ///
532   /// The remote port number.
533   ///
534   UINT16                          RemotePort;
535   ///
536   /// The network protocol(i.e. UDP, TCP).
537   ///
538   UINT16                          Protocol;
539   ///
540   /// 0x00 - The Source IP Address was assigned though DHCP.
541   /// 0x01 - The Source IP Address is statically bound.
542   ///
543   BOOLEAN                         StaticIpAddress;
544 } IPv4_DEVICE_PATH;
545
546 ///
547 /// IPv6 Device Path SubType.
548 ///
549 #define MSG_IPv6_DP               0x0d
550 typedef struct {
551   EFI_DEVICE_PATH_PROTOCOL        Header;
552   ///
553   /// The local IPv6 address.
554   ///
555   EFI_IPv6_ADDRESS                LocalIpAddress;
556   ///
557   /// The remote IPv6 address.
558   ///
559   EFI_IPv6_ADDRESS                RemoteIpAddress;
560   ///
561   /// The local port number.
562   ///
563   UINT16                          LocalPort;
564   ///
565   /// The remote port number.
566   ///
567   UINT16                          RemotePort;
568   ///
569   /// The network protocol(i.e. UDP, TCP).
570   ///
571   UINT16                          Protocol;
572   ///
573   /// 0x00 - The Source IP Address was assigned though DHCP.
574   /// 0x01 - The Source IP Address is statically bound.
575   ///
576   BOOLEAN                         StaticIpAddress;
577 } IPv6_DEVICE_PATH;
578
579 ///
580 /// InfiniBand Device Path SubType.
581 ///
582 #define MSG_INFINIBAND_DP         0x09
583 typedef struct {
584   EFI_DEVICE_PATH_PROTOCOL        Header;
585   ///
586   /// Flags to help identify/manage InfiniBand device path elements:
587   /// Bit 0 - IOC/Service (0b = IOC, 1b = Service).
588   /// Bit 1 - Extend Boot Environment.
589   /// Bit 2 - Console Protocol.
590   /// Bit 3 - Storage Protocol.
591   /// Bit 4 - Network Protocol.
592   /// All other bits are reserved.
593   ///
594   UINT32                          ResourceFlags;
595   ///
596   /// 128-bit Global Identifier for remote fabric port.
597   ///
598   UINT8                           PortGid[16];
599   ///
600   /// 64-bit unique identifier to remote IOC or server process.
601   /// Interpretation of field specified by Resource Flags (bit 0).
602   ///
603   UINT64                          ServiceId;
604   ///
605   /// 64-bit persistent ID of remote IOC port.
606   ///
607   UINT64                          TargetPortId;
608   ///
609   /// 64-bit persistent ID of remote device.
610   ///
611   UINT64                          DeviceId;
612 } INFINIBAND_DEVICE_PATH;
613
614 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE                0x01
615 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT  0x02
616 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL           0x04
617 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL           0x08
618 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL           0x10
619
620 ///
621 /// UART Device Path SubType.
622 ///
623 #define MSG_UART_DP               0x0e
624 typedef struct {
625   EFI_DEVICE_PATH_PROTOCOL        Header;
626   ///
627   /// Reserved.
628   ///
629   UINT32                          Reserved;
630   ///
631   /// The baud rate setting for the UART style device. A value of 0
632   /// means that the device's default baud rate will be used.
633   ///
634   UINT64                          BaudRate;
635   ///
636   /// The number of data bits for the UART style device. A value
637   /// of 0 means that the device's default number of data bits will be used.
638   ///
639   UINT8                           DataBits;
640   ///
641   /// The parity setting for the UART style device.
642   /// Parity 0x00 - Default Parity.
643   /// Parity 0x01 - No Parity.
644   /// Parity 0x02 - Even Parity.
645   /// Parity 0x03 - Odd Parity.
646   /// Parity 0x04 - Mark Parity.
647   /// Parity 0x05 - Space Parity.
648   ///
649   UINT8                           Parity;
650   ///
651   /// The number of stop bits for the UART style device.
652   /// Stop Bits 0x00 - Default Stop Bits.
653   /// Stop Bits 0x01 - 1 Stop Bit.
654   /// Stop Bits 0x02 - 1.5 Stop Bits.
655   /// Stop Bits 0x03 - 2 Stop Bits.
656   ///
657   UINT8                           StopBits;
658 } UART_DEVICE_PATH;
659
660 //
661 // Use VENDOR_DEVICE_PATH struct
662 //
663 #define MSG_VENDOR_DP             0x0a
664 typedef VENDOR_DEVICE_PATH        VENDOR_DEFINED_DEVICE_PATH;
665
666 #define DEVICE_PATH_MESSAGING_PC_ANSI     EFI_PC_ANSI_GUID
667 #define DEVICE_PATH_MESSAGING_VT_100      EFI_VT_100_GUID
668 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
669 #define DEVICE_PATH_MESSAGING_VT_UTF8     EFI_VT_UTF8_GUID
670
671 ///
672 /// A new device path node is defined to declare flow control characteristics.
673 /// UART Flow Control Messaging Device Path
674 ///
675 typedef struct {
676   EFI_DEVICE_PATH_PROTOCOL        Header;
677   ///
678   /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID.
679   ///
680   EFI_GUID                        Guid;
681   ///
682   /// Bitmap of supported flow control types.
683   /// Bit 0 set indicates hardware flow control.
684   /// Bit 1 set indicates Xon/Xoff flow control.
685   /// All other bits are reserved and are clear.
686   ///
687   UINT32                          FlowControlMap;
688 } UART_FLOW_CONTROL_DEVICE_PATH;
689
690 #define UART_FLOW_CONTROL_HARDWARE         0x00000001
691 #define UART_FLOW_CONTROL_XON_XOFF         0x00000010
692
693 #define DEVICE_PATH_MESSAGING_SAS                 EFI_SAS_DEVICE_PATH_GUID
694 ///
695 /// Serial Attached SCSI (SAS) devices.
696 ///
697 typedef struct {
698   EFI_DEVICE_PATH_PROTOCOL        Header;
699   ///
700   /// DEVICE_PATH_MESSAGING_SAS GUID.
701   ///
702   EFI_GUID                        Guid;
703   ///
704   /// Reserved for future use.
705   ///
706   UINT32                          Reserved;
707   ///
708   /// SAS Address for Serial Attached SCSI Target.
709   ///
710   UINT64                          SasAddress;
711   ///
712   /// SAS Logical Unit Number.
713   ///
714   UINT64                          Lun;
715   ///
716   /// More Information about the device and its interconnect.
717   ///
718   UINT16                          DeviceTopology;
719   ///
720   /// Relative Target Port (RTP).
721   ///
722   UINT16                          RelativeTargetPort;
723 } SAS_DEVICE_PATH;
724
725 ///
726 /// iSCSI Device Path SubType
727 ///
728 #define MSG_ISCSI_DP              0x13
729 typedef struct {
730   EFI_DEVICE_PATH_PROTOCOL        Header;
731   ///
732   /// Network Protocol (0 = TCP, 1+ = reserved).
733   ///
734   UINT16                          NetworkProtocol;
735   ///
736   /// iSCSI Login Options.
737   ///
738   UINT16                          LoginOption;
739   ///
740   /// iSCSI Logical Unit Number.
741   ///
742   UINT64                          Lun;
743   ///
744   /// iSCSI Target Portal group tag the initiator intends
745   /// to establish a session with.
746   ///
747   UINT16                          TargetPortalGroupTag;
748   ///
749   /// iSCSI NodeTarget Name. The length of the name
750   /// is determined by subtracting the offset of this field from Length.
751   ///
752   /// CHAR8                        iSCSI Target Name.
753 } ISCSI_DEVICE_PATH;
754
755 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST             0x0000
756 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C   0x0002
757 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST               0x0000
758 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C     0x0008
759 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP              0x0000
760 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON               0x1000
761 #define ISCSI_LOGIN_OPTION_CHAP_BI                      0x0000
762 #define ISCSI_LOGIN_OPTION_CHAP_UNI                     0x2000
763
764 ///
765 /// VLAN Device Path SubType.
766 ///
767 #define MSG_VLAN_DP               0x14
768 typedef struct {
769   EFI_DEVICE_PATH_PROTOCOL        Header;
770   ///
771   /// VLAN identifier (0-4094).
772   ///
773   UINT16                          VlanId;
774 } VLAN_DEVICE_PATH;
775
776 //
777 // Media Device Path
778 //
779 #define MEDIA_DEVICE_PATH         0x04
780
781 ///
782 /// Hard Drive Media Device Path SubType.
783 ///
784 #define MEDIA_HARDDRIVE_DP        0x01
785
786 ///
787 /// The Hard Drive Media Device Path is used to represent a partition on a hard drive.
788 ///
789 typedef struct {
790   EFI_DEVICE_PATH_PROTOCOL        Header;
791   ///
792   /// Describes the entry in a partition table, starting with entry 1.
793   /// Partition number zero represents the entire device. Valid
794   /// partition numbers for a MBR partition are [1, 4]. Valid
795   /// partition numbers for a GPT partition are [1, NumberOfPartitionEntries].
796   ///
797   UINT32                          PartitionNumber;
798   ///
799   /// Starting LBA of the partition on the hard drive.
800   ///
801   UINT64                          PartitionStart;
802   ///
803   /// Size of the partition in units of Logical Blocks.
804   ///
805   UINT64                          PartitionSize;
806   ///
807   /// Signature unique to this partition:
808   /// If SignatureType is 0, this field has to be initialized with 16 zeros.
809   /// If SignatureType is 1, the MBR signature is stored in the first 4 bytes of this field.
810   /// The other 12 bytes are initialized with zeros.
811   /// If SignatureType is 2, this field contains a 16 byte signature.
812   ///
813   UINT8                           Signature[16];
814   ///
815   /// Partition Format: (Unused values reserved).
816   /// 0x01 - PC-AT compatible legacy MBR.
817   /// 0x02 - GUID Partition Table.
818   ///
819   UINT8                           MBRType;
820   ///
821   /// Type of Disk Signature: (Unused values reserved).
822   /// 0x00 - No Disk Signature.
823   /// 0x01 - 32-bit signature from address 0x1b8 of the type 0x01 MBR.
824   /// 0x02 - GUID signature.
825   ///
826   UINT8                           SignatureType;
827 } HARDDRIVE_DEVICE_PATH;
828
829 #define MBR_TYPE_PCAT             0x01
830 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
831
832 #define NO_DISK_SIGNATURE         0x00
833 #define SIGNATURE_TYPE_MBR        0x01
834 #define SIGNATURE_TYPE_GUID       0x02
835
836 ///
837 /// CD-ROM Media Device Path SubType.
838 ///
839 #define MEDIA_CDROM_DP            0x02
840
841 ///
842 /// The CD-ROM Media Device Path is used to define a system partition that exists on a CD-ROM.
843 ///
844 typedef struct {
845   EFI_DEVICE_PATH_PROTOCOL        Header;
846   ///
847   /// Boot Entry number from the Boot Catalog. The Initial/Default entry is defined as zero.
848   ///
849   UINT32                          BootEntry;
850   ///
851   /// Starting RBA of the partition on the medium. CD-ROMs use Relative logical Block Addressing.
852   ///
853   UINT64                          PartitionStart;
854   ///
855   /// Size of the partition in units of Blocks, also called Sectors.
856   ///
857   UINT64                          PartitionSize;
858 } CDROM_DEVICE_PATH;
859
860 //
861 // Use VENDOR_DEVICE_PATH struct
862 //
863 #define MEDIA_VENDOR_DP           0x03  ///< Media vendor device path subtype.
864
865 ///
866 /// File Path Media Device Path SubType
867 ///
868 #define MEDIA_FILEPATH_DP         0x04
869 typedef struct {
870   EFI_DEVICE_PATH_PROTOCOL        Header;
871   ///
872   /// A NULL-terminated Path string including directory and file names.
873   ///
874   CHAR16                          PathName[1];
875 } FILEPATH_DEVICE_PATH;
876
877 #define SIZE_OF_FILEPATH_DEVICE_PATH  OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)
878
879 ///
880 /// Media Protocol Device Path SubType.
881 ///
882 #define MEDIA_PROTOCOL_DP         0x05
883
884 ///
885 /// The Media Protocol Device Path is used to denote the protocol that is being
886 /// used in a device path at the location of the path specified.
887 /// Many protocols are inherent to the style of device path.
888 ///
889 typedef struct {
890   EFI_DEVICE_PATH_PROTOCOL        Header;
891   ///
892   /// The ID of the protocol.
893   ///
894   EFI_GUID                        Protocol;
895 } MEDIA_PROTOCOL_DEVICE_PATH;
896
897 ///
898 /// PIWG Firmware Volume Device Path SubType.
899 ///
900 #define MEDIA_PIWG_FW_FILE_DP     0x06
901
902 ///
903 /// This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware file.
904 ///
905 typedef struct {
906   EFI_DEVICE_PATH_PROTOCOL        Header;
907   ///
908   /// Firmware file name
909   ///
910   EFI_GUID                        FvFileName;
911 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;
912
913 ///
914 /// PIWG Firmware Volume Device Path SubType.
915 ///
916 #define MEDIA_PIWG_FW_VOL_DP      0x07
917
918 ///
919 /// This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware volume.
920 ///
921 typedef struct {
922   EFI_DEVICE_PATH_PROTOCOL        Header;
923   ///
924   /// Firmware volume name.
925   ///
926   EFI_GUID                        FvName;
927 } MEDIA_FW_VOL_DEVICE_PATH;
928
929 ///
930 /// Media relative offset range device path.
931 ///
932 #define MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08
933
934 ///
935 /// Used to describe the offset range of media relative.
936 ///
937 typedef struct {
938   EFI_DEVICE_PATH_PROTOCOL  Header;
939   UINT32                    Reserved;
940   UINT64                    StartingOffset;
941   UINT64                    EndingOffset;
942 } MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH;
943
944 ///
945 /// BIOS Boot Specification Device Path.
946 ///
947 #define BBS_DEVICE_PATH           0x05
948
949 ///
950 /// BIOS Boot Specification Device Path SubType.
951 ///
952 #define BBS_BBS_DP                0x01
953
954 ///
955 /// This Device Path is used to describe the booting of non-EFI-aware operating systems.
956 ///
957 typedef struct {
958   EFI_DEVICE_PATH_PROTOCOL        Header;
959   ///
960   /// Device Type as defined by the BIOS Boot Specification.
961   ///
962   UINT16                          DeviceType;
963   ///
964   /// Status Flags as defined by the BIOS Boot Specification.
965   ///
966   UINT16                          StatusFlag;
967   ///
968   /// ASCIIZ string that describes the boot device to a user.
969   ///
970   CHAR8                           String[1];
971 } BBS_BBS_DEVICE_PATH;
972
973 //
974 // DeviceType definitions - from BBS specification
975 //
976 #define BBS_TYPE_FLOPPY           0x01
977 #define BBS_TYPE_HARDDRIVE        0x02
978 #define BBS_TYPE_CDROM            0x03
979 #define BBS_TYPE_PCMCIA           0x04
980 #define BBS_TYPE_USB              0x05
981 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
982 #define BBS_TYPE_BEV              0x80
983 #define BBS_TYPE_UNKNOWN          0xFF
984
985
986 ///
987 /// Union of all possible Device Paths and pointers to Device Paths.
988 ///
989 typedef union {
990   EFI_DEVICE_PATH_PROTOCOL             DevPath;
991   PCI_DEVICE_PATH                      Pci;
992   PCCARD_DEVICE_PATH                   PcCard;
993   MEMMAP_DEVICE_PATH                   MemMap;
994   VENDOR_DEVICE_PATH                   Vendor;
995
996   CONTROLLER_DEVICE_PATH               Controller;
997   ACPI_HID_DEVICE_PATH                 Acpi;
998
999   ATAPI_DEVICE_PATH                    Atapi;
1000   SCSI_DEVICE_PATH                     Scsi;
1001   ISCSI_DEVICE_PATH                    Iscsi;
1002   FIBRECHANNEL_DEVICE_PATH             FibreChannel;
1003
1004   F1394_DEVICE_PATH                    F1394;
1005   USB_DEVICE_PATH                      Usb;
1006   SATA_DEVICE_PATH                     Sata;
1007   USB_CLASS_DEVICE_PATH                UsbClass;
1008   I2O_DEVICE_PATH                      I2O;
1009   MAC_ADDR_DEVICE_PATH                 MacAddr;
1010   IPv4_DEVICE_PATH                     Ipv4;
1011   IPv6_DEVICE_PATH                     Ipv6;
1012   INFINIBAND_DEVICE_PATH               InfiniBand;
1013   UART_DEVICE_PATH                     Uart;
1014
1015   HARDDRIVE_DEVICE_PATH                HardDrive;
1016   CDROM_DEVICE_PATH                    CD;
1017
1018   FILEPATH_DEVICE_PATH                 FilePath;
1019   MEDIA_PROTOCOL_DEVICE_PATH           MediaProtocol;
1020   MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH Offset;
1021
1022   BBS_BBS_DEVICE_PATH                  Bbs;
1023 } EFI_DEV_PATH;
1024
1025
1026
1027 typedef union {
1028   EFI_DEVICE_PATH_PROTOCOL             *DevPath;
1029   PCI_DEVICE_PATH                      *Pci;
1030   PCCARD_DEVICE_PATH                   *PcCard;
1031   MEMMAP_DEVICE_PATH                   *MemMap;
1032   VENDOR_DEVICE_PATH                   *Vendor;
1033
1034   CONTROLLER_DEVICE_PATH               *Controller;
1035   ACPI_HID_DEVICE_PATH                 *Acpi;
1036   ACPI_EXTENDED_HID_DEVICE_PATH        *ExtendedAcpi;
1037
1038   ATAPI_DEVICE_PATH                    *Atapi;
1039   SCSI_DEVICE_PATH                     *Scsi;
1040   FIBRECHANNEL_DEVICE_PATH             *FibreChannel;
1041
1042   F1394_DEVICE_PATH                    *F1394;
1043   USB_DEVICE_PATH                      *Usb;
1044   SATA_DEVICE_PATH                     *Sata;
1045   USB_CLASS_DEVICE_PATH                *UsbClass;
1046   I2O_DEVICE_PATH                      *I2O;
1047   MAC_ADDR_DEVICE_PATH                 *MacAddr;
1048   IPv4_DEVICE_PATH                     *Ipv4;
1049   IPv6_DEVICE_PATH                     *Ipv6;
1050   INFINIBAND_DEVICE_PATH               *InfiniBand;
1051   UART_DEVICE_PATH                     *Uart;
1052
1053   HARDDRIVE_DEVICE_PATH                *HardDrive;
1054   CDROM_DEVICE_PATH                    *CD;
1055
1056   FILEPATH_DEVICE_PATH                 *FilePath;
1057   MEDIA_PROTOCOL_DEVICE_PATH           *MediaProtocol;
1058   MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH *Offset;
1059
1060   BBS_BBS_DEVICE_PATH                  *Bbs;
1061   UINT8                                *Raw;
1062 } EFI_DEV_PATH_PTR;
1063
1064 #pragma pack()
1065
1066 #define END_DEVICE_PATH_TYPE                 0x7f
1067 #define END_ENTIRE_DEVICE_PATH_SUBTYPE       0xFF
1068 #define END_INSTANCE_DEVICE_PATH_SUBTYPE     0x01
1069
1070 extern EFI_GUID gEfiDevicePathProtocolGuid;
1071
1072 #endif