doc: reference: Add clock control API
Add the clock control API to the documentation reference. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
parent
22854d39c0
commit
68bfb5c3f2
3 changed files with 40 additions and 0 deletions
23
doc/reference/peripherals/clock_control.rst
Normal file
23
doc/reference/peripherals/clock_control.rst
Normal file
|
@ -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
|
|
@ -8,6 +8,7 @@ Peripherals
|
||||||
|
|
||||||
adc.rst
|
adc.rst
|
||||||
counter.rst
|
counter.rst
|
||||||
|
clock_control.rst
|
||||||
dma.rst
|
dma.rst
|
||||||
eeprom.rst
|
eeprom.rst
|
||||||
entropy.rst
|
entropy.rst
|
||||||
|
|
|
@ -6,9 +6,21 @@
|
||||||
* SPDX-License-Identifier: Apache-2.0
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
* @brief Public Clock Control APIs
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_
|
#ifndef ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_
|
||||||
#define 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 <zephyr/types.h>
|
#include <zephyr/types.h>
|
||||||
#include <stddef.h>
|
#include <stddef.h>
|
||||||
#include <device.h>
|
#include <device.h>
|
||||||
|
@ -229,4 +241,8 @@ static inline int clock_control_get_rate(struct device *dev,
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @}
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_ */
|
#endif /* ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_ */
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue