Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2015 Google, Inc |
| 3 | * Written by Simon Glass <sjg@chromium.org> |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 4 | * Copyright (c) 2016, NVIDIA CORPORATION. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 5 | * |
| 6 | * SPDX-License-Identifier: GPL-2.0+ |
| 7 | */ |
| 8 | |
Michal Simek | a0d2802 | 2013-11-21 13:39:02 -0800 | [diff] [blame] | 9 | #ifndef _CLK_H_ |
| 10 | #define _CLK_H_ |
| 11 | |
Masahiro Yamada | 56a931c | 2016-09-21 11:28:55 +0900 | [diff] [blame] | 12 | #include <linux/errno.h> |
Masahiro Yamada | 53b2aec | 2016-01-13 13:16:09 +0900 | [diff] [blame] | 13 | #include <linux/types.h> |
| 14 | |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 15 | /** |
| 16 | * A clock is a hardware signal that oscillates autonomously at a specific |
| 17 | * frequency and duty cycle. Most hardware modules require one or more clock |
| 18 | * signal to drive their operation. Clock signals are typically generated |
| 19 | * externally to the HW module consuming them, by an entity this API calls a |
| 20 | * clock provider. This API provides a standard means for drivers to enable and |
| 21 | * disable clocks, and to set the rate at which they oscillate. |
| 22 | * |
| 23 | * A driver that implements UCLASS_CLOCK is a clock provider. A provider will |
| 24 | * often implement multiple separate clocks, since the hardware it manages |
| 25 | * often has this capability. clock_uclass.h describes the interface which |
| 26 | * clock providers must implement. |
| 27 | * |
| 28 | * Clock consumers/clients are the HW modules driven by the clock signals. This |
| 29 | * header file describes the API used by drivers for those HW modules. |
| 30 | */ |
Masahiro Yamada | 67c2295 | 2016-01-13 13:16:12 +0900 | [diff] [blame] | 31 | |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 32 | struct udevice; |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 33 | |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 34 | /** |
| 35 | * struct clk - A handle to (allowing control of) a single clock. |
| 36 | * |
| 37 | * Clients provide storage for clock handles. The content of the structure is |
| 38 | * managed solely by the clock API and clock drivers. A clock struct is |
| 39 | * initialized by "get"ing the clock struct. The clock struct is passed to all |
| 40 | * other clock APIs to identify which clock signal to operate upon. |
| 41 | * |
| 42 | * @dev: The device which implements the clock signal. |
| 43 | * @id: The clock signal ID within the provider. |
| 44 | * |
| 45 | * Currently, the clock API assumes that a single integer ID is enough to |
| 46 | * identify and configure any clock signal for any clock provider. If this |
| 47 | * assumption becomes invalid in the future, the struct could be expanded to |
| 48 | * either (a) add more fields to allow clock providers to store additional |
| 49 | * information, or (b) replace the id field with an opaque pointer, which the |
| 50 | * provider would dynamically allocated during its .of_xlate op, and process |
| 51 | * during is .request op. This may require the addition of an extra op to clean |
| 52 | * up the allocation. |
| 53 | */ |
| 54 | struct clk { |
| 55 | struct udevice *dev; |
| 56 | /* |
| 57 | * Written by of_xlate. We assume a single id is enough for now. In the |
| 58 | * future, we might add more fields here. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 59 | */ |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 60 | unsigned long id; |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 61 | }; |
| 62 | |
Paul Burton | 103387a | 2016-09-08 07:47:28 +0100 | [diff] [blame] | 63 | #if CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(CLK) |
Simon Glass | e94414b | 2017-08-29 14:15:56 -0600 | [diff] [blame^] | 64 | struct phandle_1_arg; |
Simon Glass | 589d915 | 2016-07-04 11:58:03 -0600 | [diff] [blame] | 65 | int clk_get_by_index_platdata(struct udevice *dev, int index, |
Simon Glass | e94414b | 2017-08-29 14:15:56 -0600 | [diff] [blame^] | 66 | struct phandle_1_arg *cells, struct clk *clk); |
Simon Glass | 589d915 | 2016-07-04 11:58:03 -0600 | [diff] [blame] | 67 | |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 68 | /** |
| 69 | * clock_get_by_index - Get/request a clock by integer index. |
| 70 | * |
| 71 | * This looks up and requests a clock. The index is relative to the client |
| 72 | * device; each device is assumed to have n clocks associated with it somehow, |
| 73 | * and this function finds and requests one of them. The mapping of client |
| 74 | * device clock indices to provider clocks may be via device-tree properties, |
| 75 | * board-provided mapping tables, or some other mechanism. |
| 76 | * |
| 77 | * @dev: The client device. |
| 78 | * @index: The index of the clock to request, within the client's list of |
| 79 | * clocks. |
| 80 | * @clock A pointer to a clock struct to initialize. |
| 81 | * @return 0 if OK, or a negative error code. |
| 82 | */ |
| 83 | int clk_get_by_index(struct udevice *dev, int index, struct clk *clk); |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 84 | |
| 85 | /** |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 86 | * clock_get_by_name - Get/request a clock by name. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 87 | * |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 88 | * This looks up and requests a clock. The name is relative to the client |
| 89 | * device; each device is assumed to have n clocks associated with it somehow, |
| 90 | * and this function finds and requests one of them. The mapping of client |
| 91 | * device clock names to provider clocks may be via device-tree properties, |
| 92 | * board-provided mapping tables, or some other mechanism. |
| 93 | * |
| 94 | * @dev: The client device. |
| 95 | * @name: The name of the clock to request, within the client's list of |
| 96 | * clocks. |
| 97 | * @clock: A pointer to a clock struct to initialize. |
| 98 | * @return 0 if OK, or a negative error code. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 99 | */ |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 100 | int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk); |
Patrice Chotard | cafc341 | 2017-07-25 13:24:45 +0200 | [diff] [blame] | 101 | |
| 102 | /** |
| 103 | * clk_release_all() - Disable (turn off)/Free an array of previously |
| 104 | * requested clocks. |
| 105 | * |
| 106 | * For each clock contained in the clock array, this function will check if |
| 107 | * clock has been previously requested and then will disable and free it. |
| 108 | * |
| 109 | * @clk: A clock struct array that was previously successfully |
| 110 | * requested by clk_request/get_by_*(). |
| 111 | * @count Number of clock contained in the array |
| 112 | * @return zero on success, or -ve error code. |
| 113 | */ |
| 114 | int clk_release_all(struct clk *clk, int count); |
| 115 | |
Masahiro Yamada | 09abe2b | 2016-09-26 20:45:27 +0900 | [diff] [blame] | 116 | #else |
| 117 | static inline int clk_get_by_index(struct udevice *dev, int index, |
| 118 | struct clk *clk) |
| 119 | { |
| 120 | return -ENOSYS; |
| 121 | } |
| 122 | |
| 123 | static inline int clk_get_by_name(struct udevice *dev, const char *name, |
| 124 | struct clk *clk) |
| 125 | { |
| 126 | return -ENOSYS; |
| 127 | } |
Patrice Chotard | cafc341 | 2017-07-25 13:24:45 +0200 | [diff] [blame] | 128 | |
| 129 | static inline int clk_release_all(struct clk *clk, int count) |
| 130 | { |
| 131 | return -ENOSYS; |
| 132 | } |
| 133 | |
Masahiro Yamada | 09abe2b | 2016-09-26 20:45:27 +0900 | [diff] [blame] | 134 | #endif |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 135 | |
| 136 | /** |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 137 | * clk_request - Request a clock by provider-specific ID. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 138 | * |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 139 | * This requests a clock using a provider-specific ID. Generally, this function |
| 140 | * should not be used, since clk_get_by_index/name() provide an interface that |
| 141 | * better separates clients from intimate knowledge of clock providers. |
| 142 | * However, this function may be useful in core SoC-specific code. |
| 143 | * |
| 144 | * @dev: The clock provider device. |
| 145 | * @clock: A pointer to a clock struct to initialize. The caller must |
| 146 | * have already initialized any field in this struct which the |
| 147 | * clock provider uses to identify the clock. |
| 148 | * @return 0 if OK, or a negative error code. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 149 | */ |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 150 | int clk_request(struct udevice *dev, struct clk *clk); |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 151 | |
| 152 | /** |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 153 | * clock_free - Free a previously requested clock. |
Masahiro Yamada | 67c2295 | 2016-01-13 13:16:12 +0900 | [diff] [blame] | 154 | * |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 155 | * @clock: A clock struct that was previously successfully requested by |
| 156 | * clk_request/get_by_*(). |
| 157 | * @return 0 if OK, or a negative error code. |
Masahiro Yamada | 67c2295 | 2016-01-13 13:16:12 +0900 | [diff] [blame] | 158 | */ |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 159 | int clk_free(struct clk *clk); |
Masahiro Yamada | 67c2295 | 2016-01-13 13:16:12 +0900 | [diff] [blame] | 160 | |
| 161 | /** |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 162 | * clk_get_rate() - Get current clock rate. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 163 | * |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 164 | * @clk: A clock struct that was previously successfully requested by |
| 165 | * clk_request/get_by_*(). |
| 166 | * @return clock rate in Hz, or -ve error code. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 167 | */ |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 168 | ulong clk_get_rate(struct clk *clk); |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 169 | |
| 170 | /** |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 171 | * clk_set_rate() - Set current clock rate. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 172 | * |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 173 | * @clk: A clock struct that was previously successfully requested by |
| 174 | * clk_request/get_by_*(). |
| 175 | * @rate: New clock rate in Hz. |
| 176 | * @return new rate, or -ve error code. |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 177 | */ |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 178 | ulong clk_set_rate(struct clk *clk, ulong rate); |
Simon Glass | 36ad234 | 2015-06-23 15:39:15 -0600 | [diff] [blame] | 179 | |
Simon Glass | 0342bd2 | 2016-01-20 19:43:02 -0700 | [diff] [blame] | 180 | /** |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 181 | * clk_enable() - Enable (turn on) a clock. |
Simon Glass | 0342bd2 | 2016-01-20 19:43:02 -0700 | [diff] [blame] | 182 | * |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 183 | * @clk: A clock struct that was previously successfully requested by |
| 184 | * clk_request/get_by_*(). |
| 185 | * @return zero on success, or -ve error code. |
| 186 | */ |
| 187 | int clk_enable(struct clk *clk); |
| 188 | |
| 189 | /** |
| 190 | * clk_disable() - Disable (turn off) a clock. |
Simon Glass | 0342bd2 | 2016-01-20 19:43:02 -0700 | [diff] [blame] | 191 | * |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 192 | * @clk: A clock struct that was previously successfully requested by |
| 193 | * clk_request/get_by_*(). |
| 194 | * @return zero on success, or -ve error code. |
Simon Glass | 0342bd2 | 2016-01-20 19:43:02 -0700 | [diff] [blame] | 195 | */ |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 196 | int clk_disable(struct clk *clk); |
Simon Glass | 0342bd2 | 2016-01-20 19:43:02 -0700 | [diff] [blame] | 197 | |
Stephen Warren | a962243 | 2016-06-17 09:44:00 -0600 | [diff] [blame] | 198 | int soc_clk_dump(void); |
| 199 | |
| 200 | #endif |