blob: 76bb64bb5ee0ffd64d050806c45b1e0f064c2986 [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
Paul Burton3f96f872016-09-08 07:47:28 +010091#if CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(CLK)
Simon Glass0d154632017-08-29 14:15:56 -060092struct phandle_1_arg;
Simon Glassf0ab8f92021-08-07 07:24:09 -060093/**
94 * clk_get_by_phandle() - Get a clock by its phandle information (of-platadata)
Sean Anderson9c88b132021-12-22 12:11:12 -050095 * @dev: Device containing the phandle
96 * @cells: Phandle info
97 * @clk: A pointer to a clock struct to initialise
Simon Glassf0ab8f92021-08-07 07:24:09 -060098 *
99 * This function is used when of-platdata is enabled.
100 *
101 * This looks up a clock using the phandle info. With dtoc, each phandle in the
Sean Anderson9c88b132021-12-22 12:11:12 -0500102 * 'clocks' property is transformed into an idx representing the device.
103 * For example::
Simon Glassf0ab8f92021-08-07 07:24:09 -0600104 *
105 * clocks = <&dpll_mpu_ck 23>;
106 *
Sean Anderson9c88b132021-12-22 12:11:12 -0500107 * might result in::
Simon Glassf0ab8f92021-08-07 07:24:09 -0600108 *
109 * .clocks = {1, {23}},},
110 *
111 * indicating that the clock is udevice idx 1 in dt-plat.c with an argument of
112 * 23. This function can return a valid clock given the above information. In
113 * this example it would return a clock containing the 'dpll_mpu_ck' device and
114 * the clock ID 23.
115 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100116 * Return: 0 if OK, or a negative error code.
Simon Glassf0ab8f92021-08-07 07:24:09 -0600117 */
118int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells,
119 struct clk *clk);
Simon Glass7423daa2016-07-04 11:58:03 -0600120
Simon Glasse70cc432016-01-20 19:43:02 -0700121/**
Simon Glassf0ab8f92021-08-07 07:24:09 -0600122 * clk_get_by_index() - Get/request a clock by integer index.
Sean Anderson9c88b132021-12-22 12:11:12 -0500123 * @dev: The client device.
124 * @index: The index of the clock to request, within the client's list of
125 * clocks.
126 * @clk: A pointer to a clock struct to initialize.
Simon Glasse70cc432016-01-20 19:43:02 -0700127 *
Stephen Warren135aa952016-06-17 09:44:00 -0600128 * This looks up and requests a clock. The index is relative to the client
129 * device; each device is assumed to have n clocks associated with it somehow,
130 * and this function finds and requests one of them. The mapping of client
131 * device clock indices to provider clocks may be via device-tree properties,
132 * board-provided mapping tables, or some other mechanism.
Simon Glasse70cc432016-01-20 19:43:02 -0700133 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100134 * Return: 0 if OK, or a negative error code.
Simon Glasse70cc432016-01-20 19:43:02 -0700135 */
Stephen Warren135aa952016-06-17 09:44:00 -0600136int clk_get_by_index(struct udevice *dev, int index, struct clk *clk);
137
138/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500139 * clk_get_by_index_nodev() - Get/request a clock by integer index without a
140 * device.
Jagan Teki75f98312019-02-28 00:26:52 +0530141 * @node: The client ofnode.
142 * @index: The index of the clock to request, within the client's list of
143 * clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -0500144 * @clk: A pointer to a clock struct to initialize.
145 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100146 * Return: 0 if OK, or a negative error code.
Jagan Teki75f98312019-02-28 00:26:52 +0530147 */
148int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk);
149
150/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500151 * clk_get_bulk() - Get/request all clocks of a device.
152 * @dev: The client device.
153 * @bulk: A pointer to a clock bulk struct to initialize.
Neil Armstronga855be82018-04-03 11:44:18 +0200154 *
155 * This looks up and requests all clocks of the client device; each device is
156 * assumed to have n clocks associated with it somehow, and this function finds
157 * and requests all of them in a separate structure. The mapping of client
158 * device clock indices to provider clocks may be via device-tree properties,
159 * board-provided mapping tables, or some other mechanism.
160 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100161 * Return: 0 if OK, or a negative error code.
Neil Armstronga855be82018-04-03 11:44:18 +0200162 */
163int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk);
164
165/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500166 * clk_get_by_name() - Get/request a clock by name.
167 * @dev: The client device.
168 * @name: The name of the clock to request, within the client's list of
169 * clocks.
170 * @clk: A pointer to a clock struct to initialize.
Stephen Warren135aa952016-06-17 09:44:00 -0600171 *
172 * This looks up and requests a clock. The name is relative to the client
173 * device; each device is assumed to have n clocks associated with it somehow,
174 * and this function finds and requests one of them. The mapping of client
175 * device clock names to provider clocks may be via device-tree properties,
176 * board-provided mapping tables, or some other mechanism.
177 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100178 * Return: 0 if OK, or a negative error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600179 */
180int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk);
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200181
182/**
Chunfeng Yund6464202020-01-09 11:35:07 +0800183 * clk_get_by_name_nodev - Get/request a clock by name without a device.
Chunfeng Yund6464202020-01-09 11:35:07 +0800184 * @node: The client ofnode.
185 * @name: The name of the clock to request, within the client's list of
186 * clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -0500187 * @clk: A pointer to a clock struct to initialize.
188 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100189 * Return: 0 if OK, or a negative error code.
Chunfeng Yund6464202020-01-09 11:35:07 +0800190 */
191int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk);
192
193/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500194 * devm_clk_get() - lookup and obtain a managed reference to a clock producer.
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200195 * @dev: device for clock "consumer"
196 * @id: clock consumer ID
197 *
Sean Anderson9c88b132021-12-22 12:11:12 -0500198 * The implementation uses @dev and @id to determine the clock consumer, and
199 * thereby the clock producer. (IOW, @id may be identical strings, but clk_get
200 * may return different clock producers depending on @dev.)
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200201 *
202 * Drivers must assume that the clock source is not enabled.
203 *
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200204 * The clock will automatically be freed when the device is unbound
205 * from the bus.
Sean Anderson9c88b132021-12-22 12:11:12 -0500206 *
207 * Return:
208 * a struct clk corresponding to the clock producer, or
209 * valid IS_ERR() condition containing errno
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200210 */
211struct clk *devm_clk_get(struct udevice *dev, const char *id);
212
213/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500214 * devm_clk_get_optional() - lookup and obtain a managed reference to an
215 * optional clock producer.
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200216 * @dev: device for clock "consumer"
217 * @id: clock consumer ID
218 *
219 * Behaves the same as devm_clk_get() except where there is no clock producer.
Sean Anderson9c88b132021-12-22 12:11:12 -0500220 * In this case, instead of returning -%ENOENT, the function returns NULL.
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200221 */
Sean Anderson14cacb02021-12-22 12:11:11 -0500222static inline struct clk *devm_clk_get_optional(struct udevice *dev,
223 const char *id)
224{
225 struct clk *clk = devm_clk_get(dev, id);
226
227 if (PTR_ERR(clk) == -ENODATA)
228 return NULL;
229
230 return clk;
231}
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200232
233/**
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200234 * clk_release_all() - Disable (turn off)/Free an array of previously
235 * requested clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -0500236 * @clk: A clock struct array that was previously successfully
237 * requested by clk_request/get_by_*().
238 * @count: Number of clock contained in the array
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200239 *
240 * For each clock contained in the clock array, this function will check if
241 * clock has been previously requested and then will disable and free it.
242 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100243 * Return: zero on success, or -ve error code.
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200244 */
245int clk_release_all(struct clk *clk, int count);
246
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200247/**
248 * devm_clk_put - "free" a managed clock source
249 * @dev: device used to acquire the clock
250 * @clk: clock source acquired with devm_clk_get()
251 *
252 * Note: drivers must ensure that all clk_enable calls made on this
253 * clock source are balanced by clk_disable calls prior to calling
254 * this function.
255 *
256 * clk_put should not be called from within interrupt context.
257 */
258void devm_clk_put(struct udevice *dev, struct clk *clk);
259
Masahiro Yamada021abf62016-09-26 20:45:27 +0900260#else
261static inline int clk_get_by_index(struct udevice *dev, int index,
262 struct clk *clk)
263{
264 return -ENOSYS;
265}
266
Neil Armstronga855be82018-04-03 11:44:18 +0200267static inline int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk)
268{
269 return -ENOSYS;
270}
271
Masahiro Yamada021abf62016-09-26 20:45:27 +0900272static inline int clk_get_by_name(struct udevice *dev, const char *name,
273 struct clk *clk)
274{
275 return -ENOSYS;
276}
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200277
Chunfeng Yund6464202020-01-09 11:35:07 +0800278static inline int
279clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk)
280{
281 return -ENOSYS;
282}
283
Patrice Chotardb108d8a2017-07-25 13:24:45 +0200284static inline int clk_release_all(struct clk *clk, int count)
285{
286 return -ENOSYS;
287}
Masahiro Yamada021abf62016-09-26 20:45:27 +0900288#endif
Simon Glasse70cc432016-01-20 19:43:02 -0700289
Sean Anderson6e33eba2021-06-11 00:16:07 -0400290/**
Sean Andersone96e2132022-01-15 15:52:47 -0500291 * clk_get_by_name_optional() - Get/request a optional clock by name.
292 * @dev: The client device.
293 * @name: The name of the clock to request, within the client's list of
294 * clocks.
295 * @clk: A pointer to a clock struct to initialize.
296 *
297 * Behaves the same as clk_get_by_name(), except when there is no clock
298 * provider. In the latter case, return 0.
299 *
300 * Return: 0 if OK, or a negative error code.
301 */
302static inline int clk_get_by_name_optional(struct udevice *dev,
303 const char *name, struct clk *clk)
304{
305 int ret;
306
307 ret = clk_get_by_name(dev, name, clk);
308 if (ret == -ENODATA)
309 return 0;
310
311 return ret;
312}
313
314/**
Sean Anderson14cacb02021-12-22 12:11:11 -0500315 * clk_get_by_name_nodev_optional - Get/request an optinonal clock by name
316 * without a device.
317 * @node: The client ofnode.
Sean Anderson14cacb02021-12-22 12:11:11 -0500318 * @name: The name of the clock to request, within the client's list of
319 * clocks.
Sean Anderson9c88b132021-12-22 12:11:12 -0500320 * @clk: A pointer to a clock struct to initialize.
Sean Anderson14cacb02021-12-22 12:11:11 -0500321 *
322 * Behaves the same as clk_get_by_name_nodev() except where there is
Sean Anderson9c88b132021-12-22 12:11:12 -0500323 * no clock producer, in this case, skip the error number -%ENODATA, and
Sean Anderson14cacb02021-12-22 12:11:11 -0500324 * the function returns 0.
325 */
326static inline int clk_get_by_name_nodev_optional(ofnode node, const char *name,
327 struct clk *clk)
328{
329 int ret;
330
331 ret = clk_get_by_name_nodev(node, name, clk);
332 if (ret == -ENODATA)
333 return 0;
334
335 return ret;
336}
337
338/**
Sean Anderson6e33eba2021-06-11 00:16:07 -0400339 * enum clk_defaults_stage - What stage clk_set_defaults() is called at
340 * @CLK_DEFAULTS_PRE: Called before probe. Setting of defaults for clocks owned
341 * by this clock driver will be defered until after probing.
342 * @CLK_DEFAULTS_POST: Called after probe. Only defaults for clocks owned by
343 * this clock driver will be set.
344 * @CLK_DEFAULTS_POST_FORCE: Called after probe, and always set defaults, even
345 * before relocation. Usually, defaults are not set
346 * pre-relocation to avoid setting them twice (when
347 * the device is probed again post-relocation). This
348 * may incur a performance cost as device tree
349 * properties must be parsed for a second time.
350 * However, when not using SPL, pre-relocation may be
351 * the only time we can set defaults for some clocks
352 * (such as those used for the RAM we will relocate
353 * into).
354 */
355enum clk_defaults_stage {
356 CLK_DEFAULTS_PRE = 0,
357 CLK_DEFAULTS_POST = 1,
358 CLK_DEFAULTS_POST_FORCE,
359};
360
Simon Glass414cc152021-08-07 07:24:03 -0600361#if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(CLK)
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100362/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500363 * clk_set_defaults - Process ``assigned-{clocks/clock-parents/clock-rates}``
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100364 * properties to configure clocks
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100365 * @dev: A device to process (the ofnode associated with this device
366 * will be processed).
Sean Anderson6e33eba2021-06-11 00:16:07 -0400367 * @stage: The stage of the probing process this function is called during.
Sean Anderson9c88b132021-12-22 12:11:12 -0500368 *
369 * Return: zero on success, or -ve error code.
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100370 */
Sean Anderson6e33eba2021-06-11 00:16:07 -0400371int clk_set_defaults(struct udevice *dev, enum clk_defaults_stage stage);
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100372#else
Jean-Jacques Hiblotfd1ba292019-10-22 14:00:06 +0200373static inline int clk_set_defaults(struct udevice *dev, int stage)
Philipp Tomsichf4fcba52018-01-08 13:59:18 +0100374{
375 return 0;
376}
377#endif
378
Stephen Warren135aa952016-06-17 09:44:00 -0600379/**
Neil Armstronga855be82018-04-03 11:44:18 +0200380 * clk_release_bulk() - Disable (turn off)/Free an array of previously
381 * requested clocks in a clock bulk struct.
Sean Anderson9c88b132021-12-22 12:11:12 -0500382 * @bulk: A clock bulk struct that was previously successfully
383 * requested by clk_get_bulk().
Neil Armstronga855be82018-04-03 11:44:18 +0200384 *
385 * For each clock contained in the clock bulk struct, this function will check
386 * if clock has been previously requested and then will disable and free it.
387 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100388 * Return: zero on success, or -ve error code.
Neil Armstronga855be82018-04-03 11:44:18 +0200389 */
390static inline int clk_release_bulk(struct clk_bulk *bulk)
391{
392 return clk_release_all(bulk->clks, bulk->count);
393}
394
Patrick Delaunay6f791742020-04-27 15:29:57 +0200395#if CONFIG_IS_ENABLED(CLK)
Neil Armstronga855be82018-04-03 11:44:18 +0200396/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500397 * clk_request() - Request a clock by provider-specific ID.
398 * @dev: The clock provider device.
399 * @clk: A pointer to a clock struct to initialize. The caller must
400 * have already initialized any field in this struct which the
401 * clock provider uses to identify the clock.
Stephen Warren135aa952016-06-17 09:44:00 -0600402 *
403 * This requests a clock using a provider-specific ID. Generally, this function
404 * should not be used, since clk_get_by_index/name() provide an interface that
405 * better separates clients from intimate knowledge of clock providers.
406 * However, this function may be useful in core SoC-specific code.
407 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100408 * Return: 0 if OK, or a negative error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600409 */
410int clk_request(struct udevice *dev, struct clk *clk);
411
412/**
Sean Anderson9c88b132021-12-22 12:11:12 -0500413 * clk_free() - Free a previously requested clock.
414 * @clk: A clock struct that was previously successfully requested by
Stephen Warren135aa952016-06-17 09:44:00 -0600415 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500416 *
Sean Andersonac15e782022-01-15 17:25:04 -0500417 * Free resources allocated by clk_request() (or any clk_get_* function).
Stephen Warren135aa952016-06-17 09:44:00 -0600418 */
Sean Andersonac15e782022-01-15 17:25:04 -0500419void clk_free(struct clk *clk);
Stephen Warren135aa952016-06-17 09:44:00 -0600420
421/**
422 * clk_get_rate() - Get current clock rate.
Stephen Warren135aa952016-06-17 09:44:00 -0600423 * @clk: A clock struct that was previously successfully requested by
424 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500425 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100426 * Return: clock rate in Hz on success, 0 for invalid clock, or -ve error code
Giulio Benetti9e578f62021-02-14 03:17:18 +0100427 * for other errors.
Stephen Warren135aa952016-06-17 09:44:00 -0600428 */
429ulong clk_get_rate(struct clk *clk);
430
431/**
Lukasz Majewski0c660c22019-06-24 15:50:42 +0200432 * clk_get_parent() - Get current clock's parent.
Lukasz Majewski0c660c22019-06-24 15:50:42 +0200433 * @clk: A clock struct that was previously successfully requested by
434 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500435 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100436 * Return: pointer to parent's struct clk, or error code passed as pointer
Lukasz Majewski0c660c22019-06-24 15:50:42 +0200437 */
438struct clk *clk_get_parent(struct clk *clk);
439
440/**
Lukasz Majewski4aa78302019-06-24 15:50:43 +0200441 * clk_get_parent_rate() - Get parent of current clock rate.
Lukasz Majewski4aa78302019-06-24 15:50:43 +0200442 * @clk: A clock struct that was previously successfully requested by
443 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500444 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100445 * Return: clock rate in Hz, or -ve error code.
Lukasz Majewski4aa78302019-06-24 15:50:43 +0200446 */
447long long clk_get_parent_rate(struct clk *clk);
448
449/**
Dario Binacchi2983ad52020-12-30 00:06:31 +0100450 * clk_round_rate() - Adjust a rate to the exact rate a clock can provide
Sean Anderson9c88b132021-12-22 12:11:12 -0500451 * @clk: A clock struct that was previously successfully requested by
452 * clk_request/get_by_*().
453 * @rate: desired clock rate in Hz.
Dario Binacchi2983ad52020-12-30 00:06:31 +0100454 *
455 * This answers the question "if I were to pass @rate to clk_set_rate(),
456 * what clock rate would I end up with?" without changing the hardware
Sean Anderson9c88b132021-12-22 12:11:12 -0500457 * in any way. In other words::
Dario Binacchi2983ad52020-12-30 00:06:31 +0100458 *
459 * rate = clk_round_rate(clk, r);
460 *
Sean Anderson9c88b132021-12-22 12:11:12 -0500461 * and::
Dario Binacchi2983ad52020-12-30 00:06:31 +0100462 *
463 * rate = clk_set_rate(clk, r);
464 *
465 * are equivalent except the former does not modify the clock hardware
466 * in any way.
467 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100468 * Return: rounded rate in Hz, or -ve error code.
Dario Binacchi2983ad52020-12-30 00:06:31 +0100469 */
470ulong clk_round_rate(struct clk *clk, ulong rate);
471
472/**
Stephen Warren135aa952016-06-17 09:44:00 -0600473 * clk_set_rate() - Set current clock rate.
Stephen Warren135aa952016-06-17 09:44:00 -0600474 * @clk: A clock struct that was previously successfully requested by
475 * clk_request/get_by_*().
476 * @rate: New clock rate in Hz.
Sean Anderson9c88b132021-12-22 12:11:12 -0500477 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100478 * Return: new rate, or -ve error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600479 */
480ulong clk_set_rate(struct clk *clk, ulong rate);
481
482/**
Philipp Tomsichf7d10462018-01-08 11:15:08 +0100483 * clk_set_parent() - Set current clock parent.
Philipp Tomsichf7d10462018-01-08 11:15:08 +0100484 * @clk: A clock struct that was previously successfully requested by
485 * clk_request/get_by_*().
486 * @parent: A clock struct that was previously successfully requested by
487 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500488 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100489 * Return: new rate, or -ve error code.
Philipp Tomsichf7d10462018-01-08 11:15:08 +0100490 */
491int clk_set_parent(struct clk *clk, struct clk *parent);
492
493/**
Stephen Warren135aa952016-06-17 09:44:00 -0600494 * clk_enable() - Enable (turn on) a clock.
Stephen Warren135aa952016-06-17 09:44:00 -0600495 * @clk: A clock struct that was previously successfully requested by
496 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500497 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100498 * Return: zero on success, or -ve error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600499 */
500int clk_enable(struct clk *clk);
501
502/**
Neil Armstronga855be82018-04-03 11:44:18 +0200503 * clk_enable_bulk() - Enable (turn on) all clocks in a clock bulk struct.
Neil Armstronga855be82018-04-03 11:44:18 +0200504 * @bulk: A clock bulk struct that was previously successfully requested
505 * by clk_get_bulk().
Sean Anderson9c88b132021-12-22 12:11:12 -0500506 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100507 * Return: zero on success, or -ve error code.
Neil Armstronga855be82018-04-03 11:44:18 +0200508 */
509int clk_enable_bulk(struct clk_bulk *bulk);
510
511/**
Stephen Warren135aa952016-06-17 09:44:00 -0600512 * clk_disable() - Disable (turn off) a clock.
Stephen Warren135aa952016-06-17 09:44:00 -0600513 * @clk: A clock struct that was previously successfully requested by
514 * clk_request/get_by_*().
Sean Anderson9c88b132021-12-22 12:11:12 -0500515 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100516 * Return: zero on success, or -ve error code.
Stephen Warren135aa952016-06-17 09:44:00 -0600517 */
518int clk_disable(struct clk *clk);
519
Neil Armstronga855be82018-04-03 11:44:18 +0200520/**
521 * clk_disable_bulk() - Disable (turn off) all clocks in a clock bulk struct.
Neil Armstronga855be82018-04-03 11:44:18 +0200522 * @bulk: A clock bulk struct that was previously successfully requested
523 * by clk_get_bulk().
Sean Anderson9c88b132021-12-22 12:11:12 -0500524 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100525 * Return: zero on success, or -ve error code.
Neil Armstronga855be82018-04-03 11:44:18 +0200526 */
527int clk_disable_bulk(struct clk_bulk *bulk);
528
Sekhar Noriacbb7cd2019-08-01 19:12:55 +0530529/**
530 * clk_is_match - check if two clk's point to the same hardware clock
531 * @p: clk compared against q
532 * @q: clk compared against p
533 *
Sean Anderson9c88b132021-12-22 12:11:12 -0500534 * Return:
535 * %true if the two struct clk pointers both point to the same hardware clock
536 * node, and %false otherwise. Note that two %NULL clks are treated as matching.
Sekhar Noriacbb7cd2019-08-01 19:12:55 +0530537 */
538bool clk_is_match(const struct clk *p, const struct clk *q);
539
Lukasz Majewski2796af72019-06-24 15:50:44 +0200540/**
541 * clk_get_by_id() - Get the clock by its ID
Lukasz Majewski2796af72019-06-24 15:50:44 +0200542 * @id: The clock ID to search for
Lukasz Majewski2796af72019-06-24 15:50:44 +0200543 * @clkp: A pointer to clock struct that has been found among added clocks
544 * to UCLASS_CLK
Sean Anderson9c88b132021-12-22 12:11:12 -0500545 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100546 * Return: zero on success, or -ENOENT on error
Lukasz Majewski2796af72019-06-24 15:50:44 +0200547 */
548int clk_get_by_id(ulong id, struct clk **clkp);
Peng Fan24576122019-07-31 07:01:23 +0000549
550/**
551 * clk_dev_binded() - Check whether the clk has a device binded
Sean Anderson9c88b132021-12-22 12:11:12 -0500552 * @clk: A pointer to the clk
Peng Fan24576122019-07-31 07:01:23 +0000553 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100554 * Return: true on binded, or false on no
Peng Fan24576122019-07-31 07:01:23 +0000555 */
556bool clk_dev_binded(struct clk *clk);
Patrick Delaunay6f791742020-04-27 15:29:57 +0200557
558#else /* CONFIG_IS_ENABLED(CLK) */
559
560static inline int clk_request(struct udevice *dev, struct clk *clk)
561{
562 return -ENOSYS;
563}
564
Sean Andersonac15e782022-01-15 17:25:04 -0500565static inline void clk_free(struct clk *clk)
Patrick Delaunay6f791742020-04-27 15:29:57 +0200566{
Sean Andersonac15e782022-01-15 17:25:04 -0500567 return;
Patrick Delaunay6f791742020-04-27 15:29:57 +0200568}
569
570static inline ulong clk_get_rate(struct clk *clk)
571{
572 return -ENOSYS;
573}
574
575static inline struct clk *clk_get_parent(struct clk *clk)
576{
577 return ERR_PTR(-ENOSYS);
578}
579
580static inline long long clk_get_parent_rate(struct clk *clk)
581{
582 return -ENOSYS;
583}
584
Dario Binacchi2983ad52020-12-30 00:06:31 +0100585static inline ulong clk_round_rate(struct clk *clk, ulong rate)
586{
587 return -ENOSYS;
588}
589
Patrick Delaunay6f791742020-04-27 15:29:57 +0200590static inline ulong clk_set_rate(struct clk *clk, ulong rate)
591{
592 return -ENOSYS;
593}
594
595static inline int clk_set_parent(struct clk *clk, struct clk *parent)
596{
597 return -ENOSYS;
598}
599
600static inline int clk_enable(struct clk *clk)
601{
602 return 0;
603}
604
605static inline int clk_enable_bulk(struct clk_bulk *bulk)
606{
607 return 0;
608}
609
610static inline int clk_disable(struct clk *clk)
611{
612 return 0;
613}
614
615static inline int clk_disable_bulk(struct clk_bulk *bulk)
616{
617 return 0;
618}
619
620static inline bool clk_is_match(const struct clk *p, const struct clk *q)
621{
622 return false;
623}
624
625static inline int clk_get_by_id(ulong id, struct clk **clkp)
626{
627 return -ENOSYS;
628}
629
630static inline bool clk_dev_binded(struct clk *clk)
631{
632 return false;
633}
634#endif /* CONFIG_IS_ENABLED(CLK) */
635
636/**
637 * clk_valid() - check if clk is valid
Patrick Delaunay6f791742020-04-27 15:29:57 +0200638 * @clk: the clock to check
Sean Anderson9c88b132021-12-22 12:11:12 -0500639 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100640 * Return: true if valid, or false
Patrick Delaunay6f791742020-04-27 15:29:57 +0200641 */
642static inline bool clk_valid(struct clk *clk)
643{
644 return clk && !!clk->dev;
645}
646
647int soc_clk_dump(void);
648
Stephen Warren135aa952016-06-17 09:44:00 -0600649#endif
Jean-Jacques Hiblot52720c52019-10-22 14:00:04 +0200650
651#define clk_prepare_enable(clk) clk_enable(clk)
652#define clk_disable_unprepare(clk) clk_disable(clk)