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>
20 #define CREATE_TRACE_POINTS
21 #include <trace/events/regmap.h>
26 * Sometimes for failures during very early init the trace
27 * infrastructure isn't available early enough to be used. For this
28 * sort of problem defining LOG_DEVICE will add printks for basic
29 * register I/O on a specific device.
33 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
34 unsigned int mask, unsigned int val,
37 bool regmap_writeable(struct regmap *map, unsigned int reg)
39 if (map->max_register && reg > map->max_register)
42 if (map->writeable_reg)
43 return map->writeable_reg(map->dev, reg);
48 bool regmap_readable(struct regmap *map, unsigned int reg)
50 if (map->max_register && reg > map->max_register)
53 if (map->format.format_write)
56 if (map->readable_reg)
57 return map->readable_reg(map->dev, reg);
62 bool regmap_volatile(struct regmap *map, unsigned int reg)
64 if (!regmap_readable(map, reg))
67 if (map->volatile_reg)
68 return map->volatile_reg(map->dev, reg);
73 bool regmap_precious(struct regmap *map, unsigned int reg)
75 if (!regmap_readable(map, reg))
78 if (map->precious_reg)
79 return map->precious_reg(map->dev, reg);
84 static bool regmap_volatile_range(struct regmap *map, unsigned int reg,
89 for (i = 0; i < num; i++)
90 if (!regmap_volatile(map, reg + i))
96 static void regmap_format_2_6_write(struct regmap *map,
97 unsigned int reg, unsigned int val)
99 u8 *out = map->work_buf;
101 *out = (reg << 6) | val;
104 static void regmap_format_4_12_write(struct regmap *map,
105 unsigned int reg, unsigned int val)
107 __be16 *out = map->work_buf;
108 *out = cpu_to_be16((reg << 12) | val);
111 static void regmap_format_7_9_write(struct regmap *map,
112 unsigned int reg, unsigned int val)
114 __be16 *out = map->work_buf;
115 *out = cpu_to_be16((reg << 9) | val);
118 static void regmap_format_10_14_write(struct regmap *map,
119 unsigned int reg, unsigned int val)
121 u8 *out = map->work_buf;
124 out[1] = (val >> 8) | (reg << 6);
128 static void regmap_format_8(void *buf, unsigned int val, unsigned int shift)
135 static void regmap_format_16_be(void *buf, unsigned int val, unsigned int shift)
139 b[0] = cpu_to_be16(val << shift);
142 static void regmap_format_16_native(void *buf, unsigned int val,
145 *(u16 *)buf = val << shift;
148 static void regmap_format_24(void *buf, unsigned int val, unsigned int shift)
159 static void regmap_format_32_be(void *buf, unsigned int val, unsigned int shift)
163 b[0] = cpu_to_be32(val << shift);
166 static void regmap_format_32_native(void *buf, unsigned int val,
169 *(u32 *)buf = val << shift;
172 static unsigned int regmap_parse_8(void *buf)
179 static unsigned int regmap_parse_16_be(void *buf)
183 b[0] = be16_to_cpu(b[0]);
188 static unsigned int regmap_parse_16_native(void *buf)
193 static unsigned int regmap_parse_24(void *buf)
196 unsigned int ret = b[2];
197 ret |= ((unsigned int)b[1]) << 8;
198 ret |= ((unsigned int)b[0]) << 16;
203 static unsigned int regmap_parse_32_be(void *buf)
207 b[0] = be32_to_cpu(b[0]);
212 static unsigned int regmap_parse_32_native(void *buf)
217 static void regmap_lock_mutex(struct regmap *map)
219 mutex_lock(&map->mutex);
222 static void regmap_unlock_mutex(struct regmap *map)
224 mutex_unlock(&map->mutex);
227 static void regmap_lock_spinlock(struct regmap *map)
229 spin_lock(&map->spinlock);
232 static void regmap_unlock_spinlock(struct regmap *map)
234 spin_unlock(&map->spinlock);
237 static void dev_get_regmap_release(struct device *dev, void *res)
240 * We don't actually have anything to do here; the goal here
241 * is not to manage the regmap but to provide a simple way to
242 * get the regmap back given a struct device.
246 static bool _regmap_range_add(struct regmap *map,
247 struct regmap_range_node *data)
249 struct rb_root *root = &map->range_tree;
250 struct rb_node **new = &(root->rb_node), *parent = NULL;
253 struct regmap_range_node *this =
254 container_of(*new, struct regmap_range_node, node);
257 if (data->range_max < this->range_min)
258 new = &((*new)->rb_left);
259 else if (data->range_min > this->range_max)
260 new = &((*new)->rb_right);
265 rb_link_node(&data->node, parent, new);
266 rb_insert_color(&data->node, root);
271 static struct regmap_range_node *_regmap_range_lookup(struct regmap *map,
274 struct rb_node *node = map->range_tree.rb_node;
277 struct regmap_range_node *this =
278 container_of(node, struct regmap_range_node, node);
280 if (reg < this->range_min)
281 node = node->rb_left;
282 else if (reg > this->range_max)
283 node = node->rb_right;
291 static void regmap_range_exit(struct regmap *map)
293 struct rb_node *next;
294 struct regmap_range_node *range_node;
296 next = rb_first(&map->range_tree);
298 range_node = rb_entry(next, struct regmap_range_node, node);
299 next = rb_next(&range_node->node);
300 rb_erase(&range_node->node, &map->range_tree);
304 kfree(map->selector_work_buf);
308 * regmap_init(): Initialise register map
310 * @dev: Device that will be interacted with
311 * @bus: Bus-specific callbacks to use with device
312 * @bus_context: Data passed to bus-specific callbacks
313 * @config: Configuration for register map
315 * The return value will be an ERR_PTR() on error or a valid pointer to
316 * a struct regmap. This function should generally not be called
317 * directly, it should be called by bus-specific init functions.
319 struct regmap *regmap_init(struct device *dev,
320 const struct regmap_bus *bus,
322 const struct regmap_config *config)
324 struct regmap *map, **m;
326 enum regmap_endian reg_endian, val_endian;
332 map = kzalloc(sizeof(*map), GFP_KERNEL);
339 spin_lock_init(&map->spinlock);
340 map->lock = regmap_lock_spinlock;
341 map->unlock = regmap_unlock_spinlock;
343 mutex_init(&map->mutex);
344 map->lock = regmap_lock_mutex;
345 map->unlock = regmap_unlock_mutex;
347 map->format.reg_bytes = DIV_ROUND_UP(config->reg_bits, 8);
348 map->format.pad_bytes = config->pad_bits / 8;
349 map->format.val_bytes = DIV_ROUND_UP(config->val_bits, 8);
350 map->format.buf_size = DIV_ROUND_UP(config->reg_bits +
351 config->val_bits + config->pad_bits, 8);
352 map->reg_shift = config->pad_bits % 8;
353 if (config->reg_stride)
354 map->reg_stride = config->reg_stride;
357 map->use_single_rw = config->use_single_rw;
360 map->bus_context = bus_context;
361 map->max_register = config->max_register;
362 map->writeable_reg = config->writeable_reg;
363 map->readable_reg = config->readable_reg;
364 map->volatile_reg = config->volatile_reg;
365 map->precious_reg = config->precious_reg;
366 map->cache_type = config->cache_type;
367 map->name = config->name;
369 if (config->read_flag_mask || config->write_flag_mask) {
370 map->read_flag_mask = config->read_flag_mask;
371 map->write_flag_mask = config->write_flag_mask;
373 map->read_flag_mask = bus->read_flag_mask;
376 reg_endian = config->reg_format_endian;
377 if (reg_endian == REGMAP_ENDIAN_DEFAULT)
378 reg_endian = bus->reg_format_endian_default;
379 if (reg_endian == REGMAP_ENDIAN_DEFAULT)
380 reg_endian = REGMAP_ENDIAN_BIG;
382 val_endian = config->val_format_endian;
383 if (val_endian == REGMAP_ENDIAN_DEFAULT)
384 val_endian = bus->val_format_endian_default;
385 if (val_endian == REGMAP_ENDIAN_DEFAULT)
386 val_endian = REGMAP_ENDIAN_BIG;
388 switch (config->reg_bits + map->reg_shift) {
390 switch (config->val_bits) {
392 map->format.format_write = regmap_format_2_6_write;
400 switch (config->val_bits) {
402 map->format.format_write = regmap_format_4_12_write;
410 switch (config->val_bits) {
412 map->format.format_write = regmap_format_7_9_write;
420 switch (config->val_bits) {
422 map->format.format_write = regmap_format_10_14_write;
430 map->format.format_reg = regmap_format_8;
434 switch (reg_endian) {
435 case REGMAP_ENDIAN_BIG:
436 map->format.format_reg = regmap_format_16_be;
438 case REGMAP_ENDIAN_NATIVE:
439 map->format.format_reg = regmap_format_16_native;
447 switch (reg_endian) {
448 case REGMAP_ENDIAN_BIG:
449 map->format.format_reg = regmap_format_32_be;
451 case REGMAP_ENDIAN_NATIVE:
452 map->format.format_reg = regmap_format_32_native;
463 switch (config->val_bits) {
465 map->format.format_val = regmap_format_8;
466 map->format.parse_val = regmap_parse_8;
469 switch (val_endian) {
470 case REGMAP_ENDIAN_BIG:
471 map->format.format_val = regmap_format_16_be;
472 map->format.parse_val = regmap_parse_16_be;
474 case REGMAP_ENDIAN_NATIVE:
475 map->format.format_val = regmap_format_16_native;
476 map->format.parse_val = regmap_parse_16_native;
483 if (val_endian != REGMAP_ENDIAN_BIG)
485 map->format.format_val = regmap_format_24;
486 map->format.parse_val = regmap_parse_24;
489 switch (val_endian) {
490 case REGMAP_ENDIAN_BIG:
491 map->format.format_val = regmap_format_32_be;
492 map->format.parse_val = regmap_parse_32_be;
494 case REGMAP_ENDIAN_NATIVE:
495 map->format.format_val = regmap_format_32_native;
496 map->format.parse_val = regmap_parse_32_native;
504 if (map->format.format_write) {
505 if ((reg_endian != REGMAP_ENDIAN_BIG) ||
506 (val_endian != REGMAP_ENDIAN_BIG))
508 map->use_single_rw = true;
511 if (!map->format.format_write &&
512 !(map->format.format_reg && map->format.format_val))
515 map->work_buf = kzalloc(map->format.buf_size, GFP_KERNEL);
516 if (map->work_buf == NULL) {
521 map->range_tree = RB_ROOT;
522 for (i = 0; i < config->n_ranges; i++) {
523 const struct regmap_range_cfg *range_cfg = &config->ranges[i];
524 struct regmap_range_node *new;
527 if (range_cfg->range_max < range_cfg->range_min ||
528 range_cfg->range_max > map->max_register ||
529 range_cfg->selector_reg > map->max_register ||
530 range_cfg->window_len == 0)
533 /* Make sure, that this register range has no selector
534 or data window within its boundary */
535 for (j = 0; j < config->n_ranges; j++) {
536 unsigned sel_reg = config->ranges[j].selector_reg;
537 unsigned win_min = config->ranges[j].window_start;
538 unsigned win_max = win_min +
539 config->ranges[j].window_len - 1;
541 if (range_cfg->range_min <= sel_reg &&
542 sel_reg <= range_cfg->range_max) {
546 if (!(win_max < range_cfg->range_min ||
547 win_min > range_cfg->range_max)) {
552 new = kzalloc(sizeof(*new), GFP_KERNEL);
558 new->range_min = range_cfg->range_min;
559 new->range_max = range_cfg->range_max;
560 new->selector_reg = range_cfg->selector_reg;
561 new->selector_mask = range_cfg->selector_mask;
562 new->selector_shift = range_cfg->selector_shift;
563 new->window_start = range_cfg->window_start;
564 new->window_len = range_cfg->window_len;
566 if (_regmap_range_add(map, new) == false) {
571 if (map->selector_work_buf == NULL) {
572 map->selector_work_buf =
573 kzalloc(map->format.buf_size, GFP_KERNEL);
574 if (map->selector_work_buf == NULL) {
581 ret = regcache_init(map, config);
585 regmap_debugfs_init(map, config->name);
587 /* Add a devres resource for dev_get_regmap() */
588 m = devres_alloc(dev_get_regmap_release, sizeof(*m), GFP_KERNEL);
599 regmap_debugfs_exit(map);
602 regmap_range_exit(map);
603 kfree(map->work_buf);
609 EXPORT_SYMBOL_GPL(regmap_init);
611 static void devm_regmap_release(struct device *dev, void *res)
613 regmap_exit(*(struct regmap **)res);
617 * devm_regmap_init(): Initialise managed register map
619 * @dev: Device that will be interacted with
620 * @bus: Bus-specific callbacks to use with device
621 * @bus_context: Data passed to bus-specific callbacks
622 * @config: Configuration for register map
624 * The return value will be an ERR_PTR() on error or a valid pointer
625 * to a struct regmap. This function should generally not be called
626 * directly, it should be called by bus-specific init functions. The
627 * map will be automatically freed by the device management code.
629 struct regmap *devm_regmap_init(struct device *dev,
630 const struct regmap_bus *bus,
632 const struct regmap_config *config)
634 struct regmap **ptr, *regmap;
636 ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
638 return ERR_PTR(-ENOMEM);
640 regmap = regmap_init(dev, bus, bus_context, config);
641 if (!IS_ERR(regmap)) {
643 devres_add(dev, ptr);
650 EXPORT_SYMBOL_GPL(devm_regmap_init);
653 * regmap_reinit_cache(): Reinitialise the current register cache
655 * @map: Register map to operate on.
656 * @config: New configuration. Only the cache data will be used.
658 * Discard any existing register cache for the map and initialize a
659 * new cache. This can be used to restore the cache to defaults or to
660 * update the cache configuration to reflect runtime discovery of the
663 * No explicit locking is done here, the user needs to ensure that
664 * this function will not race with other calls to regmap.
666 int regmap_reinit_cache(struct regmap *map, const struct regmap_config *config)
669 regmap_debugfs_exit(map);
671 map->max_register = config->max_register;
672 map->writeable_reg = config->writeable_reg;
673 map->readable_reg = config->readable_reg;
674 map->volatile_reg = config->volatile_reg;
675 map->precious_reg = config->precious_reg;
676 map->cache_type = config->cache_type;
678 regmap_debugfs_init(map, config->name);
680 map->cache_bypass = false;
681 map->cache_only = false;
683 return regcache_init(map, config);
685 EXPORT_SYMBOL_GPL(regmap_reinit_cache);
688 * regmap_exit(): Free a previously allocated register map
690 void regmap_exit(struct regmap *map)
693 regmap_debugfs_exit(map);
694 regmap_range_exit(map);
695 if (map->bus->free_context)
696 map->bus->free_context(map->bus_context);
697 kfree(map->work_buf);
700 EXPORT_SYMBOL_GPL(regmap_exit);
702 static int dev_get_regmap_match(struct device *dev, void *res, void *data)
704 struct regmap **r = res;
710 /* If the user didn't specify a name match any */
712 return (*r)->name == data;
718 * dev_get_regmap(): Obtain the regmap (if any) for a device
720 * @dev: Device to retrieve the map for
721 * @name: Optional name for the register map, usually NULL.
723 * Returns the regmap for the device if one is present, or NULL. If
724 * name is specified then it must match the name specified when
725 * registering the device, if it is NULL then the first regmap found
726 * will be used. Devices with multiple register maps are very rare,
727 * generic code should normally not need to specify a name.
729 struct regmap *dev_get_regmap(struct device *dev, const char *name)
731 struct regmap **r = devres_find(dev, dev_get_regmap_release,
732 dev_get_regmap_match, (void *)name);
738 EXPORT_SYMBOL_GPL(dev_get_regmap);
740 static int _regmap_select_page(struct regmap *map, unsigned int *reg,
741 unsigned int val_num)
743 struct regmap_range_node *range;
745 unsigned int win_offset;
746 unsigned int win_page;
750 range = _regmap_range_lookup(map, *reg);
752 win_offset = (*reg - range->range_min) % range->window_len;
753 win_page = (*reg - range->range_min) / range->window_len;
756 /* Bulk write shouldn't cross range boundary */
757 if (*reg + val_num - 1 > range->range_max)
760 /* ... or single page boundary */
761 if (val_num > range->window_len - win_offset)
765 /* It is possible to have selector register inside data window.
766 In that case, selector register is located on every page and
767 it needs no page switching, when accessed alone. */
769 range->window_start + win_offset != range->selector_reg) {
770 /* Use separate work_buf during page switching */
771 orig_work_buf = map->work_buf;
772 map->work_buf = map->selector_work_buf;
774 ret = _regmap_update_bits(map, range->selector_reg,
775 range->selector_mask,
776 win_page << range->selector_shift,
779 map->work_buf = orig_work_buf;
785 *reg = range->window_start + win_offset;
791 static int _regmap_raw_write(struct regmap *map, unsigned int reg,
792 const void *val, size_t val_len)
794 u8 *u8 = map->work_buf;
800 /* Check for unwritable registers before we start */
801 if (map->writeable_reg)
802 for (i = 0; i < val_len / map->format.val_bytes; i++)
803 if (!map->writeable_reg(map->dev,
804 reg + (i * map->reg_stride)))
807 if (!map->cache_bypass && map->format.parse_val) {
809 int val_bytes = map->format.val_bytes;
810 for (i = 0; i < val_len / val_bytes; i++) {
811 memcpy(map->work_buf, val + (i * val_bytes), val_bytes);
812 ival = map->format.parse_val(map->work_buf);
813 ret = regcache_write(map, reg + (i * map->reg_stride),
817 "Error in caching of register: %u ret: %d\n",
822 if (map->cache_only) {
823 map->cache_dirty = true;
828 ret = _regmap_select_page(map, ®, val_len / map->format.val_bytes);
832 map->format.format_reg(map->work_buf, reg, map->reg_shift);
834 u8[0] |= map->write_flag_mask;
836 trace_regmap_hw_write_start(map->dev, reg,
837 val_len / map->format.val_bytes);
839 /* If we're doing a single register write we can probably just
840 * send the work_buf directly, otherwise try to do a gather
843 if (val == (map->work_buf + map->format.pad_bytes +
844 map->format.reg_bytes))
845 ret = map->bus->write(map->bus_context, map->work_buf,
846 map->format.reg_bytes +
847 map->format.pad_bytes +
849 else if (map->bus->gather_write)
850 ret = map->bus->gather_write(map->bus_context, map->work_buf,
851 map->format.reg_bytes +
852 map->format.pad_bytes,
855 /* If that didn't work fall back on linearising by hand. */
856 if (ret == -ENOTSUPP) {
857 len = map->format.reg_bytes + map->format.pad_bytes + val_len;
858 buf = kzalloc(len, GFP_KERNEL);
862 memcpy(buf, map->work_buf, map->format.reg_bytes);
863 memcpy(buf + map->format.reg_bytes + map->format.pad_bytes,
865 ret = map->bus->write(map->bus_context, buf, len);
870 trace_regmap_hw_write_done(map->dev, reg,
871 val_len / map->format.val_bytes);
876 int _regmap_write(struct regmap *map, unsigned int reg,
880 BUG_ON(!map->format.format_write && !map->format.format_val);
882 if (!map->cache_bypass && map->format.format_write) {
883 ret = regcache_write(map, reg, val);
886 if (map->cache_only) {
887 map->cache_dirty = true;
893 if (strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
894 dev_info(map->dev, "%x <= %x\n", reg, val);
897 trace_regmap_reg_write(map->dev, reg, val);
899 if (map->format.format_write) {
900 ret = _regmap_select_page(map, ®, 1);
904 map->format.format_write(map, reg, val);
906 trace_regmap_hw_write_start(map->dev, reg, 1);
908 ret = map->bus->write(map->bus_context, map->work_buf,
909 map->format.buf_size);
911 trace_regmap_hw_write_done(map->dev, reg, 1);
915 map->format.format_val(map->work_buf + map->format.reg_bytes
916 + map->format.pad_bytes, val, 0);
917 return _regmap_raw_write(map, reg,
919 map->format.reg_bytes +
920 map->format.pad_bytes,
921 map->format.val_bytes);
926 * regmap_write(): Write a value to a single register
928 * @map: Register map to write to
929 * @reg: Register to write to
930 * @val: Value to be written
932 * A value of zero will be returned on success, a negative errno will
933 * be returned in error cases.
935 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val)
939 if (reg % map->reg_stride)
944 ret = _regmap_write(map, reg, val);
950 EXPORT_SYMBOL_GPL(regmap_write);
953 * regmap_raw_write(): Write raw values to one or more registers
955 * @map: Register map to write to
956 * @reg: Initial register to write to
957 * @val: Block of data to be written, laid out for direct transmission to the
959 * @val_len: Length of data pointed to by val.
961 * This function is intended to be used for things like firmware
962 * download where a large block of data needs to be transferred to the
963 * device. No formatting will be done on the data provided.
965 * A value of zero will be returned on success, a negative errno will
966 * be returned in error cases.
968 int regmap_raw_write(struct regmap *map, unsigned int reg,
969 const void *val, size_t val_len)
973 if (val_len % map->format.val_bytes)
975 if (reg % map->reg_stride)
980 ret = _regmap_raw_write(map, reg, val, val_len);
986 EXPORT_SYMBOL_GPL(regmap_raw_write);
989 * regmap_bulk_write(): Write multiple registers to the device
991 * @map: Register map to write to
992 * @reg: First register to be write from
993 * @val: Block of data to be written, in native register size for device
994 * @val_count: Number of registers to write
996 * This function is intended to be used for writing a large block of
997 * data to be device either in single transfer or multiple transfer.
999 * A value of zero will be returned on success, a negative errno will
1000 * be returned in error cases.
1002 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1006 size_t val_bytes = map->format.val_bytes;
1009 if (!map->format.parse_val)
1011 if (reg % map->reg_stride)
1016 /* No formatting is require if val_byte is 1 */
1017 if (val_bytes == 1) {
1020 wval = kmemdup(val, val_count * val_bytes, GFP_KERNEL);
1023 dev_err(map->dev, "Error in memory allocation\n");
1026 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1027 map->format.parse_val(wval + i);
1030 * Some devices does not support bulk write, for
1031 * them we have a series of single write operations.
1033 if (map->use_single_rw) {
1034 for (i = 0; i < val_count; i++) {
1035 ret = regmap_raw_write(map,
1036 reg + (i * map->reg_stride),
1037 val + (i * val_bytes),
1043 ret = _regmap_raw_write(map, reg, wval, val_bytes * val_count);
1053 EXPORT_SYMBOL_GPL(regmap_bulk_write);
1055 static int _regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
1056 unsigned int val_len)
1058 u8 *u8 = map->work_buf;
1061 ret = _regmap_select_page(map, ®, val_len / map->format.val_bytes);
1065 map->format.format_reg(map->work_buf, reg, map->reg_shift);
1068 * Some buses or devices flag reads by setting the high bits in the
1069 * register addresss; since it's always the high bits for all
1070 * current formats we can do this here rather than in
1071 * formatting. This may break if we get interesting formats.
1073 u8[0] |= map->read_flag_mask;
1075 trace_regmap_hw_read_start(map->dev, reg,
1076 val_len / map->format.val_bytes);
1078 ret = map->bus->read(map->bus_context, map->work_buf,
1079 map->format.reg_bytes + map->format.pad_bytes,
1082 trace_regmap_hw_read_done(map->dev, reg,
1083 val_len / map->format.val_bytes);
1088 static int _regmap_read(struct regmap *map, unsigned int reg,
1093 if (!map->cache_bypass) {
1094 ret = regcache_read(map, reg, val);
1099 if (!map->format.parse_val)
1102 if (map->cache_only)
1105 ret = _regmap_raw_read(map, reg, map->work_buf, map->format.val_bytes);
1107 *val = map->format.parse_val(map->work_buf);
1110 if (strcmp(dev_name(map->dev), LOG_DEVICE) == 0)
1111 dev_info(map->dev, "%x => %x\n", reg, *val);
1114 trace_regmap_reg_read(map->dev, reg, *val);
1117 if (ret == 0 && !map->cache_bypass)
1118 regcache_write(map, reg, *val);
1124 * regmap_read(): Read a value from a single register
1126 * @map: Register map to write to
1127 * @reg: Register to be read from
1128 * @val: Pointer to store read value
1130 * A value of zero will be returned on success, a negative errno will
1131 * be returned in error cases.
1133 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val)
1137 if (reg % map->reg_stride)
1142 ret = _regmap_read(map, reg, val);
1148 EXPORT_SYMBOL_GPL(regmap_read);
1151 * regmap_raw_read(): Read raw data from the device
1153 * @map: Register map to write to
1154 * @reg: First register to be read from
1155 * @val: Pointer to store read value
1156 * @val_len: Size of data to read
1158 * A value of zero will be returned on success, a negative errno will
1159 * be returned in error cases.
1161 int regmap_raw_read(struct regmap *map, unsigned int reg, void *val,
1164 size_t val_bytes = map->format.val_bytes;
1165 size_t val_count = val_len / val_bytes;
1169 if (val_len % map->format.val_bytes)
1171 if (reg % map->reg_stride)
1176 if (regmap_volatile_range(map, reg, val_count) || map->cache_bypass ||
1177 map->cache_type == REGCACHE_NONE) {
1178 /* Physical block read if there's no cache involved */
1179 ret = _regmap_raw_read(map, reg, val, val_len);
1182 /* Otherwise go word by word for the cache; should be low
1183 * cost as we expect to hit the cache.
1185 for (i = 0; i < val_count; i++) {
1186 ret = _regmap_read(map, reg + (i * map->reg_stride),
1191 map->format.format_val(val + (i * val_bytes), v, 0);
1200 EXPORT_SYMBOL_GPL(regmap_raw_read);
1203 * regmap_bulk_read(): Read multiple registers from the device
1205 * @map: Register map to write to
1206 * @reg: First register to be read from
1207 * @val: Pointer to store read value, in native register size for device
1208 * @val_count: Number of registers to read
1210 * A value of zero will be returned on success, a negative errno will
1211 * be returned in error cases.
1213 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1217 size_t val_bytes = map->format.val_bytes;
1218 bool vol = regmap_volatile_range(map, reg, val_count);
1220 if (!map->format.parse_val)
1222 if (reg % map->reg_stride)
1225 if (vol || map->cache_type == REGCACHE_NONE) {
1227 * Some devices does not support bulk read, for
1228 * them we have a series of single read operations.
1230 if (map->use_single_rw) {
1231 for (i = 0; i < val_count; i++) {
1232 ret = regmap_raw_read(map,
1233 reg + (i * map->reg_stride),
1234 val + (i * val_bytes),
1240 ret = regmap_raw_read(map, reg, val,
1241 val_bytes * val_count);
1246 for (i = 0; i < val_count * val_bytes; i += val_bytes)
1247 map->format.parse_val(val + i);
1249 for (i = 0; i < val_count; i++) {
1251 ret = regmap_read(map, reg + (i * map->reg_stride),
1255 memcpy(val + (i * val_bytes), &ival, val_bytes);
1261 EXPORT_SYMBOL_GPL(regmap_bulk_read);
1263 static int _regmap_update_bits(struct regmap *map, unsigned int reg,
1264 unsigned int mask, unsigned int val,
1268 unsigned int tmp, orig;
1270 ret = _regmap_read(map, reg, &orig);
1278 ret = _regmap_write(map, reg, tmp);
1288 * regmap_update_bits: Perform a read/modify/write cycle on the register map
1290 * @map: Register map to update
1291 * @reg: Register to update
1292 * @mask: Bitmask to change
1293 * @val: New value for bitmask
1295 * Returns zero for success, a negative number on error.
1297 int regmap_update_bits(struct regmap *map, unsigned int reg,
1298 unsigned int mask, unsigned int val)
1304 ret = _regmap_update_bits(map, reg, mask, val, &change);
1309 EXPORT_SYMBOL_GPL(regmap_update_bits);
1312 * regmap_update_bits_check: Perform a read/modify/write cycle on the
1313 * register map and report if updated
1315 * @map: Register map to update
1316 * @reg: Register to update
1317 * @mask: Bitmask to change
1318 * @val: New value for bitmask
1319 * @change: Boolean indicating if a write was done
1321 * Returns zero for success, a negative number on error.
1323 int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1324 unsigned int mask, unsigned int val,
1330 ret = _regmap_update_bits(map, reg, mask, val, change);
1334 EXPORT_SYMBOL_GPL(regmap_update_bits_check);
1337 * regmap_register_patch: Register and apply register updates to be applied
1338 * on device initialistion
1340 * @map: Register map to apply updates to.
1341 * @regs: Values to update.
1342 * @num_regs: Number of entries in regs.
1344 * Register a set of register updates to be applied to the device
1345 * whenever the device registers are synchronised with the cache and
1346 * apply them immediately. Typically this is used to apply
1347 * corrections to be applied to the device defaults on startup, such
1348 * as the updates some vendors provide to undocumented registers.
1350 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
1356 /* If needed the implementation can be extended to support this */
1362 bypass = map->cache_bypass;
1364 map->cache_bypass = true;
1366 /* Write out first; it's useful to apply even if we fail later. */
1367 for (i = 0; i < num_regs; i++) {
1368 ret = _regmap_write(map, regs[i].reg, regs[i].def);
1370 dev_err(map->dev, "Failed to write %x = %x: %d\n",
1371 regs[i].reg, regs[i].def, ret);
1376 map->patch = kcalloc(num_regs, sizeof(struct reg_default), GFP_KERNEL);
1377 if (map->patch != NULL) {
1378 memcpy(map->patch, regs,
1379 num_regs * sizeof(struct reg_default));
1380 map->patch_regs = num_regs;
1386 map->cache_bypass = bypass;
1392 EXPORT_SYMBOL_GPL(regmap_register_patch);
1395 * regmap_get_val_bytes(): Report the size of a register value
1397 * Report the size of a register value, mainly intended to for use by
1398 * generic infrastructure built on top of regmap.
1400 int regmap_get_val_bytes(struct regmap *map)
1402 if (map->format.format_write)
1405 return map->format.val_bytes;
1407 EXPORT_SYMBOL_GPL(regmap_get_val_bytes);
1409 static int __init regmap_initcall(void)
1411 regmap_debugfs_initcall();
1415 postcore_initcall(regmap_initcall);