CLOCK_MONITOR Driver Backend API

Data Structures
struct	clock_monitor_driver_api
	Driver Operations CLOCK_MONITOR driver operations More...

Typedefs
typedef int(*	clock_monitor_api_configure) (const struct device *dev, const struct clock_monitor_config *cfg)
	Callback API for configuring a clock monitor.
typedef int(*	clock_monitor_api_start) (const struct device *dev)
	Callback API for starting the configured mode.
typedef int(*	clock_monitor_api_stop) (const struct device *dev)
	Callback API for stopping the clock monitor (ISR-safe).
typedef int(*	clock_monitor_api_get_rate) (const struct device *dev, uint32_t *rate_hz)
	Callback API for polling the most recent measured rate.
typedef int(*	clock_monitor_api_set_source) (const struct device *dev, uint32_t reference, uint32_t target)
	Callback API for switching the reference / target clock inputs.

Detailed Description

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

Typedef Documentation

clock_monitor_api_configure

typedef int(* clock_monitor_api_configure) (const struct device *dev, const struct clock_monitor_config *cfg)

#include <zephyr/drivers/clock_monitor.h>

Callback API for configuring a clock monitor.

clock_monitor_api_get_rate

typedef int(* clock_monitor_api_get_rate) (const struct device *dev, uint32_t *rate_hz)

#include <zephyr/drivers/clock_monitor.h>

Callback API for polling the most recent measured rate.

clock_monitor_api_set_source

typedef int(* clock_monitor_api_set_source) (const struct device *dev, uint32_t reference, uint32_t target)

#include <zephyr/drivers/clock_monitor.h>

Callback API for switching the reference / target clock inputs.

clock_monitor_api_start

typedef int(* clock_monitor_api_start) (const struct device *dev)

#include <zephyr/drivers/clock_monitor.h>

Callback API for starting the configured mode.

clock_monitor_api_stop

typedef int(* clock_monitor_api_stop) (const struct device *dev)

#include <zephyr/drivers/clock_monitor.h>

Callback API for stopping the clock monitor (ISR-safe).