projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: hda - Move the function "check_amp_caps" to hda_codec.c
[linux-2.6-block.git] / sound / pci / hda / hda_local.h
CommitLineData
1da177e4
LT		 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
9c96fa59
TI		 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)
9e3fd871 34#define HDA_SUBDEV_AMP_FLAG (1U << 30)
9c96fa59 35
1da177e4
LT		 36/*
37 * for mixer controls
38 */
29fdbec2
TI		 39#define HDA_COMPOSE_AMP_VAL_OFS(nid,chs,idx,dir,ofs) \
40 ((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19) | ((ofs)<<23))
de8c85f7 41#define HDA_AMP_VAL_MIN_MUTE (1<<29)
d01ce99f 42#define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
29fdbec2 43 HDA_COMPOSE_AMP_VAL_OFS(nid, chs, idx, dir, 0)
985be54b 44/* mono volume with index (index=0,1,...) (channel=1,2) */
de8c85f7 45#define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, dir, flags) \
1da177e4 46 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
5e26dfd0 47 .subdevice = HDA_SUBDEV_AMP_FLAG, \
302e9c5a
JK		 48 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | \
49 SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
50 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
1da177e4
LT		 51 .info = snd_hda_mixer_amp_volume_info, \
52 .get = snd_hda_mixer_amp_volume_get, \
53 .put = snd_hda_mixer_amp_volume_put, \
7cf0a953 54 .tlv = { .c = snd_hda_mixer_amp_tlv }, \
de8c85f7 55 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, dir) | flags }
985be54b 56/* stereo volume with index */
1da177e4 57#define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
de8c85f7 58 HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction, 0)
985be54b 59/* mono volume */
1da177e4 60#define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
de8c85f7 61 HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction, 0)
985be54b 62/* stereo volume */
1da177e4
LT		 63#define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
64 HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
de8c85f7
CL		 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)
985be54b 69/* mono mute switch with index (index=0,1,...) (channel=1,2) */
1da177e4
LT		 70#define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
71 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
5e26dfd0 72 .subdevice = HDA_SUBDEV_AMP_FLAG, \
1da177e4
LT		 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) }
985be54b 77/* stereo mute switch with index */
1da177e4
LT		 78#define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
79 HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
985be54b 80/* mono mute switch */
1da177e4
LT		 81#define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
82 HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
985be54b 83/* stereo mute switch */
1da177e4
LT		 84#define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
85 HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
67d634c0 86#ifdef CONFIG_SND_HDA_INPUT_BEEP
123c07ae
JK		 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, \
5e26dfd0 90 .subdevice = HDA_SUBDEV_AMP_FLAG, \
123c07ae 91 .info = snd_hda_mixer_amp_switch_info, \
0401e854 92 .get = snd_hda_mixer_amp_switch_get_beep, \
123c07ae
JK		 93 .put = snd_hda_mixer_amp_switch_put_beep, \
94 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
67d634c0
TI		 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 */
123c07ae
JK		 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)
1da177e4 106
85dd662f
JK		 107extern const char *snd_hda_pcm_type_name[];
108
d01ce99f
TI		 109int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
110 struct snd_ctl_elem_info *uinfo);
111int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
112 struct snd_ctl_elem_value *ucontrol);
113int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
114 struct snd_ctl_elem_value *ucontrol);
115int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
116 unsigned int size, unsigned int __user *tlv);
117int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
118 struct snd_ctl_elem_info *uinfo);
119int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
120 struct snd_ctl_elem_value *ucontrol);
121int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
122 struct snd_ctl_elem_value *ucontrol);
67d634c0 123#ifdef CONFIG_SND_HDA_INPUT_BEEP
0401e854
TI		 124int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
125 struct snd_ctl_elem_value *ucontrol);
123c07ae
JK		 126int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
127 struct snd_ctl_elem_value *ucontrol);
67d634c0 128#endif
834be88d
TI		 129/* lowlevel accessor with caching; use carefully */
130int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
131 int direction, int index);
132int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
133 int direction, int idx, int mask, int val);
47fd830a
TI		 134int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
135 int dir, int idx, int mask, int val);
280e57d5
TI		 136int snd_hda_codec_amp_init(struct hda_codec *codec, hda_nid_t nid, int ch,
137 int direction, int idx, int mask, int val);
138int snd_hda_codec_amp_init_stereo(struct hda_codec *codec, hda_nid_t nid,
139 int dir, int idx, int mask, int val);
b3ac5636 140void snd_hda_codec_resume_amp(struct hda_codec *codec);
1da177e4 141
2134ea4f
TI		 142void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
143 unsigned int *tlv);
144struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
145 const char *name);
18478e8b 146int __snd_hda_add_vmaster(struct hda_codec *codec, char *name,
29e5853d
TI		 147 unsigned int *tlv, const char * const *slaves,
148 const char *suffix, bool init_slave_vol,
149 struct snd_kcontrol **ctl_ret);
18478e8b 150#define snd_hda_add_vmaster(codec, name, tlv, slaves, suffix) \
29e5853d 151 __snd_hda_add_vmaster(codec, name, tlv, slaves, suffix, true, NULL)
a65d629c 152int snd_hda_codec_reset(struct hda_codec *codec);
2134ea4f 153
d2f344b5
TI		 154enum {
155 HDA_VMUTE_OFF,
156 HDA_VMUTE_ON,
157 HDA_VMUTE_FOLLOW_MASTER,
158};
159
160struct 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
171int snd_hda_add_vmaster_hook(struct hda_codec *codec,
f29735cb
TI		 172 struct hda_vmaster_mute_hook *hook,
173 bool expose_enum_ctl);
d2f344b5
TI		 174void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook);
175
47fd830a
TI		 176/* amp value bits */
177#define HDA_AMP_MUTE 0x80
178#define HDA_AMP_UNMUTE 0x00
179#define HDA_AMP_VOLMASK 0x7f
180
985be54b
TI		 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 */
d01ce99f
TI		 190#define HDA_BIND_MUTE(xname,nid,indices,dir) \
191 HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
985be54b 192
d01ce99f
TI		 193int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
194 struct snd_ctl_elem_value *ucontrol);
195int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
196 struct snd_ctl_elem_value *ucontrol);
985be54b 197
532d5381
TI		 198/* more generic bound controls */
199struct 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
206extern struct hda_ctl_ops snd_hda_bind_vol; /* for bind-volume with TLV */
207extern struct hda_ctl_ops snd_hda_bind_sw; /* for bind-switch */
208
209struct hda_bind_ctls {
210 struct hda_ctl_ops *ops;
5d9b6c07 211 unsigned long values[];
532d5381
TI		 212};
213
214int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
215 struct snd_ctl_elem_info *uinfo);
216int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
217 struct snd_ctl_elem_value *ucontrol);
218int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
219 struct snd_ctl_elem_value *ucontrol);
220int 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 */
dcda5806
TI		 245int 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)
1da177e4
LT		 250int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
251
252/*
253 * input MUX helper
254 */
54d17403 255#define HDA_MAX_NUM_INPUTS 16
1da177e4 256struct hda_input_mux_item {
b5786e85 257 char label[32];
1da177e4
LT		 258 unsigned int index;
259};
260struct hda_input_mux {
261 unsigned int num_items;
262 struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
263};
264
d01ce99f
TI		 265int snd_hda_input_mux_info(const struct hda_input_mux *imux,
266 struct snd_ctl_elem_info *uinfo);
267int snd_hda_input_mux_put(struct hda_codec *codec,
268 const struct hda_input_mux *imux,
c8b6bf9b 269 struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
1da177e4 270 unsigned int *cur_val);
6194b99d
TI		 271int snd_hda_add_imux_item(struct hda_codec *codec,
272 struct hda_input_mux *imux, const char *label,
128bc4ba 273 int index, int *type_index_ret);
1da177e4 274
c8b6bf9b 275/*
d2a6d7dc
TI		 276 * Channel mode helper
277 */
278struct hda_channel_mode {
279 int channels;
280 const struct hda_verb *sequence;
281};
282
d01ce99f
TI		 283int snd_hda_ch_mode_info(struct hda_codec *codec,
284 struct snd_ctl_elem_info *uinfo,
285 const struct hda_channel_mode *chmode,
286 int num_chmodes);
287int snd_hda_ch_mode_get(struct hda_codec *codec,
288 struct snd_ctl_elem_value *ucontrol,
289 const struct hda_channel_mode *chmode,
290 int num_chmodes,
d2a6d7dc 291 int max_channels);
d01ce99f
TI		 292int snd_hda_ch_mode_put(struct hda_codec *codec,
293 struct snd_ctl_elem_value *ucontrol,
294 const struct hda_channel_mode *chmode,
295 int num_chmodes,
d2a6d7dc
TI		 296 int *max_channelsp);
297
1da177e4
LT		 298/*
299 * Multi-channel / digital-out PCM helper
300 */
301
302enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
303enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
304
a06dbfc2
TI		 305#define HDA_MAX_OUTS 5
306
1da177e4
LT		 307struct hda_multi_out {
308 int num_dacs; /* # of DACs, must be more than 1 */
dda14410 309 const hda_nid_t *dac_nids; /* DAC list */
1da177e4 310 hda_nid_t hp_nid; /* optional DAC for HP, 0 when not exists */
a06dbfc2
TI		 311 hda_nid_t hp_out_nid[HDA_MAX_OUTS]; /* DACs for multiple HPs */
312 hda_nid_t extra_out_nid[HDA_MAX_OUTS]; /* other (e.g. speaker) DACs */
1da177e4 313 hda_nid_t dig_out_nid; /* digital out audio widget */
dda14410 314 const hda_nid_t *slave_dig_outs;
1da177e4
LT		 315 int max_channels; /* currently supported analog channels */
316 int dig_out_used; /* current usage of digital out (HDA_DIG_XXX) */
d29240ce 317 int no_share_stream; /* don't share a stream with multiple pins */
9a08160b
TI		 318 int share_spdif; /* share SPDIF pin */
319 /* PCM information for both analog and SPDIF DACs */
320 unsigned int analog_rates;
321 unsigned int analog_maxbps;
322 u64 analog_formats;
323 unsigned int spdif_rates;
324 unsigned int spdif_maxbps;
325 u64 spdif_formats;
1da177e4
LT		 326};
327
9a08160b
TI		 328int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
329 struct hda_multi_out *mout);
d01ce99f
TI		 330int snd_hda_multi_out_dig_open(struct hda_codec *codec,
331 struct hda_multi_out *mout);
332int snd_hda_multi_out_dig_close(struct hda_codec *codec,
333 struct hda_multi_out *mout);
6b97eb45
TI		 334int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
335 struct hda_multi_out *mout,
336 unsigned int stream_tag,
337 unsigned int format,
338 struct snd_pcm_substream *substream);
9411e21c
TI		 339int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
340 struct hda_multi_out *mout);
d01ce99f
TI		 341int snd_hda_multi_out_analog_open(struct hda_codec *codec,
342 struct hda_multi_out *mout,
9a08160b
TI		 343 struct snd_pcm_substream *substream,
344 struct hda_pcm_stream *hinfo);
d01ce99f
TI		 345int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
346 struct hda_multi_out *mout,
1da177e4
LT		 347 unsigned int stream_tag,
348 unsigned int format,
c8b6bf9b 349 struct snd_pcm_substream *substream);
d01ce99f
TI		 350int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
351 struct hda_multi_out *mout);
1da177e4
LT		 352
353/*
354 * generic codec parser
355 */
356int snd_hda_parse_generic_codec(struct hda_codec *codec);
f0639272 357int snd_hda_parse_hdmi_codec(struct hda_codec *codec);
1da177e4
LT		 358
359/*
360 * generic proc interface
361 */
362#ifdef CONFIG_PROC_FS
363int snd_hda_codec_proc_new(struct hda_codec *codec);
364#else
365static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
366#endif
367
d39b4352
WF		 368#define SND_PRINT_BITS_ADVISED_BUFSIZE 16
369void snd_print_pcm_bits(int pcm, char *buf, int buflen);
370
1da177e4
LT		 371/*
372 * Misc
373 */
d01ce99f 374int snd_hda_add_new_ctls(struct hda_codec *codec,
031024ee 375 const struct snd_kcontrol_new *knew);
1da177e4 376
c9ce6b26
TI		 377/*
378 * Fix-up pin default configurations and add default verbs
379 */
380
381struct hda_pintbl {
382 hda_nid_t nid;
383 u32 val;
384};
385
386struct hda_model_fixup {
387 const int id;
388 const char *name;
389};
390
391struct hda_fixup {
392 int type;
1f578250
TI		 393 bool chained:1; /* call the chained fixup(s) after this */
394 bool chained_before:1; /* call the chained fixup(s) before this */
c9ce6b26
TI		 395 int chain_id;
396 union {
397 const struct hda_pintbl *pins;
398 const struct hda_verb *verbs;
399 void (*func)(struct hda_codec *codec,
400 const struct hda_fixup *fix,
401 int action);
402 } v;
403};
404
20531415
DH		 405struct snd_hda_pin_quirk {
406 unsigned int codec; /* Codec vendor/device ID */
407 unsigned short subvendor; /* PCI subvendor ID */
408 const struct hda_pintbl *pins; /* list of matching pins */
409#ifdef CONFIG_SND_DEBUG_VERBOSE
410 const char *name;
411#endif
412 int value; /* quirk value */
413};
414
a2d2fa02
DH		 415#ifdef CONFIG_SND_DEBUG_VERBOSE
416
417#define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
418 { .codec = _codec,\
419 .subvendor = _subvendor,\
420 .name = _name,\
421 .value = _value,\
422 .pins = (const struct hda_pintbl[]) { _pins } \
423 }
424#else
425
426#define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
427 { .codec = _codec,\
428 .subvendor = _subvendor,\
429 .value = _value,\
430 .pins = (const struct hda_pintbl[]) { _pins } \
431 }
432
433#endif
434
f5662e1c
DH		 435#define HDA_FIXUP_ID_NOT_SET -1
436#define HDA_FIXUP_ID_NO_FIXUP -2
a2d2fa02 437
c9ce6b26
TI		 438/* fixup types */
439enum {
440 HDA_FIXUP_INVALID,
441 HDA_FIXUP_PINS,
442 HDA_FIXUP_VERBS,
443 HDA_FIXUP_FUNC,
fd108215 444 HDA_FIXUP_PINCTLS,
c9ce6b26
TI		 445};
446
447/* fixup action definitions */
448enum {
449 HDA_FIXUP_ACT_PRE_PROBE,
450 HDA_FIXUP_ACT_PROBE,
451 HDA_FIXUP_ACT_INIT,
452 HDA_FIXUP_ACT_BUILD,
360fec28 453 HDA_FIXUP_ACT_FREE,
c9ce6b26
TI		 454};
455
456int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
457void snd_hda_apply_verbs(struct hda_codec *codec);
458void snd_hda_apply_pincfgs(struct hda_codec *codec,
459 const struct hda_pintbl *cfg);
460void snd_hda_apply_fixup(struct hda_codec *codec, int action);
461void snd_hda_pick_fixup(struct hda_codec *codec,
462 const struct hda_model_fixup *models,
463 const struct snd_pci_quirk *quirk,
464 const struct hda_fixup *fixlist);
20531415
DH		 465void snd_hda_pick_pin_fixup(struct hda_codec *codec,
466 const struct snd_hda_pin_quirk *pin_quirk,
467 const struct hda_fixup *fixlist);
468
c9ce6b26 469
1da177e4
LT		 470/*
471 * unsolicited event handler
472 */
473
474#define HDA_UNSOL_QUEUE_SIZE 64
475
476struct hda_bus_unsolicited {
477 /* ring buffer */
478 u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
479 unsigned int rp, wp;
480
481 /* workqueue */
1da177e4 482 struct work_struct work;
c4028958 483 struct hda_bus *bus;
1da177e4
LT		 484};
485
128bc4ba 486/* helper macros to retrieve pin default-config values */
d01ce99f
TI		 487#define get_defcfg_connect(cfg) \
488 ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
489#define get_defcfg_association(cfg) \
490 ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
491#define get_defcfg_location(cfg) \
492 ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
493#define get_defcfg_sequence(cfg) \
494 (cfg & AC_DEFCFG_SEQUENCE)
495#define get_defcfg_device(cfg) \
496 ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
08a1f5eb
TI		 497#define get_defcfg_misc(cfg) \
498 ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
d01ce99f 499
8d88bc3d
TI		 500/* amp values */
501#define AMP_IN_MUTE(idx) (0x7080 | ((idx)<<8))
502#define AMP_IN_UNMUTE(idx) (0x7000 | ((idx)<<8))
d301fc32
TI		 503#define AMP_OUT_MUTE 0xb080
504#define AMP_OUT_UNMUTE 0xb000
505#define AMP_OUT_ZERO 0xb000
8d88bc3d 506/* pinctl values */
35e8901e 507#define PIN_IN (AC_PINCTL_IN_EN)
d301fc32 508#define PIN_VREFHIZ (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
35e8901e 509#define PIN_VREF50 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
d301fc32 510#define PIN_VREFGRD (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
35e8901e 511#define PIN_VREF80 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
d301fc32
TI		 512#define PIN_VREF100 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
513#define PIN_OUT (AC_PINCTL_OUT_EN)
35e8901e
RJ		 514#define PIN_HP (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
515#define PIN_HP_AMP (AC_PINCTL_HP_EN)
8d88bc3d 516
4740860b 517unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
62f3a2f7
TI		 518unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
519 hda_nid_t pin, unsigned int val);
cdd03ced
TI		 520int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
521 unsigned int val, bool cached);
522
523/**
524 * _snd_hda_set_pin_ctl - Set a pin-control value safely
525 * @codec: the codec instance
526 * @pin: the pin NID to set the control
527 * @val: the pin-control value (AC_PINCTL_* bits)
528 *
529 * This function sets the pin-control value to the given pin, but
530 * filters out the invalid pin-control bits when the pin has no such
531 * capabilities. For example, when PIN_HP is passed but the pin has no
532 * HP-drive capability, the HP bit is omitted.
533 *
534 * The function doesn't check the input VREF capability bits, though.
4740860b 535 * Use snd_hda_get_default_vref() to guess the right value.
cdd03ced
TI		 536 * Also, this function is only for analog pins, not for HDMI pins.
537 */
538static inline int
539snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
540{
541 return _snd_hda_set_pin_ctl(codec, pin, val, false);
542}
543
544/**
545 * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
546 * @codec: the codec instance
547 * @pin: the pin NID to set the control
548 * @val: the pin-control value (AC_PINCTL_* bits)
549 *
550 * Just like snd_hda_set_pin_ctl() but write to cache as well.
551 */
552static inline int
553snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
554 unsigned int val)
555{
556 return _snd_hda_set_pin_ctl(codec, pin, val, true);
557}
558
d7fdc00a
TI		 559int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
560int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
561 unsigned int val);
562
54d17403
TI		 563/*
564 * get widget capabilities
565 */
566static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
567{
568 if (nid < codec->start_nid ||
569 nid >= codec->start_nid + codec->num_nodes)
dca008f3 570 return 0;
54d17403
TI		 571 return codec->wcaps[nid - codec->start_nid];
572}
573
a22d543a 574/* get the widget type from widget capability bits */
3a90274d
TI		 575static inline int get_wcaps_type(unsigned int wcaps)
576{
577 if (!wcaps)
578 return -1; /* invalid type */
579 return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
580}
a22d543a 581
fd72d008
WF		 582static inline unsigned int get_wcaps_channels(u32 wcaps)
583{
584 unsigned int chans;
585
586 chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
587 chans = ((chans << 1) | 1) + 1;
588
589 return chans;
590}
591
d045c5dc
TI		 592static inline void snd_hda_override_wcaps(struct hda_codec *codec,
593 hda_nid_t nid, u32 val)
594{
595 if (nid >= codec->start_nid &&
596 nid < codec->start_nid + codec->num_nodes)
597 codec->wcaps[nid - codec->start_nid] = val;
598}
599
09a99959 600u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
897cc188
TI		 601int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
602 unsigned int caps);
1327a32b 603u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
f57c2565
TI		 604int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
605 unsigned int caps);
861a04ed
DH		 606bool snd_hda_check_amp_caps(struct hda_codec *codec, hda_nid_t nid,
607 int dir, unsigned int bits);
608
609#define nid_has_mute(codec, nid, dir) \
610 snd_hda_check_amp_caps(codec, nid, dir, (AC_AMPCAP_MUTE | AC_AMPCAP_MIN_MUTE))
611#define nid_has_volume(codec, nid, dir) \
612 snd_hda_check_amp_caps(codec, nid, dir, AC_AMPCAP_NUM_STEPS)
613
03697e2a 614
9e3fd871
JK		 615/* flags for hda_nid_item */
616#define HDA_NID_ITEM_AMP (1<<0)
617
3911a4c1
JK		 618struct hda_nid_item {
619 struct snd_kcontrol *kctl;
5b0cb1d8 620 unsigned int index;
3911a4c1 621 hda_nid_t nid;
9e3fd871 622 unsigned short flags;
3911a4c1
JK		 623};
624
625int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
626 struct snd_kcontrol *kctl);
5b0cb1d8
JK		 627int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
628 unsigned int index, hda_nid_t nid);
d13bd412
TI		 629void snd_hda_ctls_clear(struct hda_codec *codec);
630
2807314d
TI		 631/*
632 * hwdep interface
633 */
d7ffba19 634#ifdef CONFIG_SND_HDA_HWDEP
2807314d 635int snd_hda_create_hwdep(struct hda_codec *codec);
d7ffba19
TI		 636#else
637static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
638#endif
2807314d 639
648a8d27
TI		 640void snd_hda_sysfs_init(struct hda_codec *codec);
641void snd_hda_sysfs_clear(struct hda_codec *codec);
642
643extern const struct attribute_group *snd_hda_dev_attr_groups[];
644
43b62713
TI		 645#ifdef CONFIG_SND_HDA_RECONFIG
646const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
647int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
bc759721 648int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
43b62713
TI		 649#else
650static inline
651const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
652{
653 return NULL;
654}
655
656static inline
657int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
658{
659 return -ENOENT;
660}
bc759721
TI		 661
662static inline
663int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
664{
665 return -ENOENT;
666}
43b62713
TI		 667#endif
668
cb53c626
TI		 669/*
670 * power-management
671 */
672
cb53c626
TI		 673void snd_hda_schedule_power_save(struct hda_codec *codec);
674
675struct hda_amp_list {
676 hda_nid_t nid;
677 unsigned char dir;
678 unsigned char idx;
679};
680
681struct hda_loopback_check {
031024ee 682 const struct hda_amp_list *amplist;
cb53c626
TI		 683 int power_on;
684};
685
686int snd_hda_check_amp_list_power(struct hda_codec *codec,
687 struct hda_loopback_check *check,
688 hda_nid_t nid);
cb53c626 689
9040d102
TI		 690/* check whether the actual power state matches with the target state */
691static inline bool
692snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
693 unsigned int target_state)
694{
695 unsigned int state = snd_hda_codec_read(codec, nid, 0,
696 AC_VERB_GET_POWER_STATE, 0);
697 if (state & AC_PWRST_ERROR)
698 return true;
699 state = (state >> 4) & 0x0f;
06ec56d3 700 return (state == target_state);
9040d102
TI		 701}
702
ba615b86
TI		 703unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
704 hda_nid_t nid,
705 unsigned int power_state);
706
89385035
MR		 707/*
708 * AMP control callbacks
709 */
710/* retrieve parameters from private_value */
3911a4c1
JK		 711#define get_amp_nid_(pv) ((pv) & 0xffff)
712#define get_amp_nid(kc) get_amp_nid_((kc)->private_value)
89385035 713#define get_amp_channels(kc) (((kc)->private_value >> 16) & 0x3)
527e4d73
TI		 714#define get_amp_direction_(pv) (((pv) >> 18) & 0x1)
715#define get_amp_direction(kc) get_amp_direction_((kc)->private_value)
130e5f06
TI		 716#define get_amp_index_(pv) (((pv) >> 19) & 0xf)
717#define get_amp_index(kc) get_amp_index_((kc)->private_value)
29fdbec2 718#define get_amp_offset(kc) (((kc)->private_value >> 23) & 0x3f)
de8c85f7 719#define get_amp_min_mute(kc) (((kc)->private_value >> 29) & 0x1)
89385035 720
dda415d4
TI		 721/*
722 * enum control helper
723 */
724int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
725 struct snd_ctl_elem_info *uinfo,
726 int num_entries, const char * const *texts);
727#define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
728 snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
729
7f4a9f43
WF		 730/*
731 * CEA Short Audio Descriptor data
732 */
733struct cea_sad {
734 int channels;
735 int format; /* (format == 0) indicates invalid SAD */
736 int rates;
737 int sample_bits; /* for LPCM */
738 int max_bitrate; /* for AC3...ATRAC */
739 int profile; /* for WMAPRO */
740};
741
742#define ELD_FIXED_BYTES 20
14bc52b8 743#define ELD_MAX_SIZE 256
7f4a9f43
WF		 744#define ELD_MAX_MNL 16
745#define ELD_MAX_SAD 16
746
747/*
748 * ELD: EDID Like Data
749 */
1613d6b4
DH		 750struct parsed_hdmi_eld {
751 /*
752 * all fields will be cleared before updating ELD
753 */
7f4a9f43 754 int baseline_len;
23ccc2bd 755 int eld_ver;
7f4a9f43
WF		 756 int cea_edid_ver;
757 char monitor_name[ELD_MAX_MNL + 1];
758 int manufacture_id;
759 int product_id;
760 u64 port_id;
761 int support_hdcp;
762 int support_ai;
763 int conn_type;
764 int aud_synch_delay;
765 int spk_alloc;
766 int sad_count;
767 struct cea_sad sad[ELD_MAX_SAD];
1613d6b4
DH		 768};
769
770struct hdmi_eld {
771 bool monitor_present;
772 bool eld_valid;
773 int eld_size;
14bc52b8 774 char eld_buffer[ELD_MAX_SIZE];
1613d6b4 775 struct parsed_hdmi_eld info;
7f4a9f43
WF		 776};
777
778int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
1613d6b4
DH		 779int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
780 unsigned char *buf, int *eld_size);
79514d47 781int snd_hdmi_parse_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e,
1613d6b4 782 const unsigned char *buf, int size);
79514d47 783void snd_hdmi_show_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e);
1613d6b4 784void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
2def8172 785 struct hda_pcm_stream *hinfo);
7f4a9f43 786
89250f84
AH		 787int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
788 unsigned char *buf, int *eld_size,
789 bool rev3_or_later);
790
5f1e71b1 791#ifdef CONFIG_PROC_FS
a4e9a38b
TI		 792void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
793 struct snd_info_buffer *buffer);
794void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
795 struct snd_info_buffer *buffer);
5f1e71b1
WF		 796#endif
797
903b21d8
WF		 798#define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
799void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
800
4e76a883
TI		 801/*
802 */
803#define codec_err(codec, fmt, args...) dev_err(&(codec)->dev, fmt, ##args)
804#define codec_warn(codec, fmt, args...) dev_warn(&(codec)->dev, fmt, ##args)
805#define codec_info(codec, fmt, args...) dev_info(&(codec)->dev, fmt, ##args)
806#define codec_dbg(codec, fmt, args...) dev_dbg(&(codec)->dev, fmt, ##args)
807
1da177e4 808#endif /* __SOUND_HDA_LOCAL_H */
Linux 6.x block layer and io_uring tree(s)