Clk_SignalClk()

Signal the clock task when one second has elapsed in order to increment the Clock module’s tick counter.

Files

clk.h/clk.c

Prototype

void  Clk_SignalClk (CLK_ERR  *p_err);

Arguments

p_err

Pointer to variable that will receive the return error code from this function: 

CLK_ERR_NONE
CLK_ERR_NOT_INIT
CLK_OS_ERR_SIGNAL

Returned Values

None.

Required Configuration

When CLK_CFG_EXT_EN is DEF_DISABLED and CLK_CFG_SIGNAL_EN is DEF_ENABLED in clk_cfg.h (see section 3-1-1 Module Configuration), this function must be periodically called by application/BSP functions in order to increment the internal clock ticker. CLK_CFG_SIGNAL_FREQ_HZ must be configured to the number of times this function gets called every second.

Notes / Warnings

None.

Example Usage

CLK_ERR  err;
 
Clk_SignalClk(&err);
if (err != CLK_ERR_NONE) {
    printf("Clock module timestamp tick signal error");
}