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/errno.h>
  13 #include <linux/types.h>
  14
  15 /**
  16  * A clock is a hardware signal that oscillates autonomously at a specific
  17  * frequency and duty cycle. Most hardware modules require one or more clock
  18  * signal to drive their operation. Clock signals are typically generated
  19  * externally to the HW module consuming them, by an entity this API calls a
  20  * clock provider. This API provides a standard means for drivers to enable and
  21  * disable clocks, and to set the rate at which they oscillate.
  22  *
  23  * A driver that implements UCLASS_CLK is a clock provider. A provider will
  24  * often implement multiple separate clocks, since the hardware it manages
  25  * often has this capability. clk-uclass.h describes the interface which
  26  * clock providers must implement.
  27  *
  28  * Clock consumers/clients are the HW modules driven by the clock signals. This
  29  * header file describes the API used by drivers for those HW modules.
  30  */
  31
  32 struct udevice;
  33
  34 /**
  35  * struct clk - A handle to (allowing control of) a single clock.
  36  *
  37  * Clients provide storage for clock handles. The content of the structure is
  38  * managed solely by the clock API and clock drivers. A clock struct is
  39  * initialized by "get"ing the clock struct. The clock struct is passed to all
  40  * other clock APIs to identify which clock signal to operate upon.
  41  *
  42  * @dev: The device which implements the clock signal.
  43  * @rate: The clock rate (in HZ).
  44  * @flags: Flags used across common clock structure (e.g. CLK_)
  45  *         Clock IP blocks specific flags (i.e. mux, div, gate, etc) are defined
  46  *         in struct's for those devices (e.g. struct clk_mux).
  47  * @id: The clock signal ID within the provider.
  48  * @data: An optional data field for scenarios where a single integer ID is not
  49  *        sufficient. If used, it can be populated through an .of_xlate op and
  50  *        processed during the various clock ops.
  51  *
  52  * Should additional information to identify and configure any clock signal
  53  * for any provider be required in the future, the struct could be expanded to
  54  * either (a) add more fields to allow clock providers to store additional
  55  * information, or (b) replace the id field with an opaque pointer, which the
  56  * provider would dynamically allocated during its .of_xlate op, and process
  57  * during is .request op. This may require the addition of an extra op to clean
  58  * up the allocation.
  59  */
  60 struct clk {
  61         struct udevice *dev;
  62         long long rate; /* in HZ */
  63         u32 flags;
  64         int enable_count;
  65         /*
  66          * Written by of_xlate. In the future, we might add more fields here.
  67          */
  68         unsigned long id;
  69         unsigned long data;
  70 };
  71
  72 /**
  73  * struct clk_bulk - A handle to (allowing control of) a bulk of clocks.
  74  *
  75  * Clients provide storage for the clock bulk. The content of the structure is
  76  * managed solely by the clock API. A clock bulk struct is
  77  * initialized by "get"ing the clock bulk struct.
  78  * The clock bulk struct is passed to all other bulk clock APIs to apply
  79  * the API to all the clock in the bulk struct.
  80  *
  81  * @clks: An array of clock handles.
  82  * @count: The number of clock handles in the clks array.
  83  */
  84 struct clk_bulk {
  85         struct clk *clks;
  86         unsigned int count;
  87 };
  88
  89 #if CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(CLK)
  90 struct phandle_1_arg;
  91 int clk_get_by_index_platdata(struct udevice *dev, int index,
  92                               struct phandle_1_arg *cells, struct clk *clk);
  93
  94 /**
  95  * clock_get_by_index - Get/request a clock by integer index.
  96  *
  97  * This looks up and requests a clock. The index is relative to the client
  98  * device; each device is assumed to have n clocks associated with it somehow,
  99  * and this function finds and requests one of them. The mapping of client
 100  * device clock indices to provider clocks may be via device-tree properties,
 101  * board-provided mapping tables, or some other mechanism.
 102  *
 103  * @dev:        The client device.
 104  * @index:      The index of the clock to request, within the client's list of
 105  *              clocks.
 106  * @clock       A pointer to a clock struct to initialize.
 107  * @return 0 if OK, or a negative error code.
 108  */
 109 int clk_get_by_index(struct udevice *dev, int index, struct clk *clk);
 110
 111 /**
 112  * clock_get_by_index_nodev - Get/request a clock by integer index
 113  * without a device.
 114  *
 115  * This is a version of clk_get_by_index() that does not use a device.
 116  *
 117  * @node:       The client ofnode.
 118  * @index:      The index of the clock to request, within the client's list of
 119  *              clocks.
 120  * @clock       A pointer to a clock struct to initialize.
 121  * @return 0 if OK, or a negative error code.
 122  */
 123 int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk);
 124
 125 /**
 126  * clock_get_bulk - Get/request all clocks of a device.
 127  *
 128  * This looks up and requests all clocks of the client device; each device is
 129  * assumed to have n clocks associated with it somehow, and this function finds
 130  * and requests all of them in a separate structure. 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.
 133  *
 134  * @dev:        The client device.
 135  * @bulk        A pointer to a clock bulk struct to initialize.
 136  * @return 0 if OK, or a negative error code.
 137  */
 138 int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk);
 139
 140 /**
 141  * clock_get_by_name - Get/request a clock by name.
 142  *
 143  * This looks up and requests a clock. The name is relative to the client
 144  * device; each device is assumed to have n clocks associated with it somehow,
 145  * and this function finds and requests one of them. The mapping of client
 146  * device clock names to provider clocks may be via device-tree properties,
 147  * board-provided mapping tables, or some other mechanism.
 148  *
 149  * @dev:        The client device.
 150  * @name:       The name of the clock to request, within the client's list of
 151  *              clocks.
 152  * @clock:      A pointer to a clock struct to initialize.
 153  * @return 0 if OK, or a negative error code.
 154  */
 155 int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk);
 156
 157 /**
 158  * clk_release_all() - Disable (turn off)/Free an array of previously
 159  * requested clocks.
 160  *
 161  * For each clock contained in the clock array, this function will check if
 162  * clock has been previously requested and then will disable and free it.
 163  *
 164  * @clk:        A clock struct array that was previously successfully
 165  *              requested by clk_request/get_by_*().
 166  * @count       Number of clock contained in the array
 167  * @return zero on success, or -ve error code.
 168  */
 169 int clk_release_all(struct clk *clk, int count);
 170
 171 #else
 172 static inline int clk_get_by_index(struct udevice *dev, int index,
 173                                    struct clk *clk)
 174 {
 175         return -ENOSYS;
 176 }
 177
 178 static inline int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk)
 179 {
 180         return -ENOSYS;
 181 }
 182
 183 static inline int clk_get_by_name(struct udevice *dev, const char *name,
 184                            struct clk *clk)
 185 {
 186         return -ENOSYS;
 187 }
 188
 189 static inline int clk_release_all(struct clk *clk, int count)
 190 {
 191         return -ENOSYS;
 192 }
 193 #endif
 194
 195 #if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) && \
 196         CONFIG_IS_ENABLED(CLK)
 197 /**
 198  * clk_set_defaults - Process 'assigned-{clocks/clock-parents/clock-rates}'
 199  *                    properties to configure clocks
 200  *
 201  * @dev:        A device to process (the ofnode associated with this device
 202  *              will be processed).
 203  */
 204 int clk_set_defaults(struct udevice *dev);
 205 #else
 206 static inline int clk_set_defaults(struct udevice *dev)
 207 {
 208         return 0;
 209 }
 210 #endif
 211
 212 /**
 213  * clk_release_bulk() - Disable (turn off)/Free an array of previously
 214  * requested clocks in a clock bulk struct.
 215  *
 216  * For each clock contained in the clock bulk struct, this function will check
 217  * if clock has been previously requested and then will disable and free it.
 218  *
 219  * @clk:        A clock bulk struct that was previously successfully
 220  *              requested by clk_get_bulk().
 221  * @return zero on success, or -ve error code.
 222  */
 223 static inline int clk_release_bulk(struct clk_bulk *bulk)
 224 {
 225         return clk_release_all(bulk->clks, bulk->count);
 226 }
 227
 228 /**
 229  * clk_request - Request a clock by provider-specific ID.
 230  *
 231  * This requests a clock using a provider-specific ID. Generally, this function
 232  * should not be used, since clk_get_by_index/name() provide an interface that
 233  * better separates clients from intimate knowledge of clock providers.
 234  * However, this function may be useful in core SoC-specific code.
 235  *
 236  * @dev:        The clock provider device.
 237  * @clock:      A pointer to a clock struct to initialize. The caller must
 238  *              have already initialized any field in this struct which the
 239  *              clock provider uses to identify the clock.
 240  * @return 0 if OK, or a negative error code.
 241  */
 242 int clk_request(struct udevice *dev, struct clk *clk);
 243
 244 /**
 245  * clock_free - Free a previously requested clock.
 246  *
 247  * @clock:      A clock struct that was previously successfully requested by
 248  *              clk_request/get_by_*().
 249  * @return 0 if OK, or a negative error code.
 250  */
 251 int clk_free(struct clk *clk);
 252
 253 /**
 254  * clk_get_rate() - Get current clock rate.
 255  *
 256  * @clk:        A clock struct that was previously successfully requested by
 257  *              clk_request/get_by_*().
 258  * @return clock rate in Hz, or -ve error code.
 259  */
 260 ulong clk_get_rate(struct clk *clk);
 261
 262 /**
 263  * clk_get_parent() - Get current clock's parent.
 264  *
 265  * @clk:        A clock struct that was previously successfully requested by
 266  *              clk_request/get_by_*().
 267  * @return pointer to parent's struct clk, or error code passed as pointer
 268  */
 269 struct clk *clk_get_parent(struct clk *clk);
 270
 271 /**
 272  * clk_get_parent_rate() - Get parent of current clock rate.
 273  *
 274  * @clk:        A clock struct that was previously successfully requested by
 275  *              clk_request/get_by_*().
 276  * @return clock rate in Hz, or -ve error code.
 277  */
 278 long long clk_get_parent_rate(struct clk *clk);
 279
 280 /**
 281  * clk_set_rate() - Set current clock rate.
 282  *
 283  * @clk:        A clock struct that was previously successfully requested by
 284  *              clk_request/get_by_*().
 285  * @rate:       New clock rate in Hz.
 286  * @return new rate, or -ve error code.
 287  */
 288 ulong clk_set_rate(struct clk *clk, ulong rate);
 289
 290 /**
 291  * clk_set_parent() - Set current clock parent.
 292  *
 293  * @clk:        A clock struct that was previously successfully requested by
 294  *              clk_request/get_by_*().
 295  * @parent:     A clock struct that was previously successfully requested by
 296  *              clk_request/get_by_*().
 297  * @return new rate, or -ve error code.
 298  */
 299 int clk_set_parent(struct clk *clk, struct clk *parent);
 300
 301 /**
 302  * clk_enable() - Enable (turn on) a clock.
 303  *
 304  * @clk:        A clock struct that was previously successfully requested by
 305  *              clk_request/get_by_*().
 306  * @return zero on success, or -ve error code.
 307  */
 308 int clk_enable(struct clk *clk);
 309
 310 /**
 311  * clk_enable_bulk() - Enable (turn on) all clocks in a clock bulk struct.
 312  *
 313  * @bulk:       A clock bulk struct that was previously successfully requested
 314  *              by clk_get_bulk().
 315  * @return zero on success, or -ve error code.
 316  */
 317 int clk_enable_bulk(struct clk_bulk *bulk);
 318
 319 /**
 320  * clk_disable() - Disable (turn off) a clock.
 321  *
 322  * @clk:        A clock struct that was previously successfully requested by
 323  *              clk_request/get_by_*().
 324  * @return zero on success, or -ve error code.
 325  */
 326 int clk_disable(struct clk *clk);
 327
 328 /**
 329  * clk_disable_bulk() - Disable (turn off) all clocks in a clock bulk struct.
 330  *
 331  * @bulk:       A clock bulk struct that was previously successfully requested
 332  *              by clk_get_bulk().
 333  * @return zero on success, or -ve error code.
 334  */
 335 int clk_disable_bulk(struct clk_bulk *bulk);
 336
 337 /**
 338  * clk_is_match - check if two clk's point to the same hardware clock
 339  * @p: clk compared against q
 340  * @q: clk compared against p
 341  *
 342  * Returns true if the two struct clk pointers both point to the same hardware
 343  * clock node.
 344  *
 345  * Returns false otherwise. Note that two NULL clks are treated as matching.
 346  */
 347 bool clk_is_match(const struct clk *p, const struct clk *q);
 348
 349 int soc_clk_dump(void);
 350
 351 /**
 352  * clk_valid() - check if clk is valid
 353  *
 354  * @clk:        the clock to check
 355  * @return true if valid, or false
 356  */
 357 static inline bool clk_valid(struct clk *clk)
 358 {
 359         return !!clk->dev;
 360 }
 361
 362 /**
 363  * clk_get_by_id() - Get the clock by its ID
 364  *
 365  * @id: The clock ID to search for
 366  *
 367  * @clkp:       A pointer to clock struct that has been found among added clocks
 368  *              to UCLASS_CLK
 369  * @return zero on success, or -ENOENT on error
 370  */
 371 int clk_get_by_id(ulong id, struct clk **clkp);
 372
 373 /**
 374  * clk_dev_binded() - Check whether the clk has a device binded
 375  *
 376  * @clk         A pointer to the clk
 377  *
 378  * @return true on binded, or false on no
 379  */
 380 bool clk_dev_binded(struct clk *clk);
 381 #endif