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>
19 #include <linux/rbtree.h>
20 #include <linux/sched.h>
21 #include <linux/delay.h>
23 #define CREATE_TRACE_POINTS
29 * Sometimes for failures during very early init the trace
30 * infrastructure isn't available early enough to be used. For this
31 * sort of problem defining LOG_DEVICE will add printks for basic
32 * register I/O on a specific device.
36 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
37 unsigned int mask, unsigned int val,
38 bool *change, bool force_write);
40 static int _regmap_bus_reg_read(void *context, unsigned int reg,
42 static int _regmap_bus_read(void *context, unsigned int reg,
44 static int _regmap_bus_formatted_write(void *context, unsigned int reg,
46 static int _regmap_bus_reg_write(void *context, unsigned int reg,
48 static int _regmap_bus_raw_write(void *context, unsigned int reg,
51 bool regmap_reg_in_ranges(unsigned int reg,
52 const struct regmap_range *ranges,
55 const struct regmap_range *r;
58 for (i = 0, r = ranges; i < nranges; i++, r++)
59 if (regmap_reg_in_range(reg, r))
63 EXPORT_SYMBOL_GPL(regmap_reg_in_ranges);
65 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
66 const struct regmap_access_table *table)
68 /* Check "no ranges" first */
69 if (regmap_reg_in_ranges(reg, table->no_ranges, table->n_no_ranges))
72 /* In case zero "yes ranges" are supplied, any reg is OK */
73 if (!table->n_yes_ranges)
76 return regmap_reg_in_ranges(reg, table->yes_ranges,
79 EXPORT_SYMBOL_GPL(regmap_check_range_table);
81 bool regmap_writeable(struct regmap *map, unsigned int reg)
83 if (map->max_register && reg > map->max_register)
86 if (map->writeable_reg)
87 return map->writeable_reg(map->dev, reg);
90 return regmap_check_range_table(map, reg, map->wr_table);
95 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 (!map->format.format_write && !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);
132 bool regmap_precious(struct regmap *map, unsigned int reg)
134 if (!regmap_readable(map, reg))
137 if (map->precious_reg)
138 return map->precious_reg(map->dev, reg);
140 if (map->precious_table)
141 return regmap_check_range_table(map, reg, map->precious_table);
146 static bool regmap_volatile_range(struct regmap *map, unsigned int reg,
151 for (i = 0; i < num; i++)
152 if (!regmap_volatile(map, reg + i))
158 static void regmap_format_2_6_write(struct regmap *map,
159 unsigned int reg, unsigned int val)
161 u8 *out = map->work_buf;
163 *out = (reg << 6) | val;
166 static void regmap_format_4_12_write(struct regmap *map,
167 unsigned int reg, unsigned int val)
169 __be16 *out = map->work_buf;
170 *out = cpu_to_be16((reg << 12) | val);
173 static void regmap_format_7_9_write(struct regmap *map,
174 unsigned int reg, unsigned int val)
176 __be16 *out = map->work_buf;
177 *out = cpu_to_be16((reg << 9) | val);
180 static void regmap_format_10_14_write(struct regmap *map,
181 unsigned int reg, unsigned int val)
183 u8 *out = map->work_buf;
186 out[1] = (val >> 8) | (reg << 6);
190 static void regmap_format_8(void *buf, unsigned int val, unsigned int shift)
197 static void regmap_format_16_be(void *buf, unsigned int val, unsigned int shift)
201 b[0] = cpu_to_be16(val << shift);
204 static void regmap_format_16_le(void *buf, unsigned int val, unsigned int shift)
208 b[0] = cpu_to_le16(val << shift);
211 static void regmap_format_16_native(void *buf, unsigned int val,
214 *(u16 *)buf = val << shift;
217 static void regmap_format_24(void *buf, unsigned int val, unsigned int shift)
228 static void regmap_format_32_be(void *buf, unsigned int val, unsigned int shift)
232 b[0] = cpu_to_be32(val << shift);
235 static void regmap_format_32_le(void *buf, unsigned int val, unsigned int shift)
239 b[0] = cpu_to_le32(val << shift);
242 static void regmap_format_32_native(void *buf, unsigned int val,
245 *(u32 *)buf = val << shift;
248 static void regmap_parse_inplace_noop(void *buf)
252 static unsigned int regmap_parse_8(const void *buf)
259 static unsigned int regmap_parse_16_be(const void *buf)
261 const __be16 *b = buf;
263 return be16_to_cpu(b[0]);
266 static unsigned int regmap_parse_16_le(const void *buf)
268 const __le16 *b = buf;
270 return le16_to_cpu(b[0]);
273 static void regmap_parse_16_be_inplace(void *buf)
277 b[0] = be16_to_cpu(b[0]);
280 static void regmap_parse_16_le_inplace(void *buf)
284 b[0] = le16_to_cpu(b[0]);
287 static unsigned int regmap_parse_16_native(const void *buf)
292 static unsigned int regmap_parse_24(const void *buf)
295 unsigned int ret = b[2];
296 ret |= ((unsigned int)b[1]) << 8;
297 ret |= ((unsigned int)b[0]) << 16;
302 static unsigned int regmap_parse_32_be(const void *buf)
304 const __be32 *b = buf;
306 return be32_to_cpu(b[0]);
309 static unsigned int regmap_parse_32_le(const void *buf)
311 const __le32 *b = buf;
313 return le32_to_cpu(b[0]);
316 static void regmap_parse_32_be_inplace(void *buf)
320 b[0] = be32_to_cpu(b[0]);
323 static void regmap_parse_32_le_inplace(void *buf)
327 b[0] = le32_to_cpu(b[0]);
330 static unsigned int regmap_parse_32_native(const void *buf)
335 static void regmap_lock_mutex(void *__map)
337 struct regmap *map = __map;
338 mutex_lock(&map->mutex);
341 static void regmap_unlock_mutex(void *__map)
343 struct regmap *map = __map;
344 mutex_unlock(&map->mutex);
347 static void regmap_lock_spinlock(void *__map)
348 __acquires(&map->spinlock)
350 struct regmap *map = __map;
353 spin_lock_irqsave(&map->spinlock, flags);
354 map->spinlock_flags = flags;
357 static void regmap_unlock_spinlock(void *__map)
358 __releases(&map->spinlock)
360 struct regmap *map = __map;
361 spin_unlock_irqrestore(&map->spinlock, map->spinlock_flags);
364 static void dev_get_regmap_release(struct device *dev, void *res)
367 * We don't actually have anything to do here; the goal here
368 * is not to manage the regmap but to provide a simple way to
369 * get the regmap back given a struct device.
373 static bool _regmap_range_add(struct regmap *map,
374 struct regmap_range_node *data)
376 struct rb_root *root = &map->range_tree;
377 struct rb_node **new = &(root->rb_node), *parent = NULL;
380 struct regmap_range_node *this =
381 container_of(*new, struct regmap_range_node, node);
384 if (data->range_max < this->range_min)
385 new = &((*new)->rb_left);
386 else if (data->range_min > this->range_max)
387 new = &((*new)->rb_right);
392 rb_link_node(&data->node, parent, new);
393 rb_insert_color(&data->node, root);
398 static struct regmap_range_node *_regmap_range_lookup(struct regmap *map,
401 struct rb_node *node = map->range_tree.rb_node;
404 struct regmap_range_node *this =
405 container_of(node, struct regmap_range_node, node);
407 if (reg < this->range_min)
408 node = node->rb_left;
409 else if (reg > this->range_max)
410 node = node->rb_right;
418 static void regmap_range_exit(struct regmap *map)
420 struct rb_node *next;
421 struct regmap_range_node *range_node;
423 next = rb_first(&map->range_tree);
425 range_node = rb_entry(next, struct regmap_range_node, node);
426 next = rb_next(&range_node->node);
427 rb_erase(&range_node->node, &map->range_tree);
431 kfree(map->selector_work_buf);
434 int regmap_attach_dev(struct device *dev, struct regmap *map,
435 const struct regmap_config *config)
441 regmap_debugfs_init(map, config->name);
443 /* Add a devres resource for dev_get_regmap() */
444 m = devres_alloc(dev_get_regmap_release, sizeof(*m), GFP_KERNEL);
446 regmap_debugfs_exit(map);
454 EXPORT_SYMBOL_GPL(regmap_attach_dev);
456 static enum regmap_endian regmap_get_reg_endian(const struct regmap_bus *bus,
457 const struct regmap_config *config)
459 enum regmap_endian endian;
461 /* Retrieve the endianness specification from the regmap config */
462 endian = config->reg_format_endian;
464 /* If the regmap config specified a non-default value, use that */
465 if (endian != REGMAP_ENDIAN_DEFAULT)
468 /* Retrieve the endianness specification from the bus config */
469 if (bus && bus->reg_format_endian_default)
470 endian = bus->reg_format_endian_default;
472 /* If the bus specified a non-default value, use that */
473 if (endian != REGMAP_ENDIAN_DEFAULT)
476 /* Use this if no other value was found */
477 return REGMAP_ENDIAN_BIG;
480 enum regmap_endian regmap_get_val_endian(struct device *dev,
481 const struct regmap_bus *bus,
482 const struct regmap_config *config)
484 struct device_node *np;
485 enum regmap_endian endian;
487 /* Retrieve the endianness specification from the regmap config */
488 endian = config->val_format_endian;
490 /* If the regmap config specified a non-default value, use that */
491 if (endian != REGMAP_ENDIAN_DEFAULT)
494 /* If the dev and dev->of_node exist try to get endianness from DT */
495 if (dev && dev->of_node) {
498 /* Parse the device's DT node for an endianness specification */
499 if (of_property_read_bool(np, "big-endian"))
500 endian = REGMAP_ENDIAN_BIG;
501 else if (of_property_read_bool(np, "little-endian"))
502 endian = REGMAP_ENDIAN_LITTLE;
504 /* If the endianness was specified in DT, use that */
505 if (endian != REGMAP_ENDIAN_DEFAULT)
509 /* Retrieve the endianness specification from the bus config */
510 if (bus && bus->val_format_endian_default)
511 endian = bus->val_format_endian_default;
513 /* If the bus specified a non-default value, use that */
514 if (endian != REGMAP_ENDIAN_DEFAULT)
517 /* Use this if no other value was found */
518 return REGMAP_ENDIAN_BIG;
520 EXPORT_SYMBOL_GPL(regmap_get_val_endian);
522 struct regmap *__regmap_init(struct device *dev,
523 const struct regmap_bus *bus,
525 const struct regmap_config *config,
526 struct lock_class_key *lock_key,
527 const char *lock_name)
531 enum regmap_endian reg_endian, val_endian;
537 map = kzalloc(sizeof(*map), GFP_KERNEL);
543 if (config->lock && config->unlock) {
544 map->lock = config->lock;
545 map->unlock = config->unlock;
546 map->lock_arg = config->lock_arg;
548 if ((bus && bus->fast_io) ||
550 spin_lock_init(&map->spinlock);
551 map->lock = regmap_lock_spinlock;
552 map->unlock = regmap_unlock_spinlock;
553 lockdep_set_class_and_name(&map->spinlock,
554 lock_key, lock_name);
556 mutex_init(&map->mutex);
557 map->lock = regmap_lock_mutex;
558 map->unlock = regmap_unlock_mutex;
559 lockdep_set_class_and_name(&map->mutex,
560 lock_key, lock_name);
566 * When we write in fast-paths with regmap_bulk_write() don't allocate
567 * scratch buffers with sleeping allocations.
569 if ((bus && bus->fast_io) || config->fast_io)
570 map->alloc_flags = GFP_ATOMIC;
572 map->alloc_flags = GFP_KERNEL;
574 map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
575 map->format.pad_bytes = config->pad_bits / 8;
576 map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
577 map->format.buf_size = DIV_ROUND_UP(config->reg_bits +
578 config->val_bits + config->pad_bits, 8);
579 map->reg_shift = config->pad_bits % 8;
580 if (config->reg_stride)
581 map->reg_stride = config->reg_stride;
584 map->use_single_read = config->use_single_rw || !bus || !bus->read;
585 map->use_single_write = config->use_single_rw || !bus || !bus->write;
586 map->can_multi_write = config->can_multi_write && bus && bus->write;
588 map->max_raw_read = bus->max_raw_read;
589 map->max_raw_write = bus->max_raw_write;
593 map->bus_context = bus_context;
594 map->max_register = config->max_register;
595 map->wr_table = config->wr_table;
596 map->rd_table = config->rd_table;
597 map->volatile_table = config->volatile_table;
598 map->precious_table = config->precious_table;
599 map->writeable_reg = config->writeable_reg;
600 map->readable_reg = config->readable_reg;
601 map->volatile_reg = config->volatile_reg;
602 map->precious_reg = config->precious_reg;
603 map->cache_type = config->cache_type;
604 map->name = config->name;
606 spin_lock_init(&map->async_lock);
607 INIT_LIST_HEAD(&map->async_list);
608 INIT_LIST_HEAD(&map->async_free);
609 init_waitqueue_head(&map->async_waitq);
611 if (config->read_flag_mask || config->write_flag_mask) {
612 map->read_flag_mask = config->read_flag_mask;
613 map->write_flag_mask = config->write_flag_mask;
615 map->read_flag_mask = bus->read_flag_mask;
619 map->reg_read = config->reg_read;
620 map->reg_write = config->reg_write;
622 map->defer_caching = false;
623 goto skip_format_initialization;
624 } else if (!bus->read || !bus->write) {
625 map->reg_read = _regmap_bus_reg_read;
626 map->reg_write = _regmap_bus_reg_write;
628 map->defer_caching = false;
629 goto skip_format_initialization;
631 map->reg_read = _regmap_bus_read;
632 map->reg_update_bits = bus->reg_update_bits;
635 reg_endian = regmap_get_reg_endian(bus, config);
636 val_endian = regmap_get_val_endian(dev, bus, config);
638 switch (config->reg_bits + map->reg_shift) {
640 switch (config->val_bits) {
642 map->format.format_write = regmap_format_2_6_write;
650 switch (config->val_bits) {
652 map->format.format_write = regmap_format_4_12_write;
660 switch (config->val_bits) {
662 map->format.format_write = regmap_format_7_9_write;
670 switch (config->val_bits) {
672 map->format.format_write = regmap_format_10_14_write;
680 map->format.format_reg = regmap_format_8;
684 switch (reg_endian) {
685 case REGMAP_ENDIAN_BIG:
686 map->format.format_reg = regmap_format_16_be;
688 case REGMAP_ENDIAN_NATIVE:
689 map->format.format_reg = regmap_format_16_native;
697 if (reg_endian != REGMAP_ENDIAN_BIG)
699 map->format.format_reg = regmap_format_24;
703 switch (reg_endian) {
704 case REGMAP_ENDIAN_BIG:
705 map->format.format_reg = regmap_format_32_be;
707 case REGMAP_ENDIAN_NATIVE:
708 map->format.format_reg = regmap_format_32_native;
719 if (val_endian == REGMAP_ENDIAN_NATIVE)
720 map->format.parse_inplace = regmap_parse_inplace_noop;
722 switch (config->val_bits) {
724 map->format.format_val = regmap_format_8;
725 map->format.parse_val = regmap_parse_8;
726 map->format.parse_inplace = regmap_parse_inplace_noop;
729 switch (val_endian) {
730 case REGMAP_ENDIAN_BIG:
731 map->format.format_val = regmap_format_16_be;
732 map->format.parse_val = regmap_parse_16_be;
733 map->format.parse_inplace = regmap_parse_16_be_inplace;
735 case REGMAP_ENDIAN_LITTLE:
736 map->format.format_val = regmap_format_16_le;
737 map->format.parse_val = regmap_parse_16_le;
738 map->format.parse_inplace = regmap_parse_16_le_inplace;
740 case REGMAP_ENDIAN_NATIVE:
741 map->format.format_val = regmap_format_16_native;
742 map->format.parse_val = regmap_parse_16_native;
749 if (val_endian != REGMAP_ENDIAN_BIG)
751 map->format.format_val = regmap_format_24;
752 map->format.parse_val = regmap_parse_24;
755 switch (val_endian) {
756 case REGMAP_ENDIAN_BIG:
757 map->format.format_val = regmap_format_32_be;
758 map->format.parse_val = regmap_parse_32_be;
759 map->format.parse_inplace = regmap_parse_32_be_inplace;
761 case REGMAP_ENDIAN_LITTLE:
762 map->format.format_val = regmap_format_32_le;
763 map->format.parse_val = regmap_parse_32_le;
764 map->format.parse_inplace = regmap_parse_32_le_inplace;
766 case REGMAP_ENDIAN_NATIVE:
767 map->format.format_val = regmap_format_32_native;
768 map->format.parse_val = regmap_parse_32_native;
776 if (map->format.format_write) {
777 if ((reg_endian != REGMAP_ENDIAN_BIG) ||
778 (val_endian != REGMAP_ENDIAN_BIG))
780 map->use_single_write = true;
783 if (!map->format.format_write &&
784 !(map->format.format_reg && map->format.format_val))
787 map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
788 if (map->work_buf == NULL) {
793 if (map->format.format_write) {
794 map->defer_caching = false;
795 map->reg_write = _regmap_bus_formatted_write;
796 } else if (map->format.format_val) {
797 map->defer_caching = true;
798 map->reg_write = _regmap_bus_raw_write;
801 skip_format_initialization:
803 map->range_tree = RB_ROOT;
804 for (i = 0; i < config->num_ranges; i++) {
805 const struct regmap_range_cfg *range_cfg = &config->ranges[i];
806 struct regmap_range_node *new;
809 if (range_cfg->range_max < range_cfg->range_min) {
810 dev_err(map->dev, "Invalid range %d: %d < %d\n", i,
811 range_cfg->range_max, range_cfg->range_min);
815 if (range_cfg->range_max > map->max_register) {
816 dev_err(map->dev, "Invalid range %d: %d > %d\n", i,
817 range_cfg->range_max, map->max_register);
821 if (range_cfg->selector_reg > map->max_register) {
823 "Invalid range %d: selector out of map\n", i);
827 if (range_cfg->window_len == 0) {
828 dev_err(map->dev, "Invalid range %d: window_len 0\n",
833 /* Make sure, that this register range has no selector
834 or data window within its boundary */
835 for (j = 0; j < config->num_ranges; j++) {
836 unsigned sel_reg = config->ranges[j].selector_reg;
837 unsigned win_min = config->ranges[j].window_start;
838 unsigned win_max = win_min +
839 config->ranges[j].window_len - 1;
841 /* Allow data window inside its own virtual range */
845 if (range_cfg->range_min <= sel_reg &&
846 sel_reg <= range_cfg->range_max) {
848 "Range %d: selector for %d in window\n",
853 if (!(win_max < range_cfg->range_min ||
854 win_min > range_cfg->range_max)) {
856 "Range %d: window for %d in window\n",
862 new = kzalloc(sizeof(*new), GFP_KERNEL);
869 new->name = range_cfg->name;
870 new->range_min = range_cfg->range_min;
871 new->range_max = range_cfg->range_max;
872 new->selector_reg = range_cfg->selector_reg;
873 new->selector_mask = range_cfg->selector_mask;
874 new->selector_shift = range_cfg->selector_shift;
875 new->window_start = range_cfg->window_start;
876 new->window_len = range_cfg->window_len;
878 if (!_regmap_range_add(map, new)) {
879 dev_err(map->dev, "Failed to add range %d\n", i);
884 if (map->selector_work_buf == NULL) {
885 map->selector_work_buf =
886 kzalloc(map->format.buf_size, GFP_KERNEL);
887 if (map->selector_work_buf == NULL) {
894 ret = regcache_init(map, config);
899 ret = regmap_attach_dev(dev, map, config);
909 regmap_range_exit(map);
910 kfree(map->work_buf);
916 EXPORT_SYMBOL_GPL(__regmap_init);
918 static void devm_regmap_release(struct device *dev, void *res)
920 regmap_exit(*(struct regmap **)res);
923 struct regmap *__devm_regmap_init(struct device *dev,
924 const struct regmap_bus *bus,
926 const struct regmap_config *config,
927 struct lock_class_key *lock_key,
928 const char *lock_name)
930 struct regmap **ptr, *regmap;
932 ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
934 return ERR_PTR(-ENOMEM);
936 regmap = __regmap_init(dev, bus, bus_context, config,
937 lock_key, lock_name);
938 if (!IS_ERR(regmap)) {
940 devres_add(dev, ptr);
947 EXPORT_SYMBOL_GPL(__devm_regmap_init);
949 static void regmap_field_init(struct regmap_field *rm_field,
950 struct regmap *regmap, struct reg_field reg_field)
952 rm_field->regmap = regmap;
953 rm_field->reg = reg_field.reg;
954 rm_field->shift = reg_field.lsb;
955 rm_field->mask = GENMASK(reg_field.msb, reg_field.lsb);
956 rm_field->id_size = reg_field.id_size;
957 rm_field->id_offset = reg_field.id_offset;
961 * devm_regmap_field_alloc(): Allocate and initialise a register field
964 * @dev: Device that will be interacted with
965 * @regmap: regmap bank in which this register field is located.
966 * @reg_field: Register field with in the bank.
968 * The return value will be an ERR_PTR() on error or a valid pointer
969 * to a struct regmap_field. The regmap_field will be automatically freed
970 * by the device management code.
972 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
973 struct regmap *regmap, struct reg_field reg_field)
975 struct regmap_field *rm_field = devm_kzalloc(dev,
976 sizeof(*rm_field), GFP_KERNEL);
978 return ERR_PTR(-ENOMEM);
980 regmap_field_init(rm_field, regmap, reg_field);
985 EXPORT_SYMBOL_GPL(devm_regmap_field_alloc);
988 * devm_regmap_field_free(): Free register field allocated using
989 * devm_regmap_field_alloc. Usally drivers need not call this function,
990 * as the memory allocated via devm will be freed as per device-driver
993 * @dev: Device that will be interacted with
994 * @field: regmap field which should be freed.
996 void devm_regmap_field_free(struct device *dev,
997 struct regmap_field *field)
999 devm_kfree(dev, field);
1001 EXPORT_SYMBOL_GPL(devm_regmap_field_free);
1004 * regmap_field_alloc(): Allocate and initialise a register field
1005 * in a register map.
1007 * @regmap: regmap bank in which this register field is located.
1008 * @reg_field: Register field with in the bank.
1010 * The return value will be an ERR_PTR() on error or a valid pointer
1011 * to a struct regmap_field. The regmap_field should be freed by the
1012 * user once its finished working with it using regmap_field_free().
1014 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
1015 struct reg_field reg_field)
1017 struct regmap_field *rm_field = kzalloc(sizeof(*rm_field), GFP_KERNEL);
1020 return ERR_PTR(-ENOMEM);
1022 regmap_field_init(rm_field, regmap, reg_field);
1026 EXPORT_SYMBOL_GPL(regmap_field_alloc);
1029 * regmap_field_free(): Free register field allocated using regmap_field_alloc
1031 * @field: regmap field which should be freed.
1033 void regmap_field_free(struct regmap_field *field)
1037 EXPORT_SYMBOL_GPL(regmap_field_free);
1040 * regmap_reinit_cache(): Reinitialise the current register cache
1042 * @map: Register map to operate on.
1043 * @config: New configuration. Only the cache data will be used.
1045 * Discard any existing register cache for the map and initialize a
1046 * new cache. This can be used to restore the cache to defaults or to
1047 * update the cache configuration to reflect runtime discovery of the
1050 * No explicit locking is done here, the user needs to ensure that
1051 * this function will not race with other calls to regmap.
1053 int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
1056 regmap_debugfs_exit(map);
1058 map->max_register = config->max_register;
1059 map->writeable_reg = config->writeable_reg;
1060 map->readable_reg = config->readable_reg;
1061 map->volatile_reg = config->volatile_reg;
1062 map->precious_reg = config->precious_reg;
1063 map->cache_type = config->cache_type;
1065 regmap_debugfs_init(map, config->name);
1067 map->cache_bypass = false;
1068 map->cache_only = false;
1070 return regcache_init(map, config);
1072 EXPORT_SYMBOL_GPL(regmap_reinit_cache);
1075 * regmap_exit(): Free a previously allocated register map
1077 void regmap_exit(struct regmap *map)
1079 struct regmap_async *async;
1082 regmap_debugfs_exit(map);
1083 regmap_range_exit(map);
1084 if (map->bus && map->bus->free_context)
1085 map->bus->free_context(map->bus_context);
1086 kfree(map->work_buf);
1087 while (!list_empty(&map->async_free)) {
1088 async = list_first_entry_or_null(&map->async_free,
1089 struct regmap_async,
1091 list_del(&async->list);
1092 kfree(async->work_buf);
1097 EXPORT_SYMBOL_GPL(regmap_exit);
1099 static int dev_get_regmap_match(struct device *dev, void *res, void *data)
1101 struct regmap **r = res;
1107 /* If the user didn't specify a name match any */
1109 return !strcmp((*r)->name, data);
1115 * dev_get_regmap(): Obtain the regmap (if any) for a device
1117 * @dev: Device to retrieve the map for
1118 * @name: Optional name for the register map, usually NULL.
1120 * Returns the regmap for the device if one is present, or NULL. If
1121 * name is specified then it must match the name specified when
1122 * registering the device, if it is NULL then the first regmap found
1123 * will be used. Devices with multiple register maps are very rare,
1124 * generic code should normally not need to specify a name.
1126 struct regmap *dev_get_regmap(struct device *dev, const char *name)
1128 struct regmap **r = devres_find(dev, dev_get_regmap_release,
1129 dev_get_regmap_match, (void *)name);
1135 EXPORT_SYMBOL_GPL(dev_get_regmap);
1138 * regmap_get_device(): Obtain the device from a regmap
1140 * @map: Register map to operate on.
1142 * Returns the underlying device that the regmap has been created for.
1144 struct device *regmap_get_device(struct regmap *map)
1148 EXPORT_SYMBOL_GPL(regmap_get_device);
1150 static int _regmap_select_page(struct regmap *map, unsigned int *reg,
1151 struct regmap_range_node *range,
1152 unsigned int val_num)
1154 void *orig_work_buf;
1155 unsigned int win_offset;
1156 unsigned int win_page;
1160 win_offset = (*reg - range->range_min) % range->window_len;
1161 win_page = (*reg - range->range_min) / range->window_len;
1164 /* Bulk write shouldn't cross range boundary */
1165 if (*reg + val_num - 1 > range->range_max)
1168 /* ... or single page boundary */
1169 if (val_num > range->window_len - win_offset)
1173 /* It is possible to have selector register inside data window.
1174 In that case, selector register is located on every page and
1175 it needs no page switching, when accessed alone. */
1177 range->window_start + win_offset != range->selector_reg) {
1178 /* Use separate work_buf during page switching */
1179 orig_work_buf = map->work_buf;
1180 map->work_buf = map->selector_work_buf;
1182 ret = _regmap_update_bits(map, range->selector_reg,
1183 range->selector_mask,
1184 win_page << range->selector_shift,
1187 map->work_buf = orig_work_buf;
1193 *reg = range->window_start + win_offset;
1198 int _regmap_raw_write(struct regmap *map, unsigned int reg,
1199 const void *val, size_t val_len)
1201 struct regmap_range_node *range;
1202 unsigned long flags;
1203 u8 *u8 = map->work_buf;
1204 void *work_val = map->work_buf + map->format.reg_bytes +
1205 map->format.pad_bytes;
1207 int ret = -ENOTSUPP;
1213 /* Check for unwritable registers before we start */
1214 if (map->writeable_reg)
1215 for (i = 0; i < val_len / map->format.val_bytes; i++)
1216 if (!map->writeable_reg(map->dev,
1217 reg + (i * map->reg_stride)))
1220 if (!map->cache_bypass && map->format.parse_val) {
1222 int val_bytes = map->format.val_bytes;
1223 for (i = 0; i < val_len / val_bytes; i++) {
1224 ival = map->format.parse_val(val + (i * val_bytes));
1225 ret = regcache_write(map, reg + (i * map->reg_stride),
1229 "Error in caching of register: %x ret: %d\n",
1234 if (map->cache_only) {
1235 map->cache_dirty = true;
1240 range = _regmap_range_lookup(map, reg);
1242 int val_num = val_len / map->format.val_bytes;
1243 int win_offset = (reg - range->range_min) % range->window_len;
1244 int win_residue = range->window_len - win_offset;
1246 /* If the write goes beyond the end of the window split it */
1247 while (val_num > win_residue) {
1248 dev_dbg(map->dev, "Writing window %d/%zu\n",
1249 win_residue, val_len / map->format.val_bytes);
1250 ret = _regmap_raw_write(map, reg, val, win_residue *
1251 map->format.val_bytes);
1256 val_num -= win_residue;
1257 val += win_residue * map->format.val_bytes;
1258 val_len -= win_residue * map->format.val_bytes;
1260 win_offset = (reg - range->range_min) %
1262 win_residue = range->window_len - win_offset;
1265 ret = _regmap_select_page(map, ®, range, val_num);
1270 map->format.format_reg(map->work_buf, reg, map->reg_shift);
1272 u8[0] |= map->write_flag_mask;
1275 * Essentially all I/O mechanisms will be faster with a single
1276 * buffer to write. Since register syncs often generate raw
1277 * writes of single registers optimise that case.
1279 if (val != work_val && val_len == map->format.val_bytes) {
1280 memcpy(work_val, val, map->format.val_bytes);
1284 if (map->async && map->bus->async_write) {
1285 struct regmap_async *async;
1287 trace_regmap_async_write_start(map, reg, val_len);
1289 spin_lock_irqsave(&map->async_lock, flags);
1290 async = list_first_entry_or_null(&map->async_free,
1291 struct regmap_async,
1294 list_del(&async->list);
1295 spin_unlock_irqrestore(&map->async_lock, flags);
1298 async = map->bus->async_alloc();
1302 async->work_buf = kzalloc(map->format.buf_size,
1303 GFP_KERNEL | GFP_DMA);
1304 if (!async->work_buf) {
1312 /* If the caller supplied the value we can use it safely. */
1313 memcpy(async->work_buf, map->work_buf, map->format.pad_bytes +
1314 map->format.reg_bytes + map->format.val_bytes);
1316 spin_lock_irqsave(&map->async_lock, flags);
1317 list_add_tail(&async->list, &map->async_list);
1318 spin_unlock_irqrestore(&map->async_lock, flags);
1320 if (val != work_val)
1321 ret = map->bus->async_write(map->bus_context,
1323 map->format.reg_bytes +
1324 map->format.pad_bytes,
1325 val, val_len, async);
1327 ret = map->bus->async_write(map->bus_context,
1329 map->format.reg_bytes +
1330 map->format.pad_bytes +
1331 val_len, NULL, 0, async);
1334 dev_err(map->dev, "Failed to schedule write: %d\n",
1337 spin_lock_irqsave(&map->async_lock, flags);
1338 list_move(&async->list, &map->async_free);
1339 spin_unlock_irqrestore(&map->async_lock, flags);
1345 trace_regmap_hw_write_start(map, reg, val_len / map->format.val_bytes);
1347 /* If we're doing a single register write we can probably just
1348 * send the work_buf directly, otherwise try to do a gather
1351 if (val == work_val)
1352 ret = map->bus->write(map->bus_context, map->work_buf,
1353 map->format.reg_bytes +
1354 map->format.pad_bytes +
1356 else if (map->bus->gather_write)
1357 ret = map->bus->gather_write(map->bus_context, map->work_buf,
1358 map->format.reg_bytes +
1359 map->format.pad_bytes,
1364 /* If that didn't work fall back on linearising by hand. */
1365 if (ret == -ENOTSUPP) {
1366 len = map->format.reg_bytes + map->format.pad_bytes + val_len;
1367 buf = kzalloc(len, GFP_KERNEL);
1371 memcpy(buf, map->work_buf, map->format.reg_bytes);
1372 memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
1374 ret = map->bus->write(map->bus_context, buf, len);
1379 trace_regmap_hw_write_done(map, reg, val_len / map->format.val_bytes);
1385 * regmap_can_raw_write - Test if regmap_raw_write() is supported
1387 * @map: Map to check.
1389 bool regmap_can_raw_write(struct regmap *map)
1391 return map->bus && map->bus->write && map->format.format_val &&
1392 map->format.format_reg;
1394 EXPORT_SYMBOL_GPL(regmap_can_raw_write);
1397 * regmap_get_raw_read_max - Get the maximum size we can read
1399 * @map: Map to check.
1401 size_t regmap_get_raw_read_max(struct regmap *map)
1403 return map->max_raw_read;
1405 EXPORT_SYMBOL_GPL(regmap_get_raw_read_max);
1408 * regmap_get_raw_write_max - Get the maximum size we can read
1410 * @map: Map to check.
1412 size_t regmap_get_raw_write_max(struct regmap *map)
1414 return map->max_raw_write;
1416 EXPORT_SYMBOL_GPL(regmap_get_raw_write_max);
1418 static int _regmap_bus_formatted_write(void *context, unsigned int reg,
1422 struct regmap_range_node *range;
1423 struct regmap *map = context;
1425 WARN_ON(!map->bus || !map->format.format_write);
1427 range = _regmap_range_lookup(map, reg);
1429 ret = _regmap_select_page(map, ®, range, 1);
1434 map->format.format_write(map, reg, val);
1436 trace_regmap_hw_write_start(map, reg, 1);
1438 ret = map->bus->write(map->bus_context, map->work_buf,
1439 map->format.buf_size);
1441 trace_regmap_hw_write_done(map, reg, 1);
1446 static int _regmap_bus_reg_write(void *context, unsigned int reg,
1449 struct regmap *map = context;
1451 return map->bus->reg_write(map->bus_context, reg, val);
1454 static int _regmap_bus_raw_write(void *context, unsigned int reg,
1457 struct regmap *map = context;
1459 WARN_ON(!map->bus || !map->format.format_val);
1461 map->format.format_val(map->work_buf + map->format.reg_bytes
1462 + map->format.pad_bytes, val, 0);
1463 return _regmap_raw_write(map, reg,
1465 map->format.reg_bytes +
1466 map->format.pad_bytes,
1467 map->format.val_bytes);
1470 static inline void *_regmap_map_get_context(struct regmap *map)
1472 return (map->bus) ? map : map->bus_context;
1475 int _regmap_write(struct regmap *map, unsigned int reg,
1479 void *context = _regmap_map_get_context(map);
1481 if (!regmap_writeable(map, reg))
1484 if (!map->cache_bypass && !map->defer_caching) {
1485 ret = regcache_write(map, reg, val);
1488 if (map->cache_only) {
1489 map->cache_dirty = true;
1495 if (map->dev && strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
1496 dev_info(map->dev, "%x <= %x\n", reg, val);
1499 trace_regmap_reg_write(map, reg, val);
1501 return map->reg_write(context, reg, val);
1505 * regmap_write(): Write a value to a single register
1507 * @map: Register map to write to
1508 * @reg: Register to write to
1509 * @val: Value to be written
1511 * A value of zero will be returned on success, a negative errno will
1512 * be returned in error cases.
1514 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
1518 if (reg % map->reg_stride)
1521 map->lock(map->lock_arg);
1523 ret = _regmap_write(map, reg, val);
1525 map->unlock(map->lock_arg);
1529 EXPORT_SYMBOL_GPL(regmap_write);
1532 * regmap_write_async(): Write a value to a single register asynchronously
1534 * @map: Register map to write to
1535 * @reg: Register to write to
1536 * @val: Value to be written
1538 * A value of zero will be returned on success, a negative errno will
1539 * be returned in error cases.
1541 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val)
1545 if (reg % map->reg_stride)
1548 map->lock(map->lock_arg);
1552 ret = _regmap_write(map, reg, val);
1556 map->unlock(map->lock_arg);
1560 EXPORT_SYMBOL_GPL(regmap_write_async);
1563 * regmap_raw_write(): Write raw values to one or more registers
1565 * @map: Register map to write to
1566 * @reg: Initial register to write to
1567 * @val: Block of data to be written, laid out for direct transmission to the
1569 * @val_len: Length of data pointed to by val.
1571 * This function is intended to be used for things like firmware
1572 * download where a large block of data needs to be transferred to the
1573 * device. No formatting will be done on the data provided.
1575 * A value of zero will be returned on success, a negative errno will
1576 * be returned in error cases.
1578 int regmap_raw_write(struct regmap *map, unsigned int reg,
1579 const void *val, size_t val_len)
1583 if (!regmap_can_raw_write(map))
1585 if (val_len % map->format.val_bytes)
1587 if (map->max_raw_write && map->max_raw_write < val_len)
1590 map->lock(map->lock_arg);
1592 ret = _regmap_raw_write(map, reg, val, val_len);
1594 map->unlock(map->lock_arg);
1598 EXPORT_SYMBOL_GPL(regmap_raw_write);
1601 * regmap_field_write(): Write a value to a single register field
1603 * @field: Register field to write to
1604 * @val: Value to be written
1606 * A value of zero will be returned on success, a negative errno will
1607 * be returned in error cases.
1609 int regmap_field_write(struct regmap_field *field, unsigned int val)
1611 return regmap_update_bits(field->regmap, field->reg,
1612 field->mask, val << field->shift);
1614 EXPORT_SYMBOL_GPL(regmap_field_write);
1617 * regmap_field_update_bits(): Perform a read/modify/write cycle
1618 * on the register field
1620 * @field: Register field to write to
1621 * @mask: Bitmask to change
1622 * @val: Value to be written
1624 * A value of zero will be returned on success, a negative errno will
1625 * be returned in error cases.
1627 int regmap_field_update_bits(struct regmap_field *field, unsigned int mask, unsigned int val)
1629 mask = (mask << field->shift) & field->mask;
1631 return regmap_update_bits(field->regmap, field->reg,
1632 mask, val << field->shift);
1634 EXPORT_SYMBOL_GPL(regmap_field_update_bits);
1637 * regmap_fields_write(): Write a value to a single register field with port ID
1639 * @field: Register field to write to
1641 * @val: Value to be written
1643 * A value of zero will be returned on success, a negative errno will
1644 * be returned in error cases.
1646 int regmap_fields_write(struct regmap_field *field, unsigned int id,
1649 if (id >= field->id_size)
1652 return regmap_update_bits(field->regmap,
1653 field->reg + (field->id_offset * id),
1654 field->mask, val << field->shift);
1656 EXPORT_SYMBOL_GPL(regmap_fields_write);
1658 int regmap_fields_force_write(struct regmap_field *field, unsigned int id,
1661 if (id >= field->id_size)
1664 return regmap_write_bits(field->regmap,
1665 field->reg + (field->id_offset * id),
1666 field->mask, val << field->shift);
1668 EXPORT_SYMBOL_GPL(regmap_fields_force_write);
1671 * regmap_fields_update_bits(): Perform a read/modify/write cycle
1672 * on the register field
1674 * @field: Register field to write to
1676 * @mask: Bitmask to change
1677 * @val: Value to be written
1679 * A value of zero will be returned on success, a negative errno will
1680 * be returned in error cases.
1682 int regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
1683 unsigned int mask, unsigned int val)
1685 if (id >= field->id_size)
1688 mask = (mask << field->shift) & field->mask;
1690 return regmap_update_bits(field->regmap,
1691 field->reg + (field->id_offset * id),
1692 mask, val << field->shift);
1694 EXPORT_SYMBOL_GPL(regmap_fields_update_bits);
1697 * regmap_bulk_write(): Write multiple registers to the device
1699 * @map: Register map to write to
1700 * @reg: First register to be write from
1701 * @val: Block of data to be written, in native register size for device
1702 * @val_count: Number of registers to write
1704 * This function is intended to be used for writing a large block of
1705 * data to the device either in single transfer or multiple transfer.
1707 * A value of zero will be returned on success, a negative errno will
1708 * be returned in error cases.
1710 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1714 size_t val_bytes = map->format.val_bytes;
1715 size_t total_size = val_bytes * val_count;
1717 if (map->bus && !map->format.parse_inplace)
1719 if (reg % map->reg_stride)
1723 * Some devices don't support bulk write, for
1724 * them we have a series of single write operations in the first two if
1727 * The first if block is used for memory mapped io. It does not allow
1728 * val_bytes of 3 for example.
1729 * The second one is used for busses which do not have this limitation
1730 * and can write arbitrary value lengths.
1733 map->lock(map->lock_arg);
1734 for (i = 0; i < val_count; i++) {
1737 switch (val_bytes) {
1739 ival = *(u8 *)(val + (i * val_bytes));
1742 ival = *(u16 *)(val + (i * val_bytes));
1745 ival = *(u32 *)(val + (i * val_bytes));
1749 ival = *(u64 *)(val + (i * val_bytes));
1757 ret = _regmap_write(map, reg + (i * map->reg_stride),
1763 map->unlock(map->lock_arg);
1764 } else if (map->use_single_write ||
1765 (map->max_raw_write && map->max_raw_write < total_size)) {
1766 int chunk_stride = map->reg_stride;
1767 size_t chunk_size = val_bytes;
1768 size_t chunk_count = val_count;
1770 if (!map->use_single_write) {
1771 chunk_size = map->max_raw_write;
1772 if (chunk_size % val_bytes)
1773 chunk_size -= chunk_size % val_bytes;
1774 chunk_count = total_size / chunk_size;
1775 chunk_stride *= chunk_size / val_bytes;
1778 map->lock(map->lock_arg);
1779 /* Write as many bytes as possible with chunk_size */
1780 for (i = 0; i < chunk_count; i++) {
1781 ret = _regmap_raw_write(map,
1782 reg + (i * chunk_stride),
1783 val + (i * chunk_size),
1789 /* Write remaining bytes */
1790 if (!ret && chunk_size * i < total_size) {
1791 ret = _regmap_raw_write(map, reg + (i * chunk_stride),
1792 val + (i * chunk_size),
1793 total_size - i * chunk_size);
1795 map->unlock(map->lock_arg);
1802 wval = kmemdup(val, val_count * val_bytes, map->alloc_flags);
1804 dev_err(map->dev, "Error in memory allocation\n");
1807 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1808 map->format.parse_inplace(wval + i);
1810 map->lock(map->lock_arg);
1811 ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count);
1812 map->unlock(map->lock_arg);
1818 EXPORT_SYMBOL_GPL(regmap_bulk_write);
1821 * _regmap_raw_multi_reg_write()
1823 * the (register,newvalue) pairs in regs have not been formatted, but
1824 * they are all in the same page and have been changed to being page
1825 * relative. The page register has been written if that was necessary.
1827 static int _regmap_raw_multi_reg_write(struct regmap *map,
1828 const struct reg_sequence *regs,
1835 size_t val_bytes = map->format.val_bytes;
1836 size_t reg_bytes = map->format.reg_bytes;
1837 size_t pad_bytes = map->format.pad_bytes;
1838 size_t pair_size = reg_bytes + pad_bytes + val_bytes;
1839 size_t len = pair_size * num_regs;
1844 buf = kzalloc(len, GFP_KERNEL);
1848 /* We have to linearise by hand. */
1852 for (i = 0; i < num_regs; i++) {
1853 unsigned int reg = regs[i].reg;
1854 unsigned int val = regs[i].def;
1855 trace_regmap_hw_write_start(map, reg, 1);
1856 map->format.format_reg(u8, reg, map->reg_shift);
1857 u8 += reg_bytes + pad_bytes;
1858 map->format.format_val(u8, val, 0);
1862 *u8 |= map->write_flag_mask;
1864 ret = map->bus->write(map->bus_context, buf, len);
1868 for (i = 0; i < num_regs; i++) {
1869 int reg = regs[i].reg;
1870 trace_regmap_hw_write_done(map, reg, 1);
1875 static unsigned int _regmap_register_page(struct regmap *map,
1877 struct regmap_range_node *range)
1879 unsigned int win_page = (reg - range->range_min) / range->window_len;
1884 static int _regmap_range_multi_paged_reg_write(struct regmap *map,
1885 struct reg_sequence *regs,
1890 struct reg_sequence *base;
1891 unsigned int this_page = 0;
1892 unsigned int page_change = 0;
1894 * the set of registers are not neccessarily in order, but
1895 * since the order of write must be preserved this algorithm
1896 * chops the set each time the page changes. This also applies
1897 * if there is a delay required at any point in the sequence.
1900 for (i = 0, n = 0; i < num_regs; i++, n++) {
1901 unsigned int reg = regs[i].reg;
1902 struct regmap_range_node *range;
1904 range = _regmap_range_lookup(map, reg);
1906 unsigned int win_page = _regmap_register_page(map, reg,
1910 this_page = win_page;
1911 if (win_page != this_page) {
1912 this_page = win_page;
1917 /* If we have both a page change and a delay make sure to
1918 * write the regs and apply the delay before we change the
1922 if (page_change || regs[i].delay_us) {
1924 /* For situations where the first write requires
1925 * a delay we need to make sure we don't call
1926 * raw_multi_reg_write with n=0
1927 * This can't occur with page breaks as we
1928 * never write on the first iteration
1930 if (regs[i].delay_us && i == 0)
1933 ret = _regmap_raw_multi_reg_write(map, base, n);
1937 if (regs[i].delay_us)
1938 udelay(regs[i].delay_us);
1944 ret = _regmap_select_page(map,
1957 return _regmap_raw_multi_reg_write(map, base, n);
1961 static int _regmap_multi_reg_write(struct regmap *map,
1962 const struct reg_sequence *regs,
1968 if (!map->can_multi_write) {
1969 for (i = 0; i < num_regs; i++) {
1970 ret = _regmap_write(map, regs[i].reg, regs[i].def);
1974 if (regs[i].delay_us)
1975 udelay(regs[i].delay_us);
1980 if (!map->format.parse_inplace)
1983 if (map->writeable_reg)
1984 for (i = 0; i < num_regs; i++) {
1985 int reg = regs[i].reg;
1986 if (!map->writeable_reg(map->dev, reg))
1988 if (reg % map->reg_stride)
1992 if (!map->cache_bypass) {
1993 for (i = 0; i < num_regs; i++) {
1994 unsigned int val = regs[i].def;
1995 unsigned int reg = regs[i].reg;
1996 ret = regcache_write(map, reg, val);
1999 "Error in caching of register: %x ret: %d\n",
2004 if (map->cache_only) {
2005 map->cache_dirty = true;
2012 for (i = 0; i < num_regs; i++) {
2013 unsigned int reg = regs[i].reg;
2014 struct regmap_range_node *range;
2016 /* Coalesce all the writes between a page break or a delay
2019 range = _regmap_range_lookup(map, reg);
2020 if (range || regs[i].delay_us) {
2021 size_t len = sizeof(struct reg_sequence)*num_regs;
2022 struct reg_sequence *base = kmemdup(regs, len,
2026 ret = _regmap_range_multi_paged_reg_write(map, base,
2033 return _regmap_raw_multi_reg_write(map, regs, num_regs);
2037 * regmap_multi_reg_write(): Write multiple registers to the device
2039 * where the set of register,value pairs are supplied in any order,
2040 * possibly not all in a single range.
2042 * @map: Register map to write to
2043 * @regs: Array of structures containing register,value to be written
2044 * @num_regs: Number of registers to write
2046 * The 'normal' block write mode will send ultimately send data on the
2047 * target bus as R,V1,V2,V3,..,Vn where successively higer registers are
2048 * addressed. However, this alternative block multi write mode will send
2049 * the data as R1,V1,R2,V2,..,Rn,Vn on the target bus. The target device
2050 * must of course support the mode.
2052 * A value of zero will be returned on success, a negative errno will be
2053 * returned in error cases.
2055 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
2060 map->lock(map->lock_arg);
2062 ret = _regmap_multi_reg_write(map, regs, num_regs);
2064 map->unlock(map->lock_arg);
2068 EXPORT_SYMBOL_GPL(regmap_multi_reg_write);
2071 * regmap_multi_reg_write_bypassed(): Write multiple registers to the
2072 * device but not the cache
2074 * where the set of register are supplied in any order
2076 * @map: Register map to write to
2077 * @regs: Array of structures containing register,value to be written
2078 * @num_regs: Number of registers to write
2080 * This function is intended to be used for writing a large block of data
2081 * atomically to the device in single transfer for those I2C client devices
2082 * that implement this alternative block write mode.
2084 * A value of zero will be returned on success, a negative errno will
2085 * be returned in error cases.
2087 int regmap_multi_reg_write_bypassed(struct regmap *map,
2088 const struct reg_sequence *regs,
2094 map->lock(map->lock_arg);
2096 bypass = map->cache_bypass;
2097 map->cache_bypass = true;
2099 ret = _regmap_multi_reg_write(map, regs, num_regs);
2101 map->cache_bypass = bypass;
2103 map->unlock(map->lock_arg);
2107 EXPORT_SYMBOL_GPL(regmap_multi_reg_write_bypassed);
2110 * regmap_raw_write_async(): Write raw values to one or more registers
2113 * @map: Register map to write to
2114 * @reg: Initial register to write to
2115 * @val: Block of data to be written, laid out for direct transmission to the
2116 * device. Must be valid until regmap_async_complete() is called.
2117 * @val_len: Length of data pointed to by val.
2119 * This function is intended to be used for things like firmware
2120 * download where a large block of data needs to be transferred to the
2121 * device. No formatting will be done on the data provided.
2123 * If supported by the underlying bus the write will be scheduled
2124 * asynchronously, helping maximise I/O speed on higher speed buses
2125 * like SPI. regmap_async_complete() can be called to ensure that all
2126 * asynchrnous writes have been completed.
2128 * A value of zero will be returned on success, a negative errno will
2129 * be returned in error cases.
2131 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
2132 const void *val, size_t val_len)
2136 if (val_len % map->format.val_bytes)
2138 if (reg % map->reg_stride)
2141 map->lock(map->lock_arg);
2145 ret = _regmap_raw_write(map, reg, val, val_len);
2149 map->unlock(map->lock_arg);
2153 EXPORT_SYMBOL_GPL(regmap_raw_write_async);
2155 static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
2156 unsigned int val_len)
2158 struct regmap_range_node *range;
2159 u8 *u8 = map->work_buf;
2164 range = _regmap_range_lookup(map, reg);
2166 ret = _regmap_select_page(map, ®, range,
2167 val_len / map->format.val_bytes);
2172 map->format.format_reg(map->work_buf, reg, map->reg_shift);
2175 * Some buses or devices flag reads by setting the high bits in the
2176 * register address; since it's always the high bits for all
2177 * current formats we can do this here rather than in
2178 * formatting. This may break if we get interesting formats.
2180 u8[0] |= map->read_flag_mask;
2182 trace_regmap_hw_read_start(map, reg, val_len / map->format.val_bytes);
2184 ret = map->bus->read(map->bus_context, map->work_buf,
2185 map->format.reg_bytes + map->format.pad_bytes,
2188 trace_regmap_hw_read_done(map, reg, val_len / map->format.val_bytes);
2193 static int _regmap_bus_reg_read(void *context, unsigned int reg,
2196 struct regmap *map = context;
2198 return map->bus->reg_read(map->bus_context, reg, val);
2201 static int _regmap_bus_read(void *context, unsigned int reg,
2205 struct regmap *map = context;
2207 if (!map->format.parse_val)
2210 ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
2212 *val = map->format.parse_val(map->work_buf);
2217 static int _regmap_read(struct regmap *map, unsigned int reg,
2221 void *context = _regmap_map_get_context(map);
2223 if (!map->cache_bypass) {
2224 ret = regcache_read(map, reg, val);
2229 if (map->cache_only)
2232 if (!regmap_readable(map, reg))
2235 ret = map->reg_read(context, reg, val);
2238 if (map->dev && strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
2239 dev_info(map->dev, "%x => %x\n", reg, *val);
2242 trace_regmap_reg_read(map, reg, *val);
2244 if (!map->cache_bypass)
2245 regcache_write(map, reg, *val);
2252 * regmap_read(): Read a value from a single register
2254 * @map: Register map to read from
2255 * @reg: Register to be read from
2256 * @val: Pointer to store read value
2258 * A value of zero will be returned on success, a negative errno will
2259 * be returned in error cases.
2261 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
2265 if (reg % map->reg_stride)
2268 map->lock(map->lock_arg);
2270 ret = _regmap_read(map, reg, val);
2272 map->unlock(map->lock_arg);
2276 EXPORT_SYMBOL_GPL(regmap_read);
2279 * regmap_raw_read(): Read raw data from the device
2281 * @map: Register map to read from
2282 * @reg: First register to be read from
2283 * @val: Pointer to store read value
2284 * @val_len: Size of data to read
2286 * A value of zero will be returned on success, a negative errno will
2287 * be returned in error cases.
2289 int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
2292 size_t val_bytes = map->format.val_bytes;
2293 size_t val_count = val_len / val_bytes;
2299 if (val_len % map->format.val_bytes)
2301 if (reg % map->reg_stride)
2306 map->lock(map->lock_arg);
2308 if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
2309 map->cache_type == REGCACHE_NONE) {
2310 if (!map->bus->read) {
2314 if (map->max_raw_read && map->max_raw_read < val_len) {
2319 /* Physical block read if there's no cache involved */
2320 ret = _regmap_raw_read(map, reg, val, val_len);
2323 /* Otherwise go word by word for the cache; should be low
2324 * cost as we expect to hit the cache.
2326 for (i = 0; i < val_count; i++) {
2327 ret = _regmap_read(map, reg + (i * map->reg_stride),
2332 map->format.format_val(val + (i * val_bytes), v, 0);
2337 map->unlock(map->lock_arg);
2341 EXPORT_SYMBOL_GPL(regmap_raw_read);
2344 * regmap_field_read(): Read a value to a single register field
2346 * @field: Register field to read from
2347 * @val: Pointer to store read value
2349 * A value of zero will be returned on success, a negative errno will
2350 * be returned in error cases.
2352 int regmap_field_read(struct regmap_field *field, unsigned int *val)
2355 unsigned int reg_val;
2356 ret = regmap_read(field->regmap, field->reg, ®_val);
2360 reg_val &= field->mask;
2361 reg_val >>= field->shift;
2366 EXPORT_SYMBOL_GPL(regmap_field_read);
2369 * regmap_fields_read(): Read a value to a single register field with port ID
2371 * @field: Register field to read from
2373 * @val: Pointer to store read value
2375 * A value of zero will be returned on success, a negative errno will
2376 * be returned in error cases.
2378 int regmap_fields_read(struct regmap_field *field, unsigned int id,
2382 unsigned int reg_val;
2384 if (id >= field->id_size)
2387 ret = regmap_read(field->regmap,
2388 field->reg + (field->id_offset * id),
2393 reg_val &= field->mask;
2394 reg_val >>= field->shift;
2399 EXPORT_SYMBOL_GPL(regmap_fields_read);
2402 * regmap_bulk_read(): Read multiple registers from the device
2404 * @map: Register map to read from
2405 * @reg: First register to be read from
2406 * @val: Pointer to store read value, in native register size for device
2407 * @val_count: Number of registers to read
2409 * A value of zero will be returned on success, a negative errno will
2410 * be returned in error cases.
2412 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
2416 size_t val_bytes = map->format.val_bytes;
2417 bool vol = regmap_volatile_range(map, reg, val_count);
2419 if (reg % map->reg_stride)
2422 if (map->bus && map->format.parse_inplace && (vol || map->cache_type == REGCACHE_NONE)) {
2424 * Some devices does not support bulk read, for
2425 * them we have a series of single read operations.
2427 size_t total_size = val_bytes * val_count;
2429 if (!map->use_single_read &&
2430 (!map->max_raw_read || map->max_raw_read > total_size)) {
2431 ret = regmap_raw_read(map, reg, val,
2432 val_bytes * val_count);
2437 * Some devices do not support bulk read or do not
2438 * support large bulk reads, for them we have a series
2439 * of read operations.
2441 int chunk_stride = map->reg_stride;
2442 size_t chunk_size = val_bytes;
2443 size_t chunk_count = val_count;
2445 if (!map->use_single_read) {
2446 chunk_size = map->max_raw_read;
2447 if (chunk_size % val_bytes)
2448 chunk_size -= chunk_size % val_bytes;
2449 chunk_count = total_size / chunk_size;
2450 chunk_stride *= chunk_size / val_bytes;
2453 /* Read bytes that fit into a multiple of chunk_size */
2454 for (i = 0; i < chunk_count; i++) {
2455 ret = regmap_raw_read(map,
2456 reg + (i * chunk_stride),
2457 val + (i * chunk_size),
2463 /* Read remaining bytes */
2464 if (chunk_size * i < total_size) {
2465 ret = regmap_raw_read(map,
2466 reg + (i * chunk_stride),
2467 val + (i * chunk_size),
2468 total_size - i * chunk_size);
2474 for (i = 0; i < val_count * val_bytes; i += val_bytes)
2475 map->format.parse_inplace(val + i);
2477 for (i = 0; i < val_count; i++) {
2479 ret = regmap_read(map, reg + (i * map->reg_stride),
2484 if (map->format.format_val) {
2485 map->format.format_val(val + (i * val_bytes), ival, 0);
2487 /* Devices providing read and write
2488 * operations can use the bulk I/O
2489 * functions if they define a val_bytes,
2490 * we assume that the values are native
2497 switch (map->format.val_bytes) {
2516 EXPORT_SYMBOL_GPL(regmap_bulk_read);
2518 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
2519 unsigned int mask, unsigned int val,
2520 bool *change, bool force_write)
2523 unsigned int tmp, orig;
2528 if (regmap_volatile(map, reg) && map->reg_update_bits) {
2529 ret = map->reg_update_bits(map->bus_context, reg, mask, val);
2530 if (ret == 0 && change)
2533 ret = _regmap_read(map, reg, &orig);
2540 if (force_write || (tmp != orig)) {
2541 ret = _regmap_write(map, reg, tmp);
2542 if (ret == 0 && change)
2551 * regmap_update_bits: Perform a read/modify/write cycle on the register map
2553 * @map: Register map to update
2554 * @reg: Register to update
2555 * @mask: Bitmask to change
2556 * @val: New value for bitmask
2558 * Returns zero for success, a negative number on error.
2560 int regmap_update_bits(struct regmap *map, unsigned int reg,
2561 unsigned int mask, unsigned int val)
2565 map->lock(map->lock_arg);
2566 ret = _regmap_update_bits(map, reg, mask, val, NULL, false);
2567 map->unlock(map->lock_arg);
2571 EXPORT_SYMBOL_GPL(regmap_update_bits);
2574 * regmap_write_bits: Perform a read/modify/write cycle on the register map
2576 * @map: Register map to update
2577 * @reg: Register to update
2578 * @mask: Bitmask to change
2579 * @val: New value for bitmask
2581 * Returns zero for success, a negative number on error.
2583 int regmap_write_bits(struct regmap *map, unsigned int reg,
2584 unsigned int mask, unsigned int val)
2588 map->lock(map->lock_arg);
2589 ret = _regmap_update_bits(map, reg, mask, val, NULL, true);
2590 map->unlock(map->lock_arg);
2594 EXPORT_SYMBOL_GPL(regmap_write_bits);
2597 * regmap_update_bits_async: Perform a read/modify/write cycle on the register
2598 * map asynchronously
2600 * @map: Register map to update
2601 * @reg: Register to update
2602 * @mask: Bitmask to change
2603 * @val: New value for bitmask
2605 * With most buses the read must be done synchronously so this is most
2606 * useful for devices with a cache which do not need to interact with
2607 * the hardware to determine the current register value.
2609 * Returns zero for success, a negative number on error.
2611 int regmap_update_bits_async(struct regmap *map, unsigned int reg,
2612 unsigned int mask, unsigned int val)
2616 map->lock(map->lock_arg);
2620 ret = _regmap_update_bits(map, reg, mask, val, NULL, false);
2624 map->unlock(map->lock_arg);
2628 EXPORT_SYMBOL_GPL(regmap_update_bits_async);
2631 * regmap_update_bits_check: Perform a read/modify/write cycle on the
2632 * register map and report if updated
2634 * @map: Register map to update
2635 * @reg: Register to update
2636 * @mask: Bitmask to change
2637 * @val: New value for bitmask
2638 * @change: Boolean indicating if a write was done
2640 * Returns zero for success, a negative number on error.
2642 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
2643 unsigned int mask, unsigned int val,
2648 map->lock(map->lock_arg);
2649 ret = _regmap_update_bits(map, reg, mask, val, change, false);
2650 map->unlock(map->lock_arg);
2653 EXPORT_SYMBOL_GPL(regmap_update_bits_check);
2656 * regmap_update_bits_check_async: Perform a read/modify/write cycle on the
2657 * register map asynchronously and report if
2660 * @map: Register map to update
2661 * @reg: Register to update
2662 * @mask: Bitmask to change
2663 * @val: New value for bitmask
2664 * @change: Boolean indicating if a write was done
2666 * With most buses the read must be done synchronously so this is most
2667 * useful for devices with a cache which do not need to interact with
2668 * the hardware to determine the current register value.
2670 * Returns zero for success, a negative number on error.
2672 int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
2673 unsigned int mask, unsigned int val,
2678 map->lock(map->lock_arg);
2682 ret = _regmap_update_bits(map, reg, mask, val, change, false);
2686 map->unlock(map->lock_arg);
2690 EXPORT_SYMBOL_GPL(regmap_update_bits_check_async);
2692 void regmap_async_complete_cb(struct regmap_async *async, int ret)
2694 struct regmap *map = async->map;
2697 trace_regmap_async_io_complete(map);
2699 spin_lock(&map->async_lock);
2700 list_move(&async->list, &map->async_free);
2701 wake = list_empty(&map->async_list);
2704 map->async_ret = ret;
2706 spin_unlock(&map->async_lock);
2709 wake_up(&map->async_waitq);
2711 EXPORT_SYMBOL_GPL(regmap_async_complete_cb);
2713 static int regmap_async_is_done(struct regmap *map)
2715 unsigned long flags;
2718 spin_lock_irqsave(&map->async_lock, flags);
2719 ret = list_empty(&map->async_list);
2720 spin_unlock_irqrestore(&map->async_lock, flags);
2726 * regmap_async_complete: Ensure all asynchronous I/O has completed.
2728 * @map: Map to operate on.
2730 * Blocks until any pending asynchronous I/O has completed. Returns
2731 * an error code for any failed I/O operations.
2733 int regmap_async_complete(struct regmap *map)
2735 unsigned long flags;
2738 /* Nothing to do with no async support */
2739 if (!map->bus || !map->bus->async_write)
2742 trace_regmap_async_complete_start(map);
2744 wait_event(map->async_waitq, regmap_async_is_done(map));
2746 spin_lock_irqsave(&map->async_lock, flags);
2747 ret = map->async_ret;
2749 spin_unlock_irqrestore(&map->async_lock, flags);
2751 trace_regmap_async_complete_done(map);
2755 EXPORT_SYMBOL_GPL(regmap_async_complete);
2758 * regmap_register_patch: Register and apply register updates to be applied
2759 * on device initialistion
2761 * @map: Register map to apply updates to.
2762 * @regs: Values to update.
2763 * @num_regs: Number of entries in regs.
2765 * Register a set of register updates to be applied to the device
2766 * whenever the device registers are synchronised with the cache and
2767 * apply them immediately. Typically this is used to apply
2768 * corrections to be applied to the device defaults on startup, such
2769 * as the updates some vendors provide to undocumented registers.
2771 * The caller must ensure that this function cannot be called
2772 * concurrently with either itself or regcache_sync().
2774 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
2777 struct reg_sequence *p;
2781 if (WARN_ONCE(num_regs <= 0, "invalid registers number (%d)\n",
2785 p = krealloc(map->patch,
2786 sizeof(struct reg_sequence) * (map->patch_regs + num_regs),
2789 memcpy(p + map->patch_regs, regs, num_regs * sizeof(*regs));
2791 map->patch_regs += num_regs;
2796 map->lock(map->lock_arg);
2798 bypass = map->cache_bypass;
2800 map->cache_bypass = true;
2803 ret = _regmap_multi_reg_write(map, regs, num_regs);
2806 map->cache_bypass = bypass;
2808 map->unlock(map->lock_arg);
2810 regmap_async_complete(map);
2814 EXPORT_SYMBOL_GPL(regmap_register_patch);
2817 * regmap_get_val_bytes(): Report the size of a register value
2819 * Report the size of a register value, mainly intended to for use by
2820 * generic infrastructure built on top of regmap.
2822 int regmap_get_val_bytes(struct regmap *map)
2824 if (map->format.format_write)
2827 return map->format.val_bytes;
2829 EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
2832 * regmap_get_max_register(): Report the max register value
2834 * Report the max register value, mainly intended to for use by
2835 * generic infrastructure built on top of regmap.
2837 int regmap_get_max_register(struct regmap *map)
2839 return map->max_register ? map->max_register : -EINVAL;
2841 EXPORT_SYMBOL_GPL(regmap_get_max_register);
2844 * regmap_get_reg_stride(): Report the register address stride
2846 * Report the register address stride, mainly intended to for use by
2847 * generic infrastructure built on top of regmap.
2849 int regmap_get_reg_stride(struct regmap *map)
2851 return map->reg_stride;
2853 EXPORT_SYMBOL_GPL(regmap_get_reg_stride);
2855 int regmap_parse_val(struct regmap *map, const void *buf,
2858 if (!map->format.parse_val)
2861 *val = map->format.parse_val(buf);
2865 EXPORT_SYMBOL_GPL(regmap_parse_val);
2867 static int __init regmap_initcall(void)
2869 regmap_debugfs_initcall();
2873 postcore_initcall(regmap_initcall);