OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/include/clock_control.h

107 lines
2.9 KiB
C
Raw Normal View History

clock: add Quark SE clock control Quark SE provides various clock controllers through its SCSS block. Peripheral, external, sensor, and others. This current drivers provides only the clock gating capability, for peripheral, external and sensor. But it could support divider and more other features once defined in the generic API. Note: such clock has _nothing_ to do with a Real Time Clock (RTC). An RTC provide clock timing like a watch would do. Here the clock controller is about circuit clocking. Change-Id: I1a365ae730dfc6be7686271f7fbb693e64a6ff6f Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2015-11-22 10:16:01 +08:00
/* clock_control.h - public clock controller driver API */
/*
* Copyright (c) 2015 Intel Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __CLOCK_CONTROL_H__
#define __CLOCK_CONTROL_H__
#include <stdint.h>
#include <stddef.h>
#include <device.h>
clock_control: extend API with clock rate query operation Extend the public API of clock_control driver with a function for querying of clock rate driving given peripheral. This is useful when the driver must calculate or configurae values that depend on the rate of clock driving this subsystem. A baud rate setting of UART port is an example of such operation. To configure a particular baud rate the driver may need to set the internal counters of UART port, where the actual value will depend on the clock rate for this peripheral. The implementation returns DEV_NO_SUPPORT for clock_control drivers that do not implement such functionality. Change-Id: I4e7ec96cd3678a4bb1ff289b0247488289310f2d Origin: Original Signed-off-by: Maciej Borzecki <maciek.borzecki@gmail.com>
2016-03-05 22:08:51 +08:00
#include <misc/__assert.h>
clock: add Quark SE clock control Quark SE provides various clock controllers through its SCSS block. Peripheral, external, sensor, and others. This current drivers provides only the clock gating capability, for peripheral, external and sensor. But it could support divider and more other features once defined in the generic API. Note: such clock has _nothing_ to do with a Real Time Clock (RTC). An RTC provide clock timing like a watch would do. Here the clock controller is about circuit clocking. Change-Id: I1a365ae730dfc6be7686271f7fbb693e64a6ff6f Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2015-11-22 10:16:01 +08:00
#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);
clock_control: extend API with clock rate query operation Extend the public API of clock_control driver with a function for querying of clock rate driving given peripheral. This is useful when the driver must calculate or configurae values that depend on the rate of clock driving this subsystem. A baud rate setting of UART port is an example of such operation. To configure a particular baud rate the driver may need to set the internal counters of UART port, where the actual value will depend on the clock rate for this peripheral. The implementation returns DEV_NO_SUPPORT for clock_control drivers that do not implement such functionality. Change-Id: I4e7ec96cd3678a4bb1ff289b0247488289310f2d Origin: Original Signed-off-by: Maciej Borzecki <maciek.borzecki@gmail.com>
2016-03-05 22:08:51 +08:00
typedef int (*clock_control_get)(struct device *dev,
clock_control_subsys_t sys,
uint32_t *rate);
clock: add Quark SE clock control Quark SE provides various clock controllers through its SCSS block. Peripheral, external, sensor, and others. This current drivers provides only the clock gating capability, for peripheral, external and sensor. But it could support divider and more other features once defined in the generic API. Note: such clock has _nothing_ to do with a Real Time Clock (RTC). An RTC provide clock timing like a watch would do. Here the clock controller is about circuit clocking. Change-Id: I1a365ae730dfc6be7686271f7fbb693e64a6ff6f Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2015-11-22 10:16:01 +08:00
struct clock_control_driver_api {
clock_control: extend API with clock rate query operation Extend the public API of clock_control driver with a function for querying of clock rate driving given peripheral. This is useful when the driver must calculate or configurae values that depend on the rate of clock driving this subsystem. A baud rate setting of UART port is an example of such operation. To configure a particular baud rate the driver may need to set the internal counters of UART port, where the actual value will depend on the clock rate for this peripheral. The implementation returns DEV_NO_SUPPORT for clock_control drivers that do not implement such functionality. Change-Id: I4e7ec96cd3678a4bb1ff289b0247488289310f2d Origin: Original Signed-off-by: Maciej Borzecki <maciek.borzecki@gmail.com>
2016-03-05 22:08:51 +08:00
clock_control on;
clock_control off;
clock_control_get get_rate;
clock: add Quark SE clock control Quark SE provides various clock controllers through its SCSS block. Peripheral, external, sensor, and others. This current drivers provides only the clock gating capability, for peripheral, external and sensor. But it could support divider and more other features once defined in the generic API. Note: such clock has _nothing_ to do with a Real Time Clock (RTC). An RTC provide clock timing like a watch would do. Here the clock controller is about circuit clocking. Change-Id: I1a365ae730dfc6be7686271f7fbb693e64a6ff6f Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2015-11-22 10:16:01 +08:00
};
/**
* @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)
{
drivers/clock_control: Make references to driver_api const Change-Id: I059fd2df62059a782b7ac5aa6e68e2cd948a2bc1 Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
2016-10-22 16:59:20 +08:00
const struct clock_control_driver_api *api = dev->driver_api;
clock: add Quark SE clock control Quark SE provides various clock controllers through its SCSS block. Peripheral, external, sensor, and others. This current drivers provides only the clock gating capability, for peripheral, external and sensor. But it could support divider and more other features once defined in the generic API. Note: such clock has _nothing_ to do with a Real Time Clock (RTC). An RTC provide clock timing like a watch would do. Here the clock controller is about circuit clocking. Change-Id: I1a365ae730dfc6be7686271f7fbb693e64a6ff6f Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2015-11-22 10:16:01 +08:00
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)
{
drivers/clock_control: Make references to driver_api const Change-Id: I059fd2df62059a782b7ac5aa6e68e2cd948a2bc1 Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
2016-10-22 16:59:20 +08:00
const struct clock_control_driver_api *api = dev->driver_api;
clock: add Quark SE clock control Quark SE provides various clock controllers through its SCSS block. Peripheral, external, sensor, and others. This current drivers provides only the clock gating capability, for peripheral, external and sensor. But it could support divider and more other features once defined in the generic API. Note: such clock has _nothing_ to do with a Real Time Clock (RTC). An RTC provide clock timing like a watch would do. Here the clock controller is about circuit clocking. Change-Id: I1a365ae730dfc6be7686271f7fbb693e64a6ff6f Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2015-11-22 10:16:01 +08:00
return api->off(dev, sys);
}
clock_control: extend API with clock rate query operation Extend the public API of clock_control driver with a function for querying of clock rate driving given peripheral. This is useful when the driver must calculate or configurae values that depend on the rate of clock driving this subsystem. A baud rate setting of UART port is an example of such operation. To configure a particular baud rate the driver may need to set the internal counters of UART port, where the actual value will depend on the clock rate for this peripheral. The implementation returns DEV_NO_SUPPORT for clock_control drivers that do not implement such functionality. Change-Id: I4e7ec96cd3678a4bb1ff289b0247488289310f2d Origin: Original Signed-off-by: Maciej Borzecki <maciek.borzecki@gmail.com>
2016-03-05 22:08:51 +08:00
/**
* @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)
{
drivers/clock_control: Make references to driver_api const Change-Id: I059fd2df62059a782b7ac5aa6e68e2cd948a2bc1 Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
2016-10-22 16:59:20 +08:00
const struct clock_control_driver_api *api = dev->driver_api;
clock_control: extend API with clock rate query operation Extend the public API of clock_control driver with a function for querying of clock rate driving given peripheral. This is useful when the driver must calculate or configurae values that depend on the rate of clock driving this subsystem. A baud rate setting of UART port is an example of such operation. To configure a particular baud rate the driver may need to set the internal counters of UART port, where the actual value will depend on the clock rate for this peripheral. The implementation returns DEV_NO_SUPPORT for clock_control drivers that do not implement such functionality. Change-Id: I4e7ec96cd3678a4bb1ff289b0247488289310f2d Origin: Original Signed-off-by: Maciej Borzecki <maciek.borzecki@gmail.com>
2016-03-05 22:08:51 +08:00
__ASSERT(api->get_rate, "%s not implemented for device %s",
__func__, dev->config->name);
return api->get_rate(dev, sys, rate);
}
clock: add Quark SE clock control Quark SE provides various clock controllers through its SCSS block. Peripheral, external, sensor, and others. This current drivers provides only the clock gating capability, for peripheral, external and sensor. But it could support divider and more other features once defined in the generic API. Note: such clock has _nothing_ to do with a Real Time Clock (RTC). An RTC provide clock timing like a watch would do. Here the clock controller is about circuit clocking. Change-Id: I1a365ae730dfc6be7686271f7fbb693e64a6ff6f Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2015-11-22 10:16:01 +08:00
#ifdef __cplusplus
}
#endif
#endif /* __CLOCK_CONTROL_H__ */