Struct LiteXLed

pub struct LiteXLed<'a, R>
where
    R: LiteXSoCRegisterConfiguration,
{ /* private fields */ }

Single LED of a LiteXLedController

Can be obtained by calling LiteXLedController::get_led.

Only one LiteXLed instance may exist per LED. To deregister this instance, call LiteXLed::destroy (or drop it).

Implementations

impl<'a, R> LiteXLed<'a, R>

where R: LiteXSoCRegisterConfiguration,

pub fn index(&self) -> usize

Index of this LED in the LiteXLedController LED array

pub fn controller(&self) -> &'a LiteXLedController<R>

Returns a reference to the LiteXLedController of this LED

pub fn destroy(self)

Destroy (deregister & consume) the LiteXLed

Trait Implementations

impl<R> Drop for LiteXLed<'_, R>

where R: LiteXSoCRegisterConfiguration,

fn drop(&mut self)

Deregister the LED with the controller

impl<R> Led for LiteXLed<'_, R>

where R: LiteXSoCRegisterConfiguration,

fn init(&self)

Initialize the LED. Must be called before the LED is used.

fn on(&self)

Turn the LED on.

fn off(&self)

Turn the LED off.

fn toggle(&self)

Toggle the LED.

fn read(&self) -> bool

Return the on/off state of the LED. true if the LED is on, false if it is off.