SYS/BIOS  7.00
Data Fields
Clock_Params Struct Reference

#include <ti/sysbios/knl/Clock.h>

Data Fields

bool startFlag
 Start immediately after instance is created. More...
 
uint32_t period
 Period of this instance (in clock ticks) More...
 
uintptr_t arg
 Uninterpreted argument passed to instance function. More...
 

Field Documentation

§ startFlag

bool Clock_Params::startFlag

Start immediately after instance is created.

When this flag is set to false, the user will have to call Clock_start() to start the instance.

When set to true, both statically created Clock objects and Clock objects created in main() are started at the end of main() when the user calls BIOS_start(). Dynamically created Clock objects created after main() (ie within a task) will be started immediately.

The default setting for this parameter is false.

The configured Clock function will be called initially after an interval equal to the 'timeout' argument for both one-shot and periodic Clock objects.

Periodic Clock objects will subsequently be called at the rate specified by the Clock_tickPeriod parameter.

§ period

uint32_t Clock_Params::period

Period of this instance (in clock ticks)

This parameter is used to set the subsequent timeout interval (in Clock ticks) for periodic instances.

The default value of this parameter is 0, which indicates this is a one- shot Clock object.

A non zero value for this parameter specifies that the Clock object is to be called periodically, and also specifies the rate (in Clock ticks) that the Clock function will be called AFTER the initial 'timeout' argument period.

For one-shot Clock instances, this parameter must be set to zero.

§ arg

uintptr_t Clock_Params::arg

Uninterpreted argument passed to instance function.

The default is null.


The documentation for this struct was generated from the following file:
© Copyright 1995-2022, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale