Blame view
include/clk.h
10.1 KB
83d290c56
|
1 |
/* SPDX-License-Identifier: GPL-2.0+ */ |
f26c8a8e7
|
2 3 4 |
/* * Copyright (c) 2015 Google, Inc * Written by Simon Glass <sjg@chromium.org> |
135aa9500
|
5 |
* Copyright (c) 2016, NVIDIA CORPORATION. |
f26c8a8e7
|
6 |
*/ |
08d0d6f32
|
7 8 |
#ifndef _CLK_H_ #define _CLK_H_ |
1221ce459
|
9 |
#include <linux/errno.h> |
ad1cf7858
|
10 |
#include <linux/types.h> |
135aa9500
|
11 12 13 14 15 16 17 18 19 20 |
/** * A clock is a hardware signal that oscillates autonomously at a specific * frequency and duty cycle. Most hardware modules require one or more clock * signal to drive their operation. Clock signals are typically generated * externally to the HW module consuming them, by an entity this API calls a * clock provider. This API provides a standard means for drivers to enable and * disable clocks, and to set the rate at which they oscillate. * * A driver that implements UCLASS_CLOCK is a clock provider. A provider will * often implement multiple separate clocks, since the hardware it manages |
9bf865067
|
21 |
* often has this capability. clk-uclass.h describes the interface which |
135aa9500
|
22 23 24 25 26 |
* clock providers must implement. * * Clock consumers/clients are the HW modules driven by the clock signals. This * header file describes the API used by drivers for those HW modules. */ |
ad1cf7858
|
27 |
|
135aa9500
|
28 |
struct udevice; |
08d0d6f32
|
29 |
|
135aa9500
|
30 31 32 33 34 35 36 37 38 39 |
/** * struct clk - A handle to (allowing control of) a single clock. * * Clients provide storage for clock handles. The content of the structure is * managed solely by the clock API and clock drivers. A clock struct is * initialized by "get"ing the clock struct. The clock struct is passed to all * other clock APIs to identify which clock signal to operate upon. * * @dev: The device which implements the clock signal. * @id: The clock signal ID within the provider. |
3b3969bd3
|
40 41 42 |
* @data: An optional data field for scenarios where a single integer ID is not * sufficient. If used, it can be populated through an .of_xlate op and * processed during the various clock ops. |
135aa9500
|
43 |
* |
3b3969bd3
|
44 45 |
* Should additional information to identify and configure any clock signal * for any provider be required in the future, the struct could be expanded to |
135aa9500
|
46 47 48 49 50 51 52 53 54 |
* either (a) add more fields to allow clock providers to store additional * information, or (b) replace the id field with an opaque pointer, which the * provider would dynamically allocated during its .of_xlate op, and process * during is .request op. This may require the addition of an extra op to clean * up the allocation. */ struct clk { struct udevice *dev; /* |
3b3969bd3
|
55 |
* Written by of_xlate. In the future, we might add more fields here. |
f26c8a8e7
|
56 |
*/ |
135aa9500
|
57 |
unsigned long id; |
3b3969bd3
|
58 |
unsigned long data; |
f26c8a8e7
|
59 |
}; |
a855be87d
|
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
/** * struct clk_bulk - A handle to (allowing control of) a bulk of clocks. * * Clients provide storage for the clock bulk. The content of the structure is * managed solely by the clock API. A clock bulk struct is * initialized by "get"ing the clock bulk struct. * The clock bulk struct is passed to all other bulk clock APIs to apply * the API to all the clock in the bulk struct. * * @clks: An array of clock handles. * @count: The number of clock handles in the clks array. */ struct clk_bulk { struct clk *clks; unsigned int count; }; |
3f96f8752
|
76 |
#if CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(CLK) |
0d15463c0
|
77 |
struct phandle_1_arg; |
7423daa60
|
78 |
int clk_get_by_index_platdata(struct udevice *dev, int index, |
0d15463c0
|
79 |
struct phandle_1_arg *cells, struct clk *clk); |
7423daa60
|
80 |
|
135aa9500
|
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
/** * clock_get_by_index - Get/request a clock by integer index. * * This looks up and requests a clock. The index is relative to the client * device; each device is assumed to have n clocks associated with it somehow, * and this function finds and requests one of them. The mapping of client * device clock indices to provider clocks may be via device-tree properties, * board-provided mapping tables, or some other mechanism. * * @dev: The client device. * @index: The index of the clock to request, within the client's list of * clocks. * @clock A pointer to a clock struct to initialize. * @return 0 if OK, or a negative error code. */ int clk_get_by_index(struct udevice *dev, int index, struct clk *clk); |
f26c8a8e7
|
97 98 |
/** |
a855be87d
|
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
* clock_get_bulk - Get/request all clocks of a device. * * This looks up and requests all clocks of the client device; each device is * assumed to have n clocks associated with it somehow, and this function finds * and requests all of them in a separate structure. The mapping of client * device clock indices to provider clocks may be via device-tree properties, * board-provided mapping tables, or some other mechanism. * * @dev: The client device. * @bulk A pointer to a clock bulk struct to initialize. * @return 0 if OK, or a negative error code. */ int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk); /** |
135aa9500
|
114 |
* clock_get_by_name - Get/request a clock by name. |
f26c8a8e7
|
115 |
* |
135aa9500
|
116 117 118 119 120 121 122 123 124 125 126 |
* This looks up and requests a clock. The name is relative to the client * device; each device is assumed to have n clocks associated with it somehow, * and this function finds and requests one of them. The mapping of client * device clock names to provider clocks may be via device-tree properties, * board-provided mapping tables, or some other mechanism. * * @dev: The client device. * @name: The name of the clock to request, within the client's list of * clocks. * @clock: A pointer to a clock struct to initialize. * @return 0 if OK, or a negative error code. |
f26c8a8e7
|
127 |
*/ |
135aa9500
|
128 |
int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk); |
b108d8a0d
|
129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
/** * clk_release_all() - Disable (turn off)/Free an array of previously * requested clocks. * * For each clock contained in the clock array, this function will check if * clock has been previously requested and then will disable and free it. * * @clk: A clock struct array that was previously successfully * requested by clk_request/get_by_*(). * @count Number of clock contained in the array * @return zero on success, or -ve error code. */ int clk_release_all(struct clk *clk, int count); |
021abf696
|
143 144 145 146 147 148 |
#else static inline int clk_get_by_index(struct udevice *dev, int index, struct clk *clk) { return -ENOSYS; } |
a855be87d
|
149 150 151 152 |
static inline int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk) { return -ENOSYS; } |
021abf696
|
153 154 155 156 157 |
static inline int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk) { return -ENOSYS; } |
b108d8a0d
|
158 159 160 161 162 |
static inline int clk_release_all(struct clk *clk, int count) { return -ENOSYS; } |
021abf696
|
163 |
#endif |
f26c8a8e7
|
164 |
|
f4fcba5c5
|
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
#if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) && \ CONFIG_IS_ENABLED(CLK) /** * clk_set_defaults - Process 'assigned-{clocks/clock-parents/clock-rates}' * properties to configure clocks * * @dev: A device to process (the ofnode associated with this device * will be processed). */ int clk_set_defaults(struct udevice *dev); #else static inline int clk_set_defaults(struct udevice *dev) { return 0; } #endif |
f26c8a8e7
|
181 |
/** |
a855be87d
|
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
* clk_release_bulk() - Disable (turn off)/Free an array of previously * requested clocks in a clock bulk struct. * * For each clock contained in the clock bulk struct, this function will check * if clock has been previously requested and then will disable and free it. * * @clk: A clock bulk struct that was previously successfully * requested by clk_get_bulk(). * @return zero on success, or -ve error code. */ static inline int clk_release_bulk(struct clk_bulk *bulk) { return clk_release_all(bulk->clks, bulk->count); } /** |
135aa9500
|
198 |
* clk_request - Request a clock by provider-specific ID. |
f26c8a8e7
|
199 |
* |
135aa9500
|
200 201 202 203 204 205 206 207 208 209 |
* This requests a clock using a provider-specific ID. Generally, this function * should not be used, since clk_get_by_index/name() provide an interface that * better separates clients from intimate knowledge of clock providers. * However, this function may be useful in core SoC-specific code. * * @dev: The clock provider device. * @clock: A pointer to a clock struct to initialize. The caller must * have already initialized any field in this struct which the * clock provider uses to identify the clock. * @return 0 if OK, or a negative error code. |
f26c8a8e7
|
210 |
*/ |
135aa9500
|
211 |
int clk_request(struct udevice *dev, struct clk *clk); |
f26c8a8e7
|
212 213 |
/** |
135aa9500
|
214 |
* clock_free - Free a previously requested clock. |
f0e075162
|
215 |
* |
135aa9500
|
216 217 218 |
* @clock: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @return 0 if OK, or a negative error code. |
f0e075162
|
219 |
*/ |
135aa9500
|
220 |
int clk_free(struct clk *clk); |
f0e075162
|
221 222 |
/** |
135aa9500
|
223 |
* clk_get_rate() - Get current clock rate. |
f26c8a8e7
|
224 |
* |
135aa9500
|
225 226 227 |
* @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @return clock rate in Hz, or -ve error code. |
f26c8a8e7
|
228 |
*/ |
135aa9500
|
229 |
ulong clk_get_rate(struct clk *clk); |
f26c8a8e7
|
230 231 |
/** |
135aa9500
|
232 |
* clk_set_rate() - Set current clock rate. |
f26c8a8e7
|
233 |
* |
135aa9500
|
234 235 236 237 |
* @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @rate: New clock rate in Hz. * @return new rate, or -ve error code. |
f26c8a8e7
|
238 |
*/ |
135aa9500
|
239 |
ulong clk_set_rate(struct clk *clk, ulong rate); |
f26c8a8e7
|
240 |
|
e70cc4383
|
241 |
/** |
f7d1046da
|
242 243 244 245 246 247 248 249 250 251 252 |
* clk_set_parent() - Set current clock parent. * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @parent: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @return new rate, or -ve error code. */ int clk_set_parent(struct clk *clk, struct clk *parent); /** |
135aa9500
|
253 |
* clk_enable() - Enable (turn on) a clock. |
e70cc4383
|
254 |
* |
135aa9500
|
255 256 257 258 259 260 261 |
* @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @return zero on success, or -ve error code. */ int clk_enable(struct clk *clk); /** |
a855be87d
|
262 263 264 265 266 267 268 269 270 |
* clk_enable_bulk() - Enable (turn on) all clocks in a clock bulk struct. * * @bulk: A clock bulk struct that was previously successfully requested * by clk_get_bulk(). * @return zero on success, or -ve error code. */ int clk_enable_bulk(struct clk_bulk *bulk); /** |
135aa9500
|
271 |
* clk_disable() - Disable (turn off) a clock. |
e70cc4383
|
272 |
* |
135aa9500
|
273 274 275 |
* @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @return zero on success, or -ve error code. |
e70cc4383
|
276 |
*/ |
135aa9500
|
277 |
int clk_disable(struct clk *clk); |
e70cc4383
|
278 |
|
a855be87d
|
279 280 281 282 283 284 285 286 |
/** * clk_disable_bulk() - Disable (turn off) all clocks in a clock bulk struct. * * @bulk: A clock bulk struct that was previously successfully requested * by clk_get_bulk(). * @return zero on success, or -ve error code. */ int clk_disable_bulk(struct clk_bulk *bulk); |
135aa9500
|
287 |
int soc_clk_dump(void); |
1fe243a1e
|
288 289 290 291 292 293 294 295 296 297 |
/** * clk_valid() - check if clk is valid * * @clk: the clock to check * @return true if valid, or false */ static inline bool clk_valid(struct clk *clk) { return !!clk->dev; } |
135aa9500
|
298 |
#endif |