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/bootmem.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 static 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
 144         for (c = oclks; c->node_name != NULL; c++) {
 145                 strcpy(buf, c->node_name);
 146                 ptr = buf;
 147                 for (i = 0; i < 2; i++)
 148                         tags[i] = NULL;
 149                 num_args = 0;
 150                 while (*ptr) {
 151                         if (*ptr == ':') {
 152                                 if (num_args >= 2) {
 153                                         pr_warn("Bad number of tags on %s\n",
 154                                                 c->node_name);
 155                                         return;
 156                                 }
 157                                 tags[num_args++] = ptr + 1;
 158                                 *ptr = 0;
 159                         }
 160                         ptr++;
 161                 }
 162
 163                 if (num_args && clkctrl_nodes_missing)
 164                         continue;
 165
 166                 node = of_find_node_by_name(NULL, buf);
 167                 if (num_args) {
 168                         parent = node;
 169                         node = of_get_child_by_name(parent, "clk");
 170                         of_node_put(parent);
 171                 }
 172
 173                 clkspec.np = node;
 174                 clkspec.args_count = num_args;
 175                 for (i = 0; i < num_args; i++) {
 176                         ret = kstrtoint(tags[i], i ? 10 : 16, clkspec.args + i);
 177                         if (ret) {
 178                                 pr_warn("Bad tag in %s at %d: %s\n",
 179                                         c->node_name, i, tags[i]);
 180                                 of_node_put(node);
 181                                 return;
 182                         }
 183                 }
 184                 clk = of_clk_get_from_provider(&clkspec);
 185                 of_node_put(node);
 186                 if (!IS_ERR(clk)) {
 187                         c->lk.clk = clk;
 188                         clkdev_add(&c->lk);
 189                 } else {
 190                         if (num_args && !has_clkctrl_data) {
 191                                 struct device_node *np;
 192
 193                                 np = of_find_compatible_node(NULL, NULL,
 194                                                              "ti,clkctrl");
 195                                 if (np) {
 196                                         has_clkctrl_data = true;
 197                                         of_node_put(np);
 198                                 } else {
 199                                         clkctrl_nodes_missing = true;
 200
 201                                         pr_warn("missing clkctrl nodes, please update your dts.\n");
 202                                         continue;
 203                                 }
 204                         }
 205
 206                         pr_warn("failed to lookup clock node %s, ret=%ld\n",
 207                                 c->node_name, PTR_ERR(clk));
 208                 }
 209         }
 210 }
 211
 212 struct clk_init_item {
 213         struct device_node *node;
 214         void *user;
 215         ti_of_clk_init_cb_t func;
 216         struct list_head link;
 217 };
 218
 219 static LIST_HEAD(retry_list);
 220
 221 /**
 222  * ti_clk_retry_init - retries a failed clock init at later phase
 223  * @node: device not for the clock
 224  * @user: user data pointer
 225  * @func: init function to be called for the clock
 226  *
 227  * Adds a failed clock init to the retry list. The retry list is parsed
 228  * once all the other clocks have been initialized.
 229  */
 230 int __init ti_clk_retry_init(struct device_node *node, void *user,
 231                              ti_of_clk_init_cb_t func)
 232 {
 233         struct clk_init_item *retry;
 234
 235         pr_debug("%s: adding to retry list...\n", node->name);
 236         retry = kzalloc(sizeof(*retry), GFP_KERNEL);
 237         if (!retry)
 238                 return -ENOMEM;
 239
 240         retry->node = node;
 241         retry->func = func;
 242         retry->user = user;
 243         list_add(&retry->link, &retry_list);
 244
 245         return 0;
 246 }
 247
 248 /**
 249  * ti_clk_get_reg_addr - get register address for a clock register
 250  * @node: device node for the clock
 251  * @index: register index from the clock node
 252  * @reg: pointer to target register struct
 253  *
 254  * Builds clock register address from device tree information, and returns
 255  * the data via the provided output pointer @reg. Returns 0 on success,
 256  * negative error value on failure.
 257  */
 258 int ti_clk_get_reg_addr(struct device_node *node, int index,
 259                         struct clk_omap_reg *reg)
 260 {
 261         u32 val;
 262         int i;
 263
 264         for (i = 0; i < CLK_MAX_MEMMAPS; i++) {
 265                 if (clocks_node_ptr[i] == node->parent)
 266                         break;
 267         }
 268
 269         if (i == CLK_MAX_MEMMAPS) {
 270                 pr_err("clk-provider not found for %s!\n", node->name);
 271                 return -ENOENT;
 272         }
 273
 274         reg->index = i;
 275
 276         if (of_property_read_u32_index(node, "reg", index, &val)) {
 277                 pr_err("%s must have reg[%d]!\n", node->name, index);
 278                 return -EINVAL;
 279         }
 280
 281         reg->offset = val;
 282         reg->ptr = NULL;
 283
 284         return 0;
 285 }
 286
 287 void ti_clk_latch(struct clk_omap_reg *reg, s8 shift)
 288 {
 289         u32 latch;
 290
 291         if (shift < 0)
 292                 return;
 293
 294         latch = 1 << shift;
 295
 296         ti_clk_ll_ops->clk_rmw(latch, latch, reg);
 297         ti_clk_ll_ops->clk_rmw(0, latch, reg);
 298         ti_clk_ll_ops->clk_readl(reg); /* OCP barrier */
 299 }
 300
 301 /**
 302  * omap2_clk_provider_init - init master clock provider
 303  * @parent: master node
 304  * @index: internal index for clk_reg_ops
 305  * @syscon: syscon regmap pointer for accessing clock registers
 306  * @mem: iomem pointer for the clock provider memory area, only used if
 307  *       syscon is not provided
 308  *
 309  * Initializes a master clock IP block. This basically sets up the
 310  * mapping from clocks node to the memory map index. All the clocks
 311  * are then initialized through the common of_clk_init call, and the
 312  * clocks will access their memory maps based on the node layout.
 313  * Returns 0 in success.
 314  */
 315 int __init omap2_clk_provider_init(struct device_node *parent, int index,
 316                                    struct regmap *syscon, void __iomem *mem)
 317 {
 318         struct device_node *clocks;
 319         struct clk_iomap *io;
 320
 321         /* get clocks for this parent */
 322         clocks = of_get_child_by_name(parent, "clocks");
 323         if (!clocks) {
 324                 pr_err("%s missing 'clocks' child node.\n", parent->name);
 325                 return -EINVAL;
 326         }
 327
 328         /* add clocks node info */
 329         clocks_node_ptr[index] = clocks;
 330
 331         io = kzalloc(sizeof(*io), GFP_KERNEL);
 332         if (!io)
 333                 return -ENOMEM;
 334
 335         io->regmap = syscon;
 336         io->mem = mem;
 337
 338         clk_memmaps[index] = io;
 339
 340         return 0;
 341 }
 342
 343 /**
 344  * omap2_clk_legacy_provider_init - initialize a legacy clock provider
 345  * @index: index for the clock provider
 346  * @mem: iomem pointer for the clock provider memory area
 347  *
 348  * Initializes a legacy clock provider memory mapping.
 349  */
 350 void __init omap2_clk_legacy_provider_init(int index, void __iomem *mem)
 351 {
 352         struct clk_iomap *io;
 353
 354         io = memblock_virt_alloc(sizeof(*io), 0);
 355
 356         io->mem = mem;
 357
 358         clk_memmaps[index] = io;
 359 }
 360
 361 /**
 362  * ti_dt_clk_init_retry_clks - init clocks from the retry list
 363  *
 364  * Initializes any clocks that have failed to initialize before,
 365  * reasons being missing parent node(s) during earlier init. This
 366  * typically happens only for DPLLs which need to have both of their
 367  * parent clocks ready during init.
 368  */
 369 void ti_dt_clk_init_retry_clks(void)
 370 {
 371         struct clk_init_item *retry;
 372         struct clk_init_item *tmp;
 373         int retries = 5;
 374
 375         while (!list_empty(&retry_list) && retries) {
 376                 list_for_each_entry_safe(retry, tmp, &retry_list, link) {
 377                         pr_debug("retry-init: %s\n", retry->node->name);
 378                         retry->func(retry->user, retry->node);
 379                         list_del(&retry->link);
 380                         kfree(retry);
 381                 }
 382                 retries--;
 383         }
 384 }
 385
 386 static const struct of_device_id simple_clk_match_table[] __initconst = {
 387         { .compatible = "fixed-clock" },
 388         { .compatible = "fixed-factor-clock" },
 389         { }
 390 };
 391
 392 /**
 393  * ti_clk_add_aliases - setup clock aliases
 394  *
 395  * Sets up any missing clock aliases. No return value.
 396  */
 397 void __init ti_clk_add_aliases(void)
 398 {
 399         struct device_node *np;
 400         struct clk *clk;
 401
 402         for_each_matching_node(np, simple_clk_match_table) {
 403                 struct of_phandle_args clkspec;
 404
 405                 clkspec.np = np;
 406                 clk = of_clk_get_from_provider(&clkspec);
 407
 408                 ti_clk_add_alias(NULL, clk, np->name);
 409         }
 410 }
 411
 412 /**
 413  * ti_clk_setup_features - setup clock features flags
 414  * @features: features definition to use
 415  *
 416  * Initializes the clock driver features flags based on platform
 417  * provided data. No return value.
 418  */
 419 void __init ti_clk_setup_features(struct ti_clk_features *features)
 420 {
 421         memcpy(&ti_clk_features, features, sizeof(*features));
 422 }
 423
 424 /**
 425  * ti_clk_get_features - get clock driver features flags
 426  *
 427  * Get TI clock driver features description. Returns a pointer
 428  * to the current feature setup.
 429  */
 430 const struct ti_clk_features *ti_clk_get_features(void)
 431 {
 432         return &ti_clk_features;
 433 }
 434
 435 /**
 436  * omap2_clk_enable_init_clocks - prepare & enable a list of clocks
 437  * @clk_names: ptr to an array of strings of clock names to enable
 438  * @num_clocks: number of clock names in @clk_names
 439  *
 440  * Prepare and enable a list of clocks, named by @clk_names.  No
 441  * return value. XXX Deprecated; only needed until these clocks are
 442  * properly claimed and enabled by the drivers or core code that uses
 443  * them.  XXX What code disables & calls clk_put on these clocks?
 444  */
 445 void omap2_clk_enable_init_clocks(const char **clk_names, u8 num_clocks)
 446 {
 447         struct clk *init_clk;
 448         int i;
 449
 450         for (i = 0; i < num_clocks; i++) {
 451                 init_clk = clk_get(NULL, clk_names[i]);
 452                 if (WARN(IS_ERR(init_clk), "could not find init clock %s\n",
 453                          clk_names[i]))
 454                         continue;
 455                 clk_prepare_enable(init_clk);
 456         }
 457 }
 458
 459 /**
 460  * ti_clk_add_alias - add a clock alias for a TI clock
 461  * @dev: device alias for this clock
 462  * @clk: clock handle to create alias for
 463  * @con: connection ID for this clock
 464  *
 465  * Creates a clock alias for a TI clock. Allocates the clock lookup entry
 466  * and assigns the data to it. Returns 0 if successful, negative error
 467  * value otherwise.
 468  */
 469 int ti_clk_add_alias(struct device *dev, struct clk *clk, const char *con)
 470 {
 471         struct clk_lookup *cl;
 472
 473         if (!clk)
 474                 return 0;
 475
 476         if (IS_ERR(clk))
 477                 return PTR_ERR(clk);
 478
 479         cl = kzalloc(sizeof(*cl), GFP_KERNEL);
 480         if (!cl)
 481                 return -ENOMEM;
 482
 483         if (dev)
 484                 cl->dev_id = dev_name(dev);
 485         cl->con_id = con;
 486         cl->clk = clk;
 487
 488         clkdev_add(cl);
 489
 490         return 0;
 491 }
 492
 493 /**
 494  * ti_clk_register - register a TI clock to the common clock framework
 495  * @dev: device for this clock
 496  * @hw: hardware clock handle
 497  * @con: connection ID for this clock
 498  *
 499  * Registers a TI clock to the common clock framework, and adds a clock
 500  * alias for it. Returns a handle to the registered clock if successful,
 501  * ERR_PTR value in failure.
 502  */
 503 struct clk *ti_clk_register(struct device *dev, struct clk_hw *hw,
 504                             const char *con)
 505 {
 506         struct clk *clk;
 507         int ret;
 508
 509         clk = clk_register(dev, hw);
 510         if (IS_ERR(clk))
 511                 return clk;
 512
 513         ret = ti_clk_add_alias(dev, clk, con);
 514         if (ret) {
 515                 clk_unregister(clk);
 516                 return ERR_PTR(ret);
 517         }
 518
 519         return clk;
 520 }