projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: hda - Enable sysfs attributes without CONFIG_SND_HDA_RECONFIG
[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);
128bc4ba
TI		 271int snd_hda_add_imux_item(struct hda_input_mux *imux, const char *label,
272 int index, int *type_index_ret);
1da177e4 273
c8b6bf9b 274/*
d2a6d7dc
TI		 275 * Channel mode helper
276 */
277struct hda_channel_mode {
278 int channels;
279 const struct hda_verb *sequence;
280};
281
d01ce99f
TI		 282int snd_hda_ch_mode_info(struct hda_codec *codec,
283 struct snd_ctl_elem_info *uinfo,
284 const struct hda_channel_mode *chmode,
285 int num_chmodes);
286int snd_hda_ch_mode_get(struct hda_codec *codec,
287 struct snd_ctl_elem_value *ucontrol,
288 const struct hda_channel_mode *chmode,
289 int num_chmodes,
d2a6d7dc 290 int max_channels);
d01ce99f
TI		 291int snd_hda_ch_mode_put(struct hda_codec *codec,
292 struct snd_ctl_elem_value *ucontrol,
293 const struct hda_channel_mode *chmode,
294 int num_chmodes,
d2a6d7dc
TI		 295 int *max_channelsp);
296
1da177e4
LT		 297/*
298 * Multi-channel / digital-out PCM helper
299 */
300
301enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
302enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
303
a06dbfc2
TI		 304#define HDA_MAX_OUTS 5
305
1da177e4
LT		 306struct hda_multi_out {
307 int num_dacs; /* # of DACs, must be more than 1 */
dda14410 308 const hda_nid_t *dac_nids; /* DAC list */
1da177e4 309 hda_nid_t hp_nid; /* optional DAC for HP, 0 when not exists */
a06dbfc2
TI		 310 hda_nid_t hp_out_nid[HDA_MAX_OUTS]; /* DACs for multiple HPs */
311 hda_nid_t extra_out_nid[HDA_MAX_OUTS]; /* other (e.g. speaker) DACs */
1da177e4 312 hda_nid_t dig_out_nid; /* digital out audio widget */
dda14410 313 const hda_nid_t *slave_dig_outs;
1da177e4
LT		 314 int max_channels; /* currently supported analog channels */
315 int dig_out_used; /* current usage of digital out (HDA_DIG_XXX) */
d29240ce 316 int no_share_stream; /* don't share a stream with multiple pins */
9a08160b
TI		 317 int share_spdif; /* share SPDIF pin */
318 /* PCM information for both analog and SPDIF DACs */
319 unsigned int analog_rates;
320 unsigned int analog_maxbps;
321 u64 analog_formats;
322 unsigned int spdif_rates;
323 unsigned int spdif_maxbps;
324 u64 spdif_formats;
1da177e4
LT		 325};
326
9a08160b
TI		 327int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
328 struct hda_multi_out *mout);
d01ce99f
TI		 329int snd_hda_multi_out_dig_open(struct hda_codec *codec,
330 struct hda_multi_out *mout);
331int snd_hda_multi_out_dig_close(struct hda_codec *codec,
332 struct hda_multi_out *mout);
6b97eb45
TI		 333int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
334 struct hda_multi_out *mout,
335 unsigned int stream_tag,
336 unsigned int format,
337 struct snd_pcm_substream *substream);
9411e21c
TI		 338int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
339 struct hda_multi_out *mout);
d01ce99f
TI		 340int snd_hda_multi_out_analog_open(struct hda_codec *codec,
341 struct hda_multi_out *mout,
9a08160b
TI		 342 struct snd_pcm_substream *substream,
343 struct hda_pcm_stream *hinfo);
d01ce99f
TI		 344int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
345 struct hda_multi_out *mout,
1da177e4
LT		 346 unsigned int stream_tag,
347 unsigned int format,
c8b6bf9b 348 struct snd_pcm_substream *substream);
d01ce99f
TI		 349int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
350 struct hda_multi_out *mout);
1da177e4
LT		 351
352/*
353 * generic codec parser
354 */
355int snd_hda_parse_generic_codec(struct hda_codec *codec);
f0639272 356int snd_hda_parse_hdmi_codec(struct hda_codec *codec);
1da177e4
LT		 357
358/*
359 * generic proc interface
360 */
361#ifdef CONFIG_PROC_FS
362int snd_hda_codec_proc_new(struct hda_codec *codec);
363#else
364static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
365#endif
366
d39b4352
WF		 367#define SND_PRINT_BITS_ADVISED_BUFSIZE 16
368void snd_print_pcm_bits(int pcm, char *buf, int buflen);
369
1da177e4
LT		 370/*
371 * Misc
372 */
f5fcc13c 373int snd_hda_check_board_config(struct hda_codec *codec, int num_configs,
ea734963 374 const char * const *modelnames,
f5fcc13c 375 const struct snd_pci_quirk *pci_list);
2eda3445 376int snd_hda_check_board_codec_sid_config(struct hda_codec *codec,
ea734963 377 int num_configs, const char * const *models,
2eda3445 378 const struct snd_pci_quirk *tbl);
d01ce99f 379int snd_hda_add_new_ctls(struct hda_codec *codec,
031024ee 380 const struct snd_kcontrol_new *knew);
1da177e4 381
c9ce6b26
TI		 382/*
383 * Fix-up pin default configurations and add default verbs
384 */
385
386struct hda_pintbl {
387 hda_nid_t nid;
388 u32 val;
389};
390
391struct hda_model_fixup {
392 const int id;
393 const char *name;
394};
395
396struct hda_fixup {
397 int type;
1f578250
TI		 398 bool chained:1; /* call the chained fixup(s) after this */
399 bool chained_before:1; /* call the chained fixup(s) before this */
c9ce6b26
TI		 400 int chain_id;
401 union {
402 const struct hda_pintbl *pins;
403 const struct hda_verb *verbs;
404 void (*func)(struct hda_codec *codec,
405 const struct hda_fixup *fix,
406 int action);
407 } v;
408};
409
410/* fixup types */
411enum {
412 HDA_FIXUP_INVALID,
413 HDA_FIXUP_PINS,
414 HDA_FIXUP_VERBS,
415 HDA_FIXUP_FUNC,
fd108215 416 HDA_FIXUP_PINCTLS,
c9ce6b26
TI		 417};
418
419/* fixup action definitions */
420enum {
421 HDA_FIXUP_ACT_PRE_PROBE,
422 HDA_FIXUP_ACT_PROBE,
423 HDA_FIXUP_ACT_INIT,
424 HDA_FIXUP_ACT_BUILD,
360fec28 425 HDA_FIXUP_ACT_FREE,
c9ce6b26
TI		 426};
427
428int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
429void snd_hda_apply_verbs(struct hda_codec *codec);
430void snd_hda_apply_pincfgs(struct hda_codec *codec,
431 const struct hda_pintbl *cfg);
432void snd_hda_apply_fixup(struct hda_codec *codec, int action);
433void snd_hda_pick_fixup(struct hda_codec *codec,
434 const struct hda_model_fixup *models,
435 const struct snd_pci_quirk *quirk,
436 const struct hda_fixup *fixlist);
437
1da177e4
LT		 438/*
439 * unsolicited event handler
440 */
441
442#define HDA_UNSOL_QUEUE_SIZE 64
443
444struct hda_bus_unsolicited {
445 /* ring buffer */
446 u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
447 unsigned int rp, wp;
448
449 /* workqueue */
1da177e4 450 struct work_struct work;
c4028958 451 struct hda_bus *bus;
1da177e4
LT		 452};
453
128bc4ba 454/* helper macros to retrieve pin default-config values */
d01ce99f
TI		 455#define get_defcfg_connect(cfg) \
456 ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
457#define get_defcfg_association(cfg) \
458 ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
459#define get_defcfg_location(cfg) \
460 ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
461#define get_defcfg_sequence(cfg) \
462 (cfg & AC_DEFCFG_SEQUENCE)
463#define get_defcfg_device(cfg) \
464 ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
08a1f5eb
TI		 465#define get_defcfg_misc(cfg) \
466 ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
d01ce99f 467
8d88bc3d
TI		 468/* amp values */
469#define AMP_IN_MUTE(idx) (0x7080 | ((idx)<<8))
470#define AMP_IN_UNMUTE(idx) (0x7000 | ((idx)<<8))
d301fc32
TI		 471#define AMP_OUT_MUTE 0xb080
472#define AMP_OUT_UNMUTE 0xb000
473#define AMP_OUT_ZERO 0xb000
8d88bc3d 474/* pinctl values */
35e8901e 475#define PIN_IN (AC_PINCTL_IN_EN)
d301fc32 476#define PIN_VREFHIZ (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
35e8901e 477#define PIN_VREF50 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
d301fc32 478#define PIN_VREFGRD (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
35e8901e 479#define PIN_VREF80 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
d301fc32
TI		 480#define PIN_VREF100 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
481#define PIN_OUT (AC_PINCTL_OUT_EN)
35e8901e
RJ		 482#define PIN_HP (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
483#define PIN_HP_AMP (AC_PINCTL_HP_EN)
8d88bc3d 484
4740860b 485unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
62f3a2f7
TI		 486unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
487 hda_nid_t pin, unsigned int val);
cdd03ced
TI		 488int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
489 unsigned int val, bool cached);
490
491/**
492 * _snd_hda_set_pin_ctl - Set a pin-control value safely
493 * @codec: the codec instance
494 * @pin: the pin NID to set the control
495 * @val: the pin-control value (AC_PINCTL_* bits)
496 *
497 * This function sets the pin-control value to the given pin, but
498 * filters out the invalid pin-control bits when the pin has no such
499 * capabilities. For example, when PIN_HP is passed but the pin has no
500 * HP-drive capability, the HP bit is omitted.
501 *
502 * The function doesn't check the input VREF capability bits, though.
4740860b 503 * Use snd_hda_get_default_vref() to guess the right value.
cdd03ced
TI		 504 * Also, this function is only for analog pins, not for HDMI pins.
505 */
506static inline int
507snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
508{
509 return _snd_hda_set_pin_ctl(codec, pin, val, false);
510}
511
512/**
513 * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
514 * @codec: the codec instance
515 * @pin: the pin NID to set the control
516 * @val: the pin-control value (AC_PINCTL_* bits)
517 *
518 * Just like snd_hda_set_pin_ctl() but write to cache as well.
519 */
520static inline int
521snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
522 unsigned int val)
523{
524 return _snd_hda_set_pin_ctl(codec, pin, val, true);
525}
526
d7fdc00a
TI		 527int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
528int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
529 unsigned int val);
530
54d17403
TI		 531/*
532 * get widget capabilities
533 */
534static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
535{
536 if (nid < codec->start_nid ||
537 nid >= codec->start_nid + codec->num_nodes)
dca008f3 538 return 0;
54d17403
TI		 539 return codec->wcaps[nid - codec->start_nid];
540}
541
a22d543a 542/* get the widget type from widget capability bits */
3a90274d
TI		 543static inline int get_wcaps_type(unsigned int wcaps)
544{
545 if (!wcaps)
546 return -1; /* invalid type */
547 return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
548}
a22d543a 549
fd72d008
WF		 550static inline unsigned int get_wcaps_channels(u32 wcaps)
551{
552 unsigned int chans;
553
554 chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
555 chans = ((chans << 1) | 1) + 1;
556
557 return chans;
558}
559
d045c5dc
TI		 560static inline void snd_hda_override_wcaps(struct hda_codec *codec,
561 hda_nid_t nid, u32 val)
562{
563 if (nid >= codec->start_nid &&
564 nid < codec->start_nid + codec->num_nodes)
565 codec->wcaps[nid - codec->start_nid] = val;
566}
567
09a99959 568u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
897cc188
TI		 569int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
570 unsigned int caps);
1327a32b 571u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
f57c2565
TI		 572int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
573 unsigned int caps);
03697e2a 574
9e3fd871
JK		 575/* flags for hda_nid_item */
576#define HDA_NID_ITEM_AMP (1<<0)
577
3911a4c1
JK		 578struct hda_nid_item {
579 struct snd_kcontrol *kctl;
5b0cb1d8 580 unsigned int index;
3911a4c1 581 hda_nid_t nid;
9e3fd871 582 unsigned short flags;
3911a4c1
JK		 583};
584
585int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
586 struct snd_kcontrol *kctl);
5b0cb1d8
JK		 587int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
588 unsigned int index, hda_nid_t nid);
d13bd412
TI		 589void snd_hda_ctls_clear(struct hda_codec *codec);
590
2807314d
TI		 591/*
592 * hwdep interface
593 */
d7ffba19 594#ifdef CONFIG_SND_HDA_HWDEP
2807314d 595int snd_hda_create_hwdep(struct hda_codec *codec);
d7ffba19
TI		 596#else
597static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
598#endif
2807314d 599
648a8d27
TI		 600void snd_hda_sysfs_init(struct hda_codec *codec);
601void snd_hda_sysfs_clear(struct hda_codec *codec);
602
603extern const struct attribute_group *snd_hda_dev_attr_groups[];
604
43b62713
TI		 605#ifdef CONFIG_SND_HDA_RECONFIG
606const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
607int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
bc759721 608int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
43b62713
TI		 609#else
610static inline
611const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
612{
613 return NULL;
614}
615
616static inline
617int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
618{
619 return -ENOENT;
620}
bc759721
TI		 621
622static inline
623int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
624{
625 return -ENOENT;
626}
43b62713
TI		 627#endif
628
cb53c626
TI		 629/*
630 * power-management
631 */
632
cb53c626
TI		 633void snd_hda_schedule_power_save(struct hda_codec *codec);
634
635struct hda_amp_list {
636 hda_nid_t nid;
637 unsigned char dir;
638 unsigned char idx;
639};
640
641struct hda_loopback_check {
031024ee 642 const struct hda_amp_list *amplist;
cb53c626
TI		 643 int power_on;
644};
645
646int snd_hda_check_amp_list_power(struct hda_codec *codec,
647 struct hda_loopback_check *check,
648 hda_nid_t nid);
cb53c626 649
9040d102
TI		 650/* check whether the actual power state matches with the target state */
651static inline bool
652snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
653 unsigned int target_state)
654{
655 unsigned int state = snd_hda_codec_read(codec, nid, 0,
656 AC_VERB_GET_POWER_STATE, 0);
657 if (state & AC_PWRST_ERROR)
658 return true;
659 state = (state >> 4) & 0x0f;
06ec56d3 660 return (state == target_state);
9040d102
TI		 661}
662
ba615b86
TI		 663unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
664 hda_nid_t nid,
665 unsigned int power_state);
666
89385035
MR		 667/*
668 * AMP control callbacks
669 */
670/* retrieve parameters from private_value */
3911a4c1
JK		 671#define get_amp_nid_(pv) ((pv) & 0xffff)
672#define get_amp_nid(kc) get_amp_nid_((kc)->private_value)
89385035 673#define get_amp_channels(kc) (((kc)->private_value >> 16) & 0x3)
527e4d73
TI		 674#define get_amp_direction_(pv) (((pv) >> 18) & 0x1)
675#define get_amp_direction(kc) get_amp_direction_((kc)->private_value)
130e5f06
TI		 676#define get_amp_index_(pv) (((pv) >> 19) & 0xf)
677#define get_amp_index(kc) get_amp_index_((kc)->private_value)
29fdbec2 678#define get_amp_offset(kc) (((kc)->private_value >> 23) & 0x3f)
de8c85f7 679#define get_amp_min_mute(kc) (((kc)->private_value >> 29) & 0x1)
89385035 680
dda415d4
TI		 681/*
682 * enum control helper
683 */
684int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
685 struct snd_ctl_elem_info *uinfo,
686 int num_entries, const char * const *texts);
687#define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
688 snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
689
7f4a9f43
WF		 690/*
691 * CEA Short Audio Descriptor data
692 */
693struct cea_sad {
694 int channels;
695 int format; /* (format == 0) indicates invalid SAD */
696 int rates;
697 int sample_bits; /* for LPCM */
698 int max_bitrate; /* for AC3...ATRAC */
699 int profile; /* for WMAPRO */
700};
701
702#define ELD_FIXED_BYTES 20
14bc52b8 703#define ELD_MAX_SIZE 256
7f4a9f43
WF		 704#define ELD_MAX_MNL 16
705#define ELD_MAX_SAD 16
706
707/*
708 * ELD: EDID Like Data
709 */
1613d6b4
DH		 710struct parsed_hdmi_eld {
711 /*
712 * all fields will be cleared before updating ELD
713 */
7f4a9f43 714 int baseline_len;
23ccc2bd 715 int eld_ver;
7f4a9f43
WF		 716 int cea_edid_ver;
717 char monitor_name[ELD_MAX_MNL + 1];
718 int manufacture_id;
719 int product_id;
720 u64 port_id;
721 int support_hdcp;
722 int support_ai;
723 int conn_type;
724 int aud_synch_delay;
725 int spk_alloc;
726 int sad_count;
727 struct cea_sad sad[ELD_MAX_SAD];
1613d6b4
DH		 728};
729
730struct hdmi_eld {
731 bool monitor_present;
732 bool eld_valid;
733 int eld_size;
14bc52b8 734 char eld_buffer[ELD_MAX_SIZE];
1613d6b4 735 struct parsed_hdmi_eld info;
7f4a9f43
WF		 736};
737
738int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
1613d6b4
DH		 739int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
740 unsigned char *buf, int *eld_size);
741int snd_hdmi_parse_eld(struct parsed_hdmi_eld *e,
742 const unsigned char *buf, int size);
743void snd_hdmi_show_eld(struct parsed_hdmi_eld *e);
744void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
2def8172 745 struct hda_pcm_stream *hinfo);
7f4a9f43 746
89250f84
AH		 747int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
748 unsigned char *buf, int *eld_size,
749 bool rev3_or_later);
750
5f1e71b1 751#ifdef CONFIG_PROC_FS
a4e9a38b
TI		 752void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
753 struct snd_info_buffer *buffer);
754void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
755 struct snd_info_buffer *buffer);
5f1e71b1
WF		 756#endif
757
903b21d8
WF		 758#define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
759void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
760
1da177e4 761#endif /* __SOUND_HDA_LOCAL_H */
Linux 6.x block layer and io_uring tree(s)