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