Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
clock_monitor_driver_api Struct Reference

Driver Operations CLOCK_MONITOR driver operations More...

#include <zephyr/drivers/clock_monitor.h>

Data Fields

clock_monitor_api_configure configure
  REQ Apply a monitor configuration.
clock_monitor_api_start start
  REQ Start operation of the configured mode.
clock_monitor_api_stop stop
  REQ Stop the monitor.
clock_monitor_api_get_rate get_rate
  OPT Poll the most recent completed measurement.
clock_monitor_api_set_source set_source
  OPT Switch the reference / target clock inputs at runtime.

Detailed Description

Driver Operations CLOCK_MONITOR driver operations

This is the driver API structure any CLOCK_MONITOR 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

◆ configure

clock_monitor_api_configure clock_monitor_driver_api::configure

REQ Apply a monitor configuration.

◆ get_rate

clock_monitor_api_get_rate clock_monitor_driver_api::get_rate

OPT Poll the most recent completed measurement.

◆ set_source

clock_monitor_api_set_source clock_monitor_driver_api::set_source

OPT Switch the reference / target clock inputs at runtime.

◆ start

clock_monitor_api_start clock_monitor_driver_api::start

REQ Start operation of the configured mode.

◆ stop

clock_monitor_api_stop clock_monitor_driver_api::stop

REQ Stop the monitor.


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