mirror of
https://github.com/embassy-rs/embassy.git
synced 2024-11-22 06:42:32 +00:00
Add DeviceStateHandler, DeviceCommand channel, and remote wakeup support
This commit is contained in:
parent
2217de24c0
commit
f5656e3544
@ -10,7 +10,7 @@ use embassy::util::Unborrow;
|
|||||||
use embassy::waitqueue::AtomicWaker;
|
use embassy::waitqueue::AtomicWaker;
|
||||||
use embassy_hal_common::unborrow;
|
use embassy_hal_common::unborrow;
|
||||||
use embassy_usb::control::Request;
|
use embassy_usb::control::Request;
|
||||||
use embassy_usb::driver::{self, EndpointError, Event};
|
use embassy_usb::driver::{self, EndpointError, Event, Unsupported};
|
||||||
use embassy_usb::types::{EndpointAddress, EndpointInfo, EndpointType, UsbDirection};
|
use embassy_usb::types::{EndpointAddress, EndpointInfo, EndpointType, UsbDirection};
|
||||||
use futures::future::poll_fn;
|
use futures::future::poll_fn;
|
||||||
use futures::Future;
|
use futures::Future;
|
||||||
@ -140,7 +140,6 @@ impl<'d, T: Instance> driver::Driver<'d> for Driver<'d, T> {
|
|||||||
type EndpointIn = Endpoint<'d, T, In>;
|
type EndpointIn = Endpoint<'d, T, In>;
|
||||||
type ControlPipe = ControlPipe<'d, T>;
|
type ControlPipe = ControlPipe<'d, T>;
|
||||||
type Bus = Bus<'d, T>;
|
type Bus = Bus<'d, T>;
|
||||||
type EnableFuture = impl Future<Output = Self::Bus> + 'd;
|
|
||||||
|
|
||||||
fn alloc_endpoint_in(
|
fn alloc_endpoint_in(
|
||||||
&mut self,
|
&mut self,
|
||||||
@ -192,7 +191,27 @@ impl<'d, T: Instance> driver::Driver<'d> for Driver<'d, T> {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
fn enable(self) -> Self::EnableFuture {
|
fn into_bus(self) -> Self::Bus {
|
||||||
|
Bus {
|
||||||
|
phantom: PhantomData,
|
||||||
|
alloc_in: self.alloc_in,
|
||||||
|
alloc_out: self.alloc_out,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct Bus<'d, T: Instance> {
|
||||||
|
phantom: PhantomData<&'d mut T>,
|
||||||
|
alloc_in: Allocator,
|
||||||
|
alloc_out: Allocator,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'d, T: Instance> driver::Bus for Bus<'d, T> {
|
||||||
|
type EnableFuture<'a> = impl Future<Output = ()> + 'a where Self: 'a;
|
||||||
|
type PollFuture<'a> = impl Future<Output = Event> + 'a where Self: 'a;
|
||||||
|
type RemoteWakeupFuture<'a> = impl Future<Output = Result<(), Unsupported>> + 'a where Self: 'a;
|
||||||
|
|
||||||
|
fn enable(&mut self) -> Self::EnableFuture<'_> {
|
||||||
async move {
|
async move {
|
||||||
let regs = T::regs();
|
let regs = T::regs();
|
||||||
|
|
||||||
@ -226,33 +245,23 @@ impl<'d, T: Instance> driver::Driver<'d> for Driver<'d, T> {
|
|||||||
// Enable the USB pullup, allowing enumeration.
|
// Enable the USB pullup, allowing enumeration.
|
||||||
regs.usbpullup.write(|w| w.connect().enabled());
|
regs.usbpullup.write(|w| w.connect().enabled());
|
||||||
trace!("enabled");
|
trace!("enabled");
|
||||||
|
|
||||||
Bus {
|
|
||||||
phantom: PhantomData,
|
|
||||||
alloc_in: self.alloc_in,
|
|
||||||
alloc_out: self.alloc_out,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
pub struct Bus<'d, T: Instance> {
|
fn disable(&mut self) {
|
||||||
phantom: PhantomData<&'d mut T>,
|
let regs = T::regs();
|
||||||
alloc_in: Allocator,
|
regs.enable.write(|x| x.enable().disabled());
|
||||||
alloc_out: Allocator,
|
}
|
||||||
}
|
|
||||||
|
|
||||||
impl<'d, T: Instance> driver::Bus for Bus<'d, T> {
|
|
||||||
type PollFuture<'a> = impl Future<Output = Event> + 'a where Self: 'a;
|
|
||||||
|
|
||||||
fn poll<'a>(&'a mut self) -> Self::PollFuture<'a> {
|
fn poll<'a>(&'a mut self) -> Self::PollFuture<'a> {
|
||||||
poll_fn(|cx| {
|
poll_fn(move |cx| {
|
||||||
BUS_WAKER.register(cx.waker());
|
BUS_WAKER.register(cx.waker());
|
||||||
let regs = T::regs();
|
let regs = T::regs();
|
||||||
|
|
||||||
if regs.events_usbreset.read().bits() != 0 {
|
if regs.events_usbreset.read().bits() != 0 {
|
||||||
regs.events_usbreset.reset();
|
regs.events_usbreset.reset();
|
||||||
regs.intenset.write(|w| w.usbreset().set());
|
regs.intenset.write(|w| w.usbreset().set());
|
||||||
|
self.set_configured(false);
|
||||||
return Poll::Ready(Event::Reset);
|
return Poll::Ready(Event::Reset);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -268,11 +277,12 @@ impl<'d, T: Instance> driver::Bus for Bus<'d, T> {
|
|||||||
}
|
}
|
||||||
if r.suspend().bit() {
|
if r.suspend().bit() {
|
||||||
regs.eventcause.write(|w| w.suspend().set_bit());
|
regs.eventcause.write(|w| w.suspend().set_bit());
|
||||||
trace!("USB event: suspend");
|
regs.lowpower.write(|w| w.lowpower().low_power());
|
||||||
|
return Poll::Ready(Event::Suspend);
|
||||||
}
|
}
|
||||||
if r.resume().bit() {
|
if r.resume().bit() {
|
||||||
regs.eventcause.write(|w| w.resume().set_bit());
|
regs.eventcause.write(|w| w.resume().set_bit());
|
||||||
trace!("USB event: resume");
|
return Poll::Ready(Event::Resume);
|
||||||
}
|
}
|
||||||
if r.ready().bit() {
|
if r.ready().bit() {
|
||||||
regs.eventcause.write(|w| w.ready().set_bit());
|
regs.eventcause.write(|w| w.ready().set_bit());
|
||||||
@ -283,11 +293,6 @@ impl<'d, T: Instance> driver::Bus for Bus<'d, T> {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn reset(&mut self) {
|
|
||||||
self.set_configured(false);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
fn set_configured(&mut self, configured: bool) {
|
fn set_configured(&mut self, configured: bool) {
|
||||||
let regs = T::regs();
|
let regs = T::regs();
|
||||||
@ -343,18 +348,43 @@ impl<'d, T: Instance> driver::Bus for Bus<'d, T> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
fn suspend(&mut self) {
|
fn remote_wakeup(&mut self) -> Self::RemoteWakeupFuture<'_> {
|
||||||
let regs = T::regs();
|
async move {
|
||||||
regs.lowpower.write(|w| w.lowpower().low_power());
|
let regs = T::regs();
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
if regs.lowpower.read().lowpower().is_low_power() {
|
||||||
fn resume(&mut self) {
|
errata::pre_wakeup();
|
||||||
let regs = T::regs();
|
|
||||||
|
|
||||||
errata::pre_wakeup();
|
regs.lowpower.write(|w| w.lowpower().force_normal());
|
||||||
|
|
||||||
regs.lowpower.write(|w| w.lowpower().force_normal());
|
poll_fn(|cx| {
|
||||||
|
BUS_WAKER.register(cx.waker());
|
||||||
|
let regs = T::regs();
|
||||||
|
let r = regs.eventcause.read();
|
||||||
|
|
||||||
|
if regs.events_usbreset.read().bits() != 0 {
|
||||||
|
Poll::Ready(())
|
||||||
|
} else if r.resume().bit() {
|
||||||
|
Poll::Ready(())
|
||||||
|
} else if r.usbwuallowed().bit() {
|
||||||
|
regs.eventcause.write(|w| w.usbwuallowed().set_bit());
|
||||||
|
|
||||||
|
regs.dpdmvalue.write(|w| w.state().resume());
|
||||||
|
regs.tasks_dpdmdrive
|
||||||
|
.write(|w| w.tasks_dpdmdrive().set_bit());
|
||||||
|
|
||||||
|
Poll::Ready(())
|
||||||
|
} else {
|
||||||
|
Poll::Pending
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.await;
|
||||||
|
|
||||||
|
errata::post_wakeup();
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -845,6 +875,7 @@ mod errata {
|
|||||||
|
|
||||||
pub fn pre_enable() {
|
pub fn pre_enable() {
|
||||||
// Works around Erratum 187 on chip revisions 1 and 2.
|
// Works around Erratum 187 on chip revisions 1 and 2.
|
||||||
|
#[cfg(any(feature = "nrf52840", feature = "nrf52833", feature = "nrf52820"))]
|
||||||
unsafe {
|
unsafe {
|
||||||
poke(0x4006EC00, 0x00009375);
|
poke(0x4006EC00, 0x00009375);
|
||||||
poke(0x4006ED14, 0x00000003);
|
poke(0x4006ED14, 0x00000003);
|
||||||
@ -858,6 +889,7 @@ mod errata {
|
|||||||
post_wakeup();
|
post_wakeup();
|
||||||
|
|
||||||
// Works around Erratum 187 on chip revisions 1 and 2.
|
// Works around Erratum 187 on chip revisions 1 and 2.
|
||||||
|
#[cfg(any(feature = "nrf52840", feature = "nrf52833", feature = "nrf52820"))]
|
||||||
unsafe {
|
unsafe {
|
||||||
poke(0x4006EC00, 0x00009375);
|
poke(0x4006EC00, 0x00009375);
|
||||||
poke(0x4006ED14, 0x00000000);
|
poke(0x4006ED14, 0x00000000);
|
||||||
@ -868,6 +900,7 @@ mod errata {
|
|||||||
pub fn pre_wakeup() {
|
pub fn pre_wakeup() {
|
||||||
// Works around Erratum 171 on chip revisions 1 and 2.
|
// Works around Erratum 171 on chip revisions 1 and 2.
|
||||||
|
|
||||||
|
#[cfg(feature = "nrf52840")]
|
||||||
unsafe {
|
unsafe {
|
||||||
if peek(0x4006EC00) == 0x00000000 {
|
if peek(0x4006EC00) == 0x00000000 {
|
||||||
poke(0x4006EC00, 0x00009375);
|
poke(0x4006EC00, 0x00009375);
|
||||||
@ -881,6 +914,7 @@ mod errata {
|
|||||||
pub fn post_wakeup() {
|
pub fn post_wakeup() {
|
||||||
// Works around Erratum 171 on chip revisions 1 and 2.
|
// Works around Erratum 171 on chip revisions 1 and 2.
|
||||||
|
|
||||||
|
#[cfg(feature = "nrf52840")]
|
||||||
unsafe {
|
unsafe {
|
||||||
if peek(0x4006EC00) == 0x00000000 {
|
if peek(0x4006EC00) == 0x00000000 {
|
||||||
poke(0x4006EC00, 0x00009375);
|
poke(0x4006EC00, 0x00009375);
|
||||||
|
@ -11,6 +11,7 @@ use core::mem::MaybeUninit;
|
|||||||
use core::ops::Range;
|
use core::ops::Range;
|
||||||
use core::sync::atomic::{AtomicUsize, Ordering};
|
use core::sync::atomic::{AtomicUsize, Ordering};
|
||||||
|
|
||||||
|
use embassy::blocking_mutex::raw::RawMutex;
|
||||||
use embassy::time::Duration;
|
use embassy::time::Duration;
|
||||||
use embassy_usb::driver::EndpointOut;
|
use embassy_usb::driver::EndpointOut;
|
||||||
use embassy_usb::{
|
use embassy_usb::{
|
||||||
@ -88,8 +89,8 @@ impl<'d, D: Driver<'d>, const IN_N: usize> HidClass<'d, D, (), IN_N> {
|
|||||||
/// high performance uses, and a value of 255 is good for best-effort usecases.
|
/// high performance uses, and a value of 255 is good for best-effort usecases.
|
||||||
///
|
///
|
||||||
/// This allocates an IN endpoint only.
|
/// This allocates an IN endpoint only.
|
||||||
pub fn new<const OUT_N: usize>(
|
pub fn new<M: RawMutex, const OUT_N: usize>(
|
||||||
builder: &mut UsbDeviceBuilder<'d, D>,
|
builder: &mut UsbDeviceBuilder<'d, D, M>,
|
||||||
state: &'d mut State<'d, IN_N, OUT_N>,
|
state: &'d mut State<'d, IN_N, OUT_N>,
|
||||||
report_descriptor: &'static [u8],
|
report_descriptor: &'static [u8],
|
||||||
request_handler: Option<&'d dyn RequestHandler>,
|
request_handler: Option<&'d dyn RequestHandler>,
|
||||||
@ -132,8 +133,8 @@ impl<'d, D: Driver<'d>, const IN_N: usize, const OUT_N: usize>
|
|||||||
/// high performance uses, and a value of 255 is good for best-effort usecases.
|
/// high performance uses, and a value of 255 is good for best-effort usecases.
|
||||||
///
|
///
|
||||||
/// This allocates two endpoints (IN and OUT).
|
/// This allocates two endpoints (IN and OUT).
|
||||||
pub fn with_output_ep(
|
pub fn with_output_ep<M: RawMutex>(
|
||||||
builder: &mut UsbDeviceBuilder<'d, D>,
|
builder: &mut UsbDeviceBuilder<'d, D, M>,
|
||||||
state: &'d mut State<'d, IN_N, OUT_N>,
|
state: &'d mut State<'d, IN_N, OUT_N>,
|
||||||
report_descriptor: &'static [u8],
|
report_descriptor: &'static [u8],
|
||||||
request_handler: Option<&'d dyn RequestHandler>,
|
request_handler: Option<&'d dyn RequestHandler>,
|
||||||
@ -392,9 +393,9 @@ impl<'a> Control<'a> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn build<'d, D: Driver<'d>>(
|
fn build<'d, D: Driver<'d>, M: RawMutex>(
|
||||||
&'d mut self,
|
&'d mut self,
|
||||||
builder: &mut UsbDeviceBuilder<'d, D>,
|
builder: &mut UsbDeviceBuilder<'d, D, M>,
|
||||||
ep_out: Option<&D::EndpointOut>,
|
ep_out: Option<&D::EndpointOut>,
|
||||||
ep_in: &D::EndpointIn,
|
ep_in: &D::EndpointIn,
|
||||||
) {
|
) {
|
||||||
|
@ -8,6 +8,7 @@ pub(crate) mod fmt;
|
|||||||
use core::cell::Cell;
|
use core::cell::Cell;
|
||||||
use core::mem::{self, MaybeUninit};
|
use core::mem::{self, MaybeUninit};
|
||||||
use core::sync::atomic::{AtomicBool, Ordering};
|
use core::sync::atomic::{AtomicBool, Ordering};
|
||||||
|
use embassy::blocking_mutex::raw::RawMutex;
|
||||||
use embassy::blocking_mutex::CriticalSectionMutex;
|
use embassy::blocking_mutex::CriticalSectionMutex;
|
||||||
use embassy_usb::control::{self, ControlHandler, InResponse, OutResponse, Request};
|
use embassy_usb::control::{self, ControlHandler, InResponse, OutResponse, Request};
|
||||||
use embassy_usb::driver::{Endpoint, EndpointError, EndpointIn, EndpointOut};
|
use embassy_usb::driver::{Endpoint, EndpointError, EndpointIn, EndpointOut};
|
||||||
@ -162,8 +163,8 @@ impl<'d> ControlHandler for Control<'d> {
|
|||||||
impl<'d, D: Driver<'d>> CdcAcmClass<'d, D> {
|
impl<'d, D: Driver<'d>> CdcAcmClass<'d, D> {
|
||||||
/// Creates a new CdcAcmClass with the provided UsbBus and max_packet_size in bytes. For
|
/// Creates a new CdcAcmClass with the provided UsbBus and max_packet_size in bytes. For
|
||||||
/// full-speed devices, max_packet_size has to be one of 8, 16, 32 or 64.
|
/// full-speed devices, max_packet_size has to be one of 8, 16, 32 or 64.
|
||||||
pub fn new(
|
pub fn new<M: RawMutex>(
|
||||||
builder: &mut UsbDeviceBuilder<'d, D>,
|
builder: &mut UsbDeviceBuilder<'d, D, M>,
|
||||||
state: &'d mut State<'d>,
|
state: &'d mut State<'d>,
|
||||||
max_packet_size: u16,
|
max_packet_size: u16,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
|
@ -1,9 +1,14 @@
|
|||||||
|
use embassy::blocking_mutex::raw::{NoopRawMutex, RawMutex};
|
||||||
|
use embassy::channel::Channel;
|
||||||
use heapless::Vec;
|
use heapless::Vec;
|
||||||
|
|
||||||
|
use crate::DeviceCommand;
|
||||||
|
|
||||||
use super::control::ControlHandler;
|
use super::control::ControlHandler;
|
||||||
use super::descriptor::{BosWriter, DescriptorWriter};
|
use super::descriptor::{BosWriter, DescriptorWriter};
|
||||||
use super::driver::{Driver, EndpointAllocError};
|
use super::driver::{Driver, EndpointAllocError};
|
||||||
use super::types::*;
|
use super::types::*;
|
||||||
|
use super::DeviceStateHandler;
|
||||||
use super::UsbDevice;
|
use super::UsbDevice;
|
||||||
use super::MAX_INTERFACE_COUNT;
|
use super::MAX_INTERFACE_COUNT;
|
||||||
|
|
||||||
@ -93,6 +98,11 @@ pub struct Config<'a> {
|
|||||||
/// Default: 100mA
|
/// Default: 100mA
|
||||||
/// Max: 500mA
|
/// Max: 500mA
|
||||||
pub max_power: u16,
|
pub max_power: u16,
|
||||||
|
|
||||||
|
/// Whether the USB bus should be enabled when built.
|
||||||
|
///
|
||||||
|
/// Default: true
|
||||||
|
pub start_enabled: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> Config<'a> {
|
impl<'a> Config<'a> {
|
||||||
@ -112,15 +122,18 @@ impl<'a> Config<'a> {
|
|||||||
supports_remote_wakeup: false,
|
supports_remote_wakeup: false,
|
||||||
composite_with_iads: false,
|
composite_with_iads: false,
|
||||||
max_power: 100,
|
max_power: 100,
|
||||||
|
start_enabled: true,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Used to build new [`UsbDevice`]s.
|
/// Used to build new [`UsbDevice`]s.
|
||||||
pub struct UsbDeviceBuilder<'d, D: Driver<'d>> {
|
pub struct UsbDeviceBuilder<'d, D: Driver<'d>, M: RawMutex> {
|
||||||
config: Config<'d>,
|
config: Config<'d>,
|
||||||
|
handler: Option<&'d dyn DeviceStateHandler>,
|
||||||
interfaces: Vec<(u8, &'d mut dyn ControlHandler), MAX_INTERFACE_COUNT>,
|
interfaces: Vec<(u8, &'d mut dyn ControlHandler), MAX_INTERFACE_COUNT>,
|
||||||
control_buf: &'d mut [u8],
|
control_buf: &'d mut [u8],
|
||||||
|
commands: Option<&'d Channel<M, DeviceCommand, 1>>,
|
||||||
|
|
||||||
driver: D,
|
driver: D,
|
||||||
next_interface_number: u8,
|
next_interface_number: u8,
|
||||||
@ -132,7 +145,7 @@ pub struct UsbDeviceBuilder<'d, D: Driver<'d>> {
|
|||||||
pub bos_descriptor: BosWriter<'d>,
|
pub bos_descriptor: BosWriter<'d>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'d, D: Driver<'d>> UsbDeviceBuilder<'d, D> {
|
impl<'d, D: Driver<'d>> UsbDeviceBuilder<'d, D, NoopRawMutex> {
|
||||||
/// Creates a builder for constructing a new [`UsbDevice`].
|
/// Creates a builder for constructing a new [`UsbDevice`].
|
||||||
///
|
///
|
||||||
/// `control_buf` is a buffer used for USB control request data. It should be sized
|
/// `control_buf` is a buffer used for USB control request data. It should be sized
|
||||||
@ -145,6 +158,58 @@ impl<'d, D: Driver<'d>> UsbDeviceBuilder<'d, D> {
|
|||||||
config_descriptor_buf: &'d mut [u8],
|
config_descriptor_buf: &'d mut [u8],
|
||||||
bos_descriptor_buf: &'d mut [u8],
|
bos_descriptor_buf: &'d mut [u8],
|
||||||
control_buf: &'d mut [u8],
|
control_buf: &'d mut [u8],
|
||||||
|
handler: Option<&'d dyn DeviceStateHandler>,
|
||||||
|
) -> Self {
|
||||||
|
Self::new_inner(
|
||||||
|
driver,
|
||||||
|
config,
|
||||||
|
device_descriptor_buf,
|
||||||
|
config_descriptor_buf,
|
||||||
|
bos_descriptor_buf,
|
||||||
|
control_buf,
|
||||||
|
handler,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'d, D: Driver<'d>, M: RawMutex> UsbDeviceBuilder<'d, D, M> {
|
||||||
|
/// Creates a builder for constructing a new [`UsbDevice`].
|
||||||
|
///
|
||||||
|
/// `control_buf` is a buffer used for USB control request data. It should be sized
|
||||||
|
/// large enough for the length of the largest control request (in or out)
|
||||||
|
/// anticipated by any class added to the device.
|
||||||
|
pub fn new_with_channel(
|
||||||
|
driver: D,
|
||||||
|
config: Config<'d>,
|
||||||
|
device_descriptor_buf: &'d mut [u8],
|
||||||
|
config_descriptor_buf: &'d mut [u8],
|
||||||
|
bos_descriptor_buf: &'d mut [u8],
|
||||||
|
control_buf: &'d mut [u8],
|
||||||
|
handler: Option<&'d dyn DeviceStateHandler>,
|
||||||
|
channel: &'d Channel<M, DeviceCommand, 1>,
|
||||||
|
) -> Self {
|
||||||
|
Self::new_inner(
|
||||||
|
driver,
|
||||||
|
config,
|
||||||
|
device_descriptor_buf,
|
||||||
|
config_descriptor_buf,
|
||||||
|
bos_descriptor_buf,
|
||||||
|
control_buf,
|
||||||
|
handler,
|
||||||
|
Some(channel),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn new_inner(
|
||||||
|
driver: D,
|
||||||
|
config: Config<'d>,
|
||||||
|
device_descriptor_buf: &'d mut [u8],
|
||||||
|
config_descriptor_buf: &'d mut [u8],
|
||||||
|
bos_descriptor_buf: &'d mut [u8],
|
||||||
|
control_buf: &'d mut [u8],
|
||||||
|
handler: Option<&'d dyn DeviceStateHandler>,
|
||||||
|
channel: Option<&'d Channel<M, DeviceCommand, 1>>,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
// Magic values specified in USB-IF ECN on IADs.
|
// Magic values specified in USB-IF ECN on IADs.
|
||||||
if config.composite_with_iads
|
if config.composite_with_iads
|
||||||
@ -174,9 +239,12 @@ impl<'d, D: Driver<'d>> UsbDeviceBuilder<'d, D> {
|
|||||||
|
|
||||||
UsbDeviceBuilder {
|
UsbDeviceBuilder {
|
||||||
driver,
|
driver,
|
||||||
|
handler,
|
||||||
config,
|
config,
|
||||||
interfaces: Vec::new(),
|
interfaces: Vec::new(),
|
||||||
control_buf,
|
control_buf,
|
||||||
|
commands: channel,
|
||||||
|
|
||||||
next_interface_number: 0,
|
next_interface_number: 0,
|
||||||
next_string_index: 4,
|
next_string_index: 4,
|
||||||
|
|
||||||
@ -187,20 +255,21 @@ impl<'d, D: Driver<'d>> UsbDeviceBuilder<'d, D> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Creates the [`UsbDevice`] instance with the configuration in this builder.
|
/// Creates the [`UsbDevice`] instance with the configuration in this builder.
|
||||||
pub async fn build(mut self) -> UsbDevice<'d, D> {
|
pub fn build(mut self) -> UsbDevice<'d, D, M> {
|
||||||
self.config_descriptor.end_configuration();
|
self.config_descriptor.end_configuration();
|
||||||
self.bos_descriptor.end_bos();
|
self.bos_descriptor.end_bos();
|
||||||
|
|
||||||
UsbDevice::build(
|
UsbDevice::build(
|
||||||
self.driver,
|
self.driver,
|
||||||
self.config,
|
self.config,
|
||||||
|
self.handler,
|
||||||
|
self.commands,
|
||||||
self.device_descriptor.into_buf(),
|
self.device_descriptor.into_buf(),
|
||||||
self.config_descriptor.into_buf(),
|
self.config_descriptor.into_buf(),
|
||||||
self.bos_descriptor.writer.into_buf(),
|
self.bos_descriptor.writer.into_buf(),
|
||||||
self.interfaces,
|
self.interfaces,
|
||||||
self.control_buf,
|
self.control_buf,
|
||||||
)
|
)
|
||||||
.await
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Allocates a new interface number.
|
/// Allocates a new interface number.
|
||||||
|
@ -11,7 +11,6 @@ pub trait Driver<'a> {
|
|||||||
type EndpointIn: EndpointIn + 'a;
|
type EndpointIn: EndpointIn + 'a;
|
||||||
type ControlPipe: ControlPipe + 'a;
|
type ControlPipe: ControlPipe + 'a;
|
||||||
type Bus: Bus + 'a;
|
type Bus: Bus + 'a;
|
||||||
type EnableFuture: Future<Output = Self::Bus> + 'a;
|
|
||||||
|
|
||||||
/// Allocates an endpoint and specified endpoint parameters. This method is called by the device
|
/// Allocates an endpoint and specified endpoint parameters. This method is called by the device
|
||||||
/// and class implementations to allocate endpoints, and can only be called before
|
/// and class implementations to allocate endpoints, and can only be called before
|
||||||
@ -47,7 +46,7 @@ pub trait Driver<'a> {
|
|||||||
|
|
||||||
/// Enables and initializes the USB peripheral. Soon after enabling the device will be reset, so
|
/// Enables and initializes the USB peripheral. Soon after enabling the device will be reset, so
|
||||||
/// there is no need to perform a USB reset in this method.
|
/// there is no need to perform a USB reset in this method.
|
||||||
fn enable(self) -> Self::EnableFuture;
|
fn into_bus(self) -> Self::Bus;
|
||||||
|
|
||||||
/// Indicates that `set_device_address` must be called before accepting the corresponding
|
/// Indicates that `set_device_address` must be called before accepting the corresponding
|
||||||
/// control transfer, not after.
|
/// control transfer, not after.
|
||||||
@ -57,19 +56,25 @@ pub trait Driver<'a> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub trait Bus {
|
pub trait Bus {
|
||||||
|
type EnableFuture<'a>: Future<Output = ()> + 'a
|
||||||
|
where
|
||||||
|
Self: 'a;
|
||||||
type PollFuture<'a>: Future<Output = Event> + 'a
|
type PollFuture<'a>: Future<Output = Event> + 'a
|
||||||
where
|
where
|
||||||
Self: 'a;
|
Self: 'a;
|
||||||
|
type RemoteWakeupFuture<'a>: Future<Output = Result<(), Unsupported>> + 'a
|
||||||
|
where
|
||||||
|
Self: 'a;
|
||||||
|
|
||||||
|
/// Enables the USB peripheral. Soon after enabling the device will be reset, so
|
||||||
|
/// there is no need to perform a USB reset in this method.
|
||||||
|
fn enable(&mut self) -> Self::EnableFuture<'_>;
|
||||||
|
|
||||||
|
/// Disables and powers down the USB peripheral.
|
||||||
|
fn disable(&mut self);
|
||||||
|
|
||||||
fn poll<'a>(&'a mut self) -> Self::PollFuture<'a>;
|
fn poll<'a>(&'a mut self) -> Self::PollFuture<'a>;
|
||||||
|
|
||||||
/// Called when the host resets the device. This will be soon called after
|
|
||||||
/// [`poll`](crate::device::UsbDevice::poll) returns [`PollResult::Reset`]. This method should
|
|
||||||
/// reset the state of all endpoints and peripheral flags back to a state suitable for
|
|
||||||
/// enumeration, as well as ensure that all endpoints previously allocated with alloc_ep are
|
|
||||||
/// initialized as specified.
|
|
||||||
fn reset(&mut self);
|
|
||||||
|
|
||||||
/// Sets the device USB address to `addr`.
|
/// Sets the device USB address to `addr`.
|
||||||
fn set_device_address(&mut self, addr: u8);
|
fn set_device_address(&mut self, addr: u8);
|
||||||
|
|
||||||
@ -83,17 +88,6 @@ pub trait Bus {
|
|||||||
/// Gets whether the STALL condition is set for an endpoint. Only used during control transfers.
|
/// Gets whether the STALL condition is set for an endpoint. Only used during control transfers.
|
||||||
fn is_stalled(&mut self, ep_addr: EndpointAddress) -> bool;
|
fn is_stalled(&mut self, ep_addr: EndpointAddress) -> bool;
|
||||||
|
|
||||||
/// Causes the USB peripheral to enter USB suspend mode, lowering power consumption and
|
|
||||||
/// preparing to detect a USB wakeup event. This will be called after
|
|
||||||
/// [`poll`](crate::device::UsbDevice::poll) returns [`PollResult::Suspend`]. The device will
|
|
||||||
/// continue be polled, and it shall return a value other than `Suspend` from `poll` when it no
|
|
||||||
/// longer detects the suspend condition.
|
|
||||||
fn suspend(&mut self);
|
|
||||||
|
|
||||||
/// Resumes from suspend mode. This may only be called after the peripheral has been previously
|
|
||||||
/// suspended.
|
|
||||||
fn resume(&mut self);
|
|
||||||
|
|
||||||
/// Simulates a disconnect from the USB bus, causing the host to reset and re-enumerate the
|
/// Simulates a disconnect from the USB bus, causing the host to reset and re-enumerate the
|
||||||
/// device.
|
/// device.
|
||||||
///
|
///
|
||||||
@ -106,6 +100,16 @@ pub trait Bus {
|
|||||||
fn force_reset(&mut self) -> Result<(), Unsupported> {
|
fn force_reset(&mut self) -> Result<(), Unsupported> {
|
||||||
Err(Unsupported)
|
Err(Unsupported)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Initiates a remote wakeup of the host by the device.
|
||||||
|
///
|
||||||
|
/// The default implementation just returns `Unsupported`.
|
||||||
|
///
|
||||||
|
/// # Errors
|
||||||
|
///
|
||||||
|
/// * [`Unsupported`](crate::UsbError::Unsupported) - This UsbBus implementation doesn't support
|
||||||
|
/// remote wakeup or it has not been enabled at creation time.
|
||||||
|
fn remote_wakeup(&mut self) -> Self::RemoteWakeupFuture<'_>;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait Endpoint {
|
pub trait Endpoint {
|
||||||
|
@ -12,6 +12,9 @@ pub mod driver;
|
|||||||
pub mod types;
|
pub mod types;
|
||||||
mod util;
|
mod util;
|
||||||
|
|
||||||
|
use driver::Unsupported;
|
||||||
|
use embassy::blocking_mutex::raw::{NoopRawMutex, RawMutex};
|
||||||
|
use embassy::channel::Channel;
|
||||||
use heapless::Vec;
|
use heapless::Vec;
|
||||||
|
|
||||||
use self::control::*;
|
use self::control::*;
|
||||||
@ -28,8 +31,12 @@ pub use self::builder::UsbDeviceBuilder;
|
|||||||
/// In general class traffic is only possible in the `Configured` state.
|
/// In general class traffic is only possible in the `Configured` state.
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum UsbDeviceState {
|
pub enum UsbDeviceState {
|
||||||
/// The USB device has just been created or reset.
|
/// The USB device is disabled.
|
||||||
|
Disabled,
|
||||||
|
|
||||||
|
/// The USB device has just been enabled or reset.
|
||||||
Default,
|
Default,
|
||||||
|
|
||||||
/// The USB device has received an address from the host.
|
/// The USB device has received an address from the host.
|
||||||
@ -37,9 +44,6 @@ pub enum UsbDeviceState {
|
|||||||
|
|
||||||
/// The USB device has been configured and is fully functional.
|
/// The USB device has been configured and is fully functional.
|
||||||
Configured,
|
Configured,
|
||||||
|
|
||||||
/// The USB device has been suspended by the host or it has been unplugged from the USB bus.
|
|
||||||
Suspend,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The bConfiguration value for the not configured state.
|
/// The bConfiguration value for the not configured state.
|
||||||
@ -53,8 +57,39 @@ pub const DEFAULT_ALTERNATE_SETTING: u8 = 0;
|
|||||||
|
|
||||||
pub const MAX_INTERFACE_COUNT: usize = 4;
|
pub const MAX_INTERFACE_COUNT: usize = 4;
|
||||||
|
|
||||||
pub struct UsbDevice<'d, D: Driver<'d>> {
|
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
|
pub enum DeviceCommand {
|
||||||
|
Enable,
|
||||||
|
Disable,
|
||||||
|
RemoteWakeup,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A handler trait for changes in the device state of the [UsbDevice].
|
||||||
|
pub trait DeviceStateHandler {
|
||||||
|
/// Called when the host resets the device.
|
||||||
|
fn reset(&self) {}
|
||||||
|
|
||||||
|
/// Called when the host has set the address of the device to `addr`.
|
||||||
|
fn addressed(&self, _addr: u8) {}
|
||||||
|
|
||||||
|
/// Called when the host has enabled or disabled the configuration of the device.
|
||||||
|
fn configured(&self, _configured: bool) {}
|
||||||
|
|
||||||
|
/// Called when the bus has entered or exited the suspend state.
|
||||||
|
fn suspended(&self, _suspended: bool) {}
|
||||||
|
|
||||||
|
/// Called when remote wakeup feature is enabled or disabled.
|
||||||
|
fn remote_wakeup_enabled(&self, _enabled: bool) {}
|
||||||
|
|
||||||
|
/// Called when the USB device has been disabled.
|
||||||
|
fn disabled(&self) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct UsbDevice<'d, D: Driver<'d>, M: RawMutex = NoopRawMutex> {
|
||||||
bus: D::Bus,
|
bus: D::Bus,
|
||||||
|
handler: Option<&'d dyn DeviceStateHandler>,
|
||||||
|
commands: Option<&'d Channel<M, DeviceCommand, 1>>,
|
||||||
control: ControlPipe<D::ControlPipe>,
|
control: ControlPipe<D::ControlPipe>,
|
||||||
|
|
||||||
config: Config<'d>,
|
config: Config<'d>,
|
||||||
@ -64,6 +99,7 @@ pub struct UsbDevice<'d, D: Driver<'d>> {
|
|||||||
control_buf: &'d mut [u8],
|
control_buf: &'d mut [u8],
|
||||||
|
|
||||||
device_state: UsbDeviceState,
|
device_state: UsbDeviceState,
|
||||||
|
suspended: bool,
|
||||||
remote_wakeup_enabled: bool,
|
remote_wakeup_enabled: bool,
|
||||||
self_powered: bool,
|
self_powered: bool,
|
||||||
pending_address: u8,
|
pending_address: u8,
|
||||||
@ -71,33 +107,38 @@ pub struct UsbDevice<'d, D: Driver<'d>> {
|
|||||||
interfaces: Vec<(u8, &'d mut dyn ControlHandler), MAX_INTERFACE_COUNT>,
|
interfaces: Vec<(u8, &'d mut dyn ControlHandler), MAX_INTERFACE_COUNT>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'d, D: Driver<'d>> UsbDevice<'d, D> {
|
impl<'d, D: Driver<'d>, M: RawMutex> UsbDevice<'d, D, M> {
|
||||||
pub(crate) async fn build(
|
pub(crate) fn build(
|
||||||
mut driver: D,
|
mut driver: D,
|
||||||
config: Config<'d>,
|
config: Config<'d>,
|
||||||
|
handler: Option<&'d dyn DeviceStateHandler>,
|
||||||
|
commands: Option<&'d Channel<M, DeviceCommand, 1>>,
|
||||||
device_descriptor: &'d [u8],
|
device_descriptor: &'d [u8],
|
||||||
config_descriptor: &'d [u8],
|
config_descriptor: &'d [u8],
|
||||||
bos_descriptor: &'d [u8],
|
bos_descriptor: &'d [u8],
|
||||||
interfaces: Vec<(u8, &'d mut dyn ControlHandler), MAX_INTERFACE_COUNT>,
|
interfaces: Vec<(u8, &'d mut dyn ControlHandler), MAX_INTERFACE_COUNT>,
|
||||||
control_buf: &'d mut [u8],
|
control_buf: &'d mut [u8],
|
||||||
) -> UsbDevice<'d, D> {
|
) -> UsbDevice<'d, D, M> {
|
||||||
let control = driver
|
let control = driver
|
||||||
.alloc_control_pipe(config.max_packet_size_0 as u16)
|
.alloc_control_pipe(config.max_packet_size_0 as u16)
|
||||||
.expect("failed to alloc control endpoint");
|
.expect("failed to alloc control endpoint");
|
||||||
|
|
||||||
// Enable the USB bus.
|
// Enable the USB bus.
|
||||||
// This prevent further allocation by consuming the driver.
|
// This prevent further allocation by consuming the driver.
|
||||||
let bus = driver.enable().await;
|
let bus = driver.into_bus();
|
||||||
|
|
||||||
Self {
|
Self {
|
||||||
bus,
|
bus,
|
||||||
config,
|
config,
|
||||||
|
handler,
|
||||||
|
commands,
|
||||||
control: ControlPipe::new(control),
|
control: ControlPipe::new(control),
|
||||||
device_descriptor,
|
device_descriptor,
|
||||||
config_descriptor,
|
config_descriptor,
|
||||||
bos_descriptor,
|
bos_descriptor,
|
||||||
control_buf,
|
control_buf,
|
||||||
device_state: UsbDeviceState::Default,
|
device_state: UsbDeviceState::Default,
|
||||||
|
suspended: false,
|
||||||
remote_wakeup_enabled: false,
|
remote_wakeup_enabled: false,
|
||||||
self_powered: false,
|
self_powered: false,
|
||||||
pending_address: 0,
|
pending_address: 0,
|
||||||
@ -105,41 +146,94 @@ impl<'d, D: Driver<'d>> UsbDevice<'d, D> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub async fn run(&mut self) {
|
pub async fn run(&mut self) -> ! {
|
||||||
|
if self.config.start_enabled {
|
||||||
|
self.bus.enable().await;
|
||||||
|
} else {
|
||||||
|
self.wait_for_enable().await
|
||||||
|
}
|
||||||
|
|
||||||
loop {
|
loop {
|
||||||
let control_fut = self.control.setup();
|
let control_fut = self.control.setup();
|
||||||
let bus_fut = self.bus.poll();
|
let bus_fut = self.bus.poll();
|
||||||
match select(bus_fut, control_fut).await {
|
let commands_fut = recv_or_wait(self.commands);
|
||||||
Either::Left(evt) => match evt {
|
|
||||||
|
match select3(bus_fut, control_fut, commands_fut).await {
|
||||||
|
Either3::First(evt) => match evt {
|
||||||
Event::Reset => {
|
Event::Reset => {
|
||||||
trace!("usb: reset");
|
trace!("usb: reset");
|
||||||
self.bus.reset();
|
|
||||||
|
|
||||||
self.device_state = UsbDeviceState::Default;
|
self.device_state = UsbDeviceState::Default;
|
||||||
|
self.suspended = false;
|
||||||
self.remote_wakeup_enabled = false;
|
self.remote_wakeup_enabled = false;
|
||||||
self.pending_address = 0;
|
self.pending_address = 0;
|
||||||
|
|
||||||
for (_, h) in self.interfaces.iter_mut() {
|
for (_, h) in self.interfaces.iter_mut() {
|
||||||
h.reset();
|
h.reset();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.reset();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
Event::Resume => {
|
Event::Resume => {
|
||||||
trace!("usb: resume");
|
trace!("usb: resume");
|
||||||
|
self.suspended = false;
|
||||||
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.suspended(false);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
Event::Suspend => {
|
Event::Suspend => {
|
||||||
trace!("usb: suspend");
|
trace!("usb: suspend");
|
||||||
self.bus.suspend();
|
self.suspended = true;
|
||||||
self.device_state = UsbDeviceState::Suspend;
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.suspended(true);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
Either::Right(req) => match req {
|
Either3::Second(req) => match req {
|
||||||
Setup::DataIn(req, stage) => self.handle_control_in(req, stage).await,
|
Setup::DataIn(req, stage) => self.handle_control_in(req, stage).await,
|
||||||
Setup::DataOut(req, stage) => self.handle_control_out(req, stage).await,
|
Setup::DataOut(req, stage) => self.handle_control_out(req, stage).await,
|
||||||
},
|
},
|
||||||
|
Either3::Third(cmd) => match cmd {
|
||||||
|
DeviceCommand::Enable => warn!("usb: Enable command received while enabled."),
|
||||||
|
DeviceCommand::Disable => {
|
||||||
|
trace!("usb: disable");
|
||||||
|
self.bus.disable();
|
||||||
|
self.device_state = UsbDeviceState::Disabled;
|
||||||
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.disabled();
|
||||||
|
}
|
||||||
|
self.wait_for_enable().await;
|
||||||
|
}
|
||||||
|
DeviceCommand::RemoteWakeup => {
|
||||||
|
if self.remote_wakeup_enabled {
|
||||||
|
match self.bus.remote_wakeup().await {
|
||||||
|
Ok(()) => (),
|
||||||
|
Err(Unsupported) => warn!("Remote wakeup is unsupported!"),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
warn!("Remote wakeup not enabled.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async fn wait_for_enable(&mut self) {
|
||||||
|
loop {
|
||||||
|
// When disabled just wait until we're told to re-enable
|
||||||
|
match recv_or_wait(self.commands).await {
|
||||||
|
DeviceCommand::Enable => break,
|
||||||
|
cmd => warn!("usb: {:?} received while disabled", cmd),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
trace!("usb: enable");
|
||||||
|
self.bus.enable().await;
|
||||||
|
self.device_state = UsbDeviceState::Default;
|
||||||
|
}
|
||||||
|
|
||||||
async fn handle_control_out(&mut self, req: Request, stage: DataOutStage) {
|
async fn handle_control_out(&mut self, req: Request, stage: DataOutStage) {
|
||||||
const CONFIGURATION_NONE_U16: u16 = CONFIGURATION_NONE as u16;
|
const CONFIGURATION_NONE_U16: u16 = CONFIGURATION_NONE as u16;
|
||||||
const CONFIGURATION_VALUE_U16: u16 = CONFIGURATION_VALUE as u16;
|
const CONFIGURATION_VALUE_U16: u16 = CONFIGURATION_VALUE as u16;
|
||||||
@ -156,20 +250,33 @@ impl<'d, D: Driver<'d>> UsbDevice<'d, D> {
|
|||||||
(RequestType::Standard, Recipient::Device) => match (req.request, req.value) {
|
(RequestType::Standard, Recipient::Device) => match (req.request, req.value) {
|
||||||
(Request::CLEAR_FEATURE, Request::FEATURE_DEVICE_REMOTE_WAKEUP) => {
|
(Request::CLEAR_FEATURE, Request::FEATURE_DEVICE_REMOTE_WAKEUP) => {
|
||||||
self.remote_wakeup_enabled = false;
|
self.remote_wakeup_enabled = false;
|
||||||
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.remote_wakeup_enabled(false);
|
||||||
|
}
|
||||||
self.control.accept(stage)
|
self.control.accept(stage)
|
||||||
}
|
}
|
||||||
(Request::SET_FEATURE, Request::FEATURE_DEVICE_REMOTE_WAKEUP) => {
|
(Request::SET_FEATURE, Request::FEATURE_DEVICE_REMOTE_WAKEUP) => {
|
||||||
self.remote_wakeup_enabled = true;
|
self.remote_wakeup_enabled = true;
|
||||||
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.remote_wakeup_enabled(true);
|
||||||
|
}
|
||||||
self.control.accept(stage)
|
self.control.accept(stage)
|
||||||
}
|
}
|
||||||
(Request::SET_ADDRESS, addr @ 1..=127) => {
|
(Request::SET_ADDRESS, addr @ 1..=127) => {
|
||||||
self.pending_address = addr as u8;
|
self.pending_address = addr as u8;
|
||||||
self.bus.set_device_address(self.pending_address);
|
self.bus.set_device_address(self.pending_address);
|
||||||
|
self.device_state = UsbDeviceState::Addressed;
|
||||||
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.addressed(self.pending_address);
|
||||||
|
}
|
||||||
self.control.accept(stage)
|
self.control.accept(stage)
|
||||||
}
|
}
|
||||||
(Request::SET_CONFIGURATION, CONFIGURATION_VALUE_U16) => {
|
(Request::SET_CONFIGURATION, CONFIGURATION_VALUE_U16) => {
|
||||||
self.device_state = UsbDeviceState::Configured;
|
self.device_state = UsbDeviceState::Configured;
|
||||||
self.bus.set_configured(true);
|
self.bus.set_configured(true);
|
||||||
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.configured(true);
|
||||||
|
}
|
||||||
self.control.accept(stage)
|
self.control.accept(stage)
|
||||||
}
|
}
|
||||||
(Request::SET_CONFIGURATION, CONFIGURATION_NONE_U16) => match self.device_state {
|
(Request::SET_CONFIGURATION, CONFIGURATION_NONE_U16) => match self.device_state {
|
||||||
@ -177,6 +284,9 @@ impl<'d, D: Driver<'d>> UsbDevice<'d, D> {
|
|||||||
_ => {
|
_ => {
|
||||||
self.device_state = UsbDeviceState::Addressed;
|
self.device_state = UsbDeviceState::Addressed;
|
||||||
self.bus.set_configured(false);
|
self.bus.set_configured(false);
|
||||||
|
if let Some(h) = &mut self.handler {
|
||||||
|
h.configured(false);
|
||||||
|
}
|
||||||
self.control.accept(stage)
|
self.control.accept(stage)
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
@ -1,45 +1,85 @@
|
|||||||
use core::future::Future;
|
use core::future::Future;
|
||||||
|
use core::marker::PhantomData;
|
||||||
use core::pin::Pin;
|
use core::pin::Pin;
|
||||||
use core::task::{Context, Poll};
|
use core::task::{Context, Poll};
|
||||||
|
|
||||||
|
use embassy::blocking_mutex::raw::RawMutex;
|
||||||
|
use embassy::channel::Channel;
|
||||||
|
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub enum Either<A, B> {
|
pub enum Either3<A, B, C> {
|
||||||
Left(A),
|
First(A),
|
||||||
Right(B),
|
Second(B),
|
||||||
|
Third(C),
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn select<A, B>(a: A, b: B) -> Select<A, B>
|
/// Same as [`select`], but with more futures.
|
||||||
|
pub fn select3<A, B, C>(a: A, b: B, c: C) -> Select3<A, B, C>
|
||||||
where
|
where
|
||||||
A: Future,
|
A: Future,
|
||||||
B: Future,
|
B: Future,
|
||||||
|
C: Future,
|
||||||
{
|
{
|
||||||
Select { a, b }
|
Select3 { a, b, c }
|
||||||
}
|
}
|
||||||
|
|
||||||
pub struct Select<A, B> {
|
/// Future for the [`select3`] function.
|
||||||
|
#[derive(Debug)]
|
||||||
|
#[must_use = "futures do nothing unless you `.await` or poll them"]
|
||||||
|
pub struct Select3<A, B, C> {
|
||||||
a: A,
|
a: A,
|
||||||
b: B,
|
b: B,
|
||||||
|
c: C,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<A: Unpin, B: Unpin> Unpin for Select<A, B> {}
|
impl<A, B, C> Future for Select3<A, B, C>
|
||||||
|
|
||||||
impl<A, B> Future for Select<A, B>
|
|
||||||
where
|
where
|
||||||
A: Future,
|
A: Future,
|
||||||
B: Future,
|
B: Future,
|
||||||
|
C: Future,
|
||||||
{
|
{
|
||||||
type Output = Either<A::Output, B::Output>;
|
type Output = Either3<A::Output, B::Output, C::Output>;
|
||||||
|
|
||||||
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||||
let this = unsafe { self.get_unchecked_mut() };
|
let this = unsafe { self.get_unchecked_mut() };
|
||||||
let a = unsafe { Pin::new_unchecked(&mut this.a) };
|
let a = unsafe { Pin::new_unchecked(&mut this.a) };
|
||||||
let b = unsafe { Pin::new_unchecked(&mut this.b) };
|
let b = unsafe { Pin::new_unchecked(&mut this.b) };
|
||||||
match a.poll(cx) {
|
let c = unsafe { Pin::new_unchecked(&mut this.c) };
|
||||||
Poll::Ready(x) => Poll::Ready(Either::Left(x)),
|
if let Poll::Ready(x) = a.poll(cx) {
|
||||||
Poll::Pending => match b.poll(cx) {
|
return Poll::Ready(Either3::First(x));
|
||||||
Poll::Ready(x) => Poll::Ready(Either::Right(x)),
|
}
|
||||||
Poll::Pending => Poll::Pending,
|
if let Poll::Ready(x) = b.poll(cx) {
|
||||||
},
|
return Poll::Ready(Either3::Second(x));
|
||||||
|
}
|
||||||
|
if let Poll::Ready(x) = c.poll(cx) {
|
||||||
|
return Poll::Ready(Either3::Third(x));
|
||||||
|
}
|
||||||
|
Poll::Pending
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct Pending<T> {
|
||||||
|
_phantom: PhantomData<T>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T> Pending<T> {
|
||||||
|
fn new() -> Self {
|
||||||
|
Pending {
|
||||||
|
_phantom: PhantomData,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<T> Future for Pending<T> {
|
||||||
|
type Output = T;
|
||||||
|
fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||||
|
Poll::Pending
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn recv_or_wait<M: RawMutex, T, const N: usize>(ch: Option<&Channel<M, T, N>>) -> T {
|
||||||
|
match ch {
|
||||||
|
Some(ch) => ch.recv().await,
|
||||||
|
None => Pending::new().await,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -4,8 +4,12 @@
|
|||||||
#![feature(type_alias_impl_trait)]
|
#![feature(type_alias_impl_trait)]
|
||||||
|
|
||||||
use core::mem;
|
use core::mem;
|
||||||
|
use core::sync::atomic::{AtomicBool, Ordering};
|
||||||
use defmt::*;
|
use defmt::*;
|
||||||
|
use embassy::blocking_mutex::raw::CriticalSectionRawMutex;
|
||||||
|
use embassy::channel::Channel;
|
||||||
use embassy::executor::Spawner;
|
use embassy::executor::Spawner;
|
||||||
|
use embassy::interrupt::InterruptExt;
|
||||||
use embassy::time::Duration;
|
use embassy::time::Duration;
|
||||||
use embassy_nrf::gpio::{Input, Pin, Pull};
|
use embassy_nrf::gpio::{Input, Pin, Pull};
|
||||||
use embassy_nrf::interrupt;
|
use embassy_nrf::interrupt;
|
||||||
@ -13,7 +17,7 @@ use embassy_nrf::pac;
|
|||||||
use embassy_nrf::usb::Driver;
|
use embassy_nrf::usb::Driver;
|
||||||
use embassy_nrf::Peripherals;
|
use embassy_nrf::Peripherals;
|
||||||
use embassy_usb::control::OutResponse;
|
use embassy_usb::control::OutResponse;
|
||||||
use embassy_usb::{Config, UsbDeviceBuilder};
|
use embassy_usb::{Config, DeviceCommand, DeviceStateHandler, UsbDeviceBuilder};
|
||||||
use embassy_usb_hid::{HidClass, ReportId, RequestHandler, State};
|
use embassy_usb_hid::{HidClass, ReportId, RequestHandler, State};
|
||||||
use futures::future::join;
|
use futures::future::join;
|
||||||
use usbd_hid::descriptor::{KeyboardReport, SerializedDescriptor};
|
use usbd_hid::descriptor::{KeyboardReport, SerializedDescriptor};
|
||||||
@ -21,6 +25,29 @@ use usbd_hid::descriptor::{KeyboardReport, SerializedDescriptor};
|
|||||||
use defmt_rtt as _; // global logger
|
use defmt_rtt as _; // global logger
|
||||||
use panic_probe as _;
|
use panic_probe as _;
|
||||||
|
|
||||||
|
static USB_COMMANDS: Channel<CriticalSectionRawMutex, DeviceCommand, 1> = Channel::new();
|
||||||
|
static SUSPENDED: AtomicBool = AtomicBool::new(false);
|
||||||
|
|
||||||
|
fn on_power_interrupt(_: *mut ()) {
|
||||||
|
let regs = unsafe { &*pac::POWER::ptr() };
|
||||||
|
|
||||||
|
if regs.events_usbdetected.read().bits() != 0 {
|
||||||
|
regs.events_usbdetected.reset();
|
||||||
|
info!("Vbus detected, enabling USB...");
|
||||||
|
if USB_COMMANDS.try_send(DeviceCommand::Enable).is_err() {
|
||||||
|
warn!("Failed to send enable command to USB channel");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if regs.events_usbremoved.read().bits() != 0 {
|
||||||
|
regs.events_usbremoved.reset();
|
||||||
|
info!("Vbus removed, disabling USB...");
|
||||||
|
if USB_COMMANDS.try_send(DeviceCommand::Disable).is_err() {
|
||||||
|
warn!("Failed to send disable command to USB channel");
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[embassy::main]
|
#[embassy::main]
|
||||||
async fn main(_spawner: Spawner, p: Peripherals) {
|
async fn main(_spawner: Spawner, p: Peripherals) {
|
||||||
let clock: pac::CLOCK = unsafe { mem::transmute(()) };
|
let clock: pac::CLOCK = unsafe { mem::transmute(()) };
|
||||||
@ -30,10 +57,6 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
clock.tasks_hfclkstart.write(|w| unsafe { w.bits(1) });
|
clock.tasks_hfclkstart.write(|w| unsafe { w.bits(1) });
|
||||||
while clock.events_hfclkstarted.read().bits() != 1 {}
|
while clock.events_hfclkstarted.read().bits() != 1 {}
|
||||||
|
|
||||||
info!("Waiting for vbus...");
|
|
||||||
while !power.usbregstatus.read().vbusdetect().is_vbus_present() {}
|
|
||||||
info!("vbus OK");
|
|
||||||
|
|
||||||
// Create the driver, from the HAL.
|
// Create the driver, from the HAL.
|
||||||
let irq = interrupt::take!(USBD);
|
let irq = interrupt::take!(USBD);
|
||||||
let driver = Driver::new(p.USBD, irq);
|
let driver = Driver::new(p.USBD, irq);
|
||||||
@ -45,6 +68,8 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
config.serial_number = Some("12345678");
|
config.serial_number = Some("12345678");
|
||||||
config.max_power = 100;
|
config.max_power = 100;
|
||||||
config.max_packet_size_0 = 64;
|
config.max_packet_size_0 = 64;
|
||||||
|
config.supports_remote_wakeup = true;
|
||||||
|
config.start_enabled = false;
|
||||||
|
|
||||||
// Create embassy-usb DeviceBuilder using the driver and config.
|
// Create embassy-usb DeviceBuilder using the driver and config.
|
||||||
// It needs some buffers for building the descriptors.
|
// It needs some buffers for building the descriptors.
|
||||||
@ -53,16 +78,19 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
let mut bos_descriptor = [0; 256];
|
let mut bos_descriptor = [0; 256];
|
||||||
let mut control_buf = [0; 16];
|
let mut control_buf = [0; 16];
|
||||||
let request_handler = MyRequestHandler {};
|
let request_handler = MyRequestHandler {};
|
||||||
|
let device_state_handler = MyDeviceStateHandler::new();
|
||||||
|
|
||||||
let mut state = State::<8, 1>::new();
|
let mut state = State::<8, 1>::new();
|
||||||
|
|
||||||
let mut builder = UsbDeviceBuilder::new(
|
let mut builder = UsbDeviceBuilder::new_with_channel(
|
||||||
driver,
|
driver,
|
||||||
config,
|
config,
|
||||||
&mut device_descriptor,
|
&mut device_descriptor,
|
||||||
&mut config_descriptor,
|
&mut config_descriptor,
|
||||||
&mut bos_descriptor,
|
&mut bos_descriptor,
|
||||||
&mut control_buf,
|
&mut control_buf,
|
||||||
|
Some(&device_state_handler),
|
||||||
|
&USB_COMMANDS,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Create classes on the builder.
|
// Create classes on the builder.
|
||||||
@ -76,7 +104,7 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
);
|
);
|
||||||
|
|
||||||
// Build the builder.
|
// Build the builder.
|
||||||
let mut usb = builder.build().await;
|
let mut usb = builder.build();
|
||||||
|
|
||||||
// Run the USB device.
|
// Run the USB device.
|
||||||
let usb_fut = usb.run();
|
let usb_fut = usb.run();
|
||||||
@ -90,6 +118,12 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
loop {
|
loop {
|
||||||
button.wait_for_low().await;
|
button.wait_for_low().await;
|
||||||
info!("PRESSED");
|
info!("PRESSED");
|
||||||
|
|
||||||
|
if SUSPENDED.load(Ordering::Acquire) {
|
||||||
|
info!("Triggering remote wakeup");
|
||||||
|
USB_COMMANDS.send(DeviceCommand::RemoteWakeup);
|
||||||
|
}
|
||||||
|
|
||||||
let report = KeyboardReport {
|
let report = KeyboardReport {
|
||||||
keycodes: [4, 0, 0, 0, 0, 0],
|
keycodes: [4, 0, 0, 0, 0, 0],
|
||||||
leds: 0,
|
leds: 0,
|
||||||
@ -119,6 +153,16 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
let out_fut = async {
|
let out_fut = async {
|
||||||
hid_out.run(false, &request_handler).await;
|
hid_out.run(false, &request_handler).await;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
let power_irq = interrupt::take!(POWER_CLOCK);
|
||||||
|
power_irq.set_handler(on_power_interrupt);
|
||||||
|
power_irq.unpend();
|
||||||
|
power_irq.enable();
|
||||||
|
|
||||||
|
power
|
||||||
|
.intenset
|
||||||
|
.write(|w| w.usbdetected().set().usbremoved().set());
|
||||||
|
|
||||||
// Run everything concurrently.
|
// Run everything concurrently.
|
||||||
// If we had made everything `'static` above instead, we could do this using separate tasks instead.
|
// If we had made everything `'static` above instead, we could do this using separate tasks instead.
|
||||||
join(usb_fut, join(in_fut, out_fut)).await;
|
join(usb_fut, join(in_fut, out_fut)).await;
|
||||||
@ -146,3 +190,59 @@ impl RequestHandler for MyRequestHandler {
|
|||||||
None
|
None
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
struct MyDeviceStateHandler {
|
||||||
|
configured: AtomicBool,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl MyDeviceStateHandler {
|
||||||
|
fn new() -> Self {
|
||||||
|
MyDeviceStateHandler {
|
||||||
|
configured: AtomicBool::new(false),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl DeviceStateHandler for MyDeviceStateHandler {
|
||||||
|
fn reset(&self) {
|
||||||
|
self.configured.store(false, Ordering::Relaxed);
|
||||||
|
info!("Bus reset, the Vbus current limit is 100mA");
|
||||||
|
}
|
||||||
|
|
||||||
|
fn addressed(&self, addr: u8) {
|
||||||
|
self.configured.store(false, Ordering::Relaxed);
|
||||||
|
info!("USB address set to: {}", addr);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn configured(&self, configured: bool) {
|
||||||
|
self.configured.store(configured, Ordering::Relaxed);
|
||||||
|
if configured {
|
||||||
|
info!(
|
||||||
|
"Device configured, it may now draw up to the configured current limit from Vbus."
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
info!("Device is no longer configured, the Vbus current limit is 100mA.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn suspended(&self, suspended: bool) {
|
||||||
|
if suspended {
|
||||||
|
info!("Device suspended, the Vbus current limit is 500µA (or 2.5mA for high-power devices with remote wakeup enabled).");
|
||||||
|
SUSPENDED.store(true, Ordering::Release);
|
||||||
|
} else {
|
||||||
|
SUSPENDED.store(false, Ordering::Release);
|
||||||
|
if self.configured.load(Ordering::Relaxed) {
|
||||||
|
info!(
|
||||||
|
"Device resumed, it may now draw up to the configured current limit from Vbus"
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
info!("Device resumed, the Vbus current limit is 100mA");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn disabled(&self) {
|
||||||
|
self.configured.store(false, Ordering::Relaxed);
|
||||||
|
info!("Device disabled");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -61,6 +61,7 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
&mut config_descriptor,
|
&mut config_descriptor,
|
||||||
&mut bos_descriptor,
|
&mut bos_descriptor,
|
||||||
&mut control_buf,
|
&mut control_buf,
|
||||||
|
None,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Create classes on the builder.
|
// Create classes on the builder.
|
||||||
@ -74,7 +75,7 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
);
|
);
|
||||||
|
|
||||||
// Build the builder.
|
// Build the builder.
|
||||||
let mut usb = builder.build().await;
|
let mut usb = builder.build();
|
||||||
|
|
||||||
// Run the USB device.
|
// Run the USB device.
|
||||||
let usb_fut = usb.run();
|
let usb_fut = usb.run();
|
||||||
|
@ -54,13 +54,14 @@ async fn main(_spawner: Spawner, p: Peripherals) {
|
|||||||
&mut config_descriptor,
|
&mut config_descriptor,
|
||||||
&mut bos_descriptor,
|
&mut bos_descriptor,
|
||||||
&mut control_buf,
|
&mut control_buf,
|
||||||
|
None,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Create classes on the builder.
|
// Create classes on the builder.
|
||||||
let mut class = CdcAcmClass::new(&mut builder, &mut state, 64);
|
let mut class = CdcAcmClass::new(&mut builder, &mut state, 64);
|
||||||
|
|
||||||
// Build the builder.
|
// Build the builder.
|
||||||
let mut usb = builder.build().await;
|
let mut usb = builder.build();
|
||||||
|
|
||||||
// Run the USB device.
|
// Run the USB device.
|
||||||
let usb_fut = usb.run();
|
let usb_fut = usb.run();
|
||||||
|
@ -79,13 +79,14 @@ async fn main(spawner: Spawner, p: Peripherals) {
|
|||||||
&mut res.config_descriptor,
|
&mut res.config_descriptor,
|
||||||
&mut res.bos_descriptor,
|
&mut res.bos_descriptor,
|
||||||
&mut res.control_buf,
|
&mut res.control_buf,
|
||||||
|
None,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Create classes on the builder.
|
// Create classes on the builder.
|
||||||
let class = CdcAcmClass::new(&mut builder, &mut res.serial_state, 64);
|
let class = CdcAcmClass::new(&mut builder, &mut res.serial_state, 64);
|
||||||
|
|
||||||
// Build the builder.
|
// Build the builder.
|
||||||
let usb = builder.build().await;
|
let usb = builder.build();
|
||||||
|
|
||||||
unwrap!(spawner.spawn(usb_task(usb)));
|
unwrap!(spawner.spawn(usb_task(usb)));
|
||||||
unwrap!(spawner.spawn(echo_task(class)));
|
unwrap!(spawner.spawn(echo_task(class)));
|
||||||
|
Loading…
Reference in New Issue
Block a user