blob: 29183ef2b93d2b950243149c6ffa1abcb56be69e [file] [log] [blame]
Mark Brown5bef44f2011-06-13 17:49:55 +01001/*
2 * soc-io.c -- ASoC register I/O helpers
3 *
4 * Copyright 2009-2011 Wolfson Microelectronics PLC.
5 *
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7 *
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.
12 */
13
14#include <linux/i2c.h>
15#include <linux/spi/spi.h>
Mark Brownbe3ea3b2011-06-13 19:35:29 +010016#include <linux/regmap.h>
Paul Gortmakerd81a6d72011-09-22 09:34:58 -040017#include <linux/export.h>
Mark Brown5bef44f2011-06-13 17:49:55 +010018#include <sound/soc.h>
19
20#include <trace/events/asoc.h>
21
Mark Brown4835ff92011-08-13 11:50:48 +090022#ifdef CONFIG_REGMAP
Mark Brownbe3ea3b2011-06-13 19:35:29 +010023static int hw_write(struct snd_soc_codec *codec, unsigned int reg,
24 unsigned int value)
Mark Brown5bef44f2011-06-13 17:49:55 +010025{
26 int ret;
27
28 if (!snd_soc_codec_volatile_register(codec, reg) &&
29 reg < codec->driver->reg_cache_size &&
30 !codec->cache_bypass) {
31 ret = snd_soc_cache_write(codec, reg, value);
32 if (ret < 0)
33 return -1;
34 }
35
36 if (codec->cache_only) {
37 codec->cache_sync = 1;
38 return 0;
39 }
40
Mark Brownbe3ea3b2011-06-13 19:35:29 +010041 return regmap_write(codec->control_data, reg, value);
Mark Brown5bef44f2011-06-13 17:49:55 +010042}
43
44static unsigned int hw_read(struct snd_soc_codec *codec, unsigned int reg)
45{
46 int ret;
47 unsigned int val;
48
49 if (reg >= codec->driver->reg_cache_size ||
50 snd_soc_codec_volatile_register(codec, reg) ||
51 codec->cache_bypass) {
52 if (codec->cache_only)
53 return -1;
54
Mark Brownbe3ea3b2011-06-13 19:35:29 +010055 ret = regmap_read(codec->control_data, reg, &val);
56 if (ret == 0)
57 return val;
58 else
Mark Brown3ebb5c92011-10-09 14:06:13 +010059 return -1;
Mark Brown5bef44f2011-06-13 17:49:55 +010060 }
61
62 ret = snd_soc_cache_read(codec, reg, &val);
63 if (ret < 0)
64 return -1;
65 return val;
66}
67
Mark Brown5bef44f2011-06-13 17:49:55 +010068/* Primitive bulk write support for soc-cache. The data pointed to by
Mark Brownbe3ea3b2011-06-13 19:35:29 +010069 * `data' needs to already be in the form the hardware expects. Any
70 * data written through this function will not go through the cache as
71 * it only handles writing to volatile or out of bounds registers.
72 *
73 * This is currently only supported for devices using the regmap API
74 * wrappers.
Mark Brown5bef44f2011-06-13 17:49:55 +010075 */
Mark Brownbe3ea3b2011-06-13 19:35:29 +010076static int snd_soc_hw_bulk_write_raw(struct snd_soc_codec *codec,
77 unsigned int reg,
Mark Brown5bef44f2011-06-13 17:49:55 +010078 const void *data, size_t len)
79{
Mark Brown5bef44f2011-06-13 17:49:55 +010080 /* To ensure that we don't get out of sync with the cache, check
81 * whether the base register is volatile or if we've directly asked
82 * to bypass the cache. Out of bounds registers are considered
83 * volatile.
84 */
85 if (!codec->cache_bypass
86 && !snd_soc_codec_volatile_register(codec, reg)
87 && reg < codec->driver->reg_cache_size)
88 return -EINVAL;
89
Mark Brownbe3ea3b2011-06-13 19:35:29 +010090 return regmap_raw_write(codec->control_data, reg, data, len);
Mark Brown5bef44f2011-06-13 17:49:55 +010091}
92
Mark Brown5bef44f2011-06-13 17:49:55 +010093/**
94 * snd_soc_codec_set_cache_io: Set up standard I/O functions.
95 *
96 * @codec: CODEC to configure.
97 * @addr_bits: Number of bits of register address data.
98 * @data_bits: Number of bits of data per register.
99 * @control: Control bus used.
100 *
101 * Register formats are frequently shared between many I2C and SPI
102 * devices. In order to promote code reuse the ASoC core provides
103 * some standard implementations of CODEC read and write operations
104 * which can be set up using this function.
105 *
106 * The caller is responsible for allocating and initialising the
107 * actual cache.
108 *
109 * Note that at present this code cannot be used by CODECs with
110 * volatile registers.
111 */
112int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
113 int addr_bits, int data_bits,
114 enum snd_soc_control_type control)
115{
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100116 struct regmap_config config;
Mark Brown2b4bdee2012-02-17 14:33:29 -0800117 int ret;
Mark Brown5bef44f2011-06-13 17:49:55 +0100118
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100119 memset(&config, 0, sizeof(config));
120 codec->write = hw_write;
Mark Brown5bef44f2011-06-13 17:49:55 +0100121 codec->read = hw_read;
122 codec->bulk_write_raw = snd_soc_hw_bulk_write_raw;
123
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100124 config.reg_bits = addr_bits;
125 config.val_bits = data_bits;
126
Mark Brown5bef44f2011-06-13 17:49:55 +0100127 switch (control) {
Stephen Warren81bca762011-08-11 11:59:11 -0600128#if defined(CONFIG_REGMAP_I2C) || defined(CONFIG_REGMAP_I2C_MODULE)
Mark Brown5bef44f2011-06-13 17:49:55 +0100129 case SND_SOC_I2C:
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100130 codec->control_data = regmap_init_i2c(to_i2c_client(codec->dev),
131 &config);
Mark Brown5bef44f2011-06-13 17:49:55 +0100132 break;
Axel Linf024d9a2011-08-10 16:24:12 +0800133#endif
Mark Brown5bef44f2011-06-13 17:49:55 +0100134
Stephen Warren81bca762011-08-11 11:59:11 -0600135#if defined(CONFIG_REGMAP_SPI) || defined(CONFIG_REGMAP_SPI_MODULE)
Mark Brown5bef44f2011-06-13 17:49:55 +0100136 case SND_SOC_SPI:
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100137 codec->control_data = regmap_init_spi(to_spi_device(codec->dev),
138 &config);
Mark Brown5bef44f2011-06-13 17:49:55 +0100139 break;
Axel Linf024d9a2011-08-10 16:24:12 +0800140#endif
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100141
Mark Brown0671da12011-07-24 12:23:37 +0100142 case SND_SOC_REGMAP:
143 /* Device has made its own regmap arrangements */
Mark Brown8a713da2011-12-03 12:33:55 +0000144 codec->using_regmap = true;
Mark Brown210cb672012-05-08 17:46:36 +0100145 if (!codec->control_data)
146 codec->control_data = dev_get_regmap(codec->dev, NULL);
Mark Brown2b4bdee2012-02-17 14:33:29 -0800147
Mark Brown9dfdd5a2012-06-22 12:40:52 +0100148 if (codec->control_data) {
149 ret = regmap_get_val_bytes(codec->control_data);
150 /* Errors are legitimate for non-integer byte
151 * multiples */
152 if (ret > 0)
153 codec->val_bytes = ret;
154 }
Mark Brown0671da12011-07-24 12:23:37 +0100155 break;
156
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100157 default:
158 return -EINVAL;
Mark Brown5bef44f2011-06-13 17:49:55 +0100159 }
160
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100161 if (IS_ERR(codec->control_data))
162 return PTR_ERR(codec->control_data);
163
Mark Brown5bef44f2011-06-13 17:49:55 +0100164 return 0;
165}
166EXPORT_SYMBOL_GPL(snd_soc_codec_set_cache_io);
Mark Brown4835ff92011-08-13 11:50:48 +0900167#else
168int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
169 int addr_bits, int data_bits,
170 enum snd_soc_control_type control)
171{
172 return -ENOTSUPP;
173}
174EXPORT_SYMBOL_GPL(snd_soc_codec_set_cache_io);
175#endif