1dd8716c387f74e036a30d14301e37e443d77925
[linux-2.6.git] / sound / pci / hda / hda_local.h
1 /*
2  * Universal Interface for Intel High Definition Audio Codec
3  *
4  * Local helper functions
5  *
6  * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
7  *
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)
11  *  any later version.
12  *
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
16  *  more details.
17  *
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.
21  */
22
23 #ifndef __SOUND_HDA_LOCAL_H
24 #define __SOUND_HDA_LOCAL_H
25
26 /*
27  * for mixer controls
28  */
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)
45 /* mono volume */
46 #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
47         HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction)
48 /* stereo volume */
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)
67
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);
91 #endif
92
93 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
94                              unsigned int *tlv);
95 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
96                                             const char *name);
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);
101
102 /* amp value bits */
103 #define HDA_AMP_MUTE    0x80
104 #define HDA_AMP_UNMUTE  0x00
105 #define HDA_AMP_VOLMASK 0x7f
106
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) }
114
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)
118
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);
123
124 /* more generic bound controls */
125 struct hda_ctl_ops {
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;
130 };
131
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 */
134
135 struct hda_bind_ctls {
136         struct hda_ctl_ops *ops;
137         long values[];
138 };
139
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);
148
149 #define HDA_BIND_VOL(xname, bindrec) \
150         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
151           .name = xname, \
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,\
162           .name = xname, \
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) }
167
168 /*
169  * SPDIF I/O
170  */
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);
173
174 /*
175  * input MUX helper
176  */
177 #define HDA_MAX_NUM_INPUTS      16
178 struct hda_input_mux_item {
179         const char *label;
180         unsigned int index;
181 };
182 struct hda_input_mux {
183         unsigned int num_items;
184         struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
185 };
186
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);
193
194 /*
195  * Channel mode helper
196  */
197 struct hda_channel_mode {
198         int channels;
199         const struct hda_verb *sequence;
200 };
201
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,
205                          int num_chmodes);
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,
209                         int num_chmodes,
210                         int max_channels);
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,
214                         int num_chmodes,
215                         int *max_channelsp);
216
217 /*
218  * Multi-channel / digital-out PCM helper
219  */
220
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 */
223
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;
237         u64 analog_formats;
238         unsigned int spdif_rates;
239         unsigned int spdif_maxbps;
240         u64 spdif_formats;
241 };
242
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,
252                                   unsigned int format,
253                                   struct snd_pcm_substream *substream);
254 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
255                                   struct hda_multi_out *mout,
256                                   struct snd_pcm_substream *substream,
257                                   struct hda_pcm_stream *hinfo);
258 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
259                                      struct hda_multi_out *mout,
260                                      unsigned int stream_tag,
261                                      unsigned int format,
262                                      struct snd_pcm_substream *substream);
263 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
264                                      struct hda_multi_out *mout);
265
266 /*
267  * generic codec parser
268  */
269 #ifdef CONFIG_SND_HDA_GENERIC
270 int snd_hda_parse_generic_codec(struct hda_codec *codec);
271 #else
272 static inline int snd_hda_parse_generic_codec(struct hda_codec *codec)
273 {
274         return -ENODEV;
275 }
276 #endif
277
278 /*
279  * generic proc interface
280  */
281 #ifdef CONFIG_PROC_FS
282 int snd_hda_codec_proc_new(struct hda_codec *codec);
283 #else
284 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
285 #endif
286
287 #define SND_PRINT_RATES_ADVISED_BUFSIZE 80
288 void snd_print_pcm_rates(int pcm, char *buf, int buflen);
289
290 #define SND_PRINT_BITS_ADVISED_BUFSIZE  16
291 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
292
293 /*
294  * Misc
295  */
296 int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
297                                const char **modelnames,
298                                const struct snd_pci_quirk *pci_list);
299 int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
300                                int num_configs, const char **models,
301                                const struct snd_pci_quirk *tbl);
302 int snd_hda_add_new_ctls(struct hda_codec *codec,
303                          struct snd_kcontrol_new *knew);
304
305 /*
306  * unsolicited event handler
307  */
308
309 #define HDA_UNSOL_QUEUE_SIZE    64
310
311 struct hda_bus_unsolicited {
312         /* ring buffer */
313         u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
314         unsigned int rp, wp;
315
316         /* workqueue */
317         struct work_struct work;
318         struct hda_bus *bus;
319 };
320
321 /*
322  * Helper for automatic ping configuration
323  */
324
325 enum {
326         AUTO_PIN_MIC,
327         AUTO_PIN_FRONT_MIC,
328         AUTO_PIN_LINE,
329         AUTO_PIN_FRONT_LINE,
330         AUTO_PIN_CD,
331         AUTO_PIN_AUX,
332         AUTO_PIN_LAST
333 };
334
335 enum {
336         AUTO_PIN_LINE_OUT,
337         AUTO_PIN_SPEAKER_OUT,
338         AUTO_PIN_HP_OUT
339 };
340
341 extern const char *auto_pin_cfg_labels[AUTO_PIN_LAST];
342
343 #define AUTO_CFG_MAX_OUTS       5
344
345 struct auto_pin_cfg {
346         int line_outs;
347         /* sorted in the order of Front/Surr/CLFE/Side */
348         hda_nid_t line_out_pins[AUTO_CFG_MAX_OUTS];
349         int speaker_outs;
350         hda_nid_t speaker_pins[AUTO_CFG_MAX_OUTS];
351         int hp_outs;
352         int line_out_type;      /* AUTO_PIN_XXX_OUT */
353         hda_nid_t hp_pins[AUTO_CFG_MAX_OUTS];
354         hda_nid_t input_pins[AUTO_PIN_LAST];
355         hda_nid_t dig_out_pin;
356         hda_nid_t dig_in_pin;
357         hda_nid_t mono_out_pin;
358 };
359
360 #define get_defcfg_connect(cfg) \
361         ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
362 #define get_defcfg_association(cfg) \
363         ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
364 #define get_defcfg_location(cfg) \
365         ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
366 #define get_defcfg_sequence(cfg) \
367         (cfg & AC_DEFCFG_SEQUENCE)
368 #define get_defcfg_device(cfg) \
369         ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
370
371 int snd_hda_parse_pin_def_config(struct hda_codec *codec,
372                                  struct auto_pin_cfg *cfg,
373                                  hda_nid_t *ignore_nids);
374
375 /* amp values */
376 #define AMP_IN_MUTE(idx)        (0x7080 | ((idx)<<8))
377 #define AMP_IN_UNMUTE(idx)      (0x7000 | ((idx)<<8))
378 #define AMP_OUT_MUTE            0xb080
379 #define AMP_OUT_UNMUTE          0xb000
380 #define AMP_OUT_ZERO            0xb000
381 /* pinctl values */
382 #define PIN_IN                  (AC_PINCTL_IN_EN)
383 #define PIN_VREFHIZ             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
384 #define PIN_VREF50              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
385 #define PIN_VREFGRD             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
386 #define PIN_VREF80              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
387 #define PIN_VREF100             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
388 #define PIN_OUT                 (AC_PINCTL_OUT_EN)
389 #define PIN_HP                  (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
390 #define PIN_HP_AMP              (AC_PINCTL_HP_EN)
391
392 /*
393  * get widget capabilities
394  */
395 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
396 {
397         if (nid < codec->start_nid ||
398             nid >= codec->start_nid + codec->num_nodes)
399                 return 0;
400         return codec->wcaps[nid - codec->start_nid];
401 }
402
403 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
404 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
405                               unsigned int caps);
406
407 int snd_hda_ctl_add(struct hda_codec *codec, struct snd_kcontrol *kctl);
408 void snd_hda_ctls_clear(struct hda_codec *codec);
409
410 /*
411  * hwdep interface
412  */
413 #ifdef CONFIG_SND_HDA_HWDEP
414 int snd_hda_create_hwdep(struct hda_codec *codec);
415 #else
416 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
417 #endif
418
419 #ifdef CONFIG_SND_HDA_RECONFIG
420 int snd_hda_hwdep_add_sysfs(struct hda_codec *codec);
421 #else
422 static inline int snd_hda_hwdep_add_sysfs(struct hda_codec *codec)
423 {
424         return 0;
425 }
426 #endif
427
428 /*
429  * power-management
430  */
431
432 #ifdef CONFIG_SND_HDA_POWER_SAVE
433 void snd_hda_schedule_power_save(struct hda_codec *codec);
434
435 struct hda_amp_list {
436         hda_nid_t nid;
437         unsigned char dir;
438         unsigned char idx;
439 };
440
441 struct hda_loopback_check {
442         struct hda_amp_list *amplist;
443         int power_on;
444 };
445
446 int snd_hda_check_amp_list_power(struct hda_codec *codec,
447                                  struct hda_loopback_check *check,
448                                  hda_nid_t nid);
449 #endif /* CONFIG_SND_HDA_POWER_SAVE */
450
451 /*
452  * AMP control callbacks
453  */
454 /* retrieve parameters from private_value */
455 #define get_amp_nid(kc)         ((kc)->private_value & 0xffff)
456 #define get_amp_channels(kc)    (((kc)->private_value >> 16) & 0x3)
457 #define get_amp_direction(kc)   (((kc)->private_value >> 18) & 0x1)
458 #define get_amp_index(kc)       (((kc)->private_value >> 19) & 0xf)
459
460 /*
461  * CEA Short Audio Descriptor data
462  */
463 struct cea_sad {
464         int     channels;
465         int     format;         /* (format == 0) indicates invalid SAD */
466         int     rates;
467         int     sample_bits;    /* for LPCM */
468         int     max_bitrate;    /* for AC3...ATRAC */
469         int     profile;        /* for WMAPRO */
470 };
471
472 #define ELD_FIXED_BYTES 20
473 #define ELD_MAX_MNL     16
474 #define ELD_MAX_SAD     16
475
476 /*
477  * ELD: EDID Like Data
478  */
479 struct hdmi_eld {
480         int     eld_size;
481         int     baseline_len;
482         int     eld_ver;        /* (eld_ver == 0) indicates invalid ELD */
483         int     cea_edid_ver;
484         char    monitor_name[ELD_MAX_MNL + 1];
485         int     manufacture_id;
486         int     product_id;
487         u64     port_id;
488         int     support_hdcp;
489         int     support_ai;
490         int     conn_type;
491         int     aud_synch_delay;
492         int     spk_alloc;
493         int     sad_count;
494         struct cea_sad sad[ELD_MAX_SAD];
495 #ifdef CONFIG_PROC_FS
496         struct snd_info_entry *proc_entry;
497 #endif
498 };
499
500 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
501 int snd_hdmi_get_eld(struct hdmi_eld *, struct hda_codec *, hda_nid_t);
502 void snd_hdmi_show_eld(struct hdmi_eld *eld);
503
504 #ifdef CONFIG_PROC_FS
505 int snd_hda_eld_proc_new(struct hda_codec *codec, struct hdmi_eld *eld);
506 void snd_hda_eld_proc_free(struct hda_codec *codec, struct hdmi_eld *eld);
507 #else
508 static inline int snd_hda_eld_proc_new(struct hda_codec *codec,
509                                        struct hdmi_eld *eld)
510 {
511         return 0;
512 }
513 static inline void snd_hda_eld_proc_free(struct hda_codec *codec,
514                                          struct hdmi_eld *eld)
515 {
516 }
517 #endif
518
519 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
520 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
521
522 #endif /* __SOUND_HDA_LOCAL_H */