mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-10 09:41:57 +00:00
789081673f
This is a start to move away from the C99 {u}int{8,16,32,64}_t types to
Zephyr defined u{8,16,32,64}_t and s{8,16,32,64}_t. This allows Zephyr
to define the sized types in a consistent manor across all the
architectures we support and not conflict with what various compilers
and libc might do with regards to the C99 types.
We introduce <zephyr/types.h> as part of this and have it include
<stdint.h> for now until we transition all the code away from the C99
types.
We go with u{8,16,32,64}_t and s{8,16,32,64}_t as there are some
existing variables defined u8 & u16 as well as to be consistent with
Zephyr naming conventions.
Jira: ZEP-2051
Change-Id: I451fed0623b029d65866622e478225dfab2c0ca8
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
97 lines
2.4 KiB
C
97 lines
2.4 KiB
C
/* clock_control.h - public clock controller driver API */
|
|
|
|
/*
|
|
* Copyright (c) 2015 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef __CLOCK_CONTROL_H__
|
|
#define __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,
|
|
uint32_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 = 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 = 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,
|
|
uint32_t *rate)
|
|
{
|
|
const struct clock_control_driver_api *api = dev->driver_api;
|
|
|
|
__ASSERT(api->get_rate, "%s not implemented for device %s",
|
|
__func__, dev->config->name);
|
|
|
|
return api->get_rate(dev, sys, rate);
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __CLOCK_CONTROL_H__ */
|