XCORE SDK
XCORE Software Development Kit
Modules | Classes | Typedefs | Functions
rtos_clock_control_driver

Modules

 rtos_clock_control_driver_core
 
 rtos_clock_control_driver_rpc
 

Classes

struct  rtos_clock_control_struct
 

Typedefs

typedef struct rtos_clock_control_struct rtos_clock_control_t
 

Functions

void rtos_clock_control_start (rtos_clock_control_t *ctx)
 
void rtos_clock_control_init (rtos_clock_control_t *ctx)
 

Detailed Description

The public API for using the RTOS clock control driver.

Typedef Documentation

◆ rtos_clock_control_t

Typedef to the RTOS Clock Control driver instance struct.

Function Documentation

◆ rtos_clock_control_init()

void rtos_clock_control_init ( rtos_clock_control_t ctx)

Initializes an RTOS clock control driver instance. There should only be one per tile. This must only be called by the tile that owns the driver instance. It may be called either before or after starting the RTOS, but must be called before calling rtos_clock_control_start() or any of the core clock control driver functions with this instance.

Parameters
ctxA pointer to the GPIO driver instance to initialize.

◆ rtos_clock_control_start()

void rtos_clock_control_start ( rtos_clock_control_t ctx)

Starts an RTOS clock control driver instance. This must only be called by the tile that owns the driver instance. It may be called either before or after starting the RTOS, but must be called before any of the core clock control driver functions are called with this instance.

rtos_clock_control_init() must be called on this clock control driver instance prior to calling this.

Parameters
ctxA pointer to the clock control driver instance to start.