LibXR::Timebase Class Reference

时间基类，用于提供高精度时间戳。 Timebase class for providing high-precision timestamps. More...

#include <timebase.hpp>

Inheritance diagram for LibXR::Timebase:

Public Member Functions
	Timebase ()=default
	默认构造函数。 Default constructor.
	Timebase (const Timebase &)=delete
	禁止拷贝构造。 Copy construction is disabled.
Timebase &	operator= (const Timebase &)=delete
	禁止拷贝赋值。 Copy assignment is disabled.

Static Public Member Functions
static MicrosecondTimestamp	GetMicroseconds ()
	获取当前时间的微秒级时间戳。 Gets the current timestamp in microseconds.
static MillisecondTimestamp	GetMilliseconds ()
	获取当前时间的毫秒级时间戳。 Gets the current timestamp in milliseconds.
static bool	IsReady () noexcept
	检查时间基是否已经初始化。 Check whether the active timebase backend is initialized.
static void	DelayMicroseconds (uint32_t us)
	微秒级延时 / Delay in microseconds

Static Protected Member Functions
static void	SetReady (bool ready=true) noexcept
	设置时间基就绪状态。 Set the timebase ready flag.
static void	ConfigureWrapRange (uint64_t max_valid_us, uint32_t max_valid_ms) noexcept
	配置时间戳回绕上界。 Configure the timestamp wraparound limits.
static uint64_t	GetConfiguredWrapRangeUs () noexcept
	读取当前配置的微秒回绕上界。 Read the configured microsecond wraparound limit.
static uint32_t	GetConfiguredWrapRangeMs () noexcept
	读取当前配置的毫秒回绕上界。 Read the configured millisecond wraparound limit.

Static Private Attributes
static bool	ready_ = false
	时间基是否已完成初始化。 Whether the timebase backend has been initialized.

Detailed Description

时间基类，用于提供高精度时间戳。 Timebase class for providing high-precision timestamps.

该类提供了微秒和毫秒级的时间戳获取接口。 This class provides interfaces for obtaining timestamps in microseconds and milliseconds.

Definition at line 16 of file timebase.hpp.

Member Function Documentation

ConfigureWrapRange()

static void LibXR::Timebase::ConfigureWrapRange ( uint64_t max_valid_us, uint32_t max_valid_ms )

inlinestaticprotectednoexcept

配置时间戳回绕上界。 Configure the timestamp wraparound limits.

Parameters

max_valid_us	微秒时间戳的有效上界。 Maximum valid microsecond timestamp value.
max_valid_ms	毫秒时间戳的有效上界。 Maximum valid millisecond timestamp value.

Definition at line 95 of file timebase.hpp.

  {
    Detail::ConfigureTimebaseWrapRange(max_valid_us, max_valid_ms);
  }

DelayMicroseconds()

static void LibXR::Timebase::DelayMicroseconds ( uint32_t us )

inlinestatic

微秒级延时 / Delay in microseconds

Parameters

us	延时长度（us）/ Delay length (us)

Definition at line 65 of file timebase.hpp.

  {
    if (us == 0u)
    {
      return;
    }
 
    const uint64_t START = static_cast<uint64_t>(Timebase::GetMicroseconds());
    while ((static_cast<uint64_t>(Timebase::GetMicroseconds()) - START) < us)
    {
      // busy-wait
    }
  }

GetConfiguredWrapRangeMs()

static uint32_t LibXR::Timebase::GetConfiguredWrapRangeMs ( )

inlinestaticnodiscardprotectednoexcept

读取当前配置的毫秒回绕上界。 Read the configured millisecond wraparound limit.

Definition at line 113 of file timebase.hpp.

  {
    return Detail::TimebaseMaxValidMs();
  }

GetConfiguredWrapRangeUs()

static uint64_t LibXR::Timebase::GetConfiguredWrapRangeUs ( )

inlinestaticnodiscardprotectednoexcept

读取当前配置的微秒回绕上界。 Read the configured microsecond wraparound limit.

Definition at line 104 of file timebase.hpp.

  {
    return Detail::TimebaseMaxValidUs();
  }

GetMicroseconds()

MicrosecondTimestamp LibXR::Timebase::GetMicroseconds ( )

static

获取当前时间的微秒级时间戳。 Gets the current timestamp in microseconds.

Returns

返回当前的时间戳（单位：微秒）。 Returns the current timestamp (in microseconds).

Definition at line 12 of file ch32_timebase.cpp.

{
  do
  {
    uint32_t tick_old = CH32Timebase::sys_tick_ms_;
    uint32_t cnt_old = SysTick->CNT;
    uint32_t tick_new = CH32Timebase::sys_tick_ms_;
    uint32_t cnt_new = SysTick->CNT;
 
    auto tick_diff = tick_new - tick_old;
    uint32_t tick_cmp = SysTick->CMP + 1;
    switch (tick_diff)
    {
      case 0:
        return MicrosecondTimestamp(static_cast<uint64_t>(tick_new) * 1000 +
                                    static_cast<uint64_t>(cnt_old) * 1000 / tick_cmp);
      case 1:
        /* 中断发生在两次读取之间 / Interrupt happened between two reads */
        return MicrosecondTimestamp(static_cast<uint64_t>(tick_new) * 1000 +
                                    static_cast<uint64_t>(cnt_new) * 1000 / tick_cmp);
      default:
        /* 中断耗时过长（超过1ms），程序异常 / Indicates that interrupt took more
         * than 1ms, an error case */
        continue;
    }
  } while (true);
}

GetMilliseconds()

MillisecondTimestamp LibXR::Timebase::GetMilliseconds ( )

static

获取当前时间的毫秒级时间戳。 Gets the current timestamp in milliseconds.

Returns

返回当前的时间戳（单位：毫秒）。 Returns the current timestamp (in milliseconds).

Definition at line 40 of file ch32_timebase.cpp.

{ return CH32Timebase::sys_tick_ms_; }

IsReady()

static bool LibXR::Timebase::IsReady ( )

inlinestaticnodiscardnoexcept

检查时间基是否已经初始化。 Check whether the active timebase backend is initialized.

Definition at line 59 of file timebase.hpp.

{ return ready_; }

SetReady()

static void LibXR::Timebase::SetReady ( bool ready = true )

inlinestaticprotectednoexcept

设置时间基就绪状态。 Set the timebase ready flag.

Parameters

ready

是否就绪。Whether the backend is ready.

Definition at line 85 of file timebase.hpp.

{ ready_ = ready; }

Field Documentation

ready_

bool LibXR::Timebase::ready_ = false

inlinestaticprivate

时间基是否已完成初始化。 Whether the timebase backend has been initialized.

Definition at line 123 of file timebase.hpp.

---

The documentation for this class was generated from the following files:

• src/driver/timebase.hpp
• driver/ch/ch32_timebase.cpp
• driver/esp/esp_timebase.cpp
• driver/hpm/hpm_timebase.cpp
• driver/linux/linux_timebase.cpp
• driver/mspm0/mspm0_timebase.cpp
• driver/st/stm32_timebase.cpp
• driver/webasm/webasm_timebase.cpp
• driver/webots/webots_timebase.cpp