2 * Register map access API
4 * Copyright 2011 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/device.h>
14 #include <linux/slab.h>
15 #include <linux/export.h>
16 #include <linux/mutex.h>
17 #include <linux/err.h>
18 #include <linux/rbtree.h>
19 #include <linux/sched.h>
21 #define CREATE_TRACE_POINTS
22 #include <trace/events/regmap.h>
27 * Sometimes for failures during very early init the trace
28 * infrastructure isn't available early enough to be used. For this
29 * sort of problem defining LOG_DEVICE will add printks for basic
30 * register I/O on a specific device.
34 static int _regmap_update_bits(struct regmap
*map
, unsigned int reg
,
35 unsigned int mask
, unsigned int val
,
38 static int _regmap_bus_read(void *context
, unsigned int reg
,
40 static int _regmap_bus_formatted_write(void *context
, unsigned int reg
,
42 static int _regmap_bus_raw_write(void *context
, unsigned int reg
,
45 static void async_cleanup(struct work_struct
*work
)
47 struct regmap_async
*async
= container_of(work
, struct regmap_async
,
50 kfree(async
->work_buf
);
54 bool regmap_reg_in_ranges(unsigned int reg
,
55 const struct regmap_range
*ranges
,
58 const struct regmap_range
*r
;
61 for (i
= 0, r
= ranges
; i
< nranges
; i
++, r
++)
62 if (regmap_reg_in_range(reg
, r
))
66 EXPORT_SYMBOL_GPL(regmap_reg_in_ranges
);
68 static bool _regmap_check_range_table(struct regmap
*map
,
70 const struct regmap_access_table
*table
)
72 /* Check "no ranges" first */
73 if (regmap_reg_in_ranges(reg
, table
->no_ranges
, table
->n_no_ranges
))
76 /* In case zero "yes ranges" are supplied, any reg is OK */
77 if (!table
->n_yes_ranges
)
80 return regmap_reg_in_ranges(reg
, table
->yes_ranges
,
84 bool regmap_writeable(struct regmap
*map
, unsigned int reg
)
86 if (map
->max_register
&& reg
> map
->max_register
)
89 if (map
->writeable_reg
)
90 return map
->writeable_reg(map
->dev
, reg
);
93 return _regmap_check_range_table(map
, reg
, map
->wr_table
);
98 bool regmap_readable(struct regmap
*map
, unsigned int reg
)
100 if (map
->max_register
&& reg
> map
->max_register
)
103 if (map
->format
.format_write
)
106 if (map
->readable_reg
)
107 return map
->readable_reg(map
->dev
, reg
);
110 return _regmap_check_range_table(map
, reg
, map
->rd_table
);
115 bool regmap_volatile(struct regmap
*map
, unsigned int reg
)
117 if (!regmap_readable(map
, reg
))
120 if (map
->volatile_reg
)
121 return map
->volatile_reg(map
->dev
, reg
);
123 if (map
->volatile_table
)
124 return _regmap_check_range_table(map
, reg
, map
->volatile_table
);
129 bool regmap_precious(struct regmap
*map
, unsigned int reg
)
131 if (!regmap_readable(map
, reg
))
134 if (map
->precious_reg
)
135 return map
->precious_reg(map
->dev
, reg
);
137 if (map
->precious_table
)
138 return _regmap_check_range_table(map
, reg
, map
->precious_table
);
143 static bool regmap_volatile_range(struct regmap
*map
, unsigned int reg
,
148 for (i
= 0; i
< num
; i
++)
149 if (!regmap_volatile(map
, reg
+ i
))
155 static void regmap_format_2_6_write(struct regmap
*map
,
156 unsigned int reg
, unsigned int val
)
158 u8
*out
= map
->work_buf
;
160 *out
= (reg
<< 6) | val
;
163 static void regmap_format_4_12_write(struct regmap
*map
,
164 unsigned int reg
, unsigned int val
)
166 __be16
*out
= map
->work_buf
;
167 *out
= cpu_to_be16((reg
<< 12) | val
);
170 static void regmap_format_7_9_write(struct regmap
*map
,
171 unsigned int reg
, unsigned int val
)
173 __be16
*out
= map
->work_buf
;
174 *out
= cpu_to_be16((reg
<< 9) | val
);
177 static void regmap_format_10_14_write(struct regmap
*map
,
178 unsigned int reg
, unsigned int val
)
180 u8
*out
= map
->work_buf
;
183 out
[1] = (val
>> 8) | (reg
<< 6);
187 static void regmap_format_8(void *buf
, unsigned int val
, unsigned int shift
)
194 static void regmap_format_16_be(void *buf
, unsigned int val
, unsigned int shift
)
198 b
[0] = cpu_to_be16(val
<< shift
);
201 static void regmap_format_16_native(void *buf
, unsigned int val
,
204 *(u16
*)buf
= val
<< shift
;
207 static void regmap_format_24(void *buf
, unsigned int val
, unsigned int shift
)
218 static void regmap_format_32_be(void *buf
, unsigned int val
, unsigned int shift
)
222 b
[0] = cpu_to_be32(val
<< shift
);
225 static void regmap_format_32_native(void *buf
, unsigned int val
,
228 *(u32
*)buf
= val
<< shift
;
231 static unsigned int regmap_parse_8(void *buf
)
238 static unsigned int regmap_parse_16_be(void *buf
)
242 b
[0] = be16_to_cpu(b
[0]);
247 static unsigned int regmap_parse_16_native(void *buf
)
252 static unsigned int regmap_parse_24(void *buf
)
255 unsigned int ret
= b
[2];
256 ret
|= ((unsigned int)b
[1]) << 8;
257 ret
|= ((unsigned int)b
[0]) << 16;
262 static unsigned int regmap_parse_32_be(void *buf
)
266 b
[0] = be32_to_cpu(b
[0]);
271 static unsigned int regmap_parse_32_native(void *buf
)
276 static void regmap_lock_mutex(void *__map
)
278 struct regmap
*map
= __map
;
279 mutex_lock(&map
->mutex
);
282 static void regmap_unlock_mutex(void *__map
)
284 struct regmap
*map
= __map
;
285 mutex_unlock(&map
->mutex
);
288 static void regmap_lock_spinlock(void *__map
)
290 struct regmap
*map
= __map
;
291 spin_lock(&map
->spinlock
);
294 static void regmap_unlock_spinlock(void *__map
)
296 struct regmap
*map
= __map
;
297 spin_unlock(&map
->spinlock
);
300 static void dev_get_regmap_release(struct device
*dev
, void *res
)
303 * We don't actually have anything to do here; the goal here
304 * is not to manage the regmap but to provide a simple way to
305 * get the regmap back given a struct device.
309 static bool _regmap_range_add(struct regmap
*map
,
310 struct regmap_range_node
*data
)
312 struct rb_root
*root
= &map
->range_tree
;
313 struct rb_node
**new = &(root
->rb_node
), *parent
= NULL
;
316 struct regmap_range_node
*this =
317 container_of(*new, struct regmap_range_node
, node
);
320 if (data
->range_max
< this->range_min
)
321 new = &((*new)->rb_left
);
322 else if (data
->range_min
> this->range_max
)
323 new = &((*new)->rb_right
);
328 rb_link_node(&data
->node
, parent
, new);
329 rb_insert_color(&data
->node
, root
);
334 static struct regmap_range_node
*_regmap_range_lookup(struct regmap
*map
,
337 struct rb_node
*node
= map
->range_tree
.rb_node
;
340 struct regmap_range_node
*this =
341 container_of(node
, struct regmap_range_node
, node
);
343 if (reg
< this->range_min
)
344 node
= node
->rb_left
;
345 else if (reg
> this->range_max
)
346 node
= node
->rb_right
;
354 static void regmap_range_exit(struct regmap
*map
)
356 struct rb_node
*next
;
357 struct regmap_range_node
*range_node
;
359 next
= rb_first(&map
->range_tree
);
361 range_node
= rb_entry(next
, struct regmap_range_node
, node
);
362 next
= rb_next(&range_node
->node
);
363 rb_erase(&range_node
->node
, &map
->range_tree
);
367 kfree(map
->selector_work_buf
);
371 * regmap_init(): Initialise register map
373 * @dev: Device that will be interacted with
374 * @bus: Bus-specific callbacks to use with device
375 * @bus_context: Data passed to bus-specific callbacks
376 * @config: Configuration for register map
378 * The return value will be an ERR_PTR() on error or a valid pointer to
379 * a struct regmap. This function should generally not be called
380 * directly, it should be called by bus-specific init functions.
382 struct regmap
*regmap_init(struct device
*dev
,
383 const struct regmap_bus
*bus
,
385 const struct regmap_config
*config
)
387 struct regmap
*map
, **m
;
389 enum regmap_endian reg_endian
, val_endian
;
395 map
= kzalloc(sizeof(*map
), GFP_KERNEL
);
401 if (config
->lock
&& config
->unlock
) {
402 map
->lock
= config
->lock
;
403 map
->unlock
= config
->unlock
;
404 map
->lock_arg
= config
->lock_arg
;
407 spin_lock_init(&map
->spinlock
);
408 map
->lock
= regmap_lock_spinlock
;
409 map
->unlock
= regmap_unlock_spinlock
;
411 mutex_init(&map
->mutex
);
412 map
->lock
= regmap_lock_mutex
;
413 map
->unlock
= regmap_unlock_mutex
;
417 map
->format
.reg_bytes
= DIV_ROUND_UP(config
->reg_bits
, 8);
418 map
->format
.pad_bytes
= config
->pad_bits
/ 8;
419 map
->format
.val_bytes
= DIV_ROUND_UP(config
->val_bits
, 8);
420 map
->format
.buf_size
= DIV_ROUND_UP(config
->reg_bits
+
421 config
->val_bits
+ config
->pad_bits
, 8);
422 map
->reg_shift
= config
->pad_bits
% 8;
423 if (config
->reg_stride
)
424 map
->reg_stride
= config
->reg_stride
;
427 map
->use_single_rw
= config
->use_single_rw
;
430 map
->bus_context
= bus_context
;
431 map
->max_register
= config
->max_register
;
432 map
->wr_table
= config
->wr_table
;
433 map
->rd_table
= config
->rd_table
;
434 map
->volatile_table
= config
->volatile_table
;
435 map
->precious_table
= config
->precious_table
;
436 map
->writeable_reg
= config
->writeable_reg
;
437 map
->readable_reg
= config
->readable_reg
;
438 map
->volatile_reg
= config
->volatile_reg
;
439 map
->precious_reg
= config
->precious_reg
;
440 map
->cache_type
= config
->cache_type
;
441 map
->name
= config
->name
;
443 spin_lock_init(&map
->async_lock
);
444 INIT_LIST_HEAD(&map
->async_list
);
445 init_waitqueue_head(&map
->async_waitq
);
447 if (config
->read_flag_mask
|| config
->write_flag_mask
) {
448 map
->read_flag_mask
= config
->read_flag_mask
;
449 map
->write_flag_mask
= config
->write_flag_mask
;
451 map
->read_flag_mask
= bus
->read_flag_mask
;
454 map
->reg_read
= _regmap_bus_read
;
456 reg_endian
= config
->reg_format_endian
;
457 if (reg_endian
== REGMAP_ENDIAN_DEFAULT
)
458 reg_endian
= bus
->reg_format_endian_default
;
459 if (reg_endian
== REGMAP_ENDIAN_DEFAULT
)
460 reg_endian
= REGMAP_ENDIAN_BIG
;
462 val_endian
= config
->val_format_endian
;
463 if (val_endian
== REGMAP_ENDIAN_DEFAULT
)
464 val_endian
= bus
->val_format_endian_default
;
465 if (val_endian
== REGMAP_ENDIAN_DEFAULT
)
466 val_endian
= REGMAP_ENDIAN_BIG
;
468 switch (config
->reg_bits
+ map
->reg_shift
) {
470 switch (config
->val_bits
) {
472 map
->format
.format_write
= regmap_format_2_6_write
;
480 switch (config
->val_bits
) {
482 map
->format
.format_write
= regmap_format_4_12_write
;
490 switch (config
->val_bits
) {
492 map
->format
.format_write
= regmap_format_7_9_write
;
500 switch (config
->val_bits
) {
502 map
->format
.format_write
= regmap_format_10_14_write
;
510 map
->format
.format_reg
= regmap_format_8
;
514 switch (reg_endian
) {
515 case REGMAP_ENDIAN_BIG
:
516 map
->format
.format_reg
= regmap_format_16_be
;
518 case REGMAP_ENDIAN_NATIVE
:
519 map
->format
.format_reg
= regmap_format_16_native
;
527 switch (reg_endian
) {
528 case REGMAP_ENDIAN_BIG
:
529 map
->format
.format_reg
= regmap_format_32_be
;
531 case REGMAP_ENDIAN_NATIVE
:
532 map
->format
.format_reg
= regmap_format_32_native
;
543 switch (config
->val_bits
) {
545 map
->format
.format_val
= regmap_format_8
;
546 map
->format
.parse_val
= regmap_parse_8
;
549 switch (val_endian
) {
550 case REGMAP_ENDIAN_BIG
:
551 map
->format
.format_val
= regmap_format_16_be
;
552 map
->format
.parse_val
= regmap_parse_16_be
;
554 case REGMAP_ENDIAN_NATIVE
:
555 map
->format
.format_val
= regmap_format_16_native
;
556 map
->format
.parse_val
= regmap_parse_16_native
;
563 if (val_endian
!= REGMAP_ENDIAN_BIG
)
565 map
->format
.format_val
= regmap_format_24
;
566 map
->format
.parse_val
= regmap_parse_24
;
569 switch (val_endian
) {
570 case REGMAP_ENDIAN_BIG
:
571 map
->format
.format_val
= regmap_format_32_be
;
572 map
->format
.parse_val
= regmap_parse_32_be
;
574 case REGMAP_ENDIAN_NATIVE
:
575 map
->format
.format_val
= regmap_format_32_native
;
576 map
->format
.parse_val
= regmap_parse_32_native
;
584 if (map
->format
.format_write
) {
585 if ((reg_endian
!= REGMAP_ENDIAN_BIG
) ||
586 (val_endian
!= REGMAP_ENDIAN_BIG
))
588 map
->use_single_rw
= true;
591 if (!map
->format
.format_write
&&
592 !(map
->format
.format_reg
&& map
->format
.format_val
))
595 map
->work_buf
= kzalloc(map
->format
.buf_size
, GFP_KERNEL
);
596 if (map
->work_buf
== NULL
) {
601 if (map
->format
.format_write
)
602 map
->reg_write
= _regmap_bus_formatted_write
;
603 else if (map
->format
.format_val
)
604 map
->reg_write
= _regmap_bus_raw_write
;
606 map
->range_tree
= RB_ROOT
;
607 for (i
= 0; i
< config
->num_ranges
; i
++) {
608 const struct regmap_range_cfg
*range_cfg
= &config
->ranges
[i
];
609 struct regmap_range_node
*new;
612 if (range_cfg
->range_max
< range_cfg
->range_min
) {
613 dev_err(map
->dev
, "Invalid range %d: %d < %d\n", i
,
614 range_cfg
->range_max
, range_cfg
->range_min
);
618 if (range_cfg
->range_max
> map
->max_register
) {
619 dev_err(map
->dev
, "Invalid range %d: %d > %d\n", i
,
620 range_cfg
->range_max
, map
->max_register
);
624 if (range_cfg
->selector_reg
> map
->max_register
) {
626 "Invalid range %d: selector out of map\n", i
);
630 if (range_cfg
->window_len
== 0) {
631 dev_err(map
->dev
, "Invalid range %d: window_len 0\n",
636 /* Make sure, that this register range has no selector
637 or data window within its boundary */
638 for (j
= 0; j
< config
->num_ranges
; j
++) {
639 unsigned sel_reg
= config
->ranges
[j
].selector_reg
;
640 unsigned win_min
= config
->ranges
[j
].window_start
;
641 unsigned win_max
= win_min
+
642 config
->ranges
[j
].window_len
- 1;
644 if (range_cfg
->range_min
<= sel_reg
&&
645 sel_reg
<= range_cfg
->range_max
) {
647 "Range %d: selector for %d in window\n",
652 if (!(win_max
< range_cfg
->range_min
||
653 win_min
> range_cfg
->range_max
)) {
655 "Range %d: window for %d in window\n",
661 new = kzalloc(sizeof(*new), GFP_KERNEL
);
668 new->name
= range_cfg
->name
;
669 new->range_min
= range_cfg
->range_min
;
670 new->range_max
= range_cfg
->range_max
;
671 new->selector_reg
= range_cfg
->selector_reg
;
672 new->selector_mask
= range_cfg
->selector_mask
;
673 new->selector_shift
= range_cfg
->selector_shift
;
674 new->window_start
= range_cfg
->window_start
;
675 new->window_len
= range_cfg
->window_len
;
677 if (_regmap_range_add(map
, new) == false) {
678 dev_err(map
->dev
, "Failed to add range %d\n", i
);
683 if (map
->selector_work_buf
== NULL
) {
684 map
->selector_work_buf
=
685 kzalloc(map
->format
.buf_size
, GFP_KERNEL
);
686 if (map
->selector_work_buf
== NULL
) {
693 ret
= regcache_init(map
, config
);
697 regmap_debugfs_init(map
, config
->name
);
699 /* Add a devres resource for dev_get_regmap() */
700 m
= devres_alloc(dev_get_regmap_release
, sizeof(*m
), GFP_KERNEL
);
711 regmap_debugfs_exit(map
);
714 regmap_range_exit(map
);
715 kfree(map
->work_buf
);
721 EXPORT_SYMBOL_GPL(regmap_init
);
723 static void devm_regmap_release(struct device
*dev
, void *res
)
725 regmap_exit(*(struct regmap
**)res
);
729 * devm_regmap_init(): Initialise managed register map
731 * @dev: Device that will be interacted with
732 * @bus: Bus-specific callbacks to use with device
733 * @bus_context: Data passed to bus-specific callbacks
734 * @config: Configuration for register map
736 * The return value will be an ERR_PTR() on error or a valid pointer
737 * to a struct regmap. This function should generally not be called
738 * directly, it should be called by bus-specific init functions. The
739 * map will be automatically freed by the device management code.
741 struct regmap
*devm_regmap_init(struct device
*dev
,
742 const struct regmap_bus
*bus
,
744 const struct regmap_config
*config
)
746 struct regmap
**ptr
, *regmap
;
748 ptr
= devres_alloc(devm_regmap_release
, sizeof(*ptr
), GFP_KERNEL
);
750 return ERR_PTR(-ENOMEM
);
752 regmap
= regmap_init(dev
, bus
, bus_context
, config
);
753 if (!IS_ERR(regmap
)) {
755 devres_add(dev
, ptr
);
762 EXPORT_SYMBOL_GPL(devm_regmap_init
);
765 * regmap_reinit_cache(): Reinitialise the current register cache
767 * @map: Register map to operate on.
768 * @config: New configuration. Only the cache data will be used.
770 * Discard any existing register cache for the map and initialize a
771 * new cache. This can be used to restore the cache to defaults or to
772 * update the cache configuration to reflect runtime discovery of the
775 * No explicit locking is done here, the user needs to ensure that
776 * this function will not race with other calls to regmap.
778 int regmap_reinit_cache(struct regmap
*map
, const struct regmap_config
*config
)
781 regmap_debugfs_exit(map
);
783 map
->max_register
= config
->max_register
;
784 map
->writeable_reg
= config
->writeable_reg
;
785 map
->readable_reg
= config
->readable_reg
;
786 map
->volatile_reg
= config
->volatile_reg
;
787 map
->precious_reg
= config
->precious_reg
;
788 map
->cache_type
= config
->cache_type
;
790 regmap_debugfs_init(map
, config
->name
);
792 map
->cache_bypass
= false;
793 map
->cache_only
= false;
795 return regcache_init(map
, config
);
797 EXPORT_SYMBOL_GPL(regmap_reinit_cache
);
800 * regmap_exit(): Free a previously allocated register map
802 void regmap_exit(struct regmap
*map
)
805 regmap_debugfs_exit(map
);
806 regmap_range_exit(map
);
807 if (map
->bus
->free_context
)
808 map
->bus
->free_context(map
->bus_context
);
809 kfree(map
->work_buf
);
812 EXPORT_SYMBOL_GPL(regmap_exit
);
814 static int dev_get_regmap_match(struct device
*dev
, void *res
, void *data
)
816 struct regmap
**r
= res
;
822 /* If the user didn't specify a name match any */
824 return (*r
)->name
== data
;
830 * dev_get_regmap(): Obtain the regmap (if any) for a device
832 * @dev: Device to retrieve the map for
833 * @name: Optional name for the register map, usually NULL.
835 * Returns the regmap for the device if one is present, or NULL. If
836 * name is specified then it must match the name specified when
837 * registering the device, if it is NULL then the first regmap found
838 * will be used. Devices with multiple register maps are very rare,
839 * generic code should normally not need to specify a name.
841 struct regmap
*dev_get_regmap(struct device
*dev
, const char *name
)
843 struct regmap
**r
= devres_find(dev
, dev_get_regmap_release
,
844 dev_get_regmap_match
, (void *)name
);
850 EXPORT_SYMBOL_GPL(dev_get_regmap
);
852 static int _regmap_select_page(struct regmap
*map
, unsigned int *reg
,
853 struct regmap_range_node
*range
,
854 unsigned int val_num
)
857 unsigned int win_offset
;
858 unsigned int win_page
;
862 win_offset
= (*reg
- range
->range_min
) % range
->window_len
;
863 win_page
= (*reg
- range
->range_min
) / range
->window_len
;
866 /* Bulk write shouldn't cross range boundary */
867 if (*reg
+ val_num
- 1 > range
->range_max
)
870 /* ... or single page boundary */
871 if (val_num
> range
->window_len
- win_offset
)
875 /* It is possible to have selector register inside data window.
876 In that case, selector register is located on every page and
877 it needs no page switching, when accessed alone. */
879 range
->window_start
+ win_offset
!= range
->selector_reg
) {
880 /* Use separate work_buf during page switching */
881 orig_work_buf
= map
->work_buf
;
882 map
->work_buf
= map
->selector_work_buf
;
884 ret
= _regmap_update_bits(map
, range
->selector_reg
,
885 range
->selector_mask
,
886 win_page
<< range
->selector_shift
,
889 map
->work_buf
= orig_work_buf
;
895 *reg
= range
->window_start
+ win_offset
;
900 static int _regmap_raw_write(struct regmap
*map
, unsigned int reg
,
901 const void *val
, size_t val_len
, bool async
)
903 struct regmap_range_node
*range
;
905 u8
*u8
= map
->work_buf
;
906 void *work_val
= map
->work_buf
+ map
->format
.reg_bytes
+
907 map
->format
.pad_bytes
;
913 /* Check for unwritable registers before we start */
914 if (map
->writeable_reg
)
915 for (i
= 0; i
< val_len
/ map
->format
.val_bytes
; i
++)
916 if (!map
->writeable_reg(map
->dev
,
917 reg
+ (i
* map
->reg_stride
)))
920 if (!map
->cache_bypass
&& map
->format
.parse_val
) {
922 int val_bytes
= map
->format
.val_bytes
;
923 for (i
= 0; i
< val_len
/ val_bytes
; i
++) {
924 memcpy(map
->work_buf
, val
+ (i
* val_bytes
), val_bytes
);
925 ival
= map
->format
.parse_val(map
->work_buf
);
926 ret
= regcache_write(map
, reg
+ (i
* map
->reg_stride
),
930 "Error in caching of register: %x ret: %d\n",
935 if (map
->cache_only
) {
936 map
->cache_dirty
= true;
941 range
= _regmap_range_lookup(map
, reg
);
943 int val_num
= val_len
/ map
->format
.val_bytes
;
944 int win_offset
= (reg
- range
->range_min
) % range
->window_len
;
945 int win_residue
= range
->window_len
- win_offset
;
947 /* If the write goes beyond the end of the window split it */
948 while (val_num
> win_residue
) {
949 dev_dbg(map
->dev
, "Writing window %d/%zu\n",
950 win_residue
, val_len
/ map
->format
.val_bytes
);
951 ret
= _regmap_raw_write(map
, reg
, val
, win_residue
*
952 map
->format
.val_bytes
, async
);
957 val_num
-= win_residue
;
958 val
+= win_residue
* map
->format
.val_bytes
;
959 val_len
-= win_residue
* map
->format
.val_bytes
;
961 win_offset
= (reg
- range
->range_min
) %
963 win_residue
= range
->window_len
- win_offset
;
966 ret
= _regmap_select_page(map
, ®
, range
, val_num
);
971 map
->format
.format_reg(map
->work_buf
, reg
, map
->reg_shift
);
973 u8
[0] |= map
->write_flag_mask
;
975 if (async
&& map
->bus
->async_write
) {
976 struct regmap_async
*async
= map
->bus
->async_alloc();
980 async
->work_buf
= kzalloc(map
->format
.buf_size
,
981 GFP_KERNEL
| GFP_DMA
);
982 if (!async
->work_buf
) {
987 INIT_WORK(&async
->cleanup
, async_cleanup
);
990 /* If the caller supplied the value we can use it safely. */
991 memcpy(async
->work_buf
, map
->work_buf
, map
->format
.pad_bytes
+
992 map
->format
.reg_bytes
+ map
->format
.val_bytes
);
994 val
= async
->work_buf
+ map
->format
.pad_bytes
+
995 map
->format
.reg_bytes
;
997 spin_lock_irqsave(&map
->async_lock
, flags
);
998 list_add_tail(&async
->list
, &map
->async_list
);
999 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1001 ret
= map
->bus
->async_write(map
->bus_context
, async
->work_buf
,
1002 map
->format
.reg_bytes
+
1003 map
->format
.pad_bytes
,
1004 val
, val_len
, async
);
1007 dev_err(map
->dev
, "Failed to schedule write: %d\n",
1010 spin_lock_irqsave(&map
->async_lock
, flags
);
1011 list_del(&async
->list
);
1012 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1014 kfree(async
->work_buf
);
1019 trace_regmap_hw_write_start(map
->dev
, reg
,
1020 val_len
/ map
->format
.val_bytes
);
1022 /* If we're doing a single register write we can probably just
1023 * send the work_buf directly, otherwise try to do a gather
1026 if (val
== work_val
)
1027 ret
= map
->bus
->write(map
->bus_context
, map
->work_buf
,
1028 map
->format
.reg_bytes
+
1029 map
->format
.pad_bytes
+
1031 else if (map
->bus
->gather_write
)
1032 ret
= map
->bus
->gather_write(map
->bus_context
, map
->work_buf
,
1033 map
->format
.reg_bytes
+
1034 map
->format
.pad_bytes
,
1037 /* If that didn't work fall back on linearising by hand. */
1038 if (ret
== -ENOTSUPP
) {
1039 len
= map
->format
.reg_bytes
+ map
->format
.pad_bytes
+ val_len
;
1040 buf
= kzalloc(len
, GFP_KERNEL
);
1044 memcpy(buf
, map
->work_buf
, map
->format
.reg_bytes
);
1045 memcpy(buf
+ map
->format
.reg_bytes
+ map
->format
.pad_bytes
,
1047 ret
= map
->bus
->write(map
->bus_context
, buf
, len
);
1052 trace_regmap_hw_write_done(map
->dev
, reg
,
1053 val_len
/ map
->format
.val_bytes
);
1058 static int _regmap_bus_formatted_write(void *context
, unsigned int reg
,
1062 struct regmap_range_node
*range
;
1063 struct regmap
*map
= context
;
1065 BUG_ON(!map
->format
.format_write
);
1067 range
= _regmap_range_lookup(map
, reg
);
1069 ret
= _regmap_select_page(map
, ®
, range
, 1);
1074 map
->format
.format_write(map
, reg
, val
);
1076 trace_regmap_hw_write_start(map
->dev
, reg
, 1);
1078 ret
= map
->bus
->write(map
->bus_context
, map
->work_buf
,
1079 map
->format
.buf_size
);
1081 trace_regmap_hw_write_done(map
->dev
, reg
, 1);
1086 static int _regmap_bus_raw_write(void *context
, unsigned int reg
,
1089 struct regmap
*map
= context
;
1091 BUG_ON(!map
->format
.format_val
);
1093 map
->format
.format_val(map
->work_buf
+ map
->format
.reg_bytes
1094 + map
->format
.pad_bytes
, val
, 0);
1095 return _regmap_raw_write(map
, reg
,
1097 map
->format
.reg_bytes
+
1098 map
->format
.pad_bytes
,
1099 map
->format
.val_bytes
, false);
1102 int _regmap_write(struct regmap
*map
, unsigned int reg
,
1107 if (!map
->cache_bypass
&& map
->format
.format_write
) {
1108 ret
= regcache_write(map
, reg
, val
);
1111 if (map
->cache_only
) {
1112 map
->cache_dirty
= true;
1118 if (strcmp(dev_name(map
->dev
), LOG_DEVICE
) == 0)
1119 dev_info(map
->dev
, "%x <= %x\n", reg
, val
);
1122 trace_regmap_reg_write(map
->dev
, reg
, val
);
1124 return map
->reg_write(map
, reg
, val
);
1128 * regmap_write(): Write a value to a single register
1130 * @map: Register map to write to
1131 * @reg: Register to write to
1132 * @val: Value to be written
1134 * A value of zero will be returned on success, a negative errno will
1135 * be returned in error cases.
1137 int regmap_write(struct regmap
*map
, unsigned int reg
, unsigned int val
)
1141 if (reg
% map
->reg_stride
)
1144 map
->lock(map
->lock_arg
);
1146 ret
= _regmap_write(map
, reg
, val
);
1148 map
->unlock(map
->lock_arg
);
1152 EXPORT_SYMBOL_GPL(regmap_write
);
1155 * regmap_raw_write(): Write raw values to one or more registers
1157 * @map: Register map to write to
1158 * @reg: Initial register to write to
1159 * @val: Block of data to be written, laid out for direct transmission to the
1161 * @val_len: Length of data pointed to by val.
1163 * This function is intended to be used for things like firmware
1164 * download where a large block of data needs to be transferred to the
1165 * device. No formatting will be done on the data provided.
1167 * A value of zero will be returned on success, a negative errno will
1168 * be returned in error cases.
1170 int regmap_raw_write(struct regmap
*map
, unsigned int reg
,
1171 const void *val
, size_t val_len
)
1175 if (val_len
% map
->format
.val_bytes
)
1177 if (reg
% map
->reg_stride
)
1180 map
->lock(map
->lock_arg
);
1182 ret
= _regmap_raw_write(map
, reg
, val
, val_len
, false);
1184 map
->unlock(map
->lock_arg
);
1188 EXPORT_SYMBOL_GPL(regmap_raw_write
);
1191 * regmap_bulk_write(): Write multiple registers to the device
1193 * @map: Register map to write to
1194 * @reg: First register to be write from
1195 * @val: Block of data to be written, in native register size for device
1196 * @val_count: Number of registers to write
1198 * This function is intended to be used for writing a large block of
1199 * data to the device either in single transfer or multiple transfer.
1201 * A value of zero will be returned on success, a negative errno will
1202 * be returned in error cases.
1204 int regmap_bulk_write(struct regmap
*map
, unsigned int reg
, const void *val
,
1208 size_t val_bytes
= map
->format
.val_bytes
;
1211 if (!map
->format
.parse_val
)
1213 if (reg
% map
->reg_stride
)
1216 map
->lock(map
->lock_arg
);
1218 /* No formatting is require if val_byte is 1 */
1219 if (val_bytes
== 1) {
1222 wval
= kmemdup(val
, val_count
* val_bytes
, GFP_KERNEL
);
1225 dev_err(map
->dev
, "Error in memory allocation\n");
1228 for (i
= 0; i
< val_count
* val_bytes
; i
+= val_bytes
)
1229 map
->format
.parse_val(wval
+ i
);
1232 * Some devices does not support bulk write, for
1233 * them we have a series of single write operations.
1235 if (map
->use_single_rw
) {
1236 for (i
= 0; i
< val_count
; i
++) {
1237 ret
= regmap_raw_write(map
,
1238 reg
+ (i
* map
->reg_stride
),
1239 val
+ (i
* val_bytes
),
1245 ret
= _regmap_raw_write(map
, reg
, wval
, val_bytes
* val_count
,
1253 map
->unlock(map
->lock_arg
);
1256 EXPORT_SYMBOL_GPL(regmap_bulk_write
);
1259 * regmap_raw_write_async(): Write raw values to one or more registers
1262 * @map: Register map to write to
1263 * @reg: Initial register to write to
1264 * @val: Block of data to be written, laid out for direct transmission to the
1265 * device. Must be valid until regmap_async_complete() is called.
1266 * @val_len: Length of data pointed to by val.
1268 * This function is intended to be used for things like firmware
1269 * download where a large block of data needs to be transferred to the
1270 * device. No formatting will be done on the data provided.
1272 * If supported by the underlying bus the write will be scheduled
1273 * asynchronously, helping maximise I/O speed on higher speed buses
1274 * like SPI. regmap_async_complete() can be called to ensure that all
1275 * asynchrnous writes have been completed.
1277 * A value of zero will be returned on success, a negative errno will
1278 * be returned in error cases.
1280 int regmap_raw_write_async(struct regmap
*map
, unsigned int reg
,
1281 const void *val
, size_t val_len
)
1285 if (val_len
% map
->format
.val_bytes
)
1287 if (reg
% map
->reg_stride
)
1290 map
->lock(map
->lock_arg
);
1292 ret
= _regmap_raw_write(map
, reg
, val
, val_len
, true);
1294 map
->unlock(map
->lock_arg
);
1298 EXPORT_SYMBOL_GPL(regmap_raw_write_async
);
1300 static int _regmap_raw_read(struct regmap
*map
, unsigned int reg
, void *val
,
1301 unsigned int val_len
)
1303 struct regmap_range_node
*range
;
1304 u8
*u8
= map
->work_buf
;
1307 range
= _regmap_range_lookup(map
, reg
);
1309 ret
= _regmap_select_page(map
, ®
, range
,
1310 val_len
/ map
->format
.val_bytes
);
1315 map
->format
.format_reg(map
->work_buf
, reg
, map
->reg_shift
);
1318 * Some buses or devices flag reads by setting the high bits in the
1319 * register addresss; since it's always the high bits for all
1320 * current formats we can do this here rather than in
1321 * formatting. This may break if we get interesting formats.
1323 u8
[0] |= map
->read_flag_mask
;
1325 trace_regmap_hw_read_start(map
->dev
, reg
,
1326 val_len
/ map
->format
.val_bytes
);
1328 ret
= map
->bus
->read(map
->bus_context
, map
->work_buf
,
1329 map
->format
.reg_bytes
+ map
->format
.pad_bytes
,
1332 trace_regmap_hw_read_done(map
->dev
, reg
,
1333 val_len
/ map
->format
.val_bytes
);
1338 static int _regmap_bus_read(void *context
, unsigned int reg
,
1342 struct regmap
*map
= context
;
1344 if (!map
->format
.parse_val
)
1347 ret
= _regmap_raw_read(map
, reg
, map
->work_buf
, map
->format
.val_bytes
);
1349 *val
= map
->format
.parse_val(map
->work_buf
);
1354 static int _regmap_read(struct regmap
*map
, unsigned int reg
,
1358 BUG_ON(!map
->reg_read
);
1360 if (!map
->cache_bypass
) {
1361 ret
= regcache_read(map
, reg
, val
);
1366 if (map
->cache_only
)
1369 ret
= map
->reg_read(map
, reg
, val
);
1372 if (strcmp(dev_name(map
->dev
), LOG_DEVICE
) == 0)
1373 dev_info(map
->dev
, "%x => %x\n", reg
, *val
);
1376 trace_regmap_reg_read(map
->dev
, reg
, *val
);
1378 if (!map
->cache_bypass
)
1379 regcache_write(map
, reg
, *val
);
1386 * regmap_read(): Read a value from a single register
1388 * @map: Register map to write to
1389 * @reg: Register to be read from
1390 * @val: Pointer to store read value
1392 * A value of zero will be returned on success, a negative errno will
1393 * be returned in error cases.
1395 int regmap_read(struct regmap
*map
, unsigned int reg
, unsigned int *val
)
1399 if (reg
% map
->reg_stride
)
1402 map
->lock(map
->lock_arg
);
1404 ret
= _regmap_read(map
, reg
, val
);
1406 map
->unlock(map
->lock_arg
);
1410 EXPORT_SYMBOL_GPL(regmap_read
);
1413 * regmap_raw_read(): Read raw data from the device
1415 * @map: Register map to write to
1416 * @reg: First register to be read from
1417 * @val: Pointer to store read value
1418 * @val_len: Size of data to read
1420 * A value of zero will be returned on success, a negative errno will
1421 * be returned in error cases.
1423 int regmap_raw_read(struct regmap
*map
, unsigned int reg
, void *val
,
1426 size_t val_bytes
= map
->format
.val_bytes
;
1427 size_t val_count
= val_len
/ val_bytes
;
1431 if (val_len
% map
->format
.val_bytes
)
1433 if (reg
% map
->reg_stride
)
1436 map
->lock(map
->lock_arg
);
1438 if (regmap_volatile_range(map
, reg
, val_count
) || map
->cache_bypass
||
1439 map
->cache_type
== REGCACHE_NONE
) {
1440 /* Physical block read if there's no cache involved */
1441 ret
= _regmap_raw_read(map
, reg
, val
, val_len
);
1444 /* Otherwise go word by word for the cache; should be low
1445 * cost as we expect to hit the cache.
1447 for (i
= 0; i
< val_count
; i
++) {
1448 ret
= _regmap_read(map
, reg
+ (i
* map
->reg_stride
),
1453 map
->format
.format_val(val
+ (i
* val_bytes
), v
, 0);
1458 map
->unlock(map
->lock_arg
);
1462 EXPORT_SYMBOL_GPL(regmap_raw_read
);
1465 * regmap_bulk_read(): Read multiple registers from the device
1467 * @map: Register map to write to
1468 * @reg: First register to be read from
1469 * @val: Pointer to store read value, in native register size for device
1470 * @val_count: Number of registers to read
1472 * A value of zero will be returned on success, a negative errno will
1473 * be returned in error cases.
1475 int regmap_bulk_read(struct regmap
*map
, unsigned int reg
, void *val
,
1479 size_t val_bytes
= map
->format
.val_bytes
;
1480 bool vol
= regmap_volatile_range(map
, reg
, val_count
);
1482 if (!map
->format
.parse_val
)
1484 if (reg
% map
->reg_stride
)
1487 if (vol
|| map
->cache_type
== REGCACHE_NONE
) {
1489 * Some devices does not support bulk read, for
1490 * them we have a series of single read operations.
1492 if (map
->use_single_rw
) {
1493 for (i
= 0; i
< val_count
; i
++) {
1494 ret
= regmap_raw_read(map
,
1495 reg
+ (i
* map
->reg_stride
),
1496 val
+ (i
* val_bytes
),
1502 ret
= regmap_raw_read(map
, reg
, val
,
1503 val_bytes
* val_count
);
1508 for (i
= 0; i
< val_count
* val_bytes
; i
+= val_bytes
)
1509 map
->format
.parse_val(val
+ i
);
1511 for (i
= 0; i
< val_count
; i
++) {
1513 ret
= regmap_read(map
, reg
+ (i
* map
->reg_stride
),
1517 memcpy(val
+ (i
* val_bytes
), &ival
, val_bytes
);
1523 EXPORT_SYMBOL_GPL(regmap_bulk_read
);
1525 static int _regmap_update_bits(struct regmap
*map
, unsigned int reg
,
1526 unsigned int mask
, unsigned int val
,
1530 unsigned int tmp
, orig
;
1532 ret
= _regmap_read(map
, reg
, &orig
);
1540 ret
= _regmap_write(map
, reg
, tmp
);
1550 * regmap_update_bits: Perform a read/modify/write cycle on the register map
1552 * @map: Register map to update
1553 * @reg: Register to update
1554 * @mask: Bitmask to change
1555 * @val: New value for bitmask
1557 * Returns zero for success, a negative number on error.
1559 int regmap_update_bits(struct regmap
*map
, unsigned int reg
,
1560 unsigned int mask
, unsigned int val
)
1565 map
->lock(map
->lock_arg
);
1566 ret
= _regmap_update_bits(map
, reg
, mask
, val
, &change
);
1567 map
->unlock(map
->lock_arg
);
1571 EXPORT_SYMBOL_GPL(regmap_update_bits
);
1574 * regmap_update_bits_check: Perform a read/modify/write cycle on the
1575 * register map and report if updated
1577 * @map: Register map to update
1578 * @reg: Register to update
1579 * @mask: Bitmask to change
1580 * @val: New value for bitmask
1581 * @change: Boolean indicating if a write was done
1583 * Returns zero for success, a negative number on error.
1585 int regmap_update_bits_check(struct regmap
*map
, unsigned int reg
,
1586 unsigned int mask
, unsigned int val
,
1591 map
->lock(map
->lock_arg
);
1592 ret
= _regmap_update_bits(map
, reg
, mask
, val
, change
);
1593 map
->unlock(map
->lock_arg
);
1596 EXPORT_SYMBOL_GPL(regmap_update_bits_check
);
1598 void regmap_async_complete_cb(struct regmap_async
*async
, int ret
)
1600 struct regmap
*map
= async
->map
;
1603 spin_lock(&map
->async_lock
);
1605 list_del(&async
->list
);
1606 wake
= list_empty(&map
->async_list
);
1609 map
->async_ret
= ret
;
1611 spin_unlock(&map
->async_lock
);
1613 schedule_work(&async
->cleanup
);
1616 wake_up(&map
->async_waitq
);
1618 EXPORT_SYMBOL_GPL(regmap_async_complete_cb
);
1620 static int regmap_async_is_done(struct regmap
*map
)
1622 unsigned long flags
;
1625 spin_lock_irqsave(&map
->async_lock
, flags
);
1626 ret
= list_empty(&map
->async_list
);
1627 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1633 * regmap_async_complete: Ensure all asynchronous I/O has completed.
1635 * @map: Map to operate on.
1637 * Blocks until any pending asynchronous I/O has completed. Returns
1638 * an error code for any failed I/O operations.
1640 int regmap_async_complete(struct regmap
*map
)
1642 unsigned long flags
;
1645 /* Nothing to do with no async support */
1646 if (!map
->bus
->async_write
)
1649 wait_event(map
->async_waitq
, regmap_async_is_done(map
));
1651 spin_lock_irqsave(&map
->async_lock
, flags
);
1652 ret
= map
->async_ret
;
1654 spin_unlock_irqrestore(&map
->async_lock
, flags
);
1658 EXPORT_SYMBOL_GPL(regmap_async_complete
);
1661 * regmap_register_patch: Register and apply register updates to be applied
1662 * on device initialistion
1664 * @map: Register map to apply updates to.
1665 * @regs: Values to update.
1666 * @num_regs: Number of entries in regs.
1668 * Register a set of register updates to be applied to the device
1669 * whenever the device registers are synchronised with the cache and
1670 * apply them immediately. Typically this is used to apply
1671 * corrections to be applied to the device defaults on startup, such
1672 * as the updates some vendors provide to undocumented registers.
1674 int regmap_register_patch(struct regmap
*map
, const struct reg_default
*regs
,
1680 /* If needed the implementation can be extended to support this */
1684 map
->lock(map
->lock_arg
);
1686 bypass
= map
->cache_bypass
;
1688 map
->cache_bypass
= true;
1690 /* Write out first; it's useful to apply even if we fail later. */
1691 for (i
= 0; i
< num_regs
; i
++) {
1692 ret
= _regmap_write(map
, regs
[i
].reg
, regs
[i
].def
);
1694 dev_err(map
->dev
, "Failed to write %x = %x: %d\n",
1695 regs
[i
].reg
, regs
[i
].def
, ret
);
1700 map
->patch
= kcalloc(num_regs
, sizeof(struct reg_default
), GFP_KERNEL
);
1701 if (map
->patch
!= NULL
) {
1702 memcpy(map
->patch
, regs
,
1703 num_regs
* sizeof(struct reg_default
));
1704 map
->patch_regs
= num_regs
;
1710 map
->cache_bypass
= bypass
;
1712 map
->unlock(map
->lock_arg
);
1716 EXPORT_SYMBOL_GPL(regmap_register_patch
);
1719 * regmap_get_val_bytes(): Report the size of a register value
1721 * Report the size of a register value, mainly intended to for use by
1722 * generic infrastructure built on top of regmap.
1724 int regmap_get_val_bytes(struct regmap
*map
)
1726 if (map
->format
.format_write
)
1729 return map
->format
.val_bytes
;
1731 EXPORT_SYMBOL_GPL(regmap_get_val_bytes
);
1733 static int __init
regmap_initcall(void)
1735 regmap_debugfs_initcall();
1739 postcore_initcall(regmap_initcall
);