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>
22 #define CREATE_TRACE_POINTS
28 * Sometimes for failures during very early init the trace
29 * infrastructure isn't available early enough to be used. For this
30 * sort of problem defining LOG_DEVICE will add printks for basic
31 * register I/O on a specific device.
35 static int _regmap_update_bits(struct regmap
*map
, unsigned int reg
,
36 unsigned int mask
, unsigned int val
,
37 bool *change
, bool force_write
);
39 static int _regmap_bus_reg_read(void *context
, unsigned int reg
,
41 static int _regmap_bus_read(void *context
, unsigned int reg
,
43 static int _regmap_bus_formatted_write(void *context
, unsigned int reg
,
45 static int _regmap_bus_reg_write(void *context
, unsigned int reg
,
47 static int _regmap_bus_raw_write(void *context
, unsigned int reg
,
50 bool regmap_reg_in_ranges(unsigned int reg
,
51 const struct regmap_range
*ranges
,
54 const struct regmap_range
*r
;
57 for (i
= 0, r
= ranges
; i
< nranges
; i
++, r
++)
58 if (regmap_reg_in_range(reg
, r
))
62 EXPORT_SYMBOL_GPL(regmap_reg_in_ranges
);
64 bool regmap_check_range_table(struct regmap
*map
, unsigned int reg
,
65 const struct regmap_access_table
*table
)
67 /* Check "no ranges" first */
68 if (regmap_reg_in_ranges(reg
, table
->no_ranges
, table
->n_no_ranges
))
71 /* In case zero "yes ranges" are supplied, any reg is OK */
72 if (!table
->n_yes_ranges
)
75 return regmap_reg_in_ranges(reg
, table
->yes_ranges
,
78 EXPORT_SYMBOL_GPL(regmap_check_range_table
);
80 bool regmap_writeable(struct regmap
*map
, unsigned int reg
)
82 if (map
->max_register
&& reg
> map
->max_register
)
85 if (map
->writeable_reg
)
86 return map
->writeable_reg(map
->dev
, reg
);
89 return regmap_check_range_table(map
, reg
, map
->wr_table
);
94 bool regmap_readable(struct regmap
*map
, unsigned int reg
)
96 if (map
->max_register
&& reg
> map
->max_register
)
99 if (map
->format
.format_write
)
102 if (map
->readable_reg
)
103 return map
->readable_reg(map
->dev
, reg
);
106 return regmap_check_range_table(map
, reg
, map
->rd_table
);
111 bool regmap_volatile(struct regmap
*map
, unsigned int reg
)
113 if (!map
->format
.format_write
&& !regmap_readable(map
, reg
))
116 if (map
->volatile_reg
)
117 return map
->volatile_reg(map
->dev
, reg
);
119 if (map
->volatile_table
)
120 return regmap_check_range_table(map
, reg
, map
->volatile_table
);
128 bool regmap_precious(struct regmap
*map
, unsigned int reg
)
130 if (!regmap_readable(map
, reg
))
133 if (map
->precious_reg
)
134 return map
->precious_reg(map
->dev
, reg
);
136 if (map
->precious_table
)
137 return regmap_check_range_table(map
, reg
, map
->precious_table
);
142 static bool regmap_volatile_range(struct regmap
*map
, unsigned int reg
,
147 for (i
= 0; i
< num
; i
++)
148 if (!regmap_volatile(map
, reg
+ i
))
154 static void regmap_format_2_6_write(struct regmap
*map
,
155 unsigned int reg
, unsigned int val
)
157 u8
*out
= map
->work_buf
;
159 *out
= (reg
<< 6) | val
;
162 static void regmap_format_4_12_write(struct regmap
*map
,
163 unsigned int reg
, unsigned int val
)
165 __be16
*out
= map
->work_buf
;
166 *out
= cpu_to_be16((reg
<< 12) | val
);
169 static void regmap_format_7_9_write(struct regmap
*map
,
170 unsigned int reg
, unsigned int val
)
172 __be16
*out
= map
->work_buf
;
173 *out
= cpu_to_be16((reg
<< 9) | val
);
176 static void regmap_format_10_14_write(struct regmap
*map
,
177 unsigned int reg
, unsigned int val
)
179 u8
*out
= map
->work_buf
;
182 out
[1] = (val
>> 8) | (reg
<< 6);
186 static void regmap_format_8(void *buf
, unsigned int val
, unsigned int shift
)
193 static void regmap_format_16_be(void *buf
, unsigned int val
, unsigned int shift
)
197 b
[0] = cpu_to_be16(val
<< shift
);
200 static void regmap_format_16_le(void *buf
, unsigned int val
, unsigned int shift
)
204 b
[0] = cpu_to_le16(val
<< shift
);
207 static void regmap_format_16_native(void *buf
, unsigned int val
,
210 *(u16
*)buf
= val
<< shift
;
213 static void regmap_format_24(void *buf
, unsigned int val
, unsigned int shift
)
224 static void regmap_format_32_be(void *buf
, unsigned int val
, unsigned int shift
)
228 b
[0] = cpu_to_be32(val
<< shift
);
231 static void regmap_format_32_le(void *buf
, unsigned int val
, unsigned int shift
)
235 b
[0] = cpu_to_le32(val
<< shift
);
238 static void regmap_format_32_native(void *buf
, unsigned int val
,
241 *(u32
*)buf
= val
<< shift
;
244 static void regmap_parse_inplace_noop(void *buf
)
248 static unsigned int regmap_parse_8(const void *buf
)
255 static unsigned int regmap_parse_16_be(const void *buf
)
257 const __be16
*b
= buf
;
259 return be16_to_cpu(b
[0]);
262 static unsigned int regmap_parse_16_le(const void *buf
)
264 const __le16
*b
= buf
;
266 return le16_to_cpu(b
[0]);
269 static void regmap_parse_16_be_inplace(void *buf
)
273 b
[0] = be16_to_cpu(b
[0]);
276 static void regmap_parse_16_le_inplace(void *buf
)
280 b
[0] = le16_to_cpu(b
[0]);
283 static unsigned int regmap_parse_16_native(const void *buf
)
288 static unsigned int regmap_parse_24(const void *buf
)
291 unsigned int ret
= b
[2];
292 ret
|= ((unsigned int)b
[1]) << 8;
293 ret
|= ((unsigned int)b
[0]) << 16;
298 static unsigned int regmap_parse_32_be(const void *buf
)
300 const __be32
*b
= buf
;
302 return be32_to_cpu(b
[0]);
305 static unsigned int regmap_parse_32_le(const void *buf
)
307 const __le32
*b
= buf
;
309 return le32_to_cpu(b
[0]);
312 static void regmap_parse_32_be_inplace(void *buf
)
316 b
[0] = be32_to_cpu(b
[0]);
319 static void regmap_parse_32_le_inplace(void *buf
)
323 b
[0] = le32_to_cpu(b
[0]);
326 static unsigned int regmap_parse_32_native(const void *buf
)
331 static void regmap_lock_mutex(void *__map
)
333 struct regmap
*map
= __map
;
334 mutex_lock(&map
->mutex
);
337 static void regmap_unlock_mutex(void *__map
)
339 struct regmap
*map
= __map
;
340 mutex_unlock(&map
->mutex
);
343 static void regmap_lock_spinlock(void *__map
)
344 __acquires(&map
->spinlock
)
346 struct regmap
*map
= __map
;
349 spin_lock_irqsave(&map
->spinlock
, flags
);
350 map
->spinlock_flags
= flags
;
353 static void regmap_unlock_spinlock(void *__map
)
354 __releases(&map
->spinlock
)
356 struct regmap
*map
= __map
;
357 spin_unlock_irqrestore(&map
->spinlock
, map
->spinlock_flags
);
360 static void dev_get_regmap_release(struct device
*dev
, void *res
)
363 * We don't actually have anything to do here; the goal here
364 * is not to manage the regmap but to provide a simple way to
365 * get the regmap back given a struct device.
369 static bool _regmap_range_add(struct regmap
*map
,
370 struct regmap_range_node
*data
)
372 struct rb_root
*root
= &map
->range_tree
;
373 struct rb_node
**new = &(root
->rb_node
), *parent
= NULL
;
376 struct regmap_range_node
*this =
377 container_of(*new, struct regmap_range_node
, node
);
380 if (data
->range_max
< this->range_min
)
381 new = &((*new)->rb_left
);
382 else if (data
->range_min
> this->range_max
)
383 new = &((*new)->rb_right
);
388 rb_link_node(&data
->node
, parent
, new);
389 rb_insert_color(&data
->node
, root
);
394 static struct regmap_range_node
*_regmap_range_lookup(struct regmap
*map
,
397 struct rb_node
*node
= map
->range_tree
.rb_node
;
400 struct regmap_range_node
*this =
401 container_of(node
, struct regmap_range_node
, node
);
403 if (reg
< this->range_min
)
404 node
= node
->rb_left
;
405 else if (reg
> this->range_max
)
406 node
= node
->rb_right
;
414 static void regmap_range_exit(struct regmap
*map
)
416 struct rb_node
*next
;
417 struct regmap_range_node
*range_node
;
419 next
= rb_first(&map
->range_tree
);
421 range_node
= rb_entry(next
, struct regmap_range_node
, node
);
422 next
= rb_next(&range_node
->node
);
423 rb_erase(&range_node
->node
, &map
->range_tree
);
427 kfree(map
->selector_work_buf
);
430 int regmap_attach_dev(struct device
*dev
, struct regmap
*map
,
431 const struct regmap_config
*config
)
437 regmap_debugfs_init(map
, config
->name
);
439 /* Add a devres resource for dev_get_regmap() */
440 m
= devres_alloc(dev_get_regmap_release
, sizeof(*m
), GFP_KERNEL
);
442 regmap_debugfs_exit(map
);
450 EXPORT_SYMBOL_GPL(regmap_attach_dev
);
452 static enum regmap_endian
regmap_get_reg_endian(const struct regmap_bus
*bus
,
453 const struct regmap_config
*config
)
455 enum regmap_endian endian
;
457 /* Retrieve the endianness specification from the regmap config */
458 endian
= config
->reg_format_endian
;
460 /* If the regmap config specified a non-default value, use that */
461 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
464 /* Retrieve the endianness specification from the bus config */
465 if (bus
&& bus
->reg_format_endian_default
)
466 endian
= bus
->reg_format_endian_default
;
468 /* If the bus specified a non-default value, use that */
469 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
472 /* Use this if no other value was found */
473 return REGMAP_ENDIAN_BIG
;
476 enum regmap_endian
regmap_get_val_endian(struct device
*dev
,
477 const struct regmap_bus
*bus
,
478 const struct regmap_config
*config
)
480 struct device_node
*np
;
481 enum regmap_endian endian
;
483 /* Retrieve the endianness specification from the regmap config */
484 endian
= config
->val_format_endian
;
486 /* If the regmap config specified a non-default value, use that */
487 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
490 /* If the dev and dev->of_node exist try to get endianness from DT */
491 if (dev
&& dev
->of_node
) {
494 /* Parse the device's DT node for an endianness specification */
495 if (of_property_read_bool(np
, "big-endian"))
496 endian
= REGMAP_ENDIAN_BIG
;
497 else if (of_property_read_bool(np
, "little-endian"))
498 endian
= REGMAP_ENDIAN_LITTLE
;
500 /* If the endianness was specified in DT, use that */
501 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
505 /* Retrieve the endianness specification from the bus config */
506 if (bus
&& bus
->val_format_endian_default
)
507 endian
= bus
->val_format_endian_default
;
509 /* If the bus specified a non-default value, use that */
510 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
513 /* Use this if no other value was found */
514 return REGMAP_ENDIAN_BIG
;
516 EXPORT_SYMBOL_GPL(regmap_get_val_endian
);
519 * regmap_init(): Initialise register map
521 * @dev: Device that will be interacted with
522 * @bus: Bus-specific callbacks to use with device
523 * @bus_context: Data passed to bus-specific callbacks
524 * @config: Configuration for register map
526 * The return value will be an ERR_PTR() on error or a valid pointer to
527 * a struct regmap. This function should generally not be called
528 * directly, it should be called by bus-specific init functions.
530 struct regmap
*regmap_init(struct device
*dev
,
531 const struct regmap_bus
*bus
,
533 const struct regmap_config
*config
)
537 enum regmap_endian reg_endian
, val_endian
;
543 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
549 if (config
->lock
&& config
->unlock
) {
550 map
->lock
= config
->lock
;
551 map
->unlock
= config
->unlock
;
552 map
->lock_arg
= config
->lock_arg
;
554 if ((bus
&& bus
->fast_io
) ||
556 spin_lock_init(&map
->spinlock
);
557 map
->lock
= regmap_lock_spinlock
;
558 map
->unlock
= regmap_unlock_spinlock
;
560 mutex_init(&map
->mutex
);
561 map
->lock
= regmap_lock_mutex
;
562 map
->unlock
= regmap_unlock_mutex
;
566 map
->format
.reg_bytes
= DIV_ROUND_UP(config
->reg_bits
, 8);
567 map
->format
.pad_bytes
= config
->pad_bits
/ 8;
568 map
->format
.val_bytes
= DIV_ROUND_UP(config
->val_bits
, 8);
569 map
->format
.buf_size
= DIV_ROUND_UP(config
->reg_bits
+
570 config
->val_bits
+ config
->pad_bits
, 8);
571 map
->reg_shift
= config
->pad_bits
% 8;
572 if (config
->reg_stride
)
573 map
->reg_stride
= config
->reg_stride
;
576 map
->use_single_rw
= config
->use_single_rw
;
577 map
->can_multi_write
= config
->can_multi_write
;
580 map
->bus_context
= bus_context
;
581 map
->max_register
= config
->max_register
;
582 map
->wr_table
= config
->wr_table
;
583 map
->rd_table
= config
->rd_table
;
584 map
->volatile_table
= config
->volatile_table
;
585 map
->precious_table
= config
->precious_table
;
586 map
->writeable_reg
= config
->writeable_reg
;
587 map
->readable_reg
= config
->readable_reg
;
588 map
->volatile_reg
= config
->volatile_reg
;
589 map
->precious_reg
= config
->precious_reg
;
590 map
->cache_type
= config
->cache_type
;
591 map
->name
= config
->name
;
593 spin_lock_init(&map
->async_lock
);
594 INIT_LIST_HEAD(&map
->async_list
);
595 INIT_LIST_HEAD(&map
->async_free
);
596 init_waitqueue_head(&map
->async_waitq
);
598 if (config
->read_flag_mask
|| config
->write_flag_mask
) {
599 map
->read_flag_mask
= config
->read_flag_mask
;
600 map
->write_flag_mask
= config
->write_flag_mask
;
602 map
->read_flag_mask
= bus
->read_flag_mask
;
606 map
->reg_read
= config
->reg_read
;
607 map
->reg_write
= config
->reg_write
;
609 map
->defer_caching
= false;
610 goto skip_format_initialization
;
611 } else if (!bus
->read
|| !bus
->write
) {
612 map
->reg_read
= _regmap_bus_reg_read
;
613 map
->reg_write
= _regmap_bus_reg_write
;
615 map
->defer_caching
= false;
616 goto skip_format_initialization
;
618 map
->reg_read
= _regmap_bus_read
;
621 reg_endian
= regmap_get_reg_endian(bus
, config
);
622 val_endian
= regmap_get_val_endian(dev
, bus
, config
);
624 switch (config
->reg_bits
+ map
->reg_shift
) {
626 switch (config
->val_bits
) {
628 map
->format
.format_write
= regmap_format_2_6_write
;
636 switch (config
->val_bits
) {
638 map
->format
.format_write
= regmap_format_4_12_write
;
646 switch (config
->val_bits
) {
648 map
->format
.format_write
= regmap_format_7_9_write
;
656 switch (config
->val_bits
) {
658 map
->format
.format_write
= regmap_format_10_14_write
;
666 map
->format
.format_reg
= regmap_format_8
;
670 switch (reg_endian
) {
671 case REGMAP_ENDIAN_BIG
:
672 map
->format
.format_reg
= regmap_format_16_be
;
674 case REGMAP_ENDIAN_NATIVE
:
675 map
->format
.format_reg
= regmap_format_16_native
;
683 if (reg_endian
!= REGMAP_ENDIAN_BIG
)
685 map
->format
.format_reg
= regmap_format_24
;
689 switch (reg_endian
) {
690 case REGMAP_ENDIAN_BIG
:
691 map
->format
.format_reg
= regmap_format_32_be
;
693 case REGMAP_ENDIAN_NATIVE
:
694 map
->format
.format_reg
= regmap_format_32_native
;
705 if (val_endian
== REGMAP_ENDIAN_NATIVE
)
706 map
->format
.parse_inplace
= regmap_parse_inplace_noop
;
708 switch (config
->val_bits
) {
710 map
->format
.format_val
= regmap_format_8
;
711 map
->format
.parse_val
= regmap_parse_8
;
712 map
->format
.parse_inplace
= regmap_parse_inplace_noop
;
715 switch (val_endian
) {
716 case REGMAP_ENDIAN_BIG
:
717 map
->format
.format_val
= regmap_format_16_be
;
718 map
->format
.parse_val
= regmap_parse_16_be
;
719 map
->format
.parse_inplace
= regmap_parse_16_be_inplace
;
721 case REGMAP_ENDIAN_LITTLE
:
722 map
->format
.format_val
= regmap_format_16_le
;
723 map
->format
.parse_val
= regmap_parse_16_le
;
724 map
->format
.parse_inplace
= regmap_parse_16_le_inplace
;
726 case REGMAP_ENDIAN_NATIVE
:
727 map
->format
.format_val
= regmap_format_16_native
;
728 map
->format
.parse_val
= regmap_parse_16_native
;
735 if (val_endian
!= REGMAP_ENDIAN_BIG
)
737 map
->format
.format_val
= regmap_format_24
;
738 map
->format
.parse_val
= regmap_parse_24
;
741 switch (val_endian
) {
742 case REGMAP_ENDIAN_BIG
:
743 map
->format
.format_val
= regmap_format_32_be
;
744 map
->format
.parse_val
= regmap_parse_32_be
;
745 map
->format
.parse_inplace
= regmap_parse_32_be_inplace
;
747 case REGMAP_ENDIAN_LITTLE
:
748 map
->format
.format_val
= regmap_format_32_le
;
749 map
->format
.parse_val
= regmap_parse_32_le
;
750 map
->format
.parse_inplace
= regmap_parse_32_le_inplace
;
752 case REGMAP_ENDIAN_NATIVE
:
753 map
->format
.format_val
= regmap_format_32_native
;
754 map
->format
.parse_val
= regmap_parse_32_native
;
762 if (map
->format
.format_write
) {
763 if ((reg_endian
!= REGMAP_ENDIAN_BIG
) ||
764 (val_endian
!= REGMAP_ENDIAN_BIG
))
766 map
->use_single_rw
= true;
769 if (!map
->format
.format_write
&&
770 !(map
->format
.format_reg
&& map
->format
.format_val
))
773 map
->work_buf
= kzalloc(map
->format
.buf_size
, GFP_KERNEL
);
774 if (map
->work_buf
== NULL
) {
779 if (map
->format
.format_write
) {
780 map
->defer_caching
= false;
781 map
->reg_write
= _regmap_bus_formatted_write
;
782 } else if (map
->format
.format_val
) {
783 map
->defer_caching
= true;
784 map
->reg_write
= _regmap_bus_raw_write
;
787 skip_format_initialization
:
789 map
->range_tree
= RB_ROOT
;
790 for (i
= 0; i
< config
->num_ranges
; i
++) {
791 const struct regmap_range_cfg
*range_cfg
= &config
->ranges
[i
];
792 struct regmap_range_node
*new;
795 if (range_cfg
->range_max
< range_cfg
->range_min
) {
796 dev_err(map
->dev
, "Invalid range %d: %d < %d\n", i
,
797 range_cfg
->range_max
, range_cfg
->range_min
);
801 if (range_cfg
->range_max
> map
->max_register
) {
802 dev_err(map
->dev
, "Invalid range %d: %d > %d\n", i
,
803 range_cfg
->range_max
, map
->max_register
);
807 if (range_cfg
->selector_reg
> map
->max_register
) {
809 "Invalid range %d: selector out of map\n", i
);
813 if (range_cfg
->window_len
== 0) {
814 dev_err(map
->dev
, "Invalid range %d: window_len 0\n",
819 /* Make sure, that this register range has no selector
820 or data window within its boundary */
821 for (j
= 0; j
< config
->num_ranges
; j
++) {
822 unsigned sel_reg
= config
->ranges
[j
].selector_reg
;
823 unsigned win_min
= config
->ranges
[j
].window_start
;
824 unsigned win_max
= win_min
+
825 config
->ranges
[j
].window_len
- 1;
827 /* Allow data window inside its own virtual range */
831 if (range_cfg
->range_min
<= sel_reg
&&
832 sel_reg
<= range_cfg
->range_max
) {
834 "Range %d: selector for %d in window\n",
839 if (!(win_max
< range_cfg
->range_min
||
840 win_min
> range_cfg
->range_max
)) {
842 "Range %d: window for %d in window\n",
848 new = kzalloc(sizeof(*new), GFP_KERNEL
);
855 new->name
= range_cfg
->name
;
856 new->range_min
= range_cfg
->range_min
;
857 new->range_max
= range_cfg
->range_max
;
858 new->selector_reg
= range_cfg
->selector_reg
;
859 new->selector_mask
= range_cfg
->selector_mask
;
860 new->selector_shift
= range_cfg
->selector_shift
;
861 new->window_start
= range_cfg
->window_start
;
862 new->window_len
= range_cfg
->window_len
;
864 if (!_regmap_range_add(map
, new)) {
865 dev_err(map
->dev
, "Failed to add range %d\n", i
);
870 if (map
->selector_work_buf
== NULL
) {
871 map
->selector_work_buf
=
872 kzalloc(map
->format
.buf_size
, GFP_KERNEL
);
873 if (map
->selector_work_buf
== NULL
) {
880 ret
= regcache_init(map
, config
);
885 ret
= regmap_attach_dev(dev
, map
, config
);
895 regmap_range_exit(map
);
896 kfree(map
->work_buf
);
902 EXPORT_SYMBOL_GPL(regmap_init
);
904 static void devm_regmap_release(struct device
*dev
, void *res
)
906 regmap_exit(*(struct regmap
**)res
);
910 * devm_regmap_init(): Initialise managed register map
912 * @dev: Device that will be interacted with
913 * @bus: Bus-specific callbacks to use with device
914 * @bus_context: Data passed to bus-specific callbacks
915 * @config: Configuration for register map
917 * The return value will be an ERR_PTR() on error or a valid pointer
918 * to a struct regmap. This function should generally not be called
919 * directly, it should be called by bus-specific init functions. The
920 * map will be automatically freed by the device management code.
922 struct regmap
*devm_regmap_init(struct device
*dev
,
923 const struct regmap_bus
*bus
,
925 const struct regmap_config
*config
)
927 struct regmap
**ptr
, *regmap
;
929 ptr
= devres_alloc(devm_regmap_release
, sizeof(*ptr
), GFP_KERNEL
);
931 return ERR_PTR(-ENOMEM
);
933 regmap
= regmap_init(dev
, bus
, bus_context
, config
);
934 if (!IS_ERR(regmap
)) {
936 devres_add(dev
, ptr
);
943 EXPORT_SYMBOL_GPL(devm_regmap_init
);
945 static void regmap_field_init(struct regmap_field
*rm_field
,
946 struct regmap
*regmap
, struct reg_field reg_field
)
948 rm_field
->regmap
= regmap
;
949 rm_field
->reg
= reg_field
.reg
;
950 rm_field
->shift
= reg_field
.lsb
;
951 rm_field
->mask
= GENMASK(reg_field
.msb
, reg_field
.lsb
);
952 rm_field
->id_size
= reg_field
.id_size
;
953 rm_field
->id_offset
= reg_field
.id_offset
;
957 * devm_regmap_field_alloc(): Allocate and initialise a register field
960 * @dev: Device that will be interacted with
961 * @regmap: regmap bank in which this register field is located.
962 * @reg_field: Register field with in the bank.
964 * The return value will be an ERR_PTR() on error or a valid pointer
965 * to a struct regmap_field. The regmap_field will be automatically freed
966 * by the device management code.
968 struct regmap_field
*devm_regmap_field_alloc(struct device
*dev
,
969 struct regmap
*regmap
, struct reg_field reg_field
)
971 struct regmap_field
*rm_field
= devm_kzalloc(dev
,
972 sizeof(*rm_field
), GFP_KERNEL
);
974 return ERR_PTR(-ENOMEM
);
976 regmap_field_init(rm_field
, regmap
, reg_field
);
981 EXPORT_SYMBOL_GPL(devm_regmap_field_alloc
);
984 * devm_regmap_field_free(): Free register field allocated using
985 * devm_regmap_field_alloc. Usally drivers need not call this function,
986 * as the memory allocated via devm will be freed as per device-driver
989 * @dev: Device that will be interacted with
990 * @field: regmap field which should be freed.
992 void devm_regmap_field_free(struct device
*dev
,
993 struct regmap_field
*field
)
995 devm_kfree(dev
, field
);
997 EXPORT_SYMBOL_GPL(devm_regmap_field_free
);
1000 * regmap_field_alloc(): Allocate and initialise a register field
1001 * in a register map.
1003 * @regmap: regmap bank in which this register field is located.
1004 * @reg_field: Register field with in the bank.
1006 * The return value will be an ERR_PTR() on error or a valid pointer
1007 * to a struct regmap_field. The regmap_field should be freed by the
1008 * user once its finished working with it using regmap_field_free().
1010 struct regmap_field
*regmap_field_alloc(struct regmap
*regmap
,
1011 struct reg_field reg_field
)
1013 struct regmap_field
*rm_field
= kzalloc(sizeof(*rm_field
), GFP_KERNEL
);
1016 return ERR_PTR(-ENOMEM
);
1018 regmap_field_init(rm_field
, regmap
, reg_field
);
1022 EXPORT_SYMBOL_GPL(regmap_field_alloc
);
1025 * regmap_field_free(): Free register field allocated using regmap_field_alloc
1027 * @field: regmap field which should be freed.
1029 void regmap_field_free(struct regmap_field
*field
)
1033 EXPORT_SYMBOL_GPL(regmap_field_free
);
1036 * regmap_reinit_cache(): Reinitialise the current register cache
1038 * @map: Register map to operate on.
1039 * @config: New configuration. Only the cache data will be used.
1041 * Discard any existing register cache for the map and initialize a
1042 * new cache. This can be used to restore the cache to defaults or to
1043 * update the cache configuration to reflect runtime discovery of the
1046 * No explicit locking is done here, the user needs to ensure that
1047 * this function will not race with other calls to regmap.
1049 int regmap_reinit_cache(struct regmap
*map
, const struct regmap_config
*config
)
1052 regmap_debugfs_exit(map
);
1054 map
->max_register
= config
->max_register
;
1055 map
->writeable_reg
= config
->writeable_reg
;
1056 map
->readable_reg
= config
->readable_reg
;
1057 map
->volatile_reg
= config
->volatile_reg
;
1058 map
->precious_reg
= config
->precious_reg
;
1059 map
->cache_type
= config
->cache_type
;
1061 regmap_debugfs_init(map
, config
->name
);
1063 map
->cache_bypass
= false;
1064 map
->cache_only
= false;
1066 return regcache_init(map
, config
);
1068 EXPORT_SYMBOL_GPL(regmap_reinit_cache
);
1071 * regmap_exit(): Free a previously allocated register map
1073 void regmap_exit(struct regmap
*map
)
1075 struct regmap_async
*async
;
1078 regmap_debugfs_exit(map
);
1079 regmap_range_exit(map
);
1080 if (map
->bus
&& map
->bus
->free_context
)
1081 map
->bus
->free_context(map
->bus_context
);
1082 kfree(map
->work_buf
);
1083 while (!list_empty(&map
->async_free
)) {
1084 async
= list_first_entry_or_null(&map
->async_free
,
1085 struct regmap_async
,
1087 list_del(&async
->list
);
1088 kfree(async
->work_buf
);
1093 EXPORT_SYMBOL_GPL(regmap_exit
);
1095 static int dev_get_regmap_match(struct device
*dev
, void *res
, void *data
)
1097 struct regmap
**r
= res
;
1103 /* If the user didn't specify a name match any */
1105 return (*r
)->name
== data
;
1111 * dev_get_regmap(): Obtain the regmap (if any) for a device
1113 * @dev: Device to retrieve the map for
1114 * @name: Optional name for the register map, usually NULL.
1116 * Returns the regmap for the device if one is present, or NULL. If
1117 * name is specified then it must match the name specified when
1118 * registering the device, if it is NULL then the first regmap found
1119 * will be used. Devices with multiple register maps are very rare,
1120 * generic code should normally not need to specify a name.
1122 struct regmap
*dev_get_regmap(struct device
*dev
, const char *name
)
1124 struct regmap
**r
= devres_find(dev
, dev_get_regmap_release
,
1125 dev_get_regmap_match
, (void *)name
);
1131 EXPORT_SYMBOL_GPL(dev_get_regmap
);
1134 * regmap_get_device(): Obtain the device from a regmap
1136 * @map: Register map to operate on.
1138 * Returns the underlying device that the regmap has been created for.
1140 struct device
*regmap_get_device(struct regmap
*map
)
1144 EXPORT_SYMBOL_GPL(regmap_get_device
);
1146 static int _regmap_select_page(struct regmap
*map
, unsigned int *reg
,
1147 struct regmap_range_node
*range
,
1148 unsigned int val_num
)
1150 void *orig_work_buf
;
1151 unsigned int win_offset
;
1152 unsigned int win_page
;
1156 win_offset
= (*reg
- range
->range_min
) % range
->window_len
;
1157 win_page
= (*reg
- range
->range_min
) / range
->window_len
;
1160 /* Bulk write shouldn't cross range boundary */
1161 if (*reg
+ val_num
- 1 > range
->range_max
)
1164 /* ... or single page boundary */
1165 if (val_num
> range
->window_len
- win_offset
)
1169 /* It is possible to have selector register inside data window.
1170 In that case, selector register is located on every page and
1171 it needs no page switching, when accessed alone. */
1173 range
->window_start
+ win_offset
!= range
->selector_reg
) {
1174 /* Use separate work_buf during page switching */
1175 orig_work_buf
= map
->work_buf
;
1176 map
->work_buf
= map
->selector_work_buf
;
1178 ret
= _regmap_update_bits(map
, range
->selector_reg
,
1179 range
->selector_mask
,
1180 win_page
<< range
->selector_shift
,
1183 map
->work_buf
= orig_work_buf
;
1189 *reg
= range
->window_start
+ win_offset
;
1194 int _regmap_raw_write(struct regmap
*map
, unsigned int reg
,
1195 const void *val
, size_t val_len
)
1197 struct regmap_range_node
*range
;
1198 unsigned long flags
;
1199 u8
*u8
= map
->work_buf
;
1200 void *work_val
= map
->work_buf
+ map
->format
.reg_bytes
+
1201 map
->format
.pad_bytes
;
1203 int ret
= -ENOTSUPP
;
1209 /* Check for unwritable registers before we start */
1210 if (map
->writeable_reg
)
1211 for (i
= 0; i
< val_len
/ map
->format
.val_bytes
; i
++)
1212 if (!map
->writeable_reg(map
->dev
,
1213 reg
+ (i
* map
->reg_stride
)))
1216 if (!map
->cache_bypass
&& map
->format
.parse_val
) {
1218 int val_bytes
= map
->format
.val_bytes
;
1219 for (i
= 0; i
< val_len
/ val_bytes
; i
++) {
1220 ival
= map
->format
.parse_val(val
+ (i
* val_bytes
));
1221 ret
= regcache_write(map
, reg
+ (i
* map
->reg_stride
),
1225 "Error in caching of register: %x ret: %d\n",
1230 if (map
->cache_only
) {
1231 map
->cache_dirty
= true;
1236 range
= _regmap_range_lookup(map
, reg
);
1238 int val_num
= val_len
/ map
->format
.val_bytes
;
1239 int win_offset
= (reg
- range
->range_min
) % range
->window_len
;
1240 int win_residue
= range
->window_len
- win_offset
;
1242 /* If the write goes beyond the end of the window split it */
1243 while (val_num
> win_residue
) {
1244 dev_dbg(map
->dev
, "Writing window %d/%zu\n",
1245 win_residue
, val_len
/ map
->format
.val_bytes
);
1246 ret
= _regmap_raw_write(map
, reg
, val
, win_residue
*
1247 map
->format
.val_bytes
);
1252 val_num
-= win_residue
;
1253 val
+= win_residue
* map
->format
.val_bytes
;
1254 val_len
-= win_residue
* map
->format
.val_bytes
;
1256 win_offset
= (reg
- range
->range_min
) %
1258 win_residue
= range
->window_len
- win_offset
;
1261 ret
= _regmap_select_page(map
, ®
, range
, val_num
);
1266 map
->format
.format_reg(map
->work_buf
, reg
, map
->reg_shift
);
1268 u8
[0] |= map
->write_flag_mask
;
1271 * Essentially all I/O mechanisms will be faster with a single
1272 * buffer to write. Since register syncs often generate raw
1273 * writes of single registers optimise that case.
1275 if (val
!= work_val
&& val_len
== map
->format
.val_bytes
) {
1276 memcpy(work_val
, val
, map
->format
.val_bytes
);
1280 if (map
->async
&& map
->bus
->async_write
) {
1281 struct regmap_async
*async
;
1283 trace_regmap_async_write_start(map
, reg
, val_len
);
1285 spin_lock_irqsave(&map
->async_lock
, flags
);
1286 async
= list_first_entry_or_null(&map
->async_free
,
1287 struct regmap_async
,
1290 list_del(&async
->list
);
1291 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1294 async
= map
->bus
->async_alloc();
1298 async
->work_buf
= kzalloc(map
->format
.buf_size
,
1299 GFP_KERNEL
| GFP_DMA
);
1300 if (!async
->work_buf
) {
1308 /* If the caller supplied the value we can use it safely. */
1309 memcpy(async
->work_buf
, map
->work_buf
, map
->format
.pad_bytes
+
1310 map
->format
.reg_bytes
+ map
->format
.val_bytes
);
1312 spin_lock_irqsave(&map
->async_lock
, flags
);
1313 list_add_tail(&async
->list
, &map
->async_list
);
1314 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1316 if (val
!= work_val
)
1317 ret
= map
->bus
->async_write(map
->bus_context
,
1319 map
->format
.reg_bytes
+
1320 map
->format
.pad_bytes
,
1321 val
, val_len
, async
);
1323 ret
= map
->bus
->async_write(map
->bus_context
,
1325 map
->format
.reg_bytes
+
1326 map
->format
.pad_bytes
+
1327 val_len
, NULL
, 0, async
);
1330 dev_err(map
->dev
, "Failed to schedule write: %d\n",
1333 spin_lock_irqsave(&map
->async_lock
, flags
);
1334 list_move(&async
->list
, &map
->async_free
);
1335 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1341 trace_regmap_hw_write_start(map
, reg
, val_len
/ map
->format
.val_bytes
);
1343 /* If we're doing a single register write we can probably just
1344 * send the work_buf directly, otherwise try to do a gather
1347 if (val
== work_val
)
1348 ret
= map
->bus
->write(map
->bus_context
, map
->work_buf
,
1349 map
->format
.reg_bytes
+
1350 map
->format
.pad_bytes
+
1352 else if (map
->bus
->gather_write
)
1353 ret
= map
->bus
->gather_write(map
->bus_context
, map
->work_buf
,
1354 map
->format
.reg_bytes
+
1355 map
->format
.pad_bytes
,
1358 /* If that didn't work fall back on linearising by hand. */
1359 if (ret
== -ENOTSUPP
) {
1360 len
= map
->format
.reg_bytes
+ map
->format
.pad_bytes
+ val_len
;
1361 buf
= kzalloc(len
, GFP_KERNEL
);
1365 memcpy(buf
, map
->work_buf
, map
->format
.reg_bytes
);
1366 memcpy(buf
+ map
->format
.reg_bytes
+ map
->format
.pad_bytes
,
1368 ret
= map
->bus
->write(map
->bus_context
, buf
, len
);
1373 trace_regmap_hw_write_done(map
, reg
, val_len
/ map
->format
.val_bytes
);
1379 * regmap_can_raw_write - Test if regmap_raw_write() is supported
1381 * @map: Map to check.
1383 bool regmap_can_raw_write(struct regmap
*map
)
1385 return map
->bus
&& map
->format
.format_val
&& map
->format
.format_reg
;
1387 EXPORT_SYMBOL_GPL(regmap_can_raw_write
);
1389 static int _regmap_bus_formatted_write(void *context
, unsigned int reg
,
1393 struct regmap_range_node
*range
;
1394 struct regmap
*map
= context
;
1396 WARN_ON(!map
->bus
|| !map
->format
.format_write
);
1398 range
= _regmap_range_lookup(map
, reg
);
1400 ret
= _regmap_select_page(map
, ®
, range
, 1);
1405 map
->format
.format_write(map
, reg
, val
);
1407 trace_regmap_hw_write_start(map
, reg
, 1);
1409 ret
= map
->bus
->write(map
->bus_context
, map
->work_buf
,
1410 map
->format
.buf_size
);
1412 trace_regmap_hw_write_done(map
, reg
, 1);
1417 static int _regmap_bus_reg_write(void *context
, unsigned int reg
,
1420 struct regmap
*map
= context
;
1422 return map
->bus
->reg_write(map
->bus_context
, reg
, val
);
1425 static int _regmap_bus_raw_write(void *context
, unsigned int reg
,
1428 struct regmap
*map
= context
;
1430 WARN_ON(!map
->bus
|| !map
->format
.format_val
);
1432 map
->format
.format_val(map
->work_buf
+ map
->format
.reg_bytes
1433 + map
->format
.pad_bytes
, val
, 0);
1434 return _regmap_raw_write(map
, reg
,
1436 map
->format
.reg_bytes
+
1437 map
->format
.pad_bytes
,
1438 map
->format
.val_bytes
);
1441 static inline void *_regmap_map_get_context(struct regmap
*map
)
1443 return (map
->bus
) ? map
: map
->bus_context
;
1446 int _regmap_write(struct regmap
*map
, unsigned int reg
,
1450 void *context
= _regmap_map_get_context(map
);
1452 if (!regmap_writeable(map
, reg
))
1455 if (!map
->cache_bypass
&& !map
->defer_caching
) {
1456 ret
= regcache_write(map
, reg
, val
);
1459 if (map
->cache_only
) {
1460 map
->cache_dirty
= true;
1466 if (map
->dev
&& strcmp(dev_name(map
->dev
), LOG_DEVICE
) == 0)
1467 dev_info(map
->dev
, "%x <= %x\n", reg
, val
);
1470 trace_regmap_reg_write(map
, reg
, val
);
1472 return map
->reg_write(context
, reg
, val
);
1476 * regmap_write(): Write a value to a single register
1478 * @map: Register map to write to
1479 * @reg: Register to write to
1480 * @val: Value to be written
1482 * A value of zero will be returned on success, a negative errno will
1483 * be returned in error cases.
1485 int regmap_write(struct regmap
*map
, unsigned int reg
, unsigned int val
)
1489 if (reg
% map
->reg_stride
)
1492 map
->lock(map
->lock_arg
);
1494 ret
= _regmap_write(map
, reg
, val
);
1496 map
->unlock(map
->lock_arg
);
1500 EXPORT_SYMBOL_GPL(regmap_write
);
1503 * regmap_write_async(): Write a value to a single register asynchronously
1505 * @map: Register map to write to
1506 * @reg: Register to write to
1507 * @val: Value to be written
1509 * A value of zero will be returned on success, a negative errno will
1510 * be returned in error cases.
1512 int regmap_write_async(struct regmap
*map
, unsigned int reg
, unsigned int val
)
1516 if (reg
% map
->reg_stride
)
1519 map
->lock(map
->lock_arg
);
1523 ret
= _regmap_write(map
, reg
, val
);
1527 map
->unlock(map
->lock_arg
);
1531 EXPORT_SYMBOL_GPL(regmap_write_async
);
1534 * regmap_raw_write(): Write raw values to one or more registers
1536 * @map: Register map to write to
1537 * @reg: Initial register to write to
1538 * @val: Block of data to be written, laid out for direct transmission to the
1540 * @val_len: Length of data pointed to by val.
1542 * This function is intended to be used for things like firmware
1543 * download where a large block of data needs to be transferred to the
1544 * device. No formatting will be done on the data provided.
1546 * A value of zero will be returned on success, a negative errno will
1547 * be returned in error cases.
1549 int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
1550 const void *val
, size_t val_len
)
1554 if (!regmap_can_raw_write(map
))
1556 if (val_len
% map
->format
.val_bytes
)
1559 map
->lock(map
->lock_arg
);
1561 ret
= _regmap_raw_write(map
, reg
, val
, val_len
);
1563 map
->unlock(map
->lock_arg
);
1567 EXPORT_SYMBOL_GPL(regmap_raw_write
);
1570 * regmap_field_write(): Write a value to a single register field
1572 * @field: Register field to write to
1573 * @val: Value to be written
1575 * A value of zero will be returned on success, a negative errno will
1576 * be returned in error cases.
1578 int regmap_field_write(struct regmap_field
*field
, unsigned int val
)
1580 return regmap_update_bits(field
->regmap
, field
->reg
,
1581 field
->mask
, val
<< field
->shift
);
1583 EXPORT_SYMBOL_GPL(regmap_field_write
);
1586 * regmap_field_update_bits(): Perform a read/modify/write cycle
1587 * on the register field
1589 * @field: Register field to write to
1590 * @mask: Bitmask to change
1591 * @val: Value to be written
1593 * A value of zero will be returned on success, a negative errno will
1594 * be returned in error cases.
1596 int regmap_field_update_bits(struct regmap_field
*field
, unsigned int mask
, unsigned int val
)
1598 mask
= (mask
<< field
->shift
) & field
->mask
;
1600 return regmap_update_bits(field
->regmap
, field
->reg
,
1601 mask
, val
<< field
->shift
);
1603 EXPORT_SYMBOL_GPL(regmap_field_update_bits
);
1606 * regmap_fields_write(): Write a value to a single register field with port ID
1608 * @field: Register field to write to
1610 * @val: Value to be written
1612 * A value of zero will be returned on success, a negative errno will
1613 * be returned in error cases.
1615 int regmap_fields_write(struct regmap_field
*field
, unsigned int id
,
1618 if (id
>= field
->id_size
)
1621 return regmap_update_bits(field
->regmap
,
1622 field
->reg
+ (field
->id_offset
* id
),
1623 field
->mask
, val
<< field
->shift
);
1625 EXPORT_SYMBOL_GPL(regmap_fields_write
);
1627 int regmap_fields_force_write(struct regmap_field
*field
, unsigned int id
,
1630 if (id
>= field
->id_size
)
1633 return regmap_write_bits(field
->regmap
,
1634 field
->reg
+ (field
->id_offset
* id
),
1635 field
->mask
, val
<< field
->shift
);
1637 EXPORT_SYMBOL_GPL(regmap_fields_force_write
);
1640 * regmap_fields_update_bits(): Perform a read/modify/write cycle
1641 * on the register field
1643 * @field: Register field to write to
1645 * @mask: Bitmask to change
1646 * @val: Value to be written
1648 * A value of zero will be returned on success, a negative errno will
1649 * be returned in error cases.
1651 int regmap_fields_update_bits(struct regmap_field
*field
, unsigned int id
,
1652 unsigned int mask
, unsigned int val
)
1654 if (id
>= field
->id_size
)
1657 mask
= (mask
<< field
->shift
) & field
->mask
;
1659 return regmap_update_bits(field
->regmap
,
1660 field
->reg
+ (field
->id_offset
* id
),
1661 mask
, val
<< field
->shift
);
1663 EXPORT_SYMBOL_GPL(regmap_fields_update_bits
);
1666 * regmap_bulk_write(): Write multiple registers to the device
1668 * @map: Register map to write to
1669 * @reg: First register to be write from
1670 * @val: Block of data to be written, in native register size for device
1671 * @val_count: Number of registers to write
1673 * This function is intended to be used for writing a large block of
1674 * data to the device either in single transfer or multiple transfer.
1676 * A value of zero will be returned on success, a negative errno will
1677 * be returned in error cases.
1679 int regmap_bulk_write(struct regmap
*map
, unsigned int reg
, const void *val
,
1683 size_t val_bytes
= map
->format
.val_bytes
;
1685 if (map
->bus
&& !map
->format
.parse_inplace
)
1687 if (reg
% map
->reg_stride
)
1691 * Some devices don't support bulk write, for
1692 * them we have a series of single write operations.
1694 if (!map
->bus
|| map
->use_single_rw
) {
1695 map
->lock(map
->lock_arg
);
1696 for (i
= 0; i
< val_count
; i
++) {
1699 switch (val_bytes
) {
1701 ival
= *(u8
*)(val
+ (i
* val_bytes
));
1704 ival
= *(u16
*)(val
+ (i
* val_bytes
));
1707 ival
= *(u32
*)(val
+ (i
* val_bytes
));
1711 ival
= *(u64
*)(val
+ (i
* val_bytes
));
1719 ret
= _regmap_write(map
, reg
+ (i
* map
->reg_stride
),
1725 map
->unlock(map
->lock_arg
);
1732 wval
= kmemdup(val
, val_count
* val_bytes
, GFP_KERNEL
);
1734 dev_err(map
->dev
, "Error in memory allocation\n");
1737 for (i
= 0; i
< val_count
* val_bytes
; i
+= val_bytes
)
1738 map
->format
.parse_inplace(wval
+ i
);
1740 map
->lock(map
->lock_arg
);
1741 ret
= _regmap_raw_write(map
, reg
, wval
, val_bytes
* val_count
);
1742 map
->unlock(map
->lock_arg
);
1748 EXPORT_SYMBOL_GPL(regmap_bulk_write
);
1751 * _regmap_raw_multi_reg_write()
1753 * the (register,newvalue) pairs in regs have not been formatted, but
1754 * they are all in the same page and have been changed to being page
1755 * relative. The page register has been written if that was neccessary.
1757 static int _regmap_raw_multi_reg_write(struct regmap
*map
,
1758 const struct reg_default
*regs
,
1765 size_t val_bytes
= map
->format
.val_bytes
;
1766 size_t reg_bytes
= map
->format
.reg_bytes
;
1767 size_t pad_bytes
= map
->format
.pad_bytes
;
1768 size_t pair_size
= reg_bytes
+ pad_bytes
+ val_bytes
;
1769 size_t len
= pair_size
* num_regs
;
1774 buf
= kzalloc(len
, GFP_KERNEL
);
1778 /* We have to linearise by hand. */
1782 for (i
= 0; i
< num_regs
; i
++) {
1783 int reg
= regs
[i
].reg
;
1784 int val
= regs
[i
].def
;
1785 trace_regmap_hw_write_start(map
, reg
, 1);
1786 map
->format
.format_reg(u8
, reg
, map
->reg_shift
);
1787 u8
+= reg_bytes
+ pad_bytes
;
1788 map
->format
.format_val(u8
, val
, 0);
1792 *u8
|= map
->write_flag_mask
;
1794 ret
= map
->bus
->write(map
->bus_context
, buf
, len
);
1798 for (i
= 0; i
< num_regs
; i
++) {
1799 int reg
= regs
[i
].reg
;
1800 trace_regmap_hw_write_done(map
, reg
, 1);
1805 static unsigned int _regmap_register_page(struct regmap
*map
,
1807 struct regmap_range_node
*range
)
1809 unsigned int win_page
= (reg
- range
->range_min
) / range
->window_len
;
1814 static int _regmap_range_multi_paged_reg_write(struct regmap
*map
,
1815 struct reg_default
*regs
,
1820 struct reg_default
*base
;
1821 unsigned int this_page
= 0;
1823 * the set of registers are not neccessarily in order, but
1824 * since the order of write must be preserved this algorithm
1825 * chops the set each time the page changes
1828 for (i
= 0, n
= 0; i
< num_regs
; i
++, n
++) {
1829 unsigned int reg
= regs
[i
].reg
;
1830 struct regmap_range_node
*range
;
1832 range
= _regmap_range_lookup(map
, reg
);
1834 unsigned int win_page
= _regmap_register_page(map
, reg
,
1838 this_page
= win_page
;
1839 if (win_page
!= this_page
) {
1840 this_page
= win_page
;
1841 ret
= _regmap_raw_multi_reg_write(map
, base
, n
);
1847 ret
= _regmap_select_page(map
, &base
[n
].reg
, range
, 1);
1853 return _regmap_raw_multi_reg_write(map
, base
, n
);
1857 static int _regmap_multi_reg_write(struct regmap
*map
,
1858 const struct reg_default
*regs
,
1864 if (!map
->can_multi_write
) {
1865 for (i
= 0; i
< num_regs
; i
++) {
1866 ret
= _regmap_write(map
, regs
[i
].reg
, regs
[i
].def
);
1873 if (!map
->format
.parse_inplace
)
1876 if (map
->writeable_reg
)
1877 for (i
= 0; i
< num_regs
; i
++) {
1878 int reg
= regs
[i
].reg
;
1879 if (!map
->writeable_reg(map
->dev
, reg
))
1881 if (reg
% map
->reg_stride
)
1885 if (!map
->cache_bypass
) {
1886 for (i
= 0; i
< num_regs
; i
++) {
1887 unsigned int val
= regs
[i
].def
;
1888 unsigned int reg
= regs
[i
].reg
;
1889 ret
= regcache_write(map
, reg
, val
);
1892 "Error in caching of register: %x ret: %d\n",
1897 if (map
->cache_only
) {
1898 map
->cache_dirty
= true;
1905 for (i
= 0; i
< num_regs
; i
++) {
1906 unsigned int reg
= regs
[i
].reg
;
1907 struct regmap_range_node
*range
;
1908 range
= _regmap_range_lookup(map
, reg
);
1910 size_t len
= sizeof(struct reg_default
)*num_regs
;
1911 struct reg_default
*base
= kmemdup(regs
, len
,
1915 ret
= _regmap_range_multi_paged_reg_write(map
, base
,
1922 return _regmap_raw_multi_reg_write(map
, regs
, num_regs
);
1926 * regmap_multi_reg_write(): Write multiple registers to the device
1928 * where the set of register,value pairs are supplied in any order,
1929 * possibly not all in a single range.
1931 * @map: Register map to write to
1932 * @regs: Array of structures containing register,value to be written
1933 * @num_regs: Number of registers to write
1935 * The 'normal' block write mode will send ultimately send data on the
1936 * target bus as R,V1,V2,V3,..,Vn where successively higer registers are
1937 * addressed. However, this alternative block multi write mode will send
1938 * the data as R1,V1,R2,V2,..,Rn,Vn on the target bus. The target device
1939 * must of course support the mode.
1941 * A value of zero will be returned on success, a negative errno will be
1942 * returned in error cases.
1944 int regmap_multi_reg_write(struct regmap
*map
, const struct reg_default
*regs
,
1949 map
->lock(map
->lock_arg
);
1951 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
1953 map
->unlock(map
->lock_arg
);
1957 EXPORT_SYMBOL_GPL(regmap_multi_reg_write
);
1960 * regmap_multi_reg_write_bypassed(): Write multiple registers to the
1961 * device but not the cache
1963 * where the set of register are supplied in any order
1965 * @map: Register map to write to
1966 * @regs: Array of structures containing register,value to be written
1967 * @num_regs: Number of registers to write
1969 * This function is intended to be used for writing a large block of data
1970 * atomically to the device in single transfer for those I2C client devices
1971 * that implement this alternative block write mode.
1973 * A value of zero will be returned on success, a negative errno will
1974 * be returned in error cases.
1976 int regmap_multi_reg_write_bypassed(struct regmap
*map
,
1977 const struct reg_default
*regs
,
1983 map
->lock(map
->lock_arg
);
1985 bypass
= map
->cache_bypass
;
1986 map
->cache_bypass
= true;
1988 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
1990 map
->cache_bypass
= bypass
;
1992 map
->unlock(map
->lock_arg
);
1996 EXPORT_SYMBOL_GPL(regmap_multi_reg_write_bypassed
);
1999 * regmap_raw_write_async(): Write raw values to one or more registers
2002 * @map: Register map to write to
2003 * @reg: Initial register to write to
2004 * @val: Block of data to be written, laid out for direct transmission to the
2005 * device. Must be valid until regmap_async_complete() is called.
2006 * @val_len: Length of data pointed to by val.
2008 * This function is intended to be used for things like firmware
2009 * download where a large block of data needs to be transferred to the
2010 * device. No formatting will be done on the data provided.
2012 * If supported by the underlying bus the write will be scheduled
2013 * asynchronously, helping maximise I/O speed on higher speed buses
2014 * like SPI. regmap_async_complete() can be called to ensure that all
2015 * asynchrnous writes have been completed.
2017 * A value of zero will be returned on success, a negative errno will
2018 * be returned in error cases.
2020 int regmap_raw_write_async(struct regmap
*map
, unsigned int reg
,
2021 const void *val
, size_t val_len
)
2025 if (val_len
% map
->format
.val_bytes
)
2027 if (reg
% map
->reg_stride
)
2030 map
->lock(map
->lock_arg
);
2034 ret
= _regmap_raw_write(map
, reg
, val
, val_len
);
2038 map
->unlock(map
->lock_arg
);
2042 EXPORT_SYMBOL_GPL(regmap_raw_write_async
);
2044 static int _regmap_raw_read(struct regmap
*map
, unsigned int reg
, void *val
,
2045 unsigned int val_len
)
2047 struct regmap_range_node
*range
;
2048 u8
*u8
= map
->work_buf
;
2053 range
= _regmap_range_lookup(map
, reg
);
2055 ret
= _regmap_select_page(map
, ®
, range
,
2056 val_len
/ map
->format
.val_bytes
);
2061 map
->format
.format_reg(map
->work_buf
, reg
, map
->reg_shift
);
2064 * Some buses or devices flag reads by setting the high bits in the
2065 * register addresss; since it's always the high bits for all
2066 * current formats we can do this here rather than in
2067 * formatting. This may break if we get interesting formats.
2069 u8
[0] |= map
->read_flag_mask
;
2071 trace_regmap_hw_read_start(map
, reg
, val_len
/ map
->format
.val_bytes
);
2073 ret
= map
->bus
->read(map
->bus_context
, map
->work_buf
,
2074 map
->format
.reg_bytes
+ map
->format
.pad_bytes
,
2077 trace_regmap_hw_read_done(map
, reg
, val_len
/ map
->format
.val_bytes
);
2082 static int _regmap_bus_reg_read(void *context
, unsigned int reg
,
2085 struct regmap
*map
= context
;
2087 return map
->bus
->reg_read(map
->bus_context
, reg
, val
);
2090 static int _regmap_bus_read(void *context
, unsigned int reg
,
2094 struct regmap
*map
= context
;
2096 if (!map
->format
.parse_val
)
2099 ret
= _regmap_raw_read(map
, reg
, map
->work_buf
, map
->format
.val_bytes
);
2101 *val
= map
->format
.parse_val(map
->work_buf
);
2106 static int _regmap_read(struct regmap
*map
, unsigned int reg
,
2110 void *context
= _regmap_map_get_context(map
);
2112 WARN_ON(!map
->reg_read
);
2114 if (!map
->cache_bypass
) {
2115 ret
= regcache_read(map
, reg
, val
);
2120 if (map
->cache_only
)
2123 if (!regmap_readable(map
, reg
))
2126 ret
= map
->reg_read(context
, reg
, val
);
2129 if (map
->dev
&& strcmp(dev_name(map
->dev
), LOG_DEVICE
) == 0)
2130 dev_info(map
->dev
, "%x => %x\n", reg
, *val
);
2133 trace_regmap_reg_read(map
, reg
, *val
);
2135 if (!map
->cache_bypass
)
2136 regcache_write(map
, reg
, *val
);
2143 * regmap_read(): Read a value from a single register
2145 * @map: Register map to read from
2146 * @reg: Register to be read from
2147 * @val: Pointer to store read value
2149 * A value of zero will be returned on success, a negative errno will
2150 * be returned in error cases.
2152 int regmap_read(struct regmap
*map
, unsigned int reg
, unsigned int *val
)
2156 if (reg
% map
->reg_stride
)
2159 map
->lock(map
->lock_arg
);
2161 ret
= _regmap_read(map
, reg
, val
);
2163 map
->unlock(map
->lock_arg
);
2167 EXPORT_SYMBOL_GPL(regmap_read
);
2170 * regmap_raw_read(): Read raw data from the device
2172 * @map: Register map to read from
2173 * @reg: First register to be read from
2174 * @val: Pointer to store read value
2175 * @val_len: Size of data to read
2177 * A value of zero will be returned on success, a negative errno will
2178 * be returned in error cases.
2180 int regmap_raw_read(struct regmap
*map
, unsigned int reg
, void *val
,
2183 size_t val_bytes
= map
->format
.val_bytes
;
2184 size_t val_count
= val_len
/ val_bytes
;
2190 if (val_len
% map
->format
.val_bytes
)
2192 if (reg
% map
->reg_stride
)
2195 map
->lock(map
->lock_arg
);
2197 if (regmap_volatile_range(map
, reg
, val_count
) || map
->cache_bypass
||
2198 map
->cache_type
== REGCACHE_NONE
) {
2199 /* Physical block read if there's no cache involved */
2200 ret
= _regmap_raw_read(map
, reg
, val
, val_len
);
2203 /* Otherwise go word by word for the cache; should be low
2204 * cost as we expect to hit the cache.
2206 for (i
= 0; i
< val_count
; i
++) {
2207 ret
= _regmap_read(map
, reg
+ (i
* map
->reg_stride
),
2212 map
->format
.format_val(val
+ (i
* val_bytes
), v
, 0);
2217 map
->unlock(map
->lock_arg
);
2221 EXPORT_SYMBOL_GPL(regmap_raw_read
);
2224 * regmap_field_read(): Read a value to a single register field
2226 * @field: Register field to read from
2227 * @val: Pointer to store read value
2229 * A value of zero will be returned on success, a negative errno will
2230 * be returned in error cases.
2232 int regmap_field_read(struct regmap_field
*field
, unsigned int *val
)
2235 unsigned int reg_val
;
2236 ret
= regmap_read(field
->regmap
, field
->reg
, ®_val
);
2240 reg_val
&= field
->mask
;
2241 reg_val
>>= field
->shift
;
2246 EXPORT_SYMBOL_GPL(regmap_field_read
);
2249 * regmap_fields_read(): Read a value to a single register field with port ID
2251 * @field: Register field to read from
2253 * @val: Pointer to store read value
2255 * A value of zero will be returned on success, a negative errno will
2256 * be returned in error cases.
2258 int regmap_fields_read(struct regmap_field
*field
, unsigned int id
,
2262 unsigned int reg_val
;
2264 if (id
>= field
->id_size
)
2267 ret
= regmap_read(field
->regmap
,
2268 field
->reg
+ (field
->id_offset
* id
),
2273 reg_val
&= field
->mask
;
2274 reg_val
>>= field
->shift
;
2279 EXPORT_SYMBOL_GPL(regmap_fields_read
);
2282 * regmap_bulk_read(): Read multiple registers from the device
2284 * @map: Register map to read from
2285 * @reg: First register to be read from
2286 * @val: Pointer to store read value, in native register size for device
2287 * @val_count: Number of registers to read
2289 * A value of zero will be returned on success, a negative errno will
2290 * be returned in error cases.
2292 int regmap_bulk_read(struct regmap
*map
, unsigned int reg
, void *val
,
2296 size_t val_bytes
= map
->format
.val_bytes
;
2297 bool vol
= regmap_volatile_range(map
, reg
, val_count
);
2299 if (reg
% map
->reg_stride
)
2302 if (map
->bus
&& map
->format
.parse_inplace
&& (vol
|| map
->cache_type
== REGCACHE_NONE
)) {
2304 * Some devices does not support bulk read, for
2305 * them we have a series of single read operations.
2307 if (map
->use_single_rw
) {
2308 for (i
= 0; i
< val_count
; i
++) {
2309 ret
= regmap_raw_read(map
,
2310 reg
+ (i
* map
->reg_stride
),
2311 val
+ (i
* val_bytes
),
2317 ret
= regmap_raw_read(map
, reg
, val
,
2318 val_bytes
* val_count
);
2323 for (i
= 0; i
< val_count
* val_bytes
; i
+= val_bytes
)
2324 map
->format
.parse_inplace(val
+ i
);
2326 for (i
= 0; i
< val_count
; i
++) {
2328 ret
= regmap_read(map
, reg
+ (i
* map
->reg_stride
),
2332 map
->format
.format_val(val
+ (i
* val_bytes
), ival
, 0);
2338 EXPORT_SYMBOL_GPL(regmap_bulk_read
);
2340 static int _regmap_update_bits(struct regmap
*map
, unsigned int reg
,
2341 unsigned int mask
, unsigned int val
,
2342 bool *change
, bool force_write
)
2345 unsigned int tmp
, orig
;
2347 ret
= _regmap_read(map
, reg
, &orig
);
2354 if (force_write
|| (tmp
!= orig
)) {
2355 ret
= _regmap_write(map
, reg
, tmp
);
2367 * regmap_update_bits: Perform a read/modify/write cycle on the register map
2369 * @map: Register map to update
2370 * @reg: Register to update
2371 * @mask: Bitmask to change
2372 * @val: New value for bitmask
2374 * Returns zero for success, a negative number on error.
2376 int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
2377 unsigned int mask
, unsigned int val
)
2381 map
->lock(map
->lock_arg
);
2382 ret
= _regmap_update_bits(map
, reg
, mask
, val
, NULL
, false);
2383 map
->unlock(map
->lock_arg
);
2387 EXPORT_SYMBOL_GPL(regmap_update_bits
);
2390 * regmap_write_bits: Perform a read/modify/write cycle on the register map
2392 * @map: Register map to update
2393 * @reg: Register to update
2394 * @mask: Bitmask to change
2395 * @val: New value for bitmask
2397 * Returns zero for success, a negative number on error.
2399 int regmap_write_bits(struct regmap
*map
, unsigned int reg
,
2400 unsigned int mask
, unsigned int val
)
2404 map
->lock(map
->lock_arg
);
2405 ret
= _regmap_update_bits(map
, reg
, mask
, val
, NULL
, true);
2406 map
->unlock(map
->lock_arg
);
2410 EXPORT_SYMBOL_GPL(regmap_write_bits
);
2413 * regmap_update_bits_async: Perform a read/modify/write cycle on the register
2414 * map asynchronously
2416 * @map: Register map to update
2417 * @reg: Register to update
2418 * @mask: Bitmask to change
2419 * @val: New value for bitmask
2421 * With most buses the read must be done synchronously so this is most
2422 * useful for devices with a cache which do not need to interact with
2423 * the hardware to determine the current register value.
2425 * Returns zero for success, a negative number on error.
2427 int regmap_update_bits_async(struct regmap
*map
, unsigned int reg
,
2428 unsigned int mask
, unsigned int val
)
2432 map
->lock(map
->lock_arg
);
2436 ret
= _regmap_update_bits(map
, reg
, mask
, val
, NULL
, false);
2440 map
->unlock(map
->lock_arg
);
2444 EXPORT_SYMBOL_GPL(regmap_update_bits_async
);
2447 * regmap_update_bits_check: Perform a read/modify/write cycle on the
2448 * register map and report if updated
2450 * @map: Register map to update
2451 * @reg: Register to update
2452 * @mask: Bitmask to change
2453 * @val: New value for bitmask
2454 * @change: Boolean indicating if a write was done
2456 * Returns zero for success, a negative number on error.
2458 int regmap_update_bits_check(struct regmap
*map
, unsigned int reg
,
2459 unsigned int mask
, unsigned int val
,
2464 map
->lock(map
->lock_arg
);
2465 ret
= _regmap_update_bits(map
, reg
, mask
, val
, change
, false);
2466 map
->unlock(map
->lock_arg
);
2469 EXPORT_SYMBOL_GPL(regmap_update_bits_check
);
2472 * regmap_update_bits_check_async: Perform a read/modify/write cycle on the
2473 * register map asynchronously and report if
2476 * @map: Register map to update
2477 * @reg: Register to update
2478 * @mask: Bitmask to change
2479 * @val: New value for bitmask
2480 * @change: Boolean indicating if a write was done
2482 * With most buses the read must be done synchronously so this is most
2483 * useful for devices with a cache which do not need to interact with
2484 * the hardware to determine the current register value.
2486 * Returns zero for success, a negative number on error.
2488 int regmap_update_bits_check_async(struct regmap
*map
, unsigned int reg
,
2489 unsigned int mask
, unsigned int val
,
2494 map
->lock(map
->lock_arg
);
2498 ret
= _regmap_update_bits(map
, reg
, mask
, val
, change
, false);
2502 map
->unlock(map
->lock_arg
);
2506 EXPORT_SYMBOL_GPL(regmap_update_bits_check_async
);
2508 void regmap_async_complete_cb(struct regmap_async
*async
, int ret
)
2510 struct regmap
*map
= async
->map
;
2513 trace_regmap_async_io_complete(map
);
2515 spin_lock(&map
->async_lock
);
2516 list_move(&async
->list
, &map
->async_free
);
2517 wake
= list_empty(&map
->async_list
);
2520 map
->async_ret
= ret
;
2522 spin_unlock(&map
->async_lock
);
2525 wake_up(&map
->async_waitq
);
2527 EXPORT_SYMBOL_GPL(regmap_async_complete_cb
);
2529 static int regmap_async_is_done(struct regmap
*map
)
2531 unsigned long flags
;
2534 spin_lock_irqsave(&map
->async_lock
, flags
);
2535 ret
= list_empty(&map
->async_list
);
2536 spin_unlock_irqrestore(&map
->async_lock
, flags
);
2542 * regmap_async_complete: Ensure all asynchronous I/O has completed.
2544 * @map: Map to operate on.
2546 * Blocks until any pending asynchronous I/O has completed. Returns
2547 * an error code for any failed I/O operations.
2549 int regmap_async_complete(struct regmap
*map
)
2551 unsigned long flags
;
2554 /* Nothing to do with no async support */
2555 if (!map
->bus
|| !map
->bus
->async_write
)
2558 trace_regmap_async_complete_start(map
);
2560 wait_event(map
->async_waitq
, regmap_async_is_done(map
));
2562 spin_lock_irqsave(&map
->async_lock
, flags
);
2563 ret
= map
->async_ret
;
2565 spin_unlock_irqrestore(&map
->async_lock
, flags
);
2567 trace_regmap_async_complete_done(map
);
2571 EXPORT_SYMBOL_GPL(regmap_async_complete
);
2574 * regmap_register_patch: Register and apply register updates to be applied
2575 * on device initialistion
2577 * @map: Register map to apply updates to.
2578 * @regs: Values to update.
2579 * @num_regs: Number of entries in regs.
2581 * Register a set of register updates to be applied to the device
2582 * whenever the device registers are synchronised with the cache and
2583 * apply them immediately. Typically this is used to apply
2584 * corrections to be applied to the device defaults on startup, such
2585 * as the updates some vendors provide to undocumented registers.
2587 * The caller must ensure that this function cannot be called
2588 * concurrently with either itself or regcache_sync().
2590 int regmap_register_patch(struct regmap
*map
, const struct reg_default
*regs
,
2593 struct reg_default
*p
;
2597 if (WARN_ONCE(num_regs
<= 0, "invalid registers number (%d)\n",
2601 p
= krealloc(map
->patch
,
2602 sizeof(struct reg_default
) * (map
->patch_regs
+ num_regs
),
2605 memcpy(p
+ map
->patch_regs
, regs
, num_regs
* sizeof(*regs
));
2607 map
->patch_regs
+= num_regs
;
2612 map
->lock(map
->lock_arg
);
2614 bypass
= map
->cache_bypass
;
2616 map
->cache_bypass
= true;
2619 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
2622 map
->cache_bypass
= bypass
;
2624 map
->unlock(map
->lock_arg
);
2626 regmap_async_complete(map
);
2630 EXPORT_SYMBOL_GPL(regmap_register_patch
);
2633 * regmap_get_val_bytes(): Report the size of a register value
2635 * Report the size of a register value, mainly intended to for use by
2636 * generic infrastructure built on top of regmap.
2638 int regmap_get_val_bytes(struct regmap
*map
)
2640 if (map
->format
.format_write
)
2643 return map
->format
.val_bytes
;
2645 EXPORT_SYMBOL_GPL(regmap_get_val_bytes
);
2648 * regmap_get_max_register(): Report the max register value
2650 * Report the max register value, mainly intended to for use by
2651 * generic infrastructure built on top of regmap.
2653 int regmap_get_max_register(struct regmap
*map
)
2655 return map
->max_register
? map
->max_register
: -EINVAL
;
2657 EXPORT_SYMBOL_GPL(regmap_get_max_register
);
2660 * regmap_get_reg_stride(): Report the register address stride
2662 * Report the register address stride, mainly intended to for use by
2663 * generic infrastructure built on top of regmap.
2665 int regmap_get_reg_stride(struct regmap
*map
)
2667 return map
->reg_stride
;
2669 EXPORT_SYMBOL_GPL(regmap_get_reg_stride
);
2671 int regmap_parse_val(struct regmap
*map
, const void *buf
,
2674 if (!map
->format
.parse_val
)
2677 *val
= map
->format
.parse_val(buf
);
2681 EXPORT_SYMBOL_GPL(regmap_parse_val
);
2683 static int __init
regmap_initcall(void)
2685 regmap_debugfs_initcall();
2689 postcore_initcall(regmap_initcall
);