uefi_raw/protocol/console/
serial.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2
3use crate::{guid, Guid, Status};
4use bitflags::bitflags;
5
6bitflags! {
7    /// The control bits of a device. These are defined in the [RS-232] standard.
8    ///
9    /// [RS-232]: https://en.wikipedia.org/wiki/RS-232
10    #[repr(transparent)]
11    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
12    pub struct ControlBits: u32 {
13        /// Clear to send
14        const CLEAR_TO_SEND = 0x10;
15        /// Data set ready
16        const DATA_SET_READY = 0x20;
17        /// Indicates that a phone line is ringing
18        const RING_INDICATE = 0x40;
19        /// Indicates the connection is still connected
20        const CARRIER_DETECT = 0x80;
21        /// The input buffer is empty
22        const INPUT_BUFFER_EMPTY = 0x100;
23        /// The output buffer is empty
24        const OUTPUT_BUFFER_EMPTY = 0x200;
25
26        /// Terminal is ready for communications
27        const DATA_TERMINAL_READY = 0x1;
28        /// Request the device to send data
29        const REQUEST_TO_SEND = 0x2;
30        /// Enable hardware loop-back
31        const HARDWARE_LOOPBACK_ENABLE = 0x1000;
32        /// Enable software loop-back
33        const SOFTWARE_LOOPBACK_ENABLE = 0x2000;
34        /// Allow the hardware to handle flow control
35        const HARDWARE_FLOW_CONTROL_ENABLE = 0x4000;
36
37        /// Bitmask of the control bits that can be set.
38        ///
39        /// Up to date as of UEFI 2.7 / Serial protocol v1
40        const SETTABLE =
41            ControlBits::DATA_TERMINAL_READY.bits()
42            | ControlBits::REQUEST_TO_SEND.bits()
43            | ControlBits::HARDWARE_LOOPBACK_ENABLE.bits()
44            | ControlBits::SOFTWARE_LOOPBACK_ENABLE.bits()
45            | ControlBits::HARDWARE_FLOW_CONTROL_ENABLE.bits();
46    }
47}
48
49/// Structure representing the device's current parameters.
50///
51/// The default values for all UART-like devices is:
52/// - 115,200 baud
53/// - 1 byte receive FIFO
54/// - 1'000'000 microsecond timeout
55/// - no parity
56/// - 8 data bits
57/// - 1 stop bit
58///
59/// The software is responsible for flow control.
60#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
61#[repr(C)]
62pub struct SerialIoMode {
63    /// Bitmask of the control bits that this device supports.
64    pub control_mask: ControlBits,
65    /// If applicable, the number of microseconds to wait before assuming an
66    /// operation timed out.
67    pub timeout: u32,
68    /// Device's baud rate, or 0 if unknown.
69    pub baud_rate: u64,
70    /// Size in character's of the device's buffer.
71    pub receive_fifo_depth: u32,
72    /// Number of data bits in each character.
73    pub data_bits: u32,
74    /// If applicable, the parity that is computed or checked for each character.
75    pub parity: Parity,
76    /// If applicable, the number of stop bits per character.
77    pub stop_bits: StopBits,
78}
79
80#[derive(Debug)]
81#[repr(C)]
82pub struct SerialIoProtocol {
83    pub revision: u32,
84    pub reset: unsafe extern "efiapi" fn(*mut Self) -> Status,
85    pub set_attributes: unsafe extern "efiapi" fn(
86        *const Self,
87        baud_rate: u64,
88        receive_fifo_depth: u32,
89        timeout: u32,
90        parity: Parity,
91        data_bits: u8,
92        stop_bits_type: StopBits,
93    ) -> Status,
94    pub set_control_bits: unsafe extern "efiapi" fn(*mut Self, ControlBits) -> Status,
95    pub get_control_bits: unsafe extern "efiapi" fn(*const Self, *mut ControlBits) -> Status,
96    pub write: unsafe extern "efiapi" fn(*mut Self, *mut usize, *const u8) -> Status,
97    pub read: unsafe extern "efiapi" fn(*mut Self, *mut usize, *mut u8) -> Status,
98    pub mode: *const SerialIoMode,
99}
100
101impl SerialIoProtocol {
102    pub const GUID: Guid = guid!("bb25cf6f-f1d4-11d2-9a0c-0090273fc1fd");
103    pub const REVISION: u32 = 0x00010000;
104    pub const REVISION1P1: u32 = 0x00010001;
105}
106
107newtype_enum! {
108    /// The parity of the device.
109    pub enum Parity: u32 => {
110        /// Device default
111        DEFAULT = 0,
112        /// No parity
113        NONE = 1,
114        /// Even parity
115        EVEN = 2,
116        /// Odd parity
117        ODD = 3,
118        /// Mark parity
119        MARK = 4,
120        /// Space parity
121        SPACE = 5,
122    }
123}
124
125newtype_enum! {
126    /// Number of stop bits per character.
127    pub enum StopBits: u32 => {
128        /// Device default
129        DEFAULT = 0,
130        /// 1 stop bit
131        ONE = 1,
132        /// 1.5 stop bits
133        ONE_FIVE = 2,
134        /// 2 stop bits
135        TWO = 3,
136    }
137}
uefi_raw/protocol/console/serial.rs

uefi_raw/protocol/console/
serial.rs
