Convert CONFIG_SYS_INTERLAKEN et al to Kconfig
[platform/kernel/u-boot.git] / include / clk.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (c) 2015 Google, Inc
4  * Written by Simon Glass <sjg@chromium.org>
5  * Copyright (c) 2016, NVIDIA CORPORATION.
6  */
7
8 #ifndef _CLK_H_
9 #define _CLK_H_
10
11 #include <dm/ofnode.h>
12 #include <linux/err.h>
13 #include <linux/errno.h>
14 #include <linux/types.h>
15
16 /**
17  * DOC: Overview
18  *
19  * 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  *
26  * A driver that implements UCLASS_CLK is a clock provider. A provider will
27  * often implement multiple separate clocks, since the hardware it manages
28  * often has this capability. clk-uclass.h describes the interface which
29  * 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
35 struct udevice;
36
37 /**
38  * struct clk - A handle to (allowing control of) a single clock.
39  * @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.
49  *
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  *
55  * 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
57  * 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  */
63 struct clk {
64         struct udevice *dev;
65         long long rate; /* in HZ */
66         u32 flags;
67         int enable_count;
68         /*
69          * Written by of_xlate. In the future, we might add more fields here.
70          */
71         unsigned long id;
72         unsigned long data;
73 };
74
75 /**
76  * struct clk_bulk - A handle to (allowing control of) a bulk of clocks.
77  * @clks: An array of clock handles.
78  * @count: The number of clock handles in the clks array.
79  *
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.
85  */
86 struct clk_bulk {
87         struct clk *clks;
88         unsigned int count;
89 };
90
91 struct phandle_1_arg;
92
93 #if CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(CLK)
94 /**
95  * clk_get_by_phandle() - Get a clock by its phandle information (of-platadata)
96  * @dev: Device containing the phandle
97  * @cells: Phandle info
98  * @clk: A pointer to a clock struct to initialise
99  *
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
103  * 'clocks' property is transformed into an idx representing the device.
104  * For example::
105  *
106  *      clocks = <&dpll_mpu_ck 23>;
107  *
108  * might result in::
109  *
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  *
117  * Return: 0 if OK, or a negative error code.
118  */
119 int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells,
120                        struct clk *clk);
121
122 /**
123  * clk_get_by_index() - Get/request a clock by integer index.
124  * @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.
128  *
129  * 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.
134  *
135  * Return: 0 if OK, or a negative error code.
136  */
137 int clk_get_by_index(struct udevice *dev, int index, struct clk *clk);
138
139 /**
140  * clk_get_by_index_nodev() - Get/request a clock by integer index without a
141  *                            device.
142  * @node:       The client ofnode.
143  * @index:      The index of the clock to request, within the client's list of
144  *              clocks.
145  * @clk:        A pointer to a clock struct to initialize.
146  *
147  * Return: 0 if OK, or a negative error code.
148  */
149 int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk);
150
151 /**
152  * 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.
155  *
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  *
162  * Return: 0 if OK, or a negative error code.
163  */
164 int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk);
165
166 /**
167  * 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.
172  *
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  *
179  * Return: 0 if OK, or a negative error code.
180  */
181 int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk);
182
183 /**
184  * clk_get_by_name_nodev - Get/request a clock by name without a device.
185  * @node:       The client ofnode.
186  * @name:       The name of the clock to request, within the client's list of
187  *              clocks.
188  * @clk:        A pointer to a clock struct to initialize.
189  *
190  * Return: 0 if OK, or a negative error code.
191  */
192 int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk);
193
194 /**
195  * devm_clk_get() - lookup and obtain a managed reference to a clock producer.
196  * @dev: device for clock "consumer"
197  * @id: clock consumer ID
198  *
199  * 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.)
202  *
203  * Drivers must assume that the clock source is not enabled.
204  *
205  * The clock will automatically be freed when the device is unbound
206  * from the bus.
207  *
208  * Return:
209  * a struct clk corresponding to the clock producer, or
210  * valid IS_ERR() condition containing errno
211  */
212 struct clk *devm_clk_get(struct udevice *dev, const char *id);
213
214 /**
215  * devm_clk_get_optional() - lookup and obtain a managed reference to an
216  *                           optional clock producer.
217  * @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.
221  * In this case, instead of returning -%ENOENT, the function returns NULL.
222  */
223 static 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 }
233
234 /**
235  * clk_release_all() - Disable (turn off)/Free an array of previously
236  * requested clocks.
237  * @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
240  *
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  *
244  * Return: zero on success, or -ve error code.
245  */
246 int clk_release_all(struct clk *clk, int count);
247
248 /**
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  */
259 void devm_clk_put(struct udevice *dev, struct clk *clk);
260
261 #else
262
263 static 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
270 static inline int clk_get_by_index(struct udevice *dev, int index,
271                                    struct clk *clk)
272 {
273         return -ENOSYS;
274 }
275
276 static inline int clk_get_by_index_nodev(ofnode node, int index,
277                                          struct clk *clk)
278 {
279         return -ENOSYS;
280 }
281
282 static inline int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk)
283 {
284         return -ENOSYS;
285 }
286
287 static inline int clk_get_by_name(struct udevice *dev, const char *name,
288                            struct clk *clk)
289 {
290         return -ENOSYS;
291 }
292
293 static inline struct clk *devm_clk_get(struct udevice *dev, const char *id)
294 {
295         return ERR_PTR(-ENOSYS);
296 }
297
298 static inline struct clk *devm_clk_get_optional(struct udevice *dev,
299                                                 const char *id)
300 {
301         return ERR_PTR(-ENOSYS);
302 }
303
304 static inline int
305 clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk)
306 {
307         return -ENOSYS;
308 }
309
310 static inline int clk_release_all(struct clk *clk, int count)
311 {
312         return -ENOSYS;
313 }
314
315 static inline void devm_clk_put(struct udevice *dev, struct clk *clk)
316 {
317 }
318 #endif
319
320 /**
321  * 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  */
332 static 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 /**
345  * clk_get_by_name_nodev_optional - Get/request an optinonal clock by name
346  *              without a device.
347  * @node:       The client ofnode.
348  * @name:       The name of the clock to request, within the client's list of
349  *              clocks.
350  * @clk:        A pointer to a clock struct to initialize.
351  *
352  * Behaves the same as clk_get_by_name_nodev() except where there is
353  * no clock producer, in this case, skip the error number -%ENODATA, and
354  * the function returns 0.
355  */
356 static 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 /**
369  * 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  */
385 enum clk_defaults_stage {
386         CLK_DEFAULTS_PRE = 0,
387         CLK_DEFAULTS_POST = 1,
388         CLK_DEFAULTS_POST_FORCE,
389 };
390
391 #if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(CLK)
392 /**
393  * clk_set_defaults - Process ``assigned-{clocks/clock-parents/clock-rates}``
394  *                    properties to configure clocks
395  * @dev:        A device to process (the ofnode associated with this device
396  *              will be processed).
397  * @stage:      The stage of the probing process this function is called during.
398  *
399  * Return: zero on success, or -ve error code.
400  */
401 int clk_set_defaults(struct udevice *dev, enum clk_defaults_stage stage);
402 #else
403 static inline int clk_set_defaults(struct udevice *dev, int stage)
404 {
405         return 0;
406 }
407 #endif
408
409 /**
410  * clk_release_bulk() - Disable (turn off)/Free an array of previously
411  * requested clocks in a clock bulk struct.
412  * @bulk:       A clock bulk struct that was previously successfully
413  *              requested by clk_get_bulk().
414  *
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  *
418  * Return: zero on success, or -ve error code.
419  */
420 static inline int clk_release_bulk(struct clk_bulk *bulk)
421 {
422         return clk_release_all(bulk->clks, bulk->count);
423 }
424
425 #if CONFIG_IS_ENABLED(CLK)
426 /**
427  * 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.
432  *
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  *
438  * Return: 0 if OK, or a negative error code.
439  */
440 int clk_request(struct udevice *dev, struct clk *clk);
441
442 /**
443  * clk_free() - Free a previously requested clock.
444  * @clk:        A clock struct that was previously successfully requested by
445  *              clk_request/get_by_*().
446  *
447  * Free resources allocated by clk_request() (or any clk_get_* function).
448  */
449 void clk_free(struct clk *clk);
450
451 /**
452  * clk_get_rate() - Get current clock rate.
453  * @clk:        A clock struct that was previously successfully requested by
454  *              clk_request/get_by_*().
455  *
456  * Return: clock rate in Hz on success, 0 for invalid clock, or -ve error code
457  *         for other errors.
458  */
459 ulong clk_get_rate(struct clk *clk);
460
461 /**
462  * clk_get_parent() - Get current clock's parent.
463  * @clk:        A clock struct that was previously successfully requested by
464  *              clk_request/get_by_*().
465  *
466  * Return: pointer to parent's struct clk, or error code passed as pointer
467  */
468 struct clk *clk_get_parent(struct clk *clk);
469
470 /**
471  * clk_get_parent_rate() - Get parent of current clock rate.
472  * @clk:        A clock struct that was previously successfully requested by
473  *              clk_request/get_by_*().
474  *
475  * Return: clock rate in Hz, or -ve error code.
476  */
477 ulong clk_get_parent_rate(struct clk *clk);
478
479 /**
480  * clk_round_rate() - Adjust a rate to the exact rate a clock can provide
481  * @clk: A clock struct that was previously successfully requested by
482  *       clk_request/get_by_*().
483  * @rate: desired clock rate in Hz.
484  *
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
487  * in any way. In other words::
488  *
489  *   rate = clk_round_rate(clk, r);
490  *
491  * and::
492  *
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  *
498  * Return: rounded rate in Hz, or -ve error code.
499  */
500 ulong clk_round_rate(struct clk *clk, ulong rate);
501
502 /**
503  * clk_set_rate() - Set current clock rate.
504  * @clk:        A clock struct that was previously successfully requested by
505  *              clk_request/get_by_*().
506  * @rate:       New clock rate in Hz.
507  *
508  * Return: new rate, or -ve error code.
509  */
510 ulong clk_set_rate(struct clk *clk, ulong rate);
511
512 /**
513  * clk_set_parent() - Set current clock parent.
514  * @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_*().
518  *
519  * Return: new rate, or -ve error code.
520  */
521 int clk_set_parent(struct clk *clk, struct clk *parent);
522
523 /**
524  * clk_enable() - Enable (turn on) a clock.
525  * @clk:        A clock struct that was previously successfully requested by
526  *              clk_request/get_by_*().
527  *
528  * Return: zero on success, or -ve error code.
529  */
530 int clk_enable(struct clk *clk);
531
532 /**
533  * clk_enable_bulk() - Enable (turn on) all clocks in a clock bulk struct.
534  * @bulk:       A clock bulk struct that was previously successfully requested
535  *              by clk_get_bulk().
536  *
537  * Return: zero on success, or -ve error code.
538  */
539 int clk_enable_bulk(struct clk_bulk *bulk);
540
541 /**
542  * clk_disable() - Disable (turn off) a clock.
543  * @clk:        A clock struct that was previously successfully requested by
544  *              clk_request/get_by_*().
545  *
546  * Return: zero on success, or -ve error code.
547  */
548 int clk_disable(struct clk *clk);
549
550 /**
551  * clk_disable_bulk() - Disable (turn off) all clocks in a clock bulk struct.
552  * @bulk:       A clock bulk struct that was previously successfully requested
553  *              by clk_get_bulk().
554  *
555  * Return: zero on success, or -ve error code.
556  */
557 int clk_disable_bulk(struct clk_bulk *bulk);
558
559 /**
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  *
564  * 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.
567  */
568 bool clk_is_match(const struct clk *p, const struct clk *q);
569
570 /**
571  * clk_get_by_id() - Get the clock by its ID
572  * @id: The clock ID to search for
573  * @clkp:       A pointer to clock struct that has been found among added clocks
574  *              to UCLASS_CLK
575  *
576  * Return: zero on success, or -ENOENT on error
577  */
578 int clk_get_by_id(ulong id, struct clk **clkp);
579
580 /**
581  * clk_dev_binded() - Check whether the clk has a device binded
582  * @clk:        A pointer to the clk
583  *
584  * Return: true on binded, or false on no
585  */
586 bool clk_dev_binded(struct clk *clk);
587
588 #else /* CONFIG_IS_ENABLED(CLK) */
589
590 static inline int clk_request(struct udevice *dev, struct clk *clk)
591 {
592         return -ENOSYS;
593 }
594
595 static inline void clk_free(struct clk *clk)
596 {
597         return;
598 }
599
600 static inline ulong clk_get_rate(struct clk *clk)
601 {
602         return -ENOSYS;
603 }
604
605 static inline struct clk *clk_get_parent(struct clk *clk)
606 {
607         return ERR_PTR(-ENOSYS);
608 }
609
610 static inline ulong clk_get_parent_rate(struct clk *clk)
611 {
612         return -ENOSYS;
613 }
614
615 static inline ulong clk_round_rate(struct clk *clk, ulong rate)
616 {
617         return -ENOSYS;
618 }
619
620 static inline ulong clk_set_rate(struct clk *clk, ulong rate)
621 {
622         return -ENOSYS;
623 }
624
625 static inline int clk_set_parent(struct clk *clk, struct clk *parent)
626 {
627         return -ENOSYS;
628 }
629
630 static inline int clk_enable(struct clk *clk)
631 {
632         return 0;
633 }
634
635 static inline int clk_enable_bulk(struct clk_bulk *bulk)
636 {
637         return 0;
638 }
639
640 static inline int clk_disable(struct clk *clk)
641 {
642         return 0;
643 }
644
645 static inline int clk_disable_bulk(struct clk_bulk *bulk)
646 {
647         return 0;
648 }
649
650 static inline bool clk_is_match(const struct clk *p, const struct clk *q)
651 {
652         return false;
653 }
654
655 static inline int clk_get_by_id(ulong id, struct clk **clkp)
656 {
657         return -ENOSYS;
658 }
659
660 static 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
668  * @clk:        the clock to check
669  *
670  * Return: true if valid, or false
671  */
672 static inline bool clk_valid(struct clk *clk)
673 {
674         return clk && !!clk->dev;
675 }
676
677 int soc_clk_dump(void);
678
679 #endif
680
681 #define clk_prepare_enable(clk) clk_enable(clk)
682 #define clk_disable_unprepare(clk) clk_disable(clk)