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 void regmap_parse_inplace_noop(void *buf)
235 static unsigned int regmap_parse_8(const void *buf)
242 static unsigned int regmap_parse_16_be(const void *buf)
244 const __be16 *b = buf;
246 return be16_to_cpu(b[0]);
249 static void regmap_parse_16_be_inplace(void *buf)
253 b[0] = be16_to_cpu(b[0]);
256 static unsigned int regmap_parse_16_native(const void *buf)
261 static unsigned int regmap_parse_24(const void *buf)
264 unsigned int ret = b[2];
265 ret |= ((unsigned int)b[1]) << 8;
266 ret |= ((unsigned int)b[0]) << 16;
271 static unsigned int regmap_parse_32_be(const void *buf)
273 const __be32 *b = buf;
275 return be32_to_cpu(b[0]);
278 static void regmap_parse_32_be_inplace(void *buf)
282 b[0] = be32_to_cpu(b[0]);
285 static unsigned int regmap_parse_32_native(const void *buf)
290 static void regmap_lock_mutex(void *__map)
292 struct regmap *map = __map;
293 mutex_lock(&map->mutex);
296 static void regmap_unlock_mutex(void *__map)
298 struct regmap *map = __map;
299 mutex_unlock(&map->mutex);
302 static void regmap_lock_spinlock(void *__map)
304 struct regmap *map = __map;
305 spin_lock(&map->spinlock);
308 static void regmap_unlock_spinlock(void *__map)
310 struct regmap *map = __map;
311 spin_unlock(&map->spinlock);
314 static void dev_get_regmap_release(struct device *dev, void *res)
317 * We don't actually have anything to do here; the goal here
318 * is not to manage the regmap but to provide a simple way to
319 * get the regmap back given a struct device.
323 static bool _regmap_range_add(struct regmap *map,
324 struct regmap_range_node *data)
326 struct rb_root *root = &map->range_tree;
327 struct rb_node **new = &(root->rb_node), *parent = NULL;
330 struct regmap_range_node *this =
331 container_of(*new, struct regmap_range_node, node);
334 if (data->range_max < this->range_min)
335 new = &((*new)->rb_left);
336 else if (data->range_min > this->range_max)
337 new = &((*new)->rb_right);
342 rb_link_node(&data->node, parent, new);
343 rb_insert_color(&data->node, root);
348 static struct regmap_range_node *_regmap_range_lookup(struct regmap *map,
351 struct rb_node *node = map->range_tree.rb_node;
354 struct regmap_range_node *this =
355 container_of(node, struct regmap_range_node, node);
357 if (reg < this->range_min)
358 node = node->rb_left;
359 else if (reg > this->range_max)
360 node = node->rb_right;
368 static void regmap_range_exit(struct regmap *map)
370 struct rb_node *next;
371 struct regmap_range_node *range_node;
373 next = rb_first(&map->range_tree);
375 range_node = rb_entry(next, struct regmap_range_node, node);
376 next = rb_next(&range_node->node);
377 rb_erase(&range_node->node, &map->range_tree);
381 kfree(map->selector_work_buf);
385 * regmap_init(): Initialise register map
387 * @dev: Device that will be interacted with
388 * @bus: Bus-specific callbacks to use with device
389 * @bus_context: Data passed to bus-specific callbacks
390 * @config: Configuration for register map
392 * The return value will be an ERR_PTR() on error or a valid pointer to
393 * a struct regmap. This function should generally not be called
394 * directly, it should be called by bus-specific init functions.
396 struct regmap *regmap_init(struct device *dev,
397 const struct regmap_bus *bus,
399 const struct regmap_config *config)
401 struct regmap *map, **m;
403 enum regmap_endian reg_endian, val_endian;
409 map = kzalloc(sizeof(*map), GFP_KERNEL);
415 if (config->lock && config->unlock) {
416 map->lock = config->lock;
417 map->unlock = config->unlock;
418 map->lock_arg = config->lock_arg;
420 if ((bus && bus->fast_io) ||
422 spin_lock_init(&map->spinlock);
423 map->lock = regmap_lock_spinlock;
424 map->unlock = regmap_unlock_spinlock;
426 mutex_init(&map->mutex);
427 map->lock = regmap_lock_mutex;
428 map->unlock = regmap_unlock_mutex;
432 map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
433 map->format.pad_bytes = config->pad_bits / 8;
434 map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
435 map->format.buf_size = DIV_ROUND_UP(config->reg_bits +
436 config->val_bits + config->pad_bits, 8);
437 map->reg_shift = config->pad_bits % 8;
438 if (config->reg_stride)
439 map->reg_stride = config->reg_stride;
442 map->use_single_rw = config->use_single_rw;
445 map->bus_context = bus_context;
446 map->max_register = config->max_register;
447 map->wr_table = config->wr_table;
448 map->rd_table = config->rd_table;
449 map->volatile_table = config->volatile_table;
450 map->precious_table = config->precious_table;
451 map->writeable_reg = config->writeable_reg;
452 map->readable_reg = config->readable_reg;
453 map->volatile_reg = config->volatile_reg;
454 map->precious_reg = config->precious_reg;
455 map->cache_type = config->cache_type;
456 map->name = config->name;
458 spin_lock_init(&map->async_lock);
459 INIT_LIST_HEAD(&map->async_list);
460 init_waitqueue_head(&map->async_waitq);
462 if (config->read_flag_mask || config->write_flag_mask) {
463 map->read_flag_mask = config->read_flag_mask;
464 map->write_flag_mask = config->write_flag_mask;
466 map->read_flag_mask = bus->read_flag_mask;
470 map->reg_read = config->reg_read;
471 map->reg_write = config->reg_write;
473 map->defer_caching = false;
474 goto skip_format_initialization;
476 map->reg_read = _regmap_bus_read;
479 reg_endian = config->reg_format_endian;
480 if (reg_endian == REGMAP_ENDIAN_DEFAULT)
481 reg_endian = bus->reg_format_endian_default;
482 if (reg_endian == REGMAP_ENDIAN_DEFAULT)
483 reg_endian = REGMAP_ENDIAN_BIG;
485 val_endian = config->val_format_endian;
486 if (val_endian == REGMAP_ENDIAN_DEFAULT)
487 val_endian = bus->val_format_endian_default;
488 if (val_endian == REGMAP_ENDIAN_DEFAULT)
489 val_endian = REGMAP_ENDIAN_BIG;
491 switch (config->reg_bits + map->reg_shift) {
493 switch (config->val_bits) {
495 map->format.format_write = regmap_format_2_6_write;
503 switch (config->val_bits) {
505 map->format.format_write = regmap_format_4_12_write;
513 switch (config->val_bits) {
515 map->format.format_write = regmap_format_7_9_write;
523 switch (config->val_bits) {
525 map->format.format_write = regmap_format_10_14_write;
533 map->format.format_reg = regmap_format_8;
537 switch (reg_endian) {
538 case REGMAP_ENDIAN_BIG:
539 map->format.format_reg = regmap_format_16_be;
541 case REGMAP_ENDIAN_NATIVE:
542 map->format.format_reg = regmap_format_16_native;
550 if (reg_endian != REGMAP_ENDIAN_BIG)
552 map->format.format_reg = regmap_format_24;
556 switch (reg_endian) {
557 case REGMAP_ENDIAN_BIG:
558 map->format.format_reg = regmap_format_32_be;
560 case REGMAP_ENDIAN_NATIVE:
561 map->format.format_reg = regmap_format_32_native;
572 if (val_endian == REGMAP_ENDIAN_NATIVE)
573 map->format.parse_inplace = regmap_parse_inplace_noop;
575 switch (config->val_bits) {
577 map->format.format_val = regmap_format_8;
578 map->format.parse_val = regmap_parse_8;
579 map->format.parse_inplace = regmap_parse_inplace_noop;
582 switch (val_endian) {
583 case REGMAP_ENDIAN_BIG:
584 map->format.format_val = regmap_format_16_be;
585 map->format.parse_val = regmap_parse_16_be;
586 map->format.parse_inplace = regmap_parse_16_be_inplace;
588 case REGMAP_ENDIAN_NATIVE:
589 map->format.format_val = regmap_format_16_native;
590 map->format.parse_val = regmap_parse_16_native;
597 if (val_endian != REGMAP_ENDIAN_BIG)
599 map->format.format_val = regmap_format_24;
600 map->format.parse_val = regmap_parse_24;
603 switch (val_endian) {
604 case REGMAP_ENDIAN_BIG:
605 map->format.format_val = regmap_format_32_be;
606 map->format.parse_val = regmap_parse_32_be;
607 map->format.parse_inplace = regmap_parse_32_be_inplace;
609 case REGMAP_ENDIAN_NATIVE:
610 map->format.format_val = regmap_format_32_native;
611 map->format.parse_val = regmap_parse_32_native;
619 if (map->format.format_write) {
620 if ((reg_endian != REGMAP_ENDIAN_BIG) ||
621 (val_endian != REGMAP_ENDIAN_BIG))
623 map->use_single_rw = true;
626 if (!map->format.format_write &&
627 !(map->format.format_reg && map->format.format_val))
630 map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
631 if (map->work_buf == NULL) {
636 if (map->format.format_write) {
637 map->defer_caching = false;
638 map->reg_write = _regmap_bus_formatted_write;
639 } else if (map->format.format_val) {
640 map->defer_caching = true;
641 map->reg_write = _regmap_bus_raw_write;
644 skip_format_initialization:
646 map->range_tree = RB_ROOT;
647 for (i = 0; i < config->num_ranges; i++) {
648 const struct regmap_range_cfg *range_cfg = &config->ranges[i];
649 struct regmap_range_node *new;
652 if (range_cfg->range_max < range_cfg->range_min) {
653 dev_err(map->dev, "Invalid range %d: %d < %d\n", i,
654 range_cfg->range_max, range_cfg->range_min);
658 if (range_cfg->range_max > map->max_register) {
659 dev_err(map->dev, "Invalid range %d: %d > %d\n", i,
660 range_cfg->range_max, map->max_register);
664 if (range_cfg->selector_reg > map->max_register) {
666 "Invalid range %d: selector out of map\n", i);
670 if (range_cfg->window_len == 0) {
671 dev_err(map->dev, "Invalid range %d: window_len 0\n",
676 /* Make sure, that this register range has no selector
677 or data window within its boundary */
678 for (j = 0; j < config->num_ranges; j++) {
679 unsigned sel_reg = config->ranges[j].selector_reg;
680 unsigned win_min = config->ranges[j].window_start;
681 unsigned win_max = win_min +
682 config->ranges[j].window_len - 1;
684 if (range_cfg->range_min <= sel_reg &&
685 sel_reg <= range_cfg->range_max) {
687 "Range %d: selector for %d in window\n",
692 if (!(win_max < range_cfg->range_min ||
693 win_min > range_cfg->range_max)) {
695 "Range %d: window for %d in window\n",
701 new = kzalloc(sizeof(*new), GFP_KERNEL);
708 new->name = range_cfg->name;
709 new->range_min = range_cfg->range_min;
710 new->range_max = range_cfg->range_max;
711 new->selector_reg = range_cfg->selector_reg;
712 new->selector_mask = range_cfg->selector_mask;
713 new->selector_shift = range_cfg->selector_shift;
714 new->window_start = range_cfg->window_start;
715 new->window_len = range_cfg->window_len;
717 if (_regmap_range_add(map, new) == false) {
718 dev_err(map->dev, "Failed to add range %d\n", i);
723 if (map->selector_work_buf == NULL) {
724 map->selector_work_buf =
725 kzalloc(map->format.buf_size, GFP_KERNEL);
726 if (map->selector_work_buf == NULL) {
733 regmap_debugfs_init(map, config->name);
735 ret = regcache_init(map, config);
739 /* Add a devres resource for dev_get_regmap() */
740 m = devres_alloc(dev_get_regmap_release, sizeof(*m), GFP_KERNEL);
751 regmap_debugfs_exit(map);
754 regmap_range_exit(map);
755 kfree(map->work_buf);
761 EXPORT_SYMBOL_GPL(regmap_init);
763 static void devm_regmap_release(struct device *dev, void *res)
765 regmap_exit(*(struct regmap **)res);
769 * devm_regmap_init(): Initialise managed register map
771 * @dev: Device that will be interacted with
772 * @bus: Bus-specific callbacks to use with device
773 * @bus_context: Data passed to bus-specific callbacks
774 * @config: Configuration for register map
776 * The return value will be an ERR_PTR() on error or a valid pointer
777 * to a struct regmap. This function should generally not be called
778 * directly, it should be called by bus-specific init functions. The
779 * map will be automatically freed by the device management code.
781 struct regmap *devm_regmap_init(struct device *dev,
782 const struct regmap_bus *bus,
784 const struct regmap_config *config)
786 struct regmap **ptr, *regmap;
788 ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
790 return ERR_PTR(-ENOMEM);
792 regmap = regmap_init(dev, bus, bus_context, config);
793 if (!IS_ERR(regmap)) {
795 devres_add(dev, ptr);
802 EXPORT_SYMBOL_GPL(devm_regmap_init);
805 * regmap_reinit_cache(): Reinitialise the current register cache
807 * @map: Register map to operate on.
808 * @config: New configuration. Only the cache data will be used.
810 * Discard any existing register cache for the map and initialize a
811 * new cache. This can be used to restore the cache to defaults or to
812 * update the cache configuration to reflect runtime discovery of the
815 * No explicit locking is done here, the user needs to ensure that
816 * this function will not race with other calls to regmap.
818 int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
821 regmap_debugfs_exit(map);
823 map->max_register = config->max_register;
824 map->writeable_reg = config->writeable_reg;
825 map->readable_reg = config->readable_reg;
826 map->volatile_reg = config->volatile_reg;
827 map->precious_reg = config->precious_reg;
828 map->cache_type = config->cache_type;
830 regmap_debugfs_init(map, config->name);
832 map->cache_bypass = false;
833 map->cache_only = false;
835 return regcache_init(map, config);
837 EXPORT_SYMBOL_GPL(regmap_reinit_cache);
840 * regmap_exit(): Free a previously allocated register map
842 void regmap_exit(struct regmap *map)
845 regmap_debugfs_exit(map);
846 regmap_range_exit(map);
847 if (map->bus && map->bus->free_context)
848 map->bus->free_context(map->bus_context);
849 kfree(map->work_buf);
852 EXPORT_SYMBOL_GPL(regmap_exit);
854 static int dev_get_regmap_match(struct device *dev, void *res, void *data)
856 struct regmap **r = res;
862 /* If the user didn't specify a name match any */
864 return (*r)->name == data;
870 * dev_get_regmap(): Obtain the regmap (if any) for a device
872 * @dev: Device to retrieve the map for
873 * @name: Optional name for the register map, usually NULL.
875 * Returns the regmap for the device if one is present, or NULL. If
876 * name is specified then it must match the name specified when
877 * registering the device, if it is NULL then the first regmap found
878 * will be used. Devices with multiple register maps are very rare,
879 * generic code should normally not need to specify a name.
881 struct regmap *dev_get_regmap(struct device *dev, const char *name)
883 struct regmap **r = devres_find(dev, dev_get_regmap_release,
884 dev_get_regmap_match, (void *)name);
890 EXPORT_SYMBOL_GPL(dev_get_regmap);
892 static int _regmap_select_page(struct regmap *map, unsigned int *reg,
893 struct regmap_range_node *range,
894 unsigned int val_num)
897 unsigned int win_offset;
898 unsigned int win_page;
902 win_offset = (*reg - range->range_min) % range->window_len;
903 win_page = (*reg - range->range_min) / range->window_len;
906 /* Bulk write shouldn't cross range boundary */
907 if (*reg + val_num - 1 > range->range_max)
910 /* ... or single page boundary */
911 if (val_num > range->window_len - win_offset)
915 /* It is possible to have selector register inside data window.
916 In that case, selector register is located on every page and
917 it needs no page switching, when accessed alone. */
919 range->window_start + win_offset != range->selector_reg) {
920 /* Use separate work_buf during page switching */
921 orig_work_buf = map->work_buf;
922 map->work_buf = map->selector_work_buf;
924 ret = _regmap_update_bits(map, range->selector_reg,
925 range->selector_mask,
926 win_page << range->selector_shift,
929 map->work_buf = orig_work_buf;
935 *reg = range->window_start + win_offset;
940 int _regmap_raw_write(struct regmap *map, unsigned int reg,
941 const void *val, size_t val_len, bool async)
943 struct regmap_range_node *range;
945 u8 *u8 = map->work_buf;
946 void *work_val = map->work_buf + map->format.reg_bytes +
947 map->format.pad_bytes;
955 /* Check for unwritable registers before we start */
956 if (map->writeable_reg)
957 for (i = 0; i < val_len / map->format.val_bytes; i++)
958 if (!map->writeable_reg(map->dev,
959 reg + (i * map->reg_stride)))
962 if (!map->cache_bypass && map->format.parse_val) {
964 int val_bytes = map->format.val_bytes;
965 for (i = 0; i < val_len / val_bytes; i++) {
966 ival = map->format.parse_val(val + (i * val_bytes));
967 ret = regcache_write(map, reg + (i * map->reg_stride),
971 "Error in caching of register: %x ret: %d\n",
976 if (map->cache_only) {
977 map->cache_dirty = true;
982 range = _regmap_range_lookup(map, reg);
984 int val_num = val_len / map->format.val_bytes;
985 int win_offset = (reg - range->range_min) % range->window_len;
986 int win_residue = range->window_len - win_offset;
988 /* If the write goes beyond the end of the window split it */
989 while (val_num > win_residue) {
990 dev_dbg(map->dev, "Writing window %d/%zu\n",
991 win_residue, val_len / map->format.val_bytes);
992 ret = _regmap_raw_write(map, reg, val, win_residue *
993 map->format.val_bytes, async);
998 val_num -= win_residue;
999 val += win_residue * map->format.val_bytes;
1000 val_len -= win_residue * map->format.val_bytes;
1002 win_offset = (reg - range->range_min) %
1004 win_residue = range->window_len - win_offset;
1007 ret = _regmap_select_page(map, ®, range, val_num);
1012 map->format.format_reg(map->work_buf, reg, map->reg_shift);
1014 u8[0] |= map->write_flag_mask;
1016 if (async && map->bus->async_write) {
1017 struct regmap_async *async = map->bus->async_alloc();
1021 trace_regmap_async_write_start(map->dev, reg, val_len);
1023 async->work_buf = kzalloc(map->format.buf_size,
1024 GFP_KERNEL | GFP_DMA);
1025 if (!async->work_buf) {
1030 INIT_WORK(&async->cleanup, async_cleanup);
1033 /* If the caller supplied the value we can use it safely. */
1034 memcpy(async->work_buf, map->work_buf, map->format.pad_bytes +
1035 map->format.reg_bytes + map->format.val_bytes);
1036 if (val == work_val)
1037 val = async->work_buf + map->format.pad_bytes +
1038 map->format.reg_bytes;
1040 spin_lock_irqsave(&map->async_lock, flags);
1041 list_add_tail(&async->list, &map->async_list);
1042 spin_unlock_irqrestore(&map->async_lock, flags);
1044 ret = map->bus->async_write(map->bus_context, async->work_buf,
1045 map->format.reg_bytes +
1046 map->format.pad_bytes,
1047 val, val_len, async);
1050 dev_err(map->dev, "Failed to schedule write: %d\n",
1053 spin_lock_irqsave(&map->async_lock, flags);
1054 list_del(&async->list);
1055 spin_unlock_irqrestore(&map->async_lock, flags);
1057 kfree(async->work_buf);
1064 trace_regmap_hw_write_start(map->dev, reg,
1065 val_len / map->format.val_bytes);
1067 /* If we're doing a single register write we can probably just
1068 * send the work_buf directly, otherwise try to do a gather
1071 if (val == work_val)
1072 ret = map->bus->write(map->bus_context, map->work_buf,
1073 map->format.reg_bytes +
1074 map->format.pad_bytes +
1076 else if (map->bus->gather_write)
1077 ret = map->bus->gather_write(map->bus_context, map->work_buf,
1078 map->format.reg_bytes +
1079 map->format.pad_bytes,
1082 /* If that didn't work fall back on linearising by hand. */
1083 if (ret == -ENOTSUPP) {
1084 len = map->format.reg_bytes + map->format.pad_bytes + val_len;
1085 buf = kzalloc(len, GFP_KERNEL);
1089 memcpy(buf, map->work_buf, map->format.reg_bytes);
1090 memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
1092 ret = map->bus->write(map->bus_context, buf, len);
1097 trace_regmap_hw_write_done(map->dev, reg,
1098 val_len / map->format.val_bytes);
1104 * regmap_can_raw_write - Test if regmap_raw_write() is supported
1106 * @map: Map to check.
1108 bool regmap_can_raw_write(struct regmap *map)
1110 return map->bus && map->format.format_val && map->format.format_reg;
1112 EXPORT_SYMBOL_GPL(regmap_can_raw_write);
1114 static int _regmap_bus_formatted_write(void *context, unsigned int reg,
1118 struct regmap_range_node *range;
1119 struct regmap *map = context;
1121 WARN_ON(!map->bus || !map->format.format_write);
1123 range = _regmap_range_lookup(map, reg);
1125 ret = _regmap_select_page(map, ®, range, 1);
1130 map->format.format_write(map, reg, val);
1132 trace_regmap_hw_write_start(map->dev, reg, 1);
1134 ret = map->bus->write(map->bus_context, map->work_buf,
1135 map->format.buf_size);
1137 trace_regmap_hw_write_done(map->dev, reg, 1);
1142 static int _regmap_bus_raw_write(void *context, unsigned int reg,
1145 struct regmap *map = context;
1147 WARN_ON(!map->bus || !map->format.format_val);
1149 map->format.format_val(map->work_buf + map->format.reg_bytes
1150 + map->format.pad_bytes, val, 0);
1151 return _regmap_raw_write(map, reg,
1153 map->format.reg_bytes +
1154 map->format.pad_bytes,
1155 map->format.val_bytes, false);
1158 static inline void *_regmap_map_get_context(struct regmap *map)
1160 return (map->bus) ? map : map->bus_context;
1163 int _regmap_write(struct regmap *map, unsigned int reg,
1167 void *context = _regmap_map_get_context(map);
1169 if (!map->cache_bypass && !map->defer_caching) {
1170 ret = regcache_write(map, reg, val);
1173 if (map->cache_only) {
1174 map->cache_dirty = true;
1180 if (strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
1181 dev_info(map->dev, "%x <= %x\n", reg, val);
1184 trace_regmap_reg_write(map->dev, reg, val);
1186 return map->reg_write(context, reg, val);
1190 * regmap_write(): Write a value to a single register
1192 * @map: Register map to write to
1193 * @reg: Register to write to
1194 * @val: Value to be written
1196 * A value of zero will be returned on success, a negative errno will
1197 * be returned in error cases.
1199 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
1203 if (reg % map->reg_stride)
1206 map->lock(map->lock_arg);
1208 ret = _regmap_write(map, reg, val);
1210 map->unlock(map->lock_arg);
1214 EXPORT_SYMBOL_GPL(regmap_write);
1217 * regmap_raw_write(): Write raw values to one or more registers
1219 * @map: Register map to write to
1220 * @reg: Initial register to write to
1221 * @val: Block of data to be written, laid out for direct transmission to the
1223 * @val_len: Length of data pointed to by val.
1225 * This function is intended to be used for things like firmware
1226 * download where a large block of data needs to be transferred to the
1227 * device. No formatting will be done on the data provided.
1229 * A value of zero will be returned on success, a negative errno will
1230 * be returned in error cases.
1232 int regmap_raw_write(struct regmap *map, unsigned int reg,
1233 const void *val, size_t val_len)
1237 if (!regmap_can_raw_write(map))
1239 if (val_len % map->format.val_bytes)
1242 map->lock(map->lock_arg);
1244 ret = _regmap_raw_write(map, reg, val, val_len, false);
1246 map->unlock(map->lock_arg);
1250 EXPORT_SYMBOL_GPL(regmap_raw_write);
1253 * regmap_bulk_write(): Write multiple registers to the device
1255 * @map: Register map to write to
1256 * @reg: First register to be write from
1257 * @val: Block of data to be written, in native register size for device
1258 * @val_count: Number of registers to write
1260 * This function is intended to be used for writing a large block of
1261 * data to the device either in single transfer or multiple transfer.
1263 * A value of zero will be returned on success, a negative errno will
1264 * be returned in error cases.
1266 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1270 size_t val_bytes = map->format.val_bytes;
1275 if (!map->format.parse_inplace)
1277 if (reg % map->reg_stride)
1280 map->lock(map->lock_arg);
1282 /* No formatting is require if val_byte is 1 */
1283 if (val_bytes == 1) {
1286 wval = kmemdup(val, val_count * val_bytes, GFP_KERNEL);
1289 dev_err(map->dev, "Error in memory allocation\n");
1292 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1293 map->format.parse_inplace(wval + i);
1296 * Some devices does not support bulk write, for
1297 * them we have a series of single write operations.
1299 if (map->use_single_rw) {
1300 for (i = 0; i < val_count; i++) {
1301 ret = regmap_raw_write(map,
1302 reg + (i * map->reg_stride),
1303 val + (i * val_bytes),
1309 ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count,
1317 map->unlock(map->lock_arg);
1320 EXPORT_SYMBOL_GPL(regmap_bulk_write);
1323 * regmap_raw_write_async(): Write raw values to one or more registers
1326 * @map: Register map to write to
1327 * @reg: Initial register to write to
1328 * @val: Block of data to be written, laid out for direct transmission to the
1329 * device. Must be valid until regmap_async_complete() is called.
1330 * @val_len: Length of data pointed to by val.
1332 * This function is intended to be used for things like firmware
1333 * download where a large block of data needs to be transferred to the
1334 * device. No formatting will be done on the data provided.
1336 * If supported by the underlying bus the write will be scheduled
1337 * asynchronously, helping maximise I/O speed on higher speed buses
1338 * like SPI. regmap_async_complete() can be called to ensure that all
1339 * asynchrnous writes have been completed.
1341 * A value of zero will be returned on success, a negative errno will
1342 * be returned in error cases.
1344 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1345 const void *val, size_t val_len)
1349 if (val_len % map->format.val_bytes)
1351 if (reg % map->reg_stride)
1354 map->lock(map->lock_arg);
1356 ret = _regmap_raw_write(map, reg, val, val_len, true);
1358 map->unlock(map->lock_arg);
1362 EXPORT_SYMBOL_GPL(regmap_raw_write_async);
1364 static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
1365 unsigned int val_len)
1367 struct regmap_range_node *range;
1368 u8 *u8 = map->work_buf;
1373 range = _regmap_range_lookup(map, reg);
1375 ret = _regmap_select_page(map, ®, range,
1376 val_len / map->format.val_bytes);
1381 map->format.format_reg(map->work_buf, reg, map->reg_shift);
1384 * Some buses or devices flag reads by setting the high bits in the
1385 * register addresss; since it's always the high bits for all
1386 * current formats we can do this here rather than in
1387 * formatting. This may break if we get interesting formats.
1389 u8[0] |= map->read_flag_mask;
1391 trace_regmap_hw_read_start(map->dev, reg,
1392 val_len / map->format.val_bytes);
1394 ret = map->bus->read(map->bus_context, map->work_buf,
1395 map->format.reg_bytes + map->format.pad_bytes,
1398 trace_regmap_hw_read_done(map->dev, reg,
1399 val_len / map->format.val_bytes);
1404 static int _regmap_bus_read(void *context, unsigned int reg,
1408 struct regmap *map = context;
1410 if (!map->format.parse_val)
1413 ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
1415 *val = map->format.parse_val(map->work_buf);
1420 static int _regmap_read(struct regmap *map, unsigned int reg,
1424 void *context = _regmap_map_get_context(map);
1426 WARN_ON(!map->reg_read);
1428 if (!map->cache_bypass) {
1429 ret = regcache_read(map, reg, val);
1434 if (map->cache_only)
1437 ret = map->reg_read(context, reg, val);
1440 if (strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
1441 dev_info(map->dev, "%x => %x\n", reg, *val);
1444 trace_regmap_reg_read(map->dev, reg, *val);
1446 if (!map->cache_bypass)
1447 regcache_write(map, reg, *val);
1454 * regmap_read(): Read a value from a single register
1456 * @map: Register map to write to
1457 * @reg: Register to be read from
1458 * @val: Pointer to store read value
1460 * A value of zero will be returned on success, a negative errno will
1461 * be returned in error cases.
1463 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
1467 if (reg % map->reg_stride)
1470 map->lock(map->lock_arg);
1472 ret = _regmap_read(map, reg, val);
1474 map->unlock(map->lock_arg);
1478 EXPORT_SYMBOL_GPL(regmap_read);
1481 * regmap_raw_read(): Read raw data from the device
1483 * @map: Register map to write to
1484 * @reg: First register to be read from
1485 * @val: Pointer to store read value
1486 * @val_len: Size of data to read
1488 * A value of zero will be returned on success, a negative errno will
1489 * be returned in error cases.
1491 int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
1494 size_t val_bytes = map->format.val_bytes;
1495 size_t val_count = val_len / val_bytes;
1501 if (val_len % map->format.val_bytes)
1503 if (reg % map->reg_stride)
1506 map->lock(map->lock_arg);
1508 if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
1509 map->cache_type == REGCACHE_NONE) {
1510 /* Physical block read if there's no cache involved */
1511 ret = _regmap_raw_read(map, reg, val, val_len);
1514 /* Otherwise go word by word for the cache; should be low
1515 * cost as we expect to hit the cache.
1517 for (i = 0; i < val_count; i++) {
1518 ret = _regmap_read(map, reg + (i * map->reg_stride),
1523 map->format.format_val(val + (i * val_bytes), v, 0);
1528 map->unlock(map->lock_arg);
1532 EXPORT_SYMBOL_GPL(regmap_raw_read);
1535 * regmap_bulk_read(): Read multiple registers from the device
1537 * @map: Register map to write to
1538 * @reg: First register to be read from
1539 * @val: Pointer to store read value, in native register size for device
1540 * @val_count: Number of registers to read
1542 * A value of zero will be returned on success, a negative errno will
1543 * be returned in error cases.
1545 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1549 size_t val_bytes = map->format.val_bytes;
1550 bool vol = regmap_volatile_range(map, reg, val_count);
1554 if (!map->format.parse_inplace)
1556 if (reg % map->reg_stride)
1559 if (vol || map->cache_type == REGCACHE_NONE) {
1561 * Some devices does not support bulk read, for
1562 * them we have a series of single read operations.
1564 if (map->use_single_rw) {
1565 for (i = 0; i < val_count; i++) {
1566 ret = regmap_raw_read(map,
1567 reg + (i * map->reg_stride),
1568 val + (i * val_bytes),
1574 ret = regmap_raw_read(map, reg, val,
1575 val_bytes * val_count);
1580 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1581 map->format.parse_inplace(val + i);
1583 for (i = 0; i < val_count; i++) {
1585 ret = regmap_read(map, reg + (i * map->reg_stride),
1589 memcpy(val + (i * val_bytes), &ival, val_bytes);
1595 EXPORT_SYMBOL_GPL(regmap_bulk_read);
1597 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
1598 unsigned int mask, unsigned int val,
1602 unsigned int tmp, orig;
1604 ret = _regmap_read(map, reg, &orig);
1612 ret = _regmap_write(map, reg, tmp);
1622 * regmap_update_bits: Perform a read/modify/write cycle on the register map
1624 * @map: Register map to update
1625 * @reg: Register to update
1626 * @mask: Bitmask to change
1627 * @val: New value for bitmask
1629 * Returns zero for success, a negative number on error.
1631 int regmap_update_bits(struct regmap *map, unsigned int reg,
1632 unsigned int mask, unsigned int val)
1637 map->lock(map->lock_arg);
1638 ret = _regmap_update_bits(map, reg, mask, val, &change);
1639 map->unlock(map->lock_arg);
1643 EXPORT_SYMBOL_GPL(regmap_update_bits);
1646 * regmap_update_bits_check: Perform a read/modify/write cycle on the
1647 * register map and report if updated
1649 * @map: Register map to update
1650 * @reg: Register to update
1651 * @mask: Bitmask to change
1652 * @val: New value for bitmask
1653 * @change: Boolean indicating if a write was done
1655 * Returns zero for success, a negative number on error.
1657 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1658 unsigned int mask, unsigned int val,
1663 map->lock(map->lock_arg);
1664 ret = _regmap_update_bits(map, reg, mask, val, change);
1665 map->unlock(map->lock_arg);
1668 EXPORT_SYMBOL_GPL(regmap_update_bits_check);
1670 void regmap_async_complete_cb(struct regmap_async *async, int ret)
1672 struct regmap *map = async->map;
1675 trace_regmap_async_io_complete(map->dev);
1677 spin_lock(&map->async_lock);
1679 list_del(&async->list);
1680 wake = list_empty(&map->async_list);
1683 map->async_ret = ret;
1685 spin_unlock(&map->async_lock);
1687 schedule_work(&async->cleanup);
1690 wake_up(&map->async_waitq);
1692 EXPORT_SYMBOL_GPL(regmap_async_complete_cb);
1694 static int regmap_async_is_done(struct regmap *map)
1696 unsigned long flags;
1699 spin_lock_irqsave(&map->async_lock, flags);
1700 ret = list_empty(&map->async_list);
1701 spin_unlock_irqrestore(&map->async_lock, flags);
1707 * regmap_async_complete: Ensure all asynchronous I/O has completed.
1709 * @map: Map to operate on.
1711 * Blocks until any pending asynchronous I/O has completed. Returns
1712 * an error code for any failed I/O operations.
1714 int regmap_async_complete(struct regmap *map)
1716 unsigned long flags;
1719 /* Nothing to do with no async support */
1720 if (!map->bus || !map->bus->async_write)
1723 trace_regmap_async_complete_start(map->dev);
1725 wait_event(map->async_waitq, regmap_async_is_done(map));
1727 spin_lock_irqsave(&map->async_lock, flags);
1728 ret = map->async_ret;
1730 spin_unlock_irqrestore(&map->async_lock, flags);
1732 trace_regmap_async_complete_done(map->dev);
1736 EXPORT_SYMBOL_GPL(regmap_async_complete);
1739 * regmap_register_patch: Register and apply register updates to be applied
1740 * on device initialistion
1742 * @map: Register map to apply updates to.
1743 * @regs: Values to update.
1744 * @num_regs: Number of entries in regs.
1746 * Register a set of register updates to be applied to the device
1747 * whenever the device registers are synchronised with the cache and
1748 * apply them immediately. Typically this is used to apply
1749 * corrections to be applied to the device defaults on startup, such
1750 * as the updates some vendors provide to undocumented registers.
1752 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
1758 /* If needed the implementation can be extended to support this */
1762 map->lock(map->lock_arg);
1764 bypass = map->cache_bypass;
1766 map->cache_bypass = true;
1768 /* Write out first; it's useful to apply even if we fail later. */
1769 for (i = 0; i < num_regs; i++) {
1770 ret = _regmap_write(map, regs[i].reg, regs[i].def);
1772 dev_err(map->dev, "Failed to write %x = %x: %d\n",
1773 regs[i].reg, regs[i].def, ret);
1778 map->patch = kcalloc(num_regs, sizeof(struct reg_default), GFP_KERNEL);
1779 if (map->patch != NULL) {
1780 memcpy(map->patch, regs,
1781 num_regs * sizeof(struct reg_default));
1782 map->patch_regs = num_regs;
1788 map->cache_bypass = bypass;
1790 map->unlock(map->lock_arg);
1794 EXPORT_SYMBOL_GPL(regmap_register_patch);
1797 * regmap_get_val_bytes(): Report the size of a register value
1799 * Report the size of a register value, mainly intended to for use by
1800 * generic infrastructure built on top of regmap.
1802 int regmap_get_val_bytes(struct regmap *map)
1804 if (map->format.format_write)
1807 return map->format.val_bytes;
1809 EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
1811 static int __init regmap_initcall(void)
1813 regmap_debugfs_initcall();
1817 postcore_initcall(regmap_initcall);