drivers/clk/ti/clk.c

   1 /*
   2  * TI clock support
   3  *
   4  * Copyright (C) 2013 Texas Instruments, Inc.
   5  *
   6  * Tero Kristo <t-kristo@ti.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  * This program is distributed "as is" WITHOUT ANY WARRANTY of any
  13  * kind, whether express or implied; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  */
  17
  18 #include <linux/clk.h>
  19 #include <linux/clk-provider.h>
  20 #include <linux/clkdev.h>
  21 #include <linux/clk/ti.h>
  22 #include <linux/of.h>
  23 #include <linux/of_address.h>
  24 #include <linux/list.h>
  25 #include <linux/regmap.h>
  26 #include <linux/memblock.h>
  27 #include <linux/device.h>
  28
  29 #include "clock.h"
  30
  31 #undef pr_fmt
  32 #define pr_fmt(fmt) "%s: " fmt, __func__
  33
  34 struct ti_clk_ll_ops *ti_clk_ll_ops;
  35 static struct device_node *clocks_node_ptr[CLK_MAX_MEMMAPS];
  36
  37 struct ti_clk_features ti_clk_features;
  38
  39 struct clk_iomap {
  40         struct regmap *regmap;
  41         void __iomem *mem;
  42 };
  43
  44 static struct clk_iomap *clk_memmaps[CLK_MAX_MEMMAPS];
  45
  46 static void clk_memmap_writel(u32 val, const struct clk_omap_reg *reg)
  47 {
  48         struct clk_iomap *io = clk_memmaps[reg->index];
  49
  50         if (reg->ptr)
  51                 writel_relaxed(val, reg->ptr);
  52         else if (io->regmap)
  53                 regmap_write(io->regmap, reg->offset, val);
  54         else
  55                 writel_relaxed(val, io->mem + reg->offset);
  56 }
  57
  58 static void _clk_rmw(u32 val, u32 mask, void __iomem *ptr)
  59 {
  60         u32 v;
  61
  62         v = readl_relaxed(ptr);
  63         v &= ~mask;
  64         v |= val;
  65         writel_relaxed(v, ptr);
  66 }
  67
  68 static void clk_memmap_rmw(u32 val, u32 mask, const struct clk_omap_reg *reg)
  69 {
  70         struct clk_iomap *io = clk_memmaps[reg->index];
  71
  72         if (reg->ptr) {
  73                 _clk_rmw(val, mask, reg->ptr);
  74         } else if (io->regmap) {
  75                 regmap_update_bits(io->regmap, reg->offset, mask, val);
  76         } else {
  77                 _clk_rmw(val, mask, io->mem + reg->offset);
  78         }
  79 }
  80
  81 static u32 clk_memmap_readl(const struct clk_omap_reg *reg)
  82 {
  83         u32 val;
  84         struct clk_iomap *io = clk_memmaps[reg->index];
  85
  86         if (reg->ptr)
  87                 val = readl_relaxed(reg->ptr);
  88         else if (io->regmap)
  89                 regmap_read(io->regmap, reg->offset, &val);
  90         else
  91                 val = readl_relaxed(io->mem + reg->offset);
  92
  93         return val;
  94 }
  95
  96 /**
  97  * ti_clk_setup_ll_ops - setup low level clock operations
  98  * @ops: low level clock ops descriptor
  99  *
 100  * Sets up low level clock operations for TI clock driver. This is used
 101  * to provide various callbacks for the clock driver towards platform
 102  * specific code. Returns 0 on success, -EBUSY if ll_ops have been
 103  * registered already.
 104  */
 105 int ti_clk_setup_ll_ops(struct ti_clk_ll_ops *ops)
 106 {
 107         if (ti_clk_ll_ops) {
 108                 pr_err("Attempt to register ll_ops multiple times.\n");
 109                 return -EBUSY;
 110         }
 111
 112         ti_clk_ll_ops = ops;
 113         ops->clk_readl = clk_memmap_readl;
 114         ops->clk_writel = clk_memmap_writel;
 115         ops->clk_rmw = clk_memmap_rmw;
 116
 117         return 0;
 118 }
 119
 120 /**
 121  * ti_dt_clocks_register - register DT alias clocks during boot
 122  * @oclks: list of clocks to register
 123  *
 124  * Register alias or non-standard DT clock entries during boot. By
 125  * default, DT clocks are found based on their node name. If any
 126  * additional con-id / dev-id -> clock mapping is required, use this
 127  * function to list these.
 128  */
 129 void __init ti_dt_clocks_register(struct ti_dt_clk oclks[])
 130 {
 131         struct ti_dt_clk *c;
 132         struct device_node *node, *parent;
 133         struct clk *clk;
 134         struct of_phandle_args clkspec;
 135         char buf[64];
 136         char *ptr;
 137         char *tags[2];
 138         int i;
 139         int num_args;
 140         int ret;
 141         static bool clkctrl_nodes_missing;
 142         static bool has_clkctrl_data;
 143         static bool compat_mode;
 144
 145         compat_mode = ti_clk_get_features()->flags & TI_CLK_CLKCTRL_COMPAT;
 146
 147         for (c = oclks; c->node_name != NULL; c++) {
 148                 strcpy(buf, c->node_name);
 149                 ptr = buf;
 150                 for (i = 0; i < 2; i++)
 151                         tags[i] = NULL;
 152                 num_args = 0;
 153                 while (*ptr) {
 154                         if (*ptr == ':') {
 155                                 if (num_args >= 2) {
 156                                         pr_warn("Bad number of tags on %s\n",
 157                                                 c->node_name);
 158                                         return;
 159                                 }
 160                                 tags[num_args++] = ptr + 1;
 161                                 *ptr = 0;
 162                         }
 163                         ptr++;
 164                 }
 165
 166                 if (num_args && clkctrl_nodes_missing)
 167                         continue;
 168
 169                 node = of_find_node_by_name(NULL, buf);
 170                 if (num_args && compat_mode) {
 171                         parent = node;
 172                         node = of_get_child_by_name(parent, "clk");
 173                         of_node_put(parent);
 174                 }
 175
 176                 clkspec.np = node;
 177                 clkspec.args_count = num_args;
 178                 for (i = 0; i < num_args; i++) {
 179                         ret = kstrtoint(tags[i], i ? 10 : 16, clkspec.args + i);
 180                         if (ret) {
 181                                 pr_warn("Bad tag in %s at %d: %s\n",
 182                                         c->node_name, i, tags[i]);
 183                                 of_node_put(node);
 184                                 return;
 185                         }
 186                 }
 187                 clk = of_clk_get_from_provider(&clkspec);
 188                 of_node_put(node);
 189                 if (!IS_ERR(clk)) {
 190                         c->lk.clk = clk;
 191                         clkdev_add(&c->lk);
 192                 } else {
 193                         if (num_args && !has_clkctrl_data) {
 194                                 struct device_node *np;
 195
 196                                 np = of_find_compatible_node(NULL, NULL,
 197                                                              "ti,clkctrl");
 198                                 if (np) {
 199                                         has_clkctrl_data = true;
 200                                         of_node_put(np);
 201                                 } else {
 202                                         clkctrl_nodes_missing = true;
 203
 204                                         pr_warn("missing clkctrl nodes, please update your dts.\n");
 205                                         continue;
 206                                 }
 207                         }
 208
 209                         pr_warn("failed to lookup clock node %s, ret=%ld\n",
 210                                 c->node_name, PTR_ERR(clk));
 211                 }
 212         }
 213 }
 214
 215 struct clk_init_item {
 216         struct device_node *node;
 217         void *user;
 218         ti_of_clk_init_cb_t func;
 219         struct list_head link;
 220 };
 221
 222 static LIST_HEAD(retry_list);
 223
 224 /**
 225  * ti_clk_retry_init - retries a failed clock init at later phase
 226  * @node: device not for the clock
 227  * @user: user data pointer
 228  * @func: init function to be called for the clock
 229  *
 230  * Adds a failed clock init to the retry list. The retry list is parsed
 231  * once all the other clocks have been initialized.
 232  */
 233 int __init ti_clk_retry_init(struct device_node *node, void *user,
 234                              ti_of_clk_init_cb_t func)
 235 {
 236         struct clk_init_item *retry;
 237
 238         pr_debug("%pOFn: adding to retry list...\n", node);
 239         retry = kzalloc(sizeof(*retry), GFP_KERNEL);
 240         if (!retry)
 241                 return -ENOMEM;
 242
 243         retry->node = node;
 244         retry->func = func;
 245         retry->user = user;
 246         list_add(&retry->link, &retry_list);
 247
 248         return 0;
 249 }
 250
 251 /**
 252  * ti_clk_get_reg_addr - get register address for a clock register
 253  * @node: device node for the clock
 254  * @index: register index from the clock node
 255  * @reg: pointer to target register struct
 256  *
 257  * Builds clock register address from device tree information, and returns
 258  * the data via the provided output pointer @reg. Returns 0 on success,
 259  * negative error value on failure.
 260  */
 261 int ti_clk_get_reg_addr(struct device_node *node, int index,
 262                         struct clk_omap_reg *reg)
 263 {
 264         u32 val;
 265         int i;
 266
 267         for (i = 0; i < CLK_MAX_MEMMAPS; i++) {
 268                 if (clocks_node_ptr[i] == node->parent)
 269                         break;
 270         }
 271
 272         if (i == CLK_MAX_MEMMAPS) {
 273                 pr_err("clk-provider not found for %pOFn!\n", node);
 274                 return -ENOENT;
 275         }
 276
 277         reg->index = i;
 278
 279         if (of_property_read_u32_index(node, "reg", index, &val)) {
 280                 pr_err("%pOFn must have reg[%d]!\n", node, index);
 281                 return -EINVAL;
 282         }
 283
 284         reg->offset = val;
 285         reg->ptr = NULL;
 286
 287         return 0;
 288 }
 289
 290 void ti_clk_latch(struct clk_omap_reg *reg, s8 shift)
 291 {
 292         u32 latch;
 293
 294         if (shift < 0)
 295                 return;
 296
 297         latch = 1 << shift;
 298
 299         ti_clk_ll_ops->clk_rmw(latch, latch, reg);
 300         ti_clk_ll_ops->clk_rmw(0, latch, reg);
 301         ti_clk_ll_ops->clk_readl(reg); /* OCP barrier */
 302 }
 303
 304 /**
 305  * omap2_clk_provider_init - init master clock provider
 306  * @parent: master node
 307  * @index: internal index for clk_reg_ops
 308  * @syscon: syscon regmap pointer for accessing clock registers
 309  * @mem: iomem pointer for the clock provider memory area, only used if
 310  *       syscon is not provided
 311  *
 312  * Initializes a master clock IP block. This basically sets up the
 313  * mapping from clocks node to the memory map index. All the clocks
 314  * are then initialized through the common of_clk_init call, and the
 315  * clocks will access their memory maps based on the node layout.
 316  * Returns 0 in success.
 317  */
 318 int __init omap2_clk_provider_init(struct device_node *parent, int index,
 319                                    struct regmap *syscon, void __iomem *mem)
 320 {
 321         struct device_node *clocks;
 322         struct clk_iomap *io;
 323
 324         /* get clocks for this parent */
 325         clocks = of_get_child_by_name(parent, "clocks");
 326         if (!clocks) {
 327                 pr_err("%pOFn missing 'clocks' child node.\n", parent);
 328                 return -EINVAL;
 329         }
 330
 331         /* add clocks node info */
 332         clocks_node_ptr[index] = clocks;
 333
 334         io = kzalloc(sizeof(*io), GFP_KERNEL);
 335         if (!io)
 336                 return -ENOMEM;
 337
 338         io->regmap = syscon;
 339         io->mem = mem;
 340
 341         clk_memmaps[index] = io;
 342
 343         return 0;
 344 }
 345
 346 /**
 347  * omap2_clk_legacy_provider_init - initialize a legacy clock provider
 348  * @index: index for the clock provider
 349  * @mem: iomem pointer for the clock provider memory area
 350  *
 351  * Initializes a legacy clock provider memory mapping.
 352  */
 353 void __init omap2_clk_legacy_provider_init(int index, void __iomem *mem)
 354 {
 355         struct clk_iomap *io;
 356
 357         io = memblock_alloc(sizeof(*io), SMP_CACHE_BYTES);
 358
 359         io->mem = mem;
 360
 361         clk_memmaps[index] = io;
 362 }
 363
 364 /**
 365  * ti_dt_clk_init_retry_clks - init clocks from the retry list
 366  *
 367  * Initializes any clocks that have failed to initialize before,
 368  * reasons being missing parent node(s) during earlier init. This
 369  * typically happens only for DPLLs which need to have both of their
 370  * parent clocks ready during init.
 371  */
 372 void ti_dt_clk_init_retry_clks(void)
 373 {
 374         struct clk_init_item *retry;
 375         struct clk_init_item *tmp;
 376         int retries = 5;
 377
 378         while (!list_empty(&retry_list) && retries) {
 379                 list_for_each_entry_safe(retry, tmp, &retry_list, link) {
 380                         pr_debug("retry-init: %pOFn\n", retry->node);
 381                         retry->func(retry->user, retry->node);
 382                         list_del(&retry->link);
 383                         kfree(retry);
 384                 }
 385                 retries--;
 386         }
 387 }
 388
 389 static const struct of_device_id simple_clk_match_table[] __initconst = {
 390         { .compatible = "fixed-clock" },
 391         { .compatible = "fixed-factor-clock" },
 392         { }
 393 };
 394
 395 /**
 396  * ti_clk_add_aliases - setup clock aliases
 397  *
 398  * Sets up any missing clock aliases. No return value.
 399  */
 400 void __init ti_clk_add_aliases(void)
 401 {
 402         struct device_node *np;
 403         struct clk *clk;
 404
 405         for_each_matching_node(np, simple_clk_match_table) {
 406                 struct of_phandle_args clkspec;
 407
 408                 clkspec.np = np;
 409                 clk = of_clk_get_from_provider(&clkspec);
 410
 411                 ti_clk_add_alias(NULL, clk, np->name);
 412         }
 413 }
 414
 415 /**
 416  * ti_clk_setup_features - setup clock features flags
 417  * @features: features definition to use
 418  *
 419  * Initializes the clock driver features flags based on platform
 420  * provided data. No return value.
 421  */
 422 void __init ti_clk_setup_features(struct ti_clk_features *features)
 423 {
 424         memcpy(&ti_clk_features, features, sizeof(*features));
 425 }
 426
 427 /**
 428  * ti_clk_get_features - get clock driver features flags
 429  *
 430  * Get TI clock driver features description. Returns a pointer
 431  * to the current feature setup.
 432  */
 433 const struct ti_clk_features *ti_clk_get_features(void)
 434 {
 435         return &ti_clk_features;
 436 }
 437
 438 /**
 439  * omap2_clk_enable_init_clocks - prepare & enable a list of clocks
 440  * @clk_names: ptr to an array of strings of clock names to enable
 441  * @num_clocks: number of clock names in @clk_names
 442  *
 443  * Prepare and enable a list of clocks, named by @clk_names.  No
 444  * return value. XXX Deprecated; only needed until these clocks are
 445  * properly claimed and enabled by the drivers or core code that uses
 446  * them.  XXX What code disables & calls clk_put on these clocks?
 447  */
 448 void omap2_clk_enable_init_clocks(const char **clk_names, u8 num_clocks)
 449 {
 450         struct clk *init_clk;
 451         int i;
 452
 453         for (i = 0; i < num_clocks; i++) {
 454                 init_clk = clk_get(NULL, clk_names[i]);
 455                 if (WARN(IS_ERR(init_clk), "could not find init clock %s\n",
 456                          clk_names[i]))
 457                         continue;
 458                 clk_prepare_enable(init_clk);
 459         }
 460 }
 461
 462 /**
 463  * ti_clk_add_alias - add a clock alias for a TI clock
 464  * @dev: device alias for this clock
 465  * @clk: clock handle to create alias for
 466  * @con: connection ID for this clock
 467  *
 468  * Creates a clock alias for a TI clock. Allocates the clock lookup entry
 469  * and assigns the data to it. Returns 0 if successful, negative error
 470  * value otherwise.
 471  */
 472 int ti_clk_add_alias(struct device *dev, struct clk *clk, const char *con)
 473 {
 474         struct clk_lookup *cl;
 475
 476         if (!clk)
 477                 return 0;
 478
 479         if (IS_ERR(clk))
 480                 return PTR_ERR(clk);
 481
 482         cl = kzalloc(sizeof(*cl), GFP_KERNEL);
 483         if (!cl)
 484                 return -ENOMEM;
 485
 486         if (dev)
 487                 cl->dev_id = dev_name(dev);
 488         cl->con_id = con;
 489         cl->clk = clk;
 490
 491         clkdev_add(cl);
 492
 493         return 0;
 494 }
 495
 496 /**
 497  * ti_clk_register - register a TI clock to the common clock framework
 498  * @dev: device for this clock
 499  * @hw: hardware clock handle
 500  * @con: connection ID for this clock
 501  *
 502  * Registers a TI clock to the common clock framework, and adds a clock
 503  * alias for it. Returns a handle to the registered clock if successful,
 504  * ERR_PTR value in failure.
 505  */
 506 struct clk *ti_clk_register(struct device *dev, struct clk_hw *hw,
 507                             const char *con)
 508 {
 509         struct clk *clk;
 510         int ret;
 511
 512         clk = clk_register(dev, hw);
 513         if (IS_ERR(clk))
 514                 return clk;
 515
 516         ret = ti_clk_add_alias(dev, clk, con);
 517         if (ret) {
 518                 clk_unregister(clk);
 519                 return ERR_PTR(ret);
 520         }
 521
 522         return clk;
 523 }