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