1 // SPDX-License-Identifier: GPL-2.0-only
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>
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>
19 #include <drm/drm_crtc.h> /* This is only to get MAX_ELD_BYTES */
21 #define HDMI_CODEC_CHMAP_IDX_UNKNOWN -1
23 struct hdmi_codec_channel_map_table {
24 unsigned char map; /* ALSA API channel map position */
28 * CEA speaker placement for HDMI 1.4:
30 * FL FLC FC FRC FR FRW
36 * Speaker placement has to be extended to support HDMI 2.0
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 */
53 * cea Speaker allocation structure
55 struct hdmi_codec_cea_spk_alloc {
61 /* Channel maps stereo HDMI */
62 static const struct snd_pcm_chmap_elem hdmi_codec_stereo_chmaps[] = {
64 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
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,
75 { .channels = 4, /* CA_ID 0x02 */
76 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_NA,
78 { .channels = 4, /* CA_ID 0x03 */
79 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR, SNDRV_CHMAP_LFE,
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 } },
189 * hdmi_codec_channel_alloc: speaker configuration available for CEA
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().
195 static const struct hdmi_codec_cea_spk_alloc hdmi_codec_channel_alloc[] = {
196 { .ca_id = 0x00, .n_ch = 2,
199 { .ca_id = 0x01, .n_ch = 4,
200 .mask = FL | FR | LFE},
202 { .ca_id = 0x02, .n_ch = 4,
203 .mask = FL | FR | FC },
205 { .ca_id = 0x0b, .n_ch = 6,
206 .mask = FL | FR | LFE | FC | RL | RR},
208 { .ca_id = 0x08, .n_ch = 6,
209 .mask = FL | FR | RL | RR },
211 { .ca_id = 0x09, .n_ch = 6,
212 .mask = FL | FR | LFE | RL | RR },
214 { .ca_id = 0x0a, .n_ch = 6,
215 .mask = FL | FR | FC | RL | RR },
217 { .ca_id = 0x0f, .n_ch = 8,
218 .mask = FL | FR | LFE | FC | RL | RR | RC },
220 { .ca_id = 0x13, .n_ch = 8,
221 .mask = FL | FR | LFE | FC | RL | RR | RLC | RRC },
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 },
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;
278 struct snd_soc_jack *jack;
279 unsigned int jack_status;
280 u8 iec_status[AES_IEC958_STATUS_SIZE];
283 static const struct snd_soc_dapm_widget hdmi_widgets[] = {
284 SND_SOC_DAPM_OUTPUT("TX"),
285 SND_SOC_DAPM_OUTPUT("RX"),
293 static int hdmi_eld_ctl_info(struct snd_kcontrol *kcontrol,
294 struct snd_ctl_elem_info *uinfo)
296 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
297 uinfo->count = sizeof_field(struct hdmi_codec_priv, eld);
302 static int hdmi_eld_ctl_get(struct snd_kcontrol *kcontrol,
303 struct snd_ctl_elem_value *ucontrol)
305 struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
306 struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
308 memcpy(ucontrol->value.bytes.data, hcp->eld, sizeof(hcp->eld));
313 static unsigned long hdmi_codec_spk_mask_from_alloc(int spk_alloc)
316 static const unsigned long hdmi_codec_eld_spk_alloc_bits[] = {
317 [0] = FL | FR, [1] = LFE, [2] = FC, [3] = RL | RR,
318 [4] = RC, [5] = FLC | FRC, [6] = RLC | RRC,
320 unsigned long spk_mask = 0;
322 for (i = 0; i < ARRAY_SIZE(hdmi_codec_eld_spk_alloc_bits); i++) {
323 if (spk_alloc & (1 << i))
324 spk_mask |= hdmi_codec_eld_spk_alloc_bits[i];
330 static void hdmi_codec_eld_chmap(struct hdmi_codec_priv *hcp)
333 unsigned long spk_mask;
335 spk_alloc = drm_eld_get_spk_alloc(hcp->eld);
336 spk_mask = hdmi_codec_spk_mask_from_alloc(spk_alloc);
338 /* Detect if only stereo supported, else return 8 channels mappings */
339 if ((spk_mask & ~(FL | FR)) && hcp->chmap_info->max_channels > 2)
340 hcp->chmap_info->chmap = hdmi_codec_8ch_chmaps;
342 hcp->chmap_info->chmap = hdmi_codec_stereo_chmaps;
345 static int hdmi_codec_get_ch_alloc_table_idx(struct hdmi_codec_priv *hcp,
346 unsigned char channels)
350 unsigned long spk_mask;
351 const struct hdmi_codec_cea_spk_alloc *cap = hdmi_codec_channel_alloc;
353 spk_alloc = drm_eld_get_spk_alloc(hcp->eld);
354 spk_mask = hdmi_codec_spk_mask_from_alloc(spk_alloc);
356 for (i = 0; i < ARRAY_SIZE(hdmi_codec_channel_alloc); i++, cap++) {
357 /* If spk_alloc == 0, HDMI is unplugged return stereo config*/
358 if (!spk_alloc && cap->ca_id == 0)
360 if (cap->n_ch != channels)
362 if (!(cap->mask == (spk_mask & cap->mask)))
369 static int hdmi_codec_chmap_ctl_get(struct snd_kcontrol *kcontrol,
370 struct snd_ctl_elem_value *ucontrol)
372 unsigned const char *map;
374 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
375 struct hdmi_codec_priv *hcp = info->private_data;
377 map = info->chmap[hcp->chmap_idx].map;
379 for (i = 0; i < info->max_channels; i++) {
380 if (hcp->chmap_idx == HDMI_CODEC_CHMAP_IDX_UNKNOWN)
381 ucontrol->value.integer.value[i] = 0;
383 ucontrol->value.integer.value[i] = map[i];
389 static int hdmi_codec_iec958_info(struct snd_kcontrol *kcontrol,
390 struct snd_ctl_elem_info *uinfo)
392 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
397 static int hdmi_codec_iec958_default_get(struct snd_kcontrol *kcontrol,
398 struct snd_ctl_elem_value *ucontrol)
400 struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
401 struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
403 memcpy(ucontrol->value.iec958.status, hcp->iec_status,
404 sizeof(hcp->iec_status));
409 static int hdmi_codec_iec958_default_put(struct snd_kcontrol *kcontrol,
410 struct snd_ctl_elem_value *ucontrol)
412 struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
413 struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
415 memcpy(hcp->iec_status, ucontrol->value.iec958.status,
416 sizeof(hcp->iec_status));
421 static int hdmi_codec_iec958_mask_get(struct snd_kcontrol *kcontrol,
422 struct snd_ctl_elem_value *ucontrol)
424 memset(ucontrol->value.iec958.status, 0xff,
425 sizeof_field(struct hdmi_codec_priv, iec_status));
430 static int hdmi_codec_startup(struct snd_pcm_substream *substream,
431 struct snd_soc_dai *dai)
433 struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
434 bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
437 mutex_lock(&hcp->lock);
439 dev_err(dai->dev, "Only one simultaneous stream supported!\n");
440 mutex_unlock(&hcp->lock);
444 if (hcp->hcd.ops->audio_startup) {
445 ret = hcp->hcd.ops->audio_startup(dai->dev->parent, hcp->hcd.data);
450 if (tx && hcp->hcd.ops->get_eld) {
451 ret = hcp->hcd.ops->get_eld(dai->dev->parent, hcp->hcd.data,
452 hcp->eld, sizeof(hcp->eld));
456 ret = snd_pcm_hw_constraint_eld(substream->runtime, hcp->eld);
460 /* Select chmap supported */
461 hdmi_codec_eld_chmap(hcp);
467 mutex_unlock(&hcp->lock);
471 static void hdmi_codec_shutdown(struct snd_pcm_substream *substream,
472 struct snd_soc_dai *dai)
474 struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
476 hcp->chmap_idx = HDMI_CODEC_CHMAP_IDX_UNKNOWN;
477 hcp->hcd.ops->audio_shutdown(dai->dev->parent, hcp->hcd.data);
479 mutex_lock(&hcp->lock);
481 mutex_unlock(&hcp->lock);
484 static int hdmi_codec_fill_codec_params(struct snd_soc_dai *dai,
485 unsigned int sample_width,
486 unsigned int sample_rate,
487 unsigned int channels,
488 struct hdmi_codec_params *hp)
490 struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
493 /* Select a channel allocation that matches with ELD and pcm channels */
494 idx = hdmi_codec_get_ch_alloc_table_idx(hcp, channels);
496 dev_err(dai->dev, "Not able to map channels to speakers (%d)\n",
498 hcp->chmap_idx = HDMI_CODEC_CHMAP_IDX_UNKNOWN;
502 memset(hp, 0, sizeof(*hp));
504 hdmi_audio_infoframe_init(&hp->cea);
505 hp->cea.channels = channels;
506 hp->cea.coding_type = HDMI_AUDIO_CODING_TYPE_STREAM;
507 hp->cea.sample_size = HDMI_AUDIO_SAMPLE_SIZE_STREAM;
508 hp->cea.sample_frequency = HDMI_AUDIO_SAMPLE_FREQUENCY_STREAM;
509 hp->cea.channel_allocation = hdmi_codec_channel_alloc[idx].ca_id;
511 hp->sample_width = sample_width;
512 hp->sample_rate = sample_rate;
513 hp->channels = channels;
515 hcp->chmap_idx = hdmi_codec_channel_alloc[idx].ca_id;
520 static int hdmi_codec_hw_params(struct snd_pcm_substream *substream,
521 struct snd_pcm_hw_params *params,
522 struct snd_soc_dai *dai)
524 struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
525 struct hdmi_codec_daifmt *cf = dai->playback_dma_data;
526 struct hdmi_codec_params hp = {
531 .dig_subframe = { 0 },
536 if (!hcp->hcd.ops->hw_params)
539 dev_dbg(dai->dev, "%s() width %d rate %d channels %d\n", __func__,
540 params_width(params), params_rate(params),
541 params_channels(params));
543 ret = hdmi_codec_fill_codec_params(dai,
544 params_width(params),
546 params_channels(params),
551 memcpy(hp.iec.status, hcp->iec_status, sizeof(hp.iec.status));
552 ret = snd_pcm_fill_iec958_consumer_hw_params(params, hp.iec.status,
553 sizeof(hp.iec.status));
555 dev_err(dai->dev, "Creating IEC958 channel status failed %d\n",
560 cf->bit_fmt = params_format(params);
561 return hcp->hcd.ops->hw_params(dai->dev->parent, hcp->hcd.data,
565 static int hdmi_codec_prepare(struct snd_pcm_substream *substream,
566 struct snd_soc_dai *dai)
568 struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
569 struct hdmi_codec_daifmt *cf = dai->playback_dma_data;
570 struct snd_pcm_runtime *runtime = substream->runtime;
571 unsigned int channels = runtime->channels;
572 unsigned int width = snd_pcm_format_width(runtime->format);
573 unsigned int rate = runtime->rate;
574 struct hdmi_codec_params hp;
577 if (!hcp->hcd.ops->prepare)
580 dev_dbg(dai->dev, "%s() width %d rate %d channels %d\n", __func__,
581 width, rate, channels);
583 ret = hdmi_codec_fill_codec_params(dai, width, rate, channels, &hp);
587 memcpy(hp.iec.status, hcp->iec_status, sizeof(hp.iec.status));
588 ret = snd_pcm_fill_iec958_consumer(runtime, hp.iec.status,
589 sizeof(hp.iec.status));
591 dev_err(dai->dev, "Creating IEC958 channel status failed %d\n",
596 cf->bit_fmt = runtime->format;
597 return hcp->hcd.ops->prepare(dai->dev->parent, hcp->hcd.data,
601 static int hdmi_codec_i2s_set_fmt(struct snd_soc_dai *dai,
604 struct hdmi_codec_daifmt *cf = dai->playback_dma_data;
607 memset(cf, 0, sizeof(*cf));
609 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
610 case SND_SOC_DAIFMT_CBM_CFM:
611 cf->bit_clk_master = 1;
612 cf->frame_clk_master = 1;
614 case SND_SOC_DAIFMT_CBS_CFM:
615 cf->frame_clk_master = 1;
617 case SND_SOC_DAIFMT_CBM_CFS:
618 cf->bit_clk_master = 1;
620 case SND_SOC_DAIFMT_CBS_CFS:
626 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
627 case SND_SOC_DAIFMT_NB_NF:
629 case SND_SOC_DAIFMT_NB_IF:
630 cf->frame_clk_inv = 1;
632 case SND_SOC_DAIFMT_IB_NF:
635 case SND_SOC_DAIFMT_IB_IF:
636 cf->frame_clk_inv = 1;
641 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
642 case SND_SOC_DAIFMT_I2S:
645 case SND_SOC_DAIFMT_DSP_A:
646 cf->fmt = HDMI_DSP_A;
648 case SND_SOC_DAIFMT_DSP_B:
649 cf->fmt = HDMI_DSP_B;
651 case SND_SOC_DAIFMT_RIGHT_J:
652 cf->fmt = HDMI_RIGHT_J;
654 case SND_SOC_DAIFMT_LEFT_J:
655 cf->fmt = HDMI_LEFT_J;
657 case SND_SOC_DAIFMT_AC97:
661 dev_err(dai->dev, "Invalid DAI interface format\n");
668 static int hdmi_codec_mute(struct snd_soc_dai *dai, int mute, int direction)
670 struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
673 * ignore if direction was CAPTURE
674 * and it had .no_capture_mute flag
676 * snd_soc_dai_digital_mute()
678 if (hcp->hcd.ops->mute_stream &&
679 (direction == SNDRV_PCM_STREAM_PLAYBACK ||
680 !hcp->hcd.ops->no_capture_mute))
681 return hcp->hcd.ops->mute_stream(dai->dev->parent,
689 * This driver can select all SND_SOC_DAIFMT_CBx_CFx,
690 * but need to be selected from Sound Card, not be auto selected.
691 * Because it might be used from other driver.
693 * ${LINUX}/drivers/gpu/drm/bridge/synopsys/dw-hdmi-i2s-audio.c
695 static u64 hdmi_codec_formats =
696 SND_SOC_POSSIBLE_DAIFMT_NB_NF |
697 SND_SOC_POSSIBLE_DAIFMT_NB_IF |
698 SND_SOC_POSSIBLE_DAIFMT_IB_NF |
699 SND_SOC_POSSIBLE_DAIFMT_IB_IF |
700 SND_SOC_POSSIBLE_DAIFMT_I2S |
701 SND_SOC_POSSIBLE_DAIFMT_DSP_A |
702 SND_SOC_POSSIBLE_DAIFMT_DSP_B |
703 SND_SOC_POSSIBLE_DAIFMT_RIGHT_J |
704 SND_SOC_POSSIBLE_DAIFMT_LEFT_J |
705 SND_SOC_POSSIBLE_DAIFMT_AC97;
707 static const struct snd_soc_dai_ops hdmi_codec_i2s_dai_ops = {
708 .startup = hdmi_codec_startup,
709 .shutdown = hdmi_codec_shutdown,
710 .hw_params = hdmi_codec_hw_params,
711 .prepare = hdmi_codec_prepare,
712 .set_fmt = hdmi_codec_i2s_set_fmt,
713 .mute_stream = hdmi_codec_mute,
714 .auto_selectable_formats = &hdmi_codec_formats,
715 .num_auto_selectable_formats = 1,
718 static const struct snd_soc_dai_ops hdmi_codec_spdif_dai_ops = {
719 .startup = hdmi_codec_startup,
720 .shutdown = hdmi_codec_shutdown,
721 .hw_params = hdmi_codec_hw_params,
722 .mute_stream = hdmi_codec_mute,
725 #define HDMI_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
726 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
727 SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 |\
728 SNDRV_PCM_RATE_192000)
730 #define SPDIF_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE |\
731 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE |\
732 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_3BE |\
733 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE)
736 * This list is only for formats allowed on the I2S bus. So there is
737 * some formats listed that are not supported by HDMI interface. For
738 * instance allowing the 32-bit formats enables 24-precision with CPU
739 * DAIs that do not support 24-bit formats. If the extra formats cause
740 * problems, we should add the video side driver an option to disable
743 #define I2S_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE |\
744 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE |\
745 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_3BE |\
746 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE |\
747 SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S32_BE |\
748 SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE)
750 static struct snd_kcontrol_new hdmi_codec_controls[] = {
752 .access = SNDRV_CTL_ELEM_ACCESS_READ,
753 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
754 .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, MASK),
755 .info = hdmi_codec_iec958_info,
756 .get = hdmi_codec_iec958_mask_get,
759 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
760 .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, DEFAULT),
761 .info = hdmi_codec_iec958_info,
762 .get = hdmi_codec_iec958_default_get,
763 .put = hdmi_codec_iec958_default_put,
766 .access = (SNDRV_CTL_ELEM_ACCESS_READ |
767 SNDRV_CTL_ELEM_ACCESS_VOLATILE),
768 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
770 .info = hdmi_eld_ctl_info,
771 .get = hdmi_eld_ctl_get,
775 static int hdmi_codec_pcm_new(struct snd_soc_pcm_runtime *rtd,
776 struct snd_soc_dai *dai)
778 struct snd_soc_dai_driver *drv = dai->driver;
779 struct hdmi_codec_priv *hcp = snd_soc_dai_get_drvdata(dai);
783 ret = snd_pcm_add_chmap_ctls(rtd->pcm, SNDRV_PCM_STREAM_PLAYBACK,
784 NULL, drv->playback.channels_max, 0,
789 /* override handlers */
790 hcp->chmap_info->private_data = hcp;
791 hcp->chmap_info->kctl->get = hdmi_codec_chmap_ctl_get;
793 /* default chmap supported is stereo */
794 hcp->chmap_info->chmap = hdmi_codec_stereo_chmaps;
795 hcp->chmap_idx = HDMI_CODEC_CHMAP_IDX_UNKNOWN;
797 for (i = 0; i < ARRAY_SIZE(hdmi_codec_controls); i++) {
798 struct snd_kcontrol *kctl;
800 /* add ELD ctl with the device number corresponding to the PCM stream */
801 kctl = snd_ctl_new1(&hdmi_codec_controls[i], dai->component);
805 kctl->id.device = rtd->pcm->device;
806 ret = snd_ctl_add(rtd->card->snd_card, kctl);
814 static int hdmi_dai_probe(struct snd_soc_dai *dai)
816 struct snd_soc_dapm_context *dapm;
817 struct hdmi_codec_daifmt *daifmt;
818 struct snd_soc_dapm_route route[] = {
821 .source = dai->driver->playback.stream_name,
824 .sink = dai->driver->capture.stream_name,
830 dapm = snd_soc_component_get_dapm(dai->component);
831 ret = snd_soc_dapm_add_routes(dapm, route, 2);
835 daifmt = kzalloc(sizeof(*daifmt), GFP_KERNEL);
839 dai->playback_dma_data = daifmt;
843 static void hdmi_codec_jack_report(struct hdmi_codec_priv *hcp,
844 unsigned int jack_status)
846 if (hcp->jack && jack_status != hcp->jack_status) {
847 snd_soc_jack_report(hcp->jack, jack_status, SND_JACK_LINEOUT);
848 hcp->jack_status = jack_status;
852 static void plugged_cb(struct device *dev, bool plugged)
854 struct hdmi_codec_priv *hcp = dev_get_drvdata(dev);
857 if (hcp->hcd.ops->get_eld) {
858 hcp->hcd.ops->get_eld(dev->parent, hcp->hcd.data,
859 hcp->eld, sizeof(hcp->eld));
861 hdmi_codec_jack_report(hcp, SND_JACK_LINEOUT);
863 hdmi_codec_jack_report(hcp, 0);
864 memset(hcp->eld, 0, sizeof(hcp->eld));
868 static int hdmi_codec_set_jack(struct snd_soc_component *component,
869 struct snd_soc_jack *jack,
872 struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
875 if (hcp->hcd.ops->hook_plugged_cb) {
877 ret = hcp->hcd.ops->hook_plugged_cb(component->dev->parent,
887 static int hdmi_dai_spdif_probe(struct snd_soc_dai *dai)
889 struct hdmi_codec_daifmt *cf;
892 ret = hdmi_dai_probe(dai);
896 cf = dai->playback_dma_data;
897 cf->fmt = HDMI_SPDIF;
902 static int hdmi_codec_dai_remove(struct snd_soc_dai *dai)
904 kfree(dai->playback_dma_data);
908 static const struct snd_soc_dai_driver hdmi_i2s_dai = {
911 .probe = hdmi_dai_probe,
912 .remove = hdmi_codec_dai_remove,
914 .stream_name = "I2S Playback",
918 .formats = I2S_FORMATS,
922 .stream_name = "Capture",
926 .formats = I2S_FORMATS,
929 .ops = &hdmi_codec_i2s_dai_ops,
930 .pcm_new = hdmi_codec_pcm_new,
933 static const struct snd_soc_dai_driver hdmi_spdif_dai = {
934 .name = "spdif-hifi",
936 .probe = hdmi_dai_spdif_probe,
937 .remove = hdmi_codec_dai_remove,
939 .stream_name = "SPDIF Playback",
943 .formats = SPDIF_FORMATS,
946 .stream_name = "Capture",
950 .formats = SPDIF_FORMATS,
952 .ops = &hdmi_codec_spdif_dai_ops,
953 .pcm_new = hdmi_codec_pcm_new,
956 static int hdmi_of_xlate_dai_id(struct snd_soc_component *component,
957 struct device_node *endpoint)
959 struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
960 int ret = -ENOTSUPP; /* see snd_soc_get_dai_id() */
962 if (hcp->hcd.ops->get_dai_id)
963 ret = hcp->hcd.ops->get_dai_id(component, endpoint);
968 static void hdmi_remove(struct snd_soc_component *component)
970 struct hdmi_codec_priv *hcp = snd_soc_component_get_drvdata(component);
972 if (hcp->hcd.ops->hook_plugged_cb)
973 hcp->hcd.ops->hook_plugged_cb(component->dev->parent,
974 hcp->hcd.data, NULL, NULL);
977 static const struct snd_soc_component_driver hdmi_driver = {
978 .remove = hdmi_remove,
979 .dapm_widgets = hdmi_widgets,
980 .num_dapm_widgets = ARRAY_SIZE(hdmi_widgets),
981 .of_xlate_dai_id = hdmi_of_xlate_dai_id,
983 .use_pmdown_time = 1,
985 .non_legacy_dai_naming = 1,
986 .set_jack = hdmi_codec_set_jack,
989 static int hdmi_codec_probe(struct platform_device *pdev)
991 struct hdmi_codec_pdata *hcd = pdev->dev.platform_data;
992 struct snd_soc_dai_driver *daidrv;
993 struct device *dev = &pdev->dev;
994 struct hdmi_codec_priv *hcp;
995 int dai_count, i = 0;
999 dev_err(dev, "%s: No platform data\n", __func__);
1003 dai_count = hcd->i2s + hcd->spdif;
1004 if (dai_count < 1 || !hcd->ops ||
1005 (!hcd->ops->hw_params && !hcd->ops->prepare) ||
1006 !hcd->ops->audio_shutdown) {
1007 dev_err(dev, "%s: Invalid parameters\n", __func__);
1011 hcp = devm_kzalloc(dev, sizeof(*hcp), GFP_KERNEL);
1016 mutex_init(&hcp->lock);
1018 ret = snd_pcm_create_iec958_consumer_default(hcp->iec_status,
1019 sizeof(hcp->iec_status));
1023 daidrv = devm_kcalloc(dev, dai_count, sizeof(*daidrv), GFP_KERNEL);
1028 daidrv[i] = hdmi_i2s_dai;
1029 daidrv[i].playback.channels_max = hcd->max_i2s_channels;
1034 daidrv[i] = hdmi_spdif_dai;
1036 dev_set_drvdata(dev, hcp);
1038 ret = devm_snd_soc_register_component(dev, &hdmi_driver, daidrv,
1041 dev_err(dev, "%s: snd_soc_register_component() failed (%d)\n",
1048 static struct platform_driver hdmi_codec_driver = {
1050 .name = HDMI_CODEC_DRV_NAME,
1052 .probe = hdmi_codec_probe,
1055 module_platform_driver(hdmi_codec_driver);
1057 MODULE_AUTHOR("Jyri Sarha <jsarha@ti.com>");
1058 MODULE_DESCRIPTION("HDMI Audio Codec Driver");
1059 MODULE_LICENSE("GPL");
1060 MODULE_ALIAS("platform:" HDMI_CODEC_DRV_NAME);