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