Skip to main content

Aw88298

Struct Aw88298

pub struct Aw88298<I2C> { /* private fields */ }

Expand description

AW88298 speaker amplifier I²C control driver.

Implementations§

impl<I2C> Aw88298<I2C>

pub const fn new(i2c: I2C) -> Self

Create an AW88298 driver using the CoreS3 amplifier I²C address.

pub fn release(self) -> I2C

Release the underlying I²C bus/device.

impl<I2C, Error> Aw88298<I2C>
where I2C: I2c<Error = Error>,

pub fn init(&mut self, config: SpeakerConfig) -> Result<(), Error>

Apply the CoreS3 AW88298 speaker amplifier sequence used by M5Unified.

The CoreS3 speaker path clocks the amplifier from BCK/WS/DOUT. The helper selects the AW88298 sample-rate bucket from SpeakerConfig::format and enables I²S input, unmutes the high-level path, disables boost mode, and applies a clamped volume value.

pub fn set_enabled(&mut self, enabled: bool) -> Result<(), Error>

Enable or disable the CoreS3 amplifier output path.

pub fn set_volume(&mut self, volume: u8) -> Result<(), Error>

Set the CoreS3 amplifier volume register value.

pub fn read_register16(&mut self, register: u8) -> Result<u16, Error>

Read one 16-bit AW88298 register.

pub fn write_register16( &mut self, register: u8, value: u16, ) -> Result<(), Error>

Write one 16-bit AW88298 register.

Auto Trait Implementations§

impl<I2C> Freeze for Aw88298<I2C>
where I2C: Freeze,

impl<I2C> RefUnwindSafe for Aw88298<I2C>
where I2C: RefUnwindSafe,

impl<I2C> Send for Aw88298<I2C>
where I2C: Send,

impl<I2C> Sync for Aw88298<I2C>
where I2C: Sync,

impl<I2C> Unpin for Aw88298<I2C>
where I2C: Unpin,

impl<I2C> UnsafeUnpin for Aw88298<I2C>
where I2C: UnsafeUnpin,

impl<I2C> UnwindSafe for Aw88298<I2C>
where I2C: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.