AM65x MCU+ SDK  09.01.00
ClockP.h File Reference

Go to the source code of this file.

Data Structures

struct  ClockP_Object
 Opaque clock object used with the clock APIs. More...
 
struct  ClockP_Config
 ClockP module config, set as part of SysConfig, not to be set by end-users directly. More...
 
struct  ClockP_Params
 Parameters passed during ClockP_construct. More...
 

Macros

#define ClockP_OBJECT_SIZE_MAX   (104u)
 Max size of clock object across no-RTOS and all OS's. More...
 

Typedefs

typedef void(* ClockP_FxnCallback) (ClockP_Object *obj, void *args)
 Callback that is called when the clock expires. More...
 

Functions

void ClockP_init (void)
 Initialize the clock module. More...
 
void ClockP_Params_init (ClockP_Params *params)
 Set default values to ClockP_Params. More...
 
int32_t ClockP_construct (ClockP_Object *obj, ClockP_Params *params)
 Create a clock object. More...
 
void ClockP_destruct (ClockP_Object *obj)
 Cleanup, delete, destruct a clock object. More...
 
void ClockP_start (ClockP_Object *obj)
 Start the clock, if not already started. More...
 
void ClockP_stop (ClockP_Object *obj)
 Stop the clock, if not already stopped. No effect if clock is already stopped. More...
 
uint32_t ClockP_isActive (ClockP_Object *obj)
 Check if clock is active i.e not expired. More...
 
void ClockP_setTimeout (ClockP_Object *obj, uint32_t timeout)
 Set clock timeout value, takes effect for next clock start. More...
 
uint32_t ClockP_getTimeout (ClockP_Object *obj)
 Get current remaining time in units of ticks. More...
 
uint32_t ClockP_getTicks (void)
 Get current clock ticks. More...
 
uint32_t ClockP_usecToTicks (uint64_t usecs)
 Convert usecs to clock ticks. More...
 
uint64_t ClockP_ticksToUsec (uint32_t ticks)
 Convert clock ticks to usecs. More...
 
uint64_t ClockP_getTimeUsec (void)
 Get current time in units of usecs. More...
 
void ClockP_usleep (uint32_t usec)
 Sleep for user specified usecs. More...
 
void ClockP_sleep (uint32_t sec)
 Sleep for user specified seconds. More...