Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
void  OSTimeSet (OS_TICK  ticks,
                 OS_ERR  *p_err)

File

Called from

Code enabled by

os_time.c

Task or ISR

N/A

...

Description

Sets the system clock. The system clock (OSTickCtr) is a counter, which has a data type of OS_TICK, and it counts the number of clock ticks since power was applied, or since the system clock was last set.

Files

os.h/os_time.c

Prototype

Arguments

ticks

is the desired value for the system clock, in ticks.

...

If the call was successful.

Returned Value

None

Required Configuration

None

Callers

Application and ISRs.

Notes/Warnings

  1. You should be careful when using this function because other tasks may depend on the current value of the tick counter (OSTickCtr). Specifically, a task may delay itself (see OSTimeDly() and specify to wake up when OSTickCtr reaches a specific value.

Example Usage