2 * Generic routines and proc interface for ELD(EDID Like Data) information
4 * Copyright(c) 2008 Intel Corporation.
7 * Wu Fengguang <wfg@linux.intel.com>
9 * This driver is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This driver is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/init.h>
25 #include <linux/slab.h>
26 #include <sound/core.h>
27 #include <asm/unaligned.h>
28 #include "hda_codec.h"
29 #include "hda_local.h"
36 enum cea_edid_versions {
37 CEA_EDID_VER_NONE = 0,
38 CEA_EDID_VER_CEA861 = 1,
39 CEA_EDID_VER_CEA861A = 2,
40 CEA_EDID_VER_CEA861BCD = 3,
41 CEA_EDID_VER_RESERVED = 4,
44 static char *cea_speaker_allocation_names[] = {
58 static char *eld_connection_type_names[4] = {
65 enum cea_audio_coding_types {
66 AUDIO_CODING_TYPE_REF_STREAM_HEADER = 0,
67 AUDIO_CODING_TYPE_LPCM = 1,
68 AUDIO_CODING_TYPE_AC3 = 2,
69 AUDIO_CODING_TYPE_MPEG1 = 3,
70 AUDIO_CODING_TYPE_MP3 = 4,
71 AUDIO_CODING_TYPE_MPEG2 = 5,
72 AUDIO_CODING_TYPE_AACLC = 6,
73 AUDIO_CODING_TYPE_DTS = 7,
74 AUDIO_CODING_TYPE_ATRAC = 8,
75 AUDIO_CODING_TYPE_SACD = 9,
76 AUDIO_CODING_TYPE_EAC3 = 10,
77 AUDIO_CODING_TYPE_DTS_HD = 11,
78 AUDIO_CODING_TYPE_MLP = 12,
79 AUDIO_CODING_TYPE_DST = 13,
80 AUDIO_CODING_TYPE_WMAPRO = 14,
81 AUDIO_CODING_TYPE_REF_CXT = 15,
82 /* also include valid xtypes below */
83 AUDIO_CODING_TYPE_HE_AAC = 15,
84 AUDIO_CODING_TYPE_HE_AAC2 = 16,
85 AUDIO_CODING_TYPE_MPEG_SURROUND = 17,
88 enum cea_audio_coding_xtypes {
89 AUDIO_CODING_XTYPE_HE_REF_CT = 0,
90 AUDIO_CODING_XTYPE_HE_AAC = 1,
91 AUDIO_CODING_XTYPE_HE_AAC2 = 2,
92 AUDIO_CODING_XTYPE_MPEG_SURROUND = 3,
93 AUDIO_CODING_XTYPE_FIRST_RESERVED = 4,
96 static char *cea_audio_coding_type_names[] = {
106 /* 9 */ "DSD (One Bit Audio)",
107 /* 10 */ "E-AC-3/DD+ (Dolby Digital Plus)",
109 /* 12 */ "MLP (Dolby TrueHD)",
114 /* 17 */ "MPEG Surround",
118 * The following two lists are shared between
119 * - HDMI audio InfoFrame (source to sink)
120 * - CEA E-EDID Extension (sink to source)
124 * SS1:SS0 index => sample size
126 static int cea_sample_sizes[4] = {
127 0, /* 0: Refer to Stream Header */
128 AC_SUPPCM_BITS_16, /* 1: 16 bits */
129 AC_SUPPCM_BITS_20, /* 2: 20 bits */
130 AC_SUPPCM_BITS_24, /* 3: 24 bits */
134 * SF2:SF1:SF0 index => sampling frequency
136 static int cea_sampling_frequencies[8] = {
137 0, /* 0: Refer to Stream Header */
138 SNDRV_PCM_RATE_32000, /* 1: 32000Hz */
139 SNDRV_PCM_RATE_44100, /* 2: 44100Hz */
140 SNDRV_PCM_RATE_48000, /* 3: 48000Hz */
141 SNDRV_PCM_RATE_88200, /* 4: 88200Hz */
142 SNDRV_PCM_RATE_96000, /* 5: 96000Hz */
143 SNDRV_PCM_RATE_176400, /* 6: 176400Hz */
144 SNDRV_PCM_RATE_192000, /* 7: 192000Hz */
147 static unsigned char hdmi_get_eld_byte(struct hda_codec *codec, hda_nid_t nid,
152 val = snd_hda_codec_read(codec, nid, 0,
153 AC_VERB_GET_HDMI_ELDD, byte_index);
156 printk(KERN_INFO "HDMI: ELD data byte %d: 0x%x\n", byte_index, val);
159 if ((val & AC_ELDD_ELD_VALID) == 0) {
160 snd_printd(KERN_INFO "HDMI: invalid ELD data byte %d\n",
165 return val & AC_ELDD_ELD_DATA;
168 #define GRAB_BITS(buf, byte, lowbit, bits) \
170 BUILD_BUG_ON(lowbit > 7); \
171 BUILD_BUG_ON(bits > 8); \
172 BUILD_BUG_ON(bits <= 0); \
174 (buf[byte] >> (lowbit)) & ((1 << (bits)) - 1); \
177 static void hdmi_update_short_audio_desc(struct cea_sad *a,
178 const unsigned char *buf)
183 val = GRAB_BITS(buf, 1, 0, 7);
185 for (i = 0; i < 7; i++)
187 a->rates |= cea_sampling_frequencies[i + 1];
189 a->channels = GRAB_BITS(buf, 0, 0, 3);
192 a->format = GRAB_BITS(buf, 0, 3, 4);
194 case AUDIO_CODING_TYPE_REF_STREAM_HEADER:
196 "HDMI: audio coding type 0 not expected\n");
199 case AUDIO_CODING_TYPE_LPCM:
200 val = GRAB_BITS(buf, 2, 0, 3);
202 for (i = 0; i < 3; i++)
204 a->sample_bits |= cea_sample_sizes[i + 1];
207 case AUDIO_CODING_TYPE_AC3:
208 case AUDIO_CODING_TYPE_MPEG1:
209 case AUDIO_CODING_TYPE_MP3:
210 case AUDIO_CODING_TYPE_MPEG2:
211 case AUDIO_CODING_TYPE_AACLC:
212 case AUDIO_CODING_TYPE_DTS:
213 case AUDIO_CODING_TYPE_ATRAC:
214 a->max_bitrate = GRAB_BITS(buf, 2, 0, 8);
215 a->max_bitrate *= 8000;
218 case AUDIO_CODING_TYPE_SACD:
221 case AUDIO_CODING_TYPE_EAC3:
224 case AUDIO_CODING_TYPE_DTS_HD:
227 case AUDIO_CODING_TYPE_MLP:
230 case AUDIO_CODING_TYPE_DST:
233 case AUDIO_CODING_TYPE_WMAPRO:
234 a->profile = GRAB_BITS(buf, 2, 0, 3);
237 case AUDIO_CODING_TYPE_REF_CXT:
238 a->format = GRAB_BITS(buf, 2, 3, 5);
239 if (a->format == AUDIO_CODING_XTYPE_HE_REF_CT ||
240 a->format >= AUDIO_CODING_XTYPE_FIRST_RESERVED) {
242 "HDMI: audio coding xtype %d not expected\n",
246 a->format += AUDIO_CODING_TYPE_HE_AAC -
247 AUDIO_CODING_XTYPE_HE_AAC;
253 * Be careful, ELD buf could be totally rubbish!
255 static int hdmi_update_eld(struct hdmi_eld *e,
256 const unsigned char *buf, int size)
261 e->eld_ver = GRAB_BITS(buf, 0, 3, 5);
262 if (e->eld_ver != ELD_VER_CEA_861D &&
263 e->eld_ver != ELD_VER_PARTIAL) {
264 snd_printd(KERN_INFO "HDMI: Unknown ELD version %d\n",
270 e->baseline_len = GRAB_BITS(buf, 2, 0, 8);
271 mnl = GRAB_BITS(buf, 4, 0, 5);
272 e->cea_edid_ver = GRAB_BITS(buf, 4, 5, 3);
274 e->support_hdcp = GRAB_BITS(buf, 5, 0, 1);
275 e->support_ai = GRAB_BITS(buf, 5, 1, 1);
276 e->conn_type = GRAB_BITS(buf, 5, 2, 2);
277 e->sad_count = GRAB_BITS(buf, 5, 4, 4);
279 e->aud_synch_delay = GRAB_BITS(buf, 6, 0, 8) * 2;
280 e->spk_alloc = GRAB_BITS(buf, 7, 0, 7);
282 e->port_id = get_unaligned_le64(buf + 8);
284 /* not specified, but the spec's tendency is little endian */
285 e->manufacture_id = get_unaligned_le16(buf + 16);
286 e->product_id = get_unaligned_le16(buf + 18);
288 if (mnl > ELD_MAX_MNL) {
289 snd_printd(KERN_INFO "HDMI: MNL is reserved value %d\n", mnl);
291 } else if (ELD_FIXED_BYTES + mnl > size) {
292 snd_printd(KERN_INFO "HDMI: out of range MNL %d\n", mnl);
295 strlcpy(e->monitor_name, buf + ELD_FIXED_BYTES, mnl);
297 for (i = 0; i < e->sad_count; i++) {
298 if (ELD_FIXED_BYTES + mnl + 3 * (i + 1) > size) {
299 snd_printd(KERN_INFO "HDMI: out of range SAD %d\n", i);
302 hdmi_update_short_audio_desc(e->sad + i,
303 buf + ELD_FIXED_BYTES + mnl + 3 * i);
313 static int hdmi_eld_valid(struct hda_codec *codec, hda_nid_t nid)
318 present = snd_hda_pin_sense(codec, nid);
319 eldv = (present & AC_PINSENSE_ELDV);
320 present = (present & AC_PINSENSE_PRESENCE);
322 #ifdef CONFIG_SND_DEBUG_VERBOSE
323 printk(KERN_INFO "HDMI: sink_present = %d, eld_valid = %d\n",
327 return eldv && present;
330 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid)
332 return snd_hda_codec_read(codec, nid, 0, AC_VERB_GET_HDMI_DIP_SIZE,
336 int snd_hdmi_get_eld(struct hdmi_eld *eld,
337 struct hda_codec *codec, hda_nid_t nid)
344 if (!hdmi_eld_valid(codec, nid))
347 size = snd_hdmi_get_eld_size(codec, nid);
349 /* wfg: workaround for ASUS P5E-VM HDMI board */
350 snd_printd(KERN_INFO "HDMI: ELD buf size is 0, force 128\n");
353 if (size < ELD_FIXED_BYTES || size > PAGE_SIZE) {
354 snd_printd(KERN_INFO "HDMI: invalid ELD buf size %d\n", size);
358 buf = kmalloc(size, GFP_KERNEL);
362 for (i = 0; i < size; i++)
363 buf[i] = hdmi_get_eld_byte(codec, nid, i);
365 ret = hdmi_update_eld(eld, buf, size);
371 static void hdmi_show_short_audio_desc(struct cea_sad *a)
373 char buf[SND_PRINT_RATES_ADVISED_BUFSIZE];
374 char buf2[8 + SND_PRINT_BITS_ADVISED_BUFSIZE] = ", bits =";
379 snd_print_pcm_rates(a->rates, buf, sizeof(buf));
381 if (a->format == AUDIO_CODING_TYPE_LPCM)
382 snd_print_pcm_bits(a->sample_bits, buf2 + 8, sizeof(buf2 - 8));
383 else if (a->max_bitrate)
384 snprintf(buf2, sizeof(buf2),
385 ", max bitrate = %d", a->max_bitrate);
389 printk(KERN_INFO "HDMI: supports coding type %s:"
390 " channels = %d, rates =%s%s\n",
391 cea_audio_coding_type_names[a->format],
397 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen)
401 for (i = 0, j = 0; i < ARRAY_SIZE(cea_speaker_allocation_names); i++) {
402 if (spk_alloc & (1 << i))
403 j += snprintf(buf + j, buflen - j, " %s",
404 cea_speaker_allocation_names[i]);
406 buf[j] = '\0'; /* necessary when j == 0 */
409 void snd_hdmi_show_eld(struct hdmi_eld *e)
413 printk(KERN_INFO "HDMI: detected monitor %s at connection type %s\n",
415 eld_connection_type_names[e->conn_type]);
418 char buf[SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE];
419 snd_print_channel_allocation(e->spk_alloc, buf, sizeof(buf));
420 printk(KERN_INFO "HDMI: available speakers:%s\n", buf);
423 for (i = 0; i < e->sad_count; i++)
424 hdmi_show_short_audio_desc(e->sad + i);
427 #ifdef CONFIG_PROC_FS
429 static void hdmi_print_sad_info(int i, struct cea_sad *a,
430 struct snd_info_buffer *buffer)
432 char buf[SND_PRINT_RATES_ADVISED_BUFSIZE];
434 snd_iprintf(buffer, "sad%d_coding_type\t[0x%x] %s\n",
435 i, a->format, cea_audio_coding_type_names[a->format]);
436 snd_iprintf(buffer, "sad%d_channels\t\t%d\n", i, a->channels);
438 snd_print_pcm_rates(a->rates, buf, sizeof(buf));
439 snd_iprintf(buffer, "sad%d_rates\t\t[0x%x]%s\n", i, a->rates, buf);
441 if (a->format == AUDIO_CODING_TYPE_LPCM) {
442 snd_print_pcm_bits(a->sample_bits, buf, sizeof(buf));
443 snd_iprintf(buffer, "sad%d_bits\t\t[0x%x]%s\n",
444 i, a->sample_bits, buf);
448 snd_iprintf(buffer, "sad%d_max_bitrate\t%d\n",
452 snd_iprintf(buffer, "sad%d_profile\t\t%d\n", i, a->profile);
455 static void hdmi_print_eld_info(struct snd_info_entry *entry,
456 struct snd_info_buffer *buffer)
458 struct hdmi_eld *e = entry->private_data;
459 char buf[SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE];
461 static char *eld_versoin_names[32] = {
465 [3 ... 30] = "reserved",
468 static char *cea_edid_version_names[8] = {
469 "no CEA EDID Timing Extension block present",
473 [4 ... 7] = "reserved"
476 snd_iprintf(buffer, "monitor_present\t\t%d\n", e->monitor_present);
477 snd_iprintf(buffer, "eld_valid\t\t%d\n", e->eld_valid);
478 snd_iprintf(buffer, "monitor_name\t\t%s\n", e->monitor_name);
479 snd_iprintf(buffer, "connection_type\t\t%s\n",
480 eld_connection_type_names[e->conn_type]);
481 snd_iprintf(buffer, "eld_version\t\t[0x%x] %s\n", e->eld_ver,
482 eld_versoin_names[e->eld_ver]);
483 snd_iprintf(buffer, "edid_version\t\t[0x%x] %s\n", e->cea_edid_ver,
484 cea_edid_version_names[e->cea_edid_ver]);
485 snd_iprintf(buffer, "manufacture_id\t\t0x%x\n", e->manufacture_id);
486 snd_iprintf(buffer, "product_id\t\t0x%x\n", e->product_id);
487 snd_iprintf(buffer, "port_id\t\t\t0x%llx\n", (long long)e->port_id);
488 snd_iprintf(buffer, "support_hdcp\t\t%d\n", e->support_hdcp);
489 snd_iprintf(buffer, "support_ai\t\t%d\n", e->support_ai);
490 snd_iprintf(buffer, "audio_sync_delay\t%d\n", e->aud_synch_delay);
492 snd_print_channel_allocation(e->spk_alloc, buf, sizeof(buf));
493 snd_iprintf(buffer, "speakers\t\t[0x%x]%s\n", e->spk_alloc, buf);
495 snd_iprintf(buffer, "sad_count\t\t%d\n", e->sad_count);
497 for (i = 0; i < e->sad_count; i++)
498 hdmi_print_sad_info(i, e->sad + i, buffer);
501 static void hdmi_write_eld_info(struct snd_info_entry *entry,
502 struct snd_info_buffer *buffer)
504 struct hdmi_eld *e = entry->private_data;
511 while (!snd_info_get_line(buffer, line, sizeof(line))) {
512 if (sscanf(line, "%s %llx", name, &val) != 2)
515 * We don't allow modification to these fields:
516 * monitor_name manufacture_id product_id
517 * eld_version edid_version
519 if (!strcmp(name, "monitor_present"))
520 e->monitor_present = val;
521 else if (!strcmp(name, "eld_valid"))
523 else if (!strcmp(name, "connection_type"))
525 else if (!strcmp(name, "port_id"))
527 else if (!strcmp(name, "support_hdcp"))
528 e->support_hdcp = val;
529 else if (!strcmp(name, "support_ai"))
531 else if (!strcmp(name, "audio_sync_delay"))
532 e->aud_synch_delay = val;
533 else if (!strcmp(name, "speakers"))
535 else if (!strcmp(name, "sad_count"))
537 else if (!strncmp(name, "sad", 3)) {
540 if (name[4] >= '0' && name[4] <= '9') {
542 n = 10 * n + name[4] - '0';
544 if (n >= ELD_MAX_SAD)
546 if (!strcmp(sname, "_coding_type"))
547 e->sad[n].format = val;
548 else if (!strcmp(sname, "_channels"))
549 e->sad[n].channels = val;
550 else if (!strcmp(sname, "_rates"))
551 e->sad[n].rates = val;
552 else if (!strcmp(sname, "_bits"))
553 e->sad[n].sample_bits = val;
554 else if (!strcmp(sname, "_max_bitrate"))
555 e->sad[n].max_bitrate = val;
556 else if (!strcmp(sname, "_profile"))
557 e->sad[n].profile = val;
558 if (n >= e->sad_count)
559 e->sad_count = n + 1;
565 int snd_hda_eld_proc_new(struct hda_codec *codec, struct hdmi_eld *eld,
569 struct snd_info_entry *entry;
572 snprintf(name, sizeof(name), "eld#%d.%d", codec->addr, index);
573 err = snd_card_proc_new(codec->bus->card, name, &entry);
577 snd_info_set_text_ops(entry, eld, hdmi_print_eld_info);
578 entry->c.text.write = hdmi_write_eld_info;
579 entry->mode |= S_IWUSR;
580 eld->proc_entry = entry;
585 void snd_hda_eld_proc_free(struct hda_codec *codec, struct hdmi_eld *eld)
587 if (!codec->bus->shutdown && eld->proc_entry) {
588 snd_device_free(codec->bus->card, eld->proc_entry);
589 eld->proc_entry = NULL;
593 #endif /* CONFIG_PROC_FS */
595 /* update PCM info based on ELD */
596 void hdmi_eld_update_pcm_info(struct hdmi_eld *eld, struct hda_pcm_stream *pcm,
597 struct hda_pcm_stream *codec_pars)
604 pcm->channels_max = 0;
605 for (i = 0; i < eld->sad_count; i++) {
606 struct cea_sad *a = &eld->sad[i];
607 pcm->rates |= a->rates;
608 if (a->channels > pcm->channels_max)
609 pcm->channels_max = a->channels;
610 if (a->format == AUDIO_CODING_TYPE_LPCM) {
611 if (a->sample_bits & AC_SUPPCM_BITS_16) {
612 pcm->formats |= SNDRV_PCM_FMTBIT_S16_LE;
613 if (pcm->maxbps < 16)
616 if (a->sample_bits & AC_SUPPCM_BITS_20) {
617 pcm->formats |= SNDRV_PCM_FMTBIT_S32_LE;
618 if (pcm->maxbps < 20)
621 if (a->sample_bits & AC_SUPPCM_BITS_24) {
622 pcm->formats |= SNDRV_PCM_FMTBIT_S32_LE;
623 if (pcm->maxbps < 24)
632 /* restrict the parameters by the values the codec provides */
633 pcm->rates &= codec_pars->rates;
634 pcm->formats &= codec_pars->formats;
635 pcm->channels_max = min(pcm->channels_max, codec_pars->channels_max);
636 pcm->maxbps = min(pcm->maxbps, codec_pars->maxbps);