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