SuperTinyKernel™ RTOS 1.05.3
Lightweight, high-performance, deterministic, bare-metal C++ RTOS for resource-constrained embedded systems. MIT Open Source License.
Loading...
Searching...
No Matches
stk::time::TimerHost::TimerCommand Struct Reference
Collaboration diagram for stk::time::TimerHost::TimerCommand:

Public Types

enum  EId : uint8_t {
  CMD_SHUTDOWN = 0 ,
  CMD_START ,
  CMD_STOP ,
  CMD_RESET ,
  CMD_RESTART ,
  CMD_START_OR_RESET ,
  CMD_SET_PERIOD
}

Public Attributes

EId cmd
 command id
Timertimer
 timer instance
Ticks timestamp
 hw tick count captured at call site
uint32_t delay
 initial delay ticks (CMD_START / CMD_RESTART / CMD_START_OR_RESET)
uint32_t period
 reload period ticks (CMD_START / CMD_RESTART / CMD_START_OR_RESET / CMD_SET_PERIOD)

Detailed Description

Definition at line 326 of file stk_time_timer.h.

Member Enumeration Documentation

◆ EId

Enumerator
CMD_SHUTDOWN 

shutdown timer host

CMD_START 

start timer

CMD_STOP 

stop timer

CMD_RESET 

reset timer

CMD_RESTART 

atomic stop + re-start

CMD_START_OR_RESET 

start if inactive, reset deadline if active and periodic

CMD_SET_PERIOD 

change period of a running periodic timer

Definition at line 328 of file stk_time_timer.h.

329 {
330 CMD_SHUTDOWN = 0,
331 CMD_START,
332 CMD_STOP,
333 CMD_RESET,
337 };
@ CMD_SET_PERIOD
change period of a running periodic timer
@ CMD_START_OR_RESET
start if inactive, reset deadline if active and periodic
@ CMD_RESTART
atomic stop + re-start

Member Data Documentation

◆ cmd

EId stk::time::TimerHost::TimerCommand::cmd

command id

Definition at line 339 of file stk_time_timer.h.

Referenced by stk::time::TimerHost::ProcessCommands().

◆ delay

uint32_t stk::time::TimerHost::TimerCommand::delay

initial delay ticks (CMD_START / CMD_RESTART / CMD_START_OR_RESET)

Definition at line 342 of file stk_time_timer.h.

Referenced by stk::time::TimerHost::ProcessCommands().

◆ period

uint32_t stk::time::TimerHost::TimerCommand::period

reload period ticks (CMD_START / CMD_RESTART / CMD_START_OR_RESET / CMD_SET_PERIOD)

Definition at line 343 of file stk_time_timer.h.

Referenced by stk::time::TimerHost::ProcessCommands().

◆ timer

Timer* stk::time::TimerHost::TimerCommand::timer

timer instance

Definition at line 340 of file stk_time_timer.h.

Referenced by stk::time::TimerHost::ProcessCommands().

◆ timestamp

Ticks stk::time::TimerHost::TimerCommand::timestamp

hw tick count captured at call site

Definition at line 341 of file stk_time_timer.h.

Referenced by stk::time::TimerHost::ProcessCommands().


The documentation for this struct was generated from the following file: