stm32-eth 0.8.2

Embedded Rust Ethernet driver for the STM32 MCU series
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
91
92
93
94
95
96
97
98
99
100
101

use super::{rx::RxDescriptor, tx::TxDescriptor, MTU};

pub trait RingDescriptor {
    fn setup(&mut self, buffer: *const u8, len: usize, next: Option<&Self>);
}

#[repr(C, align(8))]
pub struct Buffer {
    buffer: [u8; MTU],
}

impl Buffer {
    pub const fn new() -> Self {
        Self { buffer: [0; MTU] }
    }
}

impl core::ops::Deref for Buffer {
    type Target = [u8; MTU];

    fn deref(&self) -> &Self::Target {
        &self.buffer
    }
}

impl core::ops::DerefMut for Buffer {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.buffer
    }
}

/// An entry in a DMA Descriptor ring
#[repr(C, align(8))]
pub struct RingEntry<T: RingDescriptor> {
    desc: T,
    buffer: Buffer,
}

impl<T: RingDescriptor + Default> Default for RingEntry<T> {
    fn default() -> Self {
        RingEntry {
            desc: T::default(),
            buffer: Buffer::new(),
        }
    }
}

impl RingEntry<TxDescriptor> {
    /// The initial value of a TxRingDescriptor
    pub const INIT: Self = Self::new();

    /// Creates a RingEntry with a TxDescriptor.
    pub const fn new() -> Self {
        RingEntry {
            desc: TxDescriptor::new(),
            buffer: Buffer::new(),
        }
    }
}

impl RingEntry<RxDescriptor> {
    /// The initial value of an RxRingDescriptor
    pub const INIT: Self = Self::new();

    /// Creates a RingEntry with a RxDescriptor.
    pub const fn new() -> Self {
        RingEntry {
            desc: RxDescriptor::new(),
            buffer: Buffer::new(),
        }
    }
}

impl<T: RingDescriptor> RingEntry<T> {
    pub(crate) fn setup(&mut self, next: Option<&Self>) {
        let buffer = self.buffer.as_ptr();
        let len = self.buffer.len();
        self.desc_mut()
            .setup(buffer, len, next.map(|next| next.desc()));
    }

    #[inline]
    pub(crate) fn desc(&self) -> &T {
        &self.desc
    }

    #[inline]
    pub(crate) fn desc_mut(&mut self) -> &mut T {
        &mut self.desc
    }

    #[inline]
    pub(crate) fn as_slice(&self) -> &[u8] {
        &(*self.buffer)[..]
    }

    #[inline]
    pub(crate) fn as_mut_slice(&mut self) -> &mut [u8] {
        &mut (*self.buffer)[..]
    }
}