Struct LiteXTimerUptime

pub struct LiteXTimerUptime<'t, R: LiteXSoCRegisterConfiguration, F: Frequency> { /* private fields */ }

LiteX hardware timer core uptime extension

Defined in litex/soc/cores/timer.py.

This hardware peripheral can optionally feature an uptime register, which counts the current ticks since power on. This wrapper can be used to provide users a safe way to access this register through the Time::now interface, if it is available in hardware.

Implementations

impl<'t, R: LiteXSoCRegisterConfiguration, F: Frequency> LiteXTimerUptime<'t, R, F>

pub const unsafe fn new( timer: &'t LiteXTimer<'t, R, F>, ) -> LiteXTimerUptime<'t, R, F>

Contruct a new LiteXTimerUptime wrapper

The function is marked unsafe as it will provide a safe method to access the uptime-register on the underlying LiteXTimer. If this register is not present (i.e. the uptime feature is disabled), this will result in undefined behavior.

Trait Implementations

impl<R: LiteXSoCRegisterConfiguration, F: Frequency> Time for LiteXTimerUptime<'_, R, F>

fn now(&self) -> Self::Ticks

Return the current ticks since sytem power on

type Frequency = F

The number of ticks per second

type Ticks = Ticks64

The width of a time value