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

Top-level configuration handed to clock_monitor_configure. More...

#include <zephyr/drivers/clock_monitor.h>

Data Fields

enum clock_monitor_mode mode
 Operating mode to activate.
union { 
   struct clock_monitor_window_cfg   window 
 Honored when mode is WINDOW. More...
   struct clock_monitor_measure_cfg   measure 
 Honored when mode is MEASURE. More...
}; 
 Per-mode parameters; selected by mode.
clock_monitor_callback_t callback
 Optional callback for asynchronous event delivery.
void * user_data
 Opaque user pointer passed to callback.

Detailed Description

Top-level configuration handed to clock_monitor_configure.

The callback (plus its user_data) is installed atomically with the rest of the configuration and is the only event delivery path. Passing callback = NULL disables event delivery; in MEASURE mode the most recent result remains retrievable by polling clock_monitor_get_rate.

Field Documentation

◆ [union]

union { ... } clock_monitor_config

Per-mode parameters; selected by mode.

◆ callback

clock_monitor_callback_t clock_monitor_config::callback

Optional callback for asynchronous event delivery.

◆ measure

struct clock_monitor_measure_cfg clock_monitor_config::measure

Honored when mode is MEASURE.

◆ mode

enum clock_monitor_mode clock_monitor_config::mode

Operating mode to activate.

◆ user_data

void* clock_monitor_config::user_data

Opaque user pointer passed to callback.

◆ window

struct clock_monitor_window_cfg clock_monitor_config::window

Honored when mode is WINDOW.


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