2 * soc-cache.c -- ASoC register cache helpers
4 * Copyright 2009 Wolfson Microelectronics PLC.
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
14 #include <linux/i2c.h>
15 #include <linux/spi/spi.h>
16 #include <sound/soc.h>
17 #include <linux/lzo.h>
18 #include <linux/bitmap.h>
19 #include <linux/rbtree.h>
21 #include <trace/events/asoc.h>
23 #ifdef CONFIG_SPI_MASTER
24 static int do_spi_write(void *control
, const char *data
, int len
)
26 struct spi_device
*spi
= control
;
29 ret
= spi_write(spi
, data
, len
);
37 static int do_hw_write(struct snd_soc_codec
*codec
, unsigned int reg
,
38 unsigned int value
, const void *data
, int len
)
42 if (!snd_soc_codec_volatile_register(codec
, reg
) &&
43 reg
< codec
->driver
->reg_cache_size
&&
44 !codec
->cache_bypass
) {
45 ret
= snd_soc_cache_write(codec
, reg
, value
);
50 if (codec
->cache_only
) {
51 codec
->cache_sync
= 1;
55 ret
= codec
->hw_write(codec
->control_data
, data
, len
);
64 static unsigned int do_hw_read(struct snd_soc_codec
*codec
, unsigned int reg
)
69 if (reg
>= codec
->driver
->reg_cache_size
||
70 snd_soc_codec_volatile_register(codec
, reg
) ||
71 codec
->cache_bypass
) {
72 if (codec
->cache_only
)
75 BUG_ON(!codec
->hw_read
);
76 return codec
->hw_read(codec
, reg
);
79 ret
= snd_soc_cache_read(codec
, reg
, &val
);
85 static unsigned int snd_soc_4_12_read(struct snd_soc_codec
*codec
,
88 return do_hw_read(codec
, reg
);
91 static int snd_soc_4_12_write(struct snd_soc_codec
*codec
, unsigned int reg
,
96 data
= cpu_to_be16((reg
<< 12) | (value
& 0xffffff));
98 return do_hw_write(codec
, reg
, value
, &data
, 2);
101 static unsigned int snd_soc_7_9_read(struct snd_soc_codec
*codec
,
104 return do_hw_read(codec
, reg
);
107 static int snd_soc_7_9_write(struct snd_soc_codec
*codec
, unsigned int reg
,
112 data
[0] = (reg
<< 1) | ((value
>> 8) & 0x0001);
113 data
[1] = value
& 0x00ff;
115 return do_hw_write(codec
, reg
, value
, data
, 2);
118 static int snd_soc_8_8_write(struct snd_soc_codec
*codec
, unsigned int reg
,
125 data
[1] = value
& 0xff;
127 return do_hw_write(codec
, reg
, value
, data
, 2);
130 static unsigned int snd_soc_8_8_read(struct snd_soc_codec
*codec
,
133 return do_hw_read(codec
, reg
);
136 static int snd_soc_8_16_write(struct snd_soc_codec
*codec
, unsigned int reg
,
142 data
[1] = (value
>> 8) & 0xff;
143 data
[2] = value
& 0xff;
145 return do_hw_write(codec
, reg
, value
, data
, 3);
148 static unsigned int snd_soc_8_16_read(struct snd_soc_codec
*codec
,
151 return do_hw_read(codec
, reg
);
154 #if defined(CONFIG_I2C) || (defined(CONFIG_I2C_MODULE) && defined(MODULE))
155 static unsigned int do_i2c_read(struct snd_soc_codec
*codec
,
156 void *reg
, int reglen
,
157 void *data
, int datalen
)
159 struct i2c_msg xfer
[2];
161 struct i2c_client
*client
= codec
->control_data
;
164 xfer
[0].addr
= client
->addr
;
166 xfer
[0].len
= reglen
;
170 xfer
[1].addr
= client
->addr
;
171 xfer
[1].flags
= I2C_M_RD
;
172 xfer
[1].len
= datalen
;
175 ret
= i2c_transfer(client
->adapter
, xfer
, 2);
185 #if defined(CONFIG_I2C) || (defined(CONFIG_I2C_MODULE) && defined(MODULE))
186 static unsigned int snd_soc_8_8_read_i2c(struct snd_soc_codec
*codec
,
193 ret
= do_i2c_read(codec
, ®
, 1, &data
, 1);
199 #define snd_soc_8_8_read_i2c NULL
202 #if defined(CONFIG_I2C) || (defined(CONFIG_I2C_MODULE) && defined(MODULE))
203 static unsigned int snd_soc_8_16_read_i2c(struct snd_soc_codec
*codec
,
210 ret
= do_i2c_read(codec
, ®
, 1, &data
, 2);
213 return (data
>> 8) | ((data
& 0xff) << 8);
216 #define snd_soc_8_16_read_i2c NULL
219 #if defined(CONFIG_I2C) || (defined(CONFIG_I2C_MODULE) && defined(MODULE))
220 static unsigned int snd_soc_16_8_read_i2c(struct snd_soc_codec
*codec
,
227 ret
= do_i2c_read(codec
, ®
, 2, &data
, 1);
233 #define snd_soc_16_8_read_i2c NULL
236 static unsigned int snd_soc_16_8_read(struct snd_soc_codec
*codec
,
239 return do_hw_read(codec
, reg
);
242 static int snd_soc_16_8_write(struct snd_soc_codec
*codec
, unsigned int reg
,
247 data
[0] = (reg
>> 8) & 0xff;
248 data
[1] = reg
& 0xff;
251 return do_hw_write(codec
, reg
, value
, data
, 3);
254 #if defined(CONFIG_I2C) || (defined(CONFIG_I2C_MODULE) && defined(MODULE))
255 static unsigned int snd_soc_16_16_read_i2c(struct snd_soc_codec
*codec
,
258 u16 reg
= cpu_to_be16(r
);
262 ret
= do_i2c_read(codec
, ®
, 2, &data
, 2);
265 return be16_to_cpu(data
);
268 #define snd_soc_16_16_read_i2c NULL
271 static unsigned int snd_soc_16_16_read(struct snd_soc_codec
*codec
,
274 return do_hw_read(codec
, reg
);
277 static int snd_soc_16_16_write(struct snd_soc_codec
*codec
, unsigned int reg
,
282 data
[0] = (reg
>> 8) & 0xff;
283 data
[1] = reg
& 0xff;
284 data
[2] = (value
>> 8) & 0xff;
285 data
[3] = value
& 0xff;
287 return do_hw_write(codec
, reg
, value
, data
, 4);
290 /* Primitive bulk write support for soc-cache. The data pointed to by
291 * `data' needs to already be in the form the hardware expects
292 * including any leading register specific data. Any data written
293 * through this function will not go through the cache as it only
294 * handles writing to volatile or out of bounds registers.
296 static int snd_soc_hw_bulk_write_raw(struct snd_soc_codec
*codec
, unsigned int reg
,
297 const void *data
, size_t len
)
301 /* To ensure that we don't get out of sync with the cache, check
302 * whether the base register is volatile or if we've directly asked
303 * to bypass the cache. Out of bounds registers are considered
306 if (!codec
->cache_bypass
307 && !snd_soc_codec_volatile_register(codec
, reg
)
308 && reg
< codec
->driver
->reg_cache_size
)
311 switch (codec
->control_type
) {
312 #if defined(CONFIG_I2C) || (defined(CONFIG_I2C_MODULE) && defined(MODULE))
314 ret
= i2c_master_send(codec
->control_data
, data
, len
);
317 #if defined(CONFIG_SPI_MASTER)
319 ret
= spi_write(codec
->control_data
, data
, len
);
337 int (*write
)(struct snd_soc_codec
*codec
, unsigned int, unsigned int);
338 unsigned int (*read
)(struct snd_soc_codec
*, unsigned int);
339 unsigned int (*i2c_read
)(struct snd_soc_codec
*, unsigned int);
342 .addr_bits
= 4, .data_bits
= 12,
343 .write
= snd_soc_4_12_write
, .read
= snd_soc_4_12_read
,
346 .addr_bits
= 7, .data_bits
= 9,
347 .write
= snd_soc_7_9_write
, .read
= snd_soc_7_9_read
,
350 .addr_bits
= 8, .data_bits
= 8,
351 .write
= snd_soc_8_8_write
, .read
= snd_soc_8_8_read
,
352 .i2c_read
= snd_soc_8_8_read_i2c
,
355 .addr_bits
= 8, .data_bits
= 16,
356 .write
= snd_soc_8_16_write
, .read
= snd_soc_8_16_read
,
357 .i2c_read
= snd_soc_8_16_read_i2c
,
360 .addr_bits
= 16, .data_bits
= 8,
361 .write
= snd_soc_16_8_write
, .read
= snd_soc_16_8_read
,
362 .i2c_read
= snd_soc_16_8_read_i2c
,
365 .addr_bits
= 16, .data_bits
= 16,
366 .write
= snd_soc_16_16_write
, .read
= snd_soc_16_16_read
,
367 .i2c_read
= snd_soc_16_16_read_i2c
,
372 * snd_soc_codec_set_cache_io: Set up standard I/O functions.
374 * @codec: CODEC to configure.
375 * @addr_bits: Number of bits of register address data.
376 * @data_bits: Number of bits of data per register.
377 * @control: Control bus used.
379 * Register formats are frequently shared between many I2C and SPI
380 * devices. In order to promote code reuse the ASoC core provides
381 * some standard implementations of CODEC read and write operations
382 * which can be set up using this function.
384 * The caller is responsible for allocating and initialising the
387 * Note that at present this code cannot be used by CODECs with
388 * volatile registers.
390 int snd_soc_codec_set_cache_io(struct snd_soc_codec
*codec
,
391 int addr_bits
, int data_bits
,
392 enum snd_soc_control_type control
)
396 for (i
= 0; i
< ARRAY_SIZE(io_types
); i
++)
397 if (io_types
[i
].addr_bits
== addr_bits
&&
398 io_types
[i
].data_bits
== data_bits
)
400 if (i
== ARRAY_SIZE(io_types
)) {
402 "No I/O functions for %d bit address %d bit data\n",
403 addr_bits
, data_bits
);
407 codec
->write
= io_types
[i
].write
;
408 codec
->read
= io_types
[i
].read
;
409 codec
->bulk_write_raw
= snd_soc_hw_bulk_write_raw
;
416 #if defined(CONFIG_I2C) || (defined(CONFIG_I2C_MODULE) && defined(MODULE))
417 codec
->hw_write
= (hw_write_t
)i2c_master_send
;
419 if (io_types
[i
].i2c_read
)
420 codec
->hw_read
= io_types
[i
].i2c_read
;
422 codec
->control_data
= container_of(codec
->dev
,
428 #ifdef CONFIG_SPI_MASTER
429 codec
->hw_write
= do_spi_write
;
432 codec
->control_data
= container_of(codec
->dev
,
440 EXPORT_SYMBOL_GPL(snd_soc_codec_set_cache_io
);
442 static bool snd_soc_set_cache_val(void *base
, unsigned int idx
,
443 unsigned int val
, unsigned int word_size
)
448 if (cache
[idx
] == val
)
455 if (cache
[idx
] == val
)
466 static unsigned int snd_soc_get_cache_val(const void *base
, unsigned int idx
,
467 unsigned int word_size
)
474 const u8
*cache
= base
;
478 const u16
*cache
= base
;
488 struct snd_soc_rbtree_node
{
493 } __attribute__ ((packed
));
495 struct snd_soc_rbtree_ctx
{
499 static struct snd_soc_rbtree_node
*snd_soc_rbtree_lookup(
500 struct rb_root
*root
, unsigned int reg
)
502 struct rb_node
*node
;
503 struct snd_soc_rbtree_node
*rbnode
;
505 node
= root
->rb_node
;
507 rbnode
= container_of(node
, struct snd_soc_rbtree_node
, node
);
508 if (rbnode
->reg
< reg
)
509 node
= node
->rb_left
;
510 else if (rbnode
->reg
> reg
)
511 node
= node
->rb_right
;
519 static int snd_soc_rbtree_insert(struct rb_root
*root
,
520 struct snd_soc_rbtree_node
*rbnode
)
522 struct rb_node
**new, *parent
;
523 struct snd_soc_rbtree_node
*rbnode_tmp
;
526 new = &root
->rb_node
;
528 rbnode_tmp
= container_of(*new, struct snd_soc_rbtree_node
,
531 if (rbnode_tmp
->reg
< rbnode
->reg
)
532 new = &((*new)->rb_left
);
533 else if (rbnode_tmp
->reg
> rbnode
->reg
)
534 new = &((*new)->rb_right
);
539 /* insert the node into the rbtree */
540 rb_link_node(&rbnode
->node
, parent
, new);
541 rb_insert_color(&rbnode
->node
, root
);
546 static int snd_soc_rbtree_cache_sync(struct snd_soc_codec
*codec
)
548 struct snd_soc_rbtree_ctx
*rbtree_ctx
;
549 struct rb_node
*node
;
550 struct snd_soc_rbtree_node
*rbnode
;
554 rbtree_ctx
= codec
->reg_cache
;
555 for (node
= rb_first(&rbtree_ctx
->root
); node
; node
= rb_next(node
)) {
556 rbnode
= rb_entry(node
, struct snd_soc_rbtree_node
, node
);
557 if (rbnode
->value
== rbnode
->defval
)
559 WARN_ON(codec
->writable_register
&&
560 codec
->writable_register(codec
, rbnode
->reg
));
561 ret
= snd_soc_cache_read(codec
, rbnode
->reg
, &val
);
564 codec
->cache_bypass
= 1;
565 ret
= snd_soc_write(codec
, rbnode
->reg
, val
);
566 codec
->cache_bypass
= 0;
569 dev_dbg(codec
->dev
, "Synced register %#x, value = %#x\n",
576 static int snd_soc_rbtree_cache_write(struct snd_soc_codec
*codec
,
577 unsigned int reg
, unsigned int value
)
579 struct snd_soc_rbtree_ctx
*rbtree_ctx
;
580 struct snd_soc_rbtree_node
*rbnode
;
582 rbtree_ctx
= codec
->reg_cache
;
583 rbnode
= snd_soc_rbtree_lookup(&rbtree_ctx
->root
, reg
);
585 if (rbnode
->value
== value
)
587 rbnode
->value
= value
;
589 /* bail out early, no need to create the rbnode yet */
593 * for uninitialized registers whose value is changed
594 * from the default zero, create an rbnode and insert
597 rbnode
= kzalloc(sizeof *rbnode
, GFP_KERNEL
);
601 rbnode
->value
= value
;
602 snd_soc_rbtree_insert(&rbtree_ctx
->root
, rbnode
);
608 static int snd_soc_rbtree_cache_read(struct snd_soc_codec
*codec
,
609 unsigned int reg
, unsigned int *value
)
611 struct snd_soc_rbtree_ctx
*rbtree_ctx
;
612 struct snd_soc_rbtree_node
*rbnode
;
614 rbtree_ctx
= codec
->reg_cache
;
615 rbnode
= snd_soc_rbtree_lookup(&rbtree_ctx
->root
, reg
);
617 *value
= rbnode
->value
;
619 /* uninitialized registers default to 0 */
626 static int snd_soc_rbtree_cache_exit(struct snd_soc_codec
*codec
)
628 struct rb_node
*next
;
629 struct snd_soc_rbtree_ctx
*rbtree_ctx
;
630 struct snd_soc_rbtree_node
*rbtree_node
;
632 /* if we've already been called then just return */
633 rbtree_ctx
= codec
->reg_cache
;
637 /* free up the rbtree */
638 next
= rb_first(&rbtree_ctx
->root
);
640 rbtree_node
= rb_entry(next
, struct snd_soc_rbtree_node
, node
);
641 next
= rb_next(&rbtree_node
->node
);
642 rb_erase(&rbtree_node
->node
, &rbtree_ctx
->root
);
646 /* release the resources */
647 kfree(codec
->reg_cache
);
648 codec
->reg_cache
= NULL
;
653 static int snd_soc_rbtree_cache_init(struct snd_soc_codec
*codec
)
655 struct snd_soc_rbtree_node
*rbtree_node
;
656 struct snd_soc_rbtree_ctx
*rbtree_ctx
;
658 unsigned int word_size
;
662 codec
->reg_cache
= kmalloc(sizeof *rbtree_ctx
, GFP_KERNEL
);
663 if (!codec
->reg_cache
)
666 rbtree_ctx
= codec
->reg_cache
;
667 rbtree_ctx
->root
= RB_ROOT
;
669 if (!codec
->reg_def_copy
)
673 * populate the rbtree with the initialized registers. All other
674 * registers will be inserted when they are first modified.
676 word_size
= codec
->driver
->reg_word_size
;
677 for (i
= 0; i
< codec
->driver
->reg_cache_size
; ++i
) {
678 val
= snd_soc_get_cache_val(codec
->reg_def_copy
, i
, word_size
);
681 rbtree_node
= kzalloc(sizeof *rbtree_node
, GFP_KERNEL
);
684 snd_soc_cache_exit(codec
);
687 rbtree_node
->reg
= i
;
688 rbtree_node
->value
= val
;
689 rbtree_node
->defval
= val
;
690 snd_soc_rbtree_insert(&rbtree_ctx
->root
, rbtree_node
);
696 #ifdef CONFIG_SND_SOC_CACHE_LZO
697 struct snd_soc_lzo_ctx
{
703 size_t decompressed_size
;
704 unsigned long *sync_bmp
;
708 #define LZO_BLOCK_NUM 8
709 static int snd_soc_lzo_block_count(void)
711 return LZO_BLOCK_NUM
;
714 static int snd_soc_lzo_prepare(struct snd_soc_lzo_ctx
*lzo_ctx
)
716 lzo_ctx
->wmem
= kmalloc(LZO1X_MEM_COMPRESS
, GFP_KERNEL
);
722 static int snd_soc_lzo_compress(struct snd_soc_lzo_ctx
*lzo_ctx
)
724 size_t compress_size
;
727 ret
= lzo1x_1_compress(lzo_ctx
->src
, lzo_ctx
->src_len
,
728 lzo_ctx
->dst
, &compress_size
, lzo_ctx
->wmem
);
729 if (ret
!= LZO_E_OK
|| compress_size
> lzo_ctx
->dst_len
)
731 lzo_ctx
->dst_len
= compress_size
;
735 static int snd_soc_lzo_decompress(struct snd_soc_lzo_ctx
*lzo_ctx
)
740 dst_len
= lzo_ctx
->dst_len
;
741 ret
= lzo1x_decompress_safe(lzo_ctx
->src
, lzo_ctx
->src_len
,
742 lzo_ctx
->dst
, &dst_len
);
743 if (ret
!= LZO_E_OK
|| dst_len
!= lzo_ctx
->dst_len
)
748 static int snd_soc_lzo_compress_cache_block(struct snd_soc_codec
*codec
,
749 struct snd_soc_lzo_ctx
*lzo_ctx
)
753 lzo_ctx
->dst_len
= lzo1x_worst_compress(PAGE_SIZE
);
754 lzo_ctx
->dst
= kmalloc(lzo_ctx
->dst_len
, GFP_KERNEL
);
756 lzo_ctx
->dst_len
= 0;
760 ret
= snd_soc_lzo_compress(lzo_ctx
);
766 static int snd_soc_lzo_decompress_cache_block(struct snd_soc_codec
*codec
,
767 struct snd_soc_lzo_ctx
*lzo_ctx
)
771 lzo_ctx
->dst_len
= lzo_ctx
->decompressed_size
;
772 lzo_ctx
->dst
= kmalloc(lzo_ctx
->dst_len
, GFP_KERNEL
);
774 lzo_ctx
->dst_len
= 0;
778 ret
= snd_soc_lzo_decompress(lzo_ctx
);
784 static inline int snd_soc_lzo_get_blkindex(struct snd_soc_codec
*codec
,
787 const struct snd_soc_codec_driver
*codec_drv
;
789 codec_drv
= codec
->driver
;
790 return (reg
* codec_drv
->reg_word_size
) /
791 DIV_ROUND_UP(codec
->reg_size
, snd_soc_lzo_block_count());
794 static inline int snd_soc_lzo_get_blkpos(struct snd_soc_codec
*codec
,
797 const struct snd_soc_codec_driver
*codec_drv
;
799 codec_drv
= codec
->driver
;
800 return reg
% (DIV_ROUND_UP(codec
->reg_size
, snd_soc_lzo_block_count()) /
801 codec_drv
->reg_word_size
);
804 static inline int snd_soc_lzo_get_blksize(struct snd_soc_codec
*codec
)
806 const struct snd_soc_codec_driver
*codec_drv
;
808 codec_drv
= codec
->driver
;
809 return DIV_ROUND_UP(codec
->reg_size
, snd_soc_lzo_block_count());
812 static int snd_soc_lzo_cache_sync(struct snd_soc_codec
*codec
)
814 struct snd_soc_lzo_ctx
**lzo_blocks
;
819 lzo_blocks
= codec
->reg_cache
;
820 for_each_set_bit(i
, lzo_blocks
[0]->sync_bmp
, lzo_blocks
[0]->sync_bmp_nbits
) {
821 WARN_ON(codec
->writable_register
&&
822 codec
->writable_register(codec
, i
));
823 ret
= snd_soc_cache_read(codec
, i
, &val
);
826 codec
->cache_bypass
= 1;
827 ret
= snd_soc_write(codec
, i
, val
);
828 codec
->cache_bypass
= 0;
831 dev_dbg(codec
->dev
, "Synced register %#x, value = %#x\n",
838 static int snd_soc_lzo_cache_write(struct snd_soc_codec
*codec
,
839 unsigned int reg
, unsigned int value
)
841 struct snd_soc_lzo_ctx
*lzo_block
, **lzo_blocks
;
842 int ret
, blkindex
, blkpos
;
843 size_t blksize
, tmp_dst_len
;
846 /* index of the compressed lzo block */
847 blkindex
= snd_soc_lzo_get_blkindex(codec
, reg
);
848 /* register index within the decompressed block */
849 blkpos
= snd_soc_lzo_get_blkpos(codec
, reg
);
850 /* size of the compressed block */
851 blksize
= snd_soc_lzo_get_blksize(codec
);
852 lzo_blocks
= codec
->reg_cache
;
853 lzo_block
= lzo_blocks
[blkindex
];
855 /* save the pointer and length of the compressed block */
856 tmp_dst
= lzo_block
->dst
;
857 tmp_dst_len
= lzo_block
->dst_len
;
859 /* prepare the source to be the compressed block */
860 lzo_block
->src
= lzo_block
->dst
;
861 lzo_block
->src_len
= lzo_block
->dst_len
;
863 /* decompress the block */
864 ret
= snd_soc_lzo_decompress_cache_block(codec
, lzo_block
);
866 kfree(lzo_block
->dst
);
870 /* write the new value to the cache */
871 if (snd_soc_set_cache_val(lzo_block
->dst
, blkpos
, value
,
872 codec
->driver
->reg_word_size
)) {
873 kfree(lzo_block
->dst
);
877 /* prepare the source to be the decompressed block */
878 lzo_block
->src
= lzo_block
->dst
;
879 lzo_block
->src_len
= lzo_block
->dst_len
;
881 /* compress the block */
882 ret
= snd_soc_lzo_compress_cache_block(codec
, lzo_block
);
884 kfree(lzo_block
->dst
);
885 kfree(lzo_block
->src
);
889 /* set the bit so we know we have to sync this register */
890 set_bit(reg
, lzo_block
->sync_bmp
);
892 kfree(lzo_block
->src
);
895 lzo_block
->dst
= tmp_dst
;
896 lzo_block
->dst_len
= tmp_dst_len
;
900 static int snd_soc_lzo_cache_read(struct snd_soc_codec
*codec
,
901 unsigned int reg
, unsigned int *value
)
903 struct snd_soc_lzo_ctx
*lzo_block
, **lzo_blocks
;
904 int ret
, blkindex
, blkpos
;
905 size_t blksize
, tmp_dst_len
;
909 /* index of the compressed lzo block */
910 blkindex
= snd_soc_lzo_get_blkindex(codec
, reg
);
911 /* register index within the decompressed block */
912 blkpos
= snd_soc_lzo_get_blkpos(codec
, reg
);
913 /* size of the compressed block */
914 blksize
= snd_soc_lzo_get_blksize(codec
);
915 lzo_blocks
= codec
->reg_cache
;
916 lzo_block
= lzo_blocks
[blkindex
];
918 /* save the pointer and length of the compressed block */
919 tmp_dst
= lzo_block
->dst
;
920 tmp_dst_len
= lzo_block
->dst_len
;
922 /* prepare the source to be the compressed block */
923 lzo_block
->src
= lzo_block
->dst
;
924 lzo_block
->src_len
= lzo_block
->dst_len
;
926 /* decompress the block */
927 ret
= snd_soc_lzo_decompress_cache_block(codec
, lzo_block
);
929 /* fetch the value from the cache */
930 *value
= snd_soc_get_cache_val(lzo_block
->dst
, blkpos
,
931 codec
->driver
->reg_word_size
);
933 kfree(lzo_block
->dst
);
934 /* restore the pointer and length of the compressed block */
935 lzo_block
->dst
= tmp_dst
;
936 lzo_block
->dst_len
= tmp_dst_len
;
940 static int snd_soc_lzo_cache_exit(struct snd_soc_codec
*codec
)
942 struct snd_soc_lzo_ctx
**lzo_blocks
;
945 lzo_blocks
= codec
->reg_cache
;
949 blkcount
= snd_soc_lzo_block_count();
951 * the pointer to the bitmap used for syncing the cache
952 * is shared amongst all lzo_blocks. Ensure it is freed
956 kfree(lzo_blocks
[0]->sync_bmp
);
957 for (i
= 0; i
< blkcount
; ++i
) {
959 kfree(lzo_blocks
[i
]->wmem
);
960 kfree(lzo_blocks
[i
]->dst
);
962 /* each lzo_block is a pointer returned by kmalloc or NULL */
963 kfree(lzo_blocks
[i
]);
966 codec
->reg_cache
= NULL
;
970 static int snd_soc_lzo_cache_init(struct snd_soc_codec
*codec
)
972 struct snd_soc_lzo_ctx
**lzo_blocks
;
974 const struct snd_soc_codec_driver
*codec_drv
;
975 int ret
, tofree
, i
, blksize
, blkcount
;
977 unsigned long *sync_bmp
;
980 codec_drv
= codec
->driver
;
983 * If we have not been given a default register cache
984 * then allocate a dummy zero-ed out region, compress it
985 * and remember to free it afterwards.
988 if (!codec
->reg_def_copy
)
991 if (!codec
->reg_def_copy
) {
992 codec
->reg_def_copy
= kzalloc(codec
->reg_size
, GFP_KERNEL
);
993 if (!codec
->reg_def_copy
)
997 blkcount
= snd_soc_lzo_block_count();
998 codec
->reg_cache
= kzalloc(blkcount
* sizeof *lzo_blocks
,
1000 if (!codec
->reg_cache
) {
1004 lzo_blocks
= codec
->reg_cache
;
1007 * allocate a bitmap to be used when syncing the cache with
1008 * the hardware. Each time a register is modified, the corresponding
1009 * bit is set in the bitmap, so we know that we have to sync
1012 bmp_size
= codec_drv
->reg_cache_size
;
1013 sync_bmp
= kmalloc(BITS_TO_LONGS(bmp_size
) * sizeof(long),
1019 bitmap_zero(sync_bmp
, bmp_size
);
1021 /* allocate the lzo blocks and initialize them */
1022 for (i
= 0; i
< blkcount
; ++i
) {
1023 lzo_blocks
[i
] = kzalloc(sizeof **lzo_blocks
,
1025 if (!lzo_blocks
[i
]) {
1030 lzo_blocks
[i
]->sync_bmp
= sync_bmp
;
1031 lzo_blocks
[i
]->sync_bmp_nbits
= bmp_size
;
1032 /* alloc the working space for the compressed block */
1033 ret
= snd_soc_lzo_prepare(lzo_blocks
[i
]);
1038 blksize
= snd_soc_lzo_get_blksize(codec
);
1039 p
= codec
->reg_def_copy
;
1040 end
= codec
->reg_def_copy
+ codec
->reg_size
;
1041 /* compress the register map and fill the lzo blocks */
1042 for (i
= 0; i
< blkcount
; ++i
, p
+= blksize
) {
1043 lzo_blocks
[i
]->src
= p
;
1044 if (p
+ blksize
> end
)
1045 lzo_blocks
[i
]->src_len
= end
- p
;
1047 lzo_blocks
[i
]->src_len
= blksize
;
1048 ret
= snd_soc_lzo_compress_cache_block(codec
,
1052 lzo_blocks
[i
]->decompressed_size
=
1053 lzo_blocks
[i
]->src_len
;
1057 kfree(codec
->reg_def_copy
);
1058 codec
->reg_def_copy
= NULL
;
1062 snd_soc_cache_exit(codec
);
1065 kfree(codec
->reg_def_copy
);
1066 codec
->reg_def_copy
= NULL
;
1072 static int snd_soc_flat_cache_sync(struct snd_soc_codec
*codec
)
1076 const struct snd_soc_codec_driver
*codec_drv
;
1079 codec_drv
= codec
->driver
;
1080 for (i
= 0; i
< codec_drv
->reg_cache_size
; ++i
) {
1081 WARN_ON(codec
->writable_register
&&
1082 codec
->writable_register(codec
, i
));
1083 ret
= snd_soc_cache_read(codec
, i
, &val
);
1086 if (codec
->reg_def_copy
)
1087 if (snd_soc_get_cache_val(codec
->reg_def_copy
,
1088 i
, codec_drv
->reg_word_size
) == val
)
1090 ret
= snd_soc_write(codec
, i
, val
);
1093 dev_dbg(codec
->dev
, "Synced register %#x, value = %#x\n",
1099 static int snd_soc_flat_cache_write(struct snd_soc_codec
*codec
,
1100 unsigned int reg
, unsigned int value
)
1102 snd_soc_set_cache_val(codec
->reg_cache
, reg
, value
,
1103 codec
->driver
->reg_word_size
);
1107 static int snd_soc_flat_cache_read(struct snd_soc_codec
*codec
,
1108 unsigned int reg
, unsigned int *value
)
1110 *value
= snd_soc_get_cache_val(codec
->reg_cache
, reg
,
1111 codec
->driver
->reg_word_size
);
1115 static int snd_soc_flat_cache_exit(struct snd_soc_codec
*codec
)
1117 if (!codec
->reg_cache
)
1119 kfree(codec
->reg_cache
);
1120 codec
->reg_cache
= NULL
;
1124 static int snd_soc_flat_cache_init(struct snd_soc_codec
*codec
)
1126 const struct snd_soc_codec_driver
*codec_drv
;
1128 codec_drv
= codec
->driver
;
1130 if (codec
->reg_def_copy
)
1131 codec
->reg_cache
= kmemdup(codec
->reg_def_copy
,
1132 codec
->reg_size
, GFP_KERNEL
);
1134 codec
->reg_cache
= kzalloc(codec
->reg_size
, GFP_KERNEL
);
1135 if (!codec
->reg_cache
)
1141 /* an array of all supported compression types */
1142 static const struct snd_soc_cache_ops cache_types
[] = {
1143 /* Flat *must* be the first entry for fallback */
1145 .id
= SND_SOC_FLAT_COMPRESSION
,
1147 .init
= snd_soc_flat_cache_init
,
1148 .exit
= snd_soc_flat_cache_exit
,
1149 .read
= snd_soc_flat_cache_read
,
1150 .write
= snd_soc_flat_cache_write
,
1151 .sync
= snd_soc_flat_cache_sync
1153 #ifdef CONFIG_SND_SOC_CACHE_LZO
1155 .id
= SND_SOC_LZO_COMPRESSION
,
1157 .init
= snd_soc_lzo_cache_init
,
1158 .exit
= snd_soc_lzo_cache_exit
,
1159 .read
= snd_soc_lzo_cache_read
,
1160 .write
= snd_soc_lzo_cache_write
,
1161 .sync
= snd_soc_lzo_cache_sync
1165 .id
= SND_SOC_RBTREE_COMPRESSION
,
1167 .init
= snd_soc_rbtree_cache_init
,
1168 .exit
= snd_soc_rbtree_cache_exit
,
1169 .read
= snd_soc_rbtree_cache_read
,
1170 .write
= snd_soc_rbtree_cache_write
,
1171 .sync
= snd_soc_rbtree_cache_sync
1175 int snd_soc_cache_init(struct snd_soc_codec
*codec
)
1179 for (i
= 0; i
< ARRAY_SIZE(cache_types
); ++i
)
1180 if (cache_types
[i
].id
== codec
->compress_type
)
1183 /* Fall back to flat compression */
1184 if (i
== ARRAY_SIZE(cache_types
)) {
1185 dev_warn(codec
->dev
, "Could not match compress type: %d\n",
1186 codec
->compress_type
);
1190 mutex_init(&codec
->cache_rw_mutex
);
1191 codec
->cache_ops
= &cache_types
[i
];
1193 if (codec
->cache_ops
->init
) {
1194 if (codec
->cache_ops
->name
)
1195 dev_dbg(codec
->dev
, "Initializing %s cache for %s codec\n",
1196 codec
->cache_ops
->name
, codec
->name
);
1197 return codec
->cache_ops
->init(codec
);
1203 * NOTE: keep in mind that this function might be called
1206 int snd_soc_cache_exit(struct snd_soc_codec
*codec
)
1208 if (codec
->cache_ops
&& codec
->cache_ops
->exit
) {
1209 if (codec
->cache_ops
->name
)
1210 dev_dbg(codec
->dev
, "Destroying %s cache for %s codec\n",
1211 codec
->cache_ops
->name
, codec
->name
);
1212 return codec
->cache_ops
->exit(codec
);
1218 * snd_soc_cache_read: Fetch the value of a given register from the cache.
1220 * @codec: CODEC to configure.
1221 * @reg: The register index.
1222 * @value: The value to be returned.
1224 int snd_soc_cache_read(struct snd_soc_codec
*codec
,
1225 unsigned int reg
, unsigned int *value
)
1229 mutex_lock(&codec
->cache_rw_mutex
);
1231 if (value
&& codec
->cache_ops
&& codec
->cache_ops
->read
) {
1232 ret
= codec
->cache_ops
->read(codec
, reg
, value
);
1233 mutex_unlock(&codec
->cache_rw_mutex
);
1237 mutex_unlock(&codec
->cache_rw_mutex
);
1240 EXPORT_SYMBOL_GPL(snd_soc_cache_read
);
1243 * snd_soc_cache_write: Set the value of a given register in the cache.
1245 * @codec: CODEC to configure.
1246 * @reg: The register index.
1247 * @value: The new register value.
1249 int snd_soc_cache_write(struct snd_soc_codec
*codec
,
1250 unsigned int reg
, unsigned int value
)
1254 mutex_lock(&codec
->cache_rw_mutex
);
1256 if (codec
->cache_ops
&& codec
->cache_ops
->write
) {
1257 ret
= codec
->cache_ops
->write(codec
, reg
, value
);
1258 mutex_unlock(&codec
->cache_rw_mutex
);
1262 mutex_unlock(&codec
->cache_rw_mutex
);
1265 EXPORT_SYMBOL_GPL(snd_soc_cache_write
);
1268 * snd_soc_cache_sync: Sync the register cache with the hardware.
1270 * @codec: CODEC to configure.
1272 * Any registers that should not be synced should be marked as
1273 * volatile. In general drivers can choose not to use the provided
1274 * syncing functionality if they so require.
1276 int snd_soc_cache_sync(struct snd_soc_codec
*codec
)
1281 if (!codec
->cache_sync
) {
1285 if (!codec
->cache_ops
|| !codec
->cache_ops
->sync
)
1288 if (codec
->cache_ops
->name
)
1289 name
= codec
->cache_ops
->name
;
1293 if (codec
->cache_ops
->name
)
1294 dev_dbg(codec
->dev
, "Syncing %s cache for %s codec\n",
1295 codec
->cache_ops
->name
, codec
->name
);
1296 trace_snd_soc_cache_sync(codec
, name
, "start");
1297 ret
= codec
->cache_ops
->sync(codec
);
1299 codec
->cache_sync
= 0;
1300 trace_snd_soc_cache_sync(codec
, name
, "end");
1303 EXPORT_SYMBOL_GPL(snd_soc_cache_sync
);
1305 static int snd_soc_get_reg_access_index(struct snd_soc_codec
*codec
,
1308 const struct snd_soc_codec_driver
*codec_drv
;
1309 unsigned int min
, max
, index
;
1311 codec_drv
= codec
->driver
;
1313 max
= codec_drv
->reg_access_size
- 1;
1315 index
= (min
+ max
) / 2;
1316 if (codec_drv
->reg_access_default
[index
].reg
== reg
)
1318 if (codec_drv
->reg_access_default
[index
].reg
< reg
)
1322 } while (min
<= max
);
1326 int snd_soc_default_volatile_register(struct snd_soc_codec
*codec
,
1331 if (reg
>= codec
->driver
->reg_cache_size
)
1333 index
= snd_soc_get_reg_access_index(codec
, reg
);
1336 return codec
->driver
->reg_access_default
[index
].vol
;
1338 EXPORT_SYMBOL_GPL(snd_soc_default_volatile_register
);
1340 int snd_soc_default_readable_register(struct snd_soc_codec
*codec
,
1345 if (reg
>= codec
->driver
->reg_cache_size
)
1347 index
= snd_soc_get_reg_access_index(codec
, reg
);
1350 return codec
->driver
->reg_access_default
[index
].read
;
1352 EXPORT_SYMBOL_GPL(snd_soc_default_readable_register
);
1354 int snd_soc_default_writable_register(struct snd_soc_codec
*codec
,
1359 if (reg
>= codec
->driver
->reg_cache_size
)
1361 index
= snd_soc_get_reg_access_index(codec
, reg
);
1364 return codec
->driver
->reg_access_default
[index
].write
;
1366 EXPORT_SYMBOL_GPL(snd_soc_default_writable_register
);