µOS++ IIIe Reference 7.0.0
The third edition of µOS++, a POSIX inspired open source framework, written in C++
Loading...
Searching...
No Matches
os::rtos::clock_highres Class Reference

High Resolution derived clock. More...

#include <cmsis-plus/rtos/os.h>

+ Inheritance diagram for os::rtos::clock_highres:

Public Types

Types & Constants
using duration_t = port::clock::duration_t
 Type of variables holding clock durations.
 
using timestamp_t = port::clock::timestamp_t
 Type of variables holding clock time stamps.
 
using offset_t = port::clock::offset_t
 Type of variables holding clock offsets.
 

Public Member Functions

Constructors & Destructor
 clock_highres ()
 Construct a SysTick clock object instance.
 
virtual ~clock_highres () override
 Destruct the SysTick clock object instance.
 
Public Member Functions
virtual void start (void) override
 
virtual timestamp_t now (void) override
 Tell the current time.
 
uint32_t input_clock_frequency_hz (void)
 
void internal_increment_count (void)
 
Public Member Functions
timestamp_t steady_now (void)
 Tell the current time since startup.
 
result_t sleep_for (duration_t duration)
 Sleep for a relative duration.
 
virtual result_t sleep_until (timestamp_t timestamp)
 Sleep until an absolute timestamp.
 
result_t wait_for (duration_t timeout)
 Timed wait for an event.
 
timestamp_t update_for_slept_time (duration_t duration)
 Increase the internal count after a deep sleep.
 
Public Member Functions
const char * name (void) const
 Get object name.
 

Detailed Description

High Resolution derived clock.

Definition at line 705 of file os-clocks.h.

Constructor & Destructor Documentation

◆ clock_highres()

os::rtos::clock_highres::clock_highres ( )

Construct a SysTick clock object instance.

Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 725 of file os-clocks.cpp.

◆ ~clock_highres()

os::rtos::clock_highres::~clock_highres ( )
overridevirtual

Destruct the SysTick clock object instance.

Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 734 of file os-clocks.cpp.

Member Function Documentation

◆ input_clock_frequency_hz()

uint32_t os::rtos::clock_highres::input_clock_frequency_hz ( void  )
inline

Definition at line 932 of file os-clocks.h.

◆ internal_increment_count()

void os::rtos::clock_highres::internal_increment_count ( void  )
inline

Definition at line 917 of file os-clocks.h.

◆ name()

const char * os::rtos::internal::object_named::name ( void  ) const
inlineinherited

Get object name.

Parameters
None.
Returns
A null terminated string.

All objects return a non-null string; anonymous objects return "-".

Note
Can be invoked from Interrupt Service Routines.

Definition at line 759 of file os-decls.h.

◆ now()

clock::timestamp_t os::rtos::clock_highres::now ( void  )
overridevirtual

Tell the current time.

Parameters
None.
Returns
The number of SysTick input clocks since startup.

Reimplemented from os::rtos::clock.

Definition at line 752 of file os-clocks.cpp.

◆ sleep_for()

result_t os::rtos::clock::sleep_for ( duration_t  duration)
inherited

Sleep for a relative duration.

Parameters
[in]durationThe number of clock units (ticks or seconds) to sleep.
Return values
ETIMEDOUTThe sleep lasted the entire duration.
EPERMCannot be invoked from an Interrupt Service Routines.
EINTRThe sleep was interrupted.
Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 190 of file os-clocks.cpp.

◆ sleep_until()

result_t os::rtos::clock::sleep_until ( timestamp_t  timestamp)
virtualinherited

Sleep until an absolute timestamp.

Parameters
[in]timestampThe absolute moment in time, in clock units.
Return values
ETIMEDOUTThe sleep lasted the entire duration.
EPERMCannot be invoked from an Interrupt Service Routines.
EINTRThe sleep was interrupted.
Warning
Cannot be invoked from Interrupt Service Routines.

Reimplemented in os::rtos::adjustable_clock.

Definition at line 240 of file os-clocks.cpp.

◆ start()

void os::rtos::clock_highres::start ( void  )
overridevirtual
Warning
Cannot be invoked from Interrupt Service Routines.

Implements os::rtos::clock.

Definition at line 742 of file os-clocks.cpp.

◆ steady_now()

clock::timestamp_t os::rtos::clock::steady_now ( void  )
inherited

Tell the current time since startup.

Parameters
None.
Returns
The clock current steady timestamp (time units from startup).
Note
Can be invoked from Interrupt Service Routines.

Definition at line 176 of file os-clocks.cpp.

◆ update_for_slept_time()

clock::timestamp_t os::rtos::clock::update_for_slept_time ( duration_t  duration)
inherited

Increase the internal count after a deep sleep.

Parameters
durationNumber of ticks lost during sleep.
Returns
The clock current steady timestamp (time units from startup).

During deep sleep the interrupts used to count clock ticks are usually disabled and an external RTC is configured to wake-up the device, so a number of clock ticks are lost.

To keep the clocks accurate, it is recommended to sample the external RTC before entering deep sleep and again when the device is back to life, compute the time slept as difference, and use this function to update the internal clock counter.

Definition at line 329 of file os-clocks.cpp.

◆ wait_for()

result_t os::rtos::clock::wait_for ( duration_t  timeout)
inherited

Timed wait for an event.

Parameters
[in]timeoutThe timeout in clock units.
Return values
result::okAn event occurred before the timeout.
ETIMEDOUTThe wait lasted the entire duration.
EPERMCannot be invoked from an Interrupt Service Routines.
EINTRThe sleep was interrupted.
Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 279 of file os-clocks.cpp.


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