uefi_raw/protocol/
device_path.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2
3mod device_path_gen;
4
5use crate::{guid, Char16, Guid};
6
7pub use device_path_gen::{acpi, bios_boot_spec, end, hardware, media, messaging};
8
9/// Device path protocol.
10///
11/// A device path contains one or more device path instances made of up
12/// variable-length nodes.
13///
14/// Note that the fields in this struct define the header at the start of each
15/// node; a device path is typically larger than these four bytes.
16#[derive(Debug)]
17#[repr(C)]
18pub struct DevicePathProtocol {
19    pub major_type: DeviceType,
20    pub sub_type: DeviceSubType,
21    pub length: [u8; 2],
22    // followed by payload (dynamically sized)
23}
24
25impl DevicePathProtocol {
26    pub const GUID: Guid = guid!("09576e91-6d3f-11d2-8e39-00a0c969723b");
27}
28
29newtype_enum! {
30/// Type identifier for a device path node.
31pub enum DeviceType: u8 => {
32    /// Hardware Device Path.
33    ///
34    /// This Device Path defines how a device is attached to the resource domain of a system, where resource domain is
35    /// simply the shared memory, memory mapped I/ O, and I/O space of the system.
36    HARDWARE = 0x01,
37    /// ACPI Device Path.
38    ///
39    /// This Device Path is used to describe devices whose enumeration is not described in an industry-standard fashion.
40    /// These devices must be described using ACPI AML in the ACPI namespace; this Device Path is a linkage to the ACPI
41    /// namespace.
42    ACPI = 0x02,
43    /// Messaging Device Path.
44    ///
45    /// This Device Path is used to describe the connection of devices outside the resource domain of the system. This
46    /// Device Path can describe physical messaging information such as a SCSI ID, or abstract information such as
47    /// networking protocol IP addresses.
48    MESSAGING = 0x03,
49    /// Media Device Path.
50    ///
51    /// This Device Path is used to describe the portion of a medium that is being abstracted by a boot service.
52    /// For example, a Media Device Path could define which partition on a hard drive was being used.
53    MEDIA = 0x04,
54    /// BIOS Boot Specification Device Path.
55    ///
56    /// This Device Path is used to point to boot legacy operating systems; it is based on the BIOS Boot Specification
57    /// Version 1.01.
58    BIOS_BOOT_SPEC = 0x05,
59    /// End of Hardware Device Path.
60    ///
61    /// Depending on the Sub-Type, this Device Path node is used to indicate the end of the Device Path instance or
62    /// Device Path structure.
63    END = 0x7F,
64}}
65
66/// Sub-type identifier for a device path node.
67#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
68#[repr(transparent)]
69pub struct DeviceSubType(pub u8);
70
71impl DeviceSubType {
72    /// PCI Device Path.
73    pub const HARDWARE_PCI: Self = Self(1);
74    /// PCCARD Device Path.
75    pub const HARDWARE_PCCARD: Self = Self(2);
76    /// Memory-mapped Device Path.
77    pub const HARDWARE_MEMORY_MAPPED: Self = Self(3);
78    /// Vendor-Defined Device Path.
79    pub const HARDWARE_VENDOR: Self = Self(4);
80    /// Controller Device Path.
81    pub const HARDWARE_CONTROLLER: Self = Self(5);
82    /// BMC Device Path.
83    pub const HARDWARE_BMC: Self = Self(6);
84
85    /// ACPI Device Path.
86    pub const ACPI: Self = Self(1);
87    /// Expanded ACPI Device Path.
88    pub const ACPI_EXPANDED: Self = Self(2);
89    /// ACPI _ADR Device Path.
90    pub const ACPI_ADR: Self = Self(3);
91    /// NVDIMM Device Path.
92    pub const ACPI_NVDIMM: Self = Self(4);
93
94    /// ATAPI Device Path.
95    pub const MESSAGING_ATAPI: Self = Self(1);
96    /// SCSI Device Path.
97    pub const MESSAGING_SCSI: Self = Self(2);
98    /// Fibre Channel Device Path.
99    pub const MESSAGING_FIBRE_CHANNEL: Self = Self(3);
100    /// 1394 Device Path.
101    pub const MESSAGING_1394: Self = Self(4);
102    /// USB Device Path.
103    pub const MESSAGING_USB: Self = Self(5);
104    /// I2O Device Path.
105    pub const MESSAGING_I2O: Self = Self(6);
106    /// Infiniband Device Path.
107    pub const MESSAGING_INFINIBAND: Self = Self(9);
108    /// Vendor-Defined Device Path.
109    pub const MESSAGING_VENDOR: Self = Self(10);
110    /// MAC Address Device Path.
111    pub const MESSAGING_MAC_ADDRESS: Self = Self(11);
112    /// IPV4 Device Path.
113    pub const MESSAGING_IPV4: Self = Self(12);
114    /// IPV6 Device Path.
115    pub const MESSAGING_IPV6: Self = Self(13);
116    /// UART Device Path.
117    pub const MESSAGING_UART: Self = Self(14);
118    /// USB Class Device Path.
119    pub const MESSAGING_USB_CLASS: Self = Self(15);
120    /// USB WWID Device Path.
121    pub const MESSAGING_USB_WWID: Self = Self(16);
122    /// Device Logical Unit.
123    pub const MESSAGING_DEVICE_LOGICAL_UNIT: Self = Self(17);
124    /// SATA Device Path.
125    pub const MESSAGING_SATA: Self = Self(18);
126    /// iSCSI Device Path node (base information).
127    pub const MESSAGING_ISCSI: Self = Self(19);
128    /// VLAN Device Path node.
129    pub const MESSAGING_VLAN: Self = Self(20);
130    /// Fibre Channel Ex Device Path.
131    pub const MESSAGING_FIBRE_CHANNEL_EX: Self = Self(21);
132    /// Serial Attached SCSI (SAS) Ex Device Path.
133    pub const MESSAGING_SCSI_SAS_EX: Self = Self(22);
134    /// NVM Express Namespace Device Path.
135    pub const MESSAGING_NVME_NAMESPACE: Self = Self(23);
136    /// Uniform Resource Identifiers (URI) Device Path.
137    pub const MESSAGING_URI: Self = Self(24);
138    /// UFS Device Path.
139    pub const MESSAGING_UFS: Self = Self(25);
140    /// SD (Secure Digital) Device Path.
141    pub const MESSAGING_SD: Self = Self(26);
142    /// Bluetooth Device Path.
143    pub const MESSAGING_BLUETOOTH: Self = Self(27);
144    /// Wi-Fi Device Path.
145    pub const MESSAGING_WIFI: Self = Self(28);
146    /// eMMC (Embedded Multi-Media Card) Device Path.
147    pub const MESSAGING_EMMC: Self = Self(29);
148    /// BluetoothLE Device Path.
149    pub const MESSAGING_BLUETOOTH_LE: Self = Self(30);
150    /// DNS Device Path.
151    pub const MESSAGING_DNS: Self = Self(31);
152    /// NVDIMM Namespace Device Path.
153    pub const MESSAGING_NVDIMM_NAMESPACE: Self = Self(32);
154    /// REST Service Device Path.
155    pub const MESSAGING_REST_SERVICE: Self = Self(33);
156    /// NVME over Fabric (NVMe-oF) Namespace Device Path.
157    pub const MESSAGING_NVME_OF_NAMESPACE: Self = Self(34);
158
159    /// Hard Drive Media Device Path.
160    pub const MEDIA_HARD_DRIVE: Self = Self(1);
161    /// CD-ROM Media Device Path.
162    pub const MEDIA_CD_ROM: Self = Self(2);
163    /// Vendor-Defined Media Device Path.
164    pub const MEDIA_VENDOR: Self = Self(3);
165    /// File Path Media Device Path.
166    pub const MEDIA_FILE_PATH: Self = Self(4);
167    /// Media Protocol Device Path.
168    pub const MEDIA_PROTOCOL: Self = Self(5);
169    /// PIWG Firmware File.
170    pub const MEDIA_PIWG_FIRMWARE_FILE: Self = Self(6);
171    /// PIWG Firmware Volume.
172    pub const MEDIA_PIWG_FIRMWARE_VOLUME: Self = Self(7);
173    /// Relative Offset Range.
174    pub const MEDIA_RELATIVE_OFFSET_RANGE: Self = Self(8);
175    /// RAM Disk Device Path.
176    pub const MEDIA_RAM_DISK: Self = Self(9);
177
178    /// BIOS Boot Specification Device Path.
179    pub const BIOS_BOOT_SPECIFICATION: Self = Self(1);
180
181    /// End this instance of a Device Path and start a new one.
182    pub const END_INSTANCE: Self = Self(0x01);
183    /// End entire Device Path.
184    pub const END_ENTIRE: Self = Self(0xff);
185}
186
187#[derive(Debug)]
188#[repr(C)]
189pub struct DevicePathToTextProtocol {
190    pub convert_device_node_to_text: unsafe extern "efiapi" fn(
191        device_node: *const DevicePathProtocol,
192        display_only: bool,
193        allow_shortcuts: bool,
194    ) -> *const Char16,
195    pub convert_device_path_to_text: unsafe extern "efiapi" fn(
196        device_path: *const DevicePathProtocol,
197        display_only: bool,
198        allow_shortcuts: bool,
199    ) -> *const Char16,
200}
201
202impl DevicePathToTextProtocol {
203    pub const GUID: Guid = guid!("8b843e20-8132-4852-90cc-551a4e4a7f1c");
204}
205
206#[derive(Debug)]
207#[repr(C)]
208pub struct DevicePathFromTextProtocol {
209    pub convert_text_to_device_node:
210        unsafe extern "efiapi" fn(text_device_node: *const Char16) -> *const DevicePathProtocol,
211    pub convert_text_to_device_path:
212        unsafe extern "efiapi" fn(text_device_path: *const Char16) -> *const DevicePathProtocol,
213}
214
215impl DevicePathFromTextProtocol {
216    pub const GUID: Guid = guid!("05c99a21-c70f-4ad2-8a5f-35df3343f51e");
217}
uefi_raw/protocol/device_path.rs

uefi_raw/protocol/
device_path.rs
