esp-hal 1.2.0

Bare-metal HAL for Espressif devices
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

//! USB OTG device driver for embassy-usb (Synopsys DWC).

use embassy_usb_driver::{EndpointAddress, EndpointAllocError, EndpointType, Event, Unsupported};
pub use embassy_usb_synopsys_otg::Config;
use embassy_usb_synopsys_otg::{
    Bus as OtgBus,
    ControlPipe,
    Driver as OtgDriver,
    Endpoint,
    In,
    OtgInstance,
    Out,
    otg_v1::Otg,
};

use crate::usb::otg::Usb;

/// Asynchronous USB driver.
pub struct Driver<'d> {
    inner: OtgDriver<'d>,
    _usb: Usb<'d>,
}

impl<'d> Driver<'d> {
    /// Initializes USB OTG for asynchronous device operation.
    ///
    /// # Arguments
    ///
    /// * `ep_out_buffer` - Buffer for received OUT packets. Must be large enough for all OUT
    ///   endpoint max packet sizes.
    pub fn new(peri: Usb<'d>, ep_out_buffer: &'d mut [u8], config: Config) -> Self {
        let info = peri.info();
        let instance = OtgInstance {
            regs: unsafe { Otg::from_ptr(info.register_ptr.cast_mut()) },
            state: peri.embassy_device_state(),
            fifo_depth_words: info.fifo_depth_words as u16,
            extra_rx_fifo_words: info.rx_fifo_extra_words,
            phy_type: info.phy_type,
            calculate_trdt_fn: |_| 5,
        };
        Self {
            inner: OtgDriver::new(ep_out_buffer, instance, config),
            _usb: peri,
        }
    }
}

impl<'d> embassy_usb_driver::Driver<'d> for Driver<'d> {
    type EndpointOut = Endpoint<'d, Out>;
    type EndpointIn = Endpoint<'d, In>;
    type ControlPipe = ControlPipe<'d>;
    type Bus = Bus<'d>;

    fn alloc_endpoint_in(
        &mut self,
        ep_type: EndpointType,
        ep_addr: Option<EndpointAddress>,
        max_packet_size: u16,
        interval_ms: u8,
    ) -> Result<Self::EndpointIn, EndpointAllocError> {
        self.inner
            .alloc_endpoint_in(ep_type, ep_addr, max_packet_size, interval_ms)
    }

    fn alloc_endpoint_out(
        &mut self,
        ep_type: EndpointType,
        ep_addr: Option<EndpointAddress>,
        max_packet_size: u16,
        interval_ms: u8,
    ) -> Result<Self::EndpointOut, EndpointAllocError> {
        self.inner
            .alloc_endpoint_out(ep_type, ep_addr, max_packet_size, interval_ms)
    }

    fn start(self, control_max_packet_size: u16) -> (Self::Bus, Self::ControlPipe) {
        let (bus, cp) = self.inner.start(control_max_packet_size);

        (
            Bus {
                inner: bus,
                inited: false,
                _usb: self._usb,
            },
            cp,
        )
    }
}

/// Asynchronous USB bus used internally by embassy-usb.
pub struct Bus<'d> {
    inner: OtgBus<'d>,
    inited: bool,
    _usb: Usb<'d>,
}

impl<'d> Bus<'d> {
    fn init(&mut self) {
        let i = self._usb.info();
        (i.enable_device_mode)();

        let r = unsafe { Otg::from_ptr(i.register_ptr.cast_mut()) };

        self.inner.core_soft_reset();

        self.inner.configure_as_device();
        self.inner.config_v5();

        r.pcgcctl().write(|w| w.0 = 0);

        self._usb.bind_device_interrupt();
    }

    fn disable(&mut self) {
        self._usb.disable_device_interrupt();
        (self._usb.info().platform_bus_disable_on_drop)();
        self.inited = false;
    }
}

impl<'d> embassy_usb_driver::Bus for Bus<'d> {
    async fn poll(&mut self) -> Event {
        if !self.inited {
            self.init();
            self.inited = true;
        }

        self.inner.poll().await
    }

    fn endpoint_set_stalled(&mut self, ep_addr: EndpointAddress, stalled: bool) {
        self.inner.endpoint_set_stalled(ep_addr, stalled)
    }

    fn endpoint_is_stalled(&mut self, ep_addr: EndpointAddress) -> bool {
        self.inner.endpoint_is_stalled(ep_addr)
    }

    fn endpoint_set_enabled(&mut self, ep_addr: EndpointAddress, enabled: bool) {
        self.inner.endpoint_set_enabled(ep_addr, enabled)
    }

    async fn enable(&mut self) {
        self.inner.enable().await
    }

    async fn disable(&mut self) {
        self.inner.disable().await
    }

    async fn remote_wakeup(&mut self) -> Result<(), Unsupported> {
        self.inner.remote_wakeup().await
    }
}

impl<'d> Drop for Bus<'d> {
    fn drop(&mut self) {
        Bus::disable(self);
    }
}