xref: /openbmc/linux/sound/soc/codecs/hdmi-codec.c (revision 9b358af7)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * ALSA SoC codec for HDMI encoder drivers
4  * Copyright (C) 2015 Texas Instruments Incorporated - https://www.ti.com/
5  * Author: Jyri Sarha <jsarha@ti.com>
6  */
7 #include <linux/module.h>
8 #include <linux/string.h>
9 #include <sound/core.h>
10 #include <sound/jack.h>
11 #include <sound/pcm.h>
12 #include <sound/pcm_params.h>
13 #include <sound/soc.h>
14 #include <sound/tlv.h>
15 #include <sound/pcm_drm_eld.h>
16 #include <sound/hdmi-codec.h>
17 #include <sound/pcm_iec958.h>
18 
19 #include <drm/drm_crtc.h> /* This is only to get MAX_ELD_BYTES */
20 
21 #define HDMI_CODEC_CHMAP_IDX_UNKNOWN  -1
22 
23 struct hdmi_codec_channel_map_table {
24 	unsigned char map;	/* ALSA API channel map position */
25 };
26 
27 /*
28  * CEA speaker placement for HDMI 1.4:
29  *
30  *  FL  FLC   FC   FRC   FR   FRW
31  *
32  *                                  LFE
33  *
34  *  RL  RLC   RC   RRC   RR
35  *
36  *  Speaker placement has to be extended to support HDMI 2.0
37  */
38 enum hdmi_codec_cea_spk_placement {
39 	FL  = BIT(0),	/* Front Left           */
40 	FC  = BIT(1),	/* Front Center         */
41 	FR  = BIT(2),	/* Front Right          */
42 	FLC = BIT(3),	/* Front Left Center    */
43 	FRC = BIT(4),	/* Front Right Center   */
44 	RL  = BIT(5),	/* Rear Left            */
45 	RC  = BIT(6),	/* Rear Center          */
46 	RR  = BIT(7),	/* Rear Right           */
47 	RLC = BIT(8),	/* Rear Left Center     */
48 	RRC = BIT(9),	/* Rear Right Center    */
49 	LFE = BIT(10),	/* Low Frequency Effect */
50 };
51 
52 /*
53  * cea Speaker allocation structure
54  */
55 struct hdmi_codec_cea_spk_alloc {
56 	const int ca_id;
57 	unsigned int n_ch;
58 	unsigned long mask;
59 };
60 
61 /* Channel maps  stereo HDMI */
62 static const struct snd_pcm_chmap_elem hdmi_codec_stereo_chmaps[] = {
63 	{ .channels = 2,
64 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
65 	{ }
66 };
67 
68 /* Channel maps for multi-channel playbacks, up to 8 n_ch */
69 static const struct snd_pcm_chmap_elem hdmi_codec_8ch_chmaps[] = {
70 	{ .channels = 2, /* CA_ID 0x00 */
71 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
72 	{ .channels = 4, /* CA_ID 0x01 */
73 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
74 		   SNDRV_CHMAP_NA } },
75 	{ .channels = 4, /* CA_ID 0x02 */
76 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
77 		   SNDRV_CHMAP_FC } },
78 	{ .channels = 4, /* CA_ID 0x03 */
79 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
80 		   SNDRV_CHMAP_FC } },
81 	{ .channels = 6, /* CA_ID 0x04 */
82 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
83 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_RC, SNDRV_CHMAP_NA } },
84 	{ .channels = 6, /* CA_ID 0x05 */
85 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
86 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_RC, SNDRV_CHMAP_NA } },
87 	{ .channels = 6, /* CA_ID 0x06 */
88 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
89 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_RC, SNDRV_CHMAP_NA } },
90 	{ .channels = 6, /* CA_ID 0x07 */
91 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
92 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_RC, SNDRV_CHMAP_NA } },
93 	{ .channels = 6, /* CA_ID 0x08 */
94 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
95 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
96 	{ .channels = 6, /* CA_ID 0x09 */
97 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
98 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
99 	{ .channels = 6, /* CA_ID 0x0A */
100 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
101 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
102 	{ .channels = 6, /* CA_ID 0x0B */
103 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
104 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
105 	{ .channels = 8, /* CA_ID 0x0C */
106 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
107 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
108 		   SNDRV_CHMAP_RC, SNDRV_CHMAP_NA } },
109 	{ .channels = 8, /* CA_ID 0x0D */
110 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
111 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
112 		   SNDRV_CHMAP_RC, SNDRV_CHMAP_NA } },
113 	{ .channels = 8, /* CA_ID 0x0E */
114 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
115 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
116 		   SNDRV_CHMAP_RC, SNDRV_CHMAP_NA } },
117 	{ .channels = 8, /* CA_ID 0x0F */
118 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
119 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
120 		   SNDRV_CHMAP_RC, SNDRV_CHMAP_NA } },
121 	{ .channels = 8, /* CA_ID 0x10 */
122 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
123 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
124 		   SNDRV_CHMAP_RLC, SNDRV_CHMAP_RRC } },
125 	{ .channels = 8, /* CA_ID 0x11 */
126 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
127 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
128 		   SNDRV_CHMAP_RLC, SNDRV_CHMAP_RRC } },
129 	{ .channels = 8, /* CA_ID 0x12 */
130 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
131 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
132 		   SNDRV_CHMAP_RLC, SNDRV_CHMAP_RRC } },
133 	{ .channels = 8, /* CA_ID 0x13 */
134 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
135 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
136 		   SNDRV_CHMAP_RLC, SNDRV_CHMAP_RRC } },
137 	{ .channels = 8, /* CA_ID 0x14 */
138 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
139 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
140 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
141 	{ .channels = 8, /* CA_ID 0x15 */
142 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
143 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
144 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
145 	{ .channels = 8, /* CA_ID 0x16 */
146 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
147 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
148 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
149 	{ .channels = 8, /* CA_ID 0x17 */
150 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
151 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
152 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
153 	{ .channels = 8, /* CA_ID 0x18 */
154 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
155 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
156 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
157 	{ .channels = 8, /* CA_ID 0x19 */
158 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
159 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
160 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
161 	{ .channels = 8, /* CA_ID 0x1A */
162 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
163 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
164 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
165 	{ .channels = 8, /* CA_ID 0x1B */
166 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
167 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
168 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
169 	{ .channels = 8, /* CA_ID 0x1C */
170 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
171 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
172 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
173 	{ .channels = 8, /* CA_ID 0x1D */
174 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
175 		   SNDRV_CHMAP_NA, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
176 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
177 	{ .channels = 8, /* CA_ID 0x1E */
178 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
179 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
180 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
181 	{ .channels = 8, /* CA_ID 0x1F */
182 	  .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
183 		   SNDRV_CHMAP_FC, SNDRV_CHMAP_NA, SNDRV_CHMAP_NA,
184 		   SNDRV_CHMAP_FLC, SNDRV_CHMAP_FRC } },
185 	{ }
186 };
187 
188 /*
189  * hdmi_codec_channel_alloc: speaker configuration available for CEA
190  *
191  * This is an ordered list that must match with hdmi_codec_8ch_chmaps struct
192  * The preceding ones have better chances to be selected by
193  * hdmi_codec_get_ch_alloc_table_idx().
194  */
195 static const struct hdmi_codec_cea_spk_alloc hdmi_codec_channel_alloc[] = {
196 	{ .ca_id = 0x00, .n_ch = 2,
197 	  .mask = FL | FR},
198 	/* 2.1 */
199 	{ .ca_id = 0x01, .n_ch = 4,
200 	  .mask = FL | FR | LFE},
201 	/* Dolby Surround */
202 	{ .ca_id = 0x02, .n_ch = 4,
203 	  .mask = FL | FR | FC },
204 	/* surround51 */
205 	{ .ca_id = 0x0b, .n_ch = 6,
206 	  .mask = FL | FR | LFE | FC | RL | RR},
207 	/* surround40 */
208 	{ .ca_id = 0x08, .n_ch = 6,
209 	  .mask = FL | FR | RL | RR },
210 	/* surround41 */
211 	{ .ca_id = 0x09, .n_ch = 6,
212 	  .mask = FL | FR | LFE | RL | RR },
213 	/* surround50 */
214 	{ .ca_id = 0x0a, .n_ch = 6,
215 	  .mask = FL | FR | FC | RL | RR },
216 	/* 6.1 */
217 	{ .ca_id = 0x0f, .n_ch = 8,
218 	  .mask = FL | FR | LFE | FC | RL | RR | RC },
219 	/* surround71 */
220 	{ .ca_id = 0x13, .n_ch = 8,
221 	  .mask = FL | FR | LFE | FC | RL | RR | RLC | RRC },
222 	/* others */
223 	{ .ca_id = 0x03, .n_ch = 8,
224 	  .mask = FL | FR | LFE | FC },
225 	{ .ca_id = 0x04, .n_ch = 8,
226 	  .mask = FL | FR | RC},
227 	{ .ca_id = 0x05, .n_ch = 8,
228 	  .mask = FL | FR | LFE | RC },
229 	{ .ca_id = 0x06, .n_ch = 8,
230 	  .mask = FL | FR | FC | RC },
231 	{ .ca_id = 0x07, .n_ch = 8,
232 	  .mask = FL | FR | LFE | FC | RC },
233 	{ .ca_id = 0x0c, .n_ch = 8,
234 	  .mask = FL | FR | RC | RL | RR },
235 	{ .ca_id = 0x0d, .n_ch = 8,
236 	  .mask = FL | FR | LFE | RL | RR | RC },
237 	{ .ca_id = 0x0e, .n_ch = 8,
238 	  .mask = FL | FR | FC | RL | RR | RC },
239 	{ .ca_id = 0x10, .n_ch = 8,
240 	  .mask = FL | FR | RL | RR | RLC | RRC },
241 	{ .ca_id = 0x11, .n_ch = 8,
242 	  .mask = FL | FR | LFE | RL | RR | RLC | RRC },
243 	{ .ca_id = 0x12, .n_ch = 8,
244 	  .mask = FL | FR | FC | RL | RR | RLC | RRC },
245 	{ .ca_id = 0x14, .n_ch = 8,
246 	  .mask = FL | FR | FLC | FRC },
247 	{ .ca_id = 0x15, .n_ch = 8,
248 	  .mask = FL | FR | LFE | FLC | FRC },
249 	{ .ca_id = 0x16, .n_ch = 8,
250 	  .mask = FL | FR | FC | FLC | FRC },
251 	{ .ca_id = 0x17, .n_ch = 8,
252 	  .mask = FL | FR | LFE | FC | FLC | FRC },
253 	{ .ca_id = 0x18, .n_ch = 8,
254 	  .mask = FL | FR | RC | FLC | FRC },
255 	{ .ca_id = 0x19, .n_ch = 8,
256 	  .mask = FL | FR | LFE | RC | FLC | FRC },
257 	{ .ca_id = 0x1a, .n_ch = 8,
258 	  .mask = FL | FR | RC | FC | FLC | FRC },
259 	{ .ca_id = 0x1b, .n_ch = 8,
260 	  .mask = FL | FR | LFE | RC | FC | FLC | FRC },
261 	{ .ca_id = 0x1c, .n_ch = 8,
262 	  .mask = FL | FR | RL | RR | FLC | FRC },
263 	{ .ca_id = 0x1d, .n_ch = 8,
264 	  .mask = FL | FR | LFE | RL | RR | FLC | FRC },
265 	{ .ca_id = 0x1e, .n_ch = 8,
266 	  .mask = FL | FR | FC | RL | RR | FLC | FRC },
267 	{ .ca_id = 0x1f, .n_ch = 8,
268 	  .mask = FL | FR | LFE | FC | RL | RR | FLC | FRC },
269 };
270 
271 struct hdmi_codec_priv {
272 	struct hdmi_codec_pdata hcd;
273 	uint8_t eld[MAX_ELD_BYTES];
274 	struct snd_pcm_chmap *chmap_info;
275 	unsigned int chmap_idx;
276 	struct mutex lock;
277 	bool busy;
278 	struct snd_soc_jack *jack;
279 	unsigned int jack_status;
280 };
281 
282 static const struct snd_soc_dapm_widget hdmi_widgets[] = {
283 	SND_SOC_DAPM_OUTPUT("TX"),
284 	SND_SOC_DAPM_OUTPUT("RX"),
285 };
286 
287 enum {
288 	DAI_ID_I2S = 0,
289 	DAI_ID_SPDIF,
290 };
291 
292 static int hdmi_eld_ctl_info(struct snd_kcontrol *kcontrol,
293 			     struct snd_ctl_elem_info *uinfo)
294 {
295 	uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
296 	uinfo->count = sizeof_field(struct hdmi_codec_priv, eld);
297 
298 	return 0;
299 }
300 
301 static int hdmi_eld_ctl_get(struct snd_kcontrol *kcontrol,
302 			    struct snd_ctl_elem_value *ucontrol)
303 {
304 	struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
305 	struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
306 
307 	memcpy(ucontrol->value.bytes.data, hcp->eld, sizeof(hcp->eld));
308 
309 	return 0;
310 }
311 
312 static unsigned long hdmi_codec_spk_mask_from_alloc(int spk_alloc)
313 {
314 	int i;
315 	static const unsigned long hdmi_codec_eld_spk_alloc_bits[] = {
316 		[0] = FL | FR, [1] = LFE, [2] = FC, [3] = RL | RR,
317 		[4] = RC, [5] = FLC | FRC, [6] = RLC | RRC,
318 	};
319 	unsigned long spk_mask = 0;
320 
321 	for (i = 0; i < ARRAY_SIZE(hdmi_codec_eld_spk_alloc_bits); i++) {
322 		if (spk_alloc & (1 << i))
323 			spk_mask |= hdmi_codec_eld_spk_alloc_bits[i];
324 	}
325 
326 	return spk_mask;
327 }
328 
329 static void hdmi_codec_eld_chmap(struct hdmi_codec_priv *hcp)
330 {
331 	u8 spk_alloc;
332 	unsigned long spk_mask;
333 
334 	spk_alloc = drm_eld_get_spk_alloc(hcp->eld);
335 	spk_mask = hdmi_codec_spk_mask_from_alloc(spk_alloc);
336 
337 	/* Detect if only stereo supported, else return 8 channels mappings */
338 	if ((spk_mask & ~(FL | FR)) && hcp->chmap_info->max_channels > 2)
339 		hcp->chmap_info->chmap = hdmi_codec_8ch_chmaps;
340 	else
341 		hcp->chmap_info->chmap = hdmi_codec_stereo_chmaps;
342 }
343 
344 static int hdmi_codec_get_ch_alloc_table_idx(struct hdmi_codec_priv *hcp,
345 					     unsigned char channels)
346 {
347 	int i;
348 	u8 spk_alloc;
349 	unsigned long spk_mask;
350 	const struct hdmi_codec_cea_spk_alloc *cap = hdmi_codec_channel_alloc;
351 
352 	spk_alloc = drm_eld_get_spk_alloc(hcp->eld);
353 	spk_mask = hdmi_codec_spk_mask_from_alloc(spk_alloc);
354 
355 	for (i = 0; i < ARRAY_SIZE(hdmi_codec_channel_alloc); i++, cap++) {
356 		/* If spk_alloc == 0, HDMI is unplugged return stereo config*/
357 		if (!spk_alloc && cap->ca_id == 0)
358 			return i;
359 		if (cap->n_ch != channels)
360 			continue;
361 		if (!(cap->mask == (spk_mask & cap->mask)))
362 			continue;
363 		return i;
364 	}
365 
366 	return -EINVAL;
367 }
368 static int hdmi_codec_chmap_ctl_get(struct snd_kcontrol *kcontrol,
369 			      struct snd_ctl_elem_value *ucontrol)
370 {
371 	unsigned const char *map;
372 	unsigned int i;
373 	struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
374 	struct hdmi_codec_priv *hcp = info->private_data;
375 
376 	map = info->chmap[hcp->chmap_idx].map;
377 
378 	for (i = 0; i < info->max_channels; i++) {
379 		if (hcp->chmap_idx == HDMI_CODEC_CHMAP_IDX_UNKNOWN)
380 			ucontrol->value.integer.value[i] = 0;
381 		else
382 			ucontrol->value.integer.value[i] = map[i];
383 	}
384 
385 	return 0;
386 }
387 
388 static int hdmi_codec_startup(struct snd_pcm_substream *substream,
389 			      struct snd_soc_dai *dai)
390 {
391 	struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
392 	bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
393 	int ret = 0;
394 
395 	mutex_lock(&hcp->lock);
396 	if (hcp->busy) {
397 		dev_err(dai->dev, "Only one simultaneous stream supported!\n");
398 		mutex_unlock(&hcp->lock);
399 		return -EINVAL;
400 	}
401 
402 	if (hcp->hcd.ops->audio_startup) {
403 		ret = hcp->hcd.ops->audio_startup(dai->dev->parent, hcp->hcd.data);
404 		if (ret)
405 			goto err;
406 	}
407 
408 	if (tx && hcp->hcd.ops->get_eld) {
409 		ret = hcp->hcd.ops->get_eld(dai->dev->parent, hcp->hcd.data,
410 					    hcp->eld, sizeof(hcp->eld));
411 		if (ret)
412 			goto err;
413 
414 		ret = snd_pcm_hw_constraint_eld(substream->runtime, hcp->eld);
415 		if (ret)
416 			goto err;
417 
418 		/* Select chmap supported */
419 		hdmi_codec_eld_chmap(hcp);
420 	}
421 
422 	hcp->busy = true;
423 
424 err:
425 	mutex_unlock(&hcp->lock);
426 	return ret;
427 }
428 
429 static void hdmi_codec_shutdown(struct snd_pcm_substream *substream,
430 				struct snd_soc_dai *dai)
431 {
432 	struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
433 
434 	hcp->chmap_idx = HDMI_CODEC_CHMAP_IDX_UNKNOWN;
435 	hcp->hcd.ops->audio_shutdown(dai->dev->parent, hcp->hcd.data);
436 
437 	mutex_lock(&hcp->lock);
438 	hcp->busy = false;
439 	mutex_unlock(&hcp->lock);
440 }
441 
442 static int hdmi_codec_hw_params(struct snd_pcm_substream *substream,
443 				struct snd_pcm_hw_params *params,
444 				struct snd_soc_dai *dai)
445 {
446 	struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
447 	struct hdmi_codec_daifmt *cf = dai->playback_dma_data;
448 	struct hdmi_codec_params hp = {
449 		.iec = {
450 			.status = { 0 },
451 			.subcode = { 0 },
452 			.pad = 0,
453 			.dig_subframe = { 0 },
454 		}
455 	};
456 	int ret, idx;
457 
458 	dev_dbg(dai->dev, "%s() width %d rate %d channels %d\n", __func__,
459 		params_width(params), params_rate(params),
460 		params_channels(params));
461 
462 	ret = snd_pcm_create_iec958_consumer_hw_params(params, hp.iec.status,
463 						       sizeof(hp.iec.status));
464 	if (ret < 0) {
465 		dev_err(dai->dev, "Creating IEC958 channel status failed %d\n",
466 			ret);
467 		return ret;
468 	}
469 
470 	hdmi_audio_infoframe_init(&hp.cea);
471 	hp.cea.channels = params_channels(params);
472 	hp.cea.coding_type = HDMI_AUDIO_CODING_TYPE_STREAM;
473 	hp.cea.sample_size = HDMI_AUDIO_SAMPLE_SIZE_STREAM;
474 	hp.cea.sample_frequency = HDMI_AUDIO_SAMPLE_FREQUENCY_STREAM;
475 
476 	/* Select a channel allocation that matches with ELD and pcm channels */
477 	idx = hdmi_codec_get_ch_alloc_table_idx(hcp, hp.cea.channels);
478 	if (idx < 0) {
479 		dev_err(dai->dev, "Not able to map channels to speakers (%d)\n",
480 			idx);
481 		hcp->chmap_idx = HDMI_CODEC_CHMAP_IDX_UNKNOWN;
482 		return idx;
483 	}
484 	hp.cea.channel_allocation = hdmi_codec_channel_alloc[idx].ca_id;
485 	hcp->chmap_idx = hdmi_codec_channel_alloc[idx].ca_id;
486 
487 	hp.sample_width = params_width(params);
488 	hp.sample_rate = params_rate(params);
489 	hp.channels = params_channels(params);
490 
491 	cf->bit_fmt = params_format(params);
492 	return hcp->hcd.ops->hw_params(dai->dev->parent, hcp->hcd.data,
493 				       cf, &hp);
494 }
495 
496 static int hdmi_codec_i2s_set_fmt(struct snd_soc_dai *dai,
497 				  unsigned int fmt)
498 {
499 	struct hdmi_codec_daifmt *cf = dai->playback_dma_data;
500 
501 	/* Reset daifmt */
502 	memset(cf, 0, sizeof(*cf));
503 
504 	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
505 	case SND_SOC_DAIFMT_CBM_CFM:
506 		cf->bit_clk_master = 1;
507 		cf->frame_clk_master = 1;
508 		break;
509 	case SND_SOC_DAIFMT_CBS_CFM:
510 		cf->frame_clk_master = 1;
511 		break;
512 	case SND_SOC_DAIFMT_CBM_CFS:
513 		cf->bit_clk_master = 1;
514 		break;
515 	case SND_SOC_DAIFMT_CBS_CFS:
516 		break;
517 	default:
518 		return -EINVAL;
519 	}
520 
521 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
522 	case SND_SOC_DAIFMT_NB_NF:
523 		break;
524 	case SND_SOC_DAIFMT_NB_IF:
525 		cf->frame_clk_inv = 1;
526 		break;
527 	case SND_SOC_DAIFMT_IB_NF:
528 		cf->bit_clk_inv = 1;
529 		break;
530 	case SND_SOC_DAIFMT_IB_IF:
531 		cf->frame_clk_inv = 1;
532 		cf->bit_clk_inv = 1;
533 		break;
534 	}
535 
536 	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
537 	case SND_SOC_DAIFMT_I2S:
538 		cf->fmt = HDMI_I2S;
539 		break;
540 	case SND_SOC_DAIFMT_DSP_A:
541 		cf->fmt = HDMI_DSP_A;
542 		break;
543 	case SND_SOC_DAIFMT_DSP_B:
544 		cf->fmt = HDMI_DSP_B;
545 		break;
546 	case SND_SOC_DAIFMT_RIGHT_J:
547 		cf->fmt = HDMI_RIGHT_J;
548 		break;
549 	case SND_SOC_DAIFMT_LEFT_J:
550 		cf->fmt = HDMI_LEFT_J;
551 		break;
552 	case SND_SOC_DAIFMT_AC97:
553 		cf->fmt = HDMI_AC97;
554 		break;
555 	default:
556 		dev_err(dai->dev, "Invalid DAI interface format\n");
557 		return -EINVAL;
558 	}
559 
560 	return 0;
561 }
562 
563 static int hdmi_codec_mute(struct snd_soc_dai *dai, int mute, int direction)
564 {
565 	struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
566 
567 	/*
568 	 * ignore if direction was CAPTURE
569 	 * and it had .no_capture_mute flag
570 	 * see
571 	 *	snd_soc_dai_digital_mute()
572 	 */
573 	if (hcp->hcd.ops->mute_stream &&
574 	    (direction == SNDRV_PCM_STREAM_PLAYBACK ||
575 	     !hcp->hcd.ops->no_capture_mute))
576 		return hcp->hcd.ops->mute_stream(dai->dev->parent,
577 						 hcp->hcd.data,
578 						 mute, direction);
579 
580 	return -ENOTSUPP;
581 }
582 
583 static const struct snd_soc_dai_ops hdmi_codec_i2s_dai_ops = {
584 	.startup	= hdmi_codec_startup,
585 	.shutdown	= hdmi_codec_shutdown,
586 	.hw_params	= hdmi_codec_hw_params,
587 	.set_fmt	= hdmi_codec_i2s_set_fmt,
588 	.mute_stream	= hdmi_codec_mute,
589 };
590 
591 static const struct snd_soc_dai_ops hdmi_codec_spdif_dai_ops = {
592 	.startup	= hdmi_codec_startup,
593 	.shutdown	= hdmi_codec_shutdown,
594 	.hw_params	= hdmi_codec_hw_params,
595 	.mute_stream	= hdmi_codec_mute,
596 };
597 
598 #define HDMI_RATES	(SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
599 			 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
600 			 SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 |\
601 			 SNDRV_PCM_RATE_192000)
602 
603 #define SPDIF_FORMATS	(SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE |\
604 			 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE |\
605 			 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_3BE |\
606 			 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE)
607 
608 /*
609  * This list is only for formats allowed on the I2S bus. So there is
610  * some formats listed that are not supported by HDMI interface. For
611  * instance allowing the 32-bit formats enables 24-precision with CPU
612  * DAIs that do not support 24-bit formats. If the extra formats cause
613  * problems, we should add the video side driver an option to disable
614  * them.
615  */
616 #define I2S_FORMATS	(SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE |\
617 			 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE |\
618 			 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_3BE |\
619 			 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE |\
620 			 SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S32_BE |\
621 			 SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE)
622 
623 static int hdmi_codec_pcm_new(struct snd_soc_pcm_runtime *rtd,
624 			      struct snd_soc_dai *dai)
625 {
626 	struct snd_soc_dai_driver *drv = dai->driver;
627 	struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
628 	struct snd_kcontrol *kctl;
629 	struct snd_kcontrol_new hdmi_eld_ctl = {
630 		.access	= SNDRV_CTL_ELEM_ACCESS_READ |
631 			  SNDRV_CTL_ELEM_ACCESS_VOLATILE,
632 		.iface	= SNDRV_CTL_ELEM_IFACE_PCM,
633 		.name	= "ELD",
634 		.info	= hdmi_eld_ctl_info,
635 		.get	= hdmi_eld_ctl_get,
636 		.device	= rtd->pcm->device,
637 	};
638 	int ret;
639 
640 	ret =  snd_pcm_add_chmap_ctls(rtd->pcm, SNDRV_PCM_STREAM_PLAYBACK,
641 				      NULL, drv->playback.channels_max, 0,
642 				      &hcp->chmap_info);
643 	if (ret < 0)
644 		return ret;
645 
646 	/* override handlers */
647 	hcp->chmap_info->private_data = hcp;
648 	hcp->chmap_info->kctl->get = hdmi_codec_chmap_ctl_get;
649 
650 	/* default chmap supported is stereo */
651 	hcp->chmap_info->chmap = hdmi_codec_stereo_chmaps;
652 	hcp->chmap_idx = HDMI_CODEC_CHMAP_IDX_UNKNOWN;
653 
654 	/* add ELD ctl with the device number corresponding to the PCM stream */
655 	kctl = snd_ctl_new1(&hdmi_eld_ctl, dai->component);
656 	if (!kctl)
657 		return -ENOMEM;
658 
659 	return snd_ctl_add(rtd->card->snd_card, kctl);
660 }
661 
662 static int hdmi_dai_probe(struct snd_soc_dai *dai)
663 {
664 	struct snd_soc_dapm_context *dapm;
665 	struct hdmi_codec_daifmt *daifmt;
666 	struct snd_soc_dapm_route route[] = {
667 		{
668 			.sink = "TX",
669 			.source = dai->driver->playback.stream_name,
670 		},
671 		{
672 			.sink = dai->driver->capture.stream_name,
673 			.source = "RX",
674 		},
675 	};
676 	int ret;
677 
678 	dapm = snd_soc_component_get_dapm(dai->component);
679 	ret = snd_soc_dapm_add_routes(dapm, route, 2);
680 	if (ret)
681 		return ret;
682 
683 	daifmt = kzalloc(sizeof(*daifmt), GFP_KERNEL);
684 	if (!daifmt)
685 		return -ENOMEM;
686 
687 	dai->playback_dma_data = daifmt;
688 	return 0;
689 }
690 
691 static void hdmi_codec_jack_report(struct hdmi_codec_priv *hcp,
692 				   unsigned int jack_status)
693 {
694 	if (hcp->jack && jack_status != hcp->jack_status) {
695 		snd_soc_jack_report(hcp->jack, jack_status, SND_JACK_LINEOUT);
696 		hcp->jack_status = jack_status;
697 	}
698 }
699 
700 static void plugged_cb(struct device *dev, bool plugged)
701 {
702 	struct hdmi_codec_priv *hcp = dev_get_drvdata(dev);
703 
704 	if (plugged) {
705 		if (hcp->hcd.ops->get_eld) {
706 			hcp->hcd.ops->get_eld(dev->parent, hcp->hcd.data,
707 					    hcp->eld, sizeof(hcp->eld));
708 		}
709 		hdmi_codec_jack_report(hcp, SND_JACK_LINEOUT);
710 	} else {
711 		hdmi_codec_jack_report(hcp, 0);
712 		memset(hcp->eld, 0, sizeof(hcp->eld));
713 	}
714 }
715 
716 static int hdmi_codec_set_jack(struct snd_soc_component *component,
717 			       struct snd_soc_jack *jack,
718 			       void *data)
719 {
720 	struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
721 	int ret = -ENOTSUPP;
722 
723 	if (hcp->hcd.ops->hook_plugged_cb) {
724 		hcp->jack = jack;
725 		ret = hcp->hcd.ops->hook_plugged_cb(component->dev->parent,
726 						    hcp->hcd.data,
727 						    plugged_cb,
728 						    component->dev);
729 		if (ret)
730 			hcp->jack = NULL;
731 	}
732 	return ret;
733 }
734 
735 static int hdmi_dai_spdif_probe(struct snd_soc_dai *dai)
736 {
737 	struct hdmi_codec_daifmt *cf;
738 	int ret;
739 
740 	ret = hdmi_dai_probe(dai);
741 	if (ret)
742 		return ret;
743 
744 	cf = dai->playback_dma_data;
745 	cf->fmt = HDMI_SPDIF;
746 
747 	return 0;
748 }
749 
750 static int hdmi_codec_dai_remove(struct snd_soc_dai *dai)
751 {
752 	kfree(dai->playback_dma_data);
753 	return 0;
754 }
755 
756 static const struct snd_soc_dai_driver hdmi_i2s_dai = {
757 	.name = "i2s-hifi",
758 	.id = DAI_ID_I2S,
759 	.probe = hdmi_dai_probe,
760 	.remove = hdmi_codec_dai_remove,
761 	.playback = {
762 		.stream_name = "I2S Playback",
763 		.channels_min = 2,
764 		.channels_max = 8,
765 		.rates = HDMI_RATES,
766 		.formats = I2S_FORMATS,
767 		.sig_bits = 24,
768 	},
769 	.capture = {
770 		.stream_name = "Capture",
771 		.channels_min = 2,
772 		.channels_max = 8,
773 		.rates = HDMI_RATES,
774 		.formats = I2S_FORMATS,
775 		.sig_bits = 24,
776 	},
777 	.ops = &hdmi_codec_i2s_dai_ops,
778 	.pcm_new = hdmi_codec_pcm_new,
779 };
780 
781 static const struct snd_soc_dai_driver hdmi_spdif_dai = {
782 	.name = "spdif-hifi",
783 	.id = DAI_ID_SPDIF,
784 	.probe = hdmi_dai_spdif_probe,
785 	.remove = hdmi_codec_dai_remove,
786 	.playback = {
787 		.stream_name = "SPDIF Playback",
788 		.channels_min = 2,
789 		.channels_max = 2,
790 		.rates = HDMI_RATES,
791 		.formats = SPDIF_FORMATS,
792 	},
793 	.capture = {
794 		.stream_name = "Capture",
795 		.channels_min = 2,
796 		.channels_max = 2,
797 		.rates = HDMI_RATES,
798 		.formats = SPDIF_FORMATS,
799 	},
800 	.ops = &hdmi_codec_spdif_dai_ops,
801 	.pcm_new = hdmi_codec_pcm_new,
802 };
803 
804 static int hdmi_of_xlate_dai_id(struct snd_soc_component *component,
805 				 struct device_node *endpoint)
806 {
807 	struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
808 	int ret = -ENOTSUPP; /* see snd_soc_get_dai_id() */
809 
810 	if (hcp->hcd.ops->get_dai_id)
811 		ret = hcp->hcd.ops->get_dai_id(component, endpoint);
812 
813 	return ret;
814 }
815 
816 static void hdmi_remove(struct snd_soc_component *component)
817 {
818 	struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
819 
820 	if (hcp->hcd.ops->hook_plugged_cb)
821 		hcp->hcd.ops->hook_plugged_cb(component->dev->parent,
822 					      hcp->hcd.data, NULL, NULL);
823 }
824 
825 static const struct snd_soc_component_driver hdmi_driver = {
826 	.remove			= hdmi_remove,
827 	.dapm_widgets		= hdmi_widgets,
828 	.num_dapm_widgets	= ARRAY_SIZE(hdmi_widgets),
829 	.of_xlate_dai_id	= hdmi_of_xlate_dai_id,
830 	.idle_bias_on		= 1,
831 	.use_pmdown_time	= 1,
832 	.endianness		= 1,
833 	.non_legacy_dai_naming	= 1,
834 	.set_jack		= hdmi_codec_set_jack,
835 };
836 
837 static int hdmi_codec_probe(struct platform_device *pdev)
838 {
839 	struct hdmi_codec_pdata *hcd = pdev->dev.platform_data;
840 	struct snd_soc_dai_driver *daidrv;
841 	struct device *dev = &pdev->dev;
842 	struct hdmi_codec_priv *hcp;
843 	int dai_count, i = 0;
844 	int ret;
845 
846 	if (!hcd) {
847 		dev_err(dev, "%s: No platform data\n", __func__);
848 		return -EINVAL;
849 	}
850 
851 	dai_count = hcd->i2s + hcd->spdif;
852 	if (dai_count < 1 || !hcd->ops || !hcd->ops->hw_params ||
853 	    !hcd->ops->audio_shutdown) {
854 		dev_err(dev, "%s: Invalid parameters\n", __func__);
855 		return -EINVAL;
856 	}
857 
858 	hcp = devm_kzalloc(dev, sizeof(*hcp), GFP_KERNEL);
859 	if (!hcp)
860 		return -ENOMEM;
861 
862 	hcp->hcd = *hcd;
863 	mutex_init(&hcp->lock);
864 
865 	daidrv = devm_kcalloc(dev, dai_count, sizeof(*daidrv), GFP_KERNEL);
866 	if (!daidrv)
867 		return -ENOMEM;
868 
869 	if (hcd->i2s) {
870 		daidrv[i] = hdmi_i2s_dai;
871 		daidrv[i].playback.channels_max = hcd->max_i2s_channels;
872 		i++;
873 	}
874 
875 	if (hcd->spdif)
876 		daidrv[i] = hdmi_spdif_dai;
877 
878 	dev_set_drvdata(dev, hcp);
879 
880 	ret = devm_snd_soc_register_component(dev, &hdmi_driver, daidrv,
881 					      dai_count);
882 	if (ret) {
883 		dev_err(dev, "%s: snd_soc_register_component() failed (%d)\n",
884 			__func__, ret);
885 		return ret;
886 	}
887 	return 0;
888 }
889 
890 static struct platform_driver hdmi_codec_driver = {
891 	.driver = {
892 		.name = HDMI_CODEC_DRV_NAME,
893 	},
894 	.probe = hdmi_codec_probe,
895 };
896 
897 module_platform_driver(hdmi_codec_driver);
898 
899 MODULE_AUTHOR("Jyri Sarha <jsarha@ti.com>");
900 MODULE_DESCRIPTION("HDMI Audio Codec Driver");
901 MODULE_LICENSE("GPL");
902 MODULE_ALIAS("platform:" HDMI_CODEC_DRV_NAME);
903