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
,
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
)
97 if (map
->max_register
&& reg
> map
->max_register
)
100 if (map
->format
.format_write
)
103 if (map
->readable_reg
)
104 return map
->readable_reg(map
->dev
, reg
);
107 return regmap_check_range_table(map
, reg
, map
->rd_table
);
112 bool regmap_volatile(struct regmap
*map
, unsigned int reg
)
114 if (!map
->format
.format_write
&& !regmap_readable(map
, reg
))
117 if (map
->volatile_reg
)
118 return map
->volatile_reg(map
->dev
, reg
);
120 if (map
->volatile_table
)
121 return regmap_check_range_table(map
, reg
, map
->volatile_table
);
129 bool regmap_precious(struct regmap
*map
, unsigned int reg
)
131 if (!regmap_readable(map
, reg
))
134 if (map
->precious_reg
)
135 return map
->precious_reg(map
->dev
, reg
);
137 if (map
->precious_table
)
138 return regmap_check_range_table(map
, reg
, map
->precious_table
);
143 static bool regmap_volatile_range(struct regmap
*map
, unsigned int reg
,
148 for (i
= 0; i
< num
; i
++)
149 if (!regmap_volatile(map
, reg
+ i
))
155 static void regmap_format_2_6_write(struct regmap
*map
,
156 unsigned int reg
, unsigned int val
)
158 u8
*out
= map
->work_buf
;
160 *out
= (reg
<< 6) | val
;
163 static void regmap_format_4_12_write(struct regmap
*map
,
164 unsigned int reg
, unsigned int val
)
166 __be16
*out
= map
->work_buf
;
167 *out
= cpu_to_be16((reg
<< 12) | val
);
170 static void regmap_format_7_9_write(struct regmap
*map
,
171 unsigned int reg
, unsigned int val
)
173 __be16
*out
= map
->work_buf
;
174 *out
= cpu_to_be16((reg
<< 9) | val
);
177 static void regmap_format_10_14_write(struct regmap
*map
,
178 unsigned int reg
, unsigned int val
)
180 u8
*out
= map
->work_buf
;
183 out
[1] = (val
>> 8) | (reg
<< 6);
187 static void regmap_format_8(void *buf
, unsigned int val
, unsigned int shift
)
194 static void regmap_format_16_be(void *buf
, unsigned int val
, unsigned int shift
)
198 b
[0] = cpu_to_be16(val
<< shift
);
201 static void regmap_format_16_le(void *buf
, unsigned int val
, unsigned int shift
)
205 b
[0] = cpu_to_le16(val
<< shift
);
208 static void regmap_format_16_native(void *buf
, unsigned int val
,
211 *(u16
*)buf
= val
<< shift
;
214 static void regmap_format_24(void *buf
, unsigned int val
, unsigned int shift
)
225 static void regmap_format_32_be(void *buf
, unsigned int val
, unsigned int shift
)
229 b
[0] = cpu_to_be32(val
<< shift
);
232 static void regmap_format_32_le(void *buf
, unsigned int val
, unsigned int shift
)
236 b
[0] = cpu_to_le32(val
<< shift
);
239 static void regmap_format_32_native(void *buf
, unsigned int val
,
242 *(u32
*)buf
= val
<< shift
;
245 static void regmap_parse_inplace_noop(void *buf
)
249 static unsigned int regmap_parse_8(const void *buf
)
256 static unsigned int regmap_parse_16_be(const void *buf
)
258 const __be16
*b
= buf
;
260 return be16_to_cpu(b
[0]);
263 static unsigned int regmap_parse_16_le(const void *buf
)
265 const __le16
*b
= buf
;
267 return le16_to_cpu(b
[0]);
270 static void regmap_parse_16_be_inplace(void *buf
)
274 b
[0] = be16_to_cpu(b
[0]);
277 static void regmap_parse_16_le_inplace(void *buf
)
281 b
[0] = le16_to_cpu(b
[0]);
284 static unsigned int regmap_parse_16_native(const void *buf
)
289 static unsigned int regmap_parse_24(const void *buf
)
292 unsigned int ret
= b
[2];
293 ret
|= ((unsigned int)b
[1]) << 8;
294 ret
|= ((unsigned int)b
[0]) << 16;
299 static unsigned int regmap_parse_32_be(const void *buf
)
301 const __be32
*b
= buf
;
303 return be32_to_cpu(b
[0]);
306 static unsigned int regmap_parse_32_le(const void *buf
)
308 const __le32
*b
= buf
;
310 return le32_to_cpu(b
[0]);
313 static void regmap_parse_32_be_inplace(void *buf
)
317 b
[0] = be32_to_cpu(b
[0]);
320 static void regmap_parse_32_le_inplace(void *buf
)
324 b
[0] = le32_to_cpu(b
[0]);
327 static unsigned int regmap_parse_32_native(const void *buf
)
332 static void regmap_lock_mutex(void *__map
)
334 struct regmap
*map
= __map
;
335 mutex_lock(&map
->mutex
);
338 static void regmap_unlock_mutex(void *__map
)
340 struct regmap
*map
= __map
;
341 mutex_unlock(&map
->mutex
);
344 static void regmap_lock_spinlock(void *__map
)
345 __acquires(&map
->spinlock
)
347 struct regmap
*map
= __map
;
350 spin_lock_irqsave(&map
->spinlock
, flags
);
351 map
->spinlock_flags
= flags
;
354 static void regmap_unlock_spinlock(void *__map
)
355 __releases(&map
->spinlock
)
357 struct regmap
*map
= __map
;
358 spin_unlock_irqrestore(&map
->spinlock
, map
->spinlock_flags
);
361 static void dev_get_regmap_release(struct device
*dev
, void *res
)
364 * We don't actually have anything to do here; the goal here
365 * is not to manage the regmap but to provide a simple way to
366 * get the regmap back given a struct device.
370 static bool _regmap_range_add(struct regmap
*map
,
371 struct regmap_range_node
*data
)
373 struct rb_root
*root
= &map
->range_tree
;
374 struct rb_node
**new = &(root
->rb_node
), *parent
= NULL
;
377 struct regmap_range_node
*this =
378 container_of(*new, struct regmap_range_node
, node
);
381 if (data
->range_max
< this->range_min
)
382 new = &((*new)->rb_left
);
383 else if (data
->range_min
> this->range_max
)
384 new = &((*new)->rb_right
);
389 rb_link_node(&data
->node
, parent
, new);
390 rb_insert_color(&data
->node
, root
);
395 static struct regmap_range_node
*_regmap_range_lookup(struct regmap
*map
,
398 struct rb_node
*node
= map
->range_tree
.rb_node
;
401 struct regmap_range_node
*this =
402 container_of(node
, struct regmap_range_node
, node
);
404 if (reg
< this->range_min
)
405 node
= node
->rb_left
;
406 else if (reg
> this->range_max
)
407 node
= node
->rb_right
;
415 static void regmap_range_exit(struct regmap
*map
)
417 struct rb_node
*next
;
418 struct regmap_range_node
*range_node
;
420 next
= rb_first(&map
->range_tree
);
422 range_node
= rb_entry(next
, struct regmap_range_node
, node
);
423 next
= rb_next(&range_node
->node
);
424 rb_erase(&range_node
->node
, &map
->range_tree
);
428 kfree(map
->selector_work_buf
);
431 int regmap_attach_dev(struct device
*dev
, struct regmap
*map
,
432 const struct regmap_config
*config
)
438 regmap_debugfs_init(map
, config
->name
);
440 /* Add a devres resource for dev_get_regmap() */
441 m
= devres_alloc(dev_get_regmap_release
, sizeof(*m
), GFP_KERNEL
);
443 regmap_debugfs_exit(map
);
451 EXPORT_SYMBOL_GPL(regmap_attach_dev
);
453 static enum regmap_endian
regmap_get_reg_endian(const struct regmap_bus
*bus
,
454 const struct regmap_config
*config
)
456 enum regmap_endian endian
;
458 /* Retrieve the endianness specification from the regmap config */
459 endian
= config
->reg_format_endian
;
461 /* If the regmap config specified a non-default value, use that */
462 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
465 /* Retrieve the endianness specification from the bus config */
466 if (bus
&& bus
->reg_format_endian_default
)
467 endian
= bus
->reg_format_endian_default
;
469 /* If the bus specified a non-default value, use that */
470 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
473 /* Use this if no other value was found */
474 return REGMAP_ENDIAN_BIG
;
477 enum regmap_endian
regmap_get_val_endian(struct device
*dev
,
478 const struct regmap_bus
*bus
,
479 const struct regmap_config
*config
)
481 struct device_node
*np
;
482 enum regmap_endian endian
;
484 /* Retrieve the endianness specification from the regmap config */
485 endian
= config
->val_format_endian
;
487 /* If the regmap config specified a non-default value, use that */
488 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
491 /* If the dev and dev->of_node exist try to get endianness from DT */
492 if (dev
&& dev
->of_node
) {
495 /* Parse the device's DT node for an endianness specification */
496 if (of_property_read_bool(np
, "big-endian"))
497 endian
= REGMAP_ENDIAN_BIG
;
498 else if (of_property_read_bool(np
, "little-endian"))
499 endian
= REGMAP_ENDIAN_LITTLE
;
501 /* If the endianness was specified in DT, use that */
502 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
506 /* Retrieve the endianness specification from the bus config */
507 if (bus
&& bus
->val_format_endian_default
)
508 endian
= bus
->val_format_endian_default
;
510 /* If the bus specified a non-default value, use that */
511 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
514 /* Use this if no other value was found */
515 return REGMAP_ENDIAN_BIG
;
517 EXPORT_SYMBOL_GPL(regmap_get_val_endian
);
520 * regmap_init(): Initialise register map
522 * @dev: Device that will be interacted with
523 * @bus: Bus-specific callbacks to use with device
524 * @bus_context: Data passed to bus-specific callbacks
525 * @config: Configuration for register map
527 * The return value will be an ERR_PTR() on error or a valid pointer to
528 * a struct regmap. This function should generally not be called
529 * directly, it should be called by bus-specific init functions.
531 struct regmap
*regmap_init(struct device
*dev
,
532 const struct regmap_bus
*bus
,
534 const struct regmap_config
*config
)
538 enum regmap_endian reg_endian
, val_endian
;
544 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
550 if (config
->lock
&& config
->unlock
) {
551 map
->lock
= config
->lock
;
552 map
->unlock
= config
->unlock
;
553 map
->lock_arg
= config
->lock_arg
;
555 if ((bus
&& bus
->fast_io
) ||
557 spin_lock_init(&map
->spinlock
);
558 map
->lock
= regmap_lock_spinlock
;
559 map
->unlock
= regmap_unlock_spinlock
;
561 mutex_init(&map
->mutex
);
562 map
->lock
= regmap_lock_mutex
;
563 map
->unlock
= regmap_unlock_mutex
;
567 map
->format
.reg_bytes
= DIV_ROUND_UP(config
->reg_bits
, 8);
568 map
->format
.pad_bytes
= config
->pad_bits
/ 8;
569 map
->format
.val_bytes
= DIV_ROUND_UP(config
->val_bits
, 8);
570 map
->format
.buf_size
= DIV_ROUND_UP(config
->reg_bits
+
571 config
->val_bits
+ config
->pad_bits
, 8);
572 map
->reg_shift
= config
->pad_bits
% 8;
573 if (config
->reg_stride
)
574 map
->reg_stride
= config
->reg_stride
;
577 map
->use_single_rw
= config
->use_single_rw
;
578 map
->can_multi_write
= config
->can_multi_write
;
581 map
->bus_context
= bus_context
;
582 map
->max_register
= config
->max_register
;
583 map
->wr_table
= config
->wr_table
;
584 map
->rd_table
= config
->rd_table
;
585 map
->volatile_table
= config
->volatile_table
;
586 map
->precious_table
= config
->precious_table
;
587 map
->writeable_reg
= config
->writeable_reg
;
588 map
->readable_reg
= config
->readable_reg
;
589 map
->volatile_reg
= config
->volatile_reg
;
590 map
->precious_reg
= config
->precious_reg
;
591 map
->cache_type
= config
->cache_type
;
592 map
->name
= config
->name
;
594 spin_lock_init(&map
->async_lock
);
595 INIT_LIST_HEAD(&map
->async_list
);
596 INIT_LIST_HEAD(&map
->async_free
);
597 init_waitqueue_head(&map
->async_waitq
);
599 if (config
->read_flag_mask
|| config
->write_flag_mask
) {
600 map
->read_flag_mask
= config
->read_flag_mask
;
601 map
->write_flag_mask
= config
->write_flag_mask
;
603 map
->read_flag_mask
= bus
->read_flag_mask
;
607 map
->reg_read
= config
->reg_read
;
608 map
->reg_write
= config
->reg_write
;
610 map
->defer_caching
= false;
611 goto skip_format_initialization
;
612 } else if (!bus
->read
|| !bus
->write
) {
613 map
->reg_read
= _regmap_bus_reg_read
;
614 map
->reg_write
= _regmap_bus_reg_write
;
616 map
->defer_caching
= false;
617 goto skip_format_initialization
;
619 map
->reg_read
= _regmap_bus_read
;
622 reg_endian
= regmap_get_reg_endian(bus
, config
);
623 val_endian
= regmap_get_val_endian(dev
, bus
, config
);
625 switch (config
->reg_bits
+ map
->reg_shift
) {
627 switch (config
->val_bits
) {
629 map
->format
.format_write
= regmap_format_2_6_write
;
637 switch (config
->val_bits
) {
639 map
->format
.format_write
= regmap_format_4_12_write
;
647 switch (config
->val_bits
) {
649 map
->format
.format_write
= regmap_format_7_9_write
;
657 switch (config
->val_bits
) {
659 map
->format
.format_write
= regmap_format_10_14_write
;
667 map
->format
.format_reg
= regmap_format_8
;
671 switch (reg_endian
) {
672 case REGMAP_ENDIAN_BIG
:
673 map
->format
.format_reg
= regmap_format_16_be
;
675 case REGMAP_ENDIAN_NATIVE
:
676 map
->format
.format_reg
= regmap_format_16_native
;
684 if (reg_endian
!= REGMAP_ENDIAN_BIG
)
686 map
->format
.format_reg
= regmap_format_24
;
690 switch (reg_endian
) {
691 case REGMAP_ENDIAN_BIG
:
692 map
->format
.format_reg
= regmap_format_32_be
;
694 case REGMAP_ENDIAN_NATIVE
:
695 map
->format
.format_reg
= regmap_format_32_native
;
706 if (val_endian
== REGMAP_ENDIAN_NATIVE
)
707 map
->format
.parse_inplace
= regmap_parse_inplace_noop
;
709 switch (config
->val_bits
) {
711 map
->format
.format_val
= regmap_format_8
;
712 map
->format
.parse_val
= regmap_parse_8
;
713 map
->format
.parse_inplace
= regmap_parse_inplace_noop
;
716 switch (val_endian
) {
717 case REGMAP_ENDIAN_BIG
:
718 map
->format
.format_val
= regmap_format_16_be
;
719 map
->format
.parse_val
= regmap_parse_16_be
;
720 map
->format
.parse_inplace
= regmap_parse_16_be_inplace
;
722 case REGMAP_ENDIAN_LITTLE
:
723 map
->format
.format_val
= regmap_format_16_le
;
724 map
->format
.parse_val
= regmap_parse_16_le
;
725 map
->format
.parse_inplace
= regmap_parse_16_le_inplace
;
727 case REGMAP_ENDIAN_NATIVE
:
728 map
->format
.format_val
= regmap_format_16_native
;
729 map
->format
.parse_val
= regmap_parse_16_native
;
736 if (val_endian
!= REGMAP_ENDIAN_BIG
)
738 map
->format
.format_val
= regmap_format_24
;
739 map
->format
.parse_val
= regmap_parse_24
;
742 switch (val_endian
) {
743 case REGMAP_ENDIAN_BIG
:
744 map
->format
.format_val
= regmap_format_32_be
;
745 map
->format
.parse_val
= regmap_parse_32_be
;
746 map
->format
.parse_inplace
= regmap_parse_32_be_inplace
;
748 case REGMAP_ENDIAN_LITTLE
:
749 map
->format
.format_val
= regmap_format_32_le
;
750 map
->format
.parse_val
= regmap_parse_32_le
;
751 map
->format
.parse_inplace
= regmap_parse_32_le_inplace
;
753 case REGMAP_ENDIAN_NATIVE
:
754 map
->format
.format_val
= regmap_format_32_native
;
755 map
->format
.parse_val
= regmap_parse_32_native
;
763 if (map
->format
.format_write
) {
764 if ((reg_endian
!= REGMAP_ENDIAN_BIG
) ||
765 (val_endian
!= REGMAP_ENDIAN_BIG
))
767 map
->use_single_rw
= true;
770 if (!map
->format
.format_write
&&
771 !(map
->format
.format_reg
&& map
->format
.format_val
))
774 map
->work_buf
= kzalloc(map
->format
.buf_size
, GFP_KERNEL
);
775 if (map
->work_buf
== NULL
) {
780 if (map
->format
.format_write
) {
781 map
->defer_caching
= false;
782 map
->reg_write
= _regmap_bus_formatted_write
;
783 } else if (map
->format
.format_val
) {
784 map
->defer_caching
= true;
785 map
->reg_write
= _regmap_bus_raw_write
;
788 skip_format_initialization
:
790 map
->range_tree
= RB_ROOT
;
791 for (i
= 0; i
< config
->num_ranges
; i
++) {
792 const struct regmap_range_cfg
*range_cfg
= &config
->ranges
[i
];
793 struct regmap_range_node
*new;
796 if (range_cfg
->range_max
< range_cfg
->range_min
) {
797 dev_err(map
->dev
, "Invalid range %d: %d < %d\n", i
,
798 range_cfg
->range_max
, range_cfg
->range_min
);
802 if (range_cfg
->range_max
> map
->max_register
) {
803 dev_err(map
->dev
, "Invalid range %d: %d > %d\n", i
,
804 range_cfg
->range_max
, map
->max_register
);
808 if (range_cfg
->selector_reg
> map
->max_register
) {
810 "Invalid range %d: selector out of map\n", i
);
814 if (range_cfg
->window_len
== 0) {
815 dev_err(map
->dev
, "Invalid range %d: window_len 0\n",
820 /* Make sure, that this register range has no selector
821 or data window within its boundary */
822 for (j
= 0; j
< config
->num_ranges
; j
++) {
823 unsigned sel_reg
= config
->ranges
[j
].selector_reg
;
824 unsigned win_min
= config
->ranges
[j
].window_start
;
825 unsigned win_max
= win_min
+
826 config
->ranges
[j
].window_len
- 1;
828 /* Allow data window inside its own virtual range */
832 if (range_cfg
->range_min
<= sel_reg
&&
833 sel_reg
<= range_cfg
->range_max
) {
835 "Range %d: selector for %d in window\n",
840 if (!(win_max
< range_cfg
->range_min
||
841 win_min
> range_cfg
->range_max
)) {
843 "Range %d: window for %d in window\n",
849 new = kzalloc(sizeof(*new), GFP_KERNEL
);
856 new->name
= range_cfg
->name
;
857 new->range_min
= range_cfg
->range_min
;
858 new->range_max
= range_cfg
->range_max
;
859 new->selector_reg
= range_cfg
->selector_reg
;
860 new->selector_mask
= range_cfg
->selector_mask
;
861 new->selector_shift
= range_cfg
->selector_shift
;
862 new->window_start
= range_cfg
->window_start
;
863 new->window_len
= range_cfg
->window_len
;
865 if (!_regmap_range_add(map
, new)) {
866 dev_err(map
->dev
, "Failed to add range %d\n", i
);
871 if (map
->selector_work_buf
== NULL
) {
872 map
->selector_work_buf
=
873 kzalloc(map
->format
.buf_size
, GFP_KERNEL
);
874 if (map
->selector_work_buf
== NULL
) {
881 ret
= regcache_init(map
, config
);
886 ret
= regmap_attach_dev(dev
, map
, config
);
896 regmap_range_exit(map
);
897 kfree(map
->work_buf
);
903 EXPORT_SYMBOL_GPL(regmap_init
);
905 static void devm_regmap_release(struct device
*dev
, void *res
)
907 regmap_exit(*(struct regmap
**)res
);
911 * devm_regmap_init(): Initialise managed register map
913 * @dev: Device that will be interacted with
914 * @bus: Bus-specific callbacks to use with device
915 * @bus_context: Data passed to bus-specific callbacks
916 * @config: Configuration for register map
918 * The return value will be an ERR_PTR() on error or a valid pointer
919 * to a struct regmap. This function should generally not be called
920 * directly, it should be called by bus-specific init functions. The
921 * map will be automatically freed by the device management code.
923 struct regmap
*devm_regmap_init(struct device
*dev
,
924 const struct regmap_bus
*bus
,
926 const struct regmap_config
*config
)
928 struct regmap
**ptr
, *regmap
;
930 ptr
= devres_alloc(devm_regmap_release
, sizeof(*ptr
), GFP_KERNEL
);
932 return ERR_PTR(-ENOMEM
);
934 regmap
= regmap_init(dev
, bus
, bus_context
, config
);
935 if (!IS_ERR(regmap
)) {
937 devres_add(dev
, ptr
);
944 EXPORT_SYMBOL_GPL(devm_regmap_init
);
946 static void regmap_field_init(struct regmap_field
*rm_field
,
947 struct regmap
*regmap
, struct reg_field reg_field
)
949 rm_field
->regmap
= regmap
;
950 rm_field
->reg
= reg_field
.reg
;
951 rm_field
->shift
= reg_field
.lsb
;
952 rm_field
->mask
= GENMASK(reg_field
.msb
, reg_field
.lsb
);
953 rm_field
->id_size
= reg_field
.id_size
;
954 rm_field
->id_offset
= reg_field
.id_offset
;
958 * devm_regmap_field_alloc(): Allocate and initialise a register field
961 * @dev: Device that will be interacted with
962 * @regmap: regmap bank in which this register field is located.
963 * @reg_field: Register field with in the bank.
965 * The return value will be an ERR_PTR() on error or a valid pointer
966 * to a struct regmap_field. The regmap_field will be automatically freed
967 * by the device management code.
969 struct regmap_field
*devm_regmap_field_alloc(struct device
*dev
,
970 struct regmap
*regmap
, struct reg_field reg_field
)
972 struct regmap_field
*rm_field
= devm_kzalloc(dev
,
973 sizeof(*rm_field
), GFP_KERNEL
);
975 return ERR_PTR(-ENOMEM
);
977 regmap_field_init(rm_field
, regmap
, reg_field
);
982 EXPORT_SYMBOL_GPL(devm_regmap_field_alloc
);
985 * devm_regmap_field_free(): Free register field allocated using
986 * devm_regmap_field_alloc. Usally drivers need not call this function,
987 * as the memory allocated via devm will be freed as per device-driver
990 * @dev: Device that will be interacted with
991 * @field: regmap field which should be freed.
993 void devm_regmap_field_free(struct device
*dev
,
994 struct regmap_field
*field
)
996 devm_kfree(dev
, field
);
998 EXPORT_SYMBOL_GPL(devm_regmap_field_free
);
1001 * regmap_field_alloc(): Allocate and initialise a register field
1002 * in a register map.
1004 * @regmap: regmap bank in which this register field is located.
1005 * @reg_field: Register field with in the bank.
1007 * The return value will be an ERR_PTR() on error or a valid pointer
1008 * to a struct regmap_field. The regmap_field should be freed by the
1009 * user once its finished working with it using regmap_field_free().
1011 struct regmap_field
*regmap_field_alloc(struct regmap
*regmap
,
1012 struct reg_field reg_field
)
1014 struct regmap_field
*rm_field
= kzalloc(sizeof(*rm_field
), GFP_KERNEL
);
1017 return ERR_PTR(-ENOMEM
);
1019 regmap_field_init(rm_field
, regmap
, reg_field
);
1023 EXPORT_SYMBOL_GPL(regmap_field_alloc
);
1026 * regmap_field_free(): Free register field allocated using regmap_field_alloc
1028 * @field: regmap field which should be freed.
1030 void regmap_field_free(struct regmap_field
*field
)
1034 EXPORT_SYMBOL_GPL(regmap_field_free
);
1037 * regmap_reinit_cache(): Reinitialise the current register cache
1039 * @map: Register map to operate on.
1040 * @config: New configuration. Only the cache data will be used.
1042 * Discard any existing register cache for the map and initialize a
1043 * new cache. This can be used to restore the cache to defaults or to
1044 * update the cache configuration to reflect runtime discovery of the
1047 * No explicit locking is done here, the user needs to ensure that
1048 * this function will not race with other calls to regmap.
1050 int regmap_reinit_cache(struct regmap
*map
, const struct regmap_config
*config
)
1053 regmap_debugfs_exit(map
);
1055 map
->max_register
= config
->max_register
;
1056 map
->writeable_reg
= config
->writeable_reg
;
1057 map
->readable_reg
= config
->readable_reg
;
1058 map
->volatile_reg
= config
->volatile_reg
;
1059 map
->precious_reg
= config
->precious_reg
;
1060 map
->cache_type
= config
->cache_type
;
1062 regmap_debugfs_init(map
, config
->name
);
1064 map
->cache_bypass
= false;
1065 map
->cache_only
= false;
1067 return regcache_init(map
, config
);
1069 EXPORT_SYMBOL_GPL(regmap_reinit_cache
);
1072 * regmap_exit(): Free a previously allocated register map
1074 void regmap_exit(struct regmap
*map
)
1076 struct regmap_async
*async
;
1079 regmap_debugfs_exit(map
);
1080 regmap_range_exit(map
);
1081 if (map
->bus
&& map
->bus
->free_context
)
1082 map
->bus
->free_context(map
->bus_context
);
1083 kfree(map
->work_buf
);
1084 while (!list_empty(&map
->async_free
)) {
1085 async
= list_first_entry_or_null(&map
->async_free
,
1086 struct regmap_async
,
1088 list_del(&async
->list
);
1089 kfree(async
->work_buf
);
1094 EXPORT_SYMBOL_GPL(regmap_exit
);
1096 static int dev_get_regmap_match(struct device
*dev
, void *res
, void *data
)
1098 struct regmap
**r
= res
;
1104 /* If the user didn't specify a name match any */
1106 return (*r
)->name
== data
;
1112 * dev_get_regmap(): Obtain the regmap (if any) for a device
1114 * @dev: Device to retrieve the map for
1115 * @name: Optional name for the register map, usually NULL.
1117 * Returns the regmap for the device if one is present, or NULL. If
1118 * name is specified then it must match the name specified when
1119 * registering the device, if it is NULL then the first regmap found
1120 * will be used. Devices with multiple register maps are very rare,
1121 * generic code should normally not need to specify a name.
1123 struct regmap
*dev_get_regmap(struct device
*dev
, const char *name
)
1125 struct regmap
**r
= devres_find(dev
, dev_get_regmap_release
,
1126 dev_get_regmap_match
, (void *)name
);
1132 EXPORT_SYMBOL_GPL(dev_get_regmap
);
1135 * regmap_get_device(): Obtain the device from a regmap
1137 * @map: Register map to operate on.
1139 * Returns the underlying device that the regmap has been created for.
1141 struct device
*regmap_get_device(struct regmap
*map
)
1145 EXPORT_SYMBOL_GPL(regmap_get_device
);
1147 static int _regmap_select_page(struct regmap
*map
, unsigned int *reg
,
1148 struct regmap_range_node
*range
,
1149 unsigned int val_num
)
1151 void *orig_work_buf
;
1152 unsigned int win_offset
;
1153 unsigned int win_page
;
1157 win_offset
= (*reg
- range
->range_min
) % range
->window_len
;
1158 win_page
= (*reg
- range
->range_min
) / range
->window_len
;
1161 /* Bulk write shouldn't cross range boundary */
1162 if (*reg
+ val_num
- 1 > range
->range_max
)
1165 /* ... or single page boundary */
1166 if (val_num
> range
->window_len
- win_offset
)
1170 /* It is possible to have selector register inside data window.
1171 In that case, selector register is located on every page and
1172 it needs no page switching, when accessed alone. */
1174 range
->window_start
+ win_offset
!= range
->selector_reg
) {
1175 /* Use separate work_buf during page switching */
1176 orig_work_buf
= map
->work_buf
;
1177 map
->work_buf
= map
->selector_work_buf
;
1179 ret
= _regmap_update_bits(map
, range
->selector_reg
,
1180 range
->selector_mask
,
1181 win_page
<< range
->selector_shift
,
1184 map
->work_buf
= orig_work_buf
;
1190 *reg
= range
->window_start
+ win_offset
;
1195 int _regmap_raw_write(struct regmap
*map
, unsigned int reg
,
1196 const void *val
, size_t val_len
)
1198 struct regmap_range_node
*range
;
1199 unsigned long flags
;
1200 u8
*u8
= map
->work_buf
;
1201 void *work_val
= map
->work_buf
+ map
->format
.reg_bytes
+
1202 map
->format
.pad_bytes
;
1204 int ret
= -ENOTSUPP
;
1210 /* Check for unwritable registers before we start */
1211 if (map
->writeable_reg
)
1212 for (i
= 0; i
< val_len
/ map
->format
.val_bytes
; i
++)
1213 if (!map
->writeable_reg(map
->dev
,
1214 reg
+ (i
* map
->reg_stride
)))
1217 if (!map
->cache_bypass
&& map
->format
.parse_val
) {
1219 int val_bytes
= map
->format
.val_bytes
;
1220 for (i
= 0; i
< val_len
/ val_bytes
; i
++) {
1221 ival
= map
->format
.parse_val(val
+ (i
* val_bytes
));
1222 ret
= regcache_write(map
, reg
+ (i
* map
->reg_stride
),
1226 "Error in caching of register: %x ret: %d\n",
1231 if (map
->cache_only
) {
1232 map
->cache_dirty
= true;
1237 range
= _regmap_range_lookup(map
, reg
);
1239 int val_num
= val_len
/ map
->format
.val_bytes
;
1240 int win_offset
= (reg
- range
->range_min
) % range
->window_len
;
1241 int win_residue
= range
->window_len
- win_offset
;
1243 /* If the write goes beyond the end of the window split it */
1244 while (val_num
> win_residue
) {
1245 dev_dbg(map
->dev
, "Writing window %d/%zu\n",
1246 win_residue
, val_len
/ map
->format
.val_bytes
);
1247 ret
= _regmap_raw_write(map
, reg
, val
, win_residue
*
1248 map
->format
.val_bytes
);
1253 val_num
-= win_residue
;
1254 val
+= win_residue
* map
->format
.val_bytes
;
1255 val_len
-= win_residue
* map
->format
.val_bytes
;
1257 win_offset
= (reg
- range
->range_min
) %
1259 win_residue
= range
->window_len
- win_offset
;
1262 ret
= _regmap_select_page(map
, ®
, range
, val_num
);
1267 map
->format
.format_reg(map
->work_buf
, reg
, map
->reg_shift
);
1269 u8
[0] |= map
->write_flag_mask
;
1272 * Essentially all I/O mechanisms will be faster with a single
1273 * buffer to write. Since register syncs often generate raw
1274 * writes of single registers optimise that case.
1276 if (val
!= work_val
&& val_len
== map
->format
.val_bytes
) {
1277 memcpy(work_val
, val
, map
->format
.val_bytes
);
1281 if (map
->async
&& map
->bus
->async_write
) {
1282 struct regmap_async
*async
;
1284 trace_regmap_async_write_start(map
, reg
, val_len
);
1286 spin_lock_irqsave(&map
->async_lock
, flags
);
1287 async
= list_first_entry_or_null(&map
->async_free
,
1288 struct regmap_async
,
1291 list_del(&async
->list
);
1292 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1295 async
= map
->bus
->async_alloc();
1299 async
->work_buf
= kzalloc(map
->format
.buf_size
,
1300 GFP_KERNEL
| GFP_DMA
);
1301 if (!async
->work_buf
) {
1309 /* If the caller supplied the value we can use it safely. */
1310 memcpy(async
->work_buf
, map
->work_buf
, map
->format
.pad_bytes
+
1311 map
->format
.reg_bytes
+ map
->format
.val_bytes
);
1313 spin_lock_irqsave(&map
->async_lock
, flags
);
1314 list_add_tail(&async
->list
, &map
->async_list
);
1315 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1317 if (val
!= work_val
)
1318 ret
= map
->bus
->async_write(map
->bus_context
,
1320 map
->format
.reg_bytes
+
1321 map
->format
.pad_bytes
,
1322 val
, val_len
, async
);
1324 ret
= map
->bus
->async_write(map
->bus_context
,
1326 map
->format
.reg_bytes
+
1327 map
->format
.pad_bytes
+
1328 val_len
, NULL
, 0, async
);
1331 dev_err(map
->dev
, "Failed to schedule write: %d\n",
1334 spin_lock_irqsave(&map
->async_lock
, flags
);
1335 list_move(&async
->list
, &map
->async_free
);
1336 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1342 trace_regmap_hw_write_start(map
, reg
, val_len
/ map
->format
.val_bytes
);
1344 /* If we're doing a single register write we can probably just
1345 * send the work_buf directly, otherwise try to do a gather
1348 if (val
== work_val
)
1349 ret
= map
->bus
->write(map
->bus_context
, map
->work_buf
,
1350 map
->format
.reg_bytes
+
1351 map
->format
.pad_bytes
+
1353 else if (map
->bus
->gather_write
)
1354 ret
= map
->bus
->gather_write(map
->bus_context
, map
->work_buf
,
1355 map
->format
.reg_bytes
+
1356 map
->format
.pad_bytes
,
1359 /* If that didn't work fall back on linearising by hand. */
1360 if (ret
== -ENOTSUPP
) {
1361 len
= map
->format
.reg_bytes
+ map
->format
.pad_bytes
+ val_len
;
1362 buf
= kzalloc(len
, GFP_KERNEL
);
1366 memcpy(buf
, map
->work_buf
, map
->format
.reg_bytes
);
1367 memcpy(buf
+ map
->format
.reg_bytes
+ map
->format
.pad_bytes
,
1369 ret
= map
->bus
->write(map
->bus_context
, buf
, len
);
1374 trace_regmap_hw_write_done(map
, reg
, val_len
/ map
->format
.val_bytes
);
1380 * regmap_can_raw_write - Test if regmap_raw_write() is supported
1382 * @map: Map to check.
1384 bool regmap_can_raw_write(struct regmap
*map
)
1386 return map
->bus
&& map
->format
.format_val
&& map
->format
.format_reg
;
1388 EXPORT_SYMBOL_GPL(regmap_can_raw_write
);
1390 static int _regmap_bus_formatted_write(void *context
, unsigned int reg
,
1394 struct regmap_range_node
*range
;
1395 struct regmap
*map
= context
;
1397 WARN_ON(!map
->bus
|| !map
->format
.format_write
);
1399 range
= _regmap_range_lookup(map
, reg
);
1401 ret
= _regmap_select_page(map
, ®
, range
, 1);
1406 map
->format
.format_write(map
, reg
, val
);
1408 trace_regmap_hw_write_start(map
, reg
, 1);
1410 ret
= map
->bus
->write(map
->bus_context
, map
->work_buf
,
1411 map
->format
.buf_size
);
1413 trace_regmap_hw_write_done(map
, reg
, 1);
1418 static int _regmap_bus_reg_write(void *context
, unsigned int reg
,
1421 struct regmap
*map
= context
;
1423 return map
->bus
->reg_write(map
->bus_context
, reg
, val
);
1426 static int _regmap_bus_raw_write(void *context
, unsigned int reg
,
1429 struct regmap
*map
= context
;
1431 WARN_ON(!map
->bus
|| !map
->format
.format_val
);
1433 map
->format
.format_val(map
->work_buf
+ map
->format
.reg_bytes
1434 + map
->format
.pad_bytes
, val
, 0);
1435 return _regmap_raw_write(map
, reg
,
1437 map
->format
.reg_bytes
+
1438 map
->format
.pad_bytes
,
1439 map
->format
.val_bytes
);
1442 static inline void *_regmap_map_get_context(struct regmap
*map
)
1444 return (map
->bus
) ? map
: map
->bus_context
;
1447 int _regmap_write(struct regmap
*map
, unsigned int reg
,
1451 void *context
= _regmap_map_get_context(map
);
1453 if (!regmap_writeable(map
, reg
))
1456 if (!map
->cache_bypass
&& !map
->defer_caching
) {
1457 ret
= regcache_write(map
, reg
, val
);
1460 if (map
->cache_only
) {
1461 map
->cache_dirty
= true;
1467 if (map
->dev
&& strcmp(dev_name(map
->dev
), LOG_DEVICE
) == 0)
1468 dev_info(map
->dev
, "%x <= %x\n", reg
, val
);
1471 trace_regmap_reg_write(map
, reg
, val
);
1473 return map
->reg_write(context
, reg
, val
);
1477 * regmap_write(): Write a value to a single register
1479 * @map: Register map to write to
1480 * @reg: Register to write to
1481 * @val: Value to be written
1483 * A value of zero will be returned on success, a negative errno will
1484 * be returned in error cases.
1486 int regmap_write(struct regmap
*map
, unsigned int reg
, unsigned int val
)
1490 if (reg
% map
->reg_stride
)
1493 map
->lock(map
->lock_arg
);
1495 ret
= _regmap_write(map
, reg
, val
);
1497 map
->unlock(map
->lock_arg
);
1501 EXPORT_SYMBOL_GPL(regmap_write
);
1504 * regmap_write_async(): Write a value to a single register asynchronously
1506 * @map: Register map to write to
1507 * @reg: Register to write to
1508 * @val: Value to be written
1510 * A value of zero will be returned on success, a negative errno will
1511 * be returned in error cases.
1513 int regmap_write_async(struct regmap
*map
, unsigned int reg
, unsigned int val
)
1517 if (reg
% map
->reg_stride
)
1520 map
->lock(map
->lock_arg
);
1524 ret
= _regmap_write(map
, reg
, val
);
1528 map
->unlock(map
->lock_arg
);
1532 EXPORT_SYMBOL_GPL(regmap_write_async
);
1535 * regmap_raw_write(): Write raw values to one or more registers
1537 * @map: Register map to write to
1538 * @reg: Initial register to write to
1539 * @val: Block of data to be written, laid out for direct transmission to the
1541 * @val_len: Length of data pointed to by val.
1543 * This function is intended to be used for things like firmware
1544 * download where a large block of data needs to be transferred to the
1545 * device. No formatting will be done on the data provided.
1547 * A value of zero will be returned on success, a negative errno will
1548 * be returned in error cases.
1550 int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
1551 const void *val
, size_t val_len
)
1555 if (!regmap_can_raw_write(map
))
1557 if (val_len
% map
->format
.val_bytes
)
1560 map
->lock(map
->lock_arg
);
1562 ret
= _regmap_raw_write(map
, reg
, val
, val_len
);
1564 map
->unlock(map
->lock_arg
);
1568 EXPORT_SYMBOL_GPL(regmap_raw_write
);
1571 * regmap_field_write(): Write a value to a single register field
1573 * @field: Register field to write to
1574 * @val: Value to be written
1576 * A value of zero will be returned on success, a negative errno will
1577 * be returned in error cases.
1579 int regmap_field_write(struct regmap_field
*field
, unsigned int val
)
1581 return regmap_update_bits(field
->regmap
, field
->reg
,
1582 field
->mask
, val
<< field
->shift
);
1584 EXPORT_SYMBOL_GPL(regmap_field_write
);
1587 * regmap_field_update_bits(): Perform a read/modify/write cycle
1588 * on the register field
1590 * @field: Register field to write to
1591 * @mask: Bitmask to change
1592 * @val: Value to be written
1594 * A value of zero will be returned on success, a negative errno will
1595 * be returned in error cases.
1597 int regmap_field_update_bits(struct regmap_field
*field
, unsigned int mask
, unsigned int val
)
1599 mask
= (mask
<< field
->shift
) & field
->mask
;
1601 return regmap_update_bits(field
->regmap
, field
->reg
,
1602 mask
, val
<< field
->shift
);
1604 EXPORT_SYMBOL_GPL(regmap_field_update_bits
);
1607 * regmap_fields_write(): Write a value to a single register field with port ID
1609 * @field: Register field to write to
1611 * @val: Value to be written
1613 * A value of zero will be returned on success, a negative errno will
1614 * be returned in error cases.
1616 int regmap_fields_write(struct regmap_field
*field
, unsigned int id
,
1619 if (id
>= field
->id_size
)
1622 return regmap_update_bits(field
->regmap
,
1623 field
->reg
+ (field
->id_offset
* id
),
1624 field
->mask
, val
<< field
->shift
);
1626 EXPORT_SYMBOL_GPL(regmap_fields_write
);
1629 * regmap_fields_update_bits(): Perform a read/modify/write cycle
1630 * on the register field
1632 * @field: Register field to write to
1634 * @mask: Bitmask to change
1635 * @val: Value to be written
1637 * A value of zero will be returned on success, a negative errno will
1638 * be returned in error cases.
1640 int regmap_fields_update_bits(struct regmap_field
*field
, unsigned int id
,
1641 unsigned int mask
, unsigned int val
)
1643 if (id
>= field
->id_size
)
1646 mask
= (mask
<< field
->shift
) & field
->mask
;
1648 return regmap_update_bits(field
->regmap
,
1649 field
->reg
+ (field
->id_offset
* id
),
1650 mask
, val
<< field
->shift
);
1652 EXPORT_SYMBOL_GPL(regmap_fields_update_bits
);
1655 * regmap_bulk_write(): Write multiple registers to the device
1657 * @map: Register map to write to
1658 * @reg: First register to be write from
1659 * @val: Block of data to be written, in native register size for device
1660 * @val_count: Number of registers to write
1662 * This function is intended to be used for writing a large block of
1663 * data to the device either in single transfer or multiple transfer.
1665 * A value of zero will be returned on success, a negative errno will
1666 * be returned in error cases.
1668 int regmap_bulk_write(struct regmap
*map
, unsigned int reg
, const void *val
,
1672 size_t val_bytes
= map
->format
.val_bytes
;
1674 if (map
->bus
&& !map
->format
.parse_inplace
)
1676 if (reg
% map
->reg_stride
)
1680 * Some devices don't support bulk write, for
1681 * them we have a series of single write operations.
1683 if (!map
->bus
|| map
->use_single_rw
) {
1684 map
->lock(map
->lock_arg
);
1685 for (i
= 0; i
< val_count
; i
++) {
1688 switch (val_bytes
) {
1690 ival
= *(u8
*)(val
+ (i
* val_bytes
));
1693 ival
= *(u16
*)(val
+ (i
* val_bytes
));
1696 ival
= *(u32
*)(val
+ (i
* val_bytes
));
1700 ival
= *(u64
*)(val
+ (i
* val_bytes
));
1708 ret
= _regmap_write(map
, reg
+ (i
* map
->reg_stride
),
1714 map
->unlock(map
->lock_arg
);
1721 wval
= kmemdup(val
, val_count
* val_bytes
, GFP_KERNEL
);
1723 dev_err(map
->dev
, "Error in memory allocation\n");
1726 for (i
= 0; i
< val_count
* val_bytes
; i
+= val_bytes
)
1727 map
->format
.parse_inplace(wval
+ i
);
1729 map
->lock(map
->lock_arg
);
1730 ret
= _regmap_raw_write(map
, reg
, wval
, val_bytes
* val_count
);
1731 map
->unlock(map
->lock_arg
);
1737 EXPORT_SYMBOL_GPL(regmap_bulk_write
);
1740 * _regmap_raw_multi_reg_write()
1742 * the (register,newvalue) pairs in regs have not been formatted, but
1743 * they are all in the same page and have been changed to being page
1744 * relative. The page register has been written if that was neccessary.
1746 static int _regmap_raw_multi_reg_write(struct regmap
*map
,
1747 const struct reg_sequence
*regs
,
1754 size_t val_bytes
= map
->format
.val_bytes
;
1755 size_t reg_bytes
= map
->format
.reg_bytes
;
1756 size_t pad_bytes
= map
->format
.pad_bytes
;
1757 size_t pair_size
= reg_bytes
+ pad_bytes
+ val_bytes
;
1758 size_t len
= pair_size
* num_regs
;
1763 buf
= kzalloc(len
, GFP_KERNEL
);
1767 /* We have to linearise by hand. */
1771 for (i
= 0; i
< num_regs
; i
++) {
1772 int reg
= regs
[i
].reg
;
1773 int val
= regs
[i
].def
;
1774 trace_regmap_hw_write_start(map
, reg
, 1);
1775 map
->format
.format_reg(u8
, reg
, map
->reg_shift
);
1776 u8
+= reg_bytes
+ pad_bytes
;
1777 map
->format
.format_val(u8
, val
, 0);
1781 *u8
|= map
->write_flag_mask
;
1783 ret
= map
->bus
->write(map
->bus_context
, buf
, len
);
1787 for (i
= 0; i
< num_regs
; i
++) {
1788 int reg
= regs
[i
].reg
;
1789 trace_regmap_hw_write_done(map
, reg
, 1);
1794 static unsigned int _regmap_register_page(struct regmap
*map
,
1796 struct regmap_range_node
*range
)
1798 unsigned int win_page
= (reg
- range
->range_min
) / range
->window_len
;
1803 static int _regmap_range_multi_paged_reg_write(struct regmap
*map
,
1804 struct reg_sequence
*regs
,
1809 struct reg_sequence
*base
;
1810 unsigned int this_page
= 0;
1811 unsigned int page_change
= 0;
1813 * the set of registers are not neccessarily in order, but
1814 * since the order of write must be preserved this algorithm
1815 * chops the set each time the page changes. This also applies
1816 * if there is a delay required at any point in the sequence.
1819 for (i
= 0, n
= 0; i
< num_regs
; i
++, n
++) {
1820 unsigned int reg
= regs
[i
].reg
;
1821 struct regmap_range_node
*range
;
1823 range
= _regmap_range_lookup(map
, reg
);
1825 unsigned int win_page
= _regmap_register_page(map
, reg
,
1829 this_page
= win_page
;
1830 if (win_page
!= this_page
) {
1831 this_page
= win_page
;
1836 /* If we have both a page change and a delay make sure to
1837 * write the regs and apply the delay before we change the
1841 if (page_change
|| regs
[i
].delay_us
) {
1843 /* For situations where the first write requires
1844 * a delay we need to make sure we don't call
1845 * raw_multi_reg_write with n=0
1846 * This can't occur with page breaks as we
1847 * never write on the first iteration
1849 if (regs
[i
].delay_us
&& i
== 0)
1852 ret
= _regmap_raw_multi_reg_write(map
, base
, n
);
1856 if (regs
[i
].delay_us
)
1857 udelay(regs
[i
].delay_us
);
1863 ret
= _regmap_select_page(map
,
1876 return _regmap_raw_multi_reg_write(map
, base
, n
);
1880 static int _regmap_multi_reg_write(struct regmap
*map
,
1881 const struct reg_sequence
*regs
,
1887 if (!map
->can_multi_write
) {
1888 for (i
= 0; i
< num_regs
; i
++) {
1889 ret
= _regmap_write(map
, regs
[i
].reg
, regs
[i
].def
);
1893 if (regs
[i
].delay_us
)
1894 udelay(regs
[i
].delay_us
);
1899 if (!map
->format
.parse_inplace
)
1902 if (map
->writeable_reg
)
1903 for (i
= 0; i
< num_regs
; i
++) {
1904 int reg
= regs
[i
].reg
;
1905 if (!map
->writeable_reg(map
->dev
, reg
))
1907 if (reg
% map
->reg_stride
)
1911 if (!map
->cache_bypass
) {
1912 for (i
= 0; i
< num_regs
; i
++) {
1913 unsigned int val
= regs
[i
].def
;
1914 unsigned int reg
= regs
[i
].reg
;
1915 ret
= regcache_write(map
, reg
, val
);
1918 "Error in caching of register: %x ret: %d\n",
1923 if (map
->cache_only
) {
1924 map
->cache_dirty
= true;
1931 for (i
= 0; i
< num_regs
; i
++) {
1932 unsigned int reg
= regs
[i
].reg
;
1933 struct regmap_range_node
*range
;
1935 /* Coalesce all the writes between a page break or a delay
1938 range
= _regmap_range_lookup(map
, reg
);
1939 if (range
|| regs
[i
].delay_us
) {
1940 size_t len
= sizeof(struct reg_sequence
)*num_regs
;
1941 struct reg_sequence
*base
= kmemdup(regs
, len
,
1945 ret
= _regmap_range_multi_paged_reg_write(map
, base
,
1952 return _regmap_raw_multi_reg_write(map
, regs
, num_regs
);
1956 * regmap_multi_reg_write(): Write multiple registers to the device
1958 * where the set of register,value pairs are supplied in any order,
1959 * possibly not all in a single range.
1961 * @map: Register map to write to
1962 * @regs: Array of structures containing register,value to be written
1963 * @num_regs: Number of registers to write
1965 * The 'normal' block write mode will send ultimately send data on the
1966 * target bus as R,V1,V2,V3,..,Vn where successively higer registers are
1967 * addressed. However, this alternative block multi write mode will send
1968 * the data as R1,V1,R2,V2,..,Rn,Vn on the target bus. The target device
1969 * must of course support the mode.
1971 * A value of zero will be returned on success, a negative errno will be
1972 * returned in error cases.
1974 int regmap_multi_reg_write(struct regmap
*map
, const struct reg_sequence
*regs
,
1979 map
->lock(map
->lock_arg
);
1981 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
1983 map
->unlock(map
->lock_arg
);
1987 EXPORT_SYMBOL_GPL(regmap_multi_reg_write
);
1990 * regmap_multi_reg_write_bypassed(): Write multiple registers to the
1991 * device but not the cache
1993 * where the set of register are supplied in any order
1995 * @map: Register map to write to
1996 * @regs: Array of structures containing register,value to be written
1997 * @num_regs: Number of registers to write
1999 * This function is intended to be used for writing a large block of data
2000 * atomically to the device in single transfer for those I2C client devices
2001 * that implement this alternative block write mode.
2003 * A value of zero will be returned on success, a negative errno will
2004 * be returned in error cases.
2006 int regmap_multi_reg_write_bypassed(struct regmap
*map
,
2007 const struct reg_sequence
*regs
,
2013 map
->lock(map
->lock_arg
);
2015 bypass
= map
->cache_bypass
;
2016 map
->cache_bypass
= true;
2018 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
2020 map
->cache_bypass
= bypass
;
2022 map
->unlock(map
->lock_arg
);
2026 EXPORT_SYMBOL_GPL(regmap_multi_reg_write_bypassed
);
2029 * regmap_raw_write_async(): Write raw values to one or more registers
2032 * @map: Register map to write to
2033 * @reg: Initial register to write to
2034 * @val: Block of data to be written, laid out for direct transmission to the
2035 * device. Must be valid until regmap_async_complete() is called.
2036 * @val_len: Length of data pointed to by val.
2038 * This function is intended to be used for things like firmware
2039 * download where a large block of data needs to be transferred to the
2040 * device. No formatting will be done on the data provided.
2042 * If supported by the underlying bus the write will be scheduled
2043 * asynchronously, helping maximise I/O speed on higher speed buses
2044 * like SPI. regmap_async_complete() can be called to ensure that all
2045 * asynchrnous writes have been completed.
2047 * A value of zero will be returned on success, a negative errno will
2048 * be returned in error cases.
2050 int regmap_raw_write_async(struct regmap
*map
, unsigned int reg
,
2051 const void *val
, size_t val_len
)
2055 if (val_len
% map
->format
.val_bytes
)
2057 if (reg
% map
->reg_stride
)
2060 map
->lock(map
->lock_arg
);
2064 ret
= _regmap_raw_write(map
, reg
, val
, val_len
);
2068 map
->unlock(map
->lock_arg
);
2072 EXPORT_SYMBOL_GPL(regmap_raw_write_async
);
2074 static int _regmap_raw_read(struct regmap
*map
, unsigned int reg
, void *val
,
2075 unsigned int val_len
)
2077 struct regmap_range_node
*range
;
2078 u8
*u8
= map
->work_buf
;
2083 range
= _regmap_range_lookup(map
, reg
);
2085 ret
= _regmap_select_page(map
, ®
, range
,
2086 val_len
/ map
->format
.val_bytes
);
2091 map
->format
.format_reg(map
->work_buf
, reg
, map
->reg_shift
);
2094 * Some buses or devices flag reads by setting the high bits in the
2095 * register addresss; since it's always the high bits for all
2096 * current formats we can do this here rather than in
2097 * formatting. This may break if we get interesting formats.
2099 u8
[0] |= map
->read_flag_mask
;
2101 trace_regmap_hw_read_start(map
, reg
, val_len
/ map
->format
.val_bytes
);
2103 ret
= map
->bus
->read(map
->bus_context
, map
->work_buf
,
2104 map
->format
.reg_bytes
+ map
->format
.pad_bytes
,
2107 trace_regmap_hw_read_done(map
, reg
, val_len
/ map
->format
.val_bytes
);
2112 static int _regmap_bus_reg_read(void *context
, unsigned int reg
,
2115 struct regmap
*map
= context
;
2117 return map
->bus
->reg_read(map
->bus_context
, reg
, val
);
2120 static int _regmap_bus_read(void *context
, unsigned int reg
,
2124 struct regmap
*map
= context
;
2126 if (!map
->format
.parse_val
)
2129 ret
= _regmap_raw_read(map
, reg
, map
->work_buf
, map
->format
.val_bytes
);
2131 *val
= map
->format
.parse_val(map
->work_buf
);
2136 static int _regmap_read(struct regmap
*map
, unsigned int reg
,
2140 void *context
= _regmap_map_get_context(map
);
2142 WARN_ON(!map
->reg_read
);
2144 if (!map
->cache_bypass
) {
2145 ret
= regcache_read(map
, reg
, val
);
2150 if (map
->cache_only
)
2153 if (!regmap_readable(map
, reg
))
2156 ret
= map
->reg_read(context
, reg
, val
);
2159 if (map
->dev
&& strcmp(dev_name(map
->dev
), LOG_DEVICE
) == 0)
2160 dev_info(map
->dev
, "%x => %x\n", reg
, *val
);
2163 trace_regmap_reg_read(map
, reg
, *val
);
2165 if (!map
->cache_bypass
)
2166 regcache_write(map
, reg
, *val
);
2173 * regmap_read(): Read a value from a single register
2175 * @map: Register map to read from
2176 * @reg: Register to be read from
2177 * @val: Pointer to store read value
2179 * A value of zero will be returned on success, a negative errno will
2180 * be returned in error cases.
2182 int regmap_read(struct regmap
*map
, unsigned int reg
, unsigned int *val
)
2186 if (reg
% map
->reg_stride
)
2189 map
->lock(map
->lock_arg
);
2191 ret
= _regmap_read(map
, reg
, val
);
2193 map
->unlock(map
->lock_arg
);
2197 EXPORT_SYMBOL_GPL(regmap_read
);
2200 * regmap_raw_read(): Read raw data from the device
2202 * @map: Register map to read from
2203 * @reg: First register to be read from
2204 * @val: Pointer to store read value
2205 * @val_len: Size of data to read
2207 * A value of zero will be returned on success, a negative errno will
2208 * be returned in error cases.
2210 int regmap_raw_read(struct regmap
*map
, unsigned int reg
, void *val
,
2213 size_t val_bytes
= map
->format
.val_bytes
;
2214 size_t val_count
= val_len
/ val_bytes
;
2220 if (val_len
% map
->format
.val_bytes
)
2222 if (reg
% map
->reg_stride
)
2225 map
->lock(map
->lock_arg
);
2227 if (regmap_volatile_range(map
, reg
, val_count
) || map
->cache_bypass
||
2228 map
->cache_type
== REGCACHE_NONE
) {
2229 /* Physical block read if there's no cache involved */
2230 ret
= _regmap_raw_read(map
, reg
, val
, val_len
);
2233 /* Otherwise go word by word for the cache; should be low
2234 * cost as we expect to hit the cache.
2236 for (i
= 0; i
< val_count
; i
++) {
2237 ret
= _regmap_read(map
, reg
+ (i
* map
->reg_stride
),
2242 map
->format
.format_val(val
+ (i
* val_bytes
), v
, 0);
2247 map
->unlock(map
->lock_arg
);
2251 EXPORT_SYMBOL_GPL(regmap_raw_read
);
2254 * regmap_field_read(): Read a value to a single register field
2256 * @field: Register field to read from
2257 * @val: Pointer to store read value
2259 * A value of zero will be returned on success, a negative errno will
2260 * be returned in error cases.
2262 int regmap_field_read(struct regmap_field
*field
, unsigned int *val
)
2265 unsigned int reg_val
;
2266 ret
= regmap_read(field
->regmap
, field
->reg
, ®_val
);
2270 reg_val
&= field
->mask
;
2271 reg_val
>>= field
->shift
;
2276 EXPORT_SYMBOL_GPL(regmap_field_read
);
2279 * regmap_fields_read(): Read a value to a single register field with port ID
2281 * @field: Register field to read from
2283 * @val: Pointer to store read value
2285 * A value of zero will be returned on success, a negative errno will
2286 * be returned in error cases.
2288 int regmap_fields_read(struct regmap_field
*field
, unsigned int id
,
2292 unsigned int reg_val
;
2294 if (id
>= field
->id_size
)
2297 ret
= regmap_read(field
->regmap
,
2298 field
->reg
+ (field
->id_offset
* id
),
2303 reg_val
&= field
->mask
;
2304 reg_val
>>= field
->shift
;
2309 EXPORT_SYMBOL_GPL(regmap_fields_read
);
2312 * regmap_bulk_read(): Read multiple registers from the device
2314 * @map: Register map to read from
2315 * @reg: First register to be read from
2316 * @val: Pointer to store read value, in native register size for device
2317 * @val_count: Number of registers to read
2319 * A value of zero will be returned on success, a negative errno will
2320 * be returned in error cases.
2322 int regmap_bulk_read(struct regmap
*map
, unsigned int reg
, void *val
,
2326 size_t val_bytes
= map
->format
.val_bytes
;
2327 bool vol
= regmap_volatile_range(map
, reg
, val_count
);
2329 if (reg
% map
->reg_stride
)
2332 if (map
->bus
&& map
->format
.parse_inplace
&& (vol
|| map
->cache_type
== REGCACHE_NONE
)) {
2334 * Some devices does not support bulk read, for
2335 * them we have a series of single read operations.
2337 if (map
->use_single_rw
) {
2338 for (i
= 0; i
< val_count
; i
++) {
2339 ret
= regmap_raw_read(map
,
2340 reg
+ (i
* map
->reg_stride
),
2341 val
+ (i
* val_bytes
),
2347 ret
= regmap_raw_read(map
, reg
, val
,
2348 val_bytes
* val_count
);
2353 for (i
= 0; i
< val_count
* val_bytes
; i
+= val_bytes
)
2354 map
->format
.parse_inplace(val
+ i
);
2356 for (i
= 0; i
< val_count
; i
++) {
2358 ret
= regmap_read(map
, reg
+ (i
* map
->reg_stride
),
2362 map
->format
.format_val(val
+ (i
* val_bytes
), ival
, 0);
2368 EXPORT_SYMBOL_GPL(regmap_bulk_read
);
2370 static int _regmap_update_bits(struct regmap
*map
, unsigned int reg
,
2371 unsigned int mask
, unsigned int val
,
2375 unsigned int tmp
, orig
;
2377 ret
= _regmap_read(map
, reg
, &orig
);
2385 ret
= _regmap_write(map
, reg
, tmp
);
2397 * regmap_update_bits: Perform a read/modify/write cycle on the register map
2399 * @map: Register map to update
2400 * @reg: Register to update
2401 * @mask: Bitmask to change
2402 * @val: New value for bitmask
2404 * Returns zero for success, a negative number on error.
2406 int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
2407 unsigned int mask
, unsigned int val
)
2411 map
->lock(map
->lock_arg
);
2412 ret
= _regmap_update_bits(map
, reg
, mask
, val
, NULL
);
2413 map
->unlock(map
->lock_arg
);
2417 EXPORT_SYMBOL_GPL(regmap_update_bits
);
2420 * regmap_update_bits_async: Perform a read/modify/write cycle on the register
2421 * map asynchronously
2423 * @map: Register map to update
2424 * @reg: Register to update
2425 * @mask: Bitmask to change
2426 * @val: New value for bitmask
2428 * With most buses the read must be done synchronously so this is most
2429 * useful for devices with a cache which do not need to interact with
2430 * the hardware to determine the current register value.
2432 * Returns zero for success, a negative number on error.
2434 int regmap_update_bits_async(struct regmap
*map
, unsigned int reg
,
2435 unsigned int mask
, unsigned int val
)
2439 map
->lock(map
->lock_arg
);
2443 ret
= _regmap_update_bits(map
, reg
, mask
, val
, NULL
);
2447 map
->unlock(map
->lock_arg
);
2451 EXPORT_SYMBOL_GPL(regmap_update_bits_async
);
2454 * regmap_update_bits_check: Perform a read/modify/write cycle on the
2455 * register map and report if updated
2457 * @map: Register map to update
2458 * @reg: Register to update
2459 * @mask: Bitmask to change
2460 * @val: New value for bitmask
2461 * @change: Boolean indicating if a write was done
2463 * Returns zero for success, a negative number on error.
2465 int regmap_update_bits_check(struct regmap
*map
, unsigned int reg
,
2466 unsigned int mask
, unsigned int val
,
2471 map
->lock(map
->lock_arg
);
2472 ret
= _regmap_update_bits(map
, reg
, mask
, val
, change
);
2473 map
->unlock(map
->lock_arg
);
2476 EXPORT_SYMBOL_GPL(regmap_update_bits_check
);
2479 * regmap_update_bits_check_async: Perform a read/modify/write cycle on the
2480 * register map asynchronously and report if
2483 * @map: Register map to update
2484 * @reg: Register to update
2485 * @mask: Bitmask to change
2486 * @val: New value for bitmask
2487 * @change: Boolean indicating if a write was done
2489 * With most buses the read must be done synchronously so this is most
2490 * useful for devices with a cache which do not need to interact with
2491 * the hardware to determine the current register value.
2493 * Returns zero for success, a negative number on error.
2495 int regmap_update_bits_check_async(struct regmap
*map
, unsigned int reg
,
2496 unsigned int mask
, unsigned int val
,
2501 map
->lock(map
->lock_arg
);
2505 ret
= _regmap_update_bits(map
, reg
, mask
, val
, change
);
2509 map
->unlock(map
->lock_arg
);
2513 EXPORT_SYMBOL_GPL(regmap_update_bits_check_async
);
2515 void regmap_async_complete_cb(struct regmap_async
*async
, int ret
)
2517 struct regmap
*map
= async
->map
;
2520 trace_regmap_async_io_complete(map
);
2522 spin_lock(&map
->async_lock
);
2523 list_move(&async
->list
, &map
->async_free
);
2524 wake
= list_empty(&map
->async_list
);
2527 map
->async_ret
= ret
;
2529 spin_unlock(&map
->async_lock
);
2532 wake_up(&map
->async_waitq
);
2534 EXPORT_SYMBOL_GPL(regmap_async_complete_cb
);
2536 static int regmap_async_is_done(struct regmap
*map
)
2538 unsigned long flags
;
2541 spin_lock_irqsave(&map
->async_lock
, flags
);
2542 ret
= list_empty(&map
->async_list
);
2543 spin_unlock_irqrestore(&map
->async_lock
, flags
);
2549 * regmap_async_complete: Ensure all asynchronous I/O has completed.
2551 * @map: Map to operate on.
2553 * Blocks until any pending asynchronous I/O has completed. Returns
2554 * an error code for any failed I/O operations.
2556 int regmap_async_complete(struct regmap
*map
)
2558 unsigned long flags
;
2561 /* Nothing to do with no async support */
2562 if (!map
->bus
|| !map
->bus
->async_write
)
2565 trace_regmap_async_complete_start(map
);
2567 wait_event(map
->async_waitq
, regmap_async_is_done(map
));
2569 spin_lock_irqsave(&map
->async_lock
, flags
);
2570 ret
= map
->async_ret
;
2572 spin_unlock_irqrestore(&map
->async_lock
, flags
);
2574 trace_regmap_async_complete_done(map
);
2578 EXPORT_SYMBOL_GPL(regmap_async_complete
);
2581 * regmap_register_patch: Register and apply register updates to be applied
2582 * on device initialistion
2584 * @map: Register map to apply updates to.
2585 * @regs: Values to update.
2586 * @num_regs: Number of entries in regs.
2588 * Register a set of register updates to be applied to the device
2589 * whenever the device registers are synchronised with the cache and
2590 * apply them immediately. Typically this is used to apply
2591 * corrections to be applied to the device defaults on startup, such
2592 * as the updates some vendors provide to undocumented registers.
2594 * The caller must ensure that this function cannot be called
2595 * concurrently with either itself or regcache_sync().
2597 int regmap_register_patch(struct regmap
*map
, const struct reg_sequence
*regs
,
2600 struct reg_sequence
*p
;
2604 if (WARN_ONCE(num_regs
<= 0, "invalid registers number (%d)\n",
2608 p
= krealloc(map
->patch
,
2609 sizeof(struct reg_sequence
) * (map
->patch_regs
+ num_regs
),
2612 memcpy(p
+ map
->patch_regs
, regs
, num_regs
* sizeof(*regs
));
2614 map
->patch_regs
+= num_regs
;
2619 map
->lock(map
->lock_arg
);
2621 bypass
= map
->cache_bypass
;
2623 map
->cache_bypass
= true;
2626 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
2629 map
->cache_bypass
= bypass
;
2631 map
->unlock(map
->lock_arg
);
2633 regmap_async_complete(map
);
2637 EXPORT_SYMBOL_GPL(regmap_register_patch
);
2640 * regmap_get_val_bytes(): Report the size of a register value
2642 * Report the size of a register value, mainly intended to for use by
2643 * generic infrastructure built on top of regmap.
2645 int regmap_get_val_bytes(struct regmap
*map
)
2647 if (map
->format
.format_write
)
2650 return map
->format
.val_bytes
;
2652 EXPORT_SYMBOL_GPL(regmap_get_val_bytes
);
2655 * regmap_get_max_register(): Report the max register value
2657 * Report the max register value, mainly intended to for use by
2658 * generic infrastructure built on top of regmap.
2660 int regmap_get_max_register(struct regmap
*map
)
2662 return map
->max_register
? map
->max_register
: -EINVAL
;
2664 EXPORT_SYMBOL_GPL(regmap_get_max_register
);
2667 * regmap_get_reg_stride(): Report the register address stride
2669 * Report the register address stride, mainly intended to for use by
2670 * generic infrastructure built on top of regmap.
2672 int regmap_get_reg_stride(struct regmap
*map
)
2674 return map
->reg_stride
;
2676 EXPORT_SYMBOL_GPL(regmap_get_reg_stride
);
2678 int regmap_parse_val(struct regmap
*map
, const void *buf
,
2681 if (!map
->format
.parse_val
)
2684 *val
= map
->format
.parse_val(buf
);
2688 EXPORT_SYMBOL_GPL(regmap_parse_val
);
2690 static int __init
regmap_initcall(void)
2692 regmap_debugfs_initcall();
2696 postcore_initcall(regmap_initcall
);