2 * Universal Interface for Intel High Definition Audio Codec
4 * Local helper functions
6 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the Free
10 * Software Foundation; either version 2 of the License, or (at your option)
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
18 * You should have received a copy of the GNU General Public License along with
19 * this program; if not, write to the Free Software Foundation, Inc., 59
20 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #ifndef __SOUND_HDA_LOCAL_H
24 #define __SOUND_HDA_LOCAL_H
29 #define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
30 ((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19))
31 /* mono volume with index (index=0,1,...) (channel=1,2) */
32 #define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
33 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
34 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | \
35 SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
36 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
37 .info = snd_hda_mixer_amp_volume_info, \
38 .get = snd_hda_mixer_amp_volume_get, \
39 .put = snd_hda_mixer_amp_volume_put, \
40 .tlv = { .c = snd_hda_mixer_amp_tlv }, \
41 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
42 /* stereo volume with index */
43 #define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
44 HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
46 #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
47 HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction)
49 #define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
50 HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
51 /* mono mute switch with index (index=0,1,...) (channel=1,2) */
52 #define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
53 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
54 .info = snd_hda_mixer_amp_switch_info, \
55 .get = snd_hda_mixer_amp_switch_get, \
56 .put = snd_hda_mixer_amp_switch_put, \
57 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
58 /* stereo mute switch with index */
59 #define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
60 HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
61 /* mono mute switch */
62 #define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
63 HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
64 /* stereo mute switch */
65 #define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
66 HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
68 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
69 struct snd_ctl_elem_info *uinfo);
70 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
71 struct snd_ctl_elem_value *ucontrol);
72 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
73 struct snd_ctl_elem_value *ucontrol);
74 int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
75 unsigned int size, unsigned int __user *tlv);
76 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
77 struct snd_ctl_elem_info *uinfo);
78 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
79 struct snd_ctl_elem_value *ucontrol);
80 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
81 struct snd_ctl_elem_value *ucontrol);
82 /* lowlevel accessor with caching; use carefully */
83 int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
84 int direction, int index);
85 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
86 int direction, int idx, int mask, int val);
87 int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
88 int dir, int idx, int mask, int val);
89 #ifdef SND_HDA_NEEDS_RESUME
90 void snd_hda_codec_resume_amp(struct hda_codec *codec);
93 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
95 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
97 int snd_hda_add_vmaster(struct hda_codec *codec, char *name,
98 unsigned int *tlv, const char **slaves);
99 void snd_hda_codec_reset(struct hda_codec *codec);
100 int snd_hda_codec_configure(struct hda_codec *codec);
103 #define HDA_AMP_MUTE 0x80
104 #define HDA_AMP_UNMUTE 0x00
105 #define HDA_AMP_VOLMASK 0x7f
107 /* mono switch binding multiple inputs */
108 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
109 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0, \
110 .info = snd_hda_mixer_amp_switch_info, \
111 .get = snd_hda_mixer_bind_switch_get, \
112 .put = snd_hda_mixer_bind_switch_put, \
113 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
115 /* stereo switch binding multiple inputs */
116 #define HDA_BIND_MUTE(xname,nid,indices,dir) \
117 HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
119 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
120 struct snd_ctl_elem_value *ucontrol);
121 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
122 struct snd_ctl_elem_value *ucontrol);
124 /* more generic bound controls */
126 snd_kcontrol_info_t *info;
127 snd_kcontrol_get_t *get;
128 snd_kcontrol_put_t *put;
129 snd_kcontrol_tlv_rw_t *tlv;
132 extern struct hda_ctl_ops snd_hda_bind_vol; /* for bind-volume with TLV */
133 extern struct hda_ctl_ops snd_hda_bind_sw; /* for bind-switch */
135 struct hda_bind_ctls {
136 struct hda_ctl_ops *ops;
140 int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
141 struct snd_ctl_elem_info *uinfo);
142 int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
143 struct snd_ctl_elem_value *ucontrol);
144 int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
145 struct snd_ctl_elem_value *ucontrol);
146 int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
147 unsigned int size, unsigned int __user *tlv);
149 #define HDA_BIND_VOL(xname, bindrec) \
150 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
152 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |\
153 SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
154 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
155 .info = snd_hda_mixer_bind_ctls_info,\
156 .get = snd_hda_mixer_bind_ctls_get,\
157 .put = snd_hda_mixer_bind_ctls_put,\
158 .tlv = { .c = snd_hda_mixer_bind_tlv },\
159 .private_value = (long) (bindrec) }
160 #define HDA_BIND_SW(xname, bindrec) \
161 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
163 .info = snd_hda_mixer_bind_ctls_info,\
164 .get = snd_hda_mixer_bind_ctls_get,\
165 .put = snd_hda_mixer_bind_ctls_put,\
166 .private_value = (long) (bindrec) }
171 int snd_hda_create_spdif_out_ctls(struct hda_codec *codec, hda_nid_t nid);
172 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
177 #define HDA_MAX_NUM_INPUTS 16
178 struct hda_input_mux_item {
182 struct hda_input_mux {
183 unsigned int num_items;
184 struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
187 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
188 struct snd_ctl_elem_info *uinfo);
189 int snd_hda_input_mux_put(struct hda_codec *codec,
190 const struct hda_input_mux *imux,
191 struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
192 unsigned int *cur_val);
195 * Channel mode helper
197 struct hda_channel_mode {
199 const struct hda_verb *sequence;
202 int snd_hda_ch_mode_info(struct hda_codec *codec,
203 struct snd_ctl_elem_info *uinfo,
204 const struct hda_channel_mode *chmode,
206 int snd_hda_ch_mode_get(struct hda_codec *codec,
207 struct snd_ctl_elem_value *ucontrol,
208 const struct hda_channel_mode *chmode,
211 int snd_hda_ch_mode_put(struct hda_codec *codec,
212 struct snd_ctl_elem_value *ucontrol,
213 const struct hda_channel_mode *chmode,
218 * Multi-channel / digital-out PCM helper
221 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
222 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
224 struct hda_multi_out {
225 int num_dacs; /* # of DACs, must be more than 1 */
226 hda_nid_t *dac_nids; /* DAC list */
227 hda_nid_t hp_nid; /* optional DAC for HP, 0 when not exists */
228 hda_nid_t extra_out_nid[3]; /* optional DACs, 0 when not exists */
229 hda_nid_t dig_out_nid; /* digital out audio widget */
230 int max_channels; /* currently supported analog channels */
231 int dig_out_used; /* current usage of digital out (HDA_DIG_XXX) */
232 int no_share_stream; /* don't share a stream with multiple pins */
233 int share_spdif; /* share SPDIF pin */
234 /* PCM information for both analog and SPDIF DACs */
235 unsigned int analog_rates;
236 unsigned int analog_maxbps;
238 unsigned int spdif_rates;
239 unsigned int spdif_maxbps;
243 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
244 struct hda_multi_out *mout);
245 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
246 struct hda_multi_out *mout);
247 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
248 struct hda_multi_out *mout);
249 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
250 struct hda_multi_out *mout,
251 unsigned int stream_tag,
253 struct snd_pcm_substream *substream);
254 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
255 struct hda_multi_out *mout);
256 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
257 struct hda_multi_out *mout,
258 struct snd_pcm_substream *substream,
259 struct hda_pcm_stream *hinfo);
260 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
261 struct hda_multi_out *mout,
262 unsigned int stream_tag,
264 struct snd_pcm_substream *substream);
265 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
266 struct hda_multi_out *mout);
269 * generic codec parser
271 #ifdef CONFIG_SND_HDA_GENERIC
272 int snd_hda_parse_generic_codec(struct hda_codec *codec);
274 static inline int snd_hda_parse_generic_codec(struct hda_codec *codec)
281 * generic proc interface
283 #ifdef CONFIG_PROC_FS
284 int snd_hda_codec_proc_new(struct hda_codec *codec);
286 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
289 #define SND_PRINT_RATES_ADVISED_BUFSIZE 80
290 void snd_print_pcm_rates(int pcm, char *buf, int buflen);
292 #define SND_PRINT_BITS_ADVISED_BUFSIZE 16
293 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
298 int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
299 const char **modelnames,
300 const struct snd_pci_quirk *pci_list);
301 int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
302 int num_configs, const char **models,
303 const struct snd_pci_quirk *tbl);
304 int snd_hda_add_new_ctls(struct hda_codec *codec,
305 struct snd_kcontrol_new *knew);
308 * unsolicited event handler
311 #define HDA_UNSOL_QUEUE_SIZE 64
313 struct hda_bus_unsolicited {
315 u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
319 struct work_struct work;
324 * Helper for automatic ping configuration
339 AUTO_PIN_SPEAKER_OUT,
343 extern const char *auto_pin_cfg_labels[AUTO_PIN_LAST];
345 #define AUTO_CFG_MAX_OUTS 5
347 struct auto_pin_cfg {
349 /* sorted in the order of Front/Surr/CLFE/Side */
350 hda_nid_t line_out_pins[AUTO_CFG_MAX_OUTS];
352 hda_nid_t speaker_pins[AUTO_CFG_MAX_OUTS];
354 int line_out_type; /* AUTO_PIN_XXX_OUT */
355 hda_nid_t hp_pins[AUTO_CFG_MAX_OUTS];
356 hda_nid_t input_pins[AUTO_PIN_LAST];
357 hda_nid_t dig_out_pin;
358 hda_nid_t dig_in_pin;
359 hda_nid_t mono_out_pin;
362 #define get_defcfg_connect(cfg) \
363 ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
364 #define get_defcfg_association(cfg) \
365 ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
366 #define get_defcfg_location(cfg) \
367 ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
368 #define get_defcfg_sequence(cfg) \
369 (cfg & AC_DEFCFG_SEQUENCE)
370 #define get_defcfg_device(cfg) \
371 ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
373 int snd_hda_parse_pin_def_config(struct hda_codec *codec,
374 struct auto_pin_cfg *cfg,
375 hda_nid_t *ignore_nids);
378 #define AMP_IN_MUTE(idx) (0x7080 | ((idx)<<8))
379 #define AMP_IN_UNMUTE(idx) (0x7000 | ((idx)<<8))
380 #define AMP_OUT_MUTE 0xb080
381 #define AMP_OUT_UNMUTE 0xb000
382 #define AMP_OUT_ZERO 0xb000
384 #define PIN_IN (AC_PINCTL_IN_EN)
385 #define PIN_VREFHIZ (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
386 #define PIN_VREF50 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
387 #define PIN_VREFGRD (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
388 #define PIN_VREF80 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
389 #define PIN_VREF100 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
390 #define PIN_OUT (AC_PINCTL_OUT_EN)
391 #define PIN_HP (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
392 #define PIN_HP_AMP (AC_PINCTL_HP_EN)
395 * get widget capabilities
397 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
399 if (nid < codec->start_nid ||
400 nid >= codec->start_nid + codec->num_nodes)
402 return codec->wcaps[nid - codec->start_nid];
405 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
406 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
409 int snd_hda_ctl_add(struct hda_codec *codec, struct snd_kcontrol *kctl);
410 void snd_hda_ctls_clear(struct hda_codec *codec);
415 #ifdef CONFIG_SND_HDA_HWDEP
416 int snd_hda_create_hwdep(struct hda_codec *codec);
418 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
421 #ifdef CONFIG_SND_HDA_RECONFIG
422 int snd_hda_hwdep_add_sysfs(struct hda_codec *codec);
424 static inline int snd_hda_hwdep_add_sysfs(struct hda_codec *codec)
434 #ifdef CONFIG_SND_HDA_POWER_SAVE
435 void snd_hda_schedule_power_save(struct hda_codec *codec);
437 struct hda_amp_list {
443 struct hda_loopback_check {
444 struct hda_amp_list *amplist;
448 int snd_hda_check_amp_list_power(struct hda_codec *codec,
449 struct hda_loopback_check *check,
451 #endif /* CONFIG_SND_HDA_POWER_SAVE */
454 * AMP control callbacks
456 /* retrieve parameters from private_value */
457 #define get_amp_nid(kc) ((kc)->private_value & 0xffff)
458 #define get_amp_channels(kc) (((kc)->private_value >> 16) & 0x3)
459 #define get_amp_direction(kc) (((kc)->private_value >> 18) & 0x1)
460 #define get_amp_index(kc) (((kc)->private_value >> 19) & 0xf)
463 * CEA Short Audio Descriptor data
467 int format; /* (format == 0) indicates invalid SAD */
469 int sample_bits; /* for LPCM */
470 int max_bitrate; /* for AC3...ATRAC */
471 int profile; /* for WMAPRO */
474 #define ELD_FIXED_BYTES 20
475 #define ELD_MAX_MNL 16
476 #define ELD_MAX_SAD 16
479 * ELD: EDID Like Data
484 int eld_ver; /* (eld_ver == 0) indicates invalid ELD */
486 char monitor_name[ELD_MAX_MNL + 1];
496 struct cea_sad sad[ELD_MAX_SAD];
497 #ifdef CONFIG_PROC_FS
498 struct snd_info_entry *proc_entry;
502 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
503 int snd_hdmi_get_eld(struct hdmi_eld *, struct hda_codec *, hda_nid_t);
504 void snd_hdmi_show_eld(struct hdmi_eld *eld);
506 #ifdef CONFIG_PROC_FS
507 int snd_hda_eld_proc_new(struct hda_codec *codec, struct hdmi_eld *eld);
508 void snd_hda_eld_proc_free(struct hda_codec *codec, struct hdmi_eld *eld);
510 static inline int snd_hda_eld_proc_new(struct hda_codec *codec,
511 struct hdmi_eld *eld)
515 static inline void snd_hda_eld_proc_free(struct hda_codec *codec,
516 struct hdmi_eld *eld)
521 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
522 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
524 #endif /* __SOUND_HDA_LOCAL_H */