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 bool regmap_reg_in_ranges(unsigned int reg,
46 const struct regmap_range *ranges,
49 const struct regmap_range *r;
52 for (i = 0, r = ranges; i < nranges; i++, r++)
53 if (regmap_reg_in_range(reg, r))
57 EXPORT_SYMBOL_GPL(regmap_reg_in_ranges);
59 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
60 const struct regmap_access_table *table)
62 /* Check "no ranges" first */
63 if (regmap_reg_in_ranges(reg, table->no_ranges, table->n_no_ranges))
66 /* In case zero "yes ranges" are supplied, any reg is OK */
67 if (!table->n_yes_ranges)
70 return regmap_reg_in_ranges(reg, table->yes_ranges,
73 EXPORT_SYMBOL_GPL(regmap_check_range_table);
75 bool regmap_writeable(struct regmap *map, unsigned int reg)
77 if (map->max_register && reg > map->max_register)
80 if (map->writeable_reg)
81 return map->writeable_reg(map->dev, reg);
84 return regmap_check_range_table(map, reg, map->wr_table);
89 bool regmap_readable(struct regmap *map, unsigned int reg)
91 if (map->max_register && reg > map->max_register)
94 if (map->format.format_write)
97 if (map->readable_reg)
98 return map->readable_reg(map->dev, reg);
101 return regmap_check_range_table(map, reg, map->rd_table);
106 bool regmap_volatile(struct regmap *map, unsigned int reg)
108 if (!regmap_readable(map, reg))
111 if (map->volatile_reg)
112 return map->volatile_reg(map->dev, reg);
114 if (map->volatile_table)
115 return regmap_check_range_table(map, reg, map->volatile_table);
123 bool regmap_precious(struct regmap *map, unsigned int reg)
125 if (!regmap_readable(map, reg))
128 if (map->precious_reg)
129 return map->precious_reg(map->dev, reg);
131 if (map->precious_table)
132 return regmap_check_range_table(map, reg, map->precious_table);
137 static bool regmap_volatile_range(struct regmap *map, unsigned int reg,
142 for (i = 0; i < num; i++)
143 if (!regmap_volatile(map, reg + i))
149 static void regmap_format_2_6_write(struct regmap *map,
150 unsigned int reg, unsigned int val)
152 u8 *out = map->work_buf;
154 *out = (reg << 6) | val;
157 static void regmap_format_4_12_write(struct regmap *map,
158 unsigned int reg, unsigned int val)
160 __be16 *out = map->work_buf;
161 *out = cpu_to_be16((reg << 12) | val);
164 static void regmap_format_7_9_write(struct regmap *map,
165 unsigned int reg, unsigned int val)
167 __be16 *out = map->work_buf;
168 *out = cpu_to_be16((reg << 9) | val);
171 static void regmap_format_10_14_write(struct regmap *map,
172 unsigned int reg, unsigned int val)
174 u8 *out = map->work_buf;
177 out[1] = (val >> 8) | (reg << 6);
181 static void regmap_format_8(void *buf, unsigned int val, unsigned int shift)
188 static void regmap_format_16_be(void *buf, unsigned int val, unsigned int shift)
192 b[0] = cpu_to_be16(val << shift);
195 static void regmap_format_16_native(void *buf, unsigned int val,
198 *(u16 *)buf = val << shift;
201 static void regmap_format_24(void *buf, unsigned int val, unsigned int shift)
212 static void regmap_format_32_be(void *buf, unsigned int val, unsigned int shift)
216 b[0] = cpu_to_be32(val << shift);
219 static void regmap_format_32_native(void *buf, unsigned int val,
222 *(u32 *)buf = val << shift;
225 static void regmap_parse_inplace_noop(void *buf)
229 static unsigned int regmap_parse_8(const void *buf)
236 static unsigned int regmap_parse_16_be(const void *buf)
238 const __be16 *b = buf;
240 return be16_to_cpu(b[0]);
243 static void regmap_parse_16_be_inplace(void *buf)
247 b[0] = be16_to_cpu(b[0]);
250 static unsigned int regmap_parse_16_native(const void *buf)
255 static unsigned int regmap_parse_24(const void *buf)
258 unsigned int ret = b[2];
259 ret |= ((unsigned int)b[1]) << 8;
260 ret |= ((unsigned int)b[0]) << 16;
265 static unsigned int regmap_parse_32_be(const void *buf)
267 const __be32 *b = buf;
269 return be32_to_cpu(b[0]);
272 static void regmap_parse_32_be_inplace(void *buf)
276 b[0] = be32_to_cpu(b[0]);
279 static unsigned int regmap_parse_32_native(const void *buf)
284 static void regmap_lock_mutex(void *__map)
286 struct regmap *map = __map;
287 mutex_lock(&map->mutex);
290 static void regmap_unlock_mutex(void *__map)
292 struct regmap *map = __map;
293 mutex_unlock(&map->mutex);
296 static void regmap_lock_spinlock(void *__map)
297 __acquires(&map->spinlock)
299 struct regmap *map = __map;
302 spin_lock_irqsave(&map->spinlock, flags);
303 map->spinlock_flags = flags;
306 static void regmap_unlock_spinlock(void *__map)
307 __releases(&map->spinlock)
309 struct regmap *map = __map;
310 spin_unlock_irqrestore(&map->spinlock, map->spinlock_flags);
313 static void dev_get_regmap_release(struct device *dev, void *res)
316 * We don't actually have anything to do here; the goal here
317 * is not to manage the regmap but to provide a simple way to
318 * get the regmap back given a struct device.
322 static bool _regmap_range_add(struct regmap *map,
323 struct regmap_range_node *data)
325 struct rb_root *root = &map->range_tree;
326 struct rb_node **new = &(root->rb_node), *parent = NULL;
329 struct regmap_range_node *this =
330 container_of(*new, struct regmap_range_node, node);
333 if (data->range_max < this->range_min)
334 new = &((*new)->rb_left);
335 else if (data->range_min > this->range_max)
336 new = &((*new)->rb_right);
341 rb_link_node(&data->node, parent, new);
342 rb_insert_color(&data->node, root);
347 static struct regmap_range_node *_regmap_range_lookup(struct regmap *map,
350 struct rb_node *node = map->range_tree.rb_node;
353 struct regmap_range_node *this =
354 container_of(node, struct regmap_range_node, node);
356 if (reg < this->range_min)
357 node = node->rb_left;
358 else if (reg > this->range_max)
359 node = node->rb_right;
367 static void regmap_range_exit(struct regmap *map)
369 struct rb_node *next;
370 struct regmap_range_node *range_node;
372 next = rb_first(&map->range_tree);
374 range_node = rb_entry(next, struct regmap_range_node, node);
375 next = rb_next(&range_node->node);
376 rb_erase(&range_node->node, &map->range_tree);
380 kfree(map->selector_work_buf);
384 * regmap_init(): Initialise register map
386 * @dev: Device that will be interacted with
387 * @bus: Bus-specific callbacks to use with device
388 * @bus_context: Data passed to bus-specific callbacks
389 * @config: Configuration for register map
391 * The return value will be an ERR_PTR() on error or a valid pointer to
392 * a struct regmap. This function should generally not be called
393 * directly, it should be called by bus-specific init functions.
395 struct regmap *regmap_init(struct device *dev,
396 const struct regmap_bus *bus,
398 const struct regmap_config *config)
400 struct regmap *map, **m;
402 enum regmap_endian reg_endian, val_endian;
408 map = kzalloc(sizeof(*map), GFP_KERNEL);
414 if (config->lock && config->unlock) {
415 map->lock = config->lock;
416 map->unlock = config->unlock;
417 map->lock_arg = config->lock_arg;
419 if ((bus && bus->fast_io) ||
421 spin_lock_init(&map->spinlock);
422 map->lock = regmap_lock_spinlock;
423 map->unlock = regmap_unlock_spinlock;
425 mutex_init(&map->mutex);
426 map->lock = regmap_lock_mutex;
427 map->unlock = regmap_unlock_mutex;
431 map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
432 map->format.pad_bytes = config->pad_bits / 8;
433 map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
434 map->format.buf_size = DIV_ROUND_UP(config->reg_bits +
435 config->val_bits + config->pad_bits, 8);
436 map->reg_shift = config->pad_bits % 8;
437 if (config->reg_stride)
438 map->reg_stride = config->reg_stride;
441 map->use_single_rw = config->use_single_rw;
444 map->bus_context = bus_context;
445 map->max_register = config->max_register;
446 map->wr_table = config->wr_table;
447 map->rd_table = config->rd_table;
448 map->volatile_table = config->volatile_table;
449 map->precious_table = config->precious_table;
450 map->writeable_reg = config->writeable_reg;
451 map->readable_reg = config->readable_reg;
452 map->volatile_reg = config->volatile_reg;
453 map->precious_reg = config->precious_reg;
454 map->cache_type = config->cache_type;
455 map->name = config->name;
457 spin_lock_init(&map->async_lock);
458 INIT_LIST_HEAD(&map->async_list);
459 INIT_LIST_HEAD(&map->async_free);
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 /* Allow data window inside its own virtual range */
688 if (range_cfg->range_min <= sel_reg &&
689 sel_reg <= range_cfg->range_max) {
691 "Range %d: selector for %d in window\n",
696 if (!(win_max < range_cfg->range_min ||
697 win_min > range_cfg->range_max)) {
699 "Range %d: window for %d in window\n",
705 new = kzalloc(sizeof(*new), GFP_KERNEL);
712 new->name = range_cfg->name;
713 new->range_min = range_cfg->range_min;
714 new->range_max = range_cfg->range_max;
715 new->selector_reg = range_cfg->selector_reg;
716 new->selector_mask = range_cfg->selector_mask;
717 new->selector_shift = range_cfg->selector_shift;
718 new->window_start = range_cfg->window_start;
719 new->window_len = range_cfg->window_len;
721 if (_regmap_range_add(map, new) == false) {
722 dev_err(map->dev, "Failed to add range %d\n", i);
727 if (map->selector_work_buf == NULL) {
728 map->selector_work_buf =
729 kzalloc(map->format.buf_size, GFP_KERNEL);
730 if (map->selector_work_buf == NULL) {
737 regmap_debugfs_init(map, config->name);
739 ret = regcache_init(map, config);
743 /* Add a devres resource for dev_get_regmap() */
744 m = devres_alloc(dev_get_regmap_release, sizeof(*m), GFP_KERNEL);
755 regmap_debugfs_exit(map);
758 regmap_range_exit(map);
759 kfree(map->work_buf);
765 EXPORT_SYMBOL_GPL(regmap_init);
767 static void devm_regmap_release(struct device *dev, void *res)
769 regmap_exit(*(struct regmap **)res);
773 * devm_regmap_init(): Initialise managed register map
775 * @dev: Device that will be interacted with
776 * @bus: Bus-specific callbacks to use with device
777 * @bus_context: Data passed to bus-specific callbacks
778 * @config: Configuration for register map
780 * The return value will be an ERR_PTR() on error or a valid pointer
781 * to a struct regmap. This function should generally not be called
782 * directly, it should be called by bus-specific init functions. The
783 * map will be automatically freed by the device management code.
785 struct regmap *devm_regmap_init(struct device *dev,
786 const struct regmap_bus *bus,
788 const struct regmap_config *config)
790 struct regmap **ptr, *regmap;
792 ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
794 return ERR_PTR(-ENOMEM);
796 regmap = regmap_init(dev, bus, bus_context, config);
797 if (!IS_ERR(regmap)) {
799 devres_add(dev, ptr);
806 EXPORT_SYMBOL_GPL(devm_regmap_init);
808 static void regmap_field_init(struct regmap_field *rm_field,
809 struct regmap *regmap, struct reg_field reg_field)
811 int field_bits = reg_field.msb - reg_field.lsb + 1;
812 rm_field->regmap = regmap;
813 rm_field->reg = reg_field.reg;
814 rm_field->shift = reg_field.lsb;
815 rm_field->mask = ((BIT(field_bits) - 1) << reg_field.lsb);
819 * devm_regmap_field_alloc(): Allocate and initialise a register field
822 * @dev: Device that will be interacted with
823 * @regmap: regmap bank in which this register field is located.
824 * @reg_field: Register field with in the bank.
826 * The return value will be an ERR_PTR() on error or a valid pointer
827 * to a struct regmap_field. The regmap_field will be automatically freed
828 * by the device management code.
830 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
831 struct regmap *regmap, struct reg_field reg_field)
833 struct regmap_field *rm_field = devm_kzalloc(dev,
834 sizeof(*rm_field), GFP_KERNEL);
836 return ERR_PTR(-ENOMEM);
838 regmap_field_init(rm_field, regmap, reg_field);
843 EXPORT_SYMBOL_GPL(devm_regmap_field_alloc);
846 * devm_regmap_field_free(): Free register field allocated using
847 * devm_regmap_field_alloc. Usally drivers need not call this function,
848 * as the memory allocated via devm will be freed as per device-driver
851 * @dev: Device that will be interacted with
852 * @field: regmap field which should be freed.
854 void devm_regmap_field_free(struct device *dev,
855 struct regmap_field *field)
857 devm_kfree(dev, field);
859 EXPORT_SYMBOL_GPL(devm_regmap_field_free);
862 * regmap_field_alloc(): Allocate and initialise a register field
865 * @regmap: regmap bank in which this register field is located.
866 * @reg_field: Register field with in the bank.
868 * The return value will be an ERR_PTR() on error or a valid pointer
869 * to a struct regmap_field. The regmap_field should be freed by the
870 * user once its finished working with it using regmap_field_free().
872 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
873 struct reg_field reg_field)
875 struct regmap_field *rm_field = kzalloc(sizeof(*rm_field), GFP_KERNEL);
878 return ERR_PTR(-ENOMEM);
880 regmap_field_init(rm_field, regmap, reg_field);
884 EXPORT_SYMBOL_GPL(regmap_field_alloc);
887 * regmap_field_free(): Free register field allocated using regmap_field_alloc
889 * @field: regmap field which should be freed.
891 void regmap_field_free(struct regmap_field *field)
895 EXPORT_SYMBOL_GPL(regmap_field_free);
898 * regmap_reinit_cache(): Reinitialise the current register cache
900 * @map: Register map to operate on.
901 * @config: New configuration. Only the cache data will be used.
903 * Discard any existing register cache for the map and initialize a
904 * new cache. This can be used to restore the cache to defaults or to
905 * update the cache configuration to reflect runtime discovery of the
908 * No explicit locking is done here, the user needs to ensure that
909 * this function will not race with other calls to regmap.
911 int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
914 regmap_debugfs_exit(map);
916 map->max_register = config->max_register;
917 map->writeable_reg = config->writeable_reg;
918 map->readable_reg = config->readable_reg;
919 map->volatile_reg = config->volatile_reg;
920 map->precious_reg = config->precious_reg;
921 map->cache_type = config->cache_type;
923 regmap_debugfs_init(map, config->name);
925 map->cache_bypass = false;
926 map->cache_only = false;
928 return regcache_init(map, config);
930 EXPORT_SYMBOL_GPL(regmap_reinit_cache);
933 * regmap_exit(): Free a previously allocated register map
935 void regmap_exit(struct regmap *map)
937 struct regmap_async *async;
940 regmap_debugfs_exit(map);
941 regmap_range_exit(map);
942 if (map->bus && map->bus->free_context)
943 map->bus->free_context(map->bus_context);
944 kfree(map->work_buf);
945 while (!list_empty(&map->async_free)) {
946 async = list_first_entry_or_null(&map->async_free,
949 list_del(&async->list);
950 kfree(async->work_buf);
955 EXPORT_SYMBOL_GPL(regmap_exit);
957 static int dev_get_regmap_match(struct device *dev, void *res, void *data)
959 struct regmap **r = res;
965 /* If the user didn't specify a name match any */
967 return (*r)->name == data;
973 * dev_get_regmap(): Obtain the regmap (if any) for a device
975 * @dev: Device to retrieve the map for
976 * @name: Optional name for the register map, usually NULL.
978 * Returns the regmap for the device if one is present, or NULL. If
979 * name is specified then it must match the name specified when
980 * registering the device, if it is NULL then the first regmap found
981 * will be used. Devices with multiple register maps are very rare,
982 * generic code should normally not need to specify a name.
984 struct regmap *dev_get_regmap(struct device *dev, const char *name)
986 struct regmap **r = devres_find(dev, dev_get_regmap_release,
987 dev_get_regmap_match, (void *)name);
993 EXPORT_SYMBOL_GPL(dev_get_regmap);
995 static int _regmap_select_page(struct regmap *map, unsigned int *reg,
996 struct regmap_range_node *range,
997 unsigned int val_num)
1000 unsigned int win_offset;
1001 unsigned int win_page;
1005 win_offset = (*reg - range->range_min) % range->window_len;
1006 win_page = (*reg - range->range_min) / range->window_len;
1009 /* Bulk write shouldn't cross range boundary */
1010 if (*reg + val_num - 1 > range->range_max)
1013 /* ... or single page boundary */
1014 if (val_num > range->window_len - win_offset)
1018 /* It is possible to have selector register inside data window.
1019 In that case, selector register is located on every page and
1020 it needs no page switching, when accessed alone. */
1022 range->window_start + win_offset != range->selector_reg) {
1023 /* Use separate work_buf during page switching */
1024 orig_work_buf = map->work_buf;
1025 map->work_buf = map->selector_work_buf;
1027 ret = _regmap_update_bits(map, range->selector_reg,
1028 range->selector_mask,
1029 win_page << range->selector_shift,
1032 map->work_buf = orig_work_buf;
1038 *reg = range->window_start + win_offset;
1043 int _regmap_raw_write(struct regmap *map, unsigned int reg,
1044 const void *val, size_t val_len)
1046 struct regmap_range_node *range;
1047 unsigned long flags;
1048 u8 *u8 = map->work_buf;
1049 void *work_val = map->work_buf + map->format.reg_bytes +
1050 map->format.pad_bytes;
1052 int ret = -ENOTSUPP;
1058 /* Check for unwritable registers before we start */
1059 if (map->writeable_reg)
1060 for (i = 0; i < val_len / map->format.val_bytes; i++)
1061 if (!map->writeable_reg(map->dev,
1062 reg + (i * map->reg_stride)))
1065 if (!map->cache_bypass && map->format.parse_val) {
1067 int val_bytes = map->format.val_bytes;
1068 for (i = 0; i < val_len / val_bytes; i++) {
1069 ival = map->format.parse_val(val + (i * val_bytes));
1070 ret = regcache_write(map, reg + (i * map->reg_stride),
1074 "Error in caching of register: %x ret: %d\n",
1079 if (map->cache_only) {
1080 map->cache_dirty = true;
1085 range = _regmap_range_lookup(map, reg);
1087 int val_num = val_len / map->format.val_bytes;
1088 int win_offset = (reg - range->range_min) % range->window_len;
1089 int win_residue = range->window_len - win_offset;
1091 /* If the write goes beyond the end of the window split it */
1092 while (val_num > win_residue) {
1093 dev_dbg(map->dev, "Writing window %d/%zu\n",
1094 win_residue, val_len / map->format.val_bytes);
1095 ret = _regmap_raw_write(map, reg, val, win_residue *
1096 map->format.val_bytes);
1101 val_num -= win_residue;
1102 val += win_residue * map->format.val_bytes;
1103 val_len -= win_residue * map->format.val_bytes;
1105 win_offset = (reg - range->range_min) %
1107 win_residue = range->window_len - win_offset;
1110 ret = _regmap_select_page(map, ®, range, val_num);
1115 map->format.format_reg(map->work_buf, reg, map->reg_shift);
1117 u8[0] |= map->write_flag_mask;
1120 * Essentially all I/O mechanisms will be faster with a single
1121 * buffer to write. Since register syncs often generate raw
1122 * writes of single registers optimise that case.
1124 if (val != work_val && val_len == map->format.val_bytes) {
1125 memcpy(work_val, val, map->format.val_bytes);
1129 if (map->async && map->bus->async_write) {
1130 struct regmap_async *async;
1132 trace_regmap_async_write_start(map->dev, reg, val_len);
1134 spin_lock_irqsave(&map->async_lock, flags);
1135 async = list_first_entry_or_null(&map->async_free,
1136 struct regmap_async,
1139 list_del(&async->list);
1140 spin_unlock_irqrestore(&map->async_lock, flags);
1143 async = map->bus->async_alloc();
1147 async->work_buf = kzalloc(map->format.buf_size,
1148 GFP_KERNEL | GFP_DMA);
1149 if (!async->work_buf) {
1157 /* If the caller supplied the value we can use it safely. */
1158 memcpy(async->work_buf, map->work_buf, map->format.pad_bytes +
1159 map->format.reg_bytes + map->format.val_bytes);
1160 if (val == work_val)
1161 val = async->work_buf + map->format.pad_bytes +
1162 map->format.reg_bytes;
1164 spin_lock_irqsave(&map->async_lock, flags);
1165 list_add_tail(&async->list, &map->async_list);
1166 spin_unlock_irqrestore(&map->async_lock, flags);
1168 ret = map->bus->async_write(map->bus_context, async->work_buf,
1169 map->format.reg_bytes +
1170 map->format.pad_bytes,
1171 val, val_len, async);
1174 dev_err(map->dev, "Failed to schedule write: %d\n",
1177 spin_lock_irqsave(&map->async_lock, flags);
1178 list_move(&async->list, &map->async_free);
1179 spin_unlock_irqrestore(&map->async_lock, flags);
1185 trace_regmap_hw_write_start(map->dev, reg,
1186 val_len / map->format.val_bytes);
1188 /* If we're doing a single register write we can probably just
1189 * send the work_buf directly, otherwise try to do a gather
1192 if (val == work_val)
1193 ret = map->bus->write(map->bus_context, map->work_buf,
1194 map->format.reg_bytes +
1195 map->format.pad_bytes +
1197 else if (map->bus->gather_write)
1198 ret = map->bus->gather_write(map->bus_context, map->work_buf,
1199 map->format.reg_bytes +
1200 map->format.pad_bytes,
1203 /* If that didn't work fall back on linearising by hand. */
1204 if (ret == -ENOTSUPP) {
1205 len = map->format.reg_bytes + map->format.pad_bytes + val_len;
1206 buf = kzalloc(len, GFP_KERNEL);
1210 memcpy(buf, map->work_buf, map->format.reg_bytes);
1211 memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
1213 ret = map->bus->write(map->bus_context, buf, len);
1218 trace_regmap_hw_write_done(map->dev, reg,
1219 val_len / map->format.val_bytes);
1225 * regmap_can_raw_write - Test if regmap_raw_write() is supported
1227 * @map: Map to check.
1229 bool regmap_can_raw_write(struct regmap *map)
1231 return map->bus && map->format.format_val && map->format.format_reg;
1233 EXPORT_SYMBOL_GPL(regmap_can_raw_write);
1235 static int _regmap_bus_formatted_write(void *context, unsigned int reg,
1239 struct regmap_range_node *range;
1240 struct regmap *map = context;
1242 WARN_ON(!map->bus || !map->format.format_write);
1244 range = _regmap_range_lookup(map, reg);
1246 ret = _regmap_select_page(map, ®, range, 1);
1251 map->format.format_write(map, reg, val);
1253 trace_regmap_hw_write_start(map->dev, reg, 1);
1255 ret = map->bus->write(map->bus_context, map->work_buf,
1256 map->format.buf_size);
1258 trace_regmap_hw_write_done(map->dev, reg, 1);
1263 static int _regmap_bus_raw_write(void *context, unsigned int reg,
1266 struct regmap *map = context;
1268 WARN_ON(!map->bus || !map->format.format_val);
1270 map->format.format_val(map->work_buf + map->format.reg_bytes
1271 + map->format.pad_bytes, val, 0);
1272 return _regmap_raw_write(map, reg,
1274 map->format.reg_bytes +
1275 map->format.pad_bytes,
1276 map->format.val_bytes);
1279 static inline void *_regmap_map_get_context(struct regmap *map)
1281 return (map->bus) ? map : map->bus_context;
1284 int _regmap_write(struct regmap *map, unsigned int reg,
1288 void *context = _regmap_map_get_context(map);
1290 if (!regmap_writeable(map, reg))
1293 if (!map->cache_bypass && !map->defer_caching) {
1294 ret = regcache_write(map, reg, val);
1297 if (map->cache_only) {
1298 map->cache_dirty = true;
1304 if (strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
1305 dev_info(map->dev, "%x <= %x\n", reg, val);
1308 trace_regmap_reg_write(map->dev, reg, val);
1310 return map->reg_write(context, reg, val);
1314 * regmap_write(): Write a value to a single register
1316 * @map: Register map to write to
1317 * @reg: Register to write to
1318 * @val: Value to be written
1320 * A value of zero will be returned on success, a negative errno will
1321 * be returned in error cases.
1323 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
1327 if (reg % map->reg_stride)
1330 map->lock(map->lock_arg);
1332 ret = _regmap_write(map, reg, val);
1334 map->unlock(map->lock_arg);
1338 EXPORT_SYMBOL_GPL(regmap_write);
1341 * regmap_write_async(): Write a value to a single register asynchronously
1343 * @map: Register map to write to
1344 * @reg: Register to write to
1345 * @val: Value to be written
1347 * A value of zero will be returned on success, a negative errno will
1348 * be returned in error cases.
1350 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val)
1354 if (reg % map->reg_stride)
1357 map->lock(map->lock_arg);
1361 ret = _regmap_write(map, reg, val);
1365 map->unlock(map->lock_arg);
1369 EXPORT_SYMBOL_GPL(regmap_write_async);
1372 * regmap_raw_write(): Write raw values to one or more registers
1374 * @map: Register map to write to
1375 * @reg: Initial register to write to
1376 * @val: Block of data to be written, laid out for direct transmission to the
1378 * @val_len: Length of data pointed to by val.
1380 * This function is intended to be used for things like firmware
1381 * download where a large block of data needs to be transferred to the
1382 * device. No formatting will be done on the data provided.
1384 * A value of zero will be returned on success, a negative errno will
1385 * be returned in error cases.
1387 int regmap_raw_write(struct regmap *map, unsigned int reg,
1388 const void *val, size_t val_len)
1392 if (!regmap_can_raw_write(map))
1394 if (val_len % map->format.val_bytes)
1397 map->lock(map->lock_arg);
1399 ret = _regmap_raw_write(map, reg, val, val_len);
1401 map->unlock(map->lock_arg);
1405 EXPORT_SYMBOL_GPL(regmap_raw_write);
1408 * regmap_field_write(): Write a value to a single register field
1410 * @field: Register field to write to
1411 * @val: Value to be written
1413 * A value of zero will be returned on success, a negative errno will
1414 * be returned in error cases.
1416 int regmap_field_write(struct regmap_field *field, unsigned int val)
1418 return regmap_update_bits(field->regmap, field->reg,
1419 field->mask, val << field->shift);
1421 EXPORT_SYMBOL_GPL(regmap_field_write);
1424 * regmap_bulk_write(): Write multiple registers to the device
1426 * @map: Register map to write to
1427 * @reg: First register to be write from
1428 * @val: Block of data to be written, in native register size for device
1429 * @val_count: Number of registers to write
1431 * This function is intended to be used for writing a large block of
1432 * data to the device either in single transfer or multiple transfer.
1434 * A value of zero will be returned on success, a negative errno will
1435 * be returned in error cases.
1437 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1441 size_t val_bytes = map->format.val_bytes;
1446 if (!map->format.parse_inplace)
1448 if (reg % map->reg_stride)
1451 map->lock(map->lock_arg);
1453 /* No formatting is require if val_byte is 1 */
1454 if (val_bytes == 1) {
1457 wval = kmemdup(val, val_count * val_bytes, GFP_KERNEL);
1460 dev_err(map->dev, "Error in memory allocation\n");
1463 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1464 map->format.parse_inplace(wval + i);
1467 * Some devices does not support bulk write, for
1468 * them we have a series of single write operations.
1470 if (map->use_single_rw) {
1471 for (i = 0; i < val_count; i++) {
1472 ret = regmap_raw_write(map,
1473 reg + (i * map->reg_stride),
1474 val + (i * val_bytes),
1480 ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count);
1487 map->unlock(map->lock_arg);
1490 EXPORT_SYMBOL_GPL(regmap_bulk_write);
1493 * regmap_raw_write_async(): Write raw values to one or more registers
1496 * @map: Register map to write to
1497 * @reg: Initial register to write to
1498 * @val: Block of data to be written, laid out for direct transmission to the
1499 * device. Must be valid until regmap_async_complete() is called.
1500 * @val_len: Length of data pointed to by val.
1502 * This function is intended to be used for things like firmware
1503 * download where a large block of data needs to be transferred to the
1504 * device. No formatting will be done on the data provided.
1506 * If supported by the underlying bus the write will be scheduled
1507 * asynchronously, helping maximise I/O speed on higher speed buses
1508 * like SPI. regmap_async_complete() can be called to ensure that all
1509 * asynchrnous writes have been completed.
1511 * A value of zero will be returned on success, a negative errno will
1512 * be returned in error cases.
1514 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1515 const void *val, size_t val_len)
1519 if (val_len % map->format.val_bytes)
1521 if (reg % map->reg_stride)
1524 map->lock(map->lock_arg);
1528 ret = _regmap_raw_write(map, reg, val, val_len);
1532 map->unlock(map->lock_arg);
1536 EXPORT_SYMBOL_GPL(regmap_raw_write_async);
1538 static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
1539 unsigned int val_len)
1541 struct regmap_range_node *range;
1542 u8 *u8 = map->work_buf;
1547 range = _regmap_range_lookup(map, reg);
1549 ret = _regmap_select_page(map, ®, range,
1550 val_len / map->format.val_bytes);
1555 map->format.format_reg(map->work_buf, reg, map->reg_shift);
1558 * Some buses or devices flag reads by setting the high bits in the
1559 * register addresss; since it's always the high bits for all
1560 * current formats we can do this here rather than in
1561 * formatting. This may break if we get interesting formats.
1563 u8[0] |= map->read_flag_mask;
1565 trace_regmap_hw_read_start(map->dev, reg,
1566 val_len / map->format.val_bytes);
1568 ret = map->bus->read(map->bus_context, map->work_buf,
1569 map->format.reg_bytes + map->format.pad_bytes,
1572 trace_regmap_hw_read_done(map->dev, reg,
1573 val_len / map->format.val_bytes);
1578 static int _regmap_bus_read(void *context, unsigned int reg,
1582 struct regmap *map = context;
1584 if (!map->format.parse_val)
1587 ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
1589 *val = map->format.parse_val(map->work_buf);
1594 static int _regmap_read(struct regmap *map, unsigned int reg,
1598 void *context = _regmap_map_get_context(map);
1600 WARN_ON(!map->reg_read);
1602 if (!map->cache_bypass) {
1603 ret = regcache_read(map, reg, val);
1608 if (map->cache_only)
1611 ret = map->reg_read(context, reg, val);
1614 if (strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
1615 dev_info(map->dev, "%x => %x\n", reg, *val);
1618 trace_regmap_reg_read(map->dev, reg, *val);
1620 if (!map->cache_bypass)
1621 regcache_write(map, reg, *val);
1628 * regmap_read(): Read a value from a single register
1630 * @map: Register map to write to
1631 * @reg: Register to be read from
1632 * @val: Pointer to store read value
1634 * A value of zero will be returned on success, a negative errno will
1635 * be returned in error cases.
1637 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
1641 if (reg % map->reg_stride)
1644 map->lock(map->lock_arg);
1646 ret = _regmap_read(map, reg, val);
1648 map->unlock(map->lock_arg);
1652 EXPORT_SYMBOL_GPL(regmap_read);
1655 * regmap_raw_read(): Read raw data from the device
1657 * @map: Register map to write to
1658 * @reg: First register to be read from
1659 * @val: Pointer to store read value
1660 * @val_len: Size of data to read
1662 * A value of zero will be returned on success, a negative errno will
1663 * be returned in error cases.
1665 int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
1668 size_t val_bytes = map->format.val_bytes;
1669 size_t val_count = val_len / val_bytes;
1675 if (val_len % map->format.val_bytes)
1677 if (reg % map->reg_stride)
1680 map->lock(map->lock_arg);
1682 if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
1683 map->cache_type == REGCACHE_NONE) {
1684 /* Physical block read if there's no cache involved */
1685 ret = _regmap_raw_read(map, reg, val, val_len);
1688 /* Otherwise go word by word for the cache; should be low
1689 * cost as we expect to hit the cache.
1691 for (i = 0; i < val_count; i++) {
1692 ret = _regmap_read(map, reg + (i * map->reg_stride),
1697 map->format.format_val(val + (i * val_bytes), v, 0);
1702 map->unlock(map->lock_arg);
1706 EXPORT_SYMBOL_GPL(regmap_raw_read);
1709 * regmap_field_read(): Read a value to a single register field
1711 * @field: Register field to read from
1712 * @val: Pointer to store read value
1714 * A value of zero will be returned on success, a negative errno will
1715 * be returned in error cases.
1717 int regmap_field_read(struct regmap_field *field, unsigned int *val)
1720 unsigned int reg_val;
1721 ret = regmap_read(field->regmap, field->reg, ®_val);
1725 reg_val &= field->mask;
1726 reg_val >>= field->shift;
1731 EXPORT_SYMBOL_GPL(regmap_field_read);
1734 * regmap_bulk_read(): Read multiple registers from the device
1736 * @map: Register map to write to
1737 * @reg: First register to be read from
1738 * @val: Pointer to store read value, in native register size for device
1739 * @val_count: Number of registers to read
1741 * A value of zero will be returned on success, a negative errno will
1742 * be returned in error cases.
1744 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1748 size_t val_bytes = map->format.val_bytes;
1749 bool vol = regmap_volatile_range(map, reg, val_count);
1753 if (!map->format.parse_inplace)
1755 if (reg % map->reg_stride)
1758 if (vol || map->cache_type == REGCACHE_NONE) {
1760 * Some devices does not support bulk read, for
1761 * them we have a series of single read operations.
1763 if (map->use_single_rw) {
1764 for (i = 0; i < val_count; i++) {
1765 ret = regmap_raw_read(map,
1766 reg + (i * map->reg_stride),
1767 val + (i * val_bytes),
1773 ret = regmap_raw_read(map, reg, val,
1774 val_bytes * val_count);
1779 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1780 map->format.parse_inplace(val + i);
1782 for (i = 0; i < val_count; i++) {
1784 ret = regmap_read(map, reg + (i * map->reg_stride),
1788 memcpy(val + (i * val_bytes), &ival, val_bytes);
1794 EXPORT_SYMBOL_GPL(regmap_bulk_read);
1796 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
1797 unsigned int mask, unsigned int val,
1801 unsigned int tmp, orig;
1803 ret = _regmap_read(map, reg, &orig);
1811 ret = _regmap_write(map, reg, tmp);
1821 * regmap_update_bits: Perform a read/modify/write cycle on the register map
1823 * @map: Register map to update
1824 * @reg: Register to update
1825 * @mask: Bitmask to change
1826 * @val: New value for bitmask
1828 * Returns zero for success, a negative number on error.
1830 int regmap_update_bits(struct regmap *map, unsigned int reg,
1831 unsigned int mask, unsigned int val)
1836 map->lock(map->lock_arg);
1837 ret = _regmap_update_bits(map, reg, mask, val, &change);
1838 map->unlock(map->lock_arg);
1842 EXPORT_SYMBOL_GPL(regmap_update_bits);
1845 * regmap_update_bits_async: Perform a read/modify/write cycle on the register
1846 * map asynchronously
1848 * @map: Register map to update
1849 * @reg: Register to update
1850 * @mask: Bitmask to change
1851 * @val: New value for bitmask
1853 * With most buses the read must be done synchronously so this is most
1854 * useful for devices with a cache which do not need to interact with
1855 * the hardware to determine the current register value.
1857 * Returns zero for success, a negative number on error.
1859 int regmap_update_bits_async(struct regmap *map, unsigned int reg,
1860 unsigned int mask, unsigned int val)
1865 map->lock(map->lock_arg);
1869 ret = _regmap_update_bits(map, reg, mask, val, &change);
1873 map->unlock(map->lock_arg);
1877 EXPORT_SYMBOL_GPL(regmap_update_bits_async);
1880 * regmap_update_bits_check: Perform a read/modify/write cycle on the
1881 * register map and report if updated
1883 * @map: Register map to update
1884 * @reg: Register to update
1885 * @mask: Bitmask to change
1886 * @val: New value for bitmask
1887 * @change: Boolean indicating if a write was done
1889 * Returns zero for success, a negative number on error.
1891 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1892 unsigned int mask, unsigned int val,
1897 map->lock(map->lock_arg);
1898 ret = _regmap_update_bits(map, reg, mask, val, change);
1899 map->unlock(map->lock_arg);
1902 EXPORT_SYMBOL_GPL(regmap_update_bits_check);
1905 * regmap_update_bits_check_async: Perform a read/modify/write cycle on the
1906 * register map asynchronously and report if
1909 * @map: Register map to update
1910 * @reg: Register to update
1911 * @mask: Bitmask to change
1912 * @val: New value for bitmask
1913 * @change: Boolean indicating if a write was done
1915 * With most buses the read must be done synchronously so this is most
1916 * useful for devices with a cache which do not need to interact with
1917 * the hardware to determine the current register value.
1919 * Returns zero for success, a negative number on error.
1921 int regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1922 unsigned int mask, unsigned int val,
1927 map->lock(map->lock_arg);
1931 ret = _regmap_update_bits(map, reg, mask, val, change);
1935 map->unlock(map->lock_arg);
1939 EXPORT_SYMBOL_GPL(regmap_update_bits_check_async);
1941 void regmap_async_complete_cb(struct regmap_async *async, int ret)
1943 struct regmap *map = async->map;
1946 trace_regmap_async_io_complete(map->dev);
1948 spin_lock(&map->async_lock);
1949 list_move(&async->list, &map->async_free);
1950 wake = list_empty(&map->async_list);
1953 map->async_ret = ret;
1955 spin_unlock(&map->async_lock);
1958 wake_up(&map->async_waitq);
1960 EXPORT_SYMBOL_GPL(regmap_async_complete_cb);
1962 static int regmap_async_is_done(struct regmap *map)
1964 unsigned long flags;
1967 spin_lock_irqsave(&map->async_lock, flags);
1968 ret = list_empty(&map->async_list);
1969 spin_unlock_irqrestore(&map->async_lock, flags);
1975 * regmap_async_complete: Ensure all asynchronous I/O has completed.
1977 * @map: Map to operate on.
1979 * Blocks until any pending asynchronous I/O has completed. Returns
1980 * an error code for any failed I/O operations.
1982 int regmap_async_complete(struct regmap *map)
1984 unsigned long flags;
1987 /* Nothing to do with no async support */
1988 if (!map->bus || !map->bus->async_write)
1991 trace_regmap_async_complete_start(map->dev);
1993 wait_event(map->async_waitq, regmap_async_is_done(map));
1995 spin_lock_irqsave(&map->async_lock, flags);
1996 ret = map->async_ret;
1998 spin_unlock_irqrestore(&map->async_lock, flags);
2000 trace_regmap_async_complete_done(map->dev);
2004 EXPORT_SYMBOL_GPL(regmap_async_complete);
2007 * regmap_register_patch: Register and apply register updates to be applied
2008 * on device initialistion
2010 * @map: Register map to apply updates to.
2011 * @regs: Values to update.
2012 * @num_regs: Number of entries in regs.
2014 * Register a set of register updates to be applied to the device
2015 * whenever the device registers are synchronised with the cache and
2016 * apply them immediately. Typically this is used to apply
2017 * corrections to be applied to the device defaults on startup, such
2018 * as the updates some vendors provide to undocumented registers.
2020 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
2023 struct reg_default *p;
2027 map->lock(map->lock_arg);
2029 bypass = map->cache_bypass;
2031 map->cache_bypass = true;
2033 /* Write out first; it's useful to apply even if we fail later. */
2034 for (i = 0; i < num_regs; i++) {
2035 ret = _regmap_write(map, regs[i].reg, regs[i].def);
2037 dev_err(map->dev, "Failed to write %x = %x: %d\n",
2038 regs[i].reg, regs[i].def, ret);
2043 p = krealloc(map->patch,
2044 sizeof(struct reg_default) * (map->patch_regs + num_regs),
2047 memcpy(p + map->patch_regs, regs, num_regs * sizeof(*regs));
2049 map->patch_regs += num_regs;
2055 map->cache_bypass = bypass;
2057 map->unlock(map->lock_arg);
2061 EXPORT_SYMBOL_GPL(regmap_register_patch);
2064 * regmap_get_val_bytes(): Report the size of a register value
2066 * Report the size of a register value, mainly intended to for use by
2067 * generic infrastructure built on top of regmap.
2069 int regmap_get_val_bytes(struct regmap *map)
2071 if (map->format.format_write)
2074 return map->format.val_bytes;
2076 EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
2078 static int __init regmap_initcall(void)
2080 regmap_debugfs_initcall();
2084 postcore_initcall(regmap_initcall);