embedded-registers 0.9.13

Procedural macro for effortless definitions of registers in embedded device drivers
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

use crate::{ReadableRegister, WritableRegister};

/// A codec that represents absense of a codec. This has two main usecases:
///
/// Firstly, if this is used as the default codec for a device, it essentially
/// requires any associated register to explicitly specify a codec. Otherwise
/// accessing that register via the [`RegisterInterfaceSync`](crate::RegisterInterfaceSync)
/// or [`RegisterInterfaceAsync`](crate::RegisterInterfaceAsync) trait will cause a panic.
///
/// Secondly, specifying this codec as the default for a register will cause
/// any reads or writes to that register via the [`RegisterInterfaceSync`](crate::RegisterInterfaceSync)
/// or [`RegisterInterfaceAsync`](crate::RegisterInterfaceAsync) traits to be performed
/// to be performed through the default codec of the device.
pub struct NoCodec {}

#[maybe_async_cfg::maybe(
    idents(hal(sync = "embedded_hal", async = "embedded_hal_async"), Codec),
    sync(feature = "sync"),
    async(feature = "async"),
    keep_self
)]
impl crate::spi::Codec for NoCodec {
    #[inline]
    async fn read_register<R, I>(_interface: &mut I) -> Result<R, I::Error>
    where
        R: ReadableRegister,
        I: hal::spi::r#SpiDevice,
    {
        panic!("spi::codecs::NoCodec cannot be used at runtime! Please specify a real codec to access this register.");
    }

    #[inline]
    async fn write_register<R, I>(_interface: &mut I, _register: impl AsRef<R>) -> Result<(), I::Error>
    where
        R: WritableRegister,
        I: hal::spi::r#SpiDevice,
    {
        panic!("spi::codecs::NoCodec cannot be used at runtime! Please specify a real codec to access this register.");
    }
}