projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: hda - Implement uncached version of parameter reads
[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);
c4c2533f 153void snd_hda_codec_register(struct hda_codec *codec);
9a6246ff 154void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
2134ea4f 155
d2f344b5
TI		 156enum {
157 HDA_VMUTE_OFF,
158 HDA_VMUTE_ON,
159 HDA_VMUTE_FOLLOW_MASTER,
160};
161
162struct hda_vmaster_mute_hook {
163 /* below two fields must be filled by the caller of
164 * snd_hda_add_vmaster_hook() beforehand
165 */
166 struct snd_kcontrol *sw_kctl;
167 void (*hook)(void *, int);
168 /* below are initialized automatically */
169 unsigned int mute_mode; /* HDA_VMUTE_XXX */
170 struct hda_codec *codec;
171};
172
173int snd_hda_add_vmaster_hook(struct hda_codec *codec,
f29735cb
TI		 174 struct hda_vmaster_mute_hook *hook,
175 bool expose_enum_ctl);
d2f344b5
TI		 176void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook);
177
47fd830a
TI		 178/* amp value bits */
179#define HDA_AMP_MUTE 0x80
180#define HDA_AMP_UNMUTE 0x00
181#define HDA_AMP_VOLMASK 0x7f
182
985be54b
TI		 183/* mono switch binding multiple inputs */
184#define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
185 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0, \
186 .info = snd_hda_mixer_amp_switch_info, \
187 .get = snd_hda_mixer_bind_switch_get, \
188 .put = snd_hda_mixer_bind_switch_put, \
189 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
190
191/* stereo switch binding multiple inputs */
d01ce99f
TI		 192#define HDA_BIND_MUTE(xname,nid,indices,dir) \
193 HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
985be54b 194
d01ce99f
TI		 195int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol,
196 struct snd_ctl_elem_value *ucontrol);
197int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol,
198 struct snd_ctl_elem_value *ucontrol);
985be54b 199
532d5381
TI		 200/* more generic bound controls */
201struct hda_ctl_ops {
202 snd_kcontrol_info_t *info;
203 snd_kcontrol_get_t *get;
204 snd_kcontrol_put_t *put;
205 snd_kcontrol_tlv_rw_t *tlv;
206};
207
208extern struct hda_ctl_ops snd_hda_bind_vol; /* for bind-volume with TLV */
209extern struct hda_ctl_ops snd_hda_bind_sw; /* for bind-switch */
210
211struct hda_bind_ctls {
212 struct hda_ctl_ops *ops;
5d9b6c07 213 unsigned long values[];
532d5381
TI		 214};
215
216int snd_hda_mixer_bind_ctls_info(struct snd_kcontrol *kcontrol,
217 struct snd_ctl_elem_info *uinfo);
218int snd_hda_mixer_bind_ctls_get(struct snd_kcontrol *kcontrol,
219 struct snd_ctl_elem_value *ucontrol);
220int snd_hda_mixer_bind_ctls_put(struct snd_kcontrol *kcontrol,
221 struct snd_ctl_elem_value *ucontrol);
222int snd_hda_mixer_bind_tlv(struct snd_kcontrol *kcontrol, int op_flag,
223 unsigned int size, unsigned int __user *tlv);
224
225#define HDA_BIND_VOL(xname, bindrec) \
226 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
227 .name = xname, \
228 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |\
229 SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
230 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,\
231 .info = snd_hda_mixer_bind_ctls_info,\
232 .get = snd_hda_mixer_bind_ctls_get,\
233 .put = snd_hda_mixer_bind_ctls_put,\
234 .tlv = { .c = snd_hda_mixer_bind_tlv },\
235 .private_value = (long) (bindrec) }
236#define HDA_BIND_SW(xname, bindrec) \
237 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER,\
238 .name = xname, \
239 .info = snd_hda_mixer_bind_ctls_info,\
240 .get = snd_hda_mixer_bind_ctls_get,\
241 .put = snd_hda_mixer_bind_ctls_put,\
242 .private_value = (long) (bindrec) }
243
244/*
245 * SPDIF I/O
246 */
dcda5806
TI		 247int snd_hda_create_dig_out_ctls(struct hda_codec *codec,
248 hda_nid_t associated_nid,
249 hda_nid_t cvt_nid, int type);
250#define snd_hda_create_spdif_out_ctls(codec, anid, cnid) \
251 snd_hda_create_dig_out_ctls(codec, anid, cnid, HDA_PCM_TYPE_SPDIF)
1da177e4
LT		 252int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
253
254/*
255 * input MUX helper
256 */
54d17403 257#define HDA_MAX_NUM_INPUTS 16
1da177e4 258struct hda_input_mux_item {
b5786e85 259 char label[32];
1da177e4
LT		 260 unsigned int index;
261};
262struct hda_input_mux {
263 unsigned int num_items;
264 struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
265};
266
d01ce99f
TI		 267int snd_hda_input_mux_info(const struct hda_input_mux *imux,
268 struct snd_ctl_elem_info *uinfo);
269int snd_hda_input_mux_put(struct hda_codec *codec,
270 const struct hda_input_mux *imux,
c8b6bf9b 271 struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
1da177e4 272 unsigned int *cur_val);
6194b99d
TI		 273int snd_hda_add_imux_item(struct hda_codec *codec,
274 struct hda_input_mux *imux, const char *label,
128bc4ba 275 int index, int *type_index_ret);
1da177e4
LT		 276
277/*
278 * Multi-channel / digital-out PCM helper
279 */
280
281enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
282enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
283
a06dbfc2
TI		 284#define HDA_MAX_OUTS 5
285
1da177e4
LT		 286struct hda_multi_out {
287 int num_dacs; /* # of DACs, must be more than 1 */
dda14410 288 const hda_nid_t *dac_nids; /* DAC list */
1da177e4 289 hda_nid_t hp_nid; /* optional DAC for HP, 0 when not exists */
a06dbfc2
TI		 290 hda_nid_t hp_out_nid[HDA_MAX_OUTS]; /* DACs for multiple HPs */
291 hda_nid_t extra_out_nid[HDA_MAX_OUTS]; /* other (e.g. speaker) DACs */
1da177e4 292 hda_nid_t dig_out_nid; /* digital out audio widget */
dda14410 293 const hda_nid_t *slave_dig_outs;
1da177e4
LT		 294 int max_channels; /* currently supported analog channels */
295 int dig_out_used; /* current usage of digital out (HDA_DIG_XXX) */
d29240ce 296 int no_share_stream; /* don't share a stream with multiple pins */
9a08160b
TI		 297 int share_spdif; /* share SPDIF pin */
298 /* PCM information for both analog and SPDIF DACs */
299 unsigned int analog_rates;
300 unsigned int analog_maxbps;
301 u64 analog_formats;
302 unsigned int spdif_rates;
303 unsigned int spdif_maxbps;
304 u64 spdif_formats;
1da177e4
LT		 305};
306
9a08160b
TI		 307int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
308 struct hda_multi_out *mout);
d01ce99f
TI		 309int snd_hda_multi_out_dig_open(struct hda_codec *codec,
310 struct hda_multi_out *mout);
311int snd_hda_multi_out_dig_close(struct hda_codec *codec,
312 struct hda_multi_out *mout);
6b97eb45
TI		 313int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
314 struct hda_multi_out *mout,
315 unsigned int stream_tag,
316 unsigned int format,
317 struct snd_pcm_substream *substream);
9411e21c
TI		 318int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
319 struct hda_multi_out *mout);
d01ce99f
TI		 320int snd_hda_multi_out_analog_open(struct hda_codec *codec,
321 struct hda_multi_out *mout,
9a08160b
TI		 322 struct snd_pcm_substream *substream,
323 struct hda_pcm_stream *hinfo);
d01ce99f
TI		 324int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
325 struct hda_multi_out *mout,
1da177e4
LT		 326 unsigned int stream_tag,
327 unsigned int format,
c8b6bf9b 328 struct snd_pcm_substream *substream);
d01ce99f
TI		 329int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
330 struct hda_multi_out *mout);
1da177e4 331
1da177e4
LT		 332/*
333 * generic proc interface
334 */
335#ifdef CONFIG_PROC_FS
336int snd_hda_codec_proc_new(struct hda_codec *codec);
337#else
338static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
339#endif
340
d39b4352
WF		 341#define SND_PRINT_BITS_ADVISED_BUFSIZE 16
342void snd_print_pcm_bits(int pcm, char *buf, int buflen);
343
1da177e4
LT		 344/*
345 * Misc
346 */
d01ce99f 347int snd_hda_add_new_ctls(struct hda_codec *codec,
031024ee 348 const struct snd_kcontrol_new *knew);
1da177e4 349
c9ce6b26
TI		 350/*
351 * Fix-up pin default configurations and add default verbs
352 */
353
354struct hda_pintbl {
355 hda_nid_t nid;
356 u32 val;
357};
358
359struct hda_model_fixup {
360 const int id;
361 const char *name;
362};
363
364struct hda_fixup {
365 int type;
1f578250
TI		 366 bool chained:1; /* call the chained fixup(s) after this */
367 bool chained_before:1; /* call the chained fixup(s) before this */
c9ce6b26
TI		 368 int chain_id;
369 union {
370 const struct hda_pintbl *pins;
371 const struct hda_verb *verbs;
372 void (*func)(struct hda_codec *codec,
373 const struct hda_fixup *fix,
374 int action);
375 } v;
376};
377
20531415
DH		 378struct snd_hda_pin_quirk {
379 unsigned int codec; /* Codec vendor/device ID */
380 unsigned short subvendor; /* PCI subvendor ID */
381 const struct hda_pintbl *pins; /* list of matching pins */
382#ifdef CONFIG_SND_DEBUG_VERBOSE
383 const char *name;
384#endif
385 int value; /* quirk value */
386};
387
a2d2fa02
DH		 388#ifdef CONFIG_SND_DEBUG_VERBOSE
389
390#define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
391 { .codec = _codec,\
392 .subvendor = _subvendor,\
393 .name = _name,\
394 .value = _value,\
fb54a645 395 .pins = (const struct hda_pintbl[]) { _pins, {0, 0}} \
a2d2fa02
DH		 396 }
397#else
398
399#define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
400 { .codec = _codec,\
401 .subvendor = _subvendor,\
402 .value = _value,\
fb54a645 403 .pins = (const struct hda_pintbl[]) { _pins, {0, 0}} \
a2d2fa02
DH		 404 }
405
406#endif
407
f5662e1c
DH		 408#define HDA_FIXUP_ID_NOT_SET -1
409#define HDA_FIXUP_ID_NO_FIXUP -2
a2d2fa02 410
c9ce6b26
TI		 411/* fixup types */
412enum {
413 HDA_FIXUP_INVALID,
414 HDA_FIXUP_PINS,
415 HDA_FIXUP_VERBS,
416 HDA_FIXUP_FUNC,
fd108215 417 HDA_FIXUP_PINCTLS,
c9ce6b26
TI		 418};
419
420/* fixup action definitions */
421enum {
422 HDA_FIXUP_ACT_PRE_PROBE,
423 HDA_FIXUP_ACT_PROBE,
424 HDA_FIXUP_ACT_INIT,
425 HDA_FIXUP_ACT_BUILD,
360fec28 426 HDA_FIXUP_ACT_FREE,
c9ce6b26
TI		 427};
428
429int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
430void snd_hda_apply_verbs(struct hda_codec *codec);
431void snd_hda_apply_pincfgs(struct hda_codec *codec,
432 const struct hda_pintbl *cfg);
433void snd_hda_apply_fixup(struct hda_codec *codec, int action);
434void snd_hda_pick_fixup(struct hda_codec *codec,
435 const struct hda_model_fixup *models,
436 const struct snd_pci_quirk *quirk,
437 const struct hda_fixup *fixlist);
20531415
DH		 438void snd_hda_pick_pin_fixup(struct hda_codec *codec,
439 const struct snd_hda_pin_quirk *pin_quirk,
440 const struct hda_fixup *fixlist);
441
128bc4ba 442/* helper macros to retrieve pin default-config values */
d01ce99f
TI		 443#define get_defcfg_connect(cfg) \
444 ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
445#define get_defcfg_association(cfg) \
446 ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
447#define get_defcfg_location(cfg) \
448 ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
449#define get_defcfg_sequence(cfg) \
450 (cfg & AC_DEFCFG_SEQUENCE)
451#define get_defcfg_device(cfg) \
452 ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
08a1f5eb
TI		 453#define get_defcfg_misc(cfg) \
454 ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
d01ce99f 455
8d88bc3d
TI		 456/* amp values */
457#define AMP_IN_MUTE(idx) (0x7080 | ((idx)<<8))
458#define AMP_IN_UNMUTE(idx) (0x7000 | ((idx)<<8))
d301fc32
TI		 459#define AMP_OUT_MUTE 0xb080
460#define AMP_OUT_UNMUTE 0xb000
461#define AMP_OUT_ZERO 0xb000
8d88bc3d 462/* pinctl values */
35e8901e 463#define PIN_IN (AC_PINCTL_IN_EN)
d301fc32 464#define PIN_VREFHIZ (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
35e8901e 465#define PIN_VREF50 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
d301fc32 466#define PIN_VREFGRD (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
35e8901e 467#define PIN_VREF80 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
d301fc32
TI		 468#define PIN_VREF100 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
469#define PIN_OUT (AC_PINCTL_OUT_EN)
35e8901e
RJ		 470#define PIN_HP (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
471#define PIN_HP_AMP (AC_PINCTL_HP_EN)
8d88bc3d 472
4740860b 473unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
62f3a2f7
TI		 474unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
475 hda_nid_t pin, unsigned int val);
cdd03ced
TI		 476int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
477 unsigned int val, bool cached);
478
479/**
480 * _snd_hda_set_pin_ctl - Set a pin-control value safely
481 * @codec: the codec instance
482 * @pin: the pin NID to set the control
483 * @val: the pin-control value (AC_PINCTL_* bits)
484 *
485 * This function sets the pin-control value to the given pin, but
486 * filters out the invalid pin-control bits when the pin has no such
487 * capabilities. For example, when PIN_HP is passed but the pin has no
488 * HP-drive capability, the HP bit is omitted.
489 *
490 * The function doesn't check the input VREF capability bits, though.
4740860b 491 * Use snd_hda_get_default_vref() to guess the right value.
cdd03ced
TI		 492 * Also, this function is only for analog pins, not for HDMI pins.
493 */
494static inline int
495snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
496{
497 return _snd_hda_set_pin_ctl(codec, pin, val, false);
498}
499
500/**
501 * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
502 * @codec: the codec instance
503 * @pin: the pin NID to set the control
504 * @val: the pin-control value (AC_PINCTL_* bits)
505 *
506 * Just like snd_hda_set_pin_ctl() but write to cache as well.
507 */
508static inline int
509snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
510 unsigned int val)
511{
512 return _snd_hda_set_pin_ctl(codec, pin, val, true);
513}
514
d7fdc00a
TI		 515int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
516int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
517 unsigned int val);
518
7639a06c
TI		 519#define for_each_hda_codec_node(nid, codec) \
520 for ((nid) = (codec)->core.start_nid; (nid) < (codec)->core.end_nid; (nid)++)
521
54d17403
TI		 522/*
523 * get widget capabilities
524 */
525static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
526{
7639a06c
TI		 527 if (nid < codec->core.start_nid ||
528 nid >= codec->core.start_nid + codec->core.num_nodes)
dca008f3 529 return 0;
7639a06c 530 return codec->wcaps[nid - codec->core.start_nid];
54d17403
TI		 531}
532
a22d543a 533/* get the widget type from widget capability bits */
3a90274d
TI		 534static inline int get_wcaps_type(unsigned int wcaps)
535{
536 if (!wcaps)
537 return -1; /* invalid type */
538 return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
539}
a22d543a 540
fd72d008
WF		 541static inline unsigned int get_wcaps_channels(u32 wcaps)
542{
543 unsigned int chans;
544
545 chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
546 chans = ((chans << 1) | 1) + 1;
547
548 return chans;
549}
550
d045c5dc
TI		 551static inline void snd_hda_override_wcaps(struct hda_codec *codec,
552 hda_nid_t nid, u32 val)
553{
7639a06c
TI		 554 if (nid >= codec->core.start_nid &&
555 nid < codec->core.start_nid + codec->core.num_nodes)
556 codec->wcaps[nid - codec->core.start_nid] = val;
d045c5dc
TI		 557}
558
09a99959 559u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
897cc188
TI		 560int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
561 unsigned int caps);
1327a32b 562u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid);
f57c2565
TI		 563int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
564 unsigned int caps);
861a04ed
DH		 565bool snd_hda_check_amp_caps(struct hda_codec *codec, hda_nid_t nid,
566 int dir, unsigned int bits);
567
568#define nid_has_mute(codec, nid, dir) \
569 snd_hda_check_amp_caps(codec, nid, dir, (AC_AMPCAP_MUTE | AC_AMPCAP_MIN_MUTE))
570#define nid_has_volume(codec, nid, dir) \
571 snd_hda_check_amp_caps(codec, nid, dir, AC_AMPCAP_NUM_STEPS)
572
03697e2a 573
9e3fd871
JK		 574/* flags for hda_nid_item */
575#define HDA_NID_ITEM_AMP (1<<0)
576
3911a4c1
JK		 577struct hda_nid_item {
578 struct snd_kcontrol *kctl;
5b0cb1d8 579 unsigned int index;
3911a4c1 580 hda_nid_t nid;
9e3fd871 581 unsigned short flags;
3911a4c1
JK		 582};
583
584int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
585 struct snd_kcontrol *kctl);
5b0cb1d8
JK		 586int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
587 unsigned int index, hda_nid_t nid);
d13bd412
TI		 588void snd_hda_ctls_clear(struct hda_codec *codec);
589
2807314d
TI		 590/*
591 * hwdep interface
592 */
d7ffba19 593#ifdef CONFIG_SND_HDA_HWDEP
2807314d 594int snd_hda_create_hwdep(struct hda_codec *codec);
d7ffba19
TI		 595#else
596static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
597#endif
2807314d 598
648a8d27
TI		 599void snd_hda_sysfs_init(struct hda_codec *codec);
600void snd_hda_sysfs_clear(struct hda_codec *codec);
601
602extern const struct attribute_group *snd_hda_dev_attr_groups[];
603
43b62713
TI		 604#ifdef CONFIG_SND_HDA_RECONFIG
605const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
606int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
bc759721 607int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
43b62713
TI		 608#else
609static inline
610const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
611{
612 return NULL;
613}
614
615static inline
616int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
617{
618 return -ENOENT;
619}
bc759721
TI		 620
621static inline
622int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
623{
624 return -ENOENT;
625}
43b62713
TI		 626#endif
627
cb53c626
TI		 628/*
629 * power-management
630 */
631
cb53c626
TI		 632void snd_hda_schedule_power_save(struct hda_codec *codec);
633
634struct hda_amp_list {
635 hda_nid_t nid;
636 unsigned char dir;
637 unsigned char idx;
638};
639
640struct hda_loopback_check {
031024ee 641 const struct hda_amp_list *amplist;
cb53c626
TI		 642 int power_on;
643};
644
645int snd_hda_check_amp_list_power(struct hda_codec *codec,
646 struct hda_loopback_check *check,
647 hda_nid_t nid);
cb53c626 648
9040d102
TI		 649/* check whether the actual power state matches with the target state */
650static inline bool
651snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
652 unsigned int target_state)
653{
654 unsigned int state = snd_hda_codec_read(codec, nid, 0,
655 AC_VERB_GET_POWER_STATE, 0);
656 if (state & AC_PWRST_ERROR)
657 return true;
658 state = (state >> 4) & 0x0f;
06ec56d3 659 return (state == target_state);
9040d102
TI		 660}
661
ba615b86
TI		 662unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
663 hda_nid_t nid,
664 unsigned int power_state);
665
89385035
MR		 666/*
667 * AMP control callbacks
668 */
669/* retrieve parameters from private_value */
3911a4c1
JK		 670#define get_amp_nid_(pv) ((pv) & 0xffff)
671#define get_amp_nid(kc) get_amp_nid_((kc)->private_value)
89385035 672#define get_amp_channels(kc) (((kc)->private_value >> 16) & 0x3)
527e4d73
TI		 673#define get_amp_direction_(pv) (((pv) >> 18) & 0x1)
674#define get_amp_direction(kc) get_amp_direction_((kc)->private_value)
130e5f06
TI		 675#define get_amp_index_(pv) (((pv) >> 19) & 0xf)
676#define get_amp_index(kc) get_amp_index_((kc)->private_value)
29fdbec2 677#define get_amp_offset(kc) (((kc)->private_value >> 23) & 0x3f)
de8c85f7 678#define get_amp_min_mute(kc) (((kc)->private_value >> 29) & 0x1)
89385035 679
dda415d4
TI		 680/*
681 * enum control helper
682 */
683int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
684 struct snd_ctl_elem_info *uinfo,
685 int num_entries, const char * const *texts);
686#define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
687 snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
688
7f4a9f43
WF		 689/*
690 * CEA Short Audio Descriptor data
691 */
692struct cea_sad {
693 int channels;
694 int format; /* (format == 0) indicates invalid SAD */
695 int rates;
696 int sample_bits; /* for LPCM */
697 int max_bitrate; /* for AC3...ATRAC */
698 int profile; /* for WMAPRO */
699};
700
701#define ELD_FIXED_BYTES 20
14bc52b8 702#define ELD_MAX_SIZE 256
7f4a9f43
WF		 703#define ELD_MAX_MNL 16
704#define ELD_MAX_SAD 16
705
706/*
707 * ELD: EDID Like Data
708 */
1613d6b4
DH		 709struct parsed_hdmi_eld {
710 /*
711 * all fields will be cleared before updating ELD
712 */
7f4a9f43 713 int baseline_len;
23ccc2bd 714 int eld_ver;
7f4a9f43
WF		 715 int cea_edid_ver;
716 char monitor_name[ELD_MAX_MNL + 1];
717 int manufacture_id;
718 int product_id;
719 u64 port_id;
720 int support_hdcp;
721 int support_ai;
722 int conn_type;
723 int aud_synch_delay;
724 int spk_alloc;
725 int sad_count;
726 struct cea_sad sad[ELD_MAX_SAD];
1613d6b4
DH		 727};
728
729struct hdmi_eld {
730 bool monitor_present;
731 bool eld_valid;
732 int eld_size;
14bc52b8 733 char eld_buffer[ELD_MAX_SIZE];
1613d6b4 734 struct parsed_hdmi_eld info;
7f4a9f43
WF		 735};
736
737int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
1613d6b4
DH		 738int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
739 unsigned char *buf, int *eld_size);
79514d47 740int snd_hdmi_parse_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e,
1613d6b4 741 const unsigned char *buf, int size);
79514d47 742void snd_hdmi_show_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e);
1613d6b4 743void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
2def8172 744 struct hda_pcm_stream *hinfo);
7f4a9f43 745
89250f84
AH		 746int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
747 unsigned char *buf, int *eld_size,
748 bool rev3_or_later);
749
5f1e71b1 750#ifdef CONFIG_PROC_FS
a4e9a38b
TI		 751void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
752 struct snd_info_buffer *buffer);
753void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
754 struct snd_info_buffer *buffer);
5f1e71b1
WF		 755#endif
756
903b21d8
WF		 757#define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
758void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
759
4e76a883
TI		 760/*
761 */
d8a766a1
TI		 762#define codec_err(codec, fmt, args...) \
763 dev_err(hda_codec_dev(codec), fmt, ##args)
764#define codec_warn(codec, fmt, args...) \
765 dev_warn(hda_codec_dev(codec), fmt, ##args)
766#define codec_info(codec, fmt, args...) \
767 dev_info(hda_codec_dev(codec), fmt, ##args)
768#define codec_dbg(codec, fmt, args...) \
769 dev_dbg(hda_codec_dev(codec), fmt, ##args)
4e76a883 770
1da177e4 771#endif /* __SOUND_HDA_LOCAL_H */
Linux 6.x block layer and io_uring tree(s)