2 * Register map access API
4 * Copyright 2011 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
13 #include <linux/device.h>
14 #include <linux/slab.h>
15 #include <linux/export.h>
16 #include <linux/mutex.h>
17 #include <linux/err.h>
18 #include <linux/rbtree.h>
19 #include <linux/sched.h>
21 #define CREATE_TRACE_POINTS
22 #include <trace/events/regmap.h>
27 * Sometimes for failures during very early init the trace
28 * infrastructure isn't available early enough to be used. For this
29 * sort of problem defining LOG_DEVICE will add printks for basic
30 * register I/O on a specific device.
34 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
35 unsigned int mask, unsigned int val,
38 static int _regmap_bus_read(void *context, unsigned int reg,
40 static int _regmap_bus_formatted_write(void *context, unsigned int reg,
42 static int _regmap_bus_raw_write(void *context, unsigned int reg,
45 static void async_cleanup(struct work_struct *work)
47 struct regmap_async *async = container_of(work, struct regmap_async,
50 kfree(async->work_buf);
54 bool regmap_reg_in_ranges(unsigned int reg,
55 const struct regmap_range *ranges,
58 const struct regmap_range *r;
61 for (i = 0, r = ranges; i < nranges; i++, r++)
62 if (regmap_reg_in_range(reg, r))
66 EXPORT_SYMBOL_GPL(regmap_reg_in_ranges);
68 static bool _regmap_check_range_table(struct regmap *map,
70 const struct regmap_access_table *table)
72 /* Check "no ranges" first */
73 if (regmap_reg_in_ranges(reg, table->no_ranges, table->n_no_ranges))
76 /* In case zero "yes ranges" are supplied, any reg is OK */
77 if (!table->n_yes_ranges)
80 return regmap_reg_in_ranges(reg, table->yes_ranges,
84 bool regmap_writeable(struct regmap *map, unsigned int reg)
86 if (map->max_register && reg > map->max_register)
89 if (map->writeable_reg)
90 return map->writeable_reg(map->dev, reg);
93 return _regmap_check_range_table(map, reg, map->wr_table);
98 bool regmap_readable(struct regmap *map, unsigned int reg)
100 if (map->max_register && reg > map->max_register)
103 if (map->format.format_write)
106 if (map->readable_reg)
107 return map->readable_reg(map->dev, reg);
110 return _regmap_check_range_table(map, reg, map->rd_table);
115 bool regmap_volatile(struct regmap *map, unsigned int reg)
117 if (!regmap_readable(map, reg))
120 if (map->volatile_reg)
121 return map->volatile_reg(map->dev, reg);
123 if (map->volatile_table)
124 return _regmap_check_range_table(map, reg, map->volatile_table);
129 bool regmap_precious(struct regmap *map, unsigned int reg)
131 if (!regmap_readable(map, reg))
134 if (map->precious_reg)
135 return map->precious_reg(map->dev, reg);
137 if (map->precious_table)
138 return _regmap_check_range_table(map, reg, map->precious_table);
143 static bool regmap_volatile_range(struct regmap *map, unsigned int reg,
148 for (i = 0; i < num; i++)
149 if (!regmap_volatile(map, reg + i))
155 static void regmap_format_2_6_write(struct regmap *map,
156 unsigned int reg, unsigned int val)
158 u8 *out = map->work_buf;
160 *out = (reg << 6) | val;
163 static void regmap_format_4_12_write(struct regmap *map,
164 unsigned int reg, unsigned int val)
166 __be16 *out = map->work_buf;
167 *out = cpu_to_be16((reg << 12) | val);
170 static void regmap_format_7_9_write(struct regmap *map,
171 unsigned int reg, unsigned int val)
173 __be16 *out = map->work_buf;
174 *out = cpu_to_be16((reg << 9) | val);
177 static void regmap_format_10_14_write(struct regmap *map,
178 unsigned int reg, unsigned int val)
180 u8 *out = map->work_buf;
183 out[1] = (val >> 8) | (reg << 6);
187 static void regmap_format_8(void *buf, unsigned int val, unsigned int shift)
194 static void regmap_format_16_be(void *buf, unsigned int val, unsigned int shift)
198 b[0] = cpu_to_be16(val << shift);
201 static void regmap_format_16_native(void *buf, unsigned int val,
204 *(u16 *)buf = val << shift;
207 static void regmap_format_24(void *buf, unsigned int val, unsigned int shift)
218 static void regmap_format_32_be(void *buf, unsigned int val, unsigned int shift)
222 b[0] = cpu_to_be32(val << shift);
225 static void regmap_format_32_native(void *buf, unsigned int val,
228 *(u32 *)buf = val << shift;
231 static unsigned int regmap_parse_8(void *buf)
238 static unsigned int regmap_parse_16_be(void *buf)
242 b[0] = be16_to_cpu(b[0]);
247 static unsigned int regmap_parse_16_native(void *buf)
252 static unsigned int regmap_parse_24(void *buf)
255 unsigned int ret = b[2];
256 ret |= ((unsigned int)b[1]) << 8;
257 ret |= ((unsigned int)b[0]) << 16;
262 static unsigned int regmap_parse_32_be(void *buf)
266 b[0] = be32_to_cpu(b[0]);
271 static unsigned int regmap_parse_32_native(void *buf)
276 static void regmap_lock_mutex(void *__map)
278 struct regmap *map = __map;
279 mutex_lock(&map->mutex);
282 static void regmap_unlock_mutex(void *__map)
284 struct regmap *map = __map;
285 mutex_unlock(&map->mutex);
288 static void regmap_lock_spinlock(void *__map)
290 struct regmap *map = __map;
291 spin_lock(&map->spinlock);
294 static void regmap_unlock_spinlock(void *__map)
296 struct regmap *map = __map;
297 spin_unlock(&map->spinlock);
300 static void dev_get_regmap_release(struct device *dev, void *res)
303 * We don't actually have anything to do here; the goal here
304 * is not to manage the regmap but to provide a simple way to
305 * get the regmap back given a struct device.
309 static bool _regmap_range_add(struct regmap *map,
310 struct regmap_range_node *data)
312 struct rb_root *root = &map->range_tree;
313 struct rb_node **new = &(root->rb_node), *parent = NULL;
316 struct regmap_range_node *this =
317 container_of(*new, struct regmap_range_node, node);
320 if (data->range_max < this->range_min)
321 new = &((*new)->rb_left);
322 else if (data->range_min > this->range_max)
323 new = &((*new)->rb_right);
328 rb_link_node(&data->node, parent, new);
329 rb_insert_color(&data->node, root);
334 static struct regmap_range_node *_regmap_range_lookup(struct regmap *map,
337 struct rb_node *node = map->range_tree.rb_node;
340 struct regmap_range_node *this =
341 container_of(node, struct regmap_range_node, node);
343 if (reg < this->range_min)
344 node = node->rb_left;
345 else if (reg > this->range_max)
346 node = node->rb_right;
354 static void regmap_range_exit(struct regmap *map)
356 struct rb_node *next;
357 struct regmap_range_node *range_node;
359 next = rb_first(&map->range_tree);
361 range_node = rb_entry(next, struct regmap_range_node, node);
362 next = rb_next(&range_node->node);
363 rb_erase(&range_node->node, &map->range_tree);
367 kfree(map->selector_work_buf);
371 * regmap_init(): Initialise register map
373 * @dev: Device that will be interacted with
374 * @bus: Bus-specific callbacks to use with device
375 * @bus_context: Data passed to bus-specific callbacks
376 * @config: Configuration for register map
378 * The return value will be an ERR_PTR() on error or a valid pointer to
379 * a struct regmap. This function should generally not be called
380 * directly, it should be called by bus-specific init functions.
382 struct regmap *regmap_init(struct device *dev,
383 const struct regmap_bus *bus,
385 const struct regmap_config *config)
387 struct regmap *map, **m;
389 enum regmap_endian reg_endian, val_endian;
395 map = kzalloc(sizeof(*map), GFP_KERNEL);
401 if (config->lock && config->unlock) {
402 map->lock = config->lock;
403 map->unlock = config->unlock;
404 map->lock_arg = config->lock_arg;
407 spin_lock_init(&map->spinlock);
408 map->lock = regmap_lock_spinlock;
409 map->unlock = regmap_unlock_spinlock;
411 mutex_init(&map->mutex);
412 map->lock = regmap_lock_mutex;
413 map->unlock = regmap_unlock_mutex;
417 map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
418 map->format.pad_bytes = config->pad_bits / 8;
419 map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
420 map->format.buf_size = DIV_ROUND_UP(config->reg_bits +
421 config->val_bits + config->pad_bits, 8);
422 map->reg_shift = config->pad_bits % 8;
423 if (config->reg_stride)
424 map->reg_stride = config->reg_stride;
427 map->use_single_rw = config->use_single_rw;
430 map->bus_context = bus_context;
431 map->max_register = config->max_register;
432 map->wr_table = config->wr_table;
433 map->rd_table = config->rd_table;
434 map->volatile_table = config->volatile_table;
435 map->precious_table = config->precious_table;
436 map->writeable_reg = config->writeable_reg;
437 map->readable_reg = config->readable_reg;
438 map->volatile_reg = config->volatile_reg;
439 map->precious_reg = config->precious_reg;
440 map->cache_type = config->cache_type;
441 map->name = config->name;
443 spin_lock_init(&map->async_lock);
444 INIT_LIST_HEAD(&map->async_list);
445 init_waitqueue_head(&map->async_waitq);
447 if (config->read_flag_mask || config->write_flag_mask) {
448 map->read_flag_mask = config->read_flag_mask;
449 map->write_flag_mask = config->write_flag_mask;
451 map->read_flag_mask = bus->read_flag_mask;
454 map->reg_read = _regmap_bus_read;
456 reg_endian = config->reg_format_endian;
457 if (reg_endian == REGMAP_ENDIAN_DEFAULT)
458 reg_endian = bus->reg_format_endian_default;
459 if (reg_endian == REGMAP_ENDIAN_DEFAULT)
460 reg_endian = REGMAP_ENDIAN_BIG;
462 val_endian = config->val_format_endian;
463 if (val_endian == REGMAP_ENDIAN_DEFAULT)
464 val_endian = bus->val_format_endian_default;
465 if (val_endian == REGMAP_ENDIAN_DEFAULT)
466 val_endian = REGMAP_ENDIAN_BIG;
468 switch (config->reg_bits + map->reg_shift) {
470 switch (config->val_bits) {
472 map->format.format_write = regmap_format_2_6_write;
480 switch (config->val_bits) {
482 map->format.format_write = regmap_format_4_12_write;
490 switch (config->val_bits) {
492 map->format.format_write = regmap_format_7_9_write;
500 switch (config->val_bits) {
502 map->format.format_write = regmap_format_10_14_write;
510 map->format.format_reg = regmap_format_8;
514 switch (reg_endian) {
515 case REGMAP_ENDIAN_BIG:
516 map->format.format_reg = regmap_format_16_be;
518 case REGMAP_ENDIAN_NATIVE:
519 map->format.format_reg = regmap_format_16_native;
527 if (reg_endian != REGMAP_ENDIAN_BIG)
529 map->format.format_reg = regmap_format_24;
533 switch (reg_endian) {
534 case REGMAP_ENDIAN_BIG:
535 map->format.format_reg = regmap_format_32_be;
537 case REGMAP_ENDIAN_NATIVE:
538 map->format.format_reg = regmap_format_32_native;
549 switch (config->val_bits) {
551 map->format.format_val = regmap_format_8;
552 map->format.parse_val = regmap_parse_8;
555 switch (val_endian) {
556 case REGMAP_ENDIAN_BIG:
557 map->format.format_val = regmap_format_16_be;
558 map->format.parse_val = regmap_parse_16_be;
560 case REGMAP_ENDIAN_NATIVE:
561 map->format.format_val = regmap_format_16_native;
562 map->format.parse_val = regmap_parse_16_native;
569 if (val_endian != REGMAP_ENDIAN_BIG)
571 map->format.format_val = regmap_format_24;
572 map->format.parse_val = regmap_parse_24;
575 switch (val_endian) {
576 case REGMAP_ENDIAN_BIG:
577 map->format.format_val = regmap_format_32_be;
578 map->format.parse_val = regmap_parse_32_be;
580 case REGMAP_ENDIAN_NATIVE:
581 map->format.format_val = regmap_format_32_native;
582 map->format.parse_val = regmap_parse_32_native;
590 if (map->format.format_write) {
591 if ((reg_endian != REGMAP_ENDIAN_BIG) ||
592 (val_endian != REGMAP_ENDIAN_BIG))
594 map->use_single_rw = true;
597 if (!map->format.format_write &&
598 !(map->format.format_reg && map->format.format_val))
601 map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
602 if (map->work_buf == NULL) {
607 if (map->format.format_write)
608 map->reg_write = _regmap_bus_formatted_write;
609 else if (map->format.format_val)
610 map->reg_write = _regmap_bus_raw_write;
612 map->range_tree = RB_ROOT;
613 for (i = 0; i < config->num_ranges; i++) {
614 const struct regmap_range_cfg *range_cfg = &config->ranges[i];
615 struct regmap_range_node *new;
618 if (range_cfg->range_max < range_cfg->range_min) {
619 dev_err(map->dev, "Invalid range %d: %d < %d\n", i,
620 range_cfg->range_max, range_cfg->range_min);
624 if (range_cfg->range_max > map->max_register) {
625 dev_err(map->dev, "Invalid range %d: %d > %d\n", i,
626 range_cfg->range_max, map->max_register);
630 if (range_cfg->selector_reg > map->max_register) {
632 "Invalid range %d: selector out of map\n", i);
636 if (range_cfg->window_len == 0) {
637 dev_err(map->dev, "Invalid range %d: window_len 0\n",
642 /* Make sure, that this register range has no selector
643 or data window within its boundary */
644 for (j = 0; j < config->num_ranges; j++) {
645 unsigned sel_reg = config->ranges[j].selector_reg;
646 unsigned win_min = config->ranges[j].window_start;
647 unsigned win_max = win_min +
648 config->ranges[j].window_len - 1;
650 if (range_cfg->range_min <= sel_reg &&
651 sel_reg <= range_cfg->range_max) {
653 "Range %d: selector for %d in window\n",
658 if (!(win_max < range_cfg->range_min ||
659 win_min > range_cfg->range_max)) {
661 "Range %d: window for %d in window\n",
667 new = kzalloc(sizeof(*new), GFP_KERNEL);
674 new->name = range_cfg->name;
675 new->range_min = range_cfg->range_min;
676 new->range_max = range_cfg->range_max;
677 new->selector_reg = range_cfg->selector_reg;
678 new->selector_mask = range_cfg->selector_mask;
679 new->selector_shift = range_cfg->selector_shift;
680 new->window_start = range_cfg->window_start;
681 new->window_len = range_cfg->window_len;
683 if (_regmap_range_add(map, new) == false) {
684 dev_err(map->dev, "Failed to add range %d\n", i);
689 if (map->selector_work_buf == NULL) {
690 map->selector_work_buf =
691 kzalloc(map->format.buf_size, GFP_KERNEL);
692 if (map->selector_work_buf == NULL) {
699 ret = regcache_init(map, config);
703 regmap_debugfs_init(map, config->name);
705 /* Add a devres resource for dev_get_regmap() */
706 m = devres_alloc(dev_get_regmap_release, sizeof(*m), GFP_KERNEL);
717 regmap_debugfs_exit(map);
720 regmap_range_exit(map);
721 kfree(map->work_buf);
727 EXPORT_SYMBOL_GPL(regmap_init);
729 static void devm_regmap_release(struct device *dev, void *res)
731 regmap_exit(*(struct regmap **)res);
735 * devm_regmap_init(): Initialise managed register map
737 * @dev: Device that will be interacted with
738 * @bus: Bus-specific callbacks to use with device
739 * @bus_context: Data passed to bus-specific callbacks
740 * @config: Configuration for register map
742 * The return value will be an ERR_PTR() on error or a valid pointer
743 * to a struct regmap. This function should generally not be called
744 * directly, it should be called by bus-specific init functions. The
745 * map will be automatically freed by the device management code.
747 struct regmap *devm_regmap_init(struct device *dev,
748 const struct regmap_bus *bus,
750 const struct regmap_config *config)
752 struct regmap **ptr, *regmap;
754 ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
756 return ERR_PTR(-ENOMEM);
758 regmap = regmap_init(dev, bus, bus_context, config);
759 if (!IS_ERR(regmap)) {
761 devres_add(dev, ptr);
768 EXPORT_SYMBOL_GPL(devm_regmap_init);
771 * regmap_reinit_cache(): Reinitialise the current register cache
773 * @map: Register map to operate on.
774 * @config: New configuration. Only the cache data will be used.
776 * Discard any existing register cache for the map and initialize a
777 * new cache. This can be used to restore the cache to defaults or to
778 * update the cache configuration to reflect runtime discovery of the
781 * No explicit locking is done here, the user needs to ensure that
782 * this function will not race with other calls to regmap.
784 int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
787 regmap_debugfs_exit(map);
789 map->max_register = config->max_register;
790 map->writeable_reg = config->writeable_reg;
791 map->readable_reg = config->readable_reg;
792 map->volatile_reg = config->volatile_reg;
793 map->precious_reg = config->precious_reg;
794 map->cache_type = config->cache_type;
796 regmap_debugfs_init(map, config->name);
798 map->cache_bypass = false;
799 map->cache_only = false;
801 return regcache_init(map, config);
803 EXPORT_SYMBOL_GPL(regmap_reinit_cache);
806 * regmap_exit(): Free a previously allocated register map
808 void regmap_exit(struct regmap *map)
811 regmap_debugfs_exit(map);
812 regmap_range_exit(map);
813 if (map->bus->free_context)
814 map->bus->free_context(map->bus_context);
815 kfree(map->work_buf);
818 EXPORT_SYMBOL_GPL(regmap_exit);
820 static int dev_get_regmap_match(struct device *dev, void *res, void *data)
822 struct regmap **r = res;
828 /* If the user didn't specify a name match any */
830 return (*r)->name == data;
836 * dev_get_regmap(): Obtain the regmap (if any) for a device
838 * @dev: Device to retrieve the map for
839 * @name: Optional name for the register map, usually NULL.
841 * Returns the regmap for the device if one is present, or NULL. If
842 * name is specified then it must match the name specified when
843 * registering the device, if it is NULL then the first regmap found
844 * will be used. Devices with multiple register maps are very rare,
845 * generic code should normally not need to specify a name.
847 struct regmap *dev_get_regmap(struct device *dev, const char *name)
849 struct regmap **r = devres_find(dev, dev_get_regmap_release,
850 dev_get_regmap_match, (void *)name);
856 EXPORT_SYMBOL_GPL(dev_get_regmap);
858 static int _regmap_select_page(struct regmap *map, unsigned int *reg,
859 struct regmap_range_node *range,
860 unsigned int val_num)
863 unsigned int win_offset;
864 unsigned int win_page;
868 win_offset = (*reg - range->range_min) % range->window_len;
869 win_page = (*reg - range->range_min) / range->window_len;
872 /* Bulk write shouldn't cross range boundary */
873 if (*reg + val_num - 1 > range->range_max)
876 /* ... or single page boundary */
877 if (val_num > range->window_len - win_offset)
881 /* It is possible to have selector register inside data window.
882 In that case, selector register is located on every page and
883 it needs no page switching, when accessed alone. */
885 range->window_start + win_offset != range->selector_reg) {
886 /* Use separate work_buf during page switching */
887 orig_work_buf = map->work_buf;
888 map->work_buf = map->selector_work_buf;
890 ret = _regmap_update_bits(map, range->selector_reg,
891 range->selector_mask,
892 win_page << range->selector_shift,
895 map->work_buf = orig_work_buf;
901 *reg = range->window_start + win_offset;
906 static int _regmap_raw_write(struct regmap *map, unsigned int reg,
907 const void *val, size_t val_len, bool async)
909 struct regmap_range_node *range;
911 u8 *u8 = map->work_buf;
912 void *work_val = map->work_buf + map->format.reg_bytes +
913 map->format.pad_bytes;
919 /* Check for unwritable registers before we start */
920 if (map->writeable_reg)
921 for (i = 0; i < val_len / map->format.val_bytes; i++)
922 if (!map->writeable_reg(map->dev,
923 reg + (i * map->reg_stride)))
926 if (!map->cache_bypass && map->format.parse_val) {
928 int val_bytes = map->format.val_bytes;
929 for (i = 0; i < val_len / val_bytes; i++) {
930 memcpy(map->work_buf, val + (i * val_bytes), val_bytes);
931 ival = map->format.parse_val(map->work_buf);
932 ret = regcache_write(map, reg + (i * map->reg_stride),
936 "Error in caching of register: %x ret: %d\n",
941 if (map->cache_only) {
942 map->cache_dirty = true;
947 range = _regmap_range_lookup(map, reg);
949 int val_num = val_len / map->format.val_bytes;
950 int win_offset = (reg - range->range_min) % range->window_len;
951 int win_residue = range->window_len - win_offset;
953 /* If the write goes beyond the end of the window split it */
954 while (val_num > win_residue) {
955 dev_dbg(map->dev, "Writing window %d/%zu\n",
956 win_residue, val_len / map->format.val_bytes);
957 ret = _regmap_raw_write(map, reg, val, win_residue *
958 map->format.val_bytes, async);
963 val_num -= win_residue;
964 val += win_residue * map->format.val_bytes;
965 val_len -= win_residue * map->format.val_bytes;
967 win_offset = (reg - range->range_min) %
969 win_residue = range->window_len - win_offset;
972 ret = _regmap_select_page(map, ®, range, val_num);
977 map->format.format_reg(map->work_buf, reg, map->reg_shift);
979 u8[0] |= map->write_flag_mask;
981 if (async && map->bus->async_write) {
982 struct regmap_async *async = map->bus->async_alloc();
986 async->work_buf = kzalloc(map->format.buf_size,
987 GFP_KERNEL | GFP_DMA);
988 if (!async->work_buf) {
993 INIT_WORK(&async->cleanup, async_cleanup);
996 /* If the caller supplied the value we can use it safely. */
997 memcpy(async->work_buf, map->work_buf, map->format.pad_bytes +
998 map->format.reg_bytes + map->format.val_bytes);
1000 val = async->work_buf + map->format.pad_bytes +
1001 map->format.reg_bytes;
1003 spin_lock_irqsave(&map->async_lock, flags);
1004 list_add_tail(&async->list, &map->async_list);
1005 spin_unlock_irqrestore(&map->async_lock, flags);
1007 ret = map->bus->async_write(map->bus_context, async->work_buf,
1008 map->format.reg_bytes +
1009 map->format.pad_bytes,
1010 val, val_len, async);
1013 dev_err(map->dev, "Failed to schedule write: %d\n",
1016 spin_lock_irqsave(&map->async_lock, flags);
1017 list_del(&async->list);
1018 spin_unlock_irqrestore(&map->async_lock, flags);
1020 kfree(async->work_buf);
1025 trace_regmap_hw_write_start(map->dev, reg,
1026 val_len / map->format.val_bytes);
1028 /* If we're doing a single register write we can probably just
1029 * send the work_buf directly, otherwise try to do a gather
1032 if (val == work_val)
1033 ret = map->bus->write(map->bus_context, map->work_buf,
1034 map->format.reg_bytes +
1035 map->format.pad_bytes +
1037 else if (map->bus->gather_write)
1038 ret = map->bus->gather_write(map->bus_context, map->work_buf,
1039 map->format.reg_bytes +
1040 map->format.pad_bytes,
1043 /* If that didn't work fall back on linearising by hand. */
1044 if (ret == -ENOTSUPP) {
1045 len = map->format.reg_bytes + map->format.pad_bytes + val_len;
1046 buf = kzalloc(len, GFP_KERNEL);
1050 memcpy(buf, map->work_buf, map->format.reg_bytes);
1051 memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
1053 ret = map->bus->write(map->bus_context, buf, len);
1058 trace_regmap_hw_write_done(map->dev, reg,
1059 val_len / map->format.val_bytes);
1064 static int _regmap_bus_formatted_write(void *context, unsigned int reg,
1068 struct regmap_range_node *range;
1069 struct regmap *map = context;
1071 BUG_ON(!map->format.format_write);
1073 range = _regmap_range_lookup(map, reg);
1075 ret = _regmap_select_page(map, ®, range, 1);
1080 map->format.format_write(map, reg, val);
1082 trace_regmap_hw_write_start(map->dev, reg, 1);
1084 ret = map->bus->write(map->bus_context, map->work_buf,
1085 map->format.buf_size);
1087 trace_regmap_hw_write_done(map->dev, reg, 1);
1092 static int _regmap_bus_raw_write(void *context, unsigned int reg,
1095 struct regmap *map = context;
1097 BUG_ON(!map->format.format_val);
1099 map->format.format_val(map->work_buf + map->format.reg_bytes
1100 + map->format.pad_bytes, val, 0);
1101 return _regmap_raw_write(map, reg,
1103 map->format.reg_bytes +
1104 map->format.pad_bytes,
1105 map->format.val_bytes, false);
1108 int _regmap_write(struct regmap *map, unsigned int reg,
1113 if (!map->cache_bypass && map->format.format_write) {
1114 ret = regcache_write(map, reg, val);
1117 if (map->cache_only) {
1118 map->cache_dirty = true;
1124 if (strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
1125 dev_info(map->dev, "%x <= %x\n", reg, val);
1128 trace_regmap_reg_write(map->dev, reg, val);
1130 return map->reg_write(map, reg, val);
1134 * regmap_write(): Write a value to a single register
1136 * @map: Register map to write to
1137 * @reg: Register to write to
1138 * @val: Value to be written
1140 * A value of zero will be returned on success, a negative errno will
1141 * be returned in error cases.
1143 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
1147 if (reg % map->reg_stride)
1150 map->lock(map->lock_arg);
1152 ret = _regmap_write(map, reg, val);
1154 map->unlock(map->lock_arg);
1158 EXPORT_SYMBOL_GPL(regmap_write);
1161 * regmap_raw_write(): Write raw values to one or more registers
1163 * @map: Register map to write to
1164 * @reg: Initial register to write to
1165 * @val: Block of data to be written, laid out for direct transmission to the
1167 * @val_len: Length of data pointed to by val.
1169 * This function is intended to be used for things like firmware
1170 * download where a large block of data needs to be transferred to the
1171 * device. No formatting will be done on the data provided.
1173 * A value of zero will be returned on success, a negative errno will
1174 * be returned in error cases.
1176 int regmap_raw_write(struct regmap *map, unsigned int reg,
1177 const void *val, size_t val_len)
1181 if (val_len % map->format.val_bytes)
1183 if (reg % map->reg_stride)
1186 map->lock(map->lock_arg);
1188 ret = _regmap_raw_write(map, reg, val, val_len, false);
1190 map->unlock(map->lock_arg);
1194 EXPORT_SYMBOL_GPL(regmap_raw_write);
1197 * regmap_bulk_write(): Write multiple registers to the device
1199 * @map: Register map to write to
1200 * @reg: First register to be write from
1201 * @val: Block of data to be written, in native register size for device
1202 * @val_count: Number of registers to write
1204 * This function is intended to be used for writing a large block of
1205 * data to the device either in single transfer or multiple transfer.
1207 * A value of zero will be returned on success, a negative errno will
1208 * be returned in error cases.
1210 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1214 size_t val_bytes = map->format.val_bytes;
1217 if (!map->format.parse_val)
1219 if (reg % map->reg_stride)
1222 map->lock(map->lock_arg);
1224 /* No formatting is require if val_byte is 1 */
1225 if (val_bytes == 1) {
1228 wval = kmemdup(val, val_count * val_bytes, GFP_KERNEL);
1231 dev_err(map->dev, "Error in memory allocation\n");
1234 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1235 map->format.parse_val(wval + i);
1238 * Some devices does not support bulk write, for
1239 * them we have a series of single write operations.
1241 if (map->use_single_rw) {
1242 for (i = 0; i < val_count; i++) {
1243 ret = regmap_raw_write(map,
1244 reg + (i * map->reg_stride),
1245 val + (i * val_bytes),
1251 ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count,
1259 map->unlock(map->lock_arg);
1262 EXPORT_SYMBOL_GPL(regmap_bulk_write);
1265 * regmap_raw_write_async(): Write raw values to one or more registers
1268 * @map: Register map to write to
1269 * @reg: Initial register to write to
1270 * @val: Block of data to be written, laid out for direct transmission to the
1271 * device. Must be valid until regmap_async_complete() is called.
1272 * @val_len: Length of data pointed to by val.
1274 * This function is intended to be used for things like firmware
1275 * download where a large block of data needs to be transferred to the
1276 * device. No formatting will be done on the data provided.
1278 * If supported by the underlying bus the write will be scheduled
1279 * asynchronously, helping maximise I/O speed on higher speed buses
1280 * like SPI. regmap_async_complete() can be called to ensure that all
1281 * asynchrnous writes have been completed.
1283 * A value of zero will be returned on success, a negative errno will
1284 * be returned in error cases.
1286 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1287 const void *val, size_t val_len)
1291 if (val_len % map->format.val_bytes)
1293 if (reg % map->reg_stride)
1296 map->lock(map->lock_arg);
1298 ret = _regmap_raw_write(map, reg, val, val_len, true);
1300 map->unlock(map->lock_arg);
1304 EXPORT_SYMBOL_GPL(regmap_raw_write_async);
1306 static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
1307 unsigned int val_len)
1309 struct regmap_range_node *range;
1310 u8 *u8 = map->work_buf;
1313 range = _regmap_range_lookup(map, reg);
1315 ret = _regmap_select_page(map, ®, range,
1316 val_len / map->format.val_bytes);
1321 map->format.format_reg(map->work_buf, reg, map->reg_shift);
1324 * Some buses or devices flag reads by setting the high bits in the
1325 * register addresss; since it's always the high bits for all
1326 * current formats we can do this here rather than in
1327 * formatting. This may break if we get interesting formats.
1329 u8[0] |= map->read_flag_mask;
1331 trace_regmap_hw_read_start(map->dev, reg,
1332 val_len / map->format.val_bytes);
1334 ret = map->bus->read(map->bus_context, map->work_buf,
1335 map->format.reg_bytes + map->format.pad_bytes,
1338 trace_regmap_hw_read_done(map->dev, reg,
1339 val_len / map->format.val_bytes);
1344 static int _regmap_bus_read(void *context, unsigned int reg,
1348 struct regmap *map = context;
1350 if (!map->format.parse_val)
1353 ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
1355 *val = map->format.parse_val(map->work_buf);
1360 static int _regmap_read(struct regmap *map, unsigned int reg,
1364 BUG_ON(!map->reg_read);
1366 if (!map->cache_bypass) {
1367 ret = regcache_read(map, reg, val);
1372 if (map->cache_only)
1375 ret = map->reg_read(map, reg, val);
1378 if (strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
1379 dev_info(map->dev, "%x => %x\n", reg, *val);
1382 trace_regmap_reg_read(map->dev, reg, *val);
1384 if (!map->cache_bypass)
1385 regcache_write(map, reg, *val);
1392 * regmap_read(): Read a value from a single register
1394 * @map: Register map to write to
1395 * @reg: Register to be read from
1396 * @val: Pointer to store read value
1398 * A value of zero will be returned on success, a negative errno will
1399 * be returned in error cases.
1401 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
1405 if (reg % map->reg_stride)
1408 map->lock(map->lock_arg);
1410 ret = _regmap_read(map, reg, val);
1412 map->unlock(map->lock_arg);
1416 EXPORT_SYMBOL_GPL(regmap_read);
1419 * regmap_raw_read(): Read raw data from the device
1421 * @map: Register map to write to
1422 * @reg: First register to be read from
1423 * @val: Pointer to store read value
1424 * @val_len: Size of data to read
1426 * A value of zero will be returned on success, a negative errno will
1427 * be returned in error cases.
1429 int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
1432 size_t val_bytes = map->format.val_bytes;
1433 size_t val_count = val_len / val_bytes;
1437 if (val_len % map->format.val_bytes)
1439 if (reg % map->reg_stride)
1442 map->lock(map->lock_arg);
1444 if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
1445 map->cache_type == REGCACHE_NONE) {
1446 /* Physical block read if there's no cache involved */
1447 ret = _regmap_raw_read(map, reg, val, val_len);
1450 /* Otherwise go word by word for the cache; should be low
1451 * cost as we expect to hit the cache.
1453 for (i = 0; i < val_count; i++) {
1454 ret = _regmap_read(map, reg + (i * map->reg_stride),
1459 map->format.format_val(val + (i * val_bytes), v, 0);
1464 map->unlock(map->lock_arg);
1468 EXPORT_SYMBOL_GPL(regmap_raw_read);
1471 * regmap_bulk_read(): Read multiple registers from the device
1473 * @map: Register map to write to
1474 * @reg: First register to be read from
1475 * @val: Pointer to store read value, in native register size for device
1476 * @val_count: Number of registers to read
1478 * A value of zero will be returned on success, a negative errno will
1479 * be returned in error cases.
1481 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1485 size_t val_bytes = map->format.val_bytes;
1486 bool vol = regmap_volatile_range(map, reg, val_count);
1488 if (!map->format.parse_val)
1490 if (reg % map->reg_stride)
1493 if (vol || map->cache_type == REGCACHE_NONE) {
1495 * Some devices does not support bulk read, for
1496 * them we have a series of single read operations.
1498 if (map->use_single_rw) {
1499 for (i = 0; i < val_count; i++) {
1500 ret = regmap_raw_read(map,
1501 reg + (i * map->reg_stride),
1502 val + (i * val_bytes),
1508 ret = regmap_raw_read(map, reg, val,
1509 val_bytes * val_count);
1514 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1515 map->format.parse_val(val + i);
1517 for (i = 0; i < val_count; i++) {
1519 ret = regmap_read(map, reg + (i * map->reg_stride),
1523 memcpy(val + (i * val_bytes), &ival, val_bytes);
1529 EXPORT_SYMBOL_GPL(regmap_bulk_read);
1531 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
1532 unsigned int mask, unsigned int val,
1536 unsigned int tmp, orig;
1538 ret = _regmap_read(map, reg, &orig);
1546 ret = _regmap_write(map, reg, tmp);
1556 * regmap_update_bits: Perform a read/modify/write cycle on the register map
1558 * @map: Register map to update
1559 * @reg: Register to update
1560 * @mask: Bitmask to change
1561 * @val: New value for bitmask
1563 * Returns zero for success, a negative number on error.
1565 int regmap_update_bits(struct regmap *map, unsigned int reg,
1566 unsigned int mask, unsigned int val)
1571 map->lock(map->lock_arg);
1572 ret = _regmap_update_bits(map, reg, mask, val, &change);
1573 map->unlock(map->lock_arg);
1577 EXPORT_SYMBOL_GPL(regmap_update_bits);
1580 * regmap_update_bits_check: Perform a read/modify/write cycle on the
1581 * register map and report if updated
1583 * @map: Register map to update
1584 * @reg: Register to update
1585 * @mask: Bitmask to change
1586 * @val: New value for bitmask
1587 * @change: Boolean indicating if a write was done
1589 * Returns zero for success, a negative number on error.
1591 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1592 unsigned int mask, unsigned int val,
1597 map->lock(map->lock_arg);
1598 ret = _regmap_update_bits(map, reg, mask, val, change);
1599 map->unlock(map->lock_arg);
1602 EXPORT_SYMBOL_GPL(regmap_update_bits_check);
1604 void regmap_async_complete_cb(struct regmap_async *async, int ret)
1606 struct regmap *map = async->map;
1609 spin_lock(&map->async_lock);
1611 list_del(&async->list);
1612 wake = list_empty(&map->async_list);
1615 map->async_ret = ret;
1617 spin_unlock(&map->async_lock);
1619 schedule_work(&async->cleanup);
1622 wake_up(&map->async_waitq);
1624 EXPORT_SYMBOL_GPL(regmap_async_complete_cb);
1626 static int regmap_async_is_done(struct regmap *map)
1628 unsigned long flags;
1631 spin_lock_irqsave(&map->async_lock, flags);
1632 ret = list_empty(&map->async_list);
1633 spin_unlock_irqrestore(&map->async_lock, flags);
1639 * regmap_async_complete: Ensure all asynchronous I/O has completed.
1641 * @map: Map to operate on.
1643 * Blocks until any pending asynchronous I/O has completed. Returns
1644 * an error code for any failed I/O operations.
1646 int regmap_async_complete(struct regmap *map)
1648 unsigned long flags;
1651 /* Nothing to do with no async support */
1652 if (!map->bus->async_write)
1655 wait_event(map->async_waitq, regmap_async_is_done(map));
1657 spin_lock_irqsave(&map->async_lock, flags);
1658 ret = map->async_ret;
1660 spin_unlock_irqrestore(&map->async_lock, flags);
1664 EXPORT_SYMBOL_GPL(regmap_async_complete);
1667 * regmap_register_patch: Register and apply register updates to be applied
1668 * on device initialistion
1670 * @map: Register map to apply updates to.
1671 * @regs: Values to update.
1672 * @num_regs: Number of entries in regs.
1674 * Register a set of register updates to be applied to the device
1675 * whenever the device registers are synchronised with the cache and
1676 * apply them immediately. Typically this is used to apply
1677 * corrections to be applied to the device defaults on startup, such
1678 * as the updates some vendors provide to undocumented registers.
1680 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
1686 /* If needed the implementation can be extended to support this */
1690 map->lock(map->lock_arg);
1692 bypass = map->cache_bypass;
1694 map->cache_bypass = true;
1696 /* Write out first; it's useful to apply even if we fail later. */
1697 for (i = 0; i < num_regs; i++) {
1698 ret = _regmap_write(map, regs[i].reg, regs[i].def);
1700 dev_err(map->dev, "Failed to write %x = %x: %d\n",
1701 regs[i].reg, regs[i].def, ret);
1706 map->patch = kcalloc(num_regs, sizeof(struct reg_default), GFP_KERNEL);
1707 if (map->patch != NULL) {
1708 memcpy(map->patch, regs,
1709 num_regs * sizeof(struct reg_default));
1710 map->patch_regs = num_regs;
1716 map->cache_bypass = bypass;
1718 map->unlock(map->lock_arg);
1722 EXPORT_SYMBOL_GPL(regmap_register_patch);
1725 * regmap_get_val_bytes(): Report the size of a register value
1727 * Report the size of a register value, mainly intended to for use by
1728 * generic infrastructure built on top of regmap.
1730 int regmap_get_val_bytes(struct regmap *map)
1732 if (map->format.format_write)
1735 return map->format.val_bytes;
1737 EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
1739 static int __init regmap_initcall(void)
1741 regmap_debugfs_initcall();
1745 postcore_initcall(regmap_initcall);