Merge pull request #1543 from nicholasbishop/bishop-raw-pxe-2

Add PXE types to uefi-raw

Author: phip1611

uefi-raw/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Added
 - Added `Boolean` type
+- Added `protocol::network::pxe` module.
 
 
 # uefi-raw - 0.10.0 (2025-02-07)

uefi-raw/src/protocol/network/mod.rs

@@ -4,4 +4,5 @@ pub mod dhcp4;
 pub mod http;
 pub mod ip4;
 pub mod ip4_config2;
+pub mod pxe;
 pub mod tls;

uefi-raw/src/protocol/network/pxe.rs

@@ -0,0 +1,349 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+use crate::{guid, Boolean, Char8, Guid, IpAddress, MacAddress, Status};
+use bitflags::bitflags;
+use core::ffi::c_void;
+use core::fmt::{self, Debug, Formatter};
+
+#[derive(Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeProtocol {
+    pub revision: u64,
+    pub start: unsafe extern "efiapi" fn(this: *mut Self, use_ipv6: Boolean) -> Status,
+    pub stop: unsafe extern "efiapi" fn(this: *mut Self) -> Status,
+    pub dhcp: unsafe extern "efiapi" fn(this: *mut Self, sort_offers: Boolean) -> Status,
+    pub discover: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        ty: PxeBaseCodeBootType,
+        layer: *mut u16,
+        use_bis: Boolean,
+        info: *const PxeBaseCodeDiscoverInfo,
+    ) -> Status,
+    pub mtftp: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        operation: PxeBaseCodeTftpOpcode,
+        buffer: *mut c_void,
+        overwrite: Boolean,
+        buffer_size: *mut u64,
+        block_size: *const usize,
+        server_ip: *const IpAddress,
+        filename: *const Char8,
+        info: *const PxeBaseCodeMtftpInfo,
+        dont_use_buffer: Boolean,
+    ) -> Status,
+    pub udp_write: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        op_flags: PxeBaseCodeUdpOpFlags,
+        dest_ip: *const IpAddress,
+        dest_port: *const PxeBaseCodeUdpPort,
+        gateway_ip: *const IpAddress,
+        src_ip: *const IpAddress,
+        src_port: *mut PxeBaseCodeUdpPort,
+        header_size: *const usize,
+        header_ptr: *const c_void,
+        buffer_size: *const usize,
+        buffer_ptr: *const c_void,
+    ) -> Status,
+    pub udp_read: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        op_flags: PxeBaseCodeUdpOpFlags,
+        dest_ip: *mut IpAddress,
+        dest_port: *mut PxeBaseCodeUdpPort,
+        src_ip: *mut IpAddress,
+        src_port: *mut PxeBaseCodeUdpPort,
+        header_size: *const usize,
+        header_ptr: *mut c_void,
+        buffer_size: *mut usize,
+        buffer_ptr: *mut c_void,
+    ) -> Status,
+    pub set_ip_filter: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        new_filter: *const PxeBaseCodeIpFilter,
+    ) -> Status,
+    pub arp: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        ip_addr: *const IpAddress,
+        mac_addr: *mut MacAddress,
+    ) -> Status,
+    pub set_parameters: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        new_auto_arp: *const Boolean,
+        new_send_guid: *const Boolean,
+        new_ttl: *const u8,
+        new_tos: *const u8,
+        new_make_callback: *const Boolean,
+    ) -> Status,
+    pub set_station_ip: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        new_station_ip: *const IpAddress,
+        new_subnet_mask: *const IpAddress,
+    ) -> Status,
+    pub set_packets: unsafe extern "efiapi" fn(
+        this: *mut Self,
+        new_dhcp_discover_valid: *const Boolean,
+        new_dhcp_ack_received: *const Boolean,
+        new_proxy_offer_received: *const Boolean,
+        new_pxe_discover_valid: *const Boolean,
+        new_pxe_reply_received: *const Boolean,
+        new_pxe_bis_reply_received: *const Boolean,
+        new_dhcp_discover: *const PxeBaseCodePacket,
+        new_dhcp_ack: *const PxeBaseCodePacket,
+        new_proxy_offer: *const PxeBaseCodePacket,
+        new_pxe_discover: *const PxeBaseCodePacket,
+        new_pxe_reply: *const PxeBaseCodePacket,
+        new_pxe_bis_reply: *const PxeBaseCodePacket,
+    ) -> Status,
+    pub mode: *const PxeBaseCodeMode,
+}
+
+impl PxeBaseCodeProtocol {
+    pub const GUID: Guid = guid!("03c4e603-ac28-11d3-9a2d-0090273fc14d");
+}
+
+newtype_enum! {
+    pub enum PxeBaseCodeBootType: u16 => {
+        BOOTSTRAP = 0,
+        MS_WINNT_RIS = 1,
+        INTEL_LCM = 2,
+        DOS_UNDI = 3,
+        NEC_ESMPRO = 4,
+        IBM_WSOD = 5,
+        IBM_LCCM = 6,
+        CA_UNICENTER_TNG = 7,
+        HP_OPENVIEW = 8,
+        ALTIRIS_9 = 9,
+        ALTIRIS_10 = 10,
+        ALTIRIS_11 = 11,
+        NOT_USED_12 = 12,
+        REDHAT_INSTALL = 13,
+        REDHAT_BOOT = 14,
+        REMBO = 15,
+        BEOBOOT = 16,
+        //    17..=32767: reserved.
+        // 32768..=65279: reserved for vendor use.
+        // 65280..=65534: reserved.
+        PXETEST = 65535,
+    }
+}
+
+newtype_enum! {
+    pub enum PxeBaseCodeTftpOpcode: i32 => {
+        TFTP_FIRST = 0,
+        TFTP_GET_FILE_SIZE = 1,
+        TFTP_READ_FILE = 2,
+        TFTP_WRITE_FILE = 3,
+        TFTP_READ_DIRECTORY = 4,
+        MTFTP_GET_FILE_SIZE = 5,
+        MTFTP_READ_FILE = 6,
+        MTFTP_READ_DIRECTORY = 7,
+        MTFTP_LAST = 8,
+    }
+}
+
+#[derive(Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeDiscoverInfo {
+    pub use_m_cast: Boolean,
+    pub use_b_cast: Boolean,
+    pub use_u_cast: Boolean,
+    pub must_use_list: Boolean,
+    pub server_m_cast_ip: IpAddress,
+    pub ip_cnt: u16,
+
+    /// Note that this field is actually a variable-length array.
+    pub srv_list: [PxeBaseCodeSrvlist; 0],
+}
+
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeSrvlist {
+    pub server_type: u16,
+    pub accept_any_response: Boolean,
+    pub reserved: u8,
+    pub ip_addr: IpAddress,
+}
+
+pub type PxeBaseCodeUdpPort = u16;
+
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeMtftpInfo {
+    pub m_cast_ip: IpAddress,
+    pub c_port: PxeBaseCodeUdpPort,
+    pub s_port: PxeBaseCodeUdpPort,
+    pub listen_timeout: u16,
+    pub transmit_timeout: u16,
+}
+
+bitflags! {
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
+    #[repr(transparent)]
+    pub struct PxeBaseCodeUdpOpFlags: u16 {
+        const ANY_SRC_IP = 0x0001;
+        const ANY_SRC_PORT = 0x0002;
+        const ANY_DEST_IP = 0x0004;
+        const ANY_DEST_PORT = 0x0008;
+        const USE_FILTER = 0x0010;
+        const MAY_FRAGMENT = 0x0020;
+    }
+}
+
+#[derive(Clone, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeMode {
+    pub started: Boolean,
+    pub ipv6_available: Boolean,
+    pub ipv6_supported: Boolean,
+    pub using_ipv6: Boolean,
+    pub bis_supported: Boolean,
+    pub bis_detected: Boolean,
+    pub auto_arp: Boolean,
+    pub send_guid: Boolean,
+    pub dhcp_discover_valid: Boolean,
+    pub dhcp_ack_received: Boolean,
+    pub proxy_offer_received: Boolean,
+    pub pxe_discover_valid: Boolean,
+    pub pxe_reply_received: Boolean,
+    pub pxe_bis_reply_received: Boolean,
+    pub icmp_error_received: Boolean,
+    pub tftp_error_received: Boolean,
+    pub make_callbacks: Boolean,
+    pub ttl: u8,
+    pub tos: u8,
+    pub station_ip: IpAddress,
+    pub subnet_mask: IpAddress,
+    pub dhcp_discover: PxeBaseCodePacket,
+    pub dhcp_ack: PxeBaseCodePacket,
+    pub proxy_offer: PxeBaseCodePacket,
+    pub pxe_discover: PxeBaseCodePacket,
+    pub pxe_reply: PxeBaseCodePacket,
+    pub pxe_bis_reply: PxeBaseCodePacket,
+    pub ip_filter: PxeBaseCodeIpFilter,
+    pub arp_cache_entries: u32,
+    pub arp_cache: [PxeBaseCodeArpEntry; 8],
+    pub route_table_entries: u32,
+    pub route_table: [PxeBaseCodeRouteEntry; 8],
+    pub icmp_error: PxeBaseCodeIcmpError,
+    pub tftp_error: PxeBaseCodeTftpError,
+}
+
+#[derive(Clone, Copy)]
+#[repr(C)]
+pub union PxeBaseCodePacket {
+    pub raw: [u8; 1472],
+    pub dhcpv4: PxeBaseCodeDhcpV4Packet,
+    pub dhcpv6: PxeBaseCodeDhcpV6Packet,
+}
+
+impl Debug for PxeBaseCodePacket {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        f.debug_struct("PxeBaseCodePacket").finish()
+    }
+}
+
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeDhcpV4Packet {
+    pub bootp_opcode: u8,
+    pub bootp_hw_type: u8,
+    pub bootp_hw_addr_len: u8,
+    pub bootp_gate_hops: u8,
+    pub bootp_ident: u32,
+    pub bootp_seconds: u16,
+    pub bootp_flags: u16,
+    pub bootp_ci_addr: [u8; 4],
+    pub bootp_yi_addr: [u8; 4],
+    pub bootp_si_addr: [u8; 4],
+    pub bootp_gi_addr: [u8; 4],
+    pub bootp_hw_addr: [u8; 16],
+    pub bootp_srv_name: [u8; 64],
+    pub bootp_boot_file: [u8; 128],
+    pub dhcp_magik: u32,
+    pub dhcp_options: [u8; 56],
+}
+
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeDhcpV6Packet {
+    pub message_type: u8,
+    pub transaction_id: [u8; 3],
+    pub dhcp_options: [u8; 1024],
+}
+
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeIpFilter {
+    pub filters: PxeBaseCodeIpFilterFlags,
+    pub ip_cnt: u8,
+    pub reserved: u16,
+    pub ip_list: [IpAddress; 8],
+}
+
+bitflags! {
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
+    #[repr(transparent)]
+    pub struct PxeBaseCodeIpFilterFlags: u8 {
+        const STATION_IP = 0x01;
+        const BROADCAST = 0x02;
+        const PROMISCUOUS = 0x04;
+        const PROMISCUOUS_MULTICAST = 0x08;
+    }
+}
+
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeArpEntry {
+    pub ip_addr: IpAddress,
+    pub mac_addr: MacAddress,
+}
+
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeRouteEntry {
+    pub ip_addr: IpAddress,
+    pub subnet_mask: IpAddress,
+    pub gw_addr: IpAddress,
+}
+
+#[derive(Clone, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeIcmpError {
+    pub ty: u8,
+    pub code: u8,
+    pub checksum: u16,
+    pub u: PxeBaseCodeIcmpErrorUnion,
+    pub data: [u8; 494],
+}
+
+/// In the C API, this is an anonymous union inside the definition of
+/// `EFI_PXE_BASE_CODE_ICMP_ERROR`.
+#[derive(Clone, Copy)]
+#[repr(C)]
+pub union PxeBaseCodeIcmpErrorUnion {
+    pub reserved: u32,
+    pub mtu: u32,
+    pub pointer: u32,
+    pub echo: PxeBaseCodeIcmpErrorEcho,
+}
+
+impl Debug for PxeBaseCodeIcmpErrorUnion {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        f.debug_struct("PxeBaseCodeIcmpErrorUnion").finish()
+    }
+}
+
+/// In the C API, this is an anonymous struct inside the definition of
+/// `EFI_PXE_BASE_CODE_ICMP_ERROR`.
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeIcmpErrorEcho {
+    pub identifier: u16,
+    pub sequence: u16,
+}
+
+#[derive(Clone, Debug)]
+#[repr(C)]
+pub struct PxeBaseCodeTftpError {
+    pub error_code: u8,
+    pub error_string: [Char8; 127],
+}