realtek-rtl8125 0.2.3

Minimal Realtek RTL8125 PCIe Ethernet driver
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

pub const DESC_OWN: u32 = 1 << 31;
pub const RING_END: u32 = 1 << 30;
pub const FIRST_FRAG: u32 = 1 << 29;
pub const LAST_FRAG: u32 = 1 << 28;

pub const RX_RES: u32 = 1 << 21;
pub const RX_RUNT: u32 = 1 << 20;
pub const RX_CRC: u32 = 1 << 19;

const RX_PACKET_LEN_MASK: u32 = 0x3fff;
const ETH_FCS_LEN: usize = 4;

#[repr(C)]
#[derive(Clone, Copy, Default)]
pub struct TxDesc {
    pub opts1: u32,
    pub opts2: u32,
    pub addr: u64,
}

impl TxDesc {
    pub fn new_cpu_owned(addr: u64, len: usize, ring_end: bool) -> Self {
        let mut opts1 = FIRST_FRAG | LAST_FRAG | len as u32;
        if ring_end {
            opts1 |= RING_END;
        }
        Self {
            opts1,
            opts2: 0,
            addr,
        }
    }

    pub fn release_to_hw(mut self) -> Self {
        self.opts1 |= DESC_OWN;
        self
    }

    pub fn is_owned_by_hw(&self) -> bool {
        self.opts1 & DESC_OWN != 0
    }

    pub fn len(&self) -> usize {
        (self.opts1 & RX_PACKET_LEN_MASK) as usize
    }
}

#[repr(C)]
#[derive(Clone, Copy, Default)]
pub struct RxDesc {
    pub opts1: u32,
    pub opts2: u32,
    pub addr: u64,
}

impl RxDesc {
    pub fn new_cpu_owned(addr: u64, len: usize, ring_end: bool) -> Self {
        let mut opts1 = len as u32;
        if ring_end {
            opts1 |= RING_END;
        }
        Self {
            opts1,
            opts2: 0,
            addr,
        }
    }

    pub fn release_to_hw(mut self) -> Self {
        self.opts1 |= DESC_OWN;
        self
    }

    pub fn is_owned_by_hw(&self) -> bool {
        self.opts1 & DESC_OWN != 0
    }

    pub fn has_error(&self) -> bool {
        self.opts1 & (RX_RES | RX_RUNT | RX_CRC) != 0
    }

    pub fn is_whole_packet(&self) -> bool {
        self.opts1 & (FIRST_FRAG | LAST_FRAG) == FIRST_FRAG | LAST_FRAG
    }

    pub fn packet_len(&self) -> usize {
        let len = (self.opts1 & RX_PACKET_LEN_MASK) as usize;
        len.saturating_sub(ETH_FCS_LEN)
    }
}