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 /* We abuse kcontrol_new.subdev field to pass the NID corresponding to
14 * the given new control. If id.subdev has a bit flag HDA_SUBDEV_NID_FLAG,
15 * snd_hda_ctl_add() takes the lower-bit subdev value as a valid NID.
16 *
17 * Note that the subdevice field is cleared again before the real registration
18 * in snd_hda_ctl_add(), so that this value won't appear in the outside.
19 */
20 #define HDA_SUBDEV_NID_FLAG (1U << 31)
21 #define HDA_SUBDEV_AMP_FLAG (1U << 30)
22
23 /*
24 * for mixer controls
25 */
26 #define HDA_COMPOSE_AMP_VAL_OFS(nid,chs,idx,dir,ofs) \
27 ((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19) | ((ofs)<<23))
28 #define HDA_AMP_VAL_MIN_MUTE (1<<29)
29 #define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) \
30 HDA_COMPOSE_AMP_VAL_OFS(nid, chs, idx, dir, 0)
31 /* mono volume with index (index=0,1,...) (channel=1,2) */
32 #define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, dir, flags) \
33 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
34 .subdevice = HDA_SUBDEV_AMP_FLAG, \
35 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | \
36 SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
37 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK, \
38 .info = snd_hda_mixer_amp_volume_info, \
39 .get = snd_hda_mixer_amp_volume_get, \
40 .put = snd_hda_mixer_amp_volume_put, \
41 .tlv = { .c = snd_hda_mixer_amp_tlv }, \
42 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, dir) | flags }
43 /* stereo volume with index */
44 #define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
45 HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction, 0)
46 /* mono volume */
47 #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
48 HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction, 0)
49 /* stereo volume */
50 #define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
51 HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
52 /* stereo volume with min=mute */
53 #define HDA_CODEC_VOLUME_MIN_MUTE(xname, nid, xindex, direction) \
54 HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, 3, xindex, direction, \
55 HDA_AMP_VAL_MIN_MUTE)
56 /* mono mute switch with index (index=0,1,...) (channel=1,2) */
57 #define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
58 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
59 .subdevice = HDA_SUBDEV_AMP_FLAG, \
60 .info = snd_hda_mixer_amp_switch_info, \
61 .get = snd_hda_mixer_amp_switch_get, \
62 .put = snd_hda_mixer_amp_switch_put, \
63 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
64 /* stereo mute switch with index */
65 #define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
66 HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
67 /* mono mute switch */
68 #define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
69 HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
70 /* stereo mute switch */
71 #define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
72 HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
73 #ifdef CONFIG_SND_HDA_INPUT_BEEP
74 /* special beep mono mute switch with index (index=0,1,...) (channel=1,2) */
75 #define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
76 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
77 .subdevice = HDA_SUBDEV_AMP_FLAG, \
78 .info = snd_hda_mixer_amp_switch_info, \
79 .get = snd_hda_mixer_amp_switch_get_beep, \
80 .put = snd_hda_mixer_amp_switch_put_beep, \
81 .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
82 #else
83 /* no digital beep - just the standard one */
84 #define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, ch, xidx, dir) \
85 HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, ch, xidx, dir)
86 #endif /* CONFIG_SND_HDA_INPUT_BEEP */
87 /* special beep mono mute switch */
88 #define HDA_CODEC_MUTE_BEEP_MONO(xname, nid, channel, xindex, direction) \
89 HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, 0, nid, channel, xindex, direction)
90 /* special beep stereo mute switch */
91 #define HDA_CODEC_MUTE_BEEP(xname, nid, xindex, direction) \
92 HDA_CODEC_MUTE_BEEP_MONO(xname, nid, 3, xindex, direction)
93
94 extern const char *snd_hda_pcm_type_name[];
95
96 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol,
97 struct snd_ctl_elem_info *uinfo);
98 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol,
99 struct snd_ctl_elem_value *ucontrol);
100 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol,
101 struct snd_ctl_elem_value *ucontrol);
102 int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag,
103 unsigned int size, unsigned int __user *_tlv);
104 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol,
105 struct snd_ctl_elem_info *uinfo);
106 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol,
107 struct snd_ctl_elem_value *ucontrol);
108 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol,
109 struct snd_ctl_elem_value *ucontrol);
110 #ifdef CONFIG_SND_HDA_INPUT_BEEP
111 int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol,
112 struct snd_ctl_elem_value *ucontrol);
113 int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol,
114 struct snd_ctl_elem_value *ucontrol);
115 #endif
116 /* lowlevel accessor with caching; use carefully */
117 #define snd_hda_codec_amp_read(codec, nid, ch, dir, idx) \
118 snd_hdac_regmap_get_amp(&(codec)->core, nid, ch, dir, idx)
119 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid,
120 int ch, int dir, int idx, int mask, int val);
121 int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid,
122 int direction, int idx, int mask, int val);
123 int snd_hda_codec_amp_init(struct hda_codec *codec, hda_nid_t nid, int ch,
124 int direction, int idx, int mask, int val);
125 int snd_hda_codec_amp_init_stereo(struct hda_codec *codec, hda_nid_t nid,
126 int dir, int idx, int mask, int val);
127 void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir,
128 unsigned int *tlv);
129 struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec,
130 const char *name);
131 int __snd_hda_add_vmaster(struct hda_codec *codec, char *name,
132 unsigned int *tlv, const char * const *followers,
133 const char *suffix, bool init_follower_vol,
134 unsigned int access, struct snd_kcontrol **ctl_ret);
135 #define snd_hda_add_vmaster(codec, name, tlv, followers, suffix, access) \
136 __snd_hda_add_vmaster(codec, name, tlv, followers, suffix, true, access, NULL)
137 int snd_hda_codec_reset(struct hda_codec *codec);
138 void snd_hda_codec_register(struct hda_codec *codec);
139 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
140 void snd_hda_codec_disconnect_pcms(struct hda_codec *codec);
141
142 #define snd_hda_regmap_sync(codec) snd_hdac_regmap_sync(&(codec)->core)
143
144 struct 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
154 int snd_hda_add_vmaster_hook(struct hda_codec *codec,
155 struct hda_vmaster_mute_hook *hook);
156 void 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 */
166 int 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)
171 int 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
177 struct hda_input_mux_item {
178 char label[32];
179 unsigned int index;
180 };
181 struct hda_input_mux {
182 unsigned int num_items;
183 struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
184 };
185
186 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
187 struct snd_ctl_elem_info *uinfo);
188 int 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);
192 int 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
200 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
201 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
202
203 #define HDA_MAX_OUTS 5
204
205 struct 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
226 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
227 struct hda_multi_out *mout);
228 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
229 struct hda_multi_out *mout);
230 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
231 struct hda_multi_out *mout);
232 int 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);
237 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
238 struct hda_multi_out *mout);
239 int 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);
243 int 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);
248 int 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
255 int snd_hda_codec_proc_new(struct hda_codec *codec);
256 #else
snd_hda_codec_proc_new(struct hda_codec * codec)257 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
258 #endif
259
260 #define SND_PRINT_BITS_ADVISED_BUFSIZE 16
261 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
262
263 /*
264 * Misc
265 */
266 int 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
273 struct hda_pintbl {
274 hda_nid_t nid;
275 u32 val;
276 };
277
278 struct hda_model_fixup {
279 const int id;
280 const char *name;
281 };
282
283 struct 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 struct snd_hda_pin_quirk {
298 unsigned int codec; /* Codec vendor/device ID */
299 unsigned short subvendor; /* PCI subvendor ID */
300 const struct hda_pintbl *pins; /* list of matching pins */
301 #ifdef CONFIG_SND_DEBUG_VERBOSE
302 const char *name;
303 #endif
304 int value; /* quirk value */
305 };
306
307 #ifdef CONFIG_SND_DEBUG_VERBOSE
308
309 #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
310 { .codec = _codec,\
311 .subvendor = _subvendor,\
312 .name = _name,\
313 .value = _value,\
314 .pins = (const struct hda_pintbl[]) { _pins, {0, 0}} \
315 }
316 #else
317
318 #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
319 { .codec = _codec,\
320 .subvendor = _subvendor,\
321 .value = _value,\
322 .pins = (const struct hda_pintbl[]) { _pins, {0, 0}} \
323 }
324
325 #endif
326
327 #define HDA_FIXUP_ID_NOT_SET -1
328 #define HDA_FIXUP_ID_NO_FIXUP -2
329
330 /* fixup types */
331 enum {
332 HDA_FIXUP_INVALID,
333 HDA_FIXUP_PINS,
334 HDA_FIXUP_VERBS,
335 HDA_FIXUP_FUNC,
336 HDA_FIXUP_PINCTLS,
337 };
338
339 /* fixup action definitions */
340 enum {
341 HDA_FIXUP_ACT_PRE_PROBE,
342 HDA_FIXUP_ACT_PROBE,
343 HDA_FIXUP_ACT_INIT,
344 HDA_FIXUP_ACT_BUILD,
345 HDA_FIXUP_ACT_FREE,
346 };
347
348 int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
349 void snd_hda_apply_verbs(struct hda_codec *codec);
350 void snd_hda_apply_pincfgs(struct hda_codec *codec,
351 const struct hda_pintbl *cfg);
352 void snd_hda_apply_fixup(struct hda_codec *codec, int action);
353 void __snd_hda_apply_fixup(struct hda_codec *codec, int id, int action, int depth);
354 void snd_hda_pick_fixup(struct hda_codec *codec,
355 const struct hda_model_fixup *models,
356 const struct snd_pci_quirk *quirk,
357 const struct hda_fixup *fixlist);
358 void snd_hda_pick_pin_fixup(struct hda_codec *codec,
359 const struct snd_hda_pin_quirk *pin_quirk,
360 const struct hda_fixup *fixlist,
361 bool match_all_pins);
362
363 /* helper macros to retrieve pin default-config values */
364 #define get_defcfg_connect(cfg) \
365 ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
366 #define get_defcfg_association(cfg) \
367 ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
368 #define get_defcfg_location(cfg) \
369 ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
370 #define get_defcfg_sequence(cfg) \
371 (cfg & AC_DEFCFG_SEQUENCE)
372 #define get_defcfg_device(cfg) \
373 ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
374 #define get_defcfg_misc(cfg) \
375 ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
376
377 /* amp values */
378 #define AMP_IN_MUTE(idx) (0x7080 | ((idx)<<8))
379 #define AMP_IN_UNMUTE(idx) (0x7000 | ((idx)<<8))
380 #define AMP_OUT_MUTE 0xb080
381 #define AMP_OUT_UNMUTE 0xb000
382 #define AMP_OUT_ZERO 0xb000
383 /* pinctl values */
384 #define PIN_IN (AC_PINCTL_IN_EN)
385 #define PIN_VREFHIZ (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
386 #define PIN_VREF50 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
387 #define PIN_VREFGRD (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
388 #define PIN_VREF80 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
389 #define PIN_VREF100 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
390 #define PIN_OUT (AC_PINCTL_OUT_EN)
391 #define PIN_HP (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
392 #define PIN_HP_AMP (AC_PINCTL_HP_EN)
393
394 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
395 unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
396 hda_nid_t pin, unsigned int val);
397 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
398 unsigned int val, bool cached);
399
400 /**
401 * _snd_hda_set_pin_ctl - Set a pin-control value safely
402 * @codec: the codec instance
403 * @pin: the pin NID to set the control
404 * @val: the pin-control value (AC_PINCTL_* bits)
405 *
406 * This function sets the pin-control value to the given pin, but
407 * filters out the invalid pin-control bits when the pin has no such
408 * capabilities. For example, when PIN_HP is passed but the pin has no
409 * HP-drive capability, the HP bit is omitted.
410 *
411 * The function doesn't check the input VREF capability bits, though.
412 * Use snd_hda_get_default_vref() to guess the right value.
413 * Also, this function is only for analog pins, not for HDMI pins.
414 */
415 static inline int
snd_hda_set_pin_ctl(struct hda_codec * codec,hda_nid_t pin,unsigned int val)416 snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
417 {
418 return _snd_hda_set_pin_ctl(codec, pin, val, false);
419 }
420
421 /**
422 * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
423 * @codec: the codec instance
424 * @pin: the pin NID to set the control
425 * @val: the pin-control value (AC_PINCTL_* bits)
426 *
427 * Just like snd_hda_set_pin_ctl() but write to cache as well.
428 */
429 static inline int
snd_hda_set_pin_ctl_cache(struct hda_codec * codec,hda_nid_t pin,unsigned int val)430 snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
431 unsigned int val)
432 {
433 return _snd_hda_set_pin_ctl(codec, pin, val, true);
434 }
435
436 int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
437 int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
438 unsigned int val);
439
440 #define for_each_hda_codec_node(nid, codec) \
441 for ((nid) = (codec)->core.start_nid; (nid) < (codec)->core.end_nid; (nid)++)
442
443 /* Set the codec power_state flag to indicate to allow unsol event handling;
444 * see hda_codec_unsol_event() in hda_bind.c. Calling this might confuse the
445 * state tracking, so use with care.
446 */
snd_hda_codec_allow_unsol_events(struct hda_codec * codec)447 static inline void snd_hda_codec_allow_unsol_events(struct hda_codec *codec)
448 {
449 codec->core.dev.power.power_state = PMSG_ON;
450 }
451
452 /*
453 * get widget capabilities
454 */
get_wcaps(struct hda_codec * codec,hda_nid_t nid)455 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
456 {
457 if (nid < codec->core.start_nid ||
458 nid >= codec->core.start_nid + codec->core.num_nodes)
459 return 0;
460 return codec->wcaps[nid - codec->core.start_nid];
461 }
462
463 /* get the widget type from widget capability bits */
get_wcaps_type(unsigned int wcaps)464 static inline int get_wcaps_type(unsigned int wcaps)
465 {
466 if (!wcaps)
467 return -1; /* invalid type */
468 return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
469 }
470
get_wcaps_channels(u32 wcaps)471 static inline unsigned int get_wcaps_channels(u32 wcaps)
472 {
473 unsigned int chans;
474
475 chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
476 chans = ((chans << 1) | 1) + 1;
477
478 return chans;
479 }
480
snd_hda_override_wcaps(struct hda_codec * codec,hda_nid_t nid,u32 val)481 static inline void snd_hda_override_wcaps(struct hda_codec *codec,
482 hda_nid_t nid, u32 val)
483 {
484 if (nid >= codec->core.start_nid &&
485 nid < codec->core.start_nid + codec->core.num_nodes)
486 codec->wcaps[nid - codec->core.start_nid] = val;
487 }
488
489 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
490 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
491 unsigned int caps);
492 /**
493 * snd_hda_query_pin_caps - Query PIN capabilities
494 * @codec: the HD-auio codec
495 * @nid: the NID to query
496 *
497 * Query PIN capabilities for the given widget.
498 * Returns the obtained capability bits.
499 *
500 * When cap bits have been already read, this doesn't read again but
501 * returns the cached value.
502 */
503 static inline u32
snd_hda_query_pin_caps(struct hda_codec * codec,hda_nid_t nid)504 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid)
505 {
506 return snd_hda_param_read(codec, nid, AC_PAR_PIN_CAP);
507
508 }
509
510 /**
511 * snd_hda_override_pin_caps - Override the pin capabilities
512 * @codec: the CODEC
513 * @nid: the NID to override
514 * @caps: the capability bits to set
515 *
516 * Override the cached PIN capabilitiy bits value by the given one.
517 *
518 * Returns zero if successful or a negative error code.
519 */
520 static inline int
snd_hda_override_pin_caps(struct hda_codec * codec,hda_nid_t nid,unsigned int caps)521 snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
522 unsigned int caps)
523 {
524 return snd_hdac_override_parm(&codec->core, nid, AC_PAR_PIN_CAP, caps);
525 }
526
527 bool snd_hda_check_amp_caps(struct hda_codec *codec, hda_nid_t nid,
528 int dir, unsigned int bits);
529
530 #define nid_has_mute(codec, nid, dir) \
531 snd_hda_check_amp_caps(codec, nid, dir, (AC_AMPCAP_MUTE | AC_AMPCAP_MIN_MUTE))
532 #define nid_has_volume(codec, nid, dir) \
533 snd_hda_check_amp_caps(codec, nid, dir, AC_AMPCAP_NUM_STEPS)
534
535
536 /* flags for hda_nid_item */
537 #define HDA_NID_ITEM_AMP (1<<0)
538
539 struct hda_nid_item {
540 struct snd_kcontrol *kctl;
541 unsigned int index;
542 hda_nid_t nid;
543 unsigned short flags;
544 };
545
546 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
547 struct snd_kcontrol *kctl);
548 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
549 unsigned int index, hda_nid_t nid);
550 void snd_hda_ctls_clear(struct hda_codec *codec);
551
552 /*
553 * hwdep interface
554 */
555 #ifdef CONFIG_SND_HDA_HWDEP
556 int snd_hda_create_hwdep(struct hda_codec *codec);
557 #else
snd_hda_create_hwdep(struct hda_codec * codec)558 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
559 #endif
560
561 void snd_hda_sysfs_init(struct hda_codec *codec);
562 void snd_hda_sysfs_clear(struct hda_codec *codec);
563
564 extern const struct attribute_group *snd_hda_dev_attr_groups[];
565
566 #ifdef CONFIG_SND_HDA_RECONFIG
567 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
568 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
569 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
570 #else
571 static inline
snd_hda_get_hint(struct hda_codec * codec,const char * key)572 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
573 {
574 return NULL;
575 }
576
577 static inline
snd_hda_get_bool_hint(struct hda_codec * codec,const char * key)578 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
579 {
580 return -ENOENT;
581 }
582
583 static inline
snd_hda_get_int_hint(struct hda_codec * codec,const char * key,int * valp)584 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp)
585 {
586 return -ENOENT;
587 }
588 #endif
589
590 /*
591 * power-management
592 */
593
594 void snd_hda_schedule_power_save(struct hda_codec *codec);
595
596 struct hda_amp_list {
597 hda_nid_t nid;
598 unsigned char dir;
599 unsigned char idx;
600 };
601
602 struct hda_loopback_check {
603 const struct hda_amp_list *amplist;
604 int power_on;
605 };
606
607 int snd_hda_check_amp_list_power(struct hda_codec *codec,
608 struct hda_loopback_check *check,
609 hda_nid_t nid);
610
611 /* check whether the actual power state matches with the target state */
612 static inline bool
snd_hda_check_power_state(struct hda_codec * codec,hda_nid_t nid,unsigned int target_state)613 snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid,
614 unsigned int target_state)
615 {
616 return snd_hdac_check_power_state(&codec->core, nid, target_state);
617 }
618
snd_hda_sync_power_state(struct hda_codec * codec,hda_nid_t nid,unsigned int target_state)619 static inline unsigned int snd_hda_sync_power_state(struct hda_codec *codec,
620 hda_nid_t nid,
621 unsigned int target_state)
622 {
623 return snd_hdac_sync_power_state(&codec->core, nid, target_state);
624 }
625 unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
626 hda_nid_t nid,
627 unsigned int power_state);
628
629 void snd_hda_codec_shutdown(struct hda_codec *codec);
630
631 /*
632 * AMP control callbacks
633 */
634 /* retrieve parameters from private_value */
635 #define get_amp_nid_(pv) ((pv) & 0xffff)
636 #define get_amp_nid(kc) get_amp_nid_((kc)->private_value)
637 #define get_amp_channels(kc) (((kc)->private_value >> 16) & 0x3)
638 #define get_amp_direction_(pv) (((pv) >> 18) & 0x1)
639 #define get_amp_direction(kc) get_amp_direction_((kc)->private_value)
640 #define get_amp_index_(pv) (((pv) >> 19) & 0xf)
641 #define get_amp_index(kc) get_amp_index_((kc)->private_value)
642 #define get_amp_offset(kc) (((kc)->private_value >> 23) & 0x3f)
643 #define get_amp_min_mute(kc) (((kc)->private_value >> 29) & 0x1)
644
645 /*
646 * enum control helper
647 */
648 int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
649 struct snd_ctl_elem_info *uinfo,
650 int num_items, const char * const *texts);
651 #define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
652 snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
653
654 /*
655 * CEA Short Audio Descriptor data
656 */
657 struct cea_sad {
658 int channels;
659 int format; /* (format == 0) indicates invalid SAD */
660 int rates;
661 int sample_bits; /* for LPCM */
662 int max_bitrate; /* for AC3...ATRAC */
663 int profile; /* for WMAPRO */
664 };
665
666 #define ELD_FIXED_BYTES 20
667 #define ELD_MAX_SIZE 256
668 #define ELD_MAX_MNL 16
669 #define ELD_MAX_SAD 16
670
671 /*
672 * ELD: EDID Like Data
673 */
674 struct parsed_hdmi_eld {
675 /*
676 * all fields will be cleared before updating ELD
677 */
678 int baseline_len;
679 int eld_ver;
680 int cea_edid_ver;
681 char monitor_name[ELD_MAX_MNL + 1];
682 int manufacture_id;
683 int product_id;
684 u64 port_id;
685 int support_hdcp;
686 int support_ai;
687 int conn_type;
688 int aud_synch_delay;
689 int spk_alloc;
690 int sad_count;
691 struct cea_sad sad[ELD_MAX_SAD];
692 };
693
694 struct hdmi_eld {
695 bool monitor_present;
696 bool eld_valid;
697 int eld_size;
698 char eld_buffer[ELD_MAX_SIZE];
699 struct parsed_hdmi_eld info;
700 };
701
702 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
703 int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
704 unsigned char *buf, int *eld_size);
705 int snd_hdmi_parse_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e,
706 const unsigned char *buf, int size);
707 void snd_hdmi_show_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e);
708 void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
709 struct hda_pcm_stream *hinfo);
710
711 int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
712 unsigned char *buf, int *eld_size,
713 bool rev3_or_later);
714
715 #ifdef CONFIG_SND_PROC_FS
716 void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
717 struct snd_info_buffer *buffer);
718 void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
719 struct snd_info_buffer *buffer);
720 #endif
721
722 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
723 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
724
725 void snd_hda_codec_display_power(struct hda_codec *codec, bool enable);
726
727 /*
728 */
729 #define codec_err(codec, fmt, args...) \
730 dev_err(hda_codec_dev(codec), fmt, ##args)
731 #define codec_warn(codec, fmt, args...) \
732 dev_warn(hda_codec_dev(codec), fmt, ##args)
733 #define codec_info(codec, fmt, args...) \
734 dev_info(hda_codec_dev(codec), fmt, ##args)
735 #define codec_dbg(codec, fmt, args...) \
736 dev_dbg(hda_codec_dev(codec), fmt, ##args)
737
738 #endif /* __SOUND_HDA_LOCAL_H */
739