regmap: add regmap_bulk_write() for register write
[linux-2.6.git] / drivers / base / regmap / regcache.c
1 /*
2  * Register cache access API
3  *
4  * Copyright 2011 Wolfson Microelectronics plc
5  *
6  * Author: Dimitris Papastamos <dp@opensource.wolfsonmicro.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
13 #include <linux/slab.h>
14 #include <linux/export.h>
15 #include <trace/events/regmap.h>
16 #include <linux/bsearch.h>
17 #include <linux/sort.h>
18
19 #include "internal.h"
20
21 static const struct regcache_ops *cache_types[] = {
22         &regcache_rbtree_ops,
23         &regcache_lzo_ops,
24 };
25
26 static int regcache_hw_init(struct regmap *map)
27 {
28         int i, j;
29         int ret;
30         int count;
31         unsigned int val;
32         void *tmp_buf;
33
34         if (!map->num_reg_defaults_raw)
35                 return -EINVAL;
36
37         if (!map->reg_defaults_raw) {
38                 dev_warn(map->dev, "No cache defaults, reading back from HW\n");
39                 tmp_buf = kmalloc(map->cache_size_raw, GFP_KERNEL);
40                 if (!tmp_buf)
41                         return -EINVAL;
42                 ret = regmap_bulk_read(map, 0, tmp_buf,
43                                        map->num_reg_defaults_raw);
44                 if (ret < 0) {
45                         kfree(tmp_buf);
46                         return ret;
47                 }
48                 map->reg_defaults_raw = tmp_buf;
49                 map->cache_free = 1;
50         }
51
52         /* calculate the size of reg_defaults */
53         for (count = 0, i = 0; i < map->num_reg_defaults_raw; i++) {
54                 val = regcache_get_val(map->reg_defaults_raw,
55                                        i, map->cache_word_size);
56                 if (regmap_volatile(map, i))
57                         continue;
58                 count++;
59         }
60
61         map->reg_defaults = kmalloc(count * sizeof(struct reg_default),
62                                       GFP_KERNEL);
63         if (!map->reg_defaults) {
64                 ret = -ENOMEM;
65                 goto err_free;
66         }
67
68         /* fill the reg_defaults */
69         map->num_reg_defaults = count;
70         for (i = 0, j = 0; i < map->num_reg_defaults_raw; i++) {
71                 val = regcache_get_val(map->reg_defaults_raw,
72                                        i, map->cache_word_size);
73                 if (regmap_volatile(map, i))
74                         continue;
75                 map->reg_defaults[j].reg = i;
76                 map->reg_defaults[j].def = val;
77                 j++;
78         }
79
80         return 0;
81
82 err_free:
83         if (map->cache_free)
84                 kfree(map->reg_defaults_raw);
85
86         return ret;
87 }
88
89 int regcache_init(struct regmap *map, const struct regmap_config *config)
90 {
91         int ret;
92         int i;
93         void *tmp_buf;
94
95         if (map->cache_type == REGCACHE_NONE) {
96                 map->cache_bypass = true;
97                 return 0;
98         }
99
100         for (i = 0; i < ARRAY_SIZE(cache_types); i++)
101                 if (cache_types[i]->type == map->cache_type)
102                         break;
103
104         if (i == ARRAY_SIZE(cache_types)) {
105                 dev_err(map->dev, "Could not match compress type: %d\n",
106                         map->cache_type);
107                 return -EINVAL;
108         }
109
110         map->num_reg_defaults = config->num_reg_defaults;
111         map->num_reg_defaults_raw = config->num_reg_defaults_raw;
112         map->reg_defaults_raw = config->reg_defaults_raw;
113         map->cache_word_size = DIV_ROUND_UP(config->val_bits, 8);
114         map->cache_size_raw = map->cache_word_size * config->num_reg_defaults_raw;
115
116         map->cache = NULL;
117         map->cache_ops = cache_types[i];
118
119         if (!map->cache_ops->read ||
120             !map->cache_ops->write ||
121             !map->cache_ops->name)
122                 return -EINVAL;
123
124         /* We still need to ensure that the reg_defaults
125          * won't vanish from under us.  We'll need to make
126          * a copy of it.
127          */
128         if (config->reg_defaults) {
129                 if (!map->num_reg_defaults)
130                         return -EINVAL;
131                 tmp_buf = kmemdup(config->reg_defaults, map->num_reg_defaults *
132                                   sizeof(struct reg_default), GFP_KERNEL);
133                 if (!tmp_buf)
134                         return -ENOMEM;
135                 map->reg_defaults = tmp_buf;
136         } else if (map->num_reg_defaults_raw) {
137                 /* Some devices such as PMICs don't have cache defaults,
138                  * we cope with this by reading back the HW registers and
139                  * crafting the cache defaults by hand.
140                  */
141                 ret = regcache_hw_init(map);
142                 if (ret < 0)
143                         return ret;
144         }
145
146         if (!map->max_register)
147                 map->max_register = map->num_reg_defaults_raw;
148
149         if (map->cache_ops->init) {
150                 dev_dbg(map->dev, "Initializing %s cache\n",
151                         map->cache_ops->name);
152                 ret = map->cache_ops->init(map);
153                 if (ret)
154                         goto err_free;
155         }
156         return 0;
157
158 err_free:
159         kfree(map->reg_defaults);
160         if (map->cache_free)
161                 kfree(map->reg_defaults_raw);
162
163         return ret;
164 }
165
166 void regcache_exit(struct regmap *map)
167 {
168         if (map->cache_type == REGCACHE_NONE)
169                 return;
170
171         BUG_ON(!map->cache_ops);
172
173         kfree(map->reg_defaults);
174         if (map->cache_free)
175                 kfree(map->reg_defaults_raw);
176
177         if (map->cache_ops->exit) {
178                 dev_dbg(map->dev, "Destroying %s cache\n",
179                         map->cache_ops->name);
180                 map->cache_ops->exit(map);
181         }
182 }
183
184 /**
185  * regcache_read: Fetch the value of a given register from the cache.
186  *
187  * @map: map to configure.
188  * @reg: The register index.
189  * @value: The value to be returned.
190  *
191  * Return a negative value on failure, 0 on success.
192  */
193 int regcache_read(struct regmap *map,
194                   unsigned int reg, unsigned int *value)
195 {
196         int ret;
197
198         if (map->cache_type == REGCACHE_NONE)
199                 return -ENOSYS;
200
201         BUG_ON(!map->cache_ops);
202
203         if (!regmap_volatile(map, reg)) {
204                 ret = map->cache_ops->read(map, reg, value);
205
206                 if (ret == 0)
207                         trace_regmap_reg_read_cache(map->dev, reg, *value);
208
209                 return ret;
210         }
211
212         return -EINVAL;
213 }
214
215 /**
216  * regcache_write: Set the value of a given register in the cache.
217  *
218  * @map: map to configure.
219  * @reg: The register index.
220  * @value: The new register value.
221  *
222  * Return a negative value on failure, 0 on success.
223  */
224 int regcache_write(struct regmap *map,
225                    unsigned int reg, unsigned int value)
226 {
227         if (map->cache_type == REGCACHE_NONE)
228                 return 0;
229
230         BUG_ON(!map->cache_ops);
231
232         if (!regmap_writeable(map, reg))
233                 return -EIO;
234
235         if (!regmap_volatile(map, reg))
236                 return map->cache_ops->write(map, reg, value);
237
238         return 0;
239 }
240
241 /**
242  * regcache_sync: Sync the register cache with the hardware.
243  *
244  * @map: map to configure.
245  *
246  * Any registers that should not be synced should be marked as
247  * volatile.  In general drivers can choose not to use the provided
248  * syncing functionality if they so require.
249  *
250  * Return a negative value on failure, 0 on success.
251  */
252 int regcache_sync(struct regmap *map)
253 {
254         int ret = 0;
255         unsigned int val;
256         unsigned int i;
257         const char *name;
258         unsigned int bypass;
259
260         BUG_ON(!map->cache_ops);
261
262         mutex_lock(&map->lock);
263         /* Remember the initial bypass state */
264         bypass = map->cache_bypass;
265         dev_dbg(map->dev, "Syncing %s cache\n",
266                 map->cache_ops->name);
267         name = map->cache_ops->name;
268         trace_regcache_sync(map->dev, name, "start");
269
270         if (!map->cache_dirty)
271                 goto out;
272
273         /* Apply any patch first */
274         map->cache_bypass = 1;
275         for (i = 0; i < map->patch_regs; i++) {
276                 ret = _regmap_write(map, map->patch[i].reg, map->patch[i].def);
277                 if (ret != 0) {
278                         dev_err(map->dev, "Failed to write %x = %x: %d\n",
279                                 map->patch[i].reg, map->patch[i].def, ret);
280                         goto out;
281                 }
282         }
283         map->cache_bypass = 0;
284
285         if (map->cache_ops->sync) {
286                 ret = map->cache_ops->sync(map);
287         } else {
288                 for (i = 0; i < map->num_reg_defaults; i++) {
289                         ret = regcache_read(map, i, &val);
290                         if (ret < 0)
291                                 goto out;
292                         map->cache_bypass = 1;
293                         ret = _regmap_write(map, i, val);
294                         map->cache_bypass = 0;
295                         if (ret < 0)
296                                 goto out;
297                         dev_dbg(map->dev, "Synced register %#x, value %#x\n",
298                                 map->reg_defaults[i].reg,
299                                 map->reg_defaults[i].def);
300                 }
301
302         }
303 out:
304         trace_regcache_sync(map->dev, name, "stop");
305         /* Restore the bypass state */
306         map->cache_bypass = bypass;
307         mutex_unlock(&map->lock);
308
309         return ret;
310 }
311 EXPORT_SYMBOL_GPL(regcache_sync);
312
313 /**
314  * regcache_cache_only: Put a register map into cache only mode
315  *
316  * @map: map to configure
317  * @cache_only: flag if changes should be written to the hardware
318  *
319  * When a register map is marked as cache only writes to the register
320  * map API will only update the register cache, they will not cause
321  * any hardware changes.  This is useful for allowing portions of
322  * drivers to act as though the device were functioning as normal when
323  * it is disabled for power saving reasons.
324  */
325 void regcache_cache_only(struct regmap *map, bool enable)
326 {
327         mutex_lock(&map->lock);
328         WARN_ON(map->cache_bypass && enable);
329         map->cache_only = enable;
330         mutex_unlock(&map->lock);
331 }
332 EXPORT_SYMBOL_GPL(regcache_cache_only);
333
334 /**
335  * regcache_mark_dirty: Mark the register cache as dirty
336  *
337  * @map: map to mark
338  *
339  * Mark the register cache as dirty, for example due to the device
340  * having been powered down for suspend.  If the cache is not marked
341  * as dirty then the cache sync will be suppressed.
342  */
343 void regcache_mark_dirty(struct regmap *map)
344 {
345         mutex_lock(&map->lock);
346         map->cache_dirty = true;
347         mutex_unlock(&map->lock);
348 }
349 EXPORT_SYMBOL_GPL(regcache_mark_dirty);
350
351 /**
352  * regcache_cache_bypass: Put a register map into cache bypass mode
353  *
354  * @map: map to configure
355  * @cache_bypass: flag if changes should not be written to the hardware
356  *
357  * When a register map is marked with the cache bypass option, writes
358  * to the register map API will only update the hardware and not the
359  * the cache directly.  This is useful when syncing the cache back to
360  * the hardware.
361  */
362 void regcache_cache_bypass(struct regmap *map, bool enable)
363 {
364         mutex_lock(&map->lock);
365         WARN_ON(map->cache_only && enable);
366         map->cache_bypass = enable;
367         mutex_unlock(&map->lock);
368 }
369 EXPORT_SYMBOL_GPL(regcache_cache_bypass);
370
371 bool regcache_set_val(void *base, unsigned int idx,
372                       unsigned int val, unsigned int word_size)
373 {
374         switch (word_size) {
375         case 1: {
376                 u8 *cache = base;
377                 if (cache[idx] == val)
378                         return true;
379                 cache[idx] = val;
380                 break;
381         }
382         case 2: {
383                 u16 *cache = base;
384                 if (cache[idx] == val)
385                         return true;
386                 cache[idx] = val;
387                 break;
388         }
389         default:
390                 BUG();
391         }
392         return false;
393 }
394
395 unsigned int regcache_get_val(const void *base, unsigned int idx,
396                               unsigned int word_size)
397 {
398         if (!base)
399                 return -EINVAL;
400
401         switch (word_size) {
402         case 1: {
403                 const u8 *cache = base;
404                 return cache[idx];
405         }
406         case 2: {
407                 const u16 *cache = base;
408                 return cache[idx];
409         }
410         default:
411                 BUG();
412         }
413         /* unreachable */
414         return -1;
415 }
416
417 static int regcache_default_cmp(const void *a, const void *b)
418 {
419         const struct reg_default *_a = a;
420         const struct reg_default *_b = b;
421
422         return _a->reg - _b->reg;
423 }
424
425 int regcache_lookup_reg(struct regmap *map, unsigned int reg)
426 {
427         struct reg_default key;
428         struct reg_default *r;
429
430         key.reg = reg;
431         key.def = 0;
432
433         r = bsearch(&key, map->reg_defaults, map->num_reg_defaults,
434                     sizeof(struct reg_default), regcache_default_cmp);
435
436         if (r)
437                 return r - map->reg_defaults;
438         else
439                 return -ENOENT;
440 }