Clock Control Driver Backend API

Data Structures
struct	clock_control_driver_api
	Driver Operations Clock Control driver operations More...

Typedefs
typedef int(*	clock_control) (const struct device *dev, clock_control_subsys_t sys)
	Callback API to enable or disable a clock.
typedef int(*	clock_control_get) (const struct device *dev, clock_control_subsys_t sys, uint32_t *rate)
	Callback API to get a clock rate.
typedef int(*	clock_control_async_on_fn) (const struct device *dev, clock_control_subsys_t sys, clock_control_cb_t cb, void *user_data)
	Callback API to start a clock asynchronously.
typedef enum clock_control_status(*	clock_control_get_status_fn) (const struct device *dev, clock_control_subsys_t sys)
	Callback API to get a clock status.
typedef int(*	clock_control_set) (const struct device *dev, clock_control_subsys_t sys, clock_control_subsys_rate_t rate)
	Callback API to set a clock rate.
typedef int(*	clock_control_configure_fn) (const struct device *dev, clock_control_subsys_t sys, void *data)
	Callback API to configure a clock.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Clock Control driver.

Typedef Documentation

clock_control

typedef int(* clock_control) (const struct device *dev, clock_control_subsys_t sys)

#include <zephyr/drivers/clock_control.h>

Callback API to enable or disable a clock.

See clock_control_on() and clock_control_off() for argument description.

clock_control_async_on_fn

typedef int(* clock_control_async_on_fn) (const struct device *dev, clock_control_subsys_t sys, clock_control_cb_t cb, void *user_data)

#include <zephyr/drivers/clock_control.h>

Callback API to start a clock asynchronously.

See clock_control_async_on() for argument description.

clock_control_configure_fn

typedef int(* clock_control_configure_fn) (const struct device *dev, clock_control_subsys_t sys, void *data)

#include <zephyr/drivers/clock_control.h>

Callback API to configure a clock.

See clock_control_configure() for argument description.

clock_control_get

typedef int(* clock_control_get) (const struct device *dev, clock_control_subsys_t sys, uint32_t *rate)

#include <zephyr/drivers/clock_control.h>

Callback API to get a clock rate.

See clock_control_get_rate() for argument description.

clock_control_get_status_fn

typedef enum clock_control_status(* clock_control_get_status_fn) (const struct device *dev, clock_control_subsys_t sys)

#include <zephyr/drivers/clock_control.h>

Callback API to get a clock status.

See clock_control_get_status() for argument description.

clock_control_set

typedef int(* clock_control_set) (const struct device *dev, clock_control_subsys_t sys, clock_control_subsys_rate_t rate)

#include <zephyr/drivers/clock_control.h>

Callback API to set a clock rate.

See clock_control_set_rate() for argument description.