Loading...
/* clock_control.h - public clock controller driver API */ /* * Copyright (c) 2015 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ #ifndef ZEPHYR_INCLUDE_CLOCK_CONTROL_H_ #define ZEPHYR_INCLUDE_CLOCK_CONTROL_H_ #include <zephyr/types.h> #include <stddef.h> #include <device.h> #include <misc/__assert.h> #ifdef __cplusplus extern "C" { #endif /* Clock control API */ /* Used to select all subsystem of a clock controller */ #define CLOCK_CONTROL_SUBSYS_ALL NULL /** * clock_control_subsys_t is a type to identify a clock controller sub-system. * Such data pointed is opaque and relevant only to the clock controller * driver instance being used. */ typedef void *clock_control_subsys_t; typedef int (*clock_control)(struct device *dev, clock_control_subsys_t sys); typedef int (*clock_control_get)(struct device *dev, clock_control_subsys_t sys, u32_t *rate); struct clock_control_driver_api { clock_control on; clock_control off; clock_control_get get_rate; }; /** * @brief Enable the clock of a sub-system controlled by the device * @param dev Pointer to the device structure for the clock controller driver * instance * @param sys A pointer to an opaque data representing the sub-system */ static inline int clock_control_on(struct device *dev, clock_control_subsys_t sys) { const struct clock_control_driver_api *api = (const struct clock_control_driver_api *)dev->driver_api; return api->on(dev, sys); } /** * @brief Disable the clock of a sub-system controlled by the device * @param dev Pointer to the device structure for the clock controller driver * instance * @param sys A pointer to an opaque data representing the sub-system */ static inline int clock_control_off(struct device *dev, clock_control_subsys_t sys) { const struct clock_control_driver_api *api = (const struct clock_control_driver_api *)dev->driver_api; return api->off(dev, sys); } /** * @brief Obtain the clock rate of given sub-system * @param dev Pointer to the device structure for the clock controller driver * instance * @param sys A pointer to an opaque data representing the sub-system * @param[out] rate Subsystem clock rate */ static inline int clock_control_get_rate(struct device *dev, clock_control_subsys_t sys, u32_t *rate) { const struct clock_control_driver_api *api = (const struct clock_control_driver_api *)dev->driver_api; __ASSERT(api->get_rate != NULL, "%s not implemented for device %s", __func__, dev->config->name); return api->get_rate(dev, sys, rate); } #ifdef __cplusplus } #endif #endif /* ZEPHYR_INCLUDE_CLOCK_CONTROL_H_ */ |