xref: /openbmc/linux/sound/soc/codecs/tas5805m.c (revision b0a4c7f5)
1ec452684SDaniel Beer // SPDX-License-Identifier: GPL-2.0
2ec452684SDaniel Beer //
3ec452684SDaniel Beer // Driver for the TAS5805M Audio Amplifier
4ec452684SDaniel Beer //
5ec452684SDaniel Beer // Author: Andy Liu <andy-liu@ti.com>
6ec452684SDaniel Beer // Author: Daniel Beer <daniel.beer@igorinstitute.com>
7ec452684SDaniel Beer //
8ec452684SDaniel Beer // This is based on a driver originally written by Andy Liu at TI and
9ec452684SDaniel Beer // posted here:
10ec452684SDaniel Beer //
11ec452684SDaniel Beer //    https://e2e.ti.com/support/audio-group/audio/f/audio-forum/722027/linux-tas5825m-linux-drivers
12ec452684SDaniel Beer //
13ec452684SDaniel Beer // It has been simplified a little and reworked for the 5.x ALSA SoC API.
14ec452684SDaniel Beer 
15ec452684SDaniel Beer #include <linux/module.h>
16ec452684SDaniel Beer #include <linux/moduleparam.h>
17ec452684SDaniel Beer #include <linux/kernel.h>
18ec452684SDaniel Beer #include <linux/firmware.h>
19ec452684SDaniel Beer #include <linux/slab.h>
20ec452684SDaniel Beer #include <linux/of.h>
21ec452684SDaniel Beer #include <linux/init.h>
22ec452684SDaniel Beer #include <linux/i2c.h>
23ec452684SDaniel Beer #include <linux/regmap.h>
24ec452684SDaniel Beer #include <linux/gpio/consumer.h>
25ec452684SDaniel Beer #include <linux/regulator/consumer.h>
26ec452684SDaniel Beer #include <linux/atomic.h>
27ec452684SDaniel Beer #include <linux/workqueue.h>
28ec452684SDaniel Beer 
29ec452684SDaniel Beer #include <sound/soc.h>
30ec452684SDaniel Beer #include <sound/pcm.h>
31ec452684SDaniel Beer #include <sound/initval.h>
32ec452684SDaniel Beer 
33ec452684SDaniel Beer /* Datasheet-defined registers on page 0, book 0 */
34ec452684SDaniel Beer #define REG_PAGE		0x00
35ec452684SDaniel Beer #define REG_DEVICE_CTRL_1	0x02
36ec452684SDaniel Beer #define REG_DEVICE_CTRL_2	0x03
37ec452684SDaniel Beer #define REG_SIG_CH_CTRL		0x28
38ec452684SDaniel Beer #define REG_SAP_CTRL_1		0x33
39ec452684SDaniel Beer #define REG_FS_MON		0x37
40ec452684SDaniel Beer #define REG_BCK_MON		0x38
41ec452684SDaniel Beer #define REG_CLKDET_STATUS	0x39
42ec452684SDaniel Beer #define REG_VOL_CTL		0x4c
43ec452684SDaniel Beer #define REG_AGAIN		0x54
44ec452684SDaniel Beer #define REG_ADR_PIN_CTRL	0x60
45ec452684SDaniel Beer #define REG_ADR_PIN_CONFIG	0x61
46ec452684SDaniel Beer #define REG_CHAN_FAULT		0x70
47ec452684SDaniel Beer #define REG_GLOBAL_FAULT1	0x71
48ec452684SDaniel Beer #define REG_GLOBAL_FAULT2	0x72
49ec452684SDaniel Beer #define REG_FAULT		0x78
50ec452684SDaniel Beer #define REG_BOOK		0x7f
51ec452684SDaniel Beer 
52ec452684SDaniel Beer /* DEVICE_CTRL_2 register values */
53ec452684SDaniel Beer #define DCTRL2_MODE_DEEP_SLEEP	0x00
54ec452684SDaniel Beer #define DCTRL2_MODE_SLEEP	0x01
55ec452684SDaniel Beer #define DCTRL2_MODE_HIZ		0x02
56ec452684SDaniel Beer #define DCTRL2_MODE_PLAY	0x03
57ec452684SDaniel Beer 
58ec452684SDaniel Beer #define DCTRL2_MUTE		0x08
59ec452684SDaniel Beer #define DCTRL2_DIS_DSP		0x10
60ec452684SDaniel Beer 
61ec452684SDaniel Beer /* This sequence of register writes must always be sent, prior to the
62ec452684SDaniel Beer  * 5ms delay while we wait for the DSP to boot.
63ec452684SDaniel Beer  */
64ec452684SDaniel Beer static const uint8_t dsp_cfg_preboot[] = {
65ec452684SDaniel Beer 	0x00, 0x00, 0x7f, 0x00, 0x03, 0x02, 0x01, 0x11,
66ec452684SDaniel Beer 	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
67ec452684SDaniel Beer 	0x00, 0x00, 0x7f, 0x00, 0x03, 0x02,
68ec452684SDaniel Beer };
69ec452684SDaniel Beer 
70ec452684SDaniel Beer static const uint32_t tas5805m_volume[] = {
71ec452684SDaniel Beer 	0x0000001B, /*   0, -110dB */ 0x0000001E, /*   1, -109dB */
72ec452684SDaniel Beer 	0x00000021, /*   2, -108dB */ 0x00000025, /*   3, -107dB */
73ec452684SDaniel Beer 	0x0000002A, /*   4, -106dB */ 0x0000002F, /*   5, -105dB */
74ec452684SDaniel Beer 	0x00000035, /*   6, -104dB */ 0x0000003B, /*   7, -103dB */
75ec452684SDaniel Beer 	0x00000043, /*   8, -102dB */ 0x0000004B, /*   9, -101dB */
76ec452684SDaniel Beer 	0x00000054, /*  10, -100dB */ 0x0000005E, /*  11,  -99dB */
77ec452684SDaniel Beer 	0x0000006A, /*  12,  -98dB */ 0x00000076, /*  13,  -97dB */
78ec452684SDaniel Beer 	0x00000085, /*  14,  -96dB */ 0x00000095, /*  15,  -95dB */
79ec452684SDaniel Beer 	0x000000A7, /*  16,  -94dB */ 0x000000BC, /*  17,  -93dB */
80ec452684SDaniel Beer 	0x000000D3, /*  18,  -92dB */ 0x000000EC, /*  19,  -91dB */
81ec452684SDaniel Beer 	0x00000109, /*  20,  -90dB */ 0x0000012A, /*  21,  -89dB */
82ec452684SDaniel Beer 	0x0000014E, /*  22,  -88dB */ 0x00000177, /*  23,  -87dB */
83ec452684SDaniel Beer 	0x000001A4, /*  24,  -86dB */ 0x000001D8, /*  25,  -85dB */
84ec452684SDaniel Beer 	0x00000211, /*  26,  -84dB */ 0x00000252, /*  27,  -83dB */
85ec452684SDaniel Beer 	0x0000029A, /*  28,  -82dB */ 0x000002EC, /*  29,  -81dB */
86ec452684SDaniel Beer 	0x00000347, /*  30,  -80dB */ 0x000003AD, /*  31,  -79dB */
87ec452684SDaniel Beer 	0x00000420, /*  32,  -78dB */ 0x000004A1, /*  33,  -77dB */
88ec452684SDaniel Beer 	0x00000532, /*  34,  -76dB */ 0x000005D4, /*  35,  -75dB */
89ec452684SDaniel Beer 	0x0000068A, /*  36,  -74dB */ 0x00000756, /*  37,  -73dB */
90ec452684SDaniel Beer 	0x0000083B, /*  38,  -72dB */ 0x0000093C, /*  39,  -71dB */
91ec452684SDaniel Beer 	0x00000A5D, /*  40,  -70dB */ 0x00000BA0, /*  41,  -69dB */
92ec452684SDaniel Beer 	0x00000D0C, /*  42,  -68dB */ 0x00000EA3, /*  43,  -67dB */
93ec452684SDaniel Beer 	0x0000106C, /*  44,  -66dB */ 0x0000126D, /*  45,  -65dB */
94ec452684SDaniel Beer 	0x000014AD, /*  46,  -64dB */ 0x00001733, /*  47,  -63dB */
95ec452684SDaniel Beer 	0x00001A07, /*  48,  -62dB */ 0x00001D34, /*  49,  -61dB */
96ec452684SDaniel Beer 	0x000020C5, /*  50,  -60dB */ 0x000024C4, /*  51,  -59dB */
97ec452684SDaniel Beer 	0x00002941, /*  52,  -58dB */ 0x00002E49, /*  53,  -57dB */
98ec452684SDaniel Beer 	0x000033EF, /*  54,  -56dB */ 0x00003A45, /*  55,  -55dB */
99ec452684SDaniel Beer 	0x00004161, /*  56,  -54dB */ 0x0000495C, /*  57,  -53dB */
100ec452684SDaniel Beer 	0x0000524F, /*  58,  -52dB */ 0x00005C5A, /*  59,  -51dB */
101ec452684SDaniel Beer 	0x0000679F, /*  60,  -50dB */ 0x00007444, /*  61,  -49dB */
102ec452684SDaniel Beer 	0x00008274, /*  62,  -48dB */ 0x0000925F, /*  63,  -47dB */
103ec452684SDaniel Beer 	0x0000A43B, /*  64,  -46dB */ 0x0000B845, /*  65,  -45dB */
104ec452684SDaniel Beer 	0x0000CEC1, /*  66,  -44dB */ 0x0000E7FB, /*  67,  -43dB */
105ec452684SDaniel Beer 	0x00010449, /*  68,  -42dB */ 0x0001240C, /*  69,  -41dB */
106ec452684SDaniel Beer 	0x000147AE, /*  70,  -40dB */ 0x00016FAA, /*  71,  -39dB */
107ec452684SDaniel Beer 	0x00019C86, /*  72,  -38dB */ 0x0001CEDC, /*  73,  -37dB */
108ec452684SDaniel Beer 	0x00020756, /*  74,  -36dB */ 0x000246B5, /*  75,  -35dB */
109ec452684SDaniel Beer 	0x00028DCF, /*  76,  -34dB */ 0x0002DD96, /*  77,  -33dB */
110ec452684SDaniel Beer 	0x00033718, /*  78,  -32dB */ 0x00039B87, /*  79,  -31dB */
111ec452684SDaniel Beer 	0x00040C37, /*  80,  -30dB */ 0x00048AA7, /*  81,  -29dB */
112ec452684SDaniel Beer 	0x00051884, /*  82,  -28dB */ 0x0005B7B1, /*  83,  -27dB */
113ec452684SDaniel Beer 	0x00066A4A, /*  84,  -26dB */ 0x000732AE, /*  85,  -25dB */
114ec452684SDaniel Beer 	0x00081385, /*  86,  -24dB */ 0x00090FCC, /*  87,  -23dB */
115ec452684SDaniel Beer 	0x000A2ADB, /*  88,  -22dB */ 0x000B6873, /*  89,  -21dB */
116ec452684SDaniel Beer 	0x000CCCCD, /*  90,  -20dB */ 0x000E5CA1, /*  91,  -19dB */
117ec452684SDaniel Beer 	0x00101D3F, /*  92,  -18dB */ 0x0012149A, /*  93,  -17dB */
118ec452684SDaniel Beer 	0x00144961, /*  94,  -16dB */ 0x0016C311, /*  95,  -15dB */
119ec452684SDaniel Beer 	0x00198A13, /*  96,  -14dB */ 0x001CA7D7, /*  97,  -13dB */
120ec452684SDaniel Beer 	0x002026F3, /*  98,  -12dB */ 0x00241347, /*  99,  -11dB */
121ec452684SDaniel Beer 	0x00287A27, /* 100,  -10dB */ 0x002D6A86, /* 101,  -9dB */
122ec452684SDaniel Beer 	0x0032F52D, /* 102,   -8dB */ 0x00392CEE, /* 103,   -7dB */
123ec452684SDaniel Beer 	0x004026E7, /* 104,   -6dB */ 0x0047FACD, /* 105,   -5dB */
124ec452684SDaniel Beer 	0x0050C336, /* 106,   -4dB */ 0x005A9DF8, /* 107,   -3dB */
125ec452684SDaniel Beer 	0x0065AC8C, /* 108,   -2dB */ 0x00721483, /* 109,   -1dB */
126ec452684SDaniel Beer 	0x00800000, /* 110,    0dB */ 0x008F9E4D, /* 111,    1dB */
127ec452684SDaniel Beer 	0x00A12478, /* 112,    2dB */ 0x00B4CE08, /* 113,    3dB */
128ec452684SDaniel Beer 	0x00CADDC8, /* 114,    4dB */ 0x00E39EA9, /* 115,    5dB */
129ec452684SDaniel Beer 	0x00FF64C1, /* 116,    6dB */ 0x011E8E6A, /* 117,    7dB */
130ec452684SDaniel Beer 	0x0141857F, /* 118,    8dB */ 0x0168C0C6, /* 119,    9dB */
131ec452684SDaniel Beer 	0x0194C584, /* 120,   10dB */ 0x01C62940, /* 121,   11dB */
132ec452684SDaniel Beer 	0x01FD93C2, /* 122,   12dB */ 0x023BC148, /* 123,   13dB */
133ec452684SDaniel Beer 	0x02818508, /* 124,   14dB */ 0x02CFCC01, /* 125,   15dB */
134ec452684SDaniel Beer 	0x0327A01A, /* 126,   16dB */ 0x038A2BAD, /* 127,   17dB */
135ec452684SDaniel Beer 	0x03F8BD7A, /* 128,   18dB */ 0x0474CD1B, /* 129,   19dB */
136ec452684SDaniel Beer 	0x05000000, /* 130,   20dB */ 0x059C2F02, /* 131,   21dB */
137ec452684SDaniel Beer 	0x064B6CAE, /* 132,   22dB */ 0x07100C4D, /* 133,   23dB */
138ec452684SDaniel Beer 	0x07ECA9CD, /* 134,   24dB */ 0x08E43299, /* 135,   25dB */
139ec452684SDaniel Beer 	0x09F9EF8E, /* 136,   26dB */ 0x0B319025, /* 137,   27dB */
140ec452684SDaniel Beer 	0x0C8F36F2, /* 138,   28dB */ 0x0E1787B8, /* 139,   29dB */
141ec452684SDaniel Beer 	0x0FCFB725, /* 140,   30dB */ 0x11BD9C84, /* 141,   31dB */
142ec452684SDaniel Beer 	0x13E7C594, /* 142,   32dB */ 0x16558CCB, /* 143,   33dB */
143ec452684SDaniel Beer 	0x190F3254, /* 144,   34dB */ 0x1C1DF80E, /* 145,   35dB */
144ec452684SDaniel Beer 	0x1F8C4107, /* 146,   36dB */ 0x2365B4BF, /* 147,   37dB */
145ec452684SDaniel Beer 	0x27B766C2, /* 148,   38dB */ 0x2C900313, /* 149,   39dB */
146ec452684SDaniel Beer 	0x32000000, /* 150,   40dB */ 0x3819D612, /* 151,   41dB */
147ec452684SDaniel Beer 	0x3EF23ECA, /* 152,   42dB */ 0x46A07B07, /* 153,   43dB */
148ec452684SDaniel Beer 	0x4F3EA203, /* 154,   44dB */ 0x58E9F9F9, /* 155,   45dB */
149ec452684SDaniel Beer 	0x63C35B8E, /* 156,   46dB */ 0x6FEFA16D, /* 157,   47dB */
150ec452684SDaniel Beer 	0x7D982575, /* 158,   48dB */
151ec452684SDaniel Beer };
152ec452684SDaniel Beer 
153ec452684SDaniel Beer #define TAS5805M_VOLUME_MAX	((int)ARRAY_SIZE(tas5805m_volume) - 1)
154ec452684SDaniel Beer #define TAS5805M_VOLUME_MIN	0
155ec452684SDaniel Beer 
156ec452684SDaniel Beer struct tas5805m_priv {
15714732379SDaniel Beer 	struct i2c_client		*i2c;
158ec452684SDaniel Beer 	struct regulator		*pvdd;
159ec452684SDaniel Beer 	struct gpio_desc		*gpio_pdn_n;
160ec452684SDaniel Beer 
161ec452684SDaniel Beer 	uint8_t				*dsp_cfg_data;
162ec452684SDaniel Beer 	int				dsp_cfg_len;
163ec452684SDaniel Beer 
164ec452684SDaniel Beer 	struct regmap			*regmap;
165ec452684SDaniel Beer 
166ec452684SDaniel Beer 	int				vol[2];
167ec452684SDaniel Beer 	bool				is_powered;
168ec452684SDaniel Beer 	bool				is_muted;
16914732379SDaniel Beer 
17014732379SDaniel Beer 	struct work_struct		work;
17114732379SDaniel Beer 	struct mutex			lock;
172ec452684SDaniel Beer };
173ec452684SDaniel Beer 
set_dsp_scale(struct regmap * rm,int offset,int vol)174ec452684SDaniel Beer static void set_dsp_scale(struct regmap *rm, int offset, int vol)
175ec452684SDaniel Beer {
176ec452684SDaniel Beer 	uint8_t v[4];
177ec452684SDaniel Beer 	uint32_t x = tas5805m_volume[vol];
178ec452684SDaniel Beer 	int i;
179ec452684SDaniel Beer 
180ec452684SDaniel Beer 	for (i = 0; i < 4; i++) {
181ec452684SDaniel Beer 		v[3 - i] = x;
182ec452684SDaniel Beer 		x >>= 8;
183ec452684SDaniel Beer 	}
184ec452684SDaniel Beer 
185ec452684SDaniel Beer 	regmap_bulk_write(rm, offset, v, ARRAY_SIZE(v));
186ec452684SDaniel Beer }
187ec452684SDaniel Beer 
tas5805m_refresh(struct tas5805m_priv * tas5805m)18814732379SDaniel Beer static void tas5805m_refresh(struct tas5805m_priv *tas5805m)
189ec452684SDaniel Beer {
190ec452684SDaniel Beer 	struct regmap *rm = tas5805m->regmap;
191ec452684SDaniel Beer 
19214732379SDaniel Beer 	dev_dbg(&tas5805m->i2c->dev, "refresh: is_muted=%d, vol=%d/%d\n",
193ec452684SDaniel Beer 		tas5805m->is_muted, tas5805m->vol[0], tas5805m->vol[1]);
194ec452684SDaniel Beer 
195ec452684SDaniel Beer 	regmap_write(rm, REG_PAGE, 0x00);
196ec452684SDaniel Beer 	regmap_write(rm, REG_BOOK, 0x8c);
197ec452684SDaniel Beer 	regmap_write(rm, REG_PAGE, 0x2a);
198ec452684SDaniel Beer 
199ec452684SDaniel Beer 	/* Refresh volume. The actual volume control documented in the
200ec452684SDaniel Beer 	 * datasheet doesn't seem to work correctly. This is a pair of
201ec452684SDaniel Beer 	 * DSP registers which are *not* documented in the datasheet.
202ec452684SDaniel Beer 	 */
203ec452684SDaniel Beer 	set_dsp_scale(rm, 0x24, tas5805m->vol[0]);
204ec452684SDaniel Beer 	set_dsp_scale(rm, 0x28, tas5805m->vol[1]);
205ec452684SDaniel Beer 
206e0576cd6SDaniel Beer 	regmap_write(rm, REG_PAGE, 0x00);
207e0576cd6SDaniel Beer 	regmap_write(rm, REG_BOOK, 0x00);
208e0576cd6SDaniel Beer 
209ec452684SDaniel Beer 	/* Set/clear digital soft-mute */
210ec452684SDaniel Beer 	regmap_write(rm, REG_DEVICE_CTRL_2,
211ec452684SDaniel Beer 		(tas5805m->is_muted ? DCTRL2_MUTE : 0) |
212ec452684SDaniel Beer 		DCTRL2_MODE_PLAY);
213ec452684SDaniel Beer }
214ec452684SDaniel Beer 
tas5805m_vol_info(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_info * uinfo)215ec452684SDaniel Beer static int tas5805m_vol_info(struct snd_kcontrol *kcontrol,
216ec452684SDaniel Beer 			     struct snd_ctl_elem_info *uinfo)
217ec452684SDaniel Beer {
218ec452684SDaniel Beer 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
219ec452684SDaniel Beer 	uinfo->count = 2;
220ec452684SDaniel Beer 
221ec452684SDaniel Beer 	uinfo->value.integer.min = TAS5805M_VOLUME_MIN;
222ec452684SDaniel Beer 	uinfo->value.integer.max = TAS5805M_VOLUME_MAX;
223ec452684SDaniel Beer 	return 0;
224ec452684SDaniel Beer }
225ec452684SDaniel Beer 
tas5805m_vol_get(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)226ec452684SDaniel Beer static int tas5805m_vol_get(struct snd_kcontrol *kcontrol,
227ec452684SDaniel Beer 			    struct snd_ctl_elem_value *ucontrol)
228ec452684SDaniel Beer {
229ec452684SDaniel Beer 	struct snd_soc_component *component =
230ec452684SDaniel Beer 		snd_soc_kcontrol_component(kcontrol);
231ec452684SDaniel Beer 	struct tas5805m_priv *tas5805m =
232ec452684SDaniel Beer 		snd_soc_component_get_drvdata(component);
233ec452684SDaniel Beer 
23414732379SDaniel Beer 	mutex_lock(&tas5805m->lock);
235ec452684SDaniel Beer 	ucontrol->value.integer.value[0] = tas5805m->vol[0];
236ec452684SDaniel Beer 	ucontrol->value.integer.value[1] = tas5805m->vol[1];
23714732379SDaniel Beer 	mutex_unlock(&tas5805m->lock);
23814732379SDaniel Beer 
239ec452684SDaniel Beer 	return 0;
240ec452684SDaniel Beer }
241ec452684SDaniel Beer 
volume_is_valid(int v)242ec452684SDaniel Beer static inline int volume_is_valid(int v)
243ec452684SDaniel Beer {
244ec452684SDaniel Beer 	return (v >= TAS5805M_VOLUME_MIN) && (v <= TAS5805M_VOLUME_MAX);
245ec452684SDaniel Beer }
246ec452684SDaniel Beer 
tas5805m_vol_put(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)247ec452684SDaniel Beer static int tas5805m_vol_put(struct snd_kcontrol *kcontrol,
248ec452684SDaniel Beer 			    struct snd_ctl_elem_value *ucontrol)
249ec452684SDaniel Beer {
250ec452684SDaniel Beer 	struct snd_soc_component *component =
251ec452684SDaniel Beer 		snd_soc_kcontrol_component(kcontrol);
252ec452684SDaniel Beer 	struct tas5805m_priv *tas5805m =
253ec452684SDaniel Beer 		snd_soc_component_get_drvdata(component);
25414732379SDaniel Beer 	int ret = 0;
255ec452684SDaniel Beer 
256ec452684SDaniel Beer 	if (!(volume_is_valid(ucontrol->value.integer.value[0]) &&
257ec452684SDaniel Beer 	      volume_is_valid(ucontrol->value.integer.value[1])))
258ec452684SDaniel Beer 		return -EINVAL;
259ec452684SDaniel Beer 
26014732379SDaniel Beer 	mutex_lock(&tas5805m->lock);
261ec452684SDaniel Beer 	if (tas5805m->vol[0] != ucontrol->value.integer.value[0] ||
262ec452684SDaniel Beer 	    tas5805m->vol[1] != ucontrol->value.integer.value[1]) {
263ec452684SDaniel Beer 		tas5805m->vol[0] = ucontrol->value.integer.value[0];
264ec452684SDaniel Beer 		tas5805m->vol[1] = ucontrol->value.integer.value[1];
265ec452684SDaniel Beer 		dev_dbg(component->dev, "set vol=%d/%d (is_powered=%d)\n",
266ec452684SDaniel Beer 			tas5805m->vol[0], tas5805m->vol[1],
267ec452684SDaniel Beer 			tas5805m->is_powered);
268ec452684SDaniel Beer 		if (tas5805m->is_powered)
26914732379SDaniel Beer 			tas5805m_refresh(tas5805m);
27014732379SDaniel Beer 		ret = 1;
271ec452684SDaniel Beer 	}
27214732379SDaniel Beer 	mutex_unlock(&tas5805m->lock);
273ec452684SDaniel Beer 
27414732379SDaniel Beer 	return ret;
275ec452684SDaniel Beer }
276ec452684SDaniel Beer 
277ec452684SDaniel Beer static const struct snd_kcontrol_new tas5805m_snd_controls[] = {
278ec452684SDaniel Beer 	{
279ec452684SDaniel Beer 		.iface	= SNDRV_CTL_ELEM_IFACE_MIXER,
280ec452684SDaniel Beer 		.name	= "Master Playback Volume",
281ec452684SDaniel Beer 		.access	= SNDRV_CTL_ELEM_ACCESS_TLV_READ |
282ec452684SDaniel Beer 			  SNDRV_CTL_ELEM_ACCESS_READWRITE,
283ec452684SDaniel Beer 		.info	= tas5805m_vol_info,
284ec452684SDaniel Beer 		.get	= tas5805m_vol_get,
285ec452684SDaniel Beer 		.put	= tas5805m_vol_put,
286ec452684SDaniel Beer 	},
287ec452684SDaniel Beer };
288ec452684SDaniel Beer 
send_cfg(struct regmap * rm,const uint8_t * s,unsigned int len)289ec452684SDaniel Beer static void send_cfg(struct regmap *rm,
290ec452684SDaniel Beer 		     const uint8_t *s, unsigned int len)
291ec452684SDaniel Beer {
292ec452684SDaniel Beer 	unsigned int i;
293ec452684SDaniel Beer 
294ec452684SDaniel Beer 	for (i = 0; i + 1 < len; i += 2)
295ec452684SDaniel Beer 		regmap_write(rm, s[i], s[i + 1]);
296ec452684SDaniel Beer }
297ec452684SDaniel Beer 
298ec452684SDaniel Beer /* The TAS5805M DSP can't be configured until the I2S clock has been
299ec452684SDaniel Beer  * present and stable for 5ms, or else it won't boot and we get no
300ec452684SDaniel Beer  * sound.
301ec452684SDaniel Beer  */
tas5805m_trigger(struct snd_pcm_substream * substream,int cmd,struct snd_soc_dai * dai)302ec452684SDaniel Beer static int tas5805m_trigger(struct snd_pcm_substream *substream, int cmd,
303ec452684SDaniel Beer 			    struct snd_soc_dai *dai)
304ec452684SDaniel Beer {
305ec452684SDaniel Beer 	struct snd_soc_component *component = dai->component;
306ec452684SDaniel Beer 	struct tas5805m_priv *tas5805m =
307ec452684SDaniel Beer 		snd_soc_component_get_drvdata(component);
308ec452684SDaniel Beer 
309ec452684SDaniel Beer 	switch (cmd) {
310ec452684SDaniel Beer 	case SNDRV_PCM_TRIGGER_START:
311ec452684SDaniel Beer 	case SNDRV_PCM_TRIGGER_RESUME:
312ec452684SDaniel Beer 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
31314732379SDaniel Beer 		dev_dbg(component->dev, "clock start\n");
31414732379SDaniel Beer 		schedule_work(&tas5805m->work);
31514732379SDaniel Beer 		break;
316ec452684SDaniel Beer 
31714732379SDaniel Beer 	case SNDRV_PCM_TRIGGER_STOP:
31814732379SDaniel Beer 	case SNDRV_PCM_TRIGGER_SUSPEND:
31914732379SDaniel Beer 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
32014732379SDaniel Beer 		break;
32114732379SDaniel Beer 
32214732379SDaniel Beer 	default:
32314732379SDaniel Beer 		return -EINVAL;
32414732379SDaniel Beer 	}
32514732379SDaniel Beer 
32614732379SDaniel Beer 	return 0;
32714732379SDaniel Beer }
32814732379SDaniel Beer 
do_work(struct work_struct * work)32914732379SDaniel Beer static void do_work(struct work_struct *work)
33014732379SDaniel Beer {
33114732379SDaniel Beer 	struct tas5805m_priv *tas5805m =
33214732379SDaniel Beer 	       container_of(work, struct tas5805m_priv, work);
33314732379SDaniel Beer 	struct regmap *rm = tas5805m->regmap;
33414732379SDaniel Beer 
33514732379SDaniel Beer 	dev_dbg(&tas5805m->i2c->dev, "DSP startup\n");
33614732379SDaniel Beer 
33714732379SDaniel Beer 	mutex_lock(&tas5805m->lock);
338ec452684SDaniel Beer 	/* We mustn't issue any I2C transactions until the I2S
339ec452684SDaniel Beer 	 * clock is stable. Furthermore, we must allow a 5ms
340ec452684SDaniel Beer 	 * delay after the first set of register writes to
341ec452684SDaniel Beer 	 * allow the DSP to boot before configuring it.
342ec452684SDaniel Beer 	 */
343ec452684SDaniel Beer 	usleep_range(5000, 10000);
34414732379SDaniel Beer 	send_cfg(rm, dsp_cfg_preboot, ARRAY_SIZE(dsp_cfg_preboot));
345ec452684SDaniel Beer 	usleep_range(5000, 15000);
34614732379SDaniel Beer 	send_cfg(rm, tas5805m->dsp_cfg_data, tas5805m->dsp_cfg_len);
347ec452684SDaniel Beer 
348ec452684SDaniel Beer 	tas5805m->is_powered = true;
34914732379SDaniel Beer 	tas5805m_refresh(tas5805m);
35014732379SDaniel Beer 	mutex_unlock(&tas5805m->lock);
35114732379SDaniel Beer }
352ec452684SDaniel Beer 
tas5805m_dac_event(struct snd_soc_dapm_widget * w,struct snd_kcontrol * kcontrol,int event)35314732379SDaniel Beer static int tas5805m_dac_event(struct snd_soc_dapm_widget *w,
35414732379SDaniel Beer 			      struct snd_kcontrol *kcontrol, int event)
35514732379SDaniel Beer {
35614732379SDaniel Beer 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
35714732379SDaniel Beer 	struct tas5805m_priv *tas5805m =
35814732379SDaniel Beer 		snd_soc_component_get_drvdata(component);
35914732379SDaniel Beer 	struct regmap *rm = tas5805m->regmap;
36014732379SDaniel Beer 
36114732379SDaniel Beer 	if (event & SND_SOC_DAPM_PRE_PMD) {
36214732379SDaniel Beer 		unsigned int chan, global1, global2;
36314732379SDaniel Beer 
364ec452684SDaniel Beer 		dev_dbg(component->dev, "DSP shutdown\n");
36514732379SDaniel Beer 		cancel_work_sync(&tas5805m->work);
366ec452684SDaniel Beer 
36714732379SDaniel Beer 		mutex_lock(&tas5805m->lock);
36814732379SDaniel Beer 		if (tas5805m->is_powered) {
369ec452684SDaniel Beer 			tas5805m->is_powered = false;
370ec452684SDaniel Beer 
371ec452684SDaniel Beer 			regmap_write(rm, REG_PAGE, 0x00);
372ec452684SDaniel Beer 			regmap_write(rm, REG_BOOK, 0x00);
373ec452684SDaniel Beer 
374ec452684SDaniel Beer 			regmap_read(rm, REG_CHAN_FAULT, &chan);
375ec452684SDaniel Beer 			regmap_read(rm, REG_GLOBAL_FAULT1, &global1);
376ec452684SDaniel Beer 			regmap_read(rm, REG_GLOBAL_FAULT2, &global2);
377ec452684SDaniel Beer 
37814732379SDaniel Beer 			dev_dbg(component->dev, "fault regs: CHAN=%02x, "
37914732379SDaniel Beer 				"GLOBAL1=%02x, GLOBAL2=%02x\n",
380ec452684SDaniel Beer 				chan, global1, global2);
381ec452684SDaniel Beer 
382ec452684SDaniel Beer 			regmap_write(rm, REG_DEVICE_CTRL_2, DCTRL2_MODE_HIZ);
38314732379SDaniel Beer 		}
38414732379SDaniel Beer 		mutex_unlock(&tas5805m->lock);
385ec452684SDaniel Beer 	}
386ec452684SDaniel Beer 
387ec452684SDaniel Beer 	return 0;
388ec452684SDaniel Beer }
389ec452684SDaniel Beer 
390ec452684SDaniel Beer static const struct snd_soc_dapm_route tas5805m_audio_map[] = {
391ec452684SDaniel Beer 	{ "DAC", NULL, "DAC IN" },
392ec452684SDaniel Beer 	{ "OUT", NULL, "DAC" },
393ec452684SDaniel Beer };
394ec452684SDaniel Beer 
395ec452684SDaniel Beer static const struct snd_soc_dapm_widget tas5805m_dapm_widgets[] = {
396ec452684SDaniel Beer 	SND_SOC_DAPM_AIF_IN("DAC IN", "Playback", 0, SND_SOC_NOPM, 0, 0),
39714732379SDaniel Beer 	SND_SOC_DAPM_DAC_E("DAC", NULL, SND_SOC_NOPM, 0, 0,
39814732379SDaniel Beer 		tas5805m_dac_event, SND_SOC_DAPM_PRE_PMD),
399ec452684SDaniel Beer 	SND_SOC_DAPM_OUTPUT("OUT")
400ec452684SDaniel Beer };
401ec452684SDaniel Beer 
402ec452684SDaniel Beer static const struct snd_soc_component_driver soc_codec_dev_tas5805m = {
403ec452684SDaniel Beer 	.controls		= tas5805m_snd_controls,
404ec452684SDaniel Beer 	.num_controls		= ARRAY_SIZE(tas5805m_snd_controls),
405ec452684SDaniel Beer 	.dapm_widgets		= tas5805m_dapm_widgets,
406ec452684SDaniel Beer 	.num_dapm_widgets	= ARRAY_SIZE(tas5805m_dapm_widgets),
407ec452684SDaniel Beer 	.dapm_routes		= tas5805m_audio_map,
408ec452684SDaniel Beer 	.num_dapm_routes	= ARRAY_SIZE(tas5805m_audio_map),
409ec452684SDaniel Beer 	.use_pmdown_time	= 1,
410ec452684SDaniel Beer 	.endianness		= 1,
411ec452684SDaniel Beer };
412ec452684SDaniel Beer 
tas5805m_mute(struct snd_soc_dai * dai,int mute,int direction)413ec452684SDaniel Beer static int tas5805m_mute(struct snd_soc_dai *dai, int mute, int direction)
414ec452684SDaniel Beer {
415ec452684SDaniel Beer 	struct snd_soc_component *component = dai->component;
416ec452684SDaniel Beer 	struct tas5805m_priv *tas5805m =
417ec452684SDaniel Beer 		snd_soc_component_get_drvdata(component);
418ec452684SDaniel Beer 
41914732379SDaniel Beer 	mutex_lock(&tas5805m->lock);
420ec452684SDaniel Beer 	dev_dbg(component->dev, "set mute=%d (is_powered=%d)\n",
421ec452684SDaniel Beer 		mute, tas5805m->is_powered);
42214732379SDaniel Beer 
423ec452684SDaniel Beer 	tas5805m->is_muted = mute;
424ec452684SDaniel Beer 	if (tas5805m->is_powered)
42514732379SDaniel Beer 		tas5805m_refresh(tas5805m);
42614732379SDaniel Beer 	mutex_unlock(&tas5805m->lock);
427ec452684SDaniel Beer 
428ec452684SDaniel Beer 	return 0;
429ec452684SDaniel Beer }
430ec452684SDaniel Beer 
431ec452684SDaniel Beer static const struct snd_soc_dai_ops tas5805m_dai_ops = {
432ec452684SDaniel Beer 	.trigger		= tas5805m_trigger,
433ec452684SDaniel Beer 	.mute_stream		= tas5805m_mute,
434ec452684SDaniel Beer 	.no_capture_mute	= 1,
435ec452684SDaniel Beer };
436ec452684SDaniel Beer 
437ec452684SDaniel Beer static struct snd_soc_dai_driver tas5805m_dai = {
438ec452684SDaniel Beer 	.name		= "tas5805m-amplifier",
439ec452684SDaniel Beer 	.playback	= {
440ec452684SDaniel Beer 		.stream_name	= "Playback",
441ec452684SDaniel Beer 		.channels_min	= 2,
442ec452684SDaniel Beer 		.channels_max	= 2,
443ec452684SDaniel Beer 		.rates		= SNDRV_PCM_RATE_48000,
444ec452684SDaniel Beer 		.formats	= SNDRV_PCM_FMTBIT_S32_LE,
445ec452684SDaniel Beer 	},
446ec452684SDaniel Beer 	.ops		= &tas5805m_dai_ops,
447ec452684SDaniel Beer };
448ec452684SDaniel Beer 
449ec452684SDaniel Beer static const struct regmap_config tas5805m_regmap = {
450ec452684SDaniel Beer 	.reg_bits	= 8,
451ec452684SDaniel Beer 	.val_bits	= 8,
452ec452684SDaniel Beer 
453ec452684SDaniel Beer 	/* We have quite a lot of multi-level bank switching and a
454ec452684SDaniel Beer 	 * relatively small number of register writes between bank
455ec452684SDaniel Beer 	 * switches.
456ec452684SDaniel Beer 	 */
457ec452684SDaniel Beer 	.cache_type	= REGCACHE_NONE,
458ec452684SDaniel Beer };
459ec452684SDaniel Beer 
tas5805m_i2c_probe(struct i2c_client * i2c)460ec452684SDaniel Beer static int tas5805m_i2c_probe(struct i2c_client *i2c)
461ec452684SDaniel Beer {
462ec452684SDaniel Beer 	struct device *dev = &i2c->dev;
463ec452684SDaniel Beer 	struct regmap *regmap;
464ec452684SDaniel Beer 	struct tas5805m_priv *tas5805m;
465ec452684SDaniel Beer 	char filename[128];
466ec452684SDaniel Beer 	const char *config_name;
467ec452684SDaniel Beer 	const struct firmware *fw;
468ec452684SDaniel Beer 	int ret;
469ec452684SDaniel Beer 
470ec452684SDaniel Beer 	regmap = devm_regmap_init_i2c(i2c, &tas5805m_regmap);
471ec452684SDaniel Beer 	if (IS_ERR(regmap)) {
472ec452684SDaniel Beer 		ret = PTR_ERR(regmap);
473ec452684SDaniel Beer 		dev_err(dev, "unable to allocate register map: %d\n", ret);
474ec452684SDaniel Beer 		return ret;
475ec452684SDaniel Beer 	}
476ec452684SDaniel Beer 
477ec452684SDaniel Beer 	tas5805m = devm_kzalloc(dev, sizeof(struct tas5805m_priv), GFP_KERNEL);
478ec452684SDaniel Beer 	if (!tas5805m)
479ec452684SDaniel Beer 		return -ENOMEM;
480ec452684SDaniel Beer 
48114732379SDaniel Beer 	tas5805m->i2c = i2c;
482ec452684SDaniel Beer 	tas5805m->pvdd = devm_regulator_get(dev, "pvdd");
483ec452684SDaniel Beer 	if (IS_ERR(tas5805m->pvdd)) {
484ec452684SDaniel Beer 		dev_err(dev, "failed to get pvdd supply: %ld\n",
485ec452684SDaniel Beer 			PTR_ERR(tas5805m->pvdd));
486ec452684SDaniel Beer 		return PTR_ERR(tas5805m->pvdd);
487ec452684SDaniel Beer 	}
488ec452684SDaniel Beer 
489ec452684SDaniel Beer 	dev_set_drvdata(dev, tas5805m);
490ec452684SDaniel Beer 	tas5805m->regmap = regmap;
491ec452684SDaniel Beer 	tas5805m->gpio_pdn_n = devm_gpiod_get(dev, "pdn", GPIOD_OUT_LOW);
492ec452684SDaniel Beer 	if (IS_ERR(tas5805m->gpio_pdn_n)) {
493ec452684SDaniel Beer 		dev_err(dev, "error requesting PDN gpio: %ld\n",
494ec452684SDaniel Beer 			PTR_ERR(tas5805m->gpio_pdn_n));
495ec452684SDaniel Beer 		return PTR_ERR(tas5805m->gpio_pdn_n);
496ec452684SDaniel Beer 	}
497ec452684SDaniel Beer 
498ec452684SDaniel Beer 	/* This configuration must be generated by PPC3. The file loaded
499ec452684SDaniel Beer 	 * consists of a sequence of register writes, where bytes at
500ec452684SDaniel Beer 	 * even indices are register addresses and those at odd indices
501ec452684SDaniel Beer 	 * are register values.
502ec452684SDaniel Beer 	 *
503ec452684SDaniel Beer 	 * The fixed portion of PPC3's output prior to the 5ms delay
504ec452684SDaniel Beer 	 * should be omitted.
505ec452684SDaniel Beer 	 */
506ec452684SDaniel Beer 	if (device_property_read_string(dev, "ti,dsp-config-name",
507ec452684SDaniel Beer 					&config_name))
508ec452684SDaniel Beer 		config_name = "default";
509ec452684SDaniel Beer 
510ec452684SDaniel Beer 	snprintf(filename, sizeof(filename), "tas5805m_dsp_%s.bin",
511ec452684SDaniel Beer 		 config_name);
512ec452684SDaniel Beer 	ret = request_firmware(&fw, filename, dev);
513ec452684SDaniel Beer 	if (ret)
514ec452684SDaniel Beer 		return ret;
515ec452684SDaniel Beer 
516ec452684SDaniel Beer 	if ((fw->size < 2) || (fw->size & 1)) {
517ec452684SDaniel Beer 		dev_err(dev, "firmware is invalid\n");
518ec452684SDaniel Beer 		release_firmware(fw);
519ec452684SDaniel Beer 		return -EINVAL;
520ec452684SDaniel Beer 	}
521ec452684SDaniel Beer 
522ec452684SDaniel Beer 	tas5805m->dsp_cfg_len = fw->size;
523*b0a4c7f5SLi Zetao 	tas5805m->dsp_cfg_data = devm_kmemdup(dev, fw->data, fw->size, GFP_KERNEL);
524ec452684SDaniel Beer 	if (!tas5805m->dsp_cfg_data) {
525ec452684SDaniel Beer 		release_firmware(fw);
526ec452684SDaniel Beer 		return -ENOMEM;
527ec452684SDaniel Beer 	}
528ec452684SDaniel Beer 
529ec452684SDaniel Beer 	release_firmware(fw);
530ec452684SDaniel Beer 
531ec452684SDaniel Beer 	/* Do the first part of the power-on here, while we can expect
532ec452684SDaniel Beer 	 * the I2S interface to be quiet. We must raise PDN# and then
533ec452684SDaniel Beer 	 * wait 5ms before any I2S clock is sent, or else the internal
534ec452684SDaniel Beer 	 * regulator apparently won't come on.
535ec452684SDaniel Beer 	 *
536ec452684SDaniel Beer 	 * Also, we must keep the device in power down for 100ms or so
537ec452684SDaniel Beer 	 * after PVDD is applied, or else the ADR pin is sampled
538ec452684SDaniel Beer 	 * incorrectly and the device comes up with an unpredictable I2C
539ec452684SDaniel Beer 	 * address.
540ec452684SDaniel Beer 	 */
541ec452684SDaniel Beer 	tas5805m->vol[0] = TAS5805M_VOLUME_MIN;
542ec452684SDaniel Beer 	tas5805m->vol[1] = TAS5805M_VOLUME_MIN;
543ec452684SDaniel Beer 
544ec452684SDaniel Beer 	ret = regulator_enable(tas5805m->pvdd);
545ec452684SDaniel Beer 	if (ret < 0) {
546ec452684SDaniel Beer 		dev_err(dev, "failed to enable pvdd: %d\n", ret);
547ec452684SDaniel Beer 		return ret;
548ec452684SDaniel Beer 	}
549ec452684SDaniel Beer 
550ec452684SDaniel Beer 	usleep_range(100000, 150000);
551ec452684SDaniel Beer 	gpiod_set_value(tas5805m->gpio_pdn_n, 1);
552ec452684SDaniel Beer 	usleep_range(10000, 15000);
553ec452684SDaniel Beer 
55414732379SDaniel Beer 	INIT_WORK(&tas5805m->work, do_work);
55514732379SDaniel Beer 	mutex_init(&tas5805m->lock);
55614732379SDaniel Beer 
557ec452684SDaniel Beer 	/* Don't register through devm. We need to be able to unregister
558ec452684SDaniel Beer 	 * the component prior to deasserting PDN#
559ec452684SDaniel Beer 	 */
560ec452684SDaniel Beer 	ret = snd_soc_register_component(dev, &soc_codec_dev_tas5805m,
561ec452684SDaniel Beer 					 &tas5805m_dai, 1);
562ec452684SDaniel Beer 	if (ret < 0) {
563ec452684SDaniel Beer 		dev_err(dev, "unable to register codec: %d\n", ret);
564ec452684SDaniel Beer 		gpiod_set_value(tas5805m->gpio_pdn_n, 0);
565ec452684SDaniel Beer 		regulator_disable(tas5805m->pvdd);
566ec452684SDaniel Beer 		return ret;
567ec452684SDaniel Beer 	}
568ec452684SDaniel Beer 
569ec452684SDaniel Beer 	return 0;
570ec452684SDaniel Beer }
571ec452684SDaniel Beer 
tas5805m_i2c_remove(struct i2c_client * i2c)572ed5c2f5fSUwe Kleine-König static void tas5805m_i2c_remove(struct i2c_client *i2c)
573ec452684SDaniel Beer {
574ec452684SDaniel Beer 	struct device *dev = &i2c->dev;
575ec452684SDaniel Beer 	struct tas5805m_priv *tas5805m = dev_get_drvdata(dev);
576ec452684SDaniel Beer 
57714732379SDaniel Beer 	cancel_work_sync(&tas5805m->work);
578ec452684SDaniel Beer 	snd_soc_unregister_component(dev);
579ec452684SDaniel Beer 	gpiod_set_value(tas5805m->gpio_pdn_n, 0);
580ec452684SDaniel Beer 	usleep_range(10000, 15000);
581ec452684SDaniel Beer 	regulator_disable(tas5805m->pvdd);
582ec452684SDaniel Beer }
583ec452684SDaniel Beer 
584ec452684SDaniel Beer static const struct i2c_device_id tas5805m_i2c_id[] = {
585ec452684SDaniel Beer 	{ "tas5805m", },
586ec452684SDaniel Beer 	{ }
587ec452684SDaniel Beer };
588ec452684SDaniel Beer MODULE_DEVICE_TABLE(i2c, tas5805m_i2c_id);
589ec452684SDaniel Beer 
590ec452684SDaniel Beer #if IS_ENABLED(CONFIG_OF)
591ec452684SDaniel Beer static const struct of_device_id tas5805m_of_match[] = {
592ec452684SDaniel Beer 	{ .compatible = "ti,tas5805m", },
593ec452684SDaniel Beer 	{ }
594ec452684SDaniel Beer };
595ec452684SDaniel Beer MODULE_DEVICE_TABLE(of, tas5805m_of_match);
596ec452684SDaniel Beer #endif
597ec452684SDaniel Beer 
598ec452684SDaniel Beer static struct i2c_driver tas5805m_i2c_driver = {
5999abcd240SUwe Kleine-König 	.probe		= tas5805m_i2c_probe,
600ec452684SDaniel Beer 	.remove		= tas5805m_i2c_remove,
601ec452684SDaniel Beer 	.id_table	= tas5805m_i2c_id,
602ec452684SDaniel Beer 	.driver		= {
603ec452684SDaniel Beer 		.name		= "tas5805m",
604ec452684SDaniel Beer 		.of_match_table = of_match_ptr(tas5805m_of_match),
605ec452684SDaniel Beer 	},
606ec452684SDaniel Beer };
607ec452684SDaniel Beer 
608ec452684SDaniel Beer module_i2c_driver(tas5805m_i2c_driver);
609ec452684SDaniel Beer 
610ec452684SDaniel Beer MODULE_AUTHOR("Andy Liu <andy-liu@ti.com>");
611ec452684SDaniel Beer MODULE_AUTHOR("Daniel Beer <daniel.beer@igorinstitute.com>");
612ec452684SDaniel Beer MODULE_DESCRIPTION("TAS5805M Audio Amplifier Driver");
613ec452684SDaniel Beer MODULE_LICENSE("GPL v2");
614