blob: 138766bd49f1f0be7d95023433feb946c2f2209e [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glassf26c8a82015-06-23 15:39:15 -06002/*
3 * Copyright (c) 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
Stephen Warren135aa952016-06-17 09:44:00 -06005 * Copyright (c) 2016, NVIDIA CORPORATION.
Simon Glassf26c8a82015-06-23 15:39:15 -06006 */
7
Michal Simek08d0d6f2013-11-21 13:39:02 -08008#ifndef _CLK_H_
9#define _CLK_H_
10
Jagan Teki75f98312019-02-28 00:26:52 +053011#include <dm/ofnode.h>
Patrick Delaunay6f791742020-04-27 15:29:57 +020012#include <linux/err.h>
Masahiro Yamada1221ce42016-09-21 11:28:55 +090013#include <linux/errno.h>
Masahiro Yamadaad1cf782016-01-13 13:16:09 +090014#include <linux/types.h>
15
Stephen Warren135aa952016-06-17 09:44:00 -060016/**
Sean Anderson9c88b132021-12-22 12:11:12 -050017 * DOC: Overview
18 *
Stephen Warren135aa952016-06-17 09:44:00 -060019 * A clock is a hardware signal that oscillates autonomously at a specific
20 * frequency and duty cycle. Most hardware modules require one or more clock
21 * signal to drive their operation. Clock signals are typically generated
22 * externally to the HW module consuming them, by an entity this API calls a
23 * clock provider. This API provides a standard means for drivers to enable and
24 * disable clocks, and to set the rate at which they oscillate.
25 *
Lukasz Majewskia9092712019-06-24 15:50:36 +020026 * A driver that implements UCLASS_CLK is a clock provider. A provider will
Stephen Warren135aa952016-06-17 09:44:00 -060027 * often implement multiple separate clocks, since the hardware it manages
Liviu Dudau9bf86502018-09-17 17:43:08 +010028 * often has this capability. clk-uclass.h describes the interface which
Stephen Warren135aa952016-06-17 09:44:00 -060029 * clock providers must implement.
30 *
31 * Clock consumers/clients are the HW modules driven by the clock signals. This
32 * header file describes the API used by drivers for those HW modules.
33 */
34
Masahiro Yamadaad1cf782016-01-13 13:16:09 +090035struct udevice;
36
Stephen Warren135aa952016-06-17 09:44:00 -060037/**
38 * struct clk - A handle to (allowing control of) a single clock.
Sean Anderson9c88b132021-12-22 12:11:12 -050039 * @dev: The device which implements the clock signal.
40 * @rate: The clock rate (in HZ).
41 * @flags: Flags used across common clock structure (e.g. %CLK_)
42 * Clock IP blocks specific flags (i.e. mux, div, gate, etc) are defined
43 * in struct's for those devices (e.g. &struct clk_mux).
44 * @enable_count: The number of times this clock has been enabled.
45 * @id: The clock signal ID within the provider.
46 * @data: An optional data field for scenarios where a single integer ID is not
47 * sufficient. If used, it can be populated through an .of_xlate op and
48 * processed during the various clock ops.
Stephen Warren135aa952016-06-17 09:44:00 -060049 *
50 * Clients provide storage for clock handles. The content of the structure is
51 * managed solely by the clock API and clock drivers. A clock struct is
52 * initialized by "get"ing the clock struct. The clock struct is passed to all
53 * other clock APIs to identify which clock signal to operate upon.
54 *
Andreas Dannenberg3b3969b2018-08-27 15:57:42 +053055 * Should additional information to identify and configure any clock signal
56 * for any provider be required in the future, the struct could be expanded to
Stephen Warren135aa952016-06-17 09:44:00 -060057 * either (a) add more fields to allow clock providers to store additional
58 * information, or (b) replace the id field with an opaque pointer, which the
59 * provider would dynamically allocated during its .of_xlate op, and process
60 * during is .request op. This may require the addition of an extra op to clean
61 * up the allocation.
62 */
63struct clk {
64 struct udevice *dev;
Lukasz Majewski105db952019-06-24 15:50:38 +020065 long long rate; /* in HZ */
Lukasz Majewskia8592cd2019-06-24 15:50:39 +020066 u32 flags;
Peng Fane6849e22019-08-21 13:35:03 +000067 int enable_count;
Stephen Warren135aa952016-06-17 09:44:00 -060068 /*
Andreas Dannenberg3b3969b2018-08-27 15:57:42 +053069 * Written by of_xlate. In the future, we might add more fields here.
Simon Glassf26c8a82015-06-23 15:39:15 -060070 */
Stephen Warren135aa952016-06-17 09:44:00 -060071 unsigned long id;
Andreas Dannenberg3b3969b2018-08-27 15:57:42 +053072 unsigned long data;
Simon Glassf26c8a82015-06-23 15:39:15 -060073};
74
Neil Armstronga855be82018-04-03 11:44:18 +020075/**
76 * struct clk_bulk - A handle to (allowing control of) a bulk of clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -050077 * @clks: An array of clock handles.
78 * @count: The number of clock handles in the clks array.
Neil Armstronga855be82018-04-03 11:44:18 +020079 *
80 * Clients provide storage for the clock bulk. The content of the structure is
81 * managed solely by the clock API. A clock bulk struct is
82 * initialized by "get"ing the clock bulk struct.
83 * The clock bulk struct is passed to all other bulk clock APIs to apply
84 * the API to all the clock in the bulk struct.
Neil Armstronga855be82018-04-03 11:44:18 +020085 */
86struct clk_bulk {
87 struct clk *clks;
88 unsigned int count;
89};
90
Simon Glass0d154632017-08-29 14:15:56 -060091struct phandle_1_arg;
Dario Binacchic9dc8e72022-09-27 19:18:19 +020092
93#if CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(CLK)
Simon Glassf0ab8f92021-08-07 07:24:09 -060094/**
95 * clk_get_by_phandle() - Get a clock by its phandle information (of-platadata)
Sean Anderson9c88b132021-12-22 12:11:12 -050096 * @dev: Device containing the phandle
97 * @cells: Phandle info
98 * @clk: A pointer to a clock struct to initialise
Simon Glassf0ab8f92021-08-07 07:24:09 -060099 *
100 * This function is used when of-platdata is enabled.
101 *
102 * This looks up a clock using the phandle info. With dtoc, each phandle in the
Sean Anderson9c88b132021-12-22 12:11:12 -0500103 * 'clocks' property is transformed into an idx representing the device.
104 * For example::
Simon Glassf0ab8f92021-08-07 07:24:09 -0600105 *
106 * clocks = <&dpll_mpu_ck 23>;
107 *
Sean Anderson9c88b132021-12-22 12:11:12 -0500108 * might result in::
Simon Glassf0ab8f92021-08-07 07:24:09 -0600109 *
110 * .clocks = {1, {23}},},
111 *
112 * indicating that the clock is udevice idx 1 in dt-plat.c with an argument of
113 * 23. This function can return a valid clock given the above information. In
114 * this example it would return a clock containing the 'dpll_mpu_ck' device and
115 * the clock ID 23.
116 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100117 * Return: 0 if OK, or a negative error code.
Simon Glassf0ab8f92021-08-07 07:24:09 -0600118 */
119int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells,
120 struct clk *clk);
Simon Glass7423daa2016-07-04 11:58:03 -0600121
Simon Glasse70cc432016-01-20 19:43:02 -0700122/**
Simon Glassf0ab8f92021-08-07 07:24:09 -0600123 * clk_get_by_index() - Get/request a clock by integer index.
Sean Anderson9c88b132021-12-22 12:11:12 -0500124 * @dev: The client device.
125 * @index: The index of the clock to request, within the client's list of
126 * clocks.
127 * @clk: A pointer to a clock struct to initialize.
Simon Glasse70cc432016-01-20 19:43:02 -0700128 *
Stephen Warren135aa952016-06-17 09:44:00 -0600129 * This looks up and requests a clock. The index is relative to the client
130 * device; each device is assumed to have n clocks associated with it somehow,
131 * and this function finds and requests one of them. The mapping of client
132 * device clock indices to provider clocks may be via device-tree properties,
133 * board-provided mapping tables, or some other mechanism.
Simon Glasse70cc432016-01-20 19:43:02 -0700134 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100135 * Return: 0 if OK, or a negative error code.
Simon Glasse70cc432016-01-20 19:43:02 -0700136 */
Stephen Warren135aa952016-06-17 09:44:00 -0600137int clk_get_by_index(struct udevice *dev, int index, struct clk *clk);
138
139/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500140 * clk_get_by_index_nodev() - Get/request a clock by integer index without a
141 * device.
Jagan Teki75f98312019-02-28 00:26:52 +0530142 * @node: The client ofnode.
143 * @index: The index of the clock to request, within the client's list of
144 * clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -0500145 * @clk: A pointer to a clock struct to initialize.
146 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100147 * Return: 0 if OK, or a negative error code.
Jagan Teki75f98312019-02-28 00:26:52 +0530148 */
149int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk);
150
151/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500152 * clk_get_bulk() - Get/request all clocks of a device.
153 * @dev: The client device.
154 * @bulk: A pointer to a clock bulk struct to initialize.
Neil Armstronga855be82018-04-03 11:44:18 +0200155 *
156 * This looks up and requests all clocks of the client device; each device is
157 * assumed to have n clocks associated with it somehow, and this function finds
158 * and requests all of them in a separate structure. The mapping of client
159 * device clock indices to provider clocks may be via device-tree properties,
160 * board-provided mapping tables, or some other mechanism.
161 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100162 * Return: 0 if OK, or a negative error code.
Neil Armstronga855be82018-04-03 11:44:18 +0200163 */
164int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk);
165
166/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500167 * clk_get_by_name() - Get/request a clock by name.
168 * @dev: The client device.
169 * @name: The name of the clock to request, within the client's list of
170 * clocks.
171 * @clk: A pointer to a clock struct to initialize.
Stephen Warren135aa952016-06-17 09:44:00 -0600172 *
173 * This looks up and requests a clock. The name is relative to the client
174 * device; each device is assumed to have n clocks associated with it somehow,
175 * and this function finds and requests one of them. The mapping of client
176 * device clock names to provider clocks may be via device-tree properties,
177 * board-provided mapping tables, or some other mechanism.
178 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100179 * Return: 0 if OK, or a negative error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600180 */
181int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk);
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200182
183/**
Chunfeng Yund6464202020-01-09 11:35:07 +0800184 * clk_get_by_name_nodev - Get/request a clock by name without a device.
Chunfeng Yund6464202020-01-09 11:35:07 +0800185 * @node: The client ofnode.
186 * @name: The name of the clock to request, within the client's list of
187 * clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -0500188 * @clk: A pointer to a clock struct to initialize.
189 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100190 * Return: 0 if OK, or a negative error code.
Chunfeng Yund6464202020-01-09 11:35:07 +0800191 */
192int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk);
193
194/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500195 * devm_clk_get() - lookup and obtain a managed reference to a clock producer.
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200196 * @dev: device for clock "consumer"
197 * @id: clock consumer ID
198 *
Sean Anderson9c88b132021-12-22 12:11:12 -0500199 * The implementation uses @dev and @id to determine the clock consumer, and
200 * thereby the clock producer. (IOW, @id may be identical strings, but clk_get
201 * may return different clock producers depending on @dev.)
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200202 *
203 * Drivers must assume that the clock source is not enabled.
204 *
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200205 * The clock will automatically be freed when the device is unbound
206 * from the bus.
Sean Anderson9c88b132021-12-22 12:11:12 -0500207 *
208 * Return:
209 * a struct clk corresponding to the clock producer, or
210 * valid IS_ERR() condition containing errno
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200211 */
212struct clk *devm_clk_get(struct udevice *dev, const char *id);
213
214/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500215 * devm_clk_get_optional() - lookup and obtain a managed reference to an
216 * optional clock producer.
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200217 * @dev: device for clock "consumer"
218 * @id: clock consumer ID
219 *
220 * Behaves the same as devm_clk_get() except where there is no clock producer.
Sean Anderson9c88b132021-12-22 12:11:12 -0500221 * In this case, instead of returning -%ENOENT, the function returns NULL.
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200222 */
Sean Anderson14cacb02021-12-22 12:11:11 -0500223static inline struct clk *devm_clk_get_optional(struct udevice *dev,
224 const char *id)
225{
226 struct clk *clk = devm_clk_get(dev, id);
227
228 if (PTR_ERR(clk) == -ENODATA)
229 return NULL;
230
231 return clk;
232}
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200233
234/**
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200235 * clk_release_all() - Disable (turn off)/Free an array of previously
236 * requested clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -0500237 * @clk: A clock struct array that was previously successfully
238 * requested by clk_request/get_by_*().
239 * @count: Number of clock contained in the array
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200240 *
241 * For each clock contained in the clock array, this function will check if
242 * clock has been previously requested and then will disable and free it.
243 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100244 * Return: zero on success, or -ve error code.
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200245 */
246int clk_release_all(struct clk *clk, int count);
247
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200248/**
249 * devm_clk_put - "free" a managed clock source
250 * @dev: device used to acquire the clock
251 * @clk: clock source acquired with devm_clk_get()
252 *
253 * Note: drivers must ensure that all clk_enable calls made on this
254 * clock source are balanced by clk_disable calls prior to calling
255 * this function.
256 *
257 * clk_put should not be called from within interrupt context.
258 */
259void devm_clk_put(struct udevice *dev, struct clk *clk);
260
Masahiro Yamada021abf62016-09-26 20:45:27 +0900261#else
Dario Binacchic9dc8e72022-09-27 19:18:19 +0200262
263static inline int clk_get_by_phandle(struct udevice *dev, const
264 struct phandle_1_arg *cells,
265 struct clk *clk)
266{
267 return -ENOSYS;
268}
269
Masahiro Yamada021abf62016-09-26 20:45:27 +0900270static inline int clk_get_by_index(struct udevice *dev, int index,
271 struct clk *clk)
272{
273 return -ENOSYS;
274}
275
Dario Binacchic9dc8e72022-09-27 19:18:19 +0200276static inline int clk_get_by_index_nodev(ofnode node, int index,
277 struct clk *clk)
278{
279 return -ENOSYS;
280}
281
Neil Armstronga855be82018-04-03 11:44:18 +0200282static inline int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk)
283{
284 return -ENOSYS;
285}
286
Masahiro Yamada021abf62016-09-26 20:45:27 +0900287static inline int clk_get_by_name(struct udevice *dev, const char *name,
288 struct clk *clk)
289{
290 return -ENOSYS;
291}
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200292
Dario Binacchic9dc8e72022-09-27 19:18:19 +0200293static inline struct clk *devm_clk_get(struct udevice *dev, const char *id)
294{
295 return ERR_PTR(-ENOSYS);
296}
297
298static inline struct clk *devm_clk_get_optional(struct udevice *dev,
299 const char *id)
300{
301 return ERR_PTR(-ENOSYS);
302}
303
Chunfeng Yund6464202020-01-09 11:35:07 +0800304static inline int
305clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk)
306{
307 return -ENOSYS;
308}
309
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200310static inline int clk_release_all(struct clk *clk, int count)
311{
312 return -ENOSYS;
313}
Dario Binacchic9dc8e72022-09-27 19:18:19 +0200314
315static inline void devm_clk_put(struct udevice *dev, struct clk *clk)
316{
317}
Masahiro Yamada021abf62016-09-26 20:45:27 +0900318#endif
Simon Glasse70cc432016-01-20 19:43:02 -0700319
Sean Anderson6e33eba2021-06-11 00:16:07 -0400320/**
Sean Andersone96e2132022-01-15 15:52:47 -0500321 * clk_get_by_name_optional() - Get/request a optional clock by name.
322 * @dev: The client device.
323 * @name: The name of the clock to request, within the client's list of
324 * clocks.
325 * @clk: A pointer to a clock struct to initialize.
326 *
327 * Behaves the same as clk_get_by_name(), except when there is no clock
328 * provider. In the latter case, return 0.
329 *
330 * Return: 0 if OK, or a negative error code.
331 */
332static inline int clk_get_by_name_optional(struct udevice *dev,
333 const char *name, struct clk *clk)
334{
335 int ret;
336
337 ret = clk_get_by_name(dev, name, clk);
338 if (ret == -ENODATA)
339 return 0;
340
341 return ret;
342}
343
344/**
Sean Anderson14cacb02021-12-22 12:11:11 -0500345 * clk_get_by_name_nodev_optional - Get/request an optinonal clock by name
346 * without a device.
347 * @node: The client ofnode.
Sean Anderson14cacb02021-12-22 12:11:11 -0500348 * @name: The name of the clock to request, within the client's list of
349 * clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -0500350 * @clk: A pointer to a clock struct to initialize.
Sean Anderson14cacb02021-12-22 12:11:11 -0500351 *
352 * Behaves the same as clk_get_by_name_nodev() except where there is
Sean Anderson9c88b132021-12-22 12:11:12 -0500353 * no clock producer, in this case, skip the error number -%ENODATA, and
Sean Anderson14cacb02021-12-22 12:11:11 -0500354 * the function returns 0.
355 */
356static inline int clk_get_by_name_nodev_optional(ofnode node, const char *name,
357 struct clk *clk)
358{
359 int ret;
360
361 ret = clk_get_by_name_nodev(node, name, clk);
362 if (ret == -ENODATA)
363 return 0;
364
365 return ret;
366}
367
368/**
Sean Anderson6e33eba2021-06-11 00:16:07 -0400369 * enum clk_defaults_stage - What stage clk_set_defaults() is called at
370 * @CLK_DEFAULTS_PRE: Called before probe. Setting of defaults for clocks owned
371 * by this clock driver will be defered until after probing.
372 * @CLK_DEFAULTS_POST: Called after probe. Only defaults for clocks owned by
373 * this clock driver will be set.
374 * @CLK_DEFAULTS_POST_FORCE: Called after probe, and always set defaults, even
375 * before relocation. Usually, defaults are not set
376 * pre-relocation to avoid setting them twice (when
377 * the device is probed again post-relocation). This
378 * may incur a performance cost as device tree
379 * properties must be parsed for a second time.
380 * However, when not using SPL, pre-relocation may be
381 * the only time we can set defaults for some clocks
382 * (such as those used for the RAM we will relocate
383 * into).
384 */
385enum clk_defaults_stage {
386 CLK_DEFAULTS_PRE = 0,
387 CLK_DEFAULTS_POST = 1,
388 CLK_DEFAULTS_POST_FORCE,
389};
390
Simon Glass414cc152021-08-07 07:24:03 -0600391#if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(CLK)
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100392/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500393 * clk_set_defaults - Process ``assigned-{clocks/clock-parents/clock-rates}``
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100394 * properties to configure clocks
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100395 * @dev: A device to process (the ofnode associated with this device
396 * will be processed).
Sean Anderson6e33eba2021-06-11 00:16:07 -0400397 * @stage: The stage of the probing process this function is called during.
Sean Anderson9c88b132021-12-22 12:11:12 -0500398 *
399 * Return: zero on success, or -ve error code.
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100400 */
Sean Anderson6e33eba2021-06-11 00:16:07 -0400401int clk_set_defaults(struct udevice *dev, enum clk_defaults_stage stage);
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100402#else
Jean-Jacques Hiblotfd1ba292019-10-22 14:00:06 +0200403static inline int clk_set_defaults(struct udevice *dev, int stage)
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100404{
405 return 0;
406}
407#endif
408
Stephen Warren135aa952016-06-17 09:44:00 -0600409/**
Neil Armstronga855be82018-04-03 11:44:18 +0200410 * clk_release_bulk() - Disable (turn off)/Free an array of previously
411 * requested clocks in a clock bulk struct.
Sean Anderson9c88b132021-12-22 12:11:12 -0500412 * @bulk: A clock bulk struct that was previously successfully
413 * requested by clk_get_bulk().
Neil Armstronga855be82018-04-03 11:44:18 +0200414 *
415 * For each clock contained in the clock bulk struct, this function will check
416 * if clock has been previously requested and then will disable and free it.
417 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100418 * Return: zero on success, or -ve error code.
Neil Armstronga855be82018-04-03 11:44:18 +0200419 */
420static inline int clk_release_bulk(struct clk_bulk *bulk)
421{
422 return clk_release_all(bulk->clks, bulk->count);
423}
424
Patrick Delaunay6f791742020-04-27 15:29:57 +0200425#if CONFIG_IS_ENABLED(CLK)
Neil Armstronga855be82018-04-03 11:44:18 +0200426/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500427 * clk_request() - Request a clock by provider-specific ID.
428 * @dev: The clock provider device.
429 * @clk: A pointer to a clock struct to initialize. The caller must
430 * have already initialized any field in this struct which the
431 * clock provider uses to identify the clock.
Stephen Warren135aa952016-06-17 09:44:00 -0600432 *
433 * This requests a clock using a provider-specific ID. Generally, this function
434 * should not be used, since clk_get_by_index/name() provide an interface that
435 * better separates clients from intimate knowledge of clock providers.
436 * However, this function may be useful in core SoC-specific code.
437 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100438 * Return: 0 if OK, or a negative error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600439 */
440int clk_request(struct udevice *dev, struct clk *clk);
441
442/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500443 * clk_free() - Free a previously requested clock.
444 * @clk: A clock struct that was previously successfully requested by
Stephen Warren135aa952016-06-17 09:44:00 -0600445 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500446 *
Sean Andersonac15e782022-01-15 17:25:04 -0500447 * Free resources allocated by clk_request() (or any clk_get_* function).
Stephen Warren135aa952016-06-17 09:44:00 -0600448 */
Sean Andersonac15e782022-01-15 17:25:04 -0500449void clk_free(struct clk *clk);
Stephen Warren135aa952016-06-17 09:44:00 -0600450
451/**
452 * clk_get_rate() - Get current clock rate.
Stephen Warren135aa952016-06-17 09:44:00 -0600453 * @clk: A clock struct that was previously successfully requested by
454 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500455 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100456 * Return: clock rate in Hz on success, 0 for invalid clock, or -ve error code
Giulio Benetti9e578f62021-02-14 03:17:18 +0100457 * for other errors.
Stephen Warren135aa952016-06-17 09:44:00 -0600458 */
459ulong clk_get_rate(struct clk *clk);
460
461/**
Lukasz Majewski0c660c22019-06-24 15:50:42 +0200462 * clk_get_parent() - Get current clock's parent.
Lukasz Majewski0c660c22019-06-24 15:50:42 +0200463 * @clk: A clock struct that was previously successfully requested by
464 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500465 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100466 * Return: pointer to parent's struct clk, or error code passed as pointer
Lukasz Majewski0c660c22019-06-24 15:50:42 +0200467 */
468struct clk *clk_get_parent(struct clk *clk);
469
470/**
Lukasz Majewski4aa78302019-06-24 15:50:43 +0200471 * clk_get_parent_rate() - Get parent of current clock rate.
Lukasz Majewski4aa78302019-06-24 15:50:43 +0200472 * @clk: A clock struct that was previously successfully requested by
473 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500474 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100475 * Return: clock rate in Hz, or -ve error code.
Lukasz Majewski4aa78302019-06-24 15:50:43 +0200476 */
Michal Suchaneka1265cd2022-09-28 12:37:57 +0200477ulong clk_get_parent_rate(struct clk *clk);
Lukasz Majewski4aa78302019-06-24 15:50:43 +0200478
479/**
Dario Binacchi2983ad52020-12-30 00:06:31 +0100480 * clk_round_rate() - Adjust a rate to the exact rate a clock can provide
Sean Anderson9c88b132021-12-22 12:11:12 -0500481 * @clk: A clock struct that was previously successfully requested by
482 * clk_request/get_by_*().
483 * @rate: desired clock rate in Hz.
Dario Binacchi2983ad52020-12-30 00:06:31 +0100484 *
485 * This answers the question "if I were to pass @rate to clk_set_rate(),
486 * what clock rate would I end up with?" without changing the hardware
Sean Anderson9c88b132021-12-22 12:11:12 -0500487 * in any way. In other words::
Dario Binacchi2983ad52020-12-30 00:06:31 +0100488 *
489 * rate = clk_round_rate(clk, r);
490 *
Sean Anderson9c88b132021-12-22 12:11:12 -0500491 * and::
Dario Binacchi2983ad52020-12-30 00:06:31 +0100492 *
493 * rate = clk_set_rate(clk, r);
494 *
495 * are equivalent except the former does not modify the clock hardware
496 * in any way.
497 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100498 * Return: rounded rate in Hz, or -ve error code.
Dario Binacchi2983ad52020-12-30 00:06:31 +0100499 */
500ulong clk_round_rate(struct clk *clk, ulong rate);
501
502/**
Stephen Warren135aa952016-06-17 09:44:00 -0600503 * clk_set_rate() - Set current clock rate.
Stephen Warren135aa952016-06-17 09:44:00 -0600504 * @clk: A clock struct that was previously successfully requested by
505 * clk_request/get_by_*().
506 * @rate: New clock rate in Hz.
Sean Anderson9c88b132021-12-22 12:11:12 -0500507 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100508 * Return: new rate, or -ve error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600509 */
510ulong clk_set_rate(struct clk *clk, ulong rate);
511
512/**
Philipp Tomsichf7d10462018-01-08 11:15:08 +0100513 * clk_set_parent() - Set current clock parent.
Philipp Tomsichf7d10462018-01-08 11:15:08 +0100514 * @clk: A clock struct that was previously successfully requested by
515 * clk_request/get_by_*().
516 * @parent: A clock struct that was previously successfully requested by
517 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500518 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100519 * Return: new rate, or -ve error code.
Philipp Tomsichf7d10462018-01-08 11:15:08 +0100520 */
521int clk_set_parent(struct clk *clk, struct clk *parent);
522
523/**
Stephen Warren135aa952016-06-17 09:44:00 -0600524 * clk_enable() - Enable (turn on) a clock.
Stephen Warren135aa952016-06-17 09:44:00 -0600525 * @clk: A clock struct that was previously successfully requested by
526 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500527 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100528 * Return: zero on success, or -ve error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600529 */
530int clk_enable(struct clk *clk);
531
532/**
Neil Armstronga855be82018-04-03 11:44:18 +0200533 * clk_enable_bulk() - Enable (turn on) all clocks in a clock bulk struct.
Neil Armstronga855be82018-04-03 11:44:18 +0200534 * @bulk: A clock bulk struct that was previously successfully requested
535 * by clk_get_bulk().
Sean Anderson9c88b132021-12-22 12:11:12 -0500536 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100537 * Return: zero on success, or -ve error code.
Neil Armstronga855be82018-04-03 11:44:18 +0200538 */
539int clk_enable_bulk(struct clk_bulk *bulk);
540
541/**
Stephen Warren135aa952016-06-17 09:44:00 -0600542 * clk_disable() - Disable (turn off) a clock.
Stephen Warren135aa952016-06-17 09:44:00 -0600543 * @clk: A clock struct that was previously successfully requested by
544 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500545 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100546 * Return: zero on success, or -ve error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600547 */
548int clk_disable(struct clk *clk);
549
Neil Armstronga855be82018-04-03 11:44:18 +0200550/**
551 * clk_disable_bulk() - Disable (turn off) all clocks in a clock bulk struct.
Neil Armstronga855be82018-04-03 11:44:18 +0200552 * @bulk: A clock bulk struct that was previously successfully requested
553 * by clk_get_bulk().
Sean Anderson9c88b132021-12-22 12:11:12 -0500554 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100555 * Return: zero on success, or -ve error code.
Neil Armstronga855be82018-04-03 11:44:18 +0200556 */
557int clk_disable_bulk(struct clk_bulk *bulk);
558
Sekhar Noriacbb7cd2019-08-01 19:12:55 +0530559/**
560 * clk_is_match - check if two clk's point to the same hardware clock
561 * @p: clk compared against q
562 * @q: clk compared against p
563 *
Sean Anderson9c88b132021-12-22 12:11:12 -0500564 * Return:
565 * %true if the two struct clk pointers both point to the same hardware clock
566 * node, and %false otherwise. Note that two %NULL clks are treated as matching.
Sekhar Noriacbb7cd2019-08-01 19:12:55 +0530567 */
568bool clk_is_match(const struct clk *p, const struct clk *q);
569
Lukasz Majewski2796af72019-06-24 15:50:44 +0200570/**
571 * clk_get_by_id() - Get the clock by its ID
Lukasz Majewski2796af72019-06-24 15:50:44 +0200572 * @id: The clock ID to search for
Lukasz Majewski2796af72019-06-24 15:50:44 +0200573 * @clkp: A pointer to clock struct that has been found among added clocks
574 * to UCLASS_CLK
Sean Anderson9c88b132021-12-22 12:11:12 -0500575 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100576 * Return: zero on success, or -ENOENT on error
Lukasz Majewski2796af72019-06-24 15:50:44 +0200577 */
578int clk_get_by_id(ulong id, struct clk **clkp);
Peng Fan24576122019-07-31 07:01:23 +0000579
580/**
581 * clk_dev_binded() - Check whether the clk has a device binded
Sean Anderson9c88b132021-12-22 12:11:12 -0500582 * @clk: A pointer to the clk
Peng Fan24576122019-07-31 07:01:23 +0000583 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100584 * Return: true on binded, or false on no
Peng Fan24576122019-07-31 07:01:23 +0000585 */
586bool clk_dev_binded(struct clk *clk);
Patrick Delaunay6f791742020-04-27 15:29:57 +0200587
588#else /* CONFIG_IS_ENABLED(CLK) */
589
590static inline int clk_request(struct udevice *dev, struct clk *clk)
591{
592 return -ENOSYS;
593}
594
Sean Andersonac15e782022-01-15 17:25:04 -0500595static inline void clk_free(struct clk *clk)
Patrick Delaunay6f791742020-04-27 15:29:57 +0200596{
Sean Andersonac15e782022-01-15 17:25:04 -0500597 return;
Patrick Delaunay6f791742020-04-27 15:29:57 +0200598}
599
600static inline ulong clk_get_rate(struct clk *clk)
601{
602 return -ENOSYS;
603}
604
605static inline struct clk *clk_get_parent(struct clk *clk)
606{
607 return ERR_PTR(-ENOSYS);
608}
609
Michal Suchaneka1265cd2022-09-28 12:37:57 +0200610static inline ulong clk_get_parent_rate(struct clk *clk)
Patrick Delaunay6f791742020-04-27 15:29:57 +0200611{
612 return -ENOSYS;
613}
614
Dario Binacchi2983ad52020-12-30 00:06:31 +0100615static inline ulong clk_round_rate(struct clk *clk, ulong rate)
616{
617 return -ENOSYS;
618}
619
Patrick Delaunay6f791742020-04-27 15:29:57 +0200620static inline ulong clk_set_rate(struct clk *clk, ulong rate)
621{
622 return -ENOSYS;
623}
624
625static inline int clk_set_parent(struct clk *clk, struct clk *parent)
626{
627 return -ENOSYS;
628}
629
630static inline int clk_enable(struct clk *clk)
631{
632 return 0;
633}
634
635static inline int clk_enable_bulk(struct clk_bulk *bulk)
636{
637 return 0;
638}
639
640static inline int clk_disable(struct clk *clk)
641{
642 return 0;
643}
644
645static inline int clk_disable_bulk(struct clk_bulk *bulk)
646{
647 return 0;
648}
649
650static inline bool clk_is_match(const struct clk *p, const struct clk *q)
651{
652 return false;
653}
654
655static inline int clk_get_by_id(ulong id, struct clk **clkp)
656{
657 return -ENOSYS;
658}
659
660static inline bool clk_dev_binded(struct clk *clk)
661{
662 return false;
663}
664#endif /* CONFIG_IS_ENABLED(CLK) */
665
666/**
667 * clk_valid() - check if clk is valid
Patrick Delaunay6f791742020-04-27 15:29:57 +0200668 * @clk: the clock to check
Sean Anderson9c88b132021-12-22 12:11:12 -0500669 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100670 * Return: true if valid, or false
Patrick Delaunay6f791742020-04-27 15:29:57 +0200671 */
672static inline bool clk_valid(struct clk *clk)
673{
674 return clk && !!clk->dev;
675}
676
677int soc_clk_dump(void);
678
Stephen Warren135aa952016-06-17 09:44:00 -0600679#endif
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200680
681#define clk_prepare_enable(clk) clk_enable(clk)
682#define clk_disable_unprepare(clk) clk_disable(clk)