drivers/clk/clkdev.c

   1 /*
   2  * drivers/clk/clkdev.c
   3  *
   4  *  Copyright (C) 2008 Russell King.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  * Helper for the clk API to assist looking up a struct clk.
  11  */
  12 #include <linux/module.h>
  13 #include <linux/kernel.h>
  14 #include <linux/device.h>
  15 #include <linux/list.h>
  16 #include <linux/errno.h>
  17 #include <linux/err.h>
  18 #include <linux/string.h>
  19 #include <linux/mutex.h>
  20 #include <linux/clk.h>
  21 #include <linux/clkdev.h>
  22
  23 static LIST_HEAD(clocks);
  24 static DEFINE_MUTEX(clocks_mutex);
  25
  26 /*
  27  * Find the correct struct clk for the device and connection ID.
  28  * We do slightly fuzzy matching here:
  29  *  An entry with a NULL ID is assumed to be a wildcard.
  30  *  If an entry has a device ID, it must match
  31  *  If an entry has a connection ID, it must match
  32  * Then we take the most specific entry - with the following
  33  * order of precedence: dev+con > dev only > con only.
  34  */
  35 static struct clk_lookup *clk_find(const char *dev_id, const char *con_id)
  36 {
  37         struct clk_lookup *p, *cl = NULL;
  38         int match, best = 0;
  39
  40         list_for_each_entry(p, &clocks, node) {
  41                 match = 0;
  42                 if (p->dev_id) {
  43                         if (!dev_id || strcmp(p->dev_id, dev_id))
  44                                 continue;
  45                         match += 2;
  46                 }
  47                 if (p->con_id) {
  48                         if (!con_id || strcmp(p->con_id, con_id))
  49                                 continue;
  50                         match += 1;
  51                 }
  52
  53                 if (match > best) {
  54                         cl = p;
  55                         if (match != 3)
  56                                 best = match;
  57                         else
  58                                 break;
  59                 }
  60         }
  61         return cl;
  62 }
  63
  64 struct clk *clk_get_sys(const char *dev_id, const char *con_id)
  65 {
  66         struct clk_lookup *cl;
  67
  68         mutex_lock(&clocks_mutex);
  69         cl = clk_find(dev_id, con_id);
  70         if (cl && !__clk_get(cl->clk))
  71                 cl = NULL;
  72         mutex_unlock(&clocks_mutex);
  73
  74         return cl ? cl->clk : ERR_PTR(-ENOENT);
  75 }
  76 EXPORT_SYMBOL(clk_get_sys);
  77
  78 struct clk *clk_get(struct device *dev, const char *con_id)
  79 {
  80         const char *dev_id = dev ? dev_name(dev) : NULL;
  81
  82         return clk_get_sys(dev_id, con_id);
  83 }
  84 EXPORT_SYMBOL(clk_get);
  85
  86 void clk_put(struct clk *clk)
  87 {
  88         __clk_put(clk);
  89 }
  90 EXPORT_SYMBOL(clk_put);
  91
  92 static void devm_clk_release(struct device *dev, void *res)
  93 {
  94         clk_put(*(struct clk **)res);
  95 }
  96
  97 struct clk *devm_clk_get(struct device *dev, const char *id)
  98 {
  99         struct clk **ptr, *clk;
 100
 101         ptr = devres_alloc(devm_clk_release, sizeof(*ptr), GFP_KERNEL);
 102         if (!ptr)
 103                 return ERR_PTR(-ENOMEM);
 104
 105         clk = clk_get(dev, id);
 106         if (!IS_ERR(clk)) {
 107                 *ptr = clk;
 108                 devres_add(dev, ptr);
 109         } else {
 110                 devres_free(ptr);
 111         }
 112
 113         return clk;
 114 }
 115 EXPORT_SYMBOL(devm_clk_get);
 116
 117 static int devm_clk_match(struct device *dev, void *res, void *data)
 118 {
 119         struct clk **c = res;
 120         if (!c || !*c) {
 121                 WARN_ON(!c || !*c);
 122                 return 0;
 123         }
 124         return *c == data;
 125 }
 126
 127 void devm_clk_put(struct device *dev, struct clk *clk)
 128 {
 129         int ret;
 130
 131         ret = devres_destroy(dev, devm_clk_release, devm_clk_match, clk);
 132
 133         WARN_ON(ret);
 134 }
 135 EXPORT_SYMBOL(devm_clk_put);
 136
 137 void clkdev_add(struct clk_lookup *cl)
 138 {
 139         mutex_lock(&clocks_mutex);
 140         list_add_tail(&cl->node, &clocks);
 141         mutex_unlock(&clocks_mutex);
 142 }
 143 EXPORT_SYMBOL(clkdev_add);
 144
 145 void __init clkdev_add_table(struct clk_lookup *cl, size_t num)
 146 {
 147         mutex_lock(&clocks_mutex);
 148         while (num--) {
 149                 list_add_tail(&cl->node, &clocks);
 150                 cl++;
 151         }
 152         mutex_unlock(&clocks_mutex);
 153 }
 154
 155 #define MAX_DEV_ID      20
 156 #define MAX_CON_ID      16
 157
 158 struct clk_lookup_alloc {
 159         struct clk_lookup cl;
 160         char    dev_id[MAX_DEV_ID];
 161         char    con_id[MAX_CON_ID];
 162 };
 163
 164 struct clk_lookup * __init_refok
 165 clkdev_alloc(struct clk *clk, const char *con_id, const char *dev_fmt, ...)
 166 {
 167         struct clk_lookup_alloc *cla;
 168
 169         cla = __clkdev_alloc(sizeof(*cla));
 170         if (!cla)
 171                 return NULL;
 172
 173         cla->cl.clk = clk;
 174         if (con_id) {
 175                 strlcpy(cla->con_id, con_id, sizeof(cla->con_id));
 176                 cla->cl.con_id = cla->con_id;
 177         }
 178
 179         if (dev_fmt) {
 180                 va_list ap;
 181
 182                 va_start(ap, dev_fmt);
 183                 vscnprintf(cla->dev_id, sizeof(cla->dev_id), dev_fmt, ap);
 184                 cla->cl.dev_id = cla->dev_id;
 185                 va_end(ap);
 186         }
 187
 188         return &cla->cl;
 189 }
 190 EXPORT_SYMBOL(clkdev_alloc);
 191
 192 int clk_add_alias(const char *alias, const char *alias_dev_name, char *id,
 193         struct device *dev)
 194 {
 195         struct clk *r = clk_get(dev, id);
 196         struct clk_lookup *l;
 197
 198         if (IS_ERR(r))
 199                 return PTR_ERR(r);
 200
 201         l = clkdev_alloc(r, alias, alias_dev_name);
 202         clk_put(r);
 203         if (!l)
 204                 return -ENODEV;
 205         clkdev_add(l);
 206         return 0;
 207 }
 208 EXPORT_SYMBOL(clk_add_alias);
 209
 210 /*
 211  * clkdev_drop - remove a clock dynamically allocated
 212  */
 213 void clkdev_drop(struct clk_lookup *cl)
 214 {
 215         mutex_lock(&clocks_mutex);
 216         list_del(&cl->node);
 217         mutex_unlock(&clocks_mutex);
 218         kfree(cl);
 219 }
 220 EXPORT_SYMBOL(clkdev_drop);