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);
195 a->format = GRAB_BITS(buf, 0, 3, 4);
197 case AUDIO_CODING_TYPE_REF_STREAM_HEADER:
199 "HDMI: audio coding type 0 not expected\n");
202 case AUDIO_CODING_TYPE_LPCM:
203 val = GRAB_BITS(buf, 2, 0, 3);
204 for (i = 0; i < 3; i++)
206 a->sample_bits |= cea_sample_sizes[i + 1];
209 case AUDIO_CODING_TYPE_AC3:
210 case AUDIO_CODING_TYPE_MPEG1:
211 case AUDIO_CODING_TYPE_MP3:
212 case AUDIO_CODING_TYPE_MPEG2:
213 case AUDIO_CODING_TYPE_AACLC:
214 case AUDIO_CODING_TYPE_DTS:
215 case AUDIO_CODING_TYPE_ATRAC:
216 a->max_bitrate = GRAB_BITS(buf, 2, 0, 8);
217 a->max_bitrate *= 8000;
220 case AUDIO_CODING_TYPE_SACD:
223 case AUDIO_CODING_TYPE_EAC3:
226 case AUDIO_CODING_TYPE_DTS_HD:
229 case AUDIO_CODING_TYPE_MLP:
232 case AUDIO_CODING_TYPE_DST:
235 case AUDIO_CODING_TYPE_WMAPRO:
236 a->profile = GRAB_BITS(buf, 2, 0, 3);
239 case AUDIO_CODING_TYPE_REF_CXT:
240 a->format = GRAB_BITS(buf, 2, 3, 5);
241 if (a->format == AUDIO_CODING_XTYPE_HE_REF_CT ||
242 a->format >= AUDIO_CODING_XTYPE_FIRST_RESERVED) {
244 "HDMI: audio coding xtype %d not expected\n",
248 a->format += AUDIO_CODING_TYPE_HE_AAC -
249 AUDIO_CODING_XTYPE_HE_AAC;
255 * Be careful, ELD buf could be totally rubbish!
257 static int hdmi_update_eld(struct hdmi_eld *e,
258 const unsigned char *buf, int size)
263 e->eld_ver = GRAB_BITS(buf, 0, 3, 5);
264 if (e->eld_ver != ELD_VER_CEA_861D &&
265 e->eld_ver != ELD_VER_PARTIAL) {
266 snd_printd(KERN_INFO "HDMI: Unknown ELD version %d\n",
272 e->baseline_len = GRAB_BITS(buf, 2, 0, 8);
273 mnl = GRAB_BITS(buf, 4, 0, 5);
274 e->cea_edid_ver = GRAB_BITS(buf, 4, 5, 3);
276 e->support_hdcp = GRAB_BITS(buf, 5, 0, 1);
277 e->support_ai = GRAB_BITS(buf, 5, 1, 1);
278 e->conn_type = GRAB_BITS(buf, 5, 2, 2);
279 e->sad_count = GRAB_BITS(buf, 5, 4, 4);
281 e->aud_synch_delay = GRAB_BITS(buf, 6, 0, 8) * 2;
282 e->spk_alloc = GRAB_BITS(buf, 7, 0, 7);
284 e->port_id = get_unaligned_le64(buf + 8);
286 /* not specified, but the spec's tendency is little endian */
287 e->manufacture_id = get_unaligned_le16(buf + 16);
288 e->product_id = get_unaligned_le16(buf + 18);
290 if (mnl > ELD_MAX_MNL) {
291 snd_printd(KERN_INFO "HDMI: MNL is reserved value %d\n", mnl);
293 } else if (ELD_FIXED_BYTES + mnl > size) {
294 snd_printd(KERN_INFO "HDMI: out of range MNL %d\n", mnl);
297 strlcpy(e->monitor_name, buf + ELD_FIXED_BYTES, mnl + 1);
299 for (i = 0; i < e->sad_count; i++) {
300 if (ELD_FIXED_BYTES + mnl + 3 * (i + 1) > size) {
301 snd_printd(KERN_INFO "HDMI: out of range SAD %d\n", i);
304 hdmi_update_short_audio_desc(e->sad + i,
305 buf + ELD_FIXED_BYTES + mnl + 3 * i);
315 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid)
317 return snd_hda_codec_read(codec, nid, 0, AC_VERB_GET_HDMI_DIP_SIZE,
321 int snd_hdmi_get_eld(struct hdmi_eld *eld,
322 struct hda_codec *codec, hda_nid_t nid)
332 size = snd_hdmi_get_eld_size(codec, nid);
334 /* wfg: workaround for ASUS P5E-VM HDMI board */
335 snd_printd(KERN_INFO "HDMI: ELD buf size is 0, force 128\n");
338 if (size < ELD_FIXED_BYTES || size > PAGE_SIZE) {
339 snd_printd(KERN_INFO "HDMI: invalid ELD buf size %d\n", size);
343 buf = kmalloc(size, GFP_KERNEL);
347 for (i = 0; i < size; i++)
348 buf[i] = hdmi_get_eld_byte(codec, nid, i);
350 ret = hdmi_update_eld(eld, buf, size);
356 static void hdmi_show_short_audio_desc(struct cea_sad *a)
358 char buf[SND_PRINT_RATES_ADVISED_BUFSIZE];
359 char buf2[8 + SND_PRINT_BITS_ADVISED_BUFSIZE] = ", bits =";
364 snd_print_pcm_rates(a->rates, buf, sizeof(buf));
366 if (a->format == AUDIO_CODING_TYPE_LPCM)
367 snd_print_pcm_bits(a->sample_bits, buf2 + 8, sizeof(buf2) - 8);
368 else if (a->max_bitrate)
369 snprintf(buf2, sizeof(buf2),
370 ", max bitrate = %d", a->max_bitrate);
374 printk(KERN_INFO "HDMI: supports coding type %s:"
375 " channels = %d, rates =%s%s\n",
376 cea_audio_coding_type_names[a->format],
382 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen)
386 for (i = 0, j = 0; i < ARRAY_SIZE(cea_speaker_allocation_names); i++) {
387 if (spk_alloc & (1 << i))
388 j += snprintf(buf + j, buflen - j, " %s",
389 cea_speaker_allocation_names[i]);
391 buf[j] = '\0'; /* necessary when j == 0 */
394 void snd_hdmi_show_eld(struct hdmi_eld *e)
398 printk(KERN_INFO "HDMI: detected monitor %s at connection type %s\n",
400 eld_connection_type_names[e->conn_type]);
403 char buf[SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE];
404 snd_print_channel_allocation(e->spk_alloc, buf, sizeof(buf));
405 printk(KERN_INFO "HDMI: available speakers:%s\n", buf);
408 for (i = 0; i < e->sad_count; i++)
409 hdmi_show_short_audio_desc(e->sad + i);
412 #ifdef CONFIG_PROC_FS
414 static void hdmi_print_sad_info(int i, struct cea_sad *a,
415 struct snd_info_buffer *buffer)
417 char buf[SND_PRINT_RATES_ADVISED_BUFSIZE];
419 snd_iprintf(buffer, "sad%d_coding_type\t[0x%x] %s\n",
420 i, a->format, cea_audio_coding_type_names[a->format]);
421 snd_iprintf(buffer, "sad%d_channels\t\t%d\n", i, a->channels);
423 snd_print_pcm_rates(a->rates, buf, sizeof(buf));
424 snd_iprintf(buffer, "sad%d_rates\t\t[0x%x]%s\n", i, a->rates, buf);
426 if (a->format == AUDIO_CODING_TYPE_LPCM) {
427 snd_print_pcm_bits(a->sample_bits, buf, sizeof(buf));
428 snd_iprintf(buffer, "sad%d_bits\t\t[0x%x]%s\n",
429 i, a->sample_bits, buf);
433 snd_iprintf(buffer, "sad%d_max_bitrate\t%d\n",
437 snd_iprintf(buffer, "sad%d_profile\t\t%d\n", i, a->profile);
440 static void hdmi_print_eld_info(struct snd_info_entry *entry,
441 struct snd_info_buffer *buffer)
443 struct hdmi_eld *e = entry->private_data;
444 char buf[SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE];
446 static char *eld_versoin_names[32] = {
450 [3 ... 30] = "reserved",
453 static char *cea_edid_version_names[8] = {
454 "no CEA EDID Timing Extension block present",
458 [4 ... 7] = "reserved"
461 snd_iprintf(buffer, "monitor_present\t\t%d\n", e->monitor_present);
462 snd_iprintf(buffer, "eld_valid\t\t%d\n", e->eld_valid);
465 snd_iprintf(buffer, "monitor_name\t\t%s\n", e->monitor_name);
466 snd_iprintf(buffer, "connection_type\t\t%s\n",
467 eld_connection_type_names[e->conn_type]);
468 snd_iprintf(buffer, "eld_version\t\t[0x%x] %s\n", e->eld_ver,
469 eld_versoin_names[e->eld_ver]);
470 snd_iprintf(buffer, "edid_version\t\t[0x%x] %s\n", e->cea_edid_ver,
471 cea_edid_version_names[e->cea_edid_ver]);
472 snd_iprintf(buffer, "manufacture_id\t\t0x%x\n", e->manufacture_id);
473 snd_iprintf(buffer, "product_id\t\t0x%x\n", e->product_id);
474 snd_iprintf(buffer, "port_id\t\t\t0x%llx\n", (long long)e->port_id);
475 snd_iprintf(buffer, "support_hdcp\t\t%d\n", e->support_hdcp);
476 snd_iprintf(buffer, "support_ai\t\t%d\n", e->support_ai);
477 snd_iprintf(buffer, "audio_sync_delay\t%d\n", e->aud_synch_delay);
479 snd_print_channel_allocation(e->spk_alloc, buf, sizeof(buf));
480 snd_iprintf(buffer, "speakers\t\t[0x%x]%s\n", e->spk_alloc, buf);
482 snd_iprintf(buffer, "sad_count\t\t%d\n", e->sad_count);
484 for (i = 0; i < e->sad_count; i++)
485 hdmi_print_sad_info(i, e->sad + i, buffer);
488 static void hdmi_write_eld_info(struct snd_info_entry *entry,
489 struct snd_info_buffer *buffer)
491 struct hdmi_eld *e = entry->private_data;
498 while (!snd_info_get_line(buffer, line, sizeof(line))) {
499 if (sscanf(line, "%s %llx", name, &val) != 2)
502 * We don't allow modification to these fields:
503 * monitor_name manufacture_id product_id
504 * eld_version edid_version
506 if (!strcmp(name, "monitor_present"))
507 e->monitor_present = val;
508 else if (!strcmp(name, "eld_valid"))
510 else if (!strcmp(name, "connection_type"))
512 else if (!strcmp(name, "port_id"))
514 else if (!strcmp(name, "support_hdcp"))
515 e->support_hdcp = val;
516 else if (!strcmp(name, "support_ai"))
518 else if (!strcmp(name, "audio_sync_delay"))
519 e->aud_synch_delay = val;
520 else if (!strcmp(name, "speakers"))
522 else if (!strcmp(name, "sad_count"))
524 else if (!strncmp(name, "sad", 3)) {
527 if (name[4] >= '0' && name[4] <= '9') {
529 n = 10 * n + name[4] - '0';
531 if (n >= ELD_MAX_SAD)
533 if (!strcmp(sname, "_coding_type"))
534 e->sad[n].format = val;
535 else if (!strcmp(sname, "_channels"))
536 e->sad[n].channels = val;
537 else if (!strcmp(sname, "_rates"))
538 e->sad[n].rates = val;
539 else if (!strcmp(sname, "_bits"))
540 e->sad[n].sample_bits = val;
541 else if (!strcmp(sname, "_max_bitrate"))
542 e->sad[n].max_bitrate = val;
543 else if (!strcmp(sname, "_profile"))
544 e->sad[n].profile = val;
545 if (n >= e->sad_count)
546 e->sad_count = n + 1;
552 int snd_hda_eld_proc_new(struct hda_codec *codec, struct hdmi_eld *eld,
556 struct snd_info_entry *entry;
559 snprintf(name, sizeof(name), "eld#%d.%d", codec->addr, index);
560 err = snd_card_proc_new(codec->bus->card, name, &entry);
564 snd_info_set_text_ops(entry, eld, hdmi_print_eld_info);
565 entry->c.text.write = hdmi_write_eld_info;
566 entry->mode |= S_IWUSR;
567 eld->proc_entry = entry;
572 void snd_hda_eld_proc_free(struct hda_codec *codec, struct hdmi_eld *eld)
574 if (!codec->bus->shutdown && eld->proc_entry) {
575 snd_device_free(codec->bus->card, eld->proc_entry);
576 eld->proc_entry = NULL;
580 #endif /* CONFIG_PROC_FS */
582 /* update PCM info based on ELD */
583 void snd_hdmi_eld_update_pcm_info(struct hdmi_eld *eld,
584 struct hda_pcm_stream *hinfo)
589 unsigned int channels_max;
592 /* assume basic audio support (the basic audio flag is not in ELD;
593 * however, all audio capable sinks are required to support basic
595 rates = SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |
596 SNDRV_PCM_RATE_48000;
597 formats = SNDRV_PCM_FMTBIT_S16_LE;
600 for (i = 0; i < eld->sad_count; i++) {
601 struct cea_sad *a = &eld->sad[i];
603 if (a->channels > channels_max)
604 channels_max = a->channels;
605 if (a->format == AUDIO_CODING_TYPE_LPCM) {
606 if (a->sample_bits & AC_SUPPCM_BITS_20) {
607 formats |= SNDRV_PCM_FMTBIT_S32_LE;
611 if (a->sample_bits & AC_SUPPCM_BITS_24) {
612 formats |= SNDRV_PCM_FMTBIT_S32_LE;
619 /* restrict the parameters by the values the codec provides */
620 hinfo->rates &= rates;
621 hinfo->formats &= formats;
622 hinfo->maxbps = min(hinfo->maxbps, maxbps);
623 hinfo->channels_max = min(hinfo->channels_max, channels_max);