driver-interface 0.5.5

Sparreal OS kernel
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

use fdt_parser::Node;

use crate::{
    DriverGeneric, IrqHandleResult,
    io::{Read, Write},
};

pub type Hardware = alloc::boxed::Box<dyn Interface>;
/// The function to probe the hardware.
/// The first parameter is the ptr of fdt.
pub type OnProbeFdt = fn(node: Node<'_>) -> Hardware;

pub trait Interface: DriverGeneric + Write + Read + Sync {
    fn handle_irq(&mut self, irq: usize) -> IrqHandleResult;
    fn irq_enable(&mut self);
    fn irq_disable(&mut self);
    fn set_baudrate(&mut self, baudrate: u64);
    fn set_databits(&mut self, databits: DataBits);
    fn set_stopbits(&mut self, stopbits: StopBits);
    fn set_parity(&mut self, parity: Option<Parity>);
}

/// Word length.
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub enum DataBits {
    Bits5,
    Bits6,
    Bits7,
    Bits8,
}

/// Parity bit.
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub enum Parity {
    Even,
    Odd,
}

/// Stop bits.
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub enum StopBits {
    #[doc = "1 stop bit"]
    STOP1,
    #[doc = "2 stop bits"]
    STOP2,
}