1 // SPDX-License-Identifier: GPL-2.0
3 // Register map access API
5 // Copyright 2011 Wolfson Microelectronics plc
7 // Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
9 #include <linux/device.h>
10 #include <linux/slab.h>
11 #include <linux/export.h>
12 #include <linux/mutex.h>
13 #include <linux/err.h>
14 #include <linux/property.h>
15 #include <linux/rbtree.h>
16 #include <linux/sched.h>
17 #include <linux/delay.h>
18 #include <linux/log2.h>
19 #include <linux/hwspinlock.h>
20 #include <linux/unaligned.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.
36 static inline bool regmap_should_log(struct regmap
*map
)
38 return (map
->dev
&& strcmp(dev_name(map
->dev
), LOG_DEVICE
) == 0);
41 static inline bool regmap_should_log(struct regmap
*map
) { return false; }
45 static int _regmap_update_bits(struct regmap
*map
, unsigned int reg
,
46 unsigned int mask
, unsigned int val
,
47 bool *change
, bool force_write
);
49 static int _regmap_bus_reg_read(void *context
, unsigned int reg
,
51 static int _regmap_bus_read(void *context
, unsigned int reg
,
53 static int _regmap_bus_formatted_write(void *context
, unsigned int reg
,
55 static int _regmap_bus_reg_write(void *context
, unsigned int reg
,
57 static int _regmap_bus_raw_write(void *context
, unsigned int reg
,
60 bool regmap_reg_in_ranges(unsigned int reg
,
61 const struct regmap_range
*ranges
,
64 const struct regmap_range
*r
;
67 for (i
= 0, r
= ranges
; i
< nranges
; i
++, r
++)
68 if (regmap_reg_in_range(reg
, r
))
72 EXPORT_SYMBOL_GPL(regmap_reg_in_ranges
);
74 bool regmap_check_range_table(struct regmap
*map
, unsigned int reg
,
75 const struct regmap_access_table
*table
)
77 /* Check "no ranges" first */
78 if (regmap_reg_in_ranges(reg
, table
->no_ranges
, table
->n_no_ranges
))
81 /* In case zero "yes ranges" are supplied, any reg is OK */
82 if (!table
->n_yes_ranges
)
85 return regmap_reg_in_ranges(reg
, table
->yes_ranges
,
88 EXPORT_SYMBOL_GPL(regmap_check_range_table
);
90 bool regmap_writeable(struct regmap
*map
, unsigned int reg
)
92 if (map
->max_register_is_set
&& reg
> map
->max_register
)
95 if (map
->writeable_reg
)
96 return map
->writeable_reg(map
->dev
, reg
);
99 return regmap_check_range_table(map
, reg
, map
->wr_table
);
104 bool regmap_cached(struct regmap
*map
, unsigned int reg
)
109 if (map
->cache_type
== REGCACHE_NONE
)
115 if (map
->max_register_is_set
&& reg
> map
->max_register
)
118 map
->lock(map
->lock_arg
);
119 ret
= regcache_read(map
, reg
, &val
);
120 map
->unlock(map
->lock_arg
);
127 bool regmap_readable(struct regmap
*map
, unsigned int reg
)
132 if (map
->max_register_is_set
&& reg
> map
->max_register
)
135 if (map
->format
.format_write
)
138 if (map
->readable_reg
)
139 return map
->readable_reg(map
->dev
, reg
);
142 return regmap_check_range_table(map
, reg
, map
->rd_table
);
147 bool regmap_volatile(struct regmap
*map
, unsigned int reg
)
149 if (!map
->format
.format_write
&& !regmap_readable(map
, reg
))
152 if (map
->volatile_reg
)
153 return map
->volatile_reg(map
->dev
, reg
);
155 if (map
->volatile_table
)
156 return regmap_check_range_table(map
, reg
, map
->volatile_table
);
164 bool regmap_precious(struct regmap
*map
, unsigned int reg
)
166 if (!regmap_readable(map
, reg
))
169 if (map
->precious_reg
)
170 return map
->precious_reg(map
->dev
, reg
);
172 if (map
->precious_table
)
173 return regmap_check_range_table(map
, reg
, map
->precious_table
);
178 bool regmap_writeable_noinc(struct regmap
*map
, unsigned int reg
)
180 if (map
->writeable_noinc_reg
)
181 return map
->writeable_noinc_reg(map
->dev
, reg
);
183 if (map
->wr_noinc_table
)
184 return regmap_check_range_table(map
, reg
, map
->wr_noinc_table
);
189 bool regmap_readable_noinc(struct regmap
*map
, unsigned int reg
)
191 if (map
->readable_noinc_reg
)
192 return map
->readable_noinc_reg(map
->dev
, reg
);
194 if (map
->rd_noinc_table
)
195 return regmap_check_range_table(map
, reg
, map
->rd_noinc_table
);
200 static bool regmap_volatile_range(struct regmap
*map
, unsigned int reg
,
205 for (i
= 0; i
< num
; i
++)
206 if (!regmap_volatile(map
, reg
+ regmap_get_offset(map
, i
)))
212 static void regmap_format_12_20_write(struct regmap
*map
,
213 unsigned int reg
, unsigned int val
)
215 u8
*out
= map
->work_buf
;
218 out
[1] = (reg
<< 4) | (val
>> 16);
224 static void regmap_format_2_6_write(struct regmap
*map
,
225 unsigned int reg
, unsigned int val
)
227 u8
*out
= map
->work_buf
;
229 *out
= (reg
<< 6) | val
;
232 static void regmap_format_4_12_write(struct regmap
*map
,
233 unsigned int reg
, unsigned int val
)
235 __be16
*out
= map
->work_buf
;
236 *out
= cpu_to_be16((reg
<< 12) | val
);
239 static void regmap_format_7_9_write(struct regmap
*map
,
240 unsigned int reg
, unsigned int val
)
242 __be16
*out
= map
->work_buf
;
243 *out
= cpu_to_be16((reg
<< 9) | val
);
246 static void regmap_format_7_17_write(struct regmap
*map
,
247 unsigned int reg
, unsigned int val
)
249 u8
*out
= map
->work_buf
;
253 out
[0] = (val
>> 16) | (reg
<< 1);
256 static void regmap_format_10_14_write(struct regmap
*map
,
257 unsigned int reg
, unsigned int val
)
259 u8
*out
= map
->work_buf
;
262 out
[1] = (val
>> 8) | (reg
<< 6);
266 static void regmap_format_8(void *buf
, unsigned int val
, unsigned int shift
)
273 static void regmap_format_16_be(void *buf
, unsigned int val
, unsigned int shift
)
275 put_unaligned_be16(val
<< shift
, buf
);
278 static void regmap_format_16_le(void *buf
, unsigned int val
, unsigned int shift
)
280 put_unaligned_le16(val
<< shift
, buf
);
283 static void regmap_format_16_native(void *buf
, unsigned int val
,
286 u16 v
= val
<< shift
;
288 memcpy(buf
, &v
, sizeof(v
));
291 static void regmap_format_24_be(void *buf
, unsigned int val
, unsigned int shift
)
293 put_unaligned_be24(val
<< shift
, buf
);
296 static void regmap_format_32_be(void *buf
, unsigned int val
, unsigned int shift
)
298 put_unaligned_be32(val
<< shift
, buf
);
301 static void regmap_format_32_le(void *buf
, unsigned int val
, unsigned int shift
)
303 put_unaligned_le32(val
<< shift
, buf
);
306 static void regmap_format_32_native(void *buf
, unsigned int val
,
309 u32 v
= val
<< shift
;
311 memcpy(buf
, &v
, sizeof(v
));
314 static void regmap_parse_inplace_noop(void *buf
)
318 static unsigned int regmap_parse_8(const void *buf
)
325 static unsigned int regmap_parse_16_be(const void *buf
)
327 return get_unaligned_be16(buf
);
330 static unsigned int regmap_parse_16_le(const void *buf
)
332 return get_unaligned_le16(buf
);
335 static void regmap_parse_16_be_inplace(void *buf
)
337 u16 v
= get_unaligned_be16(buf
);
339 memcpy(buf
, &v
, sizeof(v
));
342 static void regmap_parse_16_le_inplace(void *buf
)
344 u16 v
= get_unaligned_le16(buf
);
346 memcpy(buf
, &v
, sizeof(v
));
349 static unsigned int regmap_parse_16_native(const void *buf
)
353 memcpy(&v
, buf
, sizeof(v
));
357 static unsigned int regmap_parse_24_be(const void *buf
)
359 return get_unaligned_be24(buf
);
362 static unsigned int regmap_parse_32_be(const void *buf
)
364 return get_unaligned_be32(buf
);
367 static unsigned int regmap_parse_32_le(const void *buf
)
369 return get_unaligned_le32(buf
);
372 static void regmap_parse_32_be_inplace(void *buf
)
374 u32 v
= get_unaligned_be32(buf
);
376 memcpy(buf
, &v
, sizeof(v
));
379 static void regmap_parse_32_le_inplace(void *buf
)
381 u32 v
= get_unaligned_le32(buf
);
383 memcpy(buf
, &v
, sizeof(v
));
386 static unsigned int regmap_parse_32_native(const void *buf
)
390 memcpy(&v
, buf
, sizeof(v
));
394 static void regmap_lock_hwlock(void *__map
)
396 struct regmap
*map
= __map
;
398 hwspin_lock_timeout(map
->hwlock
, UINT_MAX
);
401 static void regmap_lock_hwlock_irq(void *__map
)
403 struct regmap
*map
= __map
;
405 hwspin_lock_timeout_irq(map
->hwlock
, UINT_MAX
);
408 static void regmap_lock_hwlock_irqsave(void *__map
)
410 struct regmap
*map
= __map
;
412 hwspin_lock_timeout_irqsave(map
->hwlock
, UINT_MAX
,
413 &map
->spinlock_flags
);
416 static void regmap_unlock_hwlock(void *__map
)
418 struct regmap
*map
= __map
;
420 hwspin_unlock(map
->hwlock
);
423 static void regmap_unlock_hwlock_irq(void *__map
)
425 struct regmap
*map
= __map
;
427 hwspin_unlock_irq(map
->hwlock
);
430 static void regmap_unlock_hwlock_irqrestore(void *__map
)
432 struct regmap
*map
= __map
;
434 hwspin_unlock_irqrestore(map
->hwlock
, &map
->spinlock_flags
);
437 static void regmap_lock_unlock_none(void *__map
)
442 static void regmap_lock_mutex(void *__map
)
444 struct regmap
*map
= __map
;
445 mutex_lock(&map
->mutex
);
448 static void regmap_unlock_mutex(void *__map
)
450 struct regmap
*map
= __map
;
451 mutex_unlock(&map
->mutex
);
454 static void regmap_lock_spinlock(void *__map
)
455 __acquires(&map
->spinlock
)
457 struct regmap
*map
= __map
;
460 spin_lock_irqsave(&map
->spinlock
, flags
);
461 map
->spinlock_flags
= flags
;
464 static void regmap_unlock_spinlock(void *__map
)
465 __releases(&map
->spinlock
)
467 struct regmap
*map
= __map
;
468 spin_unlock_irqrestore(&map
->spinlock
, map
->spinlock_flags
);
471 static void regmap_lock_raw_spinlock(void *__map
)
472 __acquires(&map
->raw_spinlock
)
474 struct regmap
*map
= __map
;
477 raw_spin_lock_irqsave(&map
->raw_spinlock
, flags
);
478 map
->raw_spinlock_flags
= flags
;
481 static void regmap_unlock_raw_spinlock(void *__map
)
482 __releases(&map
->raw_spinlock
)
484 struct regmap
*map
= __map
;
485 raw_spin_unlock_irqrestore(&map
->raw_spinlock
, map
->raw_spinlock_flags
);
488 static void dev_get_regmap_release(struct device
*dev
, void *res
)
491 * We don't actually have anything to do here; the goal here
492 * is not to manage the regmap but to provide a simple way to
493 * get the regmap back given a struct device.
497 static bool _regmap_range_add(struct regmap
*map
,
498 struct regmap_range_node
*data
)
500 struct rb_root
*root
= &map
->range_tree
;
501 struct rb_node
**new = &(root
->rb_node
), *parent
= NULL
;
504 struct regmap_range_node
*this =
505 rb_entry(*new, struct regmap_range_node
, node
);
508 if (data
->range_max
< this->range_min
)
509 new = &((*new)->rb_left
);
510 else if (data
->range_min
> this->range_max
)
511 new = &((*new)->rb_right
);
516 rb_link_node(&data
->node
, parent
, new);
517 rb_insert_color(&data
->node
, root
);
522 static struct regmap_range_node
*_regmap_range_lookup(struct regmap
*map
,
525 struct rb_node
*node
= map
->range_tree
.rb_node
;
528 struct regmap_range_node
*this =
529 rb_entry(node
, struct regmap_range_node
, node
);
531 if (reg
< this->range_min
)
532 node
= node
->rb_left
;
533 else if (reg
> this->range_max
)
534 node
= node
->rb_right
;
542 static void regmap_range_exit(struct regmap
*map
)
544 struct rb_node
*next
;
545 struct regmap_range_node
*range_node
;
547 next
= rb_first(&map
->range_tree
);
549 range_node
= rb_entry(next
, struct regmap_range_node
, node
);
550 next
= rb_next(&range_node
->node
);
551 rb_erase(&range_node
->node
, &map
->range_tree
);
555 kfree(map
->selector_work_buf
);
558 static int regmap_set_name(struct regmap
*map
, const struct regmap_config
*config
)
561 const char *name
= kstrdup_const(config
->name
, GFP_KERNEL
);
566 kfree_const(map
->name
);
573 int regmap_attach_dev(struct device
*dev
, struct regmap
*map
,
574 const struct regmap_config
*config
)
581 ret
= regmap_set_name(map
, config
);
585 regmap_debugfs_exit(map
);
586 regmap_debugfs_init(map
);
588 /* Add a devres resource for dev_get_regmap() */
589 m
= devres_alloc(dev_get_regmap_release
, sizeof(*m
), GFP_KERNEL
);
591 regmap_debugfs_exit(map
);
599 EXPORT_SYMBOL_GPL(regmap_attach_dev
);
601 static int dev_get_regmap_match(struct device
*dev
, void *res
, void *data
);
603 static int regmap_detach_dev(struct device
*dev
, struct regmap
*map
)
608 return devres_release(dev
, dev_get_regmap_release
,
609 dev_get_regmap_match
, (void *)map
->name
);
612 static enum regmap_endian
regmap_get_reg_endian(const struct regmap_bus
*bus
,
613 const struct regmap_config
*config
)
615 enum regmap_endian endian
;
617 /* Retrieve the endianness specification from the regmap config */
618 endian
= config
->reg_format_endian
;
620 /* If the regmap config specified a non-default value, use that */
621 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
624 /* Retrieve the endianness specification from the bus config */
625 if (bus
&& bus
->reg_format_endian_default
)
626 endian
= bus
->reg_format_endian_default
;
628 /* If the bus specified a non-default value, use that */
629 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
632 /* Use this if no other value was found */
633 return REGMAP_ENDIAN_BIG
;
636 enum regmap_endian
regmap_get_val_endian(struct device
*dev
,
637 const struct regmap_bus
*bus
,
638 const struct regmap_config
*config
)
640 struct fwnode_handle
*fwnode
= dev
? dev_fwnode(dev
) : NULL
;
641 enum regmap_endian endian
;
643 /* Retrieve the endianness specification from the regmap config */
644 endian
= config
->val_format_endian
;
646 /* If the regmap config specified a non-default value, use that */
647 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
650 /* If the firmware node exist try to get endianness from it */
651 if (fwnode_property_read_bool(fwnode
, "big-endian"))
652 endian
= REGMAP_ENDIAN_BIG
;
653 else if (fwnode_property_read_bool(fwnode
, "little-endian"))
654 endian
= REGMAP_ENDIAN_LITTLE
;
655 else if (fwnode_property_read_bool(fwnode
, "native-endian"))
656 endian
= REGMAP_ENDIAN_NATIVE
;
658 /* If the endianness was specified in fwnode, use that */
659 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
662 /* Retrieve the endianness specification from the bus config */
663 if (bus
&& bus
->val_format_endian_default
)
664 endian
= bus
->val_format_endian_default
;
666 /* If the bus specified a non-default value, use that */
667 if (endian
!= REGMAP_ENDIAN_DEFAULT
)
670 /* Use this if no other value was found */
671 return REGMAP_ENDIAN_BIG
;
673 EXPORT_SYMBOL_GPL(regmap_get_val_endian
);
675 struct regmap
*__regmap_init(struct device
*dev
,
676 const struct regmap_bus
*bus
,
678 const struct regmap_config
*config
,
679 struct lock_class_key
*lock_key
,
680 const char *lock_name
)
684 enum regmap_endian reg_endian
, val_endian
;
690 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
696 ret
= regmap_set_name(map
, config
);
700 ret
= -EINVAL
; /* Later error paths rely on this */
702 if (config
->disable_locking
) {
703 map
->lock
= map
->unlock
= regmap_lock_unlock_none
;
704 map
->can_sleep
= config
->can_sleep
;
705 regmap_debugfs_disable(map
);
706 } else if (config
->lock
&& config
->unlock
) {
707 map
->lock
= config
->lock
;
708 map
->unlock
= config
->unlock
;
709 map
->lock_arg
= config
->lock_arg
;
710 map
->can_sleep
= config
->can_sleep
;
711 } else if (config
->use_hwlock
) {
712 map
->hwlock
= hwspin_lock_request_specific(config
->hwlock_id
);
718 switch (config
->hwlock_mode
) {
719 case HWLOCK_IRQSTATE
:
720 map
->lock
= regmap_lock_hwlock_irqsave
;
721 map
->unlock
= regmap_unlock_hwlock_irqrestore
;
724 map
->lock
= regmap_lock_hwlock_irq
;
725 map
->unlock
= regmap_unlock_hwlock_irq
;
728 map
->lock
= regmap_lock_hwlock
;
729 map
->unlock
= regmap_unlock_hwlock
;
735 if ((bus
&& bus
->fast_io
) ||
737 if (config
->use_raw_spinlock
) {
738 raw_spin_lock_init(&map
->raw_spinlock
);
739 map
->lock
= regmap_lock_raw_spinlock
;
740 map
->unlock
= regmap_unlock_raw_spinlock
;
741 lockdep_set_class_and_name(&map
->raw_spinlock
,
742 lock_key
, lock_name
);
744 spin_lock_init(&map
->spinlock
);
745 map
->lock
= regmap_lock_spinlock
;
746 map
->unlock
= regmap_unlock_spinlock
;
747 lockdep_set_class_and_name(&map
->spinlock
,
748 lock_key
, lock_name
);
751 mutex_init(&map
->mutex
);
752 map
->lock
= regmap_lock_mutex
;
753 map
->unlock
= regmap_unlock_mutex
;
754 map
->can_sleep
= true;
755 lockdep_set_class_and_name(&map
->mutex
,
756 lock_key
, lock_name
);
759 map
->lock_key
= lock_key
;
763 * When we write in fast-paths with regmap_bulk_write() don't allocate
764 * scratch buffers with sleeping allocations.
766 if ((bus
&& bus
->fast_io
) || config
->fast_io
)
767 map
->alloc_flags
= GFP_ATOMIC
;
769 map
->alloc_flags
= GFP_KERNEL
;
771 map
->reg_base
= config
->reg_base
;
773 map
->format
.reg_bytes
= DIV_ROUND_UP(config
->reg_bits
, 8);
774 map
->format
.pad_bytes
= config
->pad_bits
/ 8;
775 map
->format
.reg_shift
= config
->reg_shift
;
776 map
->format
.val_bytes
= DIV_ROUND_UP(config
->val_bits
, 8);
777 map
->format
.buf_size
= DIV_ROUND_UP(config
->reg_bits
+
778 config
->val_bits
+ config
->pad_bits
, 8);
779 map
->reg_shift
= config
->pad_bits
% 8;
780 if (config
->reg_stride
)
781 map
->reg_stride
= config
->reg_stride
;
784 if (is_power_of_2(map
->reg_stride
))
785 map
->reg_stride_order
= ilog2(map
->reg_stride
);
787 map
->reg_stride_order
= -1;
788 map
->use_single_read
= config
->use_single_read
|| !(config
->read
|| (bus
&& bus
->read
));
789 map
->use_single_write
= config
->use_single_write
|| !(config
->write
|| (bus
&& bus
->write
));
790 map
->can_multi_write
= config
->can_multi_write
&& (config
->write
|| (bus
&& bus
->write
));
792 map
->max_raw_read
= bus
->max_raw_read
;
793 map
->max_raw_write
= bus
->max_raw_write
;
794 } else if (config
->max_raw_read
&& config
->max_raw_write
) {
795 map
->max_raw_read
= config
->max_raw_read
;
796 map
->max_raw_write
= config
->max_raw_write
;
800 map
->bus_context
= bus_context
;
801 map
->max_register
= config
->max_register
;
802 map
->max_register_is_set
= map
->max_register
?: config
->max_register_is_0
;
803 map
->wr_table
= config
->wr_table
;
804 map
->rd_table
= config
->rd_table
;
805 map
->volatile_table
= config
->volatile_table
;
806 map
->precious_table
= config
->precious_table
;
807 map
->wr_noinc_table
= config
->wr_noinc_table
;
808 map
->rd_noinc_table
= config
->rd_noinc_table
;
809 map
->writeable_reg
= config
->writeable_reg
;
810 map
->readable_reg
= config
->readable_reg
;
811 map
->volatile_reg
= config
->volatile_reg
;
812 map
->precious_reg
= config
->precious_reg
;
813 map
->writeable_noinc_reg
= config
->writeable_noinc_reg
;
814 map
->readable_noinc_reg
= config
->readable_noinc_reg
;
815 map
->cache_type
= config
->cache_type
;
817 spin_lock_init(&map
->async_lock
);
818 INIT_LIST_HEAD(&map
->async_list
);
819 INIT_LIST_HEAD(&map
->async_free
);
820 init_waitqueue_head(&map
->async_waitq
);
822 if (config
->read_flag_mask
||
823 config
->write_flag_mask
||
824 config
->zero_flag_mask
) {
825 map
->read_flag_mask
= config
->read_flag_mask
;
826 map
->write_flag_mask
= config
->write_flag_mask
;
828 map
->read_flag_mask
= bus
->read_flag_mask
;
831 if (config
&& config
->read
&& config
->write
) {
832 map
->reg_read
= _regmap_bus_read
;
833 if (config
->reg_update_bits
)
834 map
->reg_update_bits
= config
->reg_update_bits
;
836 /* Bulk read/write */
837 map
->read
= config
->read
;
838 map
->write
= config
->write
;
840 reg_endian
= REGMAP_ENDIAN_NATIVE
;
841 val_endian
= REGMAP_ENDIAN_NATIVE
;
843 map
->reg_read
= config
->reg_read
;
844 map
->reg_write
= config
->reg_write
;
845 map
->reg_update_bits
= config
->reg_update_bits
;
847 map
->defer_caching
= false;
848 goto skip_format_initialization
;
849 } else if (!bus
->read
|| !bus
->write
) {
850 map
->reg_read
= _regmap_bus_reg_read
;
851 map
->reg_write
= _regmap_bus_reg_write
;
852 map
->reg_update_bits
= bus
->reg_update_bits
;
854 map
->defer_caching
= false;
855 goto skip_format_initialization
;
857 map
->reg_read
= _regmap_bus_read
;
858 map
->reg_update_bits
= bus
->reg_update_bits
;
859 /* Bulk read/write */
860 map
->read
= bus
->read
;
861 map
->write
= bus
->write
;
863 reg_endian
= regmap_get_reg_endian(bus
, config
);
864 val_endian
= regmap_get_val_endian(dev
, bus
, config
);
867 switch (config
->reg_bits
+ map
->reg_shift
) {
869 switch (config
->val_bits
) {
871 map
->format
.format_write
= regmap_format_2_6_write
;
879 switch (config
->val_bits
) {
881 map
->format
.format_write
= regmap_format_4_12_write
;
889 switch (config
->val_bits
) {
891 map
->format
.format_write
= regmap_format_7_9_write
;
894 map
->format
.format_write
= regmap_format_7_17_write
;
902 switch (config
->val_bits
) {
904 map
->format
.format_write
= regmap_format_10_14_write
;
912 switch (config
->val_bits
) {
914 map
->format
.format_write
= regmap_format_12_20_write
;
922 map
->format
.format_reg
= regmap_format_8
;
926 switch (reg_endian
) {
927 case REGMAP_ENDIAN_BIG
:
928 map
->format
.format_reg
= regmap_format_16_be
;
930 case REGMAP_ENDIAN_LITTLE
:
931 map
->format
.format_reg
= regmap_format_16_le
;
933 case REGMAP_ENDIAN_NATIVE
:
934 map
->format
.format_reg
= regmap_format_16_native
;
942 switch (reg_endian
) {
943 case REGMAP_ENDIAN_BIG
:
944 map
->format
.format_reg
= regmap_format_24_be
;
952 switch (reg_endian
) {
953 case REGMAP_ENDIAN_BIG
:
954 map
->format
.format_reg
= regmap_format_32_be
;
956 case REGMAP_ENDIAN_LITTLE
:
957 map
->format
.format_reg
= regmap_format_32_le
;
959 case REGMAP_ENDIAN_NATIVE
:
960 map
->format
.format_reg
= regmap_format_32_native
;
971 if (val_endian
== REGMAP_ENDIAN_NATIVE
)
972 map
->format
.parse_inplace
= regmap_parse_inplace_noop
;
974 switch (config
->val_bits
) {
976 map
->format
.format_val
= regmap_format_8
;
977 map
->format
.parse_val
= regmap_parse_8
;
978 map
->format
.parse_inplace
= regmap_parse_inplace_noop
;
981 switch (val_endian
) {
982 case REGMAP_ENDIAN_BIG
:
983 map
->format
.format_val
= regmap_format_16_be
;
984 map
->format
.parse_val
= regmap_parse_16_be
;
985 map
->format
.parse_inplace
= regmap_parse_16_be_inplace
;
987 case REGMAP_ENDIAN_LITTLE
:
988 map
->format
.format_val
= regmap_format_16_le
;
989 map
->format
.parse_val
= regmap_parse_16_le
;
990 map
->format
.parse_inplace
= regmap_parse_16_le_inplace
;
992 case REGMAP_ENDIAN_NATIVE
:
993 map
->format
.format_val
= regmap_format_16_native
;
994 map
->format
.parse_val
= regmap_parse_16_native
;
1001 switch (val_endian
) {
1002 case REGMAP_ENDIAN_BIG
:
1003 map
->format
.format_val
= regmap_format_24_be
;
1004 map
->format
.parse_val
= regmap_parse_24_be
;
1011 switch (val_endian
) {
1012 case REGMAP_ENDIAN_BIG
:
1013 map
->format
.format_val
= regmap_format_32_be
;
1014 map
->format
.parse_val
= regmap_parse_32_be
;
1015 map
->format
.parse_inplace
= regmap_parse_32_be_inplace
;
1017 case REGMAP_ENDIAN_LITTLE
:
1018 map
->format
.format_val
= regmap_format_32_le
;
1019 map
->format
.parse_val
= regmap_parse_32_le
;
1020 map
->format
.parse_inplace
= regmap_parse_32_le_inplace
;
1022 case REGMAP_ENDIAN_NATIVE
:
1023 map
->format
.format_val
= regmap_format_32_native
;
1024 map
->format
.parse_val
= regmap_parse_32_native
;
1032 if (map
->format
.format_write
) {
1033 if ((reg_endian
!= REGMAP_ENDIAN_BIG
) ||
1034 (val_endian
!= REGMAP_ENDIAN_BIG
))
1036 map
->use_single_write
= true;
1039 if (!map
->format
.format_write
&&
1040 !(map
->format
.format_reg
&& map
->format
.format_val
))
1043 map
->work_buf
= kzalloc(map
->format
.buf_size
, GFP_KERNEL
);
1044 if (map
->work_buf
== NULL
) {
1049 if (map
->format
.format_write
) {
1050 map
->defer_caching
= false;
1051 map
->reg_write
= _regmap_bus_formatted_write
;
1052 } else if (map
->format
.format_val
) {
1053 map
->defer_caching
= true;
1054 map
->reg_write
= _regmap_bus_raw_write
;
1057 skip_format_initialization
:
1059 map
->range_tree
= RB_ROOT
;
1060 for (i
= 0; i
< config
->num_ranges
; i
++) {
1061 const struct regmap_range_cfg
*range_cfg
= &config
->ranges
[i
];
1062 struct regmap_range_node
*new;
1065 if (range_cfg
->range_max
< range_cfg
->range_min
) {
1066 dev_err(map
->dev
, "Invalid range %d: %u < %u\n", i
,
1067 range_cfg
->range_max
, range_cfg
->range_min
);
1071 if (range_cfg
->range_max
> map
->max_register
) {
1072 dev_err(map
->dev
, "Invalid range %d: %u > %u\n", i
,
1073 range_cfg
->range_max
, map
->max_register
);
1077 if (range_cfg
->selector_reg
> map
->max_register
) {
1079 "Invalid range %d: selector out of map\n", i
);
1083 if (range_cfg
->window_len
== 0) {
1084 dev_err(map
->dev
, "Invalid range %d: window_len 0\n",
1089 /* Make sure, that this register range has no selector
1090 or data window within its boundary */
1091 for (j
= 0; j
< config
->num_ranges
; j
++) {
1092 unsigned int sel_reg
= config
->ranges
[j
].selector_reg
;
1093 unsigned int win_min
= config
->ranges
[j
].window_start
;
1094 unsigned int win_max
= win_min
+
1095 config
->ranges
[j
].window_len
- 1;
1097 /* Allow data window inside its own virtual range */
1101 if (range_cfg
->range_min
<= sel_reg
&&
1102 sel_reg
<= range_cfg
->range_max
) {
1104 "Range %d: selector for %d in window\n",
1109 if (!(win_max
< range_cfg
->range_min
||
1110 win_min
> range_cfg
->range_max
)) {
1112 "Range %d: window for %d in window\n",
1118 new = kzalloc(sizeof(*new), GFP_KERNEL
);
1125 new->name
= range_cfg
->name
;
1126 new->range_min
= range_cfg
->range_min
;
1127 new->range_max
= range_cfg
->range_max
;
1128 new->selector_reg
= range_cfg
->selector_reg
;
1129 new->selector_mask
= range_cfg
->selector_mask
;
1130 new->selector_shift
= range_cfg
->selector_shift
;
1131 new->window_start
= range_cfg
->window_start
;
1132 new->window_len
= range_cfg
->window_len
;
1134 if (!_regmap_range_add(map
, new)) {
1135 dev_err(map
->dev
, "Failed to add range %d\n", i
);
1140 if (map
->selector_work_buf
== NULL
) {
1141 map
->selector_work_buf
=
1142 kzalloc(map
->format
.buf_size
, GFP_KERNEL
);
1143 if (map
->selector_work_buf
== NULL
) {
1150 ret
= regcache_init(map
, config
);
1155 ret
= regmap_attach_dev(dev
, map
, config
);
1159 regmap_debugfs_init(map
);
1167 regmap_range_exit(map
);
1168 kfree(map
->work_buf
);
1171 hwspin_lock_free(map
->hwlock
);
1173 kfree_const(map
->name
);
1177 return ERR_PTR(ret
);
1179 EXPORT_SYMBOL_GPL(__regmap_init
);
1181 static void devm_regmap_release(struct device
*dev
, void *res
)
1183 regmap_exit(*(struct regmap
**)res
);
1186 struct regmap
*__devm_regmap_init(struct device
*dev
,
1187 const struct regmap_bus
*bus
,
1189 const struct regmap_config
*config
,
1190 struct lock_class_key
*lock_key
,
1191 const char *lock_name
)
1193 struct regmap
**ptr
, *regmap
;
1195 ptr
= devres_alloc(devm_regmap_release
, sizeof(*ptr
), GFP_KERNEL
);
1197 return ERR_PTR(-ENOMEM
);
1199 regmap
= __regmap_init(dev
, bus
, bus_context
, config
,
1200 lock_key
, lock_name
);
1201 if (!IS_ERR(regmap
)) {
1203 devres_add(dev
, ptr
);
1210 EXPORT_SYMBOL_GPL(__devm_regmap_init
);
1212 static void regmap_field_init(struct regmap_field
*rm_field
,
1213 struct regmap
*regmap
, struct reg_field reg_field
)
1215 rm_field
->regmap
= regmap
;
1216 rm_field
->reg
= reg_field
.reg
;
1217 rm_field
->shift
= reg_field
.lsb
;
1218 rm_field
->mask
= GENMASK(reg_field
.msb
, reg_field
.lsb
);
1220 WARN_ONCE(rm_field
->mask
== 0, "invalid empty mask defined\n");
1222 rm_field
->id_size
= reg_field
.id_size
;
1223 rm_field
->id_offset
= reg_field
.id_offset
;
1227 * devm_regmap_field_alloc() - Allocate and initialise a register field.
1229 * @dev: Device that will be interacted with
1230 * @regmap: regmap bank in which this register field is located.
1231 * @reg_field: Register field with in the bank.
1233 * The return value will be an ERR_PTR() on error or a valid pointer
1234 * to a struct regmap_field. The regmap_field will be automatically freed
1235 * by the device management code.
1237 struct regmap_field
*devm_regmap_field_alloc(struct device
*dev
,
1238 struct regmap
*regmap
, struct reg_field reg_field
)
1240 struct regmap_field
*rm_field
= devm_kzalloc(dev
,
1241 sizeof(*rm_field
), GFP_KERNEL
);
1243 return ERR_PTR(-ENOMEM
);
1245 regmap_field_init(rm_field
, regmap
, reg_field
);
1250 EXPORT_SYMBOL_GPL(devm_regmap_field_alloc
);
1254 * regmap_field_bulk_alloc() - Allocate and initialise a bulk register field.
1256 * @regmap: regmap bank in which this register field is located.
1257 * @rm_field: regmap register fields within the bank.
1258 * @reg_field: Register fields within the bank.
1259 * @num_fields: Number of register fields.
1261 * The return value will be an -ENOMEM on error or zero for success.
1262 * Newly allocated regmap_fields should be freed by calling
1263 * regmap_field_bulk_free()
1265 int regmap_field_bulk_alloc(struct regmap
*regmap
,
1266 struct regmap_field
**rm_field
,
1267 const struct reg_field
*reg_field
,
1270 struct regmap_field
*rf
;
1273 rf
= kcalloc(num_fields
, sizeof(*rf
), GFP_KERNEL
);
1277 for (i
= 0; i
< num_fields
; i
++) {
1278 regmap_field_init(&rf
[i
], regmap
, reg_field
[i
]);
1279 rm_field
[i
] = &rf
[i
];
1284 EXPORT_SYMBOL_GPL(regmap_field_bulk_alloc
);
1287 * devm_regmap_field_bulk_alloc() - Allocate and initialise a bulk register
1290 * @dev: Device that will be interacted with
1291 * @regmap: regmap bank in which this register field is located.
1292 * @rm_field: regmap register fields within the bank.
1293 * @reg_field: Register fields within the bank.
1294 * @num_fields: Number of register fields.
1296 * The return value will be an -ENOMEM on error or zero for success.
1297 * Newly allocated regmap_fields will be automatically freed by the
1298 * device management code.
1300 int devm_regmap_field_bulk_alloc(struct device
*dev
,
1301 struct regmap
*regmap
,
1302 struct regmap_field
**rm_field
,
1303 const struct reg_field
*reg_field
,
1306 struct regmap_field
*rf
;
1309 rf
= devm_kcalloc(dev
, num_fields
, sizeof(*rf
), GFP_KERNEL
);
1313 for (i
= 0; i
< num_fields
; i
++) {
1314 regmap_field_init(&rf
[i
], regmap
, reg_field
[i
]);
1315 rm_field
[i
] = &rf
[i
];
1320 EXPORT_SYMBOL_GPL(devm_regmap_field_bulk_alloc
);
1323 * regmap_field_bulk_free() - Free register field allocated using
1324 * regmap_field_bulk_alloc.
1326 * @field: regmap fields which should be freed.
1328 void regmap_field_bulk_free(struct regmap_field
*field
)
1332 EXPORT_SYMBOL_GPL(regmap_field_bulk_free
);
1335 * devm_regmap_field_bulk_free() - Free a bulk register field allocated using
1336 * devm_regmap_field_bulk_alloc.
1338 * @dev: Device that will be interacted with
1339 * @field: regmap field which should be freed.
1341 * Free register field allocated using devm_regmap_field_bulk_alloc(). Usually
1342 * drivers need not call this function, as the memory allocated via devm
1343 * will be freed as per device-driver life-cycle.
1345 void devm_regmap_field_bulk_free(struct device
*dev
,
1346 struct regmap_field
*field
)
1348 devm_kfree(dev
, field
);
1350 EXPORT_SYMBOL_GPL(devm_regmap_field_bulk_free
);
1353 * devm_regmap_field_free() - Free a register field allocated using
1354 * devm_regmap_field_alloc.
1356 * @dev: Device that will be interacted with
1357 * @field: regmap field which should be freed.
1359 * Free register field allocated using devm_regmap_field_alloc(). Usually
1360 * drivers need not call this function, as the memory allocated via devm
1361 * will be freed as per device-driver life-cyle.
1363 void devm_regmap_field_free(struct device
*dev
,
1364 struct regmap_field
*field
)
1366 devm_kfree(dev
, field
);
1368 EXPORT_SYMBOL_GPL(devm_regmap_field_free
);
1371 * regmap_field_alloc() - Allocate and initialise a register field.
1373 * @regmap: regmap bank in which this register field is located.
1374 * @reg_field: Register field with in the bank.
1376 * The return value will be an ERR_PTR() on error or a valid pointer
1377 * to a struct regmap_field. The regmap_field should be freed by the
1378 * user once its finished working with it using regmap_field_free().
1380 struct regmap_field
*regmap_field_alloc(struct regmap
*regmap
,
1381 struct reg_field reg_field
)
1383 struct regmap_field
*rm_field
= kzalloc(sizeof(*rm_field
), GFP_KERNEL
);
1386 return ERR_PTR(-ENOMEM
);
1388 regmap_field_init(rm_field
, regmap
, reg_field
);
1392 EXPORT_SYMBOL_GPL(regmap_field_alloc
);
1395 * regmap_field_free() - Free register field allocated using
1396 * regmap_field_alloc.
1398 * @field: regmap field which should be freed.
1400 void regmap_field_free(struct regmap_field
*field
)
1404 EXPORT_SYMBOL_GPL(regmap_field_free
);
1407 * regmap_reinit_cache() - Reinitialise the current register cache
1409 * @map: Register map to operate on.
1410 * @config: New configuration. Only the cache data will be used.
1412 * Discard any existing register cache for the map and initialize a
1413 * new cache. This can be used to restore the cache to defaults or to
1414 * update the cache configuration to reflect runtime discovery of the
1417 * No explicit locking is done here, the user needs to ensure that
1418 * this function will not race with other calls to regmap.
1420 int regmap_reinit_cache(struct regmap
*map
, const struct regmap_config
*config
)
1425 regmap_debugfs_exit(map
);
1427 map
->max_register
= config
->max_register
;
1428 map
->max_register_is_set
= map
->max_register
?: config
->max_register_is_0
;
1429 map
->writeable_reg
= config
->writeable_reg
;
1430 map
->readable_reg
= config
->readable_reg
;
1431 map
->volatile_reg
= config
->volatile_reg
;
1432 map
->precious_reg
= config
->precious_reg
;
1433 map
->writeable_noinc_reg
= config
->writeable_noinc_reg
;
1434 map
->readable_noinc_reg
= config
->readable_noinc_reg
;
1435 map
->cache_type
= config
->cache_type
;
1437 ret
= regmap_set_name(map
, config
);
1441 regmap_debugfs_init(map
);
1443 map
->cache_bypass
= false;
1444 map
->cache_only
= false;
1446 return regcache_init(map
, config
);
1448 EXPORT_SYMBOL_GPL(regmap_reinit_cache
);
1451 * regmap_exit() - Free a previously allocated register map
1453 * @map: Register map to operate on.
1455 void regmap_exit(struct regmap
*map
)
1457 struct regmap_async
*async
;
1459 regmap_detach_dev(map
->dev
, map
);
1462 regmap_debugfs_exit(map
);
1463 regmap_range_exit(map
);
1464 if (map
->bus
&& map
->bus
->free_context
)
1465 map
->bus
->free_context(map
->bus_context
);
1466 kfree(map
->work_buf
);
1467 while (!list_empty(&map
->async_free
)) {
1468 async
= list_first_entry_or_null(&map
->async_free
,
1469 struct regmap_async
,
1471 list_del(&async
->list
);
1472 kfree(async
->work_buf
);
1476 hwspin_lock_free(map
->hwlock
);
1477 if (map
->lock
== regmap_lock_mutex
)
1478 mutex_destroy(&map
->mutex
);
1479 kfree_const(map
->name
);
1481 if (map
->bus
&& map
->bus
->free_on_exit
)
1485 EXPORT_SYMBOL_GPL(regmap_exit
);
1487 static int dev_get_regmap_match(struct device
*dev
, void *res
, void *data
)
1489 struct regmap
**r
= res
;
1495 /* If the user didn't specify a name match any */
1497 return (*r
)->name
&& !strcmp((*r
)->name
, data
);
1503 * dev_get_regmap() - Obtain the regmap (if any) for a device
1505 * @dev: Device to retrieve the map for
1506 * @name: Optional name for the register map, usually NULL.
1508 * Returns the regmap for the device if one is present, or NULL. If
1509 * name is specified then it must match the name specified when
1510 * registering the device, if it is NULL then the first regmap found
1511 * will be used. Devices with multiple register maps are very rare,
1512 * generic code should normally not need to specify a name.
1514 struct regmap
*dev_get_regmap(struct device
*dev
, const char *name
)
1516 struct regmap
**r
= devres_find(dev
, dev_get_regmap_release
,
1517 dev_get_regmap_match
, (void *)name
);
1523 EXPORT_SYMBOL_GPL(dev_get_regmap
);
1526 * regmap_get_device() - Obtain the device from a regmap
1528 * @map: Register map to operate on.
1530 * Returns the underlying device that the regmap has been created for.
1532 struct device
*regmap_get_device(struct regmap
*map
)
1536 EXPORT_SYMBOL_GPL(regmap_get_device
);
1538 static int _regmap_select_page(struct regmap
*map
, unsigned int *reg
,
1539 struct regmap_range_node
*range
,
1540 unsigned int val_num
)
1542 void *orig_work_buf
;
1543 unsigned int win_offset
;
1544 unsigned int win_page
;
1548 win_offset
= (*reg
- range
->range_min
) % range
->window_len
;
1549 win_page
= (*reg
- range
->range_min
) / range
->window_len
;
1552 /* Bulk write shouldn't cross range boundary */
1553 if (*reg
+ val_num
- 1 > range
->range_max
)
1556 /* ... or single page boundary */
1557 if (val_num
> range
->window_len
- win_offset
)
1561 /* It is possible to have selector register inside data window.
1562 In that case, selector register is located on every page and
1563 it needs no page switching, when accessed alone. */
1565 range
->window_start
+ win_offset
!= range
->selector_reg
) {
1566 /* Use separate work_buf during page switching */
1567 orig_work_buf
= map
->work_buf
;
1568 map
->work_buf
= map
->selector_work_buf
;
1570 ret
= _regmap_update_bits(map
, range
->selector_reg
,
1571 range
->selector_mask
,
1572 win_page
<< range
->selector_shift
,
1575 map
->work_buf
= orig_work_buf
;
1581 *reg
= range
->window_start
+ win_offset
;
1586 static void regmap_set_work_buf_flag_mask(struct regmap
*map
, int max_bytes
,
1592 if (!mask
|| !map
->work_buf
)
1595 buf
= map
->work_buf
;
1597 for (i
= 0; i
< max_bytes
; i
++)
1598 buf
[i
] |= (mask
>> (8 * i
)) & 0xff;
1601 static unsigned int regmap_reg_addr(struct regmap
*map
, unsigned int reg
)
1603 reg
+= map
->reg_base
;
1605 if (map
->format
.reg_shift
> 0)
1606 reg
>>= map
->format
.reg_shift
;
1607 else if (map
->format
.reg_shift
< 0)
1608 reg
<<= -(map
->format
.reg_shift
);
1613 static int _regmap_raw_write_impl(struct regmap
*map
, unsigned int reg
,
1614 const void *val
, size_t val_len
, bool noinc
)
1616 struct regmap_range_node
*range
;
1617 unsigned long flags
;
1618 void *work_val
= map
->work_buf
+ map
->format
.reg_bytes
+
1619 map
->format
.pad_bytes
;
1621 int ret
= -ENOTSUPP
;
1625 /* Check for unwritable or noinc registers in range
1628 if (!regmap_writeable_noinc(map
, reg
)) {
1629 for (i
= 0; i
< val_len
/ map
->format
.val_bytes
; i
++) {
1630 unsigned int element
=
1631 reg
+ regmap_get_offset(map
, i
);
1632 if (!regmap_writeable(map
, element
) ||
1633 regmap_writeable_noinc(map
, element
))
1638 if (!map
->cache_bypass
&& map
->format
.parse_val
) {
1639 unsigned int ival
, offset
;
1640 int val_bytes
= map
->format
.val_bytes
;
1642 /* Cache the last written value for noinc writes */
1643 i
= noinc
? val_len
- val_bytes
: 0;
1644 for (; i
< val_len
; i
+= val_bytes
) {
1645 ival
= map
->format
.parse_val(val
+ i
);
1646 offset
= noinc
? 0 : regmap_get_offset(map
, i
/ val_bytes
);
1647 ret
= regcache_write(map
, reg
+ offset
, ival
);
1650 "Error in caching of register: %x ret: %d\n",
1655 if (map
->cache_only
) {
1656 map
->cache_dirty
= true;
1661 range
= _regmap_range_lookup(map
, reg
);
1663 int val_num
= val_len
/ map
->format
.val_bytes
;
1664 int win_offset
= (reg
- range
->range_min
) % range
->window_len
;
1665 int win_residue
= range
->window_len
- win_offset
;
1667 /* If the write goes beyond the end of the window split it */
1668 while (val_num
> win_residue
) {
1669 dev_dbg(map
->dev
, "Writing window %d/%zu\n",
1670 win_residue
, val_len
/ map
->format
.val_bytes
);
1671 ret
= _regmap_raw_write_impl(map
, reg
, val
,
1673 map
->format
.val_bytes
, noinc
);
1678 val_num
-= win_residue
;
1679 val
+= win_residue
* map
->format
.val_bytes
;
1680 val_len
-= win_residue
* map
->format
.val_bytes
;
1682 win_offset
= (reg
- range
->range_min
) %
1684 win_residue
= range
->window_len
- win_offset
;
1687 ret
= _regmap_select_page(map
, ®
, range
, noinc
? 1 : val_num
);
1692 reg
= regmap_reg_addr(map
, reg
);
1693 map
->format
.format_reg(map
->work_buf
, reg
, map
->reg_shift
);
1694 regmap_set_work_buf_flag_mask(map
, map
->format
.reg_bytes
,
1695 map
->write_flag_mask
);
1698 * Essentially all I/O mechanisms will be faster with a single
1699 * buffer to write. Since register syncs often generate raw
1700 * writes of single registers optimise that case.
1702 if (val
!= work_val
&& val_len
== map
->format
.val_bytes
) {
1703 memcpy(work_val
, val
, map
->format
.val_bytes
);
1707 if (map
->async
&& map
->bus
&& map
->bus
->async_write
) {
1708 struct regmap_async
*async
;
1710 trace_regmap_async_write_start(map
, reg
, val_len
);
1712 spin_lock_irqsave(&map
->async_lock
, flags
);
1713 async
= list_first_entry_or_null(&map
->async_free
,
1714 struct regmap_async
,
1717 list_del(&async
->list
);
1718 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1721 async
= map
->bus
->async_alloc();
1725 async
->work_buf
= kzalloc(map
->format
.buf_size
,
1726 GFP_KERNEL
| GFP_DMA
);
1727 if (!async
->work_buf
) {
1735 /* If the caller supplied the value we can use it safely. */
1736 memcpy(async
->work_buf
, map
->work_buf
, map
->format
.pad_bytes
+
1737 map
->format
.reg_bytes
+ map
->format
.val_bytes
);
1739 spin_lock_irqsave(&map
->async_lock
, flags
);
1740 list_add_tail(&async
->list
, &map
->async_list
);
1741 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1743 if (val
!= work_val
)
1744 ret
= map
->bus
->async_write(map
->bus_context
,
1746 map
->format
.reg_bytes
+
1747 map
->format
.pad_bytes
,
1748 val
, val_len
, async
);
1750 ret
= map
->bus
->async_write(map
->bus_context
,
1752 map
->format
.reg_bytes
+
1753 map
->format
.pad_bytes
+
1754 val_len
, NULL
, 0, async
);
1757 dev_err(map
->dev
, "Failed to schedule write: %d\n",
1760 spin_lock_irqsave(&map
->async_lock
, flags
);
1761 list_move(&async
->list
, &map
->async_free
);
1762 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1768 trace_regmap_hw_write_start(map
, reg
, val_len
/ map
->format
.val_bytes
);
1770 /* If we're doing a single register write we can probably just
1771 * send the work_buf directly, otherwise try to do a gather
1774 if (val
== work_val
)
1775 ret
= map
->write(map
->bus_context
, map
->work_buf
,
1776 map
->format
.reg_bytes
+
1777 map
->format
.pad_bytes
+
1779 else if (map
->bus
&& map
->bus
->gather_write
)
1780 ret
= map
->bus
->gather_write(map
->bus_context
, map
->work_buf
,
1781 map
->format
.reg_bytes
+
1782 map
->format
.pad_bytes
,
1787 /* If that didn't work fall back on linearising by hand. */
1788 if (ret
== -ENOTSUPP
) {
1789 len
= map
->format
.reg_bytes
+ map
->format
.pad_bytes
+ val_len
;
1790 buf
= kzalloc(len
, GFP_KERNEL
);
1794 memcpy(buf
, map
->work_buf
, map
->format
.reg_bytes
);
1795 memcpy(buf
+ map
->format
.reg_bytes
+ map
->format
.pad_bytes
,
1797 ret
= map
->write(map
->bus_context
, buf
, len
);
1800 } else if (ret
!= 0 && !map
->cache_bypass
&& map
->format
.parse_val
) {
1801 /* regcache_drop_region() takes lock that we already have,
1802 * thus call map->cache_ops->drop() directly
1804 if (map
->cache_ops
&& map
->cache_ops
->drop
)
1805 map
->cache_ops
->drop(map
, reg
, reg
+ 1);
1808 trace_regmap_hw_write_done(map
, reg
, val_len
/ map
->format
.val_bytes
);
1814 * regmap_can_raw_write - Test if regmap_raw_write() is supported
1816 * @map: Map to check.
1818 bool regmap_can_raw_write(struct regmap
*map
)
1820 return map
->write
&& map
->format
.format_val
&& map
->format
.format_reg
;
1822 EXPORT_SYMBOL_GPL(regmap_can_raw_write
);
1825 * regmap_get_raw_read_max - Get the maximum size we can read
1827 * @map: Map to check.
1829 size_t regmap_get_raw_read_max(struct regmap
*map
)
1831 return map
->max_raw_read
;
1833 EXPORT_SYMBOL_GPL(regmap_get_raw_read_max
);
1836 * regmap_get_raw_write_max - Get the maximum size we can read
1838 * @map: Map to check.
1840 size_t regmap_get_raw_write_max(struct regmap
*map
)
1842 return map
->max_raw_write
;
1844 EXPORT_SYMBOL_GPL(regmap_get_raw_write_max
);
1846 static int _regmap_bus_formatted_write(void *context
, unsigned int reg
,
1850 struct regmap_range_node
*range
;
1851 struct regmap
*map
= context
;
1853 WARN_ON(!map
->format
.format_write
);
1855 range
= _regmap_range_lookup(map
, reg
);
1857 ret
= _regmap_select_page(map
, ®
, range
, 1);
1862 reg
= regmap_reg_addr(map
, reg
);
1863 map
->format
.format_write(map
, reg
, val
);
1865 trace_regmap_hw_write_start(map
, reg
, 1);
1867 ret
= map
->write(map
->bus_context
, map
->work_buf
, map
->format
.buf_size
);
1869 trace_regmap_hw_write_done(map
, reg
, 1);
1874 static int _regmap_bus_reg_write(void *context
, unsigned int reg
,
1877 struct regmap
*map
= context
;
1878 struct regmap_range_node
*range
;
1881 range
= _regmap_range_lookup(map
, reg
);
1883 ret
= _regmap_select_page(map
, ®
, range
, 1);
1888 reg
= regmap_reg_addr(map
, reg
);
1889 return map
->bus
->reg_write(map
->bus_context
, reg
, val
);
1892 static int _regmap_bus_raw_write(void *context
, unsigned int reg
,
1895 struct regmap
*map
= context
;
1897 WARN_ON(!map
->format
.format_val
);
1899 map
->format
.format_val(map
->work_buf
+ map
->format
.reg_bytes
1900 + map
->format
.pad_bytes
, val
, 0);
1901 return _regmap_raw_write_impl(map
, reg
,
1903 map
->format
.reg_bytes
+
1904 map
->format
.pad_bytes
,
1905 map
->format
.val_bytes
,
1909 static inline void *_regmap_map_get_context(struct regmap
*map
)
1911 return (map
->bus
|| (!map
->bus
&& map
->read
)) ? map
: map
->bus_context
;
1914 int _regmap_write(struct regmap
*map
, unsigned int reg
,
1918 void *context
= _regmap_map_get_context(map
);
1920 if (!regmap_writeable(map
, reg
))
1923 if (!map
->cache_bypass
&& !map
->defer_caching
) {
1924 ret
= regcache_write(map
, reg
, val
);
1927 if (map
->cache_only
) {
1928 map
->cache_dirty
= true;
1933 ret
= map
->reg_write(context
, reg
, val
);
1935 if (regmap_should_log(map
))
1936 dev_info(map
->dev
, "%x <= %x\n", reg
, val
);
1938 trace_regmap_reg_write(map
, reg
, val
);
1945 * regmap_write() - Write a value to a single register
1947 * @map: Register map to write to
1948 * @reg: Register to write to
1949 * @val: Value to be written
1951 * A value of zero will be returned on success, a negative errno will
1952 * be returned in error cases.
1954 int regmap_write(struct regmap
*map
, unsigned int reg
, unsigned int val
)
1958 if (!IS_ALIGNED(reg
, map
->reg_stride
))
1961 map
->lock(map
->lock_arg
);
1963 ret
= _regmap_write(map
, reg
, val
);
1965 map
->unlock(map
->lock_arg
);
1969 EXPORT_SYMBOL_GPL(regmap_write
);
1972 * regmap_write_async() - Write a value to a single register asynchronously
1974 * @map: Register map to write to
1975 * @reg: Register to write to
1976 * @val: Value to be written
1978 * A value of zero will be returned on success, a negative errno will
1979 * be returned in error cases.
1981 int regmap_write_async(struct regmap
*map
, unsigned int reg
, unsigned int val
)
1985 if (!IS_ALIGNED(reg
, map
->reg_stride
))
1988 map
->lock(map
->lock_arg
);
1992 ret
= _regmap_write(map
, reg
, val
);
1996 map
->unlock(map
->lock_arg
);
2000 EXPORT_SYMBOL_GPL(regmap_write_async
);
2002 int _regmap_raw_write(struct regmap
*map
, unsigned int reg
,
2003 const void *val
, size_t val_len
, bool noinc
)
2005 size_t val_bytes
= map
->format
.val_bytes
;
2006 size_t val_count
= val_len
/ val_bytes
;
2007 size_t chunk_count
, chunk_bytes
;
2008 size_t chunk_regs
= val_count
;
2014 if (map
->use_single_write
)
2016 else if (map
->max_raw_write
&& val_len
> map
->max_raw_write
)
2017 chunk_regs
= map
->max_raw_write
/ val_bytes
;
2019 chunk_count
= val_count
/ chunk_regs
;
2020 chunk_bytes
= chunk_regs
* val_bytes
;
2022 /* Write as many bytes as possible with chunk_size */
2023 for (i
= 0; i
< chunk_count
; i
++) {
2024 ret
= _regmap_raw_write_impl(map
, reg
, val
, chunk_bytes
, noinc
);
2028 reg
+= regmap_get_offset(map
, chunk_regs
);
2030 val_len
-= chunk_bytes
;
2033 /* Write remaining bytes */
2035 ret
= _regmap_raw_write_impl(map
, reg
, val
, val_len
, noinc
);
2041 * regmap_raw_write() - Write raw values to one or more registers
2043 * @map: Register map to write to
2044 * @reg: Initial register to write to
2045 * @val: Block of data to be written, laid out for direct transmission to the
2047 * @val_len: Length of data pointed to by val.
2049 * This function is intended to be used for things like firmware
2050 * download where a large block of data needs to be transferred to the
2051 * device. No formatting will be done on the data provided.
2053 * A value of zero will be returned on success, a negative errno will
2054 * be returned in error cases.
2056 int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
2057 const void *val
, size_t val_len
)
2061 if (!regmap_can_raw_write(map
))
2063 if (val_len
% map
->format
.val_bytes
)
2066 map
->lock(map
->lock_arg
);
2068 ret
= _regmap_raw_write(map
, reg
, val
, val_len
, false);
2070 map
->unlock(map
->lock_arg
);
2074 EXPORT_SYMBOL_GPL(regmap_raw_write
);
2076 static int regmap_noinc_readwrite(struct regmap
*map
, unsigned int reg
,
2077 void *val
, unsigned int val_len
, bool write
)
2079 size_t val_bytes
= map
->format
.val_bytes
;
2080 size_t val_count
= val_len
/ val_bytes
;
2081 unsigned int lastval
;
2088 switch (val_bytes
) {
2092 lastval
= (unsigned int)u8p
[val_count
- 1];
2097 lastval
= (unsigned int)u16p
[val_count
- 1];
2102 lastval
= (unsigned int)u32p
[val_count
- 1];
2109 * Update the cache with the last value we write, the rest is just
2110 * gone down in the hardware FIFO. We can't cache FIFOs. This makes
2111 * sure a single read from the cache will work.
2114 if (!map
->cache_bypass
&& !map
->defer_caching
) {
2115 ret
= regcache_write(map
, reg
, lastval
);
2118 if (map
->cache_only
) {
2119 map
->cache_dirty
= true;
2123 ret
= map
->bus
->reg_noinc_write(map
->bus_context
, reg
, val
, val_count
);
2125 ret
= map
->bus
->reg_noinc_read(map
->bus_context
, reg
, val
, val_count
);
2128 if (!ret
&& regmap_should_log(map
)) {
2129 dev_info(map
->dev
, "%x %s [", reg
, write
? "<=" : "=>");
2130 for (i
= 0; i
< val_count
; i
++) {
2131 switch (val_bytes
) {
2133 pr_cont("%x", u8p
[i
]);
2136 pr_cont("%x", u16p
[i
]);
2139 pr_cont("%x", u32p
[i
]);
2144 if (i
== (val_count
- 1))
2155 * regmap_noinc_write(): Write data to a register without incrementing the
2158 * @map: Register map to write to
2159 * @reg: Register to write to
2160 * @val: Pointer to data buffer
2161 * @val_len: Length of output buffer in bytes.
2163 * The regmap API usually assumes that bulk bus write operations will write a
2164 * range of registers. Some devices have certain registers for which a write
2165 * operation can write to an internal FIFO.
2167 * The target register must be volatile but registers after it can be
2168 * completely unrelated cacheable registers.
2170 * This will attempt multiple writes as required to write val_len bytes.
2172 * A value of zero will be returned on success, a negative errno will be
2173 * returned in error cases.
2175 int regmap_noinc_write(struct regmap
*map
, unsigned int reg
,
2176 const void *val
, size_t val_len
)
2181 if (!map
->write
&& !(map
->bus
&& map
->bus
->reg_noinc_write
))
2183 if (val_len
% map
->format
.val_bytes
)
2185 if (!IS_ALIGNED(reg
, map
->reg_stride
))
2190 map
->lock(map
->lock_arg
);
2192 if (!regmap_volatile(map
, reg
) || !regmap_writeable_noinc(map
, reg
)) {
2198 * Use the accelerated operation if we can. The val drops the const
2199 * typing in order to facilitate code reuse in regmap_noinc_readwrite().
2201 if (map
->bus
->reg_noinc_write
) {
2202 ret
= regmap_noinc_readwrite(map
, reg
, (void *)val
, val_len
, true);
2207 if (map
->max_raw_write
&& map
->max_raw_write
< val_len
)
2208 write_len
= map
->max_raw_write
;
2210 write_len
= val_len
;
2211 ret
= _regmap_raw_write(map
, reg
, val
, write_len
, true);
2214 val
= ((u8
*)val
) + write_len
;
2215 val_len
-= write_len
;
2219 map
->unlock(map
->lock_arg
);
2222 EXPORT_SYMBOL_GPL(regmap_noinc_write
);
2225 * regmap_field_update_bits_base() - Perform a read/modify/write cycle a
2228 * @field: Register field to write to
2229 * @mask: Bitmask to change
2230 * @val: Value to be written
2231 * @change: Boolean indicating if a write was done
2232 * @async: Boolean indicating asynchronously
2233 * @force: Boolean indicating use force update
2235 * Perform a read/modify/write cycle on the register field with change,
2236 * async, force option.
2238 * A value of zero will be returned on success, a negative errno will
2239 * be returned in error cases.
2241 int regmap_field_update_bits_base(struct regmap_field
*field
,
2242 unsigned int mask
, unsigned int val
,
2243 bool *change
, bool async
, bool force
)
2245 mask
= (mask
<< field
->shift
) & field
->mask
;
2247 return regmap_update_bits_base(field
->regmap
, field
->reg
,
2248 mask
, val
<< field
->shift
,
2249 change
, async
, force
);
2251 EXPORT_SYMBOL_GPL(regmap_field_update_bits_base
);
2254 * regmap_field_test_bits() - Check if all specified bits are set in a
2257 * @field: Register field to operate on
2258 * @bits: Bits to test
2260 * Returns -1 if the underlying regmap_field_read() fails, 0 if at least one of the
2261 * tested bits is not set and 1 if all tested bits are set.
2263 int regmap_field_test_bits(struct regmap_field
*field
, unsigned int bits
)
2265 unsigned int val
, ret
;
2267 ret
= regmap_field_read(field
, &val
);
2271 return (val
& bits
) == bits
;
2273 EXPORT_SYMBOL_GPL(regmap_field_test_bits
);
2276 * regmap_fields_update_bits_base() - Perform a read/modify/write cycle a
2277 * register field with port ID
2279 * @field: Register field to write to
2281 * @mask: Bitmask to change
2282 * @val: Value to be written
2283 * @change: Boolean indicating if a write was done
2284 * @async: Boolean indicating asynchronously
2285 * @force: Boolean indicating use force update
2287 * A value of zero will be returned on success, a negative errno will
2288 * be returned in error cases.
2290 int regmap_fields_update_bits_base(struct regmap_field
*field
, unsigned int id
,
2291 unsigned int mask
, unsigned int val
,
2292 bool *change
, bool async
, bool force
)
2294 if (id
>= field
->id_size
)
2297 mask
= (mask
<< field
->shift
) & field
->mask
;
2299 return regmap_update_bits_base(field
->regmap
,
2300 field
->reg
+ (field
->id_offset
* id
),
2301 mask
, val
<< field
->shift
,
2302 change
, async
, force
);
2304 EXPORT_SYMBOL_GPL(regmap_fields_update_bits_base
);
2307 * regmap_bulk_write() - Write multiple registers to the device
2309 * @map: Register map to write to
2310 * @reg: First register to be write from
2311 * @val: Block of data to be written, in native register size for device
2312 * @val_count: Number of registers to write
2314 * This function is intended to be used for writing a large block of
2315 * data to the device either in single transfer or multiple transfer.
2317 * A value of zero will be returned on success, a negative errno will
2318 * be returned in error cases.
2320 int regmap_bulk_write(struct regmap
*map
, unsigned int reg
, const void *val
,
2324 size_t val_bytes
= map
->format
.val_bytes
;
2326 if (!IS_ALIGNED(reg
, map
->reg_stride
))
2330 * Some devices don't support bulk write, for them we have a series of
2331 * single write operations.
2333 if (!map
->write
|| !map
->format
.parse_inplace
) {
2334 map
->lock(map
->lock_arg
);
2335 for (i
= 0; i
< val_count
; i
++) {
2338 switch (val_bytes
) {
2340 ival
= *(u8
*)(val
+ (i
* val_bytes
));
2343 ival
= *(u16
*)(val
+ (i
* val_bytes
));
2346 ival
= *(u32
*)(val
+ (i
* val_bytes
));
2353 ret
= _regmap_write(map
,
2354 reg
+ regmap_get_offset(map
, i
),
2360 map
->unlock(map
->lock_arg
);
2364 wval
= kmemdup_array(val
, val_count
, val_bytes
, map
->alloc_flags
);
2368 for (i
= 0; i
< val_count
* val_bytes
; i
+= val_bytes
)
2369 map
->format
.parse_inplace(wval
+ i
);
2371 ret
= regmap_raw_write(map
, reg
, wval
, val_bytes
* val_count
);
2377 trace_regmap_bulk_write(map
, reg
, val
, val_bytes
* val_count
);
2381 EXPORT_SYMBOL_GPL(regmap_bulk_write
);
2384 * _regmap_raw_multi_reg_write()
2386 * the (register,newvalue) pairs in regs have not been formatted, but
2387 * they are all in the same page and have been changed to being page
2388 * relative. The page register has been written if that was necessary.
2390 static int _regmap_raw_multi_reg_write(struct regmap
*map
,
2391 const struct reg_sequence
*regs
,
2398 size_t val_bytes
= map
->format
.val_bytes
;
2399 size_t reg_bytes
= map
->format
.reg_bytes
;
2400 size_t pad_bytes
= map
->format
.pad_bytes
;
2401 size_t pair_size
= reg_bytes
+ pad_bytes
+ val_bytes
;
2402 size_t len
= pair_size
* num_regs
;
2407 buf
= kzalloc(len
, GFP_KERNEL
);
2411 /* We have to linearise by hand. */
2415 for (i
= 0; i
< num_regs
; i
++) {
2416 unsigned int reg
= regs
[i
].reg
;
2417 unsigned int val
= regs
[i
].def
;
2418 trace_regmap_hw_write_start(map
, reg
, 1);
2419 reg
= regmap_reg_addr(map
, reg
);
2420 map
->format
.format_reg(u8
, reg
, map
->reg_shift
);
2421 u8
+= reg_bytes
+ pad_bytes
;
2422 map
->format
.format_val(u8
, val
, 0);
2426 *u8
|= map
->write_flag_mask
;
2428 ret
= map
->write(map
->bus_context
, buf
, len
);
2432 for (i
= 0; i
< num_regs
; i
++) {
2433 int reg
= regs
[i
].reg
;
2434 trace_regmap_hw_write_done(map
, reg
, 1);
2439 static unsigned int _regmap_register_page(struct regmap
*map
,
2441 struct regmap_range_node
*range
)
2443 unsigned int win_page
= (reg
- range
->range_min
) / range
->window_len
;
2448 static int _regmap_range_multi_paged_reg_write(struct regmap
*map
,
2449 struct reg_sequence
*regs
,
2454 struct reg_sequence
*base
;
2455 unsigned int this_page
= 0;
2456 unsigned int page_change
= 0;
2458 * the set of registers are not neccessarily in order, but
2459 * since the order of write must be preserved this algorithm
2460 * chops the set each time the page changes. This also applies
2461 * if there is a delay required at any point in the sequence.
2464 for (i
= 0, n
= 0; i
< num_regs
; i
++, n
++) {
2465 unsigned int reg
= regs
[i
].reg
;
2466 struct regmap_range_node
*range
;
2468 range
= _regmap_range_lookup(map
, reg
);
2470 unsigned int win_page
= _regmap_register_page(map
, reg
,
2474 this_page
= win_page
;
2475 if (win_page
!= this_page
) {
2476 this_page
= win_page
;
2481 /* If we have both a page change and a delay make sure to
2482 * write the regs and apply the delay before we change the
2486 if (page_change
|| regs
[i
].delay_us
) {
2488 /* For situations where the first write requires
2489 * a delay we need to make sure we don't call
2490 * raw_multi_reg_write with n=0
2491 * This can't occur with page breaks as we
2492 * never write on the first iteration
2494 if (regs
[i
].delay_us
&& i
== 0)
2497 ret
= _regmap_raw_multi_reg_write(map
, base
, n
);
2501 if (regs
[i
].delay_us
) {
2503 fsleep(regs
[i
].delay_us
);
2505 udelay(regs
[i
].delay_us
);
2512 ret
= _regmap_select_page(map
,
2525 return _regmap_raw_multi_reg_write(map
, base
, n
);
2529 static int _regmap_multi_reg_write(struct regmap
*map
,
2530 const struct reg_sequence
*regs
,
2536 if (!map
->can_multi_write
) {
2537 for (i
= 0; i
< num_regs
; i
++) {
2538 ret
= _regmap_write(map
, regs
[i
].reg
, regs
[i
].def
);
2542 if (regs
[i
].delay_us
) {
2544 fsleep(regs
[i
].delay_us
);
2546 udelay(regs
[i
].delay_us
);
2552 if (!map
->format
.parse_inplace
)
2555 if (map
->writeable_reg
)
2556 for (i
= 0; i
< num_regs
; i
++) {
2557 int reg
= regs
[i
].reg
;
2558 if (!map
->writeable_reg(map
->dev
, reg
))
2560 if (!IS_ALIGNED(reg
, map
->reg_stride
))
2564 if (!map
->cache_bypass
) {
2565 for (i
= 0; i
< num_regs
; i
++) {
2566 unsigned int val
= regs
[i
].def
;
2567 unsigned int reg
= regs
[i
].reg
;
2568 ret
= regcache_write(map
, reg
, val
);
2571 "Error in caching of register: %x ret: %d\n",
2576 if (map
->cache_only
) {
2577 map
->cache_dirty
= true;
2584 for (i
= 0; i
< num_regs
; i
++) {
2585 unsigned int reg
= regs
[i
].reg
;
2586 struct regmap_range_node
*range
;
2588 /* Coalesce all the writes between a page break or a delay
2591 range
= _regmap_range_lookup(map
, reg
);
2592 if (range
|| regs
[i
].delay_us
) {
2593 size_t len
= sizeof(struct reg_sequence
)*num_regs
;
2594 struct reg_sequence
*base
= kmemdup(regs
, len
,
2598 ret
= _regmap_range_multi_paged_reg_write(map
, base
,
2605 return _regmap_raw_multi_reg_write(map
, regs
, num_regs
);
2609 * regmap_multi_reg_write() - Write multiple registers to the device
2611 * @map: Register map to write to
2612 * @regs: Array of structures containing register,value to be written
2613 * @num_regs: Number of registers to write
2615 * Write multiple registers to the device where the set of register, value
2616 * pairs are supplied in any order, possibly not all in a single range.
2618 * The 'normal' block write mode will send ultimately send data on the
2619 * target bus as R,V1,V2,V3,..,Vn where successively higher registers are
2620 * addressed. However, this alternative block multi write mode will send
2621 * the data as R1,V1,R2,V2,..,Rn,Vn on the target bus. The target device
2622 * must of course support the mode.
2624 * A value of zero will be returned on success, a negative errno will be
2625 * returned in error cases.
2627 int regmap_multi_reg_write(struct regmap
*map
, const struct reg_sequence
*regs
,
2632 map
->lock(map
->lock_arg
);
2634 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
2636 map
->unlock(map
->lock_arg
);
2640 EXPORT_SYMBOL_GPL(regmap_multi_reg_write
);
2643 * regmap_multi_reg_write_bypassed() - Write multiple registers to the
2644 * device but not the cache
2646 * @map: Register map to write to
2647 * @regs: Array of structures containing register,value to be written
2648 * @num_regs: Number of registers to write
2650 * Write multiple registers to the device but not the cache where the set
2651 * of register are supplied in any order.
2653 * This function is intended to be used for writing a large block of data
2654 * atomically to the device in single transfer for those I2C client devices
2655 * that implement this alternative block write mode.
2657 * A value of zero will be returned on success, a negative errno will
2658 * be returned in error cases.
2660 int regmap_multi_reg_write_bypassed(struct regmap
*map
,
2661 const struct reg_sequence
*regs
,
2667 map
->lock(map
->lock_arg
);
2669 bypass
= map
->cache_bypass
;
2670 map
->cache_bypass
= true;
2672 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
2674 map
->cache_bypass
= bypass
;
2676 map
->unlock(map
->lock_arg
);
2680 EXPORT_SYMBOL_GPL(regmap_multi_reg_write_bypassed
);
2683 * regmap_raw_write_async() - Write raw values to one or more registers
2686 * @map: Register map to write to
2687 * @reg: Initial register to write to
2688 * @val: Block of data to be written, laid out for direct transmission to the
2689 * device. Must be valid until regmap_async_complete() is called.
2690 * @val_len: Length of data pointed to by val.
2692 * This function is intended to be used for things like firmware
2693 * download where a large block of data needs to be transferred to the
2694 * device. No formatting will be done on the data provided.
2696 * If supported by the underlying bus the write will be scheduled
2697 * asynchronously, helping maximise I/O speed on higher speed buses
2698 * like SPI. regmap_async_complete() can be called to ensure that all
2699 * asynchrnous writes have been completed.
2701 * A value of zero will be returned on success, a negative errno will
2702 * be returned in error cases.
2704 int regmap_raw_write_async(struct regmap
*map
, unsigned int reg
,
2705 const void *val
, size_t val_len
)
2709 if (val_len
% map
->format
.val_bytes
)
2711 if (!IS_ALIGNED(reg
, map
->reg_stride
))
2714 map
->lock(map
->lock_arg
);
2718 ret
= _regmap_raw_write(map
, reg
, val
, val_len
, false);
2722 map
->unlock(map
->lock_arg
);
2726 EXPORT_SYMBOL_GPL(regmap_raw_write_async
);
2728 static int _regmap_raw_read(struct regmap
*map
, unsigned int reg
, void *val
,
2729 unsigned int val_len
, bool noinc
)
2731 struct regmap_range_node
*range
;
2737 range
= _regmap_range_lookup(map
, reg
);
2739 ret
= _regmap_select_page(map
, ®
, range
,
2740 noinc
? 1 : val_len
/ map
->format
.val_bytes
);
2745 reg
= regmap_reg_addr(map
, reg
);
2746 map
->format
.format_reg(map
->work_buf
, reg
, map
->reg_shift
);
2747 regmap_set_work_buf_flag_mask(map
, map
->format
.reg_bytes
,
2748 map
->read_flag_mask
);
2749 trace_regmap_hw_read_start(map
, reg
, val_len
/ map
->format
.val_bytes
);
2751 ret
= map
->read(map
->bus_context
, map
->work_buf
,
2752 map
->format
.reg_bytes
+ map
->format
.pad_bytes
,
2755 trace_regmap_hw_read_done(map
, reg
, val_len
/ map
->format
.val_bytes
);
2760 static int _regmap_bus_reg_read(void *context
, unsigned int reg
,
2763 struct regmap
*map
= context
;
2764 struct regmap_range_node
*range
;
2767 range
= _regmap_range_lookup(map
, reg
);
2769 ret
= _regmap_select_page(map
, ®
, range
, 1);
2774 reg
= regmap_reg_addr(map
, reg
);
2775 return map
->bus
->reg_read(map
->bus_context
, reg
, val
);
2778 static int _regmap_bus_read(void *context
, unsigned int reg
,
2782 struct regmap
*map
= context
;
2783 void *work_val
= map
->work_buf
+ map
->format
.reg_bytes
+
2784 map
->format
.pad_bytes
;
2786 if (!map
->format
.parse_val
)
2789 ret
= _regmap_raw_read(map
, reg
, work_val
, map
->format
.val_bytes
, false);
2791 *val
= map
->format
.parse_val(work_val
);
2796 static int _regmap_read(struct regmap
*map
, unsigned int reg
,
2800 void *context
= _regmap_map_get_context(map
);
2802 if (!map
->cache_bypass
) {
2803 ret
= regcache_read(map
, reg
, val
);
2808 if (map
->cache_only
)
2811 if (!regmap_readable(map
, reg
))
2814 ret
= map
->reg_read(context
, reg
, val
);
2816 if (regmap_should_log(map
))
2817 dev_info(map
->dev
, "%x => %x\n", reg
, *val
);
2819 trace_regmap_reg_read(map
, reg
, *val
);
2821 if (!map
->cache_bypass
)
2822 regcache_write(map
, reg
, *val
);
2829 * regmap_read() - Read a value from a single register
2831 * @map: Register map to read from
2832 * @reg: Register to be read from
2833 * @val: Pointer to store read value
2835 * A value of zero will be returned on success, a negative errno will
2836 * be returned in error cases.
2838 int regmap_read(struct regmap
*map
, unsigned int reg
, unsigned int *val
)
2842 if (!IS_ALIGNED(reg
, map
->reg_stride
))
2845 map
->lock(map
->lock_arg
);
2847 ret
= _regmap_read(map
, reg
, val
);
2849 map
->unlock(map
->lock_arg
);
2853 EXPORT_SYMBOL_GPL(regmap_read
);
2856 * regmap_read_bypassed() - Read a value from a single register direct
2857 * from the device, bypassing the cache
2859 * @map: Register map to read from
2860 * @reg: Register to be read from
2861 * @val: Pointer to store read value
2863 * A value of zero will be returned on success, a negative errno will
2864 * be returned in error cases.
2866 int regmap_read_bypassed(struct regmap
*map
, unsigned int reg
, unsigned int *val
)
2869 bool bypass
, cache_only
;
2871 if (!IS_ALIGNED(reg
, map
->reg_stride
))
2874 map
->lock(map
->lock_arg
);
2876 bypass
= map
->cache_bypass
;
2877 cache_only
= map
->cache_only
;
2878 map
->cache_bypass
= true;
2879 map
->cache_only
= false;
2881 ret
= _regmap_read(map
, reg
, val
);
2883 map
->cache_bypass
= bypass
;
2884 map
->cache_only
= cache_only
;
2886 map
->unlock(map
->lock_arg
);
2890 EXPORT_SYMBOL_GPL(regmap_read_bypassed
);
2893 * regmap_raw_read() - Read raw data from the device
2895 * @map: Register map to read from
2896 * @reg: First register to be read from
2897 * @val: Pointer to store read value
2898 * @val_len: Size of data to read
2900 * A value of zero will be returned on success, a negative errno will
2901 * be returned in error cases.
2903 int regmap_raw_read(struct regmap
*map
, unsigned int reg
, void *val
,
2906 size_t val_bytes
= map
->format
.val_bytes
;
2907 size_t val_count
= val_len
/ val_bytes
;
2911 if (val_len
% map
->format
.val_bytes
)
2913 if (!IS_ALIGNED(reg
, map
->reg_stride
))
2918 map
->lock(map
->lock_arg
);
2920 if (regmap_volatile_range(map
, reg
, val_count
) || map
->cache_bypass
||
2921 map
->cache_type
== REGCACHE_NONE
) {
2922 size_t chunk_count
, chunk_bytes
;
2923 size_t chunk_regs
= val_count
;
2925 if (!map
->cache_bypass
&& map
->cache_only
) {
2935 if (map
->use_single_read
)
2937 else if (map
->max_raw_read
&& val_len
> map
->max_raw_read
)
2938 chunk_regs
= map
->max_raw_read
/ val_bytes
;
2940 chunk_count
= val_count
/ chunk_regs
;
2941 chunk_bytes
= chunk_regs
* val_bytes
;
2943 /* Read bytes that fit into whole chunks */
2944 for (i
= 0; i
< chunk_count
; i
++) {
2945 ret
= _regmap_raw_read(map
, reg
, val
, chunk_bytes
, false);
2949 reg
+= regmap_get_offset(map
, chunk_regs
);
2951 val_len
-= chunk_bytes
;
2954 /* Read remaining bytes */
2956 ret
= _regmap_raw_read(map
, reg
, val
, val_len
, false);
2961 /* Otherwise go word by word for the cache; should be low
2962 * cost as we expect to hit the cache.
2964 for (i
= 0; i
< val_count
; i
++) {
2965 ret
= _regmap_read(map
, reg
+ regmap_get_offset(map
, i
),
2970 map
->format
.format_val(val
+ (i
* val_bytes
), v
, 0);
2975 map
->unlock(map
->lock_arg
);
2979 EXPORT_SYMBOL_GPL(regmap_raw_read
);
2982 * regmap_noinc_read(): Read data from a register without incrementing the
2985 * @map: Register map to read from
2986 * @reg: Register to read from
2987 * @val: Pointer to data buffer
2988 * @val_len: Length of output buffer in bytes.
2990 * The regmap API usually assumes that bulk read operations will read a
2991 * range of registers. Some devices have certain registers for which a read
2992 * operation read will read from an internal FIFO.
2994 * The target register must be volatile but registers after it can be
2995 * completely unrelated cacheable registers.
2997 * This will attempt multiple reads as required to read val_len bytes.
2999 * A value of zero will be returned on success, a negative errno will be
3000 * returned in error cases.
3002 int regmap_noinc_read(struct regmap
*map
, unsigned int reg
,
3003 void *val
, size_t val_len
)
3011 if (val_len
% map
->format
.val_bytes
)
3013 if (!IS_ALIGNED(reg
, map
->reg_stride
))
3018 map
->lock(map
->lock_arg
);
3020 if (!regmap_volatile(map
, reg
) || !regmap_readable_noinc(map
, reg
)) {
3026 * We have not defined the FIFO semantics for cache, as the
3027 * cache is just one value deep. Should we return the last
3028 * written value? Just avoid this by always reading the FIFO
3029 * even when using cache. Cache only will not work.
3031 if (!map
->cache_bypass
&& map
->cache_only
) {
3036 /* Use the accelerated operation if we can */
3037 if (map
->bus
->reg_noinc_read
) {
3038 ret
= regmap_noinc_readwrite(map
, reg
, val
, val_len
, false);
3043 if (map
->max_raw_read
&& map
->max_raw_read
< val_len
)
3044 read_len
= map
->max_raw_read
;
3047 ret
= _regmap_raw_read(map
, reg
, val
, read_len
, true);
3050 val
= ((u8
*)val
) + read_len
;
3051 val_len
-= read_len
;
3055 map
->unlock(map
->lock_arg
);
3058 EXPORT_SYMBOL_GPL(regmap_noinc_read
);
3061 * regmap_field_read(): Read a value to a single register field
3063 * @field: Register field to read from
3064 * @val: Pointer to store read value
3066 * A value of zero will be returned on success, a negative errno will
3067 * be returned in error cases.
3069 int regmap_field_read(struct regmap_field
*field
, unsigned int *val
)
3072 unsigned int reg_val
;
3073 ret
= regmap_read(field
->regmap
, field
->reg
, ®_val
);
3077 reg_val
&= field
->mask
;
3078 reg_val
>>= field
->shift
;
3083 EXPORT_SYMBOL_GPL(regmap_field_read
);
3086 * regmap_fields_read() - Read a value to a single register field with port ID
3088 * @field: Register field to read from
3090 * @val: Pointer to store read value
3092 * A value of zero will be returned on success, a negative errno will
3093 * be returned in error cases.
3095 int regmap_fields_read(struct regmap_field
*field
, unsigned int id
,
3099 unsigned int reg_val
;
3101 if (id
>= field
->id_size
)
3104 ret
= regmap_read(field
->regmap
,
3105 field
->reg
+ (field
->id_offset
* id
),
3110 reg_val
&= field
->mask
;
3111 reg_val
>>= field
->shift
;
3116 EXPORT_SYMBOL_GPL(regmap_fields_read
);
3118 static int _regmap_bulk_read(struct regmap
*map
, unsigned int reg
,
3119 unsigned int *regs
, void *val
, size_t val_count
)
3126 map
->lock(map
->lock_arg
);
3128 for (i
= 0; i
< val_count
; i
++) {
3132 if (!IS_ALIGNED(regs
[i
], map
->reg_stride
)) {
3136 ret
= _regmap_read(map
, regs
[i
], &ival
);
3138 ret
= _regmap_read(map
, reg
+ regmap_get_offset(map
, i
), &ival
);
3143 switch (map
->format
.val_bytes
) {
3159 map
->unlock(map
->lock_arg
);
3164 * regmap_bulk_read() - Read multiple sequential registers from the device
3166 * @map: Register map to read from
3167 * @reg: First register to be read from
3168 * @val: Pointer to store read value, in native register size for device
3169 * @val_count: Number of registers to read
3171 * A value of zero will be returned on success, a negative errno will
3172 * be returned in error cases.
3174 int regmap_bulk_read(struct regmap
*map
, unsigned int reg
, void *val
,
3178 size_t val_bytes
= map
->format
.val_bytes
;
3179 bool vol
= regmap_volatile_range(map
, reg
, val_count
);
3181 if (!IS_ALIGNED(reg
, map
->reg_stride
))
3186 if (map
->read
&& map
->format
.parse_inplace
&& (vol
|| map
->cache_type
== REGCACHE_NONE
)) {
3187 ret
= regmap_raw_read(map
, reg
, val
, val_bytes
* val_count
);
3191 for (i
= 0; i
< val_count
* val_bytes
; i
+= val_bytes
)
3192 map
->format
.parse_inplace(val
+ i
);
3194 ret
= _regmap_bulk_read(map
, reg
, NULL
, val
, val_count
);
3197 trace_regmap_bulk_read(map
, reg
, val
, val_bytes
* val_count
);
3200 EXPORT_SYMBOL_GPL(regmap_bulk_read
);
3203 * regmap_multi_reg_read() - Read multiple non-sequential registers from the device
3205 * @map: Register map to read from
3206 * @regs: Array of registers to read from
3207 * @val: Pointer to store read value, in native register size for device
3208 * @val_count: Number of registers to read
3210 * A value of zero will be returned on success, a negative errno will
3211 * be returned in error cases.
3213 int regmap_multi_reg_read(struct regmap
*map
, unsigned int *regs
, void *val
,
3219 return _regmap_bulk_read(map
, 0, regs
, val
, val_count
);
3221 EXPORT_SYMBOL_GPL(regmap_multi_reg_read
);
3223 static int _regmap_update_bits(struct regmap
*map
, unsigned int reg
,
3224 unsigned int mask
, unsigned int val
,
3225 bool *change
, bool force_write
)
3228 unsigned int tmp
, orig
;
3233 if (regmap_volatile(map
, reg
) && map
->reg_update_bits
) {
3234 reg
= regmap_reg_addr(map
, reg
);
3235 ret
= map
->reg_update_bits(map
->bus_context
, reg
, mask
, val
);
3236 if (ret
== 0 && change
)
3239 ret
= _regmap_read(map
, reg
, &orig
);
3246 if (force_write
|| (tmp
!= orig
) || map
->force_write_field
) {
3247 ret
= _regmap_write(map
, reg
, tmp
);
3248 if (ret
== 0 && change
)
3257 * regmap_update_bits_base() - Perform a read/modify/write cycle on a register
3259 * @map: Register map to update
3260 * @reg: Register to update
3261 * @mask: Bitmask to change
3262 * @val: New value for bitmask
3263 * @change: Boolean indicating if a write was done
3264 * @async: Boolean indicating asynchronously
3265 * @force: Boolean indicating use force update
3267 * Perform a read/modify/write cycle on a register map with change, async, force
3272 * With most buses the read must be done synchronously so this is most useful
3273 * for devices with a cache which do not need to interact with the hardware to
3274 * determine the current register value.
3276 * Returns zero for success, a negative number on error.
3278 int regmap_update_bits_base(struct regmap
*map
, unsigned int reg
,
3279 unsigned int mask
, unsigned int val
,
3280 bool *change
, bool async
, bool force
)
3284 map
->lock(map
->lock_arg
);
3288 ret
= _regmap_update_bits(map
, reg
, mask
, val
, change
, force
);
3292 map
->unlock(map
->lock_arg
);
3296 EXPORT_SYMBOL_GPL(regmap_update_bits_base
);
3299 * regmap_test_bits() - Check if all specified bits are set in a register.
3301 * @map: Register map to operate on
3302 * @reg: Register to read from
3303 * @bits: Bits to test
3305 * Returns 0 if at least one of the tested bits is not set, 1 if all tested
3306 * bits are set and a negative error number if the underlying regmap_read()
3309 int regmap_test_bits(struct regmap
*map
, unsigned int reg
, unsigned int bits
)
3311 unsigned int val
, ret
;
3313 ret
= regmap_read(map
, reg
, &val
);
3317 return (val
& bits
) == bits
;
3319 EXPORT_SYMBOL_GPL(regmap_test_bits
);
3321 void regmap_async_complete_cb(struct regmap_async
*async
, int ret
)
3323 struct regmap
*map
= async
->map
;
3326 trace_regmap_async_io_complete(map
);
3328 spin_lock(&map
->async_lock
);
3329 list_move(&async
->list
, &map
->async_free
);
3330 wake
= list_empty(&map
->async_list
);
3333 map
->async_ret
= ret
;
3335 spin_unlock(&map
->async_lock
);
3338 wake_up(&map
->async_waitq
);
3340 EXPORT_SYMBOL_GPL(regmap_async_complete_cb
);
3342 static int regmap_async_is_done(struct regmap
*map
)
3344 unsigned long flags
;
3347 spin_lock_irqsave(&map
->async_lock
, flags
);
3348 ret
= list_empty(&map
->async_list
);
3349 spin_unlock_irqrestore(&map
->async_lock
, flags
);
3355 * regmap_async_complete - Ensure all asynchronous I/O has completed.
3357 * @map: Map to operate on.
3359 * Blocks until any pending asynchronous I/O has completed. Returns
3360 * an error code for any failed I/O operations.
3362 int regmap_async_complete(struct regmap
*map
)
3364 unsigned long flags
;
3367 /* Nothing to do with no async support */
3368 if (!map
->bus
|| !map
->bus
->async_write
)
3371 trace_regmap_async_complete_start(map
);
3373 wait_event(map
->async_waitq
, regmap_async_is_done(map
));
3375 spin_lock_irqsave(&map
->async_lock
, flags
);
3376 ret
= map
->async_ret
;
3378 spin_unlock_irqrestore(&map
->async_lock
, flags
);
3380 trace_regmap_async_complete_done(map
);
3384 EXPORT_SYMBOL_GPL(regmap_async_complete
);
3387 * regmap_register_patch - Register and apply register updates to be applied
3388 * on device initialistion
3390 * @map: Register map to apply updates to.
3391 * @regs: Values to update.
3392 * @num_regs: Number of entries in regs.
3394 * Register a set of register updates to be applied to the device
3395 * whenever the device registers are synchronised with the cache and
3396 * apply them immediately. Typically this is used to apply
3397 * corrections to be applied to the device defaults on startup, such
3398 * as the updates some vendors provide to undocumented registers.
3400 * The caller must ensure that this function cannot be called
3401 * concurrently with either itself or regcache_sync().
3403 int regmap_register_patch(struct regmap
*map
, const struct reg_sequence
*regs
,
3406 struct reg_sequence
*p
;
3410 if (WARN_ONCE(num_regs
<= 0, "invalid registers number (%d)\n",
3414 p
= krealloc(map
->patch
,
3415 sizeof(struct reg_sequence
) * (map
->patch_regs
+ num_regs
),
3418 memcpy(p
+ map
->patch_regs
, regs
, num_regs
* sizeof(*regs
));
3420 map
->patch_regs
+= num_regs
;
3425 map
->lock(map
->lock_arg
);
3427 bypass
= map
->cache_bypass
;
3429 map
->cache_bypass
= true;
3432 ret
= _regmap_multi_reg_write(map
, regs
, num_regs
);
3435 map
->cache_bypass
= bypass
;
3437 map
->unlock(map
->lock_arg
);
3439 regmap_async_complete(map
);
3443 EXPORT_SYMBOL_GPL(regmap_register_patch
);
3446 * regmap_get_val_bytes() - Report the size of a register value
3448 * @map: Register map to operate on.
3450 * Report the size of a register value, mainly intended to for use by
3451 * generic infrastructure built on top of regmap.
3453 int regmap_get_val_bytes(struct regmap
*map
)
3455 if (map
->format
.format_write
)
3458 return map
->format
.val_bytes
;
3460 EXPORT_SYMBOL_GPL(regmap_get_val_bytes
);
3463 * regmap_get_max_register() - Report the max register value
3465 * @map: Register map to operate on.
3467 * Report the max register value, mainly intended to for use by
3468 * generic infrastructure built on top of regmap.
3470 int regmap_get_max_register(struct regmap
*map
)
3472 return map
->max_register_is_set
? map
->max_register
: -EINVAL
;
3474 EXPORT_SYMBOL_GPL(regmap_get_max_register
);
3477 * regmap_get_reg_stride() - Report the register address stride
3479 * @map: Register map to operate on.
3481 * Report the register address stride, mainly intended to for use by
3482 * generic infrastructure built on top of regmap.
3484 int regmap_get_reg_stride(struct regmap
*map
)
3486 return map
->reg_stride
;
3488 EXPORT_SYMBOL_GPL(regmap_get_reg_stride
);
3491 * regmap_might_sleep() - Returns whether a regmap access might sleep.
3493 * @map: Register map to operate on.
3495 * Returns true if an access to the register might sleep, else false.
3497 bool regmap_might_sleep(struct regmap
*map
)
3499 return map
->can_sleep
;
3501 EXPORT_SYMBOL_GPL(regmap_might_sleep
);
3503 int regmap_parse_val(struct regmap
*map
, const void *buf
,
3506 if (!map
->format
.parse_val
)
3509 *val
= map
->format
.parse_val(buf
);
3513 EXPORT_SYMBOL_GPL(regmap_parse_val
);
3515 static int __init
regmap_initcall(void)
3517 regmap_debugfs_initcall();
3521 postcore_initcall(regmap_initcall
);