From 68bfb5c3f26c0c4ec47ff47c328cef6fec477200 Mon Sep 17 00:00:00 2001 From: Carles Cufi Date: Tue, 17 Mar 2020 15:06:11 +0100 Subject: [PATCH] doc: reference: Add clock control API Add the clock control API to the documentation reference. Signed-off-by: Carles Cufi --- doc/reference/peripherals/clock_control.rst | 23 +++++++++++++++++++++ doc/reference/peripherals/index.rst | 1 + include/drivers/clock_control.h | 16 ++++++++++++++ 3 files changed, 40 insertions(+) create mode 100644 doc/reference/peripherals/clock_control.rst diff --git a/doc/reference/peripherals/clock_control.rst b/doc/reference/peripherals/clock_control.rst new file mode 100644 index 00000000000..c9f3d6219cb --- /dev/null +++ b/doc/reference/peripherals/clock_control.rst @@ -0,0 +1,23 @@ +.. _clock_control_api: + +Clock Control +############# + +Overview +******** + +The clock control API provides access to clocks in the system, including the +ability to turn them on and off. + +Configuration Options +********************* + +Related configuration options: + +* :option:`CONFIG_CLOCK_CONTROL` + +API Reference +************* + +.. doxygengroup:: clock_control_interface + :project: Zephyr diff --git a/doc/reference/peripherals/index.rst b/doc/reference/peripherals/index.rst index 9e7516334ee..2f5cfe9186c 100644 --- a/doc/reference/peripherals/index.rst +++ b/doc/reference/peripherals/index.rst @@ -8,6 +8,7 @@ Peripherals adc.rst counter.rst + clock_control.rst dma.rst eeprom.rst entropy.rst diff --git a/include/drivers/clock_control.h b/include/drivers/clock_control.h index 9f6584beb70..43e4ff403fa 100644 --- a/include/drivers/clock_control.h +++ b/include/drivers/clock_control.h @@ -6,9 +6,21 @@ * SPDX-License-Identifier: Apache-2.0 */ +/** + * @file + * @brief Public Clock Control APIs + */ + #ifndef ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_ #define ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_ +/** + * @brief Clock Control Interface + * @defgroup clock_control_interface Clock Control Interface + * @ingroup io_interfaces + * @{ + */ + #include #include #include @@ -229,4 +241,8 @@ static inline int clock_control_get_rate(struct device *dev, } #endif +/** + * @} + */ + #endif /* ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_ */