Merge pull request #2731 from embassy-rs/sealed4

use private_bounds for sealed traits.
This commit is contained in:
Dario Nieuwenhuis 2024-03-23 01:55:13 +01:00 committed by GitHub
commit 2fd6f0e718
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 44 additions and 59 deletions

View File

@ -30,14 +30,12 @@ macro_rules! interrupt_mod {
pub mod typelevel { pub mod typelevel {
use super::InterruptExt; use super::InterruptExt;
mod sealed { trait SealedInterrupt {}
pub trait Interrupt {}
}
/// Type-level interrupt. /// Type-level interrupt.
/// ///
/// This trait is implemented for all typelevel interrupt types in this module. /// This trait is implemented for all typelevel interrupt types in this module.
pub trait Interrupt: sealed::Interrupt { pub trait Interrupt: SealedInterrupt {
/// Interrupt enum variant. /// Interrupt enum variant.
/// ///
@ -105,7 +103,7 @@ macro_rules! interrupt_mod {
#[doc=stringify!($irqs)] #[doc=stringify!($irqs)]
#[doc=" typelevel interrupt."] #[doc=" typelevel interrupt."]
pub enum $irqs {} pub enum $irqs {}
impl sealed::Interrupt for $irqs{} impl SealedInterrupt for $irqs{}
impl Interrupt for $irqs { impl Interrupt for $irqs {
const IRQ: super::Interrupt = super::Interrupt::$irqs; const IRQ: super::Interrupt = super::Interrupt::$irqs;
} }

View File

@ -2,49 +2,40 @@
mod w5500; mod w5500;
pub use w5500::W5500; pub use w5500::W5500;
mod w5100s; mod w5100s;
use embedded_hal_async::spi::SpiDevice;
pub use w5100s::W5100S; pub use w5100s::W5100S;
pub(crate) mod sealed { pub(crate) trait SealedChip {
use embedded_hal_async::spi::SpiDevice; type Address;
pub trait Chip { const COMMON_MODE: Self::Address;
type Address; const COMMON_MAC: Self::Address;
const COMMON_SOCKET_INTR: Self::Address;
const COMMON_PHY_CFG: Self::Address;
const SOCKET_MODE: Self::Address;
const SOCKET_COMMAND: Self::Address;
const SOCKET_RXBUF_SIZE: Self::Address;
const SOCKET_TXBUF_SIZE: Self::Address;
const SOCKET_TX_FREE_SIZE: Self::Address;
const SOCKET_TX_DATA_WRITE_PTR: Self::Address;
const SOCKET_RECVD_SIZE: Self::Address;
const SOCKET_RX_DATA_READ_PTR: Self::Address;
const SOCKET_INTR_MASK: Self::Address;
const SOCKET_INTR: Self::Address;
const COMMON_MODE: Self::Address; const SOCKET_MODE_VALUE: u8;
const COMMON_MAC: Self::Address;
const COMMON_SOCKET_INTR: Self::Address;
const COMMON_PHY_CFG: Self::Address;
const SOCKET_MODE: Self::Address;
const SOCKET_COMMAND: Self::Address;
const SOCKET_RXBUF_SIZE: Self::Address;
const SOCKET_TXBUF_SIZE: Self::Address;
const SOCKET_TX_FREE_SIZE: Self::Address;
const SOCKET_TX_DATA_WRITE_PTR: Self::Address;
const SOCKET_RECVD_SIZE: Self::Address;
const SOCKET_RX_DATA_READ_PTR: Self::Address;
const SOCKET_INTR_MASK: Self::Address;
const SOCKET_INTR: Self::Address;
const SOCKET_MODE_VALUE: u8; const BUF_SIZE: u16;
const AUTO_WRAP: bool;
const BUF_SIZE: u16; fn rx_addr(addr: u16) -> Self::Address;
const AUTO_WRAP: bool; fn tx_addr(addr: u16) -> Self::Address;
fn rx_addr(addr: u16) -> Self::Address; async fn bus_read<SPI: SpiDevice>(spi: &mut SPI, address: Self::Address, data: &mut [u8])
fn tx_addr(addr: u16) -> Self::Address; -> Result<(), SPI::Error>;
async fn bus_write<SPI: SpiDevice>(spi: &mut SPI, address: Self::Address, data: &[u8]) -> Result<(), SPI::Error>;
async fn bus_read<SPI: SpiDevice>(
spi: &mut SPI,
address: Self::Address,
data: &mut [u8],
) -> Result<(), SPI::Error>;
async fn bus_write<SPI: SpiDevice>(
spi: &mut SPI,
address: Self::Address,
data: &[u8],
) -> Result<(), SPI::Error>;
}
} }
/// Trait for Wiznet chips. /// Trait for Wiznet chips.
pub trait Chip: sealed::Chip {} #[allow(private_bounds)]
pub trait Chip: SealedChip {}

View File

@ -8,7 +8,7 @@ const RX_BASE: u16 = 0x6000;
pub enum W5100S {} pub enum W5100S {}
impl super::Chip for W5100S {} impl super::Chip for W5100S {}
impl super::sealed::Chip for W5100S { impl super::SealedChip for W5100S {
type Address = u16; type Address = u16;
const COMMON_MODE: Self::Address = 0x00; const COMMON_MODE: Self::Address = 0x00;

View File

@ -12,7 +12,7 @@ pub enum RegisterBlock {
pub enum W5500 {} pub enum W5500 {}
impl super::Chip for W5500 {} impl super::Chip for W5500 {}
impl super::sealed::Chip for W5500 { impl super::SealedChip for W5500 {
type Address = (RegisterBlock, u16); type Address = (RegisterBlock, u16);
const COMMON_MODE: Self::Address = (RegisterBlock::Common, 0x00); const COMMON_MODE: Self::Address = (RegisterBlock::Common, 0x00);

View File

@ -226,27 +226,21 @@ pub mod windows_version {
pub const WIN10: u32 = 0x0A000000; pub const WIN10: u32 = 0x0A000000;
} }
mod sealed { /// A trait for descriptors
use core::mem::size_of; trait Descriptor: Sized {
const TYPE: DescriptorType;
/// A trait for descriptors /// The size of the descriptor's header.
pub trait Descriptor: Sized { fn size(&self) -> usize {
const TYPE: super::DescriptorType; size_of::<Self>()
/// The size of the descriptor's header.
fn size(&self) -> usize {
size_of::<Self>()
}
fn write_to(&self, buf: &mut [u8]);
} }
pub trait DescriptorSet: Descriptor { fn write_to(&self, buf: &mut [u8]);
const LENGTH_OFFSET: usize;
}
} }
use sealed::*; trait DescriptorSet: Descriptor {
const LENGTH_OFFSET: usize;
}
/// Copies the data of `t` into `buf`. /// Copies the data of `t` into `buf`.
/// ///
@ -412,9 +406,11 @@ impl DescriptorSet for FunctionSubsetHeader {
// Feature Descriptors // Feature Descriptors
/// A marker trait for feature descriptors that are valid at the device level. /// A marker trait for feature descriptors that are valid at the device level.
#[allow(private_bounds)]
pub trait DeviceLevelDescriptor: Descriptor {} pub trait DeviceLevelDescriptor: Descriptor {}
/// A marker trait for feature descriptors that are valid at the function level. /// A marker trait for feature descriptors that are valid at the function level.
#[allow(private_bounds)]
pub trait FunctionLevelDescriptor: Descriptor {} pub trait FunctionLevelDescriptor: Descriptor {}
/// Table 13. Microsoft OS 2.0 compatible ID descriptor. /// Table 13. Microsoft OS 2.0 compatible ID descriptor.