3 * patch_intelhdmi.c - Patch for Intel HDMI codecs
5 * Copyright(c) 2008 Intel Corporation. All rights reserved.
8 * Jiang Zhe <zhe.jiang@intel.com>
9 * Wu Fengguang <wfg@linux.intel.com>
12 * Wu Fengguang <wfg@linux.intel.com>
14 * This program is free software; you can redistribute it and/or modify it
15 * under the terms of the GNU General Public License as published by the Free
16 * Software Foundation; either version 2 of the License, or (at your option)
19 * This program is distributed in the hope that it will be useful, but
20 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
21 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 #include <linux/init.h>
30 #include <linux/delay.h>
31 #include <linux/slab.h>
32 #include <sound/core.h>
33 #include "hda_codec.h"
34 #include "hda_local.h"
35 #include "hda_patch.h"
37 #define CVT_NID 0x02 /* audio converter */
38 #define PIN_NID 0x03 /* HDMI output pin */
40 #define INTEL_HDMI_EVENT_TAG 0x08
42 struct intel_hdmi_spec {
43 struct hda_multi_out multiout;
44 struct hda_pcm pcm_rec;
45 struct hdmi_eld sink_eld;
48 static struct hda_verb pinout_enable_verb[] = {
49 {PIN_NID, AC_VERB_SET_PIN_WIDGET_CONTROL, PIN_OUT},
53 static struct hda_verb pinout_disable_verb[] = {
54 {PIN_NID, AC_VERB_SET_PIN_WIDGET_CONTROL, 0x00},
58 static struct hda_verb unsolicited_response_verb[] = {
59 {PIN_NID, AC_VERB_SET_UNSOLICITED_ENABLE, AC_USRSP_EN |
60 INTEL_HDMI_EVENT_TAG},
64 static struct hda_verb def_chan_map[] = {
65 {CVT_NID, AC_VERB_SET_HDMI_CHAN_SLOT, 0x00},
66 {CVT_NID, AC_VERB_SET_HDMI_CHAN_SLOT, 0x11},
67 {CVT_NID, AC_VERB_SET_HDMI_CHAN_SLOT, 0x22},
68 {CVT_NID, AC_VERB_SET_HDMI_CHAN_SLOT, 0x33},
69 {CVT_NID, AC_VERB_SET_HDMI_CHAN_SLOT, 0x44},
70 {CVT_NID, AC_VERB_SET_HDMI_CHAN_SLOT, 0x55},
71 {CVT_NID, AC_VERB_SET_HDMI_CHAN_SLOT, 0x66},
72 {CVT_NID, AC_VERB_SET_HDMI_CHAN_SLOT, 0x77},
77 struct hdmi_audio_infoframe {
82 u8 checksum; /* PB0 */
83 u8 CC02_CT47; /* CC in bits 0:2, CT in 4:7 */
87 u8 LFEPBL01_LSV36_DM_INH7;
88 u8 reserved[5]; /* PB6 - PB10 */
92 * CEA speaker placement:
95 * FLW FL FLC FC FRC FR FRW
102 * The Left/Right Surround channel _notions_ LS/RS in SMPTE 320M corresponds to
103 * CEA RL/RR; The SMPTE channel _assignment_ C/LFE is swapped to CEA LFE/FC.
105 enum cea_speaker_placement {
106 FL = (1 << 0), /* Front Left */
107 FC = (1 << 1), /* Front Center */
108 FR = (1 << 2), /* Front Right */
109 FLC = (1 << 3), /* Front Left Center */
110 FRC = (1 << 4), /* Front Right Center */
111 RL = (1 << 5), /* Rear Left */
112 RC = (1 << 6), /* Rear Center */
113 RR = (1 << 7), /* Rear Right */
114 RLC = (1 << 8), /* Rear Left Center */
115 RRC = (1 << 9), /* Rear Right Center */
116 LFE = (1 << 10), /* Low Frequency Effect */
117 FLW = (1 << 11), /* Front Left Wide */
118 FRW = (1 << 12), /* Front Right Wide */
119 FLH = (1 << 13), /* Front Left High */
120 FCH = (1 << 14), /* Front Center High */
121 FRH = (1 << 15), /* Front Right High */
122 TC = (1 << 16), /* Top Center */
126 * ELD SA bits in the CEA Speaker Allocation data block
128 static int eld_speaker_allocation_bits[] = {
136 /* the following are not defined in ELD yet */
143 struct cea_channel_speaker_allocation {
147 /* derived values, just for convenience */
153 * This is an ordered list!
155 * The preceding ones have better chances to be selected by
156 * hdmi_setup_channel_allocation().
158 static struct cea_channel_speaker_allocation channel_allocations[] = {
159 /* channel: 8 7 6 5 4 3 2 1 */
160 { .ca_index = 0x00, .speakers = { 0, 0, 0, 0, 0, 0, FR, FL } },
162 { .ca_index = 0x01, .speakers = { 0, 0, 0, 0, 0, LFE, FR, FL } },
164 { .ca_index = 0x02, .speakers = { 0, 0, 0, 0, FC, 0, FR, FL } },
165 { .ca_index = 0x03, .speakers = { 0, 0, 0, 0, FC, LFE, FR, FL } },
166 { .ca_index = 0x04, .speakers = { 0, 0, 0, RC, 0, 0, FR, FL } },
167 { .ca_index = 0x05, .speakers = { 0, 0, 0, RC, 0, LFE, FR, FL } },
168 { .ca_index = 0x06, .speakers = { 0, 0, 0, RC, FC, 0, FR, FL } },
169 { .ca_index = 0x07, .speakers = { 0, 0, 0, RC, FC, LFE, FR, FL } },
170 { .ca_index = 0x08, .speakers = { 0, 0, RR, RL, 0, 0, FR, FL } },
171 { .ca_index = 0x09, .speakers = { 0, 0, RR, RL, 0, LFE, FR, FL } },
172 { .ca_index = 0x0a, .speakers = { 0, 0, RR, RL, FC, 0, FR, FL } },
174 { .ca_index = 0x0b, .speakers = { 0, 0, RR, RL, FC, LFE, FR, FL } },
175 { .ca_index = 0x0c, .speakers = { 0, RC, RR, RL, 0, 0, FR, FL } },
176 { .ca_index = 0x0d, .speakers = { 0, RC, RR, RL, 0, LFE, FR, FL } },
177 { .ca_index = 0x0e, .speakers = { 0, RC, RR, RL, FC, 0, FR, FL } },
179 { .ca_index = 0x0f, .speakers = { 0, RC, RR, RL, FC, LFE, FR, FL } },
180 { .ca_index = 0x10, .speakers = { RRC, RLC, RR, RL, 0, 0, FR, FL } },
181 { .ca_index = 0x11, .speakers = { RRC, RLC, RR, RL, 0, LFE, FR, FL } },
182 { .ca_index = 0x12, .speakers = { RRC, RLC, RR, RL, FC, 0, FR, FL } },
184 { .ca_index = 0x13, .speakers = { RRC, RLC, RR, RL, FC, LFE, FR, FL } },
185 { .ca_index = 0x14, .speakers = { FRC, FLC, 0, 0, 0, 0, FR, FL } },
186 { .ca_index = 0x15, .speakers = { FRC, FLC, 0, 0, 0, LFE, FR, FL } },
187 { .ca_index = 0x16, .speakers = { FRC, FLC, 0, 0, FC, 0, FR, FL } },
188 { .ca_index = 0x17, .speakers = { FRC, FLC, 0, 0, FC, LFE, FR, FL } },
189 { .ca_index = 0x18, .speakers = { FRC, FLC, 0, RC, 0, 0, FR, FL } },
190 { .ca_index = 0x19, .speakers = { FRC, FLC, 0, RC, 0, LFE, FR, FL } },
191 { .ca_index = 0x1a, .speakers = { FRC, FLC, 0, RC, FC, 0, FR, FL } },
192 { .ca_index = 0x1b, .speakers = { FRC, FLC, 0, RC, FC, LFE, FR, FL } },
193 { .ca_index = 0x1c, .speakers = { FRC, FLC, RR, RL, 0, 0, FR, FL } },
194 { .ca_index = 0x1d, .speakers = { FRC, FLC, RR, RL, 0, LFE, FR, FL } },
195 { .ca_index = 0x1e, .speakers = { FRC, FLC, RR, RL, FC, 0, FR, FL } },
196 { .ca_index = 0x1f, .speakers = { FRC, FLC, RR, RL, FC, LFE, FR, FL } },
197 { .ca_index = 0x20, .speakers = { 0, FCH, RR, RL, FC, 0, FR, FL } },
198 { .ca_index = 0x21, .speakers = { 0, FCH, RR, RL, FC, LFE, FR, FL } },
199 { .ca_index = 0x22, .speakers = { TC, 0, RR, RL, FC, 0, FR, FL } },
200 { .ca_index = 0x23, .speakers = { TC, 0, RR, RL, FC, LFE, FR, FL } },
201 { .ca_index = 0x24, .speakers = { FRH, FLH, RR, RL, 0, 0, FR, FL } },
202 { .ca_index = 0x25, .speakers = { FRH, FLH, RR, RL, 0, LFE, FR, FL } },
203 { .ca_index = 0x26, .speakers = { FRW, FLW, RR, RL, 0, 0, FR, FL } },
204 { .ca_index = 0x27, .speakers = { FRW, FLW, RR, RL, 0, LFE, FR, FL } },
205 { .ca_index = 0x28, .speakers = { TC, RC, RR, RL, FC, 0, FR, FL } },
206 { .ca_index = 0x29, .speakers = { TC, RC, RR, RL, FC, LFE, FR, FL } },
207 { .ca_index = 0x2a, .speakers = { FCH, RC, RR, RL, FC, 0, FR, FL } },
208 { .ca_index = 0x2b, .speakers = { FCH, RC, RR, RL, FC, LFE, FR, FL } },
209 { .ca_index = 0x2c, .speakers = { TC, FCH, RR, RL, FC, 0, FR, FL } },
210 { .ca_index = 0x2d, .speakers = { TC, FCH, RR, RL, FC, LFE, FR, FL } },
211 { .ca_index = 0x2e, .speakers = { FRH, FLH, RR, RL, FC, 0, FR, FL } },
212 { .ca_index = 0x2f, .speakers = { FRH, FLH, RR, RL, FC, LFE, FR, FL } },
213 { .ca_index = 0x30, .speakers = { FRW, FLW, RR, RL, FC, 0, FR, FL } },
214 { .ca_index = 0x31, .speakers = { FRW, FLW, RR, RL, FC, LFE, FR, FL } },
222 static void hdmi_get_dip_index(struct hda_codec *codec, hda_nid_t nid,
223 int *packet_index, int *byte_index)
227 val = snd_hda_codec_read(codec, nid, 0, AC_VERB_GET_HDMI_DIP_INDEX, 0);
229 *packet_index = val >> 5;
230 *byte_index = val & 0x1f;
234 static void hdmi_set_dip_index(struct hda_codec *codec, hda_nid_t nid,
235 int packet_index, int byte_index)
239 val = (packet_index << 5) | (byte_index & 0x1f);
241 snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_HDMI_DIP_INDEX, val);
244 static void hdmi_write_dip_byte(struct hda_codec *codec, hda_nid_t nid,
247 snd_hda_codec_write(codec, nid, 0, AC_VERB_SET_HDMI_DIP_DATA, val);
250 static void hdmi_enable_output(struct hda_codec *codec)
252 /* Enable Audio InfoFrame Transmission */
253 hdmi_set_dip_index(codec, PIN_NID, 0x0, 0x0);
254 snd_hda_codec_write(codec, PIN_NID, 0, AC_VERB_SET_HDMI_DIP_XMIT,
257 if (get_wcaps(codec, PIN_NID) & AC_WCAP_OUT_AMP)
258 snd_hda_codec_write(codec, PIN_NID, 0,
259 AC_VERB_SET_AMP_GAIN_MUTE, AMP_OUT_UNMUTE);
261 snd_hda_sequence_write(codec, pinout_enable_verb);
264 static void hdmi_disable_output(struct hda_codec *codec)
266 snd_hda_sequence_write(codec, pinout_disable_verb);
267 if (get_wcaps(codec, PIN_NID) & AC_WCAP_OUT_AMP)
268 snd_hda_codec_write(codec, PIN_NID, 0,
269 AC_VERB_SET_AMP_GAIN_MUTE, AMP_OUT_MUTE);
272 * FIXME: noises may arise when playing music after reloading the
273 * kernel module, until the next X restart or monitor repower.
277 static int hdmi_get_channel_count(struct hda_codec *codec)
279 return 1 + snd_hda_codec_read(codec, CVT_NID, 0,
280 AC_VERB_GET_CVT_CHAN_COUNT, 0);
283 static void hdmi_set_channel_count(struct hda_codec *codec, int chs)
285 snd_hda_codec_write(codec, CVT_NID, 0,
286 AC_VERB_SET_CVT_CHAN_COUNT, chs - 1);
288 if (chs != hdmi_get_channel_count(codec))
289 snd_printd(KERN_INFO "HDMI channel count: expect %d, get %d\n",
290 chs, hdmi_get_channel_count(codec));
293 static void hdmi_debug_channel_mapping(struct hda_codec *codec)
295 #ifdef CONFIG_SND_DEBUG_VERBOSE
299 for (i = 0; i < 8; i++) {
300 slot = snd_hda_codec_read(codec, CVT_NID, 0,
301 AC_VERB_GET_HDMI_CHAN_SLOT, i);
302 printk(KERN_DEBUG "HDMI: ASP channel %d => slot %d\n",
303 slot >> 4, slot & 0x7);
308 static void hdmi_parse_eld(struct hda_codec *codec)
310 struct intel_hdmi_spec *spec = codec->spec;
311 struct hdmi_eld *eld = &spec->sink_eld;
313 if (!snd_hdmi_get_eld(eld, codec, PIN_NID))
314 snd_hdmi_show_eld(eld);
319 * Audio InfoFrame routines
322 static void hdmi_debug_dip_size(struct hda_codec *codec)
324 #ifdef CONFIG_SND_DEBUG_VERBOSE
328 size = snd_hdmi_get_eld_size(codec, PIN_NID);
329 printk(KERN_DEBUG "HDMI: ELD buf size is %d\n", size);
331 for (i = 0; i < 8; i++) {
332 size = snd_hda_codec_read(codec, PIN_NID, 0,
333 AC_VERB_GET_HDMI_DIP_SIZE, i);
334 printk(KERN_DEBUG "HDMI: DIP GP[%d] buf size is %d\n", i, size);
339 static void hdmi_clear_dip_buffers(struct hda_codec *codec)
345 for (i = 0; i < 8; i++) {
346 size = snd_hda_codec_read(codec, PIN_NID, 0,
347 AC_VERB_GET_HDMI_DIP_SIZE, i);
351 hdmi_set_dip_index(codec, PIN_NID, i, 0x0);
352 for (j = 1; j < 1000; j++) {
353 hdmi_write_dip_byte(codec, PIN_NID, 0x0);
354 hdmi_get_dip_index(codec, PIN_NID, &pi, &bi);
356 snd_printd(KERN_INFO "dip index %d: %d != %d\n",
358 if (bi == 0) /* byte index wrapped around */
362 "HDMI: DIP GP[%d] buf reported size=%d, written=%d\n",
368 static void hdmi_fill_audio_infoframe(struct hda_codec *codec,
369 struct hdmi_audio_infoframe *ai)
371 u8 *params = (u8 *)ai;
374 hdmi_debug_dip_size(codec);
375 hdmi_clear_dip_buffers(codec); /* be paranoid */
377 hdmi_set_dip_index(codec, PIN_NID, 0x0, 0x0);
378 for (i = 0; i < sizeof(ai); i++)
379 hdmi_write_dip_byte(codec, PIN_NID, params[i]);
383 * Compute derived values in channel_allocations[].
385 static void init_channel_allocations(void)
388 struct cea_channel_speaker_allocation *p;
390 for (i = 0; i < ARRAY_SIZE(channel_allocations); i++) {
391 p = channel_allocations + i;
394 for (j = 0; j < ARRAY_SIZE(p->speakers); j++)
395 if (p->speakers[j]) {
397 p->spk_mask |= p->speakers[j];
403 * The transformation takes two steps:
405 * eld->spk_alloc => (eld_speaker_allocation_bits[]) => spk_mask
406 * spk_mask => (channel_allocations[]) => ai->CA
408 * TODO: it could select the wrong CA from multiple candidates.
410 static int hdmi_setup_channel_allocation(struct hda_codec *codec,
411 struct hdmi_audio_infoframe *ai)
413 struct intel_hdmi_spec *spec = codec->spec;
414 struct hdmi_eld *eld = &spec->sink_eld;
417 int channels = 1 + (ai->CC02_CT47 & 0x7);
418 char buf[SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE];
421 * CA defaults to 0 for basic stereo audio
431 * expand ELD's speaker allocation mask
433 * ELD tells the speaker mask in a compact(paired) form,
434 * expand ELD's notions to match the ones used by Audio InfoFrame.
436 for (i = 0; i < ARRAY_SIZE(eld_speaker_allocation_bits); i++) {
437 if (eld->spk_alloc & (1 << i))
438 spk_mask |= eld_speaker_allocation_bits[i];
441 /* search for the first working match in the CA table */
442 for (i = 0; i < ARRAY_SIZE(channel_allocations); i++) {
443 if (channels == channel_allocations[i].channels &&
444 (spk_mask & channel_allocations[i].spk_mask) ==
445 channel_allocations[i].spk_mask) {
446 ai->CA = channel_allocations[i].ca_index;
451 snd_print_channel_allocation(eld->spk_alloc, buf, sizeof(buf));
452 snd_printdd(KERN_INFO
453 "HDMI: select CA 0x%x for %d-channel allocation: %s\n",
454 ai->CA, channels, buf);
459 static void hdmi_setup_channel_mapping(struct hda_codec *codec,
460 struct hdmi_audio_infoframe *ai)
466 * TODO: adjust channel mapping if necessary
467 * ALSA sequence is front/surr/clfe/side?
470 snd_hda_sequence_write(codec, def_chan_map);
471 hdmi_debug_channel_mapping(codec);
475 static void hdmi_setup_audio_infoframe(struct hda_codec *codec,
476 struct snd_pcm_substream *substream)
478 struct hdmi_audio_infoframe ai = {
482 .CC02_CT47 = substream->runtime->channels - 1,
485 hdmi_setup_channel_allocation(codec, &ai);
486 hdmi_setup_channel_mapping(codec, &ai);
488 hdmi_fill_audio_infoframe(codec, &ai);
496 static void hdmi_intrinsic_event(struct hda_codec *codec, unsigned int res)
498 int pind = !!(res & AC_UNSOL_RES_PD);
499 int eldv = !!(res & AC_UNSOL_RES_ELDV);
502 "HDMI hot plug event: Presence_Detect=%d ELD_Valid=%d\n",
506 hdmi_parse_eld(codec);
507 /* TODO: do real things about ELD */
511 static void hdmi_non_intrinsic_event(struct hda_codec *codec, unsigned int res)
513 int subtag = (res & AC_UNSOL_RES_SUBTAG) >> AC_UNSOL_RES_SUBTAG_SHIFT;
514 int cp_state = !!(res & AC_UNSOL_RES_CP_STATE);
515 int cp_ready = !!(res & AC_UNSOL_RES_CP_READY);
518 "HDMI content protection event: SUBTAG=0x%x CP_STATE=%d CP_READY=%d\n",
531 static void intel_hdmi_unsol_event(struct hda_codec *codec, unsigned int res)
533 int tag = res >> AC_UNSOL_RES_TAG_SHIFT;
534 int subtag = (res & AC_UNSOL_RES_SUBTAG) >> AC_UNSOL_RES_SUBTAG_SHIFT;
536 if (tag != INTEL_HDMI_EVENT_TAG) {
537 snd_printd(KERN_INFO "Unexpected HDMI event tag 0x%x\n", tag);
542 hdmi_intrinsic_event(codec, res);
544 hdmi_non_intrinsic_event(codec, res);
551 static int intel_hdmi_playback_pcm_open(struct hda_pcm_stream *hinfo,
552 struct hda_codec *codec,
553 struct snd_pcm_substream *substream)
555 struct intel_hdmi_spec *spec = codec->spec;
557 return snd_hda_multi_out_dig_open(codec, &spec->multiout);
560 static int intel_hdmi_playback_pcm_close(struct hda_pcm_stream *hinfo,
561 struct hda_codec *codec,
562 struct snd_pcm_substream *substream)
564 struct intel_hdmi_spec *spec = codec->spec;
566 hdmi_disable_output(codec);
568 return snd_hda_multi_out_dig_close(codec, &spec->multiout);
571 static int intel_hdmi_playback_pcm_prepare(struct hda_pcm_stream *hinfo,
572 struct hda_codec *codec,
573 unsigned int stream_tag,
575 struct snd_pcm_substream *substream)
577 struct intel_hdmi_spec *spec = codec->spec;
579 snd_hda_multi_out_dig_prepare(codec, &spec->multiout, stream_tag,
582 hdmi_set_channel_count(codec, substream->runtime->channels);
584 hdmi_setup_audio_infoframe(codec, substream);
586 hdmi_enable_output(codec);
591 static struct hda_pcm_stream intel_hdmi_pcm_playback = {
595 .nid = CVT_NID, /* NID to query formats and rates and setup streams */
597 .open = intel_hdmi_playback_pcm_open,
598 .close = intel_hdmi_playback_pcm_close,
599 .prepare = intel_hdmi_playback_pcm_prepare
603 static int intel_hdmi_build_pcms(struct hda_codec *codec)
605 struct intel_hdmi_spec *spec = codec->spec;
606 struct hda_pcm *info = &spec->pcm_rec;
609 codec->pcm_info = info;
611 info->name = "INTEL HDMI";
612 info->pcm_type = HDA_PCM_TYPE_HDMI;
613 info->stream[SNDRV_PCM_STREAM_PLAYBACK] = intel_hdmi_pcm_playback;
618 static int intel_hdmi_build_controls(struct hda_codec *codec)
620 struct intel_hdmi_spec *spec = codec->spec;
623 err = snd_hda_create_spdif_out_ctls(codec, spec->multiout.dig_out_nid);
630 static int intel_hdmi_init(struct hda_codec *codec)
632 /* disable audio output as early as possible */
633 hdmi_disable_output(codec);
635 snd_hda_sequence_write(codec, unsolicited_response_verb);
640 static void intel_hdmi_free(struct hda_codec *codec)
642 struct intel_hdmi_spec *spec = codec->spec;
644 snd_hda_eld_proc_free(codec, &spec->sink_eld);
648 static struct hda_codec_ops intel_hdmi_patch_ops = {
649 .init = intel_hdmi_init,
650 .free = intel_hdmi_free,
651 .build_pcms = intel_hdmi_build_pcms,
652 .build_controls = intel_hdmi_build_controls,
653 .unsol_event = intel_hdmi_unsol_event,
656 static int patch_intel_hdmi(struct hda_codec *codec)
658 struct intel_hdmi_spec *spec;
660 spec = kzalloc(sizeof(*spec), GFP_KERNEL);
664 spec->multiout.num_dacs = 0; /* no analog */
665 spec->multiout.max_channels = 8;
666 spec->multiout.dig_out_nid = CVT_NID;
669 codec->patch_ops = intel_hdmi_patch_ops;
671 snd_hda_eld_proc_new(codec, &spec->sink_eld);
673 init_channel_allocations();
678 struct hda_codec_preset snd_hda_preset_intelhdmi[] = {
679 { .id = 0x808629fb, .name = "INTEL G45 DEVCL", .patch = patch_intel_hdmi },
680 { .id = 0x80862801, .name = "INTEL G45 DEVBLC", .patch = patch_intel_hdmi },
681 { .id = 0x80862802, .name = "INTEL G45 DEVCTG", .patch = patch_intel_hdmi },
682 { .id = 0x80862803, .name = "INTEL G45 DEVELK", .patch = patch_intel_hdmi },
683 { .id = 0x10951392, .name = "SiI1392 HDMI", .patch = patch_intel_hdmi },