embassy-stm32 0.6.0

Embassy Hardware Abstraction Layer (HAL) for ST STM32 series microcontrollers
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

use super::word::Word;
use super::{Channel, Request, Transfer, TransferOptions};
use crate::Peri;
use crate::dma::{ChannelInstance, InterruptHandler};
use crate::interrupt::typelevel::Binding;

/// Convenience wrapper, contains a channel and a request number.
///
/// Commonly used in peripheral drivers that own DMA channels.
pub(crate) struct ChannelAndRequest<'d> {
    pub channel: Channel<'d>,
    pub request: Request,
}

impl<'d> ChannelAndRequest<'d> {
    pub fn new<T: ChannelInstance>(
        ch: Peri<'d, T>,
        irqs: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd,
        request: Request,
    ) -> Self {
        Self {
            channel: Channel::new(ch, irqs),
            request,
        }
    }

    pub unsafe fn read<'a, W: Word>(
        &'a mut self,
        peri_addr: *mut W,
        buf: &'a mut [W],
        options: TransferOptions,
    ) -> Transfer<'a> {
        self.channel.read(self.request, peri_addr, buf, options)
    }

    pub unsafe fn read_raw<'a, MW: Word, PW: Word>(
        &'a mut self,
        peri_addr: *mut PW,
        buf: *mut [MW],
        options: TransferOptions,
    ) -> Transfer<'a> {
        self.channel.read_raw(self.request, peri_addr, buf, options)
    }

    pub unsafe fn write<'a, W: Word>(
        &'a mut self,
        buf: &'a [W],
        peri_addr: *mut W,
        options: TransferOptions,
    ) -> Transfer<'a> {
        self.channel.write(self.request, buf, peri_addr, options)
    }

    pub unsafe fn write_raw<'a, MW: Word, PW: Word>(
        &'a mut self,
        buf: *const [MW],
        peri_addr: *mut PW,
        options: TransferOptions,
    ) -> Transfer<'a> {
        self.channel.write_raw(self.request, buf, peri_addr, options)
    }

    #[allow(dead_code)]
    pub unsafe fn write_repeated<'a, W: Word>(
        &'a mut self,
        repeated: &'a W,
        count: usize,
        peri_addr: *mut W,
        options: TransferOptions,
    ) -> Transfer<'a> {
        self.channel
            .write_repeated(self.request, repeated, count, peri_addr, options)
    }

    /// Reborrow the channel and request, allowing it to be used in multiple places.
    #[allow(dead_code)]
    pub fn reborrow(&mut self) -> ChannelAndRequest<'_> {
        ChannelAndRequest {
            channel: self.channel.reborrow(),
            request: self.request,
        }
    }

    #[allow(dead_code)]
    pub(crate) unsafe fn clone_unchecked(&self) -> ChannelAndRequest<'d> {
        ChannelAndRequest {
            channel: self.channel.clone_unchecked(),
            request: self.request,
        }
    }
}