mirror of
https://github.com/brain-hackers/u-boot-brain
synced 2024-08-21 01:18:52 +09:00
![Simon Glass](/assets/img/avatar_default.png)
Clocks are an important feature of platforms and have become increasing complex with time. Most modern SoCs have multiple PLLs and dozens of clock dividers which distribute clocks to on-chip peripherals. Some SoC implementations have a clock API which is private to that SoC family, e.g. Tegra and Exynos. This is useful but it would be better to have a common API that can be understood and used throughout U-Boot. Add a simple clock API as a starting point. It supports querying and setting the rate of a clock. Each clock is a device. To reduce memory and processing overhead the concept of peripheral clocks is provided. These do not need to be explicit devices - it is possible to write a driver that can adjust the I2C clock (for example) without an explicit I2C clock device. This can dramatically reduce the number of devices (and associated overhead) in a complex SoC. Clocks are referenced by a number, and it is expected that SoCs will define that numbering themselves via an enum. Signed-off-by: Simon Glass <sjg@chromium.org>
87 lines
2.0 KiB
C
87 lines
2.0 KiB
C
/*
|
|
* Copyright (c) 2015 Google, Inc
|
|
* Written by Simon Glass <sjg@chromium.org>
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0+
|
|
*/
|
|
|
|
#ifndef _CLK_H_
|
|
#define _CLK_H_
|
|
|
|
int soc_clk_dump(void);
|
|
|
|
struct clk_ops {
|
|
/**
|
|
* get_rate() - Get current clock rate
|
|
*
|
|
* @dev: Device to check (UCLASS_CLK)
|
|
* @return clock rate in Hz, or -ve error code
|
|
*/
|
|
ulong (*get_rate)(struct udevice *dev);
|
|
|
|
/**
|
|
* set_rate() - Set current clock rate
|
|
*
|
|
* @dev: Device to adjust
|
|
* @rate: New clock rate in Hz
|
|
* @return new rate, or -ve error code
|
|
*/
|
|
ulong (*set_rate)(struct udevice *dev, ulong rate);
|
|
|
|
/**
|
|
* clk_set_periph_rate() - Set clock rate for a peripheral
|
|
*
|
|
* @dev: Device to adjust (UCLASS_CLK)
|
|
* @rate: New clock rate in Hz
|
|
* @return new clock rate in Hz, or -ve error code
|
|
*/
|
|
ulong (*get_periph_rate)(struct udevice *dev, int periph);
|
|
|
|
/**
|
|
* clk_set_periph_rate() - Set current clock rate for a peripheral
|
|
*
|
|
* @dev: Device to update (UCLASS_CLK)
|
|
* @periph: Peripheral ID to cupdate
|
|
* @return new clock rate in Hz, or -ve error code
|
|
*/
|
|
ulong (*set_periph_rate)(struct udevice *dev, int periph, ulong rate);
|
|
};
|
|
|
|
#define clk_get_ops(dev) ((struct clk_ops *)(dev)->driver->ops)
|
|
|
|
/**
|
|
* clk_get_rate() - Get current clock rate
|
|
*
|
|
* @dev: Device to check (UCLASS_CLK)
|
|
* @return clock rate in Hz, or -ve error code
|
|
*/
|
|
ulong clk_get_rate(struct udevice *dev);
|
|
|
|
/**
|
|
* set_rate() - Set current clock rate
|
|
*
|
|
* @dev: Device to adjust
|
|
* @rate: New clock rate in Hz
|
|
* @return new rate, or -ve error code
|
|
*/
|
|
ulong clk_set_rate(struct udevice *dev, ulong rate);
|
|
|
|
/**
|
|
* clk_get_periph_rate() - Get current clock rate for a peripheral
|
|
*
|
|
* @dev: Device to check (UCLASS_CLK)
|
|
* @return clock rate in Hz, -ve error code
|
|
*/
|
|
ulong clk_get_periph_rate(struct udevice *dev, int periph);
|
|
|
|
/**
|
|
* clk_set_periph_rate() - Set current clock rate for a peripheral
|
|
*
|
|
* @dev: Device to update (UCLASS_CLK)
|
|
* @periph: Peripheral ID to cupdate
|
|
* @return new clock rate in Hz, or -ve error code
|
|
*/
|
|
ulong clk_set_periph_rate(struct udevice *dev, int periph, ulong rate);
|
|
|
|
#endif /* _CLK_H_ */
|