1 // SPDX-License-Identifier: GPL-2.0-only
3 * intel_hdmi_audio.c - Intel HDMI audio driver
5 * Copyright (C) 2016 Intel Corp
6 * Authors: Sailaja Bandarupalli <sailaja.bandarupalli@intel.com>
7 * Ramesh Babu K V <ramesh.babu@intel.com>
8 * Vaibhav Agarwal <vaibhav.agarwal@intel.com>
9 * Jerome Anand <jerome.anand@intel.com>
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13 * ALSA driver for Intel HDMI audio
16 #include <linux/types.h>
17 #include <linux/platform_device.h>
19 #include <linux/slab.h>
20 #include <linux/module.h>
21 #include <linux/interrupt.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/dma-mapping.h>
24 #include <linux/delay.h>
25 #include <sound/core.h>
26 #include <sound/asoundef.h>
27 #include <sound/pcm.h>
28 #include <sound/pcm_params.h>
29 #include <sound/initval.h>
30 #include <sound/control.h>
31 #include <sound/jack.h>
32 #include <drm/drm_edid.h>
33 #include <drm/drm_eld.h>
34 #include <drm/intel_lpe_audio.h>
35 #include "intel_hdmi_audio.h"
37 #define INTEL_HDMI_AUDIO_SUSPEND_DELAY_MS 5000
39 #define for_each_pipe(card_ctx, pipe) \
40 for ((pipe) = 0; (pipe) < (card_ctx)->num_pipes; (pipe)++)
41 #define for_each_port(card_ctx, port) \
42 for ((port) = 0; (port) < (card_ctx)->num_ports; (port)++)
44 /*standard module options for ALSA. This module supports only one card*/
45 static int hdmi_card_index = SNDRV_DEFAULT_IDX1;
46 static char *hdmi_card_id = SNDRV_DEFAULT_STR1;
47 static bool single_port;
49 module_param_named(index, hdmi_card_index, int, 0444);
50 MODULE_PARM_DESC(index,
51 "Index value for INTEL Intel HDMI Audio controller.");
52 module_param_named(id, hdmi_card_id, charp, 0444);
54 "ID string for INTEL Intel HDMI Audio controller.");
55 module_param(single_port, bool, 0444);
56 MODULE_PARM_DESC(single_port,
57 "Single-port mode (for compatibility)");
60 * ELD SA bits in the CEA Speaker Allocation data block
62 static const int eld_speaker_allocation_bits[] = {
70 /* the following are not defined in ELD yet */
75 * This is an ordered list!
77 * The preceding ones have better chances to be selected by
78 * hdmi_channel_allocation().
80 static struct cea_channel_speaker_allocation channel_allocations[] = {
81 /* channel: 7 6 5 4 3 2 1 0 */
82 { .ca_index = 0x00, .speakers = { 0, 0, 0, 0, 0, 0, FR, FL } },
84 { .ca_index = 0x01, .speakers = { 0, 0, 0, 0, 0, LFE, FR, FL } },
86 { .ca_index = 0x02, .speakers = { 0, 0, 0, 0, FC, 0, FR, FL } },
88 { .ca_index = 0x08, .speakers = { 0, 0, RR, RL, 0, 0, FR, FL } },
90 { .ca_index = 0x09, .speakers = { 0, 0, RR, RL, 0, LFE, FR, FL } },
92 { .ca_index = 0x0a, .speakers = { 0, 0, RR, RL, FC, 0, FR, FL } },
94 { .ca_index = 0x0b, .speakers = { 0, 0, RR, RL, FC, LFE, FR, FL } },
96 { .ca_index = 0x0f, .speakers = { 0, RC, RR, RL, FC, LFE, FR, FL } },
98 { .ca_index = 0x13, .speakers = { RRC, RLC, RR, RL, FC, LFE, FR, FL } },
100 { .ca_index = 0x03, .speakers = { 0, 0, 0, 0, FC, LFE, FR, FL } },
101 { .ca_index = 0x04, .speakers = { 0, 0, 0, RC, 0, 0, FR, FL } },
102 { .ca_index = 0x05, .speakers = { 0, 0, 0, RC, 0, LFE, FR, FL } },
103 { .ca_index = 0x06, .speakers = { 0, 0, 0, RC, FC, 0, FR, FL } },
104 { .ca_index = 0x07, .speakers = { 0, 0, 0, RC, FC, LFE, FR, FL } },
105 { .ca_index = 0x0c, .speakers = { 0, RC, RR, RL, 0, 0, FR, FL } },
106 { .ca_index = 0x0d, .speakers = { 0, RC, RR, RL, 0, LFE, FR, FL } },
107 { .ca_index = 0x0e, .speakers = { 0, RC, RR, RL, FC, 0, FR, FL } },
108 { .ca_index = 0x10, .speakers = { RRC, RLC, RR, RL, 0, 0, FR, FL } },
109 { .ca_index = 0x11, .speakers = { RRC, RLC, RR, RL, 0, LFE, FR, FL } },
110 { .ca_index = 0x12, .speakers = { RRC, RLC, RR, RL, FC, 0, FR, FL } },
111 { .ca_index = 0x14, .speakers = { FRC, FLC, 0, 0, 0, 0, FR, FL } },
112 { .ca_index = 0x15, .speakers = { FRC, FLC, 0, 0, 0, LFE, FR, FL } },
113 { .ca_index = 0x16, .speakers = { FRC, FLC, 0, 0, FC, 0, FR, FL } },
114 { .ca_index = 0x17, .speakers = { FRC, FLC, 0, 0, FC, LFE, FR, FL } },
115 { .ca_index = 0x18, .speakers = { FRC, FLC, 0, RC, 0, 0, FR, FL } },
116 { .ca_index = 0x19, .speakers = { FRC, FLC, 0, RC, 0, LFE, FR, FL } },
117 { .ca_index = 0x1a, .speakers = { FRC, FLC, 0, RC, FC, 0, FR, FL } },
118 { .ca_index = 0x1b, .speakers = { FRC, FLC, 0, RC, FC, LFE, FR, FL } },
119 { .ca_index = 0x1c, .speakers = { FRC, FLC, RR, RL, 0, 0, FR, FL } },
120 { .ca_index = 0x1d, .speakers = { FRC, FLC, RR, RL, 0, LFE, FR, FL } },
121 { .ca_index = 0x1e, .speakers = { FRC, FLC, RR, RL, FC, 0, FR, FL } },
122 { .ca_index = 0x1f, .speakers = { FRC, FLC, RR, RL, FC, LFE, FR, FL } },
125 static const struct channel_map_table map_tables[] = {
126 { SNDRV_CHMAP_FL, 0x00, FL },
127 { SNDRV_CHMAP_FR, 0x01, FR },
128 { SNDRV_CHMAP_RL, 0x04, RL },
129 { SNDRV_CHMAP_RR, 0x05, RR },
130 { SNDRV_CHMAP_LFE, 0x02, LFE },
131 { SNDRV_CHMAP_FC, 0x03, FC },
132 { SNDRV_CHMAP_RLC, 0x06, RLC },
133 { SNDRV_CHMAP_RRC, 0x07, RRC },
137 /* hardware capability structure */
138 static const struct snd_pcm_hardware had_pcm_hardware = {
139 .info = (SNDRV_PCM_INFO_INTERLEAVED |
140 SNDRV_PCM_INFO_MMAP |
141 SNDRV_PCM_INFO_MMAP_VALID |
142 SNDRV_PCM_INFO_NO_PERIOD_WAKEUP),
143 .formats = (SNDRV_PCM_FMTBIT_S16_LE |
144 SNDRV_PCM_FMTBIT_S24_LE |
145 SNDRV_PCM_FMTBIT_S32_LE),
146 .rates = SNDRV_PCM_RATE_32000 |
147 SNDRV_PCM_RATE_44100 |
148 SNDRV_PCM_RATE_48000 |
149 SNDRV_PCM_RATE_88200 |
150 SNDRV_PCM_RATE_96000 |
151 SNDRV_PCM_RATE_176400 |
152 SNDRV_PCM_RATE_192000,
153 .rate_min = HAD_MIN_RATE,
154 .rate_max = HAD_MAX_RATE,
155 .channels_min = HAD_MIN_CHANNEL,
156 .channels_max = HAD_MAX_CHANNEL,
157 .buffer_bytes_max = HAD_MAX_BUFFER,
158 .period_bytes_min = HAD_MIN_PERIOD_BYTES,
159 .period_bytes_max = HAD_MAX_PERIOD_BYTES,
160 .periods_min = HAD_MIN_PERIODS,
161 .periods_max = HAD_MAX_PERIODS,
162 .fifo_size = HAD_FIFO_SIZE,
165 /* Get the active PCM substream;
166 * Call had_substream_put() for unreferecing.
167 * Don't call this inside had_spinlock, as it takes by itself
169 static struct snd_pcm_substream *
170 had_substream_get(struct snd_intelhad *intelhaddata)
172 struct snd_pcm_substream *substream;
175 spin_lock_irqsave(&intelhaddata->had_spinlock, flags);
176 substream = intelhaddata->stream_info.substream;
178 intelhaddata->stream_info.substream_refcount++;
179 spin_unlock_irqrestore(&intelhaddata->had_spinlock, flags);
183 /* Unref the active PCM substream;
184 * Don't call this inside had_spinlock, as it takes by itself
186 static void had_substream_put(struct snd_intelhad *intelhaddata)
190 spin_lock_irqsave(&intelhaddata->had_spinlock, flags);
191 intelhaddata->stream_info.substream_refcount--;
192 spin_unlock_irqrestore(&intelhaddata->had_spinlock, flags);
195 static u32 had_config_offset(int pipe)
200 return AUDIO_HDMI_CONFIG_A;
202 return AUDIO_HDMI_CONFIG_B;
204 return AUDIO_HDMI_CONFIG_C;
208 /* Register access functions */
209 static u32 had_read_register_raw(struct snd_intelhad_card *card_ctx,
212 return ioread32(card_ctx->mmio_start + had_config_offset(pipe) + reg);
215 static void had_write_register_raw(struct snd_intelhad_card *card_ctx,
216 int pipe, u32 reg, u32 val)
218 iowrite32(val, card_ctx->mmio_start + had_config_offset(pipe) + reg);
221 static void had_read_register(struct snd_intelhad *ctx, u32 reg, u32 *val)
226 *val = had_read_register_raw(ctx->card_ctx, ctx->pipe, reg);
229 static void had_write_register(struct snd_intelhad *ctx, u32 reg, u32 val)
232 had_write_register_raw(ctx->card_ctx, ctx->pipe, reg, val);
236 * enable / disable audio configuration
238 * The normal read/modify should not directly be used on VLV2 for
239 * updating AUD_CONFIG register.
241 * Bit6 of AUD_CONFIG register is writeonly due to a silicon bug on VLV2
242 * HDMI IP. As a result a read-modify of AUD_CONFIG register will always
243 * clear bit6. AUD_CONFIG[6:4] represents the "channels" field of the
244 * register. This field should be 1xy binary for configuration with 6 or
245 * more channels. Read-modify of AUD_CONFIG (Eg. for enabling audio)
246 * causes the "channels" field to be updated as 0xy binary resulting in
247 * bad audio. The fix is to always write the AUD_CONFIG[6:4] with
248 * appropriate value when doing read-modify of AUD_CONFIG register.
250 static void had_enable_audio(struct snd_intelhad *intelhaddata,
253 /* update the cached value */
254 intelhaddata->aud_config.regx.aud_en = enable;
255 had_write_register(intelhaddata, AUD_CONFIG,
256 intelhaddata->aud_config.regval);
259 /* forcibly ACKs to both BUFFER_DONE and BUFFER_UNDERRUN interrupts */
260 static void had_ack_irqs(struct snd_intelhad *ctx)
266 had_read_register(ctx, AUD_HDMI_STATUS, &status_reg);
267 status_reg |= HDMI_AUDIO_BUFFER_DONE | HDMI_AUDIO_UNDERRUN;
268 had_write_register(ctx, AUD_HDMI_STATUS, status_reg);
269 had_read_register(ctx, AUD_HDMI_STATUS, &status_reg);
272 /* Reset buffer pointers */
273 static void had_reset_audio(struct snd_intelhad *intelhaddata)
275 had_write_register(intelhaddata, AUD_HDMI_STATUS,
276 AUD_HDMI_STATUSG_MASK_FUNCRST);
277 had_write_register(intelhaddata, AUD_HDMI_STATUS, 0);
281 * initialize audio channel status registers
282 * This function is called in the prepare callback
284 static int had_prog_status_reg(struct snd_pcm_substream *substream,
285 struct snd_intelhad *intelhaddata)
287 union aud_ch_status_0 ch_stat0 = {.regval = 0};
288 union aud_ch_status_1 ch_stat1 = {.regval = 0};
290 ch_stat0.regx.lpcm_id = (intelhaddata->aes_bits &
291 IEC958_AES0_NONAUDIO) >> 1;
292 ch_stat0.regx.clk_acc = (intelhaddata->aes_bits &
293 IEC958_AES3_CON_CLOCK) >> 4;
295 switch (substream->runtime->rate) {
296 case AUD_SAMPLE_RATE_32:
297 ch_stat0.regx.samp_freq = CH_STATUS_MAP_32KHZ;
300 case AUD_SAMPLE_RATE_44_1:
301 ch_stat0.regx.samp_freq = CH_STATUS_MAP_44KHZ;
303 case AUD_SAMPLE_RATE_48:
304 ch_stat0.regx.samp_freq = CH_STATUS_MAP_48KHZ;
306 case AUD_SAMPLE_RATE_88_2:
307 ch_stat0.regx.samp_freq = CH_STATUS_MAP_88KHZ;
309 case AUD_SAMPLE_RATE_96:
310 ch_stat0.regx.samp_freq = CH_STATUS_MAP_96KHZ;
312 case AUD_SAMPLE_RATE_176_4:
313 ch_stat0.regx.samp_freq = CH_STATUS_MAP_176KHZ;
315 case AUD_SAMPLE_RATE_192:
316 ch_stat0.regx.samp_freq = CH_STATUS_MAP_192KHZ;
320 /* control should never come here */
324 had_write_register(intelhaddata,
325 AUD_CH_STATUS_0, ch_stat0.regval);
327 switch (substream->runtime->format) {
328 case SNDRV_PCM_FORMAT_S16_LE:
329 ch_stat1.regx.max_wrd_len = MAX_SMPL_WIDTH_20;
330 ch_stat1.regx.wrd_len = SMPL_WIDTH_16BITS;
332 case SNDRV_PCM_FORMAT_S24_LE:
333 case SNDRV_PCM_FORMAT_S32_LE:
334 ch_stat1.regx.max_wrd_len = MAX_SMPL_WIDTH_24;
335 ch_stat1.regx.wrd_len = SMPL_WIDTH_24BITS;
341 had_write_register(intelhaddata,
342 AUD_CH_STATUS_1, ch_stat1.regval);
347 * function to initialize audio
348 * registers and buffer configuration registers
349 * This function is called in the prepare callback
351 static int had_init_audio_ctrl(struct snd_pcm_substream *substream,
352 struct snd_intelhad *intelhaddata)
354 union aud_cfg cfg_val = {.regval = 0};
355 union aud_buf_config buf_cfg = {.regval = 0};
358 had_prog_status_reg(substream, intelhaddata);
360 buf_cfg.regx.audio_fifo_watermark = FIFO_THRESHOLD;
361 buf_cfg.regx.dma_fifo_watermark = DMA_FIFO_THRESHOLD;
362 buf_cfg.regx.aud_delay = 0;
363 had_write_register(intelhaddata, AUD_BUF_CONFIG, buf_cfg.regval);
365 channels = substream->runtime->channels;
366 cfg_val.regx.num_ch = channels - 2;
368 cfg_val.regx.layout = LAYOUT0;
370 cfg_val.regx.layout = LAYOUT1;
372 if (substream->runtime->format == SNDRV_PCM_FORMAT_S16_LE)
373 cfg_val.regx.packet_mode = 1;
375 if (substream->runtime->format == SNDRV_PCM_FORMAT_S32_LE)
376 cfg_val.regx.left_align = 1;
378 cfg_val.regx.val_bit = 1;
380 /* fix up the DP bits */
381 if (intelhaddata->dp_output) {
382 cfg_val.regx.dp_modei = 1;
383 cfg_val.regx.set = 1;
386 had_write_register(intelhaddata, AUD_CONFIG, cfg_val.regval);
387 intelhaddata->aud_config = cfg_val;
392 * Compute derived values in channel_allocations[].
394 static void init_channel_allocations(void)
397 struct cea_channel_speaker_allocation *p;
399 for (i = 0; i < ARRAY_SIZE(channel_allocations); i++) {
400 p = channel_allocations + i;
403 for (j = 0; j < ARRAY_SIZE(p->speakers); j++)
404 if (p->speakers[j]) {
406 p->spk_mask |= p->speakers[j];
412 * The transformation takes two steps:
414 * eld->spk_alloc => (eld_speaker_allocation_bits[]) => spk_mask
415 * spk_mask => (channel_allocations[]) => ai->CA
417 * TODO: it could select the wrong CA from multiple candidates.
419 static int had_channel_allocation(struct snd_intelhad *intelhaddata,
427 * CA defaults to 0 for basic stereo audio
433 * expand ELD's speaker allocation mask
435 * ELD tells the speaker mask in a compact(paired) form,
436 * expand ELD's notions to match the ones used by Audio InfoFrame.
439 for (i = 0; i < ARRAY_SIZE(eld_speaker_allocation_bits); i++) {
440 if (intelhaddata->eld[DRM_ELD_SPEAKER] & (1 << i))
441 spk_mask |= eld_speaker_allocation_bits[i];
444 /* search for the first working match in the CA table */
445 for (i = 0; i < ARRAY_SIZE(channel_allocations); i++) {
446 if (channels == channel_allocations[i].channels &&
447 (spk_mask & channel_allocations[i].spk_mask) ==
448 channel_allocations[i].spk_mask) {
449 ca = channel_allocations[i].ca_index;
454 dev_dbg(intelhaddata->dev, "select CA 0x%x for %d\n", ca, channels);
459 /* from speaker bit mask to ALSA API channel position */
460 static int spk_to_chmap(int spk)
462 const struct channel_map_table *t = map_tables;
464 for (; t->map; t++) {
465 if (t->spk_mask == spk)
471 static void had_build_channel_allocation_map(struct snd_intelhad *intelhaddata)
475 struct snd_pcm_chmap_elem *chmap;
476 u8 eld_high, eld_high_mask = 0xF0;
479 kfree(intelhaddata->chmap->chmap);
480 intelhaddata->chmap->chmap = NULL;
482 chmap = kzalloc(sizeof(*chmap), GFP_KERNEL);
486 dev_dbg(intelhaddata->dev, "eld speaker = %x\n",
487 intelhaddata->eld[DRM_ELD_SPEAKER]);
489 /* WA: Fix the max channel supported to 8 */
492 * Sink may support more than 8 channels, if eld_high has more than
493 * one bit set. SOC supports max 8 channels.
494 * Refer eld_speaker_allocation_bits, for sink speaker allocation
497 /* if 0x2F < eld < 0x4F fall back to 0x2f, else fall back to 0x4F */
498 eld_high = intelhaddata->eld[DRM_ELD_SPEAKER] & eld_high_mask;
499 if ((eld_high & (eld_high-1)) && (eld_high > 0x1F)) {
500 /* eld_high & (eld_high-1): if more than 1 bit set */
501 /* 0x1F: 7 channels */
502 for (i = 1; i < 4; i++) {
503 high_msb = eld_high & (0x80 >> i);
505 intelhaddata->eld[DRM_ELD_SPEAKER] &=
512 for (i = 0; i < ARRAY_SIZE(eld_speaker_allocation_bits); i++) {
513 if (intelhaddata->eld[DRM_ELD_SPEAKER] & (1 << i))
514 spk_mask |= eld_speaker_allocation_bits[i];
517 for (i = 0; i < ARRAY_SIZE(channel_allocations); i++) {
518 if (spk_mask == channel_allocations[i].spk_mask) {
519 for (c = 0; c < channel_allocations[i].channels; c++) {
520 chmap->map[c] = spk_to_chmap(
521 channel_allocations[i].speakers[
522 (MAX_SPEAKERS - 1) - c]);
524 chmap->channels = channel_allocations[i].channels;
525 intelhaddata->chmap->chmap = chmap;
529 if (i >= ARRAY_SIZE(channel_allocations))
534 * ALSA API channel-map control callbacks
536 static int had_chmap_ctl_info(struct snd_kcontrol *kcontrol,
537 struct snd_ctl_elem_info *uinfo)
539 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
540 uinfo->count = HAD_MAX_CHANNEL;
541 uinfo->value.integer.min = 0;
542 uinfo->value.integer.max = SNDRV_CHMAP_LAST;
546 static int had_chmap_ctl_get(struct snd_kcontrol *kcontrol,
547 struct snd_ctl_elem_value *ucontrol)
549 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
550 struct snd_intelhad *intelhaddata = info->private_data;
552 const struct snd_pcm_chmap_elem *chmap;
554 memset(ucontrol->value.integer.value, 0,
555 sizeof(long) * HAD_MAX_CHANNEL);
556 mutex_lock(&intelhaddata->mutex);
557 if (!intelhaddata->chmap->chmap) {
558 mutex_unlock(&intelhaddata->mutex);
562 chmap = intelhaddata->chmap->chmap;
563 for (i = 0; i < chmap->channels; i++)
564 ucontrol->value.integer.value[i] = chmap->map[i];
565 mutex_unlock(&intelhaddata->mutex);
570 static int had_register_chmap_ctls(struct snd_intelhad *intelhaddata,
575 err = snd_pcm_add_chmap_ctls(pcm, SNDRV_PCM_STREAM_PLAYBACK,
576 NULL, 0, (unsigned long)intelhaddata,
577 &intelhaddata->chmap);
581 intelhaddata->chmap->private_data = intelhaddata;
582 intelhaddata->chmap->kctl->info = had_chmap_ctl_info;
583 intelhaddata->chmap->kctl->get = had_chmap_ctl_get;
584 intelhaddata->chmap->chmap = NULL;
589 * Initialize Data Island Packets registers
590 * This function is called in the prepare callback
592 static void had_prog_dip(struct snd_pcm_substream *substream,
593 struct snd_intelhad *intelhaddata)
596 union aud_ctrl_st ctrl_state = {.regval = 0};
597 union aud_info_frame2 frame2 = {.regval = 0};
598 union aud_info_frame3 frame3 = {.regval = 0};
604 channels = substream->runtime->channels;
606 had_write_register(intelhaddata, AUD_CNTL_ST, ctrl_state.regval);
608 ca = had_channel_allocation(intelhaddata, channels);
609 if (intelhaddata->dp_output) {
610 info_frame = DP_INFO_FRAME_WORD1;
611 frame2.regval = (substream->runtime->channels - 1) | (ca << 24);
613 info_frame = HDMI_INFO_FRAME_WORD1;
614 frame2.regx.chnl_cnt = substream->runtime->channels - 1;
615 frame3.regx.chnl_alloc = ca;
617 /* Calculte the byte wide checksum for all valid DIP words */
618 for (i = 0; i < BYTES_PER_WORD; i++)
619 checksum += (info_frame >> (i * 8)) & 0xff;
620 for (i = 0; i < BYTES_PER_WORD; i++)
621 checksum += (frame2.regval >> (i * 8)) & 0xff;
622 for (i = 0; i < BYTES_PER_WORD; i++)
623 checksum += (frame3.regval >> (i * 8)) & 0xff;
625 frame2.regx.chksum = -(checksum);
628 had_write_register(intelhaddata, AUD_HDMIW_INFOFR, info_frame);
629 had_write_register(intelhaddata, AUD_HDMIW_INFOFR, frame2.regval);
630 had_write_register(intelhaddata, AUD_HDMIW_INFOFR, frame3.regval);
632 /* program remaining DIP words with zero */
633 for (i = 0; i < HAD_MAX_DIP_WORDS-VALID_DIP_WORDS; i++)
634 had_write_register(intelhaddata, AUD_HDMIW_INFOFR, 0x0);
636 ctrl_state.regx.dip_freq = 1;
637 ctrl_state.regx.dip_en_sta = 1;
638 had_write_register(intelhaddata, AUD_CNTL_ST, ctrl_state.regval);
641 static int had_calculate_maud_value(u32 aud_samp_freq, u32 link_rate)
645 /* Select maud according to DP 1.2 spec */
646 if (link_rate == DP_2_7_GHZ) {
647 switch (aud_samp_freq) {
648 case AUD_SAMPLE_RATE_32:
649 maud_val = AUD_SAMPLE_RATE_32_DP_2_7_MAUD_VAL;
652 case AUD_SAMPLE_RATE_44_1:
653 maud_val = AUD_SAMPLE_RATE_44_1_DP_2_7_MAUD_VAL;
656 case AUD_SAMPLE_RATE_48:
657 maud_val = AUD_SAMPLE_RATE_48_DP_2_7_MAUD_VAL;
660 case AUD_SAMPLE_RATE_88_2:
661 maud_val = AUD_SAMPLE_RATE_88_2_DP_2_7_MAUD_VAL;
664 case AUD_SAMPLE_RATE_96:
665 maud_val = AUD_SAMPLE_RATE_96_DP_2_7_MAUD_VAL;
668 case AUD_SAMPLE_RATE_176_4:
669 maud_val = AUD_SAMPLE_RATE_176_4_DP_2_7_MAUD_VAL;
673 maud_val = HAD_MAX_RATE_DP_2_7_MAUD_VAL;
680 } else if (link_rate == DP_1_62_GHZ) {
681 switch (aud_samp_freq) {
682 case AUD_SAMPLE_RATE_32:
683 maud_val = AUD_SAMPLE_RATE_32_DP_1_62_MAUD_VAL;
686 case AUD_SAMPLE_RATE_44_1:
687 maud_val = AUD_SAMPLE_RATE_44_1_DP_1_62_MAUD_VAL;
690 case AUD_SAMPLE_RATE_48:
691 maud_val = AUD_SAMPLE_RATE_48_DP_1_62_MAUD_VAL;
694 case AUD_SAMPLE_RATE_88_2:
695 maud_val = AUD_SAMPLE_RATE_88_2_DP_1_62_MAUD_VAL;
698 case AUD_SAMPLE_RATE_96:
699 maud_val = AUD_SAMPLE_RATE_96_DP_1_62_MAUD_VAL;
702 case AUD_SAMPLE_RATE_176_4:
703 maud_val = AUD_SAMPLE_RATE_176_4_DP_1_62_MAUD_VAL;
707 maud_val = HAD_MAX_RATE_DP_1_62_MAUD_VAL;
721 * Program HDMI audio CTS value
723 * @aud_samp_freq: sampling frequency of audio data
724 * @tmds: sampling frequency of the display data
725 * @link_rate: DP link rate
726 * @n_param: N value, depends on aud_samp_freq
727 * @intelhaddata: substream private data
729 * Program CTS register based on the audio and display sampling frequency
731 static void had_prog_cts(u32 aud_samp_freq, u32 tmds, u32 link_rate,
732 u32 n_param, struct snd_intelhad *intelhaddata)
735 u64 dividend, divisor;
737 if (intelhaddata->dp_output) {
738 /* Substitute cts_val with Maud according to DP 1.2 spec*/
739 cts_val = had_calculate_maud_value(aud_samp_freq, link_rate);
741 /* Calculate CTS according to HDMI 1.3a spec*/
742 dividend = (u64)tmds * n_param*1000;
743 divisor = 128 * aud_samp_freq;
744 cts_val = div64_u64(dividend, divisor);
746 dev_dbg(intelhaddata->dev, "TMDS value=%d, N value=%d, CTS Value=%d\n",
747 tmds, n_param, cts_val);
748 had_write_register(intelhaddata, AUD_HDMI_CTS, (BIT(24) | cts_val));
751 static int had_calculate_n_value(u32 aud_samp_freq)
755 /* Select N according to HDMI 1.3a spec*/
756 switch (aud_samp_freq) {
757 case AUD_SAMPLE_RATE_32:
761 case AUD_SAMPLE_RATE_44_1:
765 case AUD_SAMPLE_RATE_48:
769 case AUD_SAMPLE_RATE_88_2:
773 case AUD_SAMPLE_RATE_96:
777 case AUD_SAMPLE_RATE_176_4:
793 * Program HDMI audio N value
795 * @aud_samp_freq: sampling frequency of audio data
796 * @n_param: N value, depends on aud_samp_freq
797 * @intelhaddata: substream private data
799 * This function is called in the prepare callback.
800 * It programs based on the audio and display sampling frequency
802 static int had_prog_n(u32 aud_samp_freq, u32 *n_param,
803 struct snd_intelhad *intelhaddata)
807 if (intelhaddata->dp_output) {
809 * According to DP specs, Maud and Naud values hold
810 * a relationship, which is stated as:
811 * Maud/Naud = 512 * fs / f_LS_Clk
812 * where, fs is the sampling frequency of the audio stream
813 * and Naud is 32768 for Async clock.
818 n_val = had_calculate_n_value(aud_samp_freq);
823 had_write_register(intelhaddata, AUD_N_ENABLE, (BIT(24) | n_val));
829 * PCM ring buffer handling
831 * The hardware provides a ring buffer with the fixed 4 buffer descriptors
832 * (BDs). The driver maps these 4 BDs onto the PCM ring buffer. The mapping
833 * moves at each period elapsed. The below illustrates how it works:
836 * PCM | 0 | 1 | 2 | 3 | 4 | 5 | .... |n-1|
837 * BD | 0 | 1 | 2 | 3 |
839 * At time=1 (period elapsed)
840 * PCM | 0 | 1 | 2 | 3 | 4 | 5 | .... |n-1|
841 * BD | 1 | 2 | 3 | 0 |
843 * At time=2 (second period elapsed)
844 * PCM | 0 | 1 | 2 | 3 | 4 | 5 | .... |n-1|
845 * BD | 2 | 3 | 0 | 1 |
847 * The bd_head field points to the index of the BD to be read. It's also the
848 * position to be filled at next. The pcm_head and the pcm_filled fields
849 * point to the indices of the current position and of the next position to
850 * be filled, respectively. For PCM buffer there are both _head and _filled
851 * because they may be difference when nperiods > 4. For example, in the
852 * example above at t=1, bd_head=1 and pcm_head=1 while pcm_filled=5:
854 * pcm_head (=1) --v v-- pcm_filled (=5)
855 * PCM | 0 | 1 | 2 | 3 | 4 | 5 | .... |n-1|
856 * BD | 1 | 2 | 3 | 0 |
857 * bd_head (=1) --^ ^-- next to fill (= bd_head)
859 * For nperiods < 4, the remaining BDs out of 4 are marked as invalid, so that
860 * the hardware skips those BDs in the loop.
862 * An exceptional setup is the case with nperiods=1. Since we have to update
863 * BDs after finishing one BD processing, we'd need at least two BDs, where
864 * both BDs point to the same content, the same address, the same size of the
868 #define AUD_BUF_ADDR(x) (AUD_BUF_A_ADDR + (x) * HAD_REG_WIDTH)
869 #define AUD_BUF_LEN(x) (AUD_BUF_A_LENGTH + (x) * HAD_REG_WIDTH)
871 /* Set up a buffer descriptor at the "filled" position */
872 static void had_prog_bd(struct snd_pcm_substream *substream,
873 struct snd_intelhad *intelhaddata)
875 int idx = intelhaddata->bd_head;
876 int ofs = intelhaddata->pcmbuf_filled * intelhaddata->period_bytes;
877 u32 addr = substream->runtime->dma_addr + ofs;
879 addr |= AUD_BUF_VALID;
880 if (!substream->runtime->no_period_wakeup)
881 addr |= AUD_BUF_INTR_EN;
882 had_write_register(intelhaddata, AUD_BUF_ADDR(idx), addr);
883 had_write_register(intelhaddata, AUD_BUF_LEN(idx),
884 intelhaddata->period_bytes);
886 /* advance the indices to the next */
887 intelhaddata->bd_head++;
888 intelhaddata->bd_head %= intelhaddata->num_bds;
889 intelhaddata->pcmbuf_filled++;
890 intelhaddata->pcmbuf_filled %= substream->runtime->periods;
893 /* invalidate a buffer descriptor with the given index */
894 static void had_invalidate_bd(struct snd_intelhad *intelhaddata,
897 had_write_register(intelhaddata, AUD_BUF_ADDR(idx), 0);
898 had_write_register(intelhaddata, AUD_BUF_LEN(idx), 0);
901 /* Initial programming of ring buffer */
902 static void had_init_ringbuf(struct snd_pcm_substream *substream,
903 struct snd_intelhad *intelhaddata)
905 struct snd_pcm_runtime *runtime = substream->runtime;
908 num_periods = runtime->periods;
909 intelhaddata->num_bds = min(num_periods, HAD_NUM_OF_RING_BUFS);
910 /* set the minimum 2 BDs for num_periods=1 */
911 intelhaddata->num_bds = max(intelhaddata->num_bds, 2U);
912 intelhaddata->period_bytes =
913 frames_to_bytes(runtime, runtime->period_size);
914 WARN_ON(intelhaddata->period_bytes & 0x3f);
916 intelhaddata->bd_head = 0;
917 intelhaddata->pcmbuf_head = 0;
918 intelhaddata->pcmbuf_filled = 0;
920 for (i = 0; i < HAD_NUM_OF_RING_BUFS; i++) {
921 if (i < intelhaddata->num_bds)
922 had_prog_bd(substream, intelhaddata);
923 else /* invalidate the rest */
924 had_invalidate_bd(intelhaddata, i);
927 intelhaddata->bd_head = 0; /* reset at head again before starting */
930 /* process a bd, advance to the next */
931 static void had_advance_ringbuf(struct snd_pcm_substream *substream,
932 struct snd_intelhad *intelhaddata)
934 int num_periods = substream->runtime->periods;
936 /* reprogram the next buffer */
937 had_prog_bd(substream, intelhaddata);
939 /* proceed to next */
940 intelhaddata->pcmbuf_head++;
941 intelhaddata->pcmbuf_head %= num_periods;
944 /* process the current BD(s);
945 * returns the current PCM buffer byte position, or -EPIPE for underrun.
947 static int had_process_ringbuf(struct snd_pcm_substream *substream,
948 struct snd_intelhad *intelhaddata)
954 spin_lock_irqsave(&intelhaddata->had_spinlock, flags);
956 /* get the remaining bytes on the buffer */
957 had_read_register(intelhaddata,
958 AUD_BUF_LEN(intelhaddata->bd_head),
960 if (len < 0 || len > intelhaddata->period_bytes) {
961 dev_dbg(intelhaddata->dev, "Invalid buf length %d\n",
967 if (len > 0) /* OK, this is the current buffer */
970 /* len=0 => already empty, check the next buffer */
971 if (++processed >= intelhaddata->num_bds) {
972 len = -EPIPE; /* all empty? - report underrun */
975 had_advance_ringbuf(substream, intelhaddata);
978 len = intelhaddata->period_bytes - len;
979 len += intelhaddata->period_bytes * intelhaddata->pcmbuf_head;
981 spin_unlock_irqrestore(&intelhaddata->had_spinlock, flags);
985 /* called from irq handler */
986 static void had_process_buffer_done(struct snd_intelhad *intelhaddata)
988 struct snd_pcm_substream *substream;
990 substream = had_substream_get(intelhaddata);
992 return; /* no stream? - bail out */
994 if (!intelhaddata->connected) {
995 snd_pcm_stop_xrun(substream);
996 goto out; /* disconnected? - bail out */
999 /* process or stop the stream */
1000 if (had_process_ringbuf(substream, intelhaddata) < 0)
1001 snd_pcm_stop_xrun(substream);
1003 snd_pcm_period_elapsed(substream);
1006 had_substream_put(intelhaddata);
1010 * The interrupt status 'sticky' bits might not be cleared by
1011 * setting '1' to that bit once...
1013 static void wait_clear_underrun_bit(struct snd_intelhad *intelhaddata)
1018 for (i = 0; i < 100; i++) {
1019 /* clear bit30, 31 AUD_HDMI_STATUS */
1020 had_read_register(intelhaddata, AUD_HDMI_STATUS, &val);
1021 if (!(val & AUD_HDMI_STATUS_MASK_UNDERRUN))
1025 had_write_register(intelhaddata, AUD_HDMI_STATUS, val);
1027 dev_err(intelhaddata->dev, "Unable to clear UNDERRUN bits\n");
1030 /* Perform some reset procedure after stopping the stream;
1031 * this is called from prepare or hw_free callbacks once after trigger STOP
1032 * or underrun has been processed in order to settle down the h/w state.
1034 static int had_pcm_sync_stop(struct snd_pcm_substream *substream)
1036 struct snd_intelhad *intelhaddata = snd_pcm_substream_chip(substream);
1038 if (!intelhaddata->connected)
1041 /* Reset buffer pointers */
1042 had_reset_audio(intelhaddata);
1043 wait_clear_underrun_bit(intelhaddata);
1047 /* called from irq handler */
1048 static void had_process_buffer_underrun(struct snd_intelhad *intelhaddata)
1050 struct snd_pcm_substream *substream;
1052 /* Report UNDERRUN error to above layers */
1053 substream = had_substream_get(intelhaddata);
1055 snd_pcm_stop_xrun(substream);
1056 had_substream_put(intelhaddata);
1061 * ALSA PCM open callback
1063 static int had_pcm_open(struct snd_pcm_substream *substream)
1065 struct snd_intelhad *intelhaddata;
1066 struct snd_pcm_runtime *runtime;
1069 intelhaddata = snd_pcm_substream_chip(substream);
1070 runtime = substream->runtime;
1072 retval = pm_runtime_resume_and_get(intelhaddata->dev);
1076 /* set the runtime hw parameter with local snd_pcm_hardware struct */
1077 runtime->hw = had_pcm_hardware;
1079 retval = snd_pcm_hw_constraint_integer(runtime,
1080 SNDRV_PCM_HW_PARAM_PERIODS);
1084 /* Make sure, that the period size is always aligned
1087 retval = snd_pcm_hw_constraint_step(substream->runtime, 0,
1088 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, 64);
1092 retval = snd_pcm_hw_constraint_msbits(runtime, 0, 32, 24);
1096 /* expose PCM substream */
1097 spin_lock_irq(&intelhaddata->had_spinlock);
1098 intelhaddata->stream_info.substream = substream;
1099 intelhaddata->stream_info.substream_refcount++;
1100 spin_unlock_irq(&intelhaddata->had_spinlock);
1104 pm_runtime_mark_last_busy(intelhaddata->dev);
1105 pm_runtime_put_autosuspend(intelhaddata->dev);
1110 * ALSA PCM close callback
1112 static int had_pcm_close(struct snd_pcm_substream *substream)
1114 struct snd_intelhad *intelhaddata;
1116 intelhaddata = snd_pcm_substream_chip(substream);
1118 /* unreference and sync with the pending PCM accesses */
1119 spin_lock_irq(&intelhaddata->had_spinlock);
1120 intelhaddata->stream_info.substream = NULL;
1121 intelhaddata->stream_info.substream_refcount--;
1122 while (intelhaddata->stream_info.substream_refcount > 0) {
1123 spin_unlock_irq(&intelhaddata->had_spinlock);
1125 spin_lock_irq(&intelhaddata->had_spinlock);
1127 spin_unlock_irq(&intelhaddata->had_spinlock);
1129 pm_runtime_mark_last_busy(intelhaddata->dev);
1130 pm_runtime_put_autosuspend(intelhaddata->dev);
1135 * ALSA PCM hw_params callback
1137 static int had_pcm_hw_params(struct snd_pcm_substream *substream,
1138 struct snd_pcm_hw_params *hw_params)
1140 struct snd_intelhad *intelhaddata;
1143 intelhaddata = snd_pcm_substream_chip(substream);
1144 buf_size = params_buffer_bytes(hw_params);
1145 dev_dbg(intelhaddata->dev, "%s:allocated memory = %d\n",
1146 __func__, buf_size);
1151 * ALSA PCM trigger callback
1153 static int had_pcm_trigger(struct snd_pcm_substream *substream, int cmd)
1156 struct snd_intelhad *intelhaddata;
1158 intelhaddata = snd_pcm_substream_chip(substream);
1160 spin_lock(&intelhaddata->had_spinlock);
1162 case SNDRV_PCM_TRIGGER_START:
1163 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1164 case SNDRV_PCM_TRIGGER_RESUME:
1166 had_ack_irqs(intelhaddata); /* FIXME: do we need this? */
1167 had_enable_audio(intelhaddata, true);
1170 case SNDRV_PCM_TRIGGER_STOP:
1171 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1173 had_enable_audio(intelhaddata, false);
1179 spin_unlock(&intelhaddata->had_spinlock);
1184 * ALSA PCM prepare callback
1186 static int had_pcm_prepare(struct snd_pcm_substream *substream)
1189 u32 disp_samp_freq, n_param;
1191 struct snd_intelhad *intelhaddata;
1192 struct snd_pcm_runtime *runtime;
1194 intelhaddata = snd_pcm_substream_chip(substream);
1195 runtime = substream->runtime;
1197 dev_dbg(intelhaddata->dev, "period_size=%d\n",
1198 (int)frames_to_bytes(runtime, runtime->period_size));
1199 dev_dbg(intelhaddata->dev, "periods=%d\n", runtime->periods);
1200 dev_dbg(intelhaddata->dev, "buffer_size=%d\n",
1201 (int)snd_pcm_lib_buffer_bytes(substream));
1202 dev_dbg(intelhaddata->dev, "rate=%d\n", runtime->rate);
1203 dev_dbg(intelhaddata->dev, "channels=%d\n", runtime->channels);
1205 /* Get N value in KHz */
1206 disp_samp_freq = intelhaddata->tmds_clock_speed;
1208 retval = had_prog_n(substream->runtime->rate, &n_param, intelhaddata);
1210 dev_err(intelhaddata->dev,
1211 "programming N value failed %#x\n", retval);
1215 if (intelhaddata->dp_output)
1216 link_rate = intelhaddata->link_rate;
1218 had_prog_cts(substream->runtime->rate, disp_samp_freq, link_rate,
1219 n_param, intelhaddata);
1221 had_prog_dip(substream, intelhaddata);
1223 retval = had_init_audio_ctrl(substream, intelhaddata);
1225 /* Prog buffer address */
1226 had_init_ringbuf(substream, intelhaddata);
1229 * Program channel mapping in following order:
1230 * FL, FR, C, LFE, RL, RR
1233 had_write_register(intelhaddata, AUD_BUF_CH_SWAP, SWAP_LFE_CENTER);
1240 * ALSA PCM pointer callback
1242 static snd_pcm_uframes_t had_pcm_pointer(struct snd_pcm_substream *substream)
1244 struct snd_intelhad *intelhaddata;
1247 intelhaddata = snd_pcm_substream_chip(substream);
1249 if (!intelhaddata->connected)
1250 return SNDRV_PCM_POS_XRUN;
1252 len = had_process_ringbuf(substream, intelhaddata);
1254 return SNDRV_PCM_POS_XRUN;
1255 len = bytes_to_frames(substream->runtime, len);
1256 /* wrapping may happen when periods=1 */
1257 len %= substream->runtime->buffer_size;
1264 static const struct snd_pcm_ops had_pcm_ops = {
1265 .open = had_pcm_open,
1266 .close = had_pcm_close,
1267 .hw_params = had_pcm_hw_params,
1268 .prepare = had_pcm_prepare,
1269 .trigger = had_pcm_trigger,
1270 .sync_stop = had_pcm_sync_stop,
1271 .pointer = had_pcm_pointer,
1274 /* process mode change of the running stream; called in mutex */
1275 static int had_process_mode_change(struct snd_intelhad *intelhaddata)
1277 struct snd_pcm_substream *substream;
1279 u32 disp_samp_freq, n_param;
1282 substream = had_substream_get(intelhaddata);
1287 had_enable_audio(intelhaddata, false);
1289 /* Update CTS value */
1290 disp_samp_freq = intelhaddata->tmds_clock_speed;
1292 retval = had_prog_n(substream->runtime->rate, &n_param, intelhaddata);
1294 dev_err(intelhaddata->dev,
1295 "programming N value failed %#x\n", retval);
1299 if (intelhaddata->dp_output)
1300 link_rate = intelhaddata->link_rate;
1302 had_prog_cts(substream->runtime->rate, disp_samp_freq, link_rate,
1303 n_param, intelhaddata);
1306 had_enable_audio(intelhaddata, true);
1309 had_substream_put(intelhaddata);
1313 /* process hot plug, called from wq with mutex locked */
1314 static void had_process_hot_plug(struct snd_intelhad *intelhaddata)
1316 struct snd_pcm_substream *substream;
1318 spin_lock_irq(&intelhaddata->had_spinlock);
1319 if (intelhaddata->connected) {
1320 dev_dbg(intelhaddata->dev, "Device already connected\n");
1321 spin_unlock_irq(&intelhaddata->had_spinlock);
1326 had_enable_audio(intelhaddata, false);
1328 intelhaddata->connected = true;
1329 dev_dbg(intelhaddata->dev,
1330 "%s @ %d:DEBUG PLUG/UNPLUG : HAD_DRV_CONNECTED\n",
1331 __func__, __LINE__);
1332 spin_unlock_irq(&intelhaddata->had_spinlock);
1334 had_build_channel_allocation_map(intelhaddata);
1336 /* Report to above ALSA layer */
1337 substream = had_substream_get(intelhaddata);
1339 snd_pcm_stop_xrun(substream);
1340 had_substream_put(intelhaddata);
1343 snd_jack_report(intelhaddata->jack, SND_JACK_AVOUT);
1346 /* process hot unplug, called from wq with mutex locked */
1347 static void had_process_hot_unplug(struct snd_intelhad *intelhaddata)
1349 struct snd_pcm_substream *substream;
1351 spin_lock_irq(&intelhaddata->had_spinlock);
1352 if (!intelhaddata->connected) {
1353 dev_dbg(intelhaddata->dev, "Device already disconnected\n");
1354 spin_unlock_irq(&intelhaddata->had_spinlock);
1360 had_enable_audio(intelhaddata, false);
1362 intelhaddata->connected = false;
1363 dev_dbg(intelhaddata->dev,
1364 "%s @ %d:DEBUG PLUG/UNPLUG : HAD_DRV_DISCONNECTED\n",
1365 __func__, __LINE__);
1366 spin_unlock_irq(&intelhaddata->had_spinlock);
1368 kfree(intelhaddata->chmap->chmap);
1369 intelhaddata->chmap->chmap = NULL;
1371 /* Report to above ALSA layer */
1372 substream = had_substream_get(intelhaddata);
1374 snd_pcm_stop_xrun(substream);
1375 had_substream_put(intelhaddata);
1378 snd_jack_report(intelhaddata->jack, 0);
1382 * ALSA iec958 and ELD controls
1385 static int had_iec958_info(struct snd_kcontrol *kcontrol,
1386 struct snd_ctl_elem_info *uinfo)
1388 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
1393 static int had_iec958_get(struct snd_kcontrol *kcontrol,
1394 struct snd_ctl_elem_value *ucontrol)
1396 struct snd_intelhad *intelhaddata = snd_kcontrol_chip(kcontrol);
1398 mutex_lock(&intelhaddata->mutex);
1399 ucontrol->value.iec958.status[0] = (intelhaddata->aes_bits >> 0) & 0xff;
1400 ucontrol->value.iec958.status[1] = (intelhaddata->aes_bits >> 8) & 0xff;
1401 ucontrol->value.iec958.status[2] =
1402 (intelhaddata->aes_bits >> 16) & 0xff;
1403 ucontrol->value.iec958.status[3] =
1404 (intelhaddata->aes_bits >> 24) & 0xff;
1405 mutex_unlock(&intelhaddata->mutex);
1409 static int had_iec958_mask_get(struct snd_kcontrol *kcontrol,
1410 struct snd_ctl_elem_value *ucontrol)
1412 ucontrol->value.iec958.status[0] = 0xff;
1413 ucontrol->value.iec958.status[1] = 0xff;
1414 ucontrol->value.iec958.status[2] = 0xff;
1415 ucontrol->value.iec958.status[3] = 0xff;
1419 static int had_iec958_put(struct snd_kcontrol *kcontrol,
1420 struct snd_ctl_elem_value *ucontrol)
1423 struct snd_intelhad *intelhaddata = snd_kcontrol_chip(kcontrol);
1426 val = (ucontrol->value.iec958.status[0] << 0) |
1427 (ucontrol->value.iec958.status[1] << 8) |
1428 (ucontrol->value.iec958.status[2] << 16) |
1429 (ucontrol->value.iec958.status[3] << 24);
1430 mutex_lock(&intelhaddata->mutex);
1431 if (intelhaddata->aes_bits != val) {
1432 intelhaddata->aes_bits = val;
1435 mutex_unlock(&intelhaddata->mutex);
1439 static int had_ctl_eld_info(struct snd_kcontrol *kcontrol,
1440 struct snd_ctl_elem_info *uinfo)
1442 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
1443 uinfo->count = HDMI_MAX_ELD_BYTES;
1447 static int had_ctl_eld_get(struct snd_kcontrol *kcontrol,
1448 struct snd_ctl_elem_value *ucontrol)
1450 struct snd_intelhad *intelhaddata = snd_kcontrol_chip(kcontrol);
1452 mutex_lock(&intelhaddata->mutex);
1453 memcpy(ucontrol->value.bytes.data, intelhaddata->eld,
1454 HDMI_MAX_ELD_BYTES);
1455 mutex_unlock(&intelhaddata->mutex);
1459 static const struct snd_kcontrol_new had_controls[] = {
1461 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1462 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
1463 .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, MASK),
1464 .info = had_iec958_info, /* shared */
1465 .get = had_iec958_mask_get,
1468 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
1469 .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, DEFAULT),
1470 .info = had_iec958_info,
1471 .get = had_iec958_get,
1472 .put = had_iec958_put,
1475 .access = (SNDRV_CTL_ELEM_ACCESS_READ |
1476 SNDRV_CTL_ELEM_ACCESS_VOLATILE),
1477 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
1479 .info = had_ctl_eld_info,
1480 .get = had_ctl_eld_get,
1485 * audio interrupt handler
1487 static irqreturn_t display_pipe_interrupt_handler(int irq, void *dev_id)
1489 struct snd_intelhad_card *card_ctx = dev_id;
1490 u32 audio_stat[3] = {};
1493 for_each_pipe(card_ctx, pipe) {
1494 /* use raw register access to ack IRQs even while disconnected */
1495 audio_stat[pipe] = had_read_register_raw(card_ctx, pipe,
1497 (HDMI_AUDIO_UNDERRUN | HDMI_AUDIO_BUFFER_DONE);
1499 if (audio_stat[pipe])
1500 had_write_register_raw(card_ctx, pipe,
1501 AUD_HDMI_STATUS, audio_stat[pipe]);
1504 for_each_port(card_ctx, port) {
1505 struct snd_intelhad *ctx = &card_ctx->pcm_ctx[port];
1506 int pipe = ctx->pipe;
1511 if (audio_stat[pipe] & HDMI_AUDIO_BUFFER_DONE)
1512 had_process_buffer_done(ctx);
1513 if (audio_stat[pipe] & HDMI_AUDIO_UNDERRUN)
1514 had_process_buffer_underrun(ctx);
1521 * monitor plug/unplug notification from i915; just kick off the work
1523 static void notify_audio_lpe(struct platform_device *pdev, int port)
1525 struct snd_intelhad_card *card_ctx = platform_get_drvdata(pdev);
1526 struct snd_intelhad *ctx;
1528 ctx = &card_ctx->pcm_ctx[single_port ? 0 : port];
1532 schedule_work(&ctx->hdmi_audio_wq);
1535 /* the work to handle monitor hot plug/unplug */
1536 static void had_audio_wq(struct work_struct *work)
1538 struct snd_intelhad *ctx =
1539 container_of(work, struct snd_intelhad, hdmi_audio_wq);
1540 struct intel_hdmi_lpe_audio_pdata *pdata = ctx->dev->platform_data;
1541 struct intel_hdmi_lpe_audio_port_pdata *ppdata = &pdata->port[ctx->port];
1544 ret = pm_runtime_resume_and_get(ctx->dev);
1548 mutex_lock(&ctx->mutex);
1549 if (ppdata->pipe < 0) {
1550 dev_dbg(ctx->dev, "%s: Event: HAD_NOTIFY_HOT_UNPLUG : port = %d\n",
1551 __func__, ctx->port);
1553 memset(ctx->eld, 0, sizeof(ctx->eld)); /* clear the old ELD */
1555 ctx->dp_output = false;
1556 ctx->tmds_clock_speed = 0;
1559 /* Shut down the stream */
1560 had_process_hot_unplug(ctx);
1564 dev_dbg(ctx->dev, "%s: HAD_NOTIFY_ELD : port = %d, tmds = %d\n",
1565 __func__, ctx->port, ppdata->ls_clock);
1567 memcpy(ctx->eld, ppdata->eld, sizeof(ctx->eld));
1569 ctx->dp_output = ppdata->dp_output;
1570 if (ctx->dp_output) {
1571 ctx->tmds_clock_speed = 0;
1572 ctx->link_rate = ppdata->ls_clock;
1574 ctx->tmds_clock_speed = ppdata->ls_clock;
1579 * Shut down the stream before we change
1580 * the pipe assignment for this pcm device
1582 had_process_hot_plug(ctx);
1584 ctx->pipe = ppdata->pipe;
1586 /* Restart the stream if necessary */
1587 had_process_mode_change(ctx);
1590 mutex_unlock(&ctx->mutex);
1591 pm_runtime_mark_last_busy(ctx->dev);
1592 pm_runtime_put_autosuspend(ctx->dev);
1598 static int had_create_jack(struct snd_intelhad *ctx,
1599 struct snd_pcm *pcm)
1604 snprintf(hdmi_str, sizeof(hdmi_str),
1605 "HDMI/DP,pcm=%d", pcm->device);
1607 err = snd_jack_new(ctx->card_ctx->card, hdmi_str,
1608 SND_JACK_AVOUT, &ctx->jack,
1612 ctx->jack->private_data = ctx;
1620 static int __maybe_unused hdmi_lpe_audio_suspend(struct device *dev)
1622 struct snd_intelhad_card *card_ctx = dev_get_drvdata(dev);
1624 snd_power_change_state(card_ctx->card, SNDRV_CTL_POWER_D3hot);
1629 static int __maybe_unused hdmi_lpe_audio_resume(struct device *dev)
1631 struct snd_intelhad_card *card_ctx = dev_get_drvdata(dev);
1633 pm_runtime_mark_last_busy(dev);
1635 snd_power_change_state(card_ctx->card, SNDRV_CTL_POWER_D0);
1640 /* release resources */
1641 static void hdmi_lpe_audio_free(struct snd_card *card)
1643 struct snd_intelhad_card *card_ctx = card->private_data;
1644 struct intel_hdmi_lpe_audio_pdata *pdata = card_ctx->dev->platform_data;
1647 spin_lock_irq(&pdata->lpe_audio_slock);
1648 pdata->notify_audio_lpe = NULL;
1649 spin_unlock_irq(&pdata->lpe_audio_slock);
1651 for_each_port(card_ctx, port) {
1652 struct snd_intelhad *ctx = &card_ctx->pcm_ctx[port];
1654 cancel_work_sync(&ctx->hdmi_audio_wq);
1659 * hdmi_lpe_audio_probe - start bridge with i915
1661 * This function is called when the i915 driver creates the
1662 * hdmi-lpe-audio platform device.
1664 static int __hdmi_lpe_audio_probe(struct platform_device *pdev)
1666 struct snd_card *card;
1667 struct snd_intelhad_card *card_ctx;
1668 struct snd_intelhad *ctx;
1669 struct snd_pcm *pcm;
1670 struct intel_hdmi_lpe_audio_pdata *pdata;
1672 struct resource *res_mmio;
1675 pdata = pdev->dev.platform_data;
1677 dev_err(&pdev->dev, "%s: quit: pdata not allocated by i915!!\n", __func__);
1682 irq = platform_get_irq(pdev, 0);
1686 res_mmio = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1688 dev_err(&pdev->dev, "Could not get IO_MEM resources\n");
1692 /* create a card instance with ALSA framework */
1693 ret = snd_devm_card_new(&pdev->dev, hdmi_card_index, hdmi_card_id,
1694 THIS_MODULE, sizeof(*card_ctx), &card);
1698 card_ctx = card->private_data;
1699 card_ctx->dev = &pdev->dev;
1700 card_ctx->card = card;
1701 strcpy(card->driver, INTEL_HAD);
1702 strcpy(card->shortname, "Intel HDMI/DP LPE Audio");
1703 strcpy(card->longname, "Intel HDMI/DP LPE Audio");
1707 card->private_free = hdmi_lpe_audio_free;
1709 platform_set_drvdata(pdev, card_ctx);
1711 card_ctx->num_pipes = pdata->num_pipes;
1712 card_ctx->num_ports = single_port ? 1 : pdata->num_ports;
1714 for_each_port(card_ctx, port) {
1715 ctx = &card_ctx->pcm_ctx[port];
1716 ctx->card_ctx = card_ctx;
1717 ctx->dev = card_ctx->dev;
1718 ctx->port = single_port ? -1 : port;
1721 spin_lock_init(&ctx->had_spinlock);
1722 mutex_init(&ctx->mutex);
1723 INIT_WORK(&ctx->hdmi_audio_wq, had_audio_wq);
1726 dev_dbg(&pdev->dev, "%s: mmio_start = 0x%x, mmio_end = 0x%x\n",
1727 __func__, (unsigned int)res_mmio->start,
1728 (unsigned int)res_mmio->end);
1730 card_ctx->mmio_start =
1731 devm_ioremap(&pdev->dev, res_mmio->start,
1732 (size_t)(resource_size(res_mmio)));
1733 if (!card_ctx->mmio_start) {
1734 dev_err(&pdev->dev, "Could not get ioremap\n");
1738 /* setup interrupt handler */
1739 ret = devm_request_irq(&pdev->dev, irq, display_pipe_interrupt_handler,
1740 0, pdev->name, card_ctx);
1742 dev_err(&pdev->dev, "request_irq failed\n");
1746 card_ctx->irq = irq;
1748 /* only 32bit addressable */
1749 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
1753 init_channel_allocations();
1755 card_ctx->num_pipes = pdata->num_pipes;
1756 card_ctx->num_ports = single_port ? 1 : pdata->num_ports;
1758 for_each_port(card_ctx, port) {
1761 ctx = &card_ctx->pcm_ctx[port];
1762 ret = snd_pcm_new(card, INTEL_HAD, port, MAX_PB_STREAMS,
1763 MAX_CAP_STREAMS, &pcm);
1767 /* setup private data which can be retrieved when required */
1768 pcm->private_data = ctx;
1769 pcm->info_flags = 0;
1770 strscpy(pcm->name, card->shortname, strlen(card->shortname));
1771 /* setup the ops for playback */
1772 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &had_pcm_ops);
1774 /* allocate dma pages;
1775 * try to allocate 600k buffer as default which is large enough
1777 snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_WC,
1778 card->dev, HAD_DEFAULT_BUFFER,
1781 /* create controls */
1782 for (i = 0; i < ARRAY_SIZE(had_controls); i++) {
1783 struct snd_kcontrol *kctl;
1785 kctl = snd_ctl_new1(&had_controls[i], ctx);
1789 kctl->id.device = pcm->device;
1791 ret = snd_ctl_add(card, kctl);
1796 /* Register channel map controls */
1797 ret = had_register_chmap_ctls(ctx, pcm);
1801 ret = had_create_jack(ctx, pcm);
1806 ret = snd_card_register(card);
1810 spin_lock_irq(&pdata->lpe_audio_slock);
1811 pdata->notify_audio_lpe = notify_audio_lpe;
1812 spin_unlock_irq(&pdata->lpe_audio_slock);
1814 pm_runtime_set_autosuspend_delay(&pdev->dev, INTEL_HDMI_AUDIO_SUSPEND_DELAY_MS);
1815 pm_runtime_use_autosuspend(&pdev->dev);
1816 pm_runtime_enable(&pdev->dev);
1817 pm_runtime_mark_last_busy(&pdev->dev);
1818 pm_runtime_idle(&pdev->dev);
1820 dev_dbg(&pdev->dev, "%s: handle pending notification\n", __func__);
1821 for_each_port(card_ctx, port) {
1822 struct snd_intelhad *ctx = &card_ctx->pcm_ctx[port];
1824 schedule_work(&ctx->hdmi_audio_wq);
1830 static int hdmi_lpe_audio_probe(struct platform_device *pdev)
1832 return snd_card_free_on_error(&pdev->dev, __hdmi_lpe_audio_probe(pdev));
1835 static const struct dev_pm_ops hdmi_lpe_audio_pm = {
1836 SET_SYSTEM_SLEEP_PM_OPS(hdmi_lpe_audio_suspend, hdmi_lpe_audio_resume)
1839 static struct platform_driver hdmi_lpe_audio_driver = {
1841 .name = "hdmi-lpe-audio",
1842 .pm = &hdmi_lpe_audio_pm,
1844 .probe = hdmi_lpe_audio_probe,
1847 module_platform_driver(hdmi_lpe_audio_driver);
1848 MODULE_ALIAS("platform:hdmi_lpe_audio");
1850 MODULE_AUTHOR("Sailaja Bandarupalli <sailaja.bandarupalli@intel.com>");
1851 MODULE_AUTHOR("Ramesh Babu K V <ramesh.babu@intel.com>");
1852 MODULE_AUTHOR("Vaibhav Agarwal <vaibhav.agarwal@intel.com>");
1853 MODULE_AUTHOR("Jerome Anand <jerome.anand@intel.com>");
1854 MODULE_DESCRIPTION("Intel HDMI Audio driver");
1855 MODULE_LICENSE("GPL v2");