Merge branches 'arm/rockchip', 'arm/exynos', 'arm/smmu', 'x86/vt-d', 'x86/amd', ...
[sfrench/cifs-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 /* We abuse kcontrol_new.subdev field to pass the NID corresponding to
27  * the given new control.  If id.subdev has a bit flag HDA_SUBDEV_NID_FLAG,
28  * snd_hda_ctl_add() takes the lower-bit subdev value as a valid NID.
29  * 
30  * Note that the subdevice field is cleared again before the real registration
31  * in snd_hda_ctl_add(), so that this value won't appear in the outside.
32  */
33 #define HDA_SUBDEV_NID_FLAG     (1U << 31)
34 #define HDA_SUBDEV_AMP_FLAG     (1U << 30)
35
36 /*
37  * for mixer controls
38  */
39 #define HDA_COMPOSE_AMP_VAL_OFS(nid,chs,idx,dir,ofs)            \
40         ((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19) | ((ofs)<<23))
41 #define HDA_AMP_VAL_MIN_MUTE (1<<29)
42 #define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
43         HDA_COMPOSE_AMP_VAL_OFS(nid, chs, idx, dir, 0)
44 /* mono volume with index (index=0,1,...) (channel=1,2) */
45 #define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, dir, flags) \
46         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx,  \
47           .subdevice = HDA_SUBDEV_AMP_FLAG, \
48           .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | \
49                     SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
50                     SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
51           .info = snd_hda_mixer_amp_volume_info, \
52           .get = snd_hda_mixer_amp_volume_get, \
53           .put = snd_hda_mixer_amp_volume_put, \
54           .tlv = { .c = snd_hda_mixer_amp_tlv },                \
55           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, dir) | flags }
56 /* stereo volume with index */
57 #define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
58         HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction, 0)
59 /* mono volume */
60 #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
61         HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction, 0)
62 /* stereo volume */
63 #define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
64         HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
65 /* stereo volume with min=mute */
66 #define HDA_CODEC_VOLUME_MIN_MUTE(xname, nid, xindex, direction) \
67         HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, 3, xindex, direction, \
68                                   HDA_AMP_VAL_MIN_MUTE)
69 /* mono mute switch with index (index=0,1,...) (channel=1,2) */
70 #define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
71         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
72           .subdevice = HDA_SUBDEV_AMP_FLAG, \
73           .info = snd_hda_mixer_amp_switch_info, \
74           .get = snd_hda_mixer_amp_switch_get, \
75           .put = snd_hda_mixer_amp_switch_put, \
76           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
77 /* stereo mute switch with index */
78 #define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
79         HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
80 /* mono mute switch */
81 #define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
82         HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
83 /* stereo mute switch */
84 #define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
85         HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
86 #ifdef CONFIG_SND_HDA_INPUT_BEEP
87 /* special beep mono mute switch with index (index=0,1,...) (channel=1,2) */
88 #define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
89         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
90           .subdevice = HDA_SUBDEV_AMP_FLAG, \
91           .info = snd_hda_mixer_amp_switch_info, \
92           .get = snd_hda_mixer_amp_switch_get_beep, \
93           .put = snd_hda_mixer_amp_switch_put_beep, \
94           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
95 #else
96 /* no digital beep - just the standard one */
97 #define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, ch, xidx, dir) \
98         HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, ch, xidx, dir)
99 #endif /* CONFIG_SND_HDA_INPUT_BEEP */
100 /* special beep mono mute switch */
101 #define HDA_CODEC_MUTE_BEEP_MONO(xname, nid, channel, xindex, direction) \
102         HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, 0, nid, channel, xindex, direction)
103 /* special beep stereo mute switch */
104 #define HDA_CODEC_MUTE_BEEP(xname, nid, xindex, direction) \
105         HDA_CODEC_MUTE_BEEP_MONO(xname, nid, 3, xindex, direction)
106
107 extern const char *snd_hda_pcm_type_name[];
108
109 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
110                                   struct snd_ctl_elem_info *uinfo);
111 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
112                                  struct snd_ctl_elem_value *ucontrol);
113 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
114                                  struct snd_ctl_elem_value *ucontrol);
115 int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
116                           unsigned int size, unsigned int __user *tlv);
117 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
118                                   struct snd_ctl_elem_info *uinfo);
119 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
120                                  struct snd_ctl_elem_value *ucontrol);
121 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
122                                  struct snd_ctl_elem_value *ucontrol);
123 #ifdef CONFIG_SND_HDA_INPUT_BEEP
124 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
125                                       struct snd_ctl_elem_value *ucontrol);
126 int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
127                                       struct snd_ctl_elem_value *ucontrol);
128 #endif
129 /* lowlevel accessor with caching; use carefully */
130 #define snd_hda_codec_amp_read(codec, nid, ch, dir, idx) \
131         snd_hdac_regmap_get_amp(&(codec)->core, nid, ch, dir, idx)
132 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid,
133                              int ch, int dir, int idx, int mask, int val);
134 int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
135                              int dir, int idx, int mask, int val);
136 int snd_hda_codec_amp_init(struct hda_codec *codec, hda_nid_t nid, int ch,
137                            int direction, int idx, int mask, int val);
138 int snd_hda_codec_amp_init_stereo(struct hda_codec *codec, hda_nid_t nid,
139                                   int dir, int idx, int mask, int val);
140 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
141                              unsigned int *tlv);
142 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
143                                             const char *name);
144 int __snd_hda_add_vmaster(struct hda_codec *codec, char *name,
145                           unsigned int *tlv, const char * const *slaves,
146                           const char *suffix, bool init_slave_vol,
147                           struct snd_kcontrol **ctl_ret);
148 #define snd_hda_add_vmaster(codec, name, tlv, slaves, suffix) \
149         __snd_hda_add_vmaster(codec, name, tlv, slaves, suffix, true, NULL)
150 int snd_hda_codec_reset(struct hda_codec *codec);
151 void snd_hda_codec_register(struct hda_codec *codec);
152 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
153
154 enum {
155         HDA_VMUTE_OFF,
156         HDA_VMUTE_ON,
157         HDA_VMUTE_FOLLOW_MASTER,
158 };
159
160 struct hda_vmaster_mute_hook {
161         /* below two fields must be filled by the caller of
162          * snd_hda_add_vmaster_hook() beforehand
163          */
164         struct snd_kcontrol *sw_kctl;
165         void (*hook)(void *, int);
166         /* below are initialized automatically */
167         unsigned int mute_mode; /* HDA_VMUTE_XXX */
168         struct hda_codec *codec;
169 };
170
171 int snd_hda_add_vmaster_hook(struct hda_codec *codec,
172                              struct hda_vmaster_mute_hook *hook,
173                              bool expose_enum_ctl);
174 void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook);
175
176 /* amp value bits */
177 #define HDA_AMP_MUTE    0x80
178 #define HDA_AMP_UNMUTE  0x00
179 #define HDA_AMP_VOLMASK 0x7f
180
181 /* mono switch binding multiple inputs */
182 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
183         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
184           .info = snd_hda_mixer_amp_switch_info, \
185           .get = snd_hda_mixer_bind_switch_get, \
186           .put = snd_hda_mixer_bind_switch_put, \
187           .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
188
189 /* stereo switch binding multiple inputs */
190 #define HDA_BIND_MUTE(xname,nid,indices,dir) \
191         HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
192
193 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
194                                   struct snd_ctl_elem_value *ucontrol);
195 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
196                                   struct snd_ctl_elem_value *ucontrol);
197
198 /* more generic bound controls */
199 struct hda_ctl_ops {
200         snd_kcontrol_info_t *info;
201         snd_kcontrol_get_t *get;
202         snd_kcontrol_put_t *put;
203         snd_kcontrol_tlv_rw_t *tlv;
204 };
205
206 extern struct hda_ctl_ops snd_hda_bind_vol;     /* for bind-volume with TLV */
207 extern struct hda_ctl_ops snd_hda_bind_sw;      /* for bind-switch */
208
209 struct hda_bind_ctls {
210         struct hda_ctl_ops *ops;
211         unsigned long values[];
212 };
213
214 int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
215                                  struct snd_ctl_elem_info *uinfo);
216 int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
217                                 struct snd_ctl_elem_value *ucontrol);
218 int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
219                                 struct snd_ctl_elem_value *ucontrol);
220 int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
221                            unsigned int size, unsigned int __user *tlv);
222
223 #define HDA_BIND_VOL(xname, bindrec) \
224         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
225           .name = xname, \
226           .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |\
227                           SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
228                           SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
229           .info = snd_hda_mixer_bind_ctls_info,\
230           .get =  snd_hda_mixer_bind_ctls_get,\
231           .put = snd_hda_mixer_bind_ctls_put,\
232           .tlv = { .c = snd_hda_mixer_bind_tlv },\
233           .private_value = (long) (bindrec) }
234 #define HDA_BIND_SW(xname, bindrec) \
235         { .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
236           .name = xname, \
237           .info = snd_hda_mixer_bind_ctls_info,\
238           .get =  snd_hda_mixer_bind_ctls_get,\
239           .put = snd_hda_mixer_bind_ctls_put,\
240           .private_value = (long) (bindrec) }
241
242 /*
243  * SPDIF I/O
244  */
245 int snd_hda_create_dig_out_ctls(struct hda_codec *codec,
246                                 hda_nid_t associated_nid,
247                                 hda_nid_t cvt_nid, int type);
248 #define snd_hda_create_spdif_out_ctls(codec, anid, cnid) \
249         snd_hda_create_dig_out_ctls(codec, anid, cnid, HDA_PCM_TYPE_SPDIF)
250 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
251
252 /*
253  * input MUX helper
254  */
255 #define HDA_MAX_NUM_INPUTS      16
256 struct hda_input_mux_item {
257         char label[32];
258         unsigned int index;
259 };
260 struct hda_input_mux {
261         unsigned int num_items;
262         struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
263 };
264
265 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
266                            struct snd_ctl_elem_info *uinfo);
267 int snd_hda_input_mux_put(struct hda_codec *codec,
268                           const struct hda_input_mux *imux,
269                           struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
270                           unsigned int *cur_val);
271 int snd_hda_add_imux_item(struct hda_codec *codec,
272                           struct hda_input_mux *imux, const char *label,
273                           int index, int *type_index_ret);
274
275 /*
276  * Multi-channel / digital-out PCM helper
277  */
278
279 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
280 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
281
282 #define HDA_MAX_OUTS    5
283
284 struct hda_multi_out {
285         int num_dacs;           /* # of DACs, must be more than 1 */
286         const hda_nid_t *dac_nids;      /* DAC list */
287         hda_nid_t hp_nid;       /* optional DAC for HP, 0 when not exists */
288         hda_nid_t hp_out_nid[HDA_MAX_OUTS];     /* DACs for multiple HPs */
289         hda_nid_t extra_out_nid[HDA_MAX_OUTS];  /* other (e.g. speaker) DACs */
290         hda_nid_t dig_out_nid;  /* digital out audio widget */
291         const hda_nid_t *slave_dig_outs;
292         int max_channels;       /* currently supported analog channels */
293         int dig_out_used;       /* current usage of digital out (HDA_DIG_XXX) */
294         int no_share_stream;    /* don't share a stream with multiple pins */
295         int share_spdif;        /* share SPDIF pin */
296         /* PCM information for both analog and SPDIF DACs */
297         unsigned int analog_rates;
298         unsigned int analog_maxbps;
299         u64 analog_formats;
300         unsigned int spdif_rates;
301         unsigned int spdif_maxbps;
302         u64 spdif_formats;
303 };
304
305 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
306                                   struct hda_multi_out *mout);
307 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
308                                struct hda_multi_out *mout);
309 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
310                                 struct hda_multi_out *mout);
311 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
312                                   struct hda_multi_out *mout,
313                                   unsigned int stream_tag,
314                                   unsigned int format,
315                                   struct snd_pcm_substream *substream);
316 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
317                                   struct hda_multi_out *mout);
318 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
319                                   struct hda_multi_out *mout,
320                                   struct snd_pcm_substream *substream,
321                                   struct hda_pcm_stream *hinfo);
322 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
323                                      struct hda_multi_out *mout,
324                                      unsigned int stream_tag,
325                                      unsigned int format,
326                                      struct snd_pcm_substream *substream);
327 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
328                                      struct hda_multi_out *mout);
329
330 /*
331  * generic proc interface
332  */
333 #ifdef CONFIG_PROC_FS
334 int snd_hda_codec_proc_new(struct hda_codec *codec);
335 #else
336 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
337 #endif
338
339 #define SND_PRINT_BITS_ADVISED_BUFSIZE  16
340 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
341
342 /*
343  * Misc
344  */
345 int snd_hda_add_new_ctls(struct hda_codec *codec,
346                          const struct snd_kcontrol_new *knew);
347
348 /*
349  * Fix-up pin default configurations and add default verbs
350  */
351
352 struct hda_pintbl {
353         hda_nid_t nid;
354         u32 val;
355 };
356
357 struct hda_model_fixup {
358         const int id;
359         const char *name;
360 };
361
362 struct hda_fixup {
363         int type;
364         bool chained:1;         /* call the chained fixup(s) after this */
365         bool chained_before:1;  /* call the chained fixup(s) before this */
366         int chain_id;
367         union {
368                 const struct hda_pintbl *pins;
369                 const struct hda_verb *verbs;
370                 void (*func)(struct hda_codec *codec,
371                              const struct hda_fixup *fix,
372                              int action);
373         } v;
374 };
375
376 struct snd_hda_pin_quirk {
377         unsigned int codec;             /* Codec vendor/device ID */
378         unsigned short subvendor;       /* PCI subvendor ID */
379         const struct hda_pintbl *pins;  /* list of matching pins */
380 #ifdef CONFIG_SND_DEBUG_VERBOSE
381         const char *name;
382 #endif
383         int value;                      /* quirk value */
384 };
385
386 #ifdef CONFIG_SND_DEBUG_VERBOSE
387
388 #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
389         { .codec = _codec,\
390           .subvendor = _subvendor,\
391           .name = _name,\
392           .value = _value,\
393           .pins = (const struct hda_pintbl[]) { _pins, {0, 0}} \
394         }
395 #else
396
397 #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
398         { .codec = _codec,\
399           .subvendor = _subvendor,\
400           .value = _value,\
401           .pins = (const struct hda_pintbl[]) { _pins, {0, 0}} \
402         }
403
404 #endif
405
406 #define HDA_FIXUP_ID_NOT_SET -1
407 #define HDA_FIXUP_ID_NO_FIXUP -2
408
409 /* fixup types */
410 enum {
411         HDA_FIXUP_INVALID,
412         HDA_FIXUP_PINS,
413         HDA_FIXUP_VERBS,
414         HDA_FIXUP_FUNC,
415         HDA_FIXUP_PINCTLS,
416 };
417
418 /* fixup action definitions */
419 enum {
420         HDA_FIXUP_ACT_PRE_PROBE,
421         HDA_FIXUP_ACT_PROBE,
422         HDA_FIXUP_ACT_INIT,
423         HDA_FIXUP_ACT_BUILD,
424         HDA_FIXUP_ACT_FREE,
425 };
426
427 int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
428 void snd_hda_apply_verbs(struct hda_codec *codec);
429 void snd_hda_apply_pincfgs(struct hda_codec *codec,
430                            const struct hda_pintbl *cfg);
431 void snd_hda_apply_fixup(struct hda_codec *codec, int action);
432 void snd_hda_pick_fixup(struct hda_codec *codec,
433                         const struct hda_model_fixup *models,
434                         const struct snd_pci_quirk *quirk,
435                         const struct hda_fixup *fixlist);
436 void snd_hda_pick_pin_fixup(struct hda_codec *codec,
437                             const struct snd_hda_pin_quirk *pin_quirk,
438                             const struct hda_fixup *fixlist);
439
440 /* helper macros to retrieve pin default-config values */
441 #define get_defcfg_connect(cfg) \
442         ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
443 #define get_defcfg_association(cfg) \
444         ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
445 #define get_defcfg_location(cfg) \
446         ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
447 #define get_defcfg_sequence(cfg) \
448         (cfg & AC_DEFCFG_SEQUENCE)
449 #define get_defcfg_device(cfg) \
450         ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
451 #define get_defcfg_misc(cfg) \
452         ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
453
454 /* amp values */
455 #define AMP_IN_MUTE(idx)        (0x7080 | ((idx)<<8))
456 #define AMP_IN_UNMUTE(idx)      (0x7000 | ((idx)<<8))
457 #define AMP_OUT_MUTE            0xb080
458 #define AMP_OUT_UNMUTE          0xb000
459 #define AMP_OUT_ZERO            0xb000
460 /* pinctl values */
461 #define PIN_IN                  (AC_PINCTL_IN_EN)
462 #define PIN_VREFHIZ             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
463 #define PIN_VREF50              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
464 #define PIN_VREFGRD             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
465 #define PIN_VREF80              (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
466 #define PIN_VREF100             (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
467 #define PIN_OUT                 (AC_PINCTL_OUT_EN)
468 #define PIN_HP                  (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
469 #define PIN_HP_AMP              (AC_PINCTL_HP_EN)
470
471 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
472 unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
473                                      hda_nid_t pin, unsigned int val);
474 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
475                          unsigned int val, bool cached);
476
477 /**
478  * _snd_hda_set_pin_ctl - Set a pin-control value safely
479  * @codec: the codec instance
480  * @pin: the pin NID to set the control
481  * @val: the pin-control value (AC_PINCTL_* bits)
482  *
483  * This function sets the pin-control value to the given pin, but
484  * filters out the invalid pin-control bits when the pin has no such
485  * capabilities.  For example, when PIN_HP is passed but the pin has no
486  * HP-drive capability, the HP bit is omitted.
487  *
488  * The function doesn't check the input VREF capability bits, though.
489  * Use snd_hda_get_default_vref() to guess the right value.
490  * Also, this function is only for analog pins, not for HDMI pins.
491  */
492 static inline int
493 snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
494 {
495         return _snd_hda_set_pin_ctl(codec, pin, val, false);
496 }
497
498 /**
499  * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
500  * @codec: the codec instance
501  * @pin: the pin NID to set the control
502  * @val: the pin-control value (AC_PINCTL_* bits)
503  *
504  * Just like snd_hda_set_pin_ctl() but write to cache as well.
505  */
506 static inline int
507 snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
508                           unsigned int val)
509 {
510         return _snd_hda_set_pin_ctl(codec, pin, val, true);
511 }
512
513 int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
514 int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
515                                  unsigned int val);
516
517 #define for_each_hda_codec_node(nid, codec) \
518         for ((nid) = (codec)->core.start_nid; (nid) < (codec)->core.end_nid; (nid)++)
519
520 /*
521  * get widget capabilities
522  */
523 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
524 {
525         if (nid < codec->core.start_nid ||
526             nid >= codec->core.start_nid + codec->core.num_nodes)
527                 return 0;
528         return codec->wcaps[nid - codec->core.start_nid];
529 }
530
531 /* get the widget type from widget capability bits */
532 static inline int get_wcaps_type(unsigned int wcaps)
533 {
534         if (!wcaps)
535                 return -1; /* invalid type */
536         return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
537 }
538
539 static inline unsigned int get_wcaps_channels(u32 wcaps)
540 {
541         unsigned int chans;
542
543         chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
544         chans = ((chans << 1) | 1) + 1;
545
546         return chans;
547 }
548
549 static inline void snd_hda_override_wcaps(struct hda_codec *codec,
550                                           hda_nid_t nid, u32 val)
551 {
552         if (nid >= codec->core.start_nid &&
553             nid < codec->core.start_nid + codec->core.num_nodes)
554                 codec->wcaps[nid - codec->core.start_nid] = val;
555 }
556
557 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
558 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
559                               unsigned int caps);
560 /**
561  * snd_hda_query_pin_caps - Query PIN capabilities
562  * @codec: the HD-auio codec
563  * @nid: the NID to query
564  *
565  * Query PIN capabilities for the given widget.
566  * Returns the obtained capability bits.
567  *
568  * When cap bits have been already read, this doesn't read again but
569  * returns the cached value.
570  */
571 static inline u32
572 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid)
573 {
574         return snd_hda_param_read(codec, nid, AC_PAR_PIN_CAP);
575
576 }
577
578 /**
579  * snd_hda_override_pin_caps - Override the pin capabilities
580  * @codec: the CODEC
581  * @nid: the NID to override
582  * @caps: the capability bits to set
583  *
584  * Override the cached PIN capabilitiy bits value by the given one.
585  *
586  * Returns zero if successful or a negative error code.
587  */
588 static inline int
589 snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
590                           unsigned int caps)
591 {
592         return snd_hdac_override_parm(&codec->core, nid, AC_PAR_PIN_CAP, caps);
593 }
594
595 bool snd_hda_check_amp_caps(struct hda_codec *codec, hda_nid_t nid,
596                            int dir, unsigned int bits);
597
598 #define nid_has_mute(codec, nid, dir) \
599         snd_hda_check_amp_caps(codec, nid, dir, (AC_AMPCAP_MUTE | AC_AMPCAP_MIN_MUTE))
600 #define nid_has_volume(codec, nid, dir) \
601         snd_hda_check_amp_caps(codec, nid, dir, AC_AMPCAP_NUM_STEPS)
602
603
604 /* flags for hda_nid_item */
605 #define HDA_NID_ITEM_AMP        (1<<0)
606
607 struct hda_nid_item {
608         struct snd_kcontrol *kctl;
609         unsigned int index;
610         hda_nid_t nid;
611         unsigned short flags;
612 };
613
614 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
615                     struct snd_kcontrol *kctl);
616 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
617                     unsigned int index, hda_nid_t nid);
618 void snd_hda_ctls_clear(struct hda_codec *codec);
619
620 /*
621  * hwdep interface
622  */
623 #ifdef CONFIG_SND_HDA_HWDEP
624 int snd_hda_create_hwdep(struct hda_codec *codec);
625 #else
626 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
627 #endif
628
629 void snd_hda_sysfs_init(struct hda_codec *codec);
630 void snd_hda_sysfs_clear(struct hda_codec *codec);
631
632 extern const struct attribute_group *snd_hda_dev_attr_groups[];
633
634 #ifdef CONFIG_SND_HDA_RECONFIG
635 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
636 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
637 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
638 #else
639 static inline
640 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
641 {
642         return NULL;
643 }
644
645 static inline
646 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
647 {
648         return -ENOENT;
649 }
650
651 static inline
652 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
653 {
654         return -ENOENT;
655 }
656 #endif
657
658 /*
659  * power-management
660  */
661
662 void snd_hda_schedule_power_save(struct hda_codec *codec);
663
664 struct hda_amp_list {
665         hda_nid_t nid;
666         unsigned char dir;
667         unsigned char idx;
668 };
669
670 struct hda_loopback_check {
671         const struct hda_amp_list *amplist;
672         int power_on;
673 };
674
675 int snd_hda_check_amp_list_power(struct hda_codec *codec,
676                                  struct hda_loopback_check *check,
677                                  hda_nid_t nid);
678
679 /* check whether the actual power state matches with the target state */
680 static inline bool
681 snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
682                           unsigned int target_state)
683 {
684         unsigned int state = snd_hda_codec_read(codec, nid, 0,
685                                                 AC_VERB_GET_POWER_STATE, 0);
686         if (state & AC_PWRST_ERROR)
687                 return true;
688         state = (state >> 4) & 0x0f;
689         return (state == target_state);
690 }
691
692 unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
693                                              hda_nid_t nid,
694                                              unsigned int power_state);
695
696 /*
697  * AMP control callbacks
698  */
699 /* retrieve parameters from private_value */
700 #define get_amp_nid_(pv)        ((pv) & 0xffff)
701 #define get_amp_nid(kc)         get_amp_nid_((kc)->private_value)
702 #define get_amp_channels(kc)    (((kc)->private_value >> 16) & 0x3)
703 #define get_amp_direction_(pv)  (((pv) >> 18) & 0x1)
704 #define get_amp_direction(kc)   get_amp_direction_((kc)->private_value)
705 #define get_amp_index_(pv)      (((pv) >> 19) & 0xf)
706 #define get_amp_index(kc)       get_amp_index_((kc)->private_value)
707 #define get_amp_offset(kc)      (((kc)->private_value >> 23) & 0x3f)
708 #define get_amp_min_mute(kc)    (((kc)->private_value >> 29) & 0x1)
709
710 /*
711  * enum control helper
712  */
713 int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
714                              struct snd_ctl_elem_info *uinfo,
715                              int num_entries, const char * const *texts);
716 #define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
717         snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
718
719 /*
720  * CEA Short Audio Descriptor data
721  */
722 struct cea_sad {
723         int     channels;
724         int     format;         /* (format == 0) indicates invalid SAD */
725         int     rates;
726         int     sample_bits;    /* for LPCM */
727         int     max_bitrate;    /* for AC3...ATRAC */
728         int     profile;        /* for WMAPRO */
729 };
730
731 #define ELD_FIXED_BYTES 20
732 #define ELD_MAX_SIZE    256
733 #define ELD_MAX_MNL     16
734 #define ELD_MAX_SAD     16
735
736 /*
737  * ELD: EDID Like Data
738  */
739 struct parsed_hdmi_eld {
740         /*
741          * all fields will be cleared before updating ELD
742          */
743         int     baseline_len;
744         int     eld_ver;
745         int     cea_edid_ver;
746         char    monitor_name[ELD_MAX_MNL + 1];
747         int     manufacture_id;
748         int     product_id;
749         u64     port_id;
750         int     support_hdcp;
751         int     support_ai;
752         int     conn_type;
753         int     aud_synch_delay;
754         int     spk_alloc;
755         int     sad_count;
756         struct cea_sad sad[ELD_MAX_SAD];
757 };
758
759 struct hdmi_eld {
760         bool    monitor_present;
761         bool    eld_valid;
762         int     eld_size;
763         char    eld_buffer[ELD_MAX_SIZE];
764         struct parsed_hdmi_eld info;
765 };
766
767 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
768 int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
769                      unsigned char *buf, int *eld_size);
770 int snd_hdmi_parse_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e,
771                        const unsigned char *buf, int size);
772 void snd_hdmi_show_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e);
773 void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
774                               struct hda_pcm_stream *hinfo);
775
776 int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
777                          unsigned char *buf, int *eld_size,
778                          bool rev3_or_later);
779
780 #ifdef CONFIG_PROC_FS
781 void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
782                              struct snd_info_buffer *buffer);
783 void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
784                              struct snd_info_buffer *buffer);
785 #endif
786
787 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
788 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
789
790 /*
791  */
792 #define codec_err(codec, fmt, args...) \
793         dev_err(hda_codec_dev(codec), fmt, ##args)
794 #define codec_warn(codec, fmt, args...) \
795         dev_warn(hda_codec_dev(codec), fmt, ##args)
796 #define codec_info(codec, fmt, args...) \
797         dev_info(hda_codec_dev(codec), fmt, ##args)
798 #define codec_dbg(codec, fmt, args...) \
799         dev_dbg(hda_codec_dev(codec), fmt, ##args)
800
801 #endif /* __SOUND_HDA_LOCAL_H */