clock_control_driver_api Struct Reference

Driver Operations Clock Control driver operations More...

#include <zephyr/drivers/clock_control.h>

Data Fields
clock_control	on
	OPT Enable a clock controlled by the device.
clock_control	off
	OPT Disable a clock controlled by the device.
clock_control_async_on_fn	async_on
	OPT Request clock to start with notification when clock has been started.
clock_control_get	get_rate
	OPT Obtain the clock rate of given sub-system.
clock_control_get_status_fn	get_status
	OPT Get clock status.
clock_control_set	set_rate
	OPT Set the rate of the clock controlled by the device.
clock_control_configure_fn	configure
	OPT Configure a source clock.

Detailed Description

Driver Operations Clock Control driver operations

This is the driver API structure any Clock Control driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also

DEVICE_DT_INST_DEFINE()

DEVICE_DT_DEFINE()

DEVICE_API()

Field Documentation

async_on

clock_control_async_on_fn clock_control_driver_api::async_on

OPT Request clock to start with notification when clock has been started.

configure

clock_control_configure_fn clock_control_driver_api::configure

OPT Configure a source clock.

get_rate

clock_control_get clock_control_driver_api::get_rate

OPT Obtain the clock rate of given sub-system.

get_status

clock_control_get_status_fn clock_control_driver_api::get_status

OPT Get clock status.

off

clock_control clock_control_driver_api::off

OPT Disable a clock controlled by the device.

on

clock_control clock_control_driver_api::on

OPT Enable a clock controlled by the device.

set_rate

clock_control_set clock_control_driver_api::set_rate

OPT Set the rate of the clock controlled by the device.

---

The documentation for this struct was generated from the following file:

• zephyr/drivers/clock_control.h