rp/pio: seal PioInstance, SmInstance

seems prudent to hide access to the internals.
This commit is contained in:
pennae 2023-04-25 19:28:01 +02:00
parent db16b6ff3f
commit 4618b79b22

View File

@ -12,6 +12,7 @@ use crate::dma::{Channel, Transfer};
use crate::gpio::sealed::Pin as SealedPin; use crate::gpio::sealed::Pin as SealedPin;
use crate::gpio::{Drive, Pin, Pull, SlewRate}; use crate::gpio::{Drive, Pin, Pull, SlewRate};
use crate::pac::dma::vals::{DataSize, TreqSel}; use crate::pac::dma::vals::{DataSize, TreqSel};
use crate::pio::sealed::{PioInstance as _, SmInstance as _};
use crate::{interrupt, pac, peripherals, RegExt}; use crate::{interrupt, pac, peripherals, RegExt};
struct Wakers([AtomicWaker; 12]); struct Wakers([AtomicWaker; 12]);
@ -320,14 +321,13 @@ pub struct PioStateMachineInstance<PIO: PioInstance, SM: SmInstance> {
sm: PhantomData<SM>, sm: PhantomData<SM>,
} }
impl<PIO: PioInstance, SM: SmInstance> PioStateMachine for PioStateMachineInstance<PIO, SM> { impl<PIO: PioInstance, SM: SmInstance> sealed::PioStateMachine for PioStateMachineInstance<PIO, SM> {
type Pio = PIO; type Pio = PIO;
type Sm = SM; type Sm = SM;
} }
impl<PIO: PioInstance, SM: SmInstance> PioStateMachine for PioStateMachineInstance<PIO, SM> {}
pub trait PioStateMachine: Sized + Unpin { pub trait PioStateMachine: sealed::PioStateMachine + Sized + Unpin {
type Pio: PioInstance;
type Sm: SmInstance;
fn pio_no(&self) -> u8 { fn pio_no(&self) -> u8 {
let _ = self; let _ = self;
Self::Pio::PIO_NO Self::Pio::PIO_NO
@ -1027,9 +1027,10 @@ pub struct PioCommonInstance<PIO: PioInstance> {
pio: PhantomData<PIO>, pio: PhantomData<PIO>,
} }
impl<PIO: PioInstance> PioCommon for PioCommonInstance<PIO> { impl<PIO: PioInstance> sealed::PioCommon for PioCommonInstance<PIO> {
type Pio = PIO; type Pio = PIO;
} }
impl<PIO: PioInstance> PioCommon for PioCommonInstance<PIO> {}
fn write_instr<I>(pio_no: u8, start: usize, instrs: I, mem_user: u32) fn write_instr<I>(pio_no: u8, start: usize, instrs: I, mem_user: u32)
where where
@ -1051,9 +1052,7 @@ where
} }
} }
pub trait PioCommon: Sized { pub trait PioCommon: sealed::PioCommon + Sized {
type Pio: PioInstance;
fn write_instr<I>(&mut self, start: usize, instrs: I) fn write_instr<I>(&mut self, start: usize, instrs: I)
where where
I: Iterator<Item = u16>, I: Iterator<Item = u16>,
@ -1096,16 +1095,14 @@ pub trait PioCommon: Sized {
// Identifies a specific state machine inside a PIO device // Identifies a specific state machine inside a PIO device
pub struct SmInstanceBase<const SM_NO: u8> {} pub struct SmInstanceBase<const SM_NO: u8> {}
pub trait SmInstance: Unpin { pub trait SmInstance: sealed::SmInstance + Unpin {}
const SM_NO: u8;
}
impl<const SM_NO: u8> SmInstance for SmInstanceBase<SM_NO> { impl<const SM_NO: u8> sealed::SmInstance for SmInstanceBase<SM_NO> {
const SM_NO: u8 = SM_NO; const SM_NO: u8 = SM_NO;
} }
impl<const SM_NO: u8> SmInstance for SmInstanceBase<SM_NO> {}
pub trait PioPeripheral: Sized { pub trait PioPeripheral: sealed::PioPeripheral + Sized {
type Pio: PioInstance;
fn pio(&self) -> u8 { fn pio(&self) -> u8 {
let _ = self; let _ = self;
Self::Pio::PIO_NO Self::Pio::PIO_NO
@ -1145,20 +1142,43 @@ pub trait PioPeripheral: Sized {
} }
} }
mod sealed {
pub trait PioInstance {
const PIO_NO: u8;
}
pub trait PioCommon {
type Pio: super::PioInstance;
}
pub trait PioStateMachine {
type Pio: super::PioInstance;
type Sm: super::SmInstance;
}
pub trait SmInstance {
const SM_NO: u8;
}
pub trait PioPeripheral {
type Pio: super::PioInstance;
}
}
// Identifies a specific PIO device // Identifies a specific PIO device
pub struct PioInstanceBase<const PIO_NO: u8> {} pub struct PioInstanceBase<const PIO_NO: u8> {}
pub trait PioInstance: Unpin { pub trait PioInstance: sealed::PioInstance + Unpin {}
const PIO_NO: u8;
}
impl PioInstance for PioInstanceBase<0> { impl sealed::PioInstance for PioInstanceBase<0> {
const PIO_NO: u8 = 0; const PIO_NO: u8 = 0;
} }
impl PioInstance for PioInstanceBase<0> {}
impl PioInstance for PioInstanceBase<1> { impl sealed::PioInstance for PioInstanceBase<1> {
const PIO_NO: u8 = 1; const PIO_NO: u8 = 1;
} }
impl PioInstance for PioInstanceBase<1> {}
pub type Pio0 = PioInstanceBase<0>; pub type Pio0 = PioInstanceBase<0>;
pub type Pio1 = PioInstanceBase<1>; pub type Pio1 = PioInstanceBase<1>;
@ -1170,9 +1190,10 @@ pub type Sm3 = SmInstanceBase<3>;
macro_rules! impl_pio_sm { macro_rules! impl_pio_sm {
($name:ident, $pio:expr) => { ($name:ident, $pio:expr) => {
impl PioPeripheral for peripherals::$name { impl sealed::PioPeripheral for peripherals::$name {
type Pio = PioInstanceBase<$pio>; type Pio = PioInstanceBase<$pio>;
} }
impl PioPeripheral for peripherals::$name {}
}; };
} }