?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
module: Convert symbol namespace to string literal
[linux.git] / sound / pci / hda / hda_local.h
blob763f79f6f32e708c822a406fb756e8679ce955d2
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_disconnect_pcms(struct hda_codec *codec);
139
140 #define snd_hda_regmap_sync(codec) snd_hdac_regmap_sync(&(codec)->core)
141
142 struct hda_vmaster_mute_hook {
143 /* below two fields must be filled by the caller of
144 * snd_hda_add_vmaster_hook() beforehand
145 */
146 struct snd_kcontrol *sw_kctl;
147 void (*hook)(void *, int);
148 /* below are initialized automatically */
149 struct hda_codec *codec;
150 };
151
152 int snd_hda_add_vmaster_hook(struct hda_codec *codec,
153 struct hda_vmaster_mute_hook *hook);
154 void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook);
155
156 /* amp value bits */
157 #define HDA_AMP_MUTE 0x80
158 #define HDA_AMP_UNMUTE 0x00
159 #define HDA_AMP_VOLMASK 0x7f
160
161 /*
162 * SPDIF I/O
163 */
164 int snd_hda_create_dig_out_ctls(struct hda_codec *codec,
165 hda_nid_t associated_nid,
166 hda_nid_t cvt_nid, int type);
167 #define snd_hda_create_spdif_out_ctls(codec, anid, cnid) \
168 snd_hda_create_dig_out_ctls(codec, anid, cnid, HDA_PCM_TYPE_SPDIF)
169 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
170
171 /*
172 * input MUX helper
173 */
174 #define HDA_MAX_NUM_INPUTS 36
175 struct hda_input_mux_item {
176 char label[32];
177 unsigned int index;
178 };
179 struct hda_input_mux {
180 unsigned int num_items;
181 struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
182 };
183
184 int snd_hda_input_mux_info(const struct hda_input_mux *imux,
185 struct snd_ctl_elem_info *uinfo);
186 int snd_hda_input_mux_put(struct hda_codec *codec,
187 const struct hda_input_mux *imux,
188 struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
189 unsigned int *cur_val);
190 int snd_hda_add_imux_item(struct hda_codec *codec,
191 struct hda_input_mux *imux, const char *label,
192 int index, int *type_idx);
193
194 /*
195 * Multi-channel / digital-out PCM helper
196 */
197
198 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
199 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
200
201 #define HDA_MAX_OUTS 5
202
203 struct hda_multi_out {
204 int num_dacs; /* # of DACs, must be more than 1 */
205 const hda_nid_t *dac_nids; /* DAC list */
206 hda_nid_t hp_nid; /* optional DAC for HP, 0 when not exists */
207 hda_nid_t hp_out_nid[HDA_MAX_OUTS]; /* DACs for multiple HPs */
208 hda_nid_t extra_out_nid[HDA_MAX_OUTS]; /* other (e.g. speaker) DACs */
209 hda_nid_t dig_out_nid; /* digital out audio widget */
210 const hda_nid_t *follower_dig_outs;
211 int max_channels; /* currently supported analog channels */
212 int dig_out_used; /* current usage of digital out (HDA_DIG_XXX) */
213 int no_share_stream; /* don't share a stream with multiple pins */
214 int share_spdif; /* share SPDIF pin */
215 /* PCM information for both analog and SPDIF DACs */
216 unsigned int analog_rates;
217 unsigned int analog_maxbps;
218 u64 analog_formats;
219 unsigned int spdif_rates;
220 unsigned int spdif_maxbps;
221 u64 spdif_formats;
222 };
223
224 int snd_hda_create_spdif_share_sw(struct hda_codec *codec,
225 struct hda_multi_out *mout);
226 int snd_hda_multi_out_dig_open(struct hda_codec *codec,
227 struct hda_multi_out *mout);
228 int snd_hda_multi_out_dig_close(struct hda_codec *codec,
229 struct hda_multi_out *mout);
230 int snd_hda_multi_out_dig_prepare(struct hda_codec *codec,
231 struct hda_multi_out *mout,
232 unsigned int stream_tag,
233 unsigned int format,
234 struct snd_pcm_substream *substream);
235 int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec,
236 struct hda_multi_out *mout);
237 int snd_hda_multi_out_analog_open(struct hda_codec *codec,
238 struct hda_multi_out *mout,
239 struct snd_pcm_substream *substream,
240 struct hda_pcm_stream *hinfo);
241 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec,
242 struct hda_multi_out *mout,
243 unsigned int stream_tag,
244 unsigned int format,
245 struct snd_pcm_substream *substream);
246 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec,
247 struct hda_multi_out *mout);
248
249 /*
250 * generic proc interface
251 */
252 #ifdef CONFIG_SND_PROC_FS
253 int snd_hda_codec_proc_new(struct hda_codec *codec);
254 #else
255 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
256 #endif
257
258 #define SND_PRINT_BITS_ADVISED_BUFSIZE 16
259 void snd_print_pcm_bits(int pcm, char *buf, int buflen);
260
261 /*
262 * Misc
263 */
264 int snd_hda_add_new_ctls(struct hda_codec *codec,
265 const struct snd_kcontrol_new *knew);
266
267 /*
268 * Fix-up pin default configurations and add default verbs
269 */
270
271 struct hda_pintbl {
272 hda_nid_t nid;
273 u32 val;
274 };
275
276 struct hda_model_fixup {
277 const int id;
278 const char *name;
279 };
280
281 struct hda_fixup {
282 int type;
283 bool chained:1; /* call the chained fixup(s) after this */
284 bool chained_before:1; /* call the chained fixup(s) before this */
285 int chain_id;
286 union {
287 const struct hda_pintbl *pins;
288 const struct hda_verb *verbs;
289 void (*func)(struct hda_codec *codec,
290 const struct hda_fixup *fix,
291 int action);
292 } v;
293 };
294
295 /*
296 * extended form of snd_pci_quirk:
297 * for PCI SSID matching, use SND_PCI_QUIRK() like before;
298 * for codec SSID matching, use the new HDA_CODEC_QUIRK() instead
299 */
300 struct hda_quirk {
301 unsigned short subvendor; /* PCI subvendor ID */
302 unsigned short subdevice; /* PCI subdevice ID */
303 unsigned short subdevice_mask; /* bitmask to match */
304 bool match_codec_ssid; /* match only with codec SSID */
305 int value; /* value */
306 #ifdef CONFIG_SND_DEBUG_VERBOSE
307 const char *name; /* name of the device (optional) */
308 #endif
309 };
310
311 #ifdef CONFIG_SND_DEBUG_VERBOSE
312 #define HDA_CODEC_QUIRK(vend, dev, xname, val) \
313 { _SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname),\
314 .match_codec_ssid = true }
315 #else
316 #define HDA_CODEC_QUIRK(vend, dev, xname, val) \
317 { _SND_PCI_QUIRK_ID(vend, dev), .value = (val), \
318 .match_codec_ssid = true }
319 #endif
320
321 struct snd_hda_pin_quirk {
322 unsigned int codec; /* Codec vendor/device ID */
323 unsigned short subvendor; /* PCI subvendor ID */
324 const struct hda_pintbl *pins; /* list of matching pins */
325 #ifdef CONFIG_SND_DEBUG_VERBOSE
326 const char *name;
327 #endif
328 int value; /* quirk value */
329 };
330
331 #ifdef CONFIG_SND_DEBUG_VERBOSE
332
333 #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
334 { .codec = _codec,\
335 .subvendor = _subvendor,\
336 .name = _name,\
337 .value = _value,\
338 .pins = (const struct hda_pintbl[]) { _pins, {0, 0}} \
339 }
340 #else
341
342 #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) \
343 { .codec = _codec,\
344 .subvendor = _subvendor,\
345 .value = _value,\
346 .pins = (const struct hda_pintbl[]) { _pins, {0, 0}} \
347 }
348
349 #endif
350
351 #define HDA_FIXUP_ID_NOT_SET -1
352 #define HDA_FIXUP_ID_NO_FIXUP -2
353
354 /* fixup types */
355 enum {
356 HDA_FIXUP_INVALID,
357 HDA_FIXUP_PINS,
358 HDA_FIXUP_VERBS,
359 HDA_FIXUP_FUNC,
360 HDA_FIXUP_PINCTLS,
361 };
362
363 /* fixup action definitions */
364 enum {
365 HDA_FIXUP_ACT_PRE_PROBE,
366 HDA_FIXUP_ACT_PROBE,
367 HDA_FIXUP_ACT_INIT,
368 HDA_FIXUP_ACT_BUILD,
369 HDA_FIXUP_ACT_FREE,
370 };
371
372 int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list);
373 void snd_hda_apply_verbs(struct hda_codec *codec);
374 void snd_hda_apply_pincfgs(struct hda_codec *codec,
375 const struct hda_pintbl *cfg);
376 void snd_hda_apply_fixup(struct hda_codec *codec, int action);
377 void __snd_hda_apply_fixup(struct hda_codec *codec, int id, int action, int depth);
378 void snd_hda_pick_fixup(struct hda_codec *codec,
379 const struct hda_model_fixup *models,
380 const struct hda_quirk *quirk,
381 const struct hda_fixup *fixlist);
382 void snd_hda_pick_pin_fixup(struct hda_codec *codec,
383 const struct snd_hda_pin_quirk *pin_quirk,
384 const struct hda_fixup *fixlist,
385 bool match_all_pins);
386
387 /* helper macros to retrieve pin default-config values */
388 #define get_defcfg_connect(cfg) \
389 ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
390 #define get_defcfg_association(cfg) \
391 ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
392 #define get_defcfg_location(cfg) \
393 ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
394 #define get_defcfg_sequence(cfg) \
395 (cfg & AC_DEFCFG_SEQUENCE)
396 #define get_defcfg_device(cfg) \
397 ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
398 #define get_defcfg_misc(cfg) \
399 ((cfg & AC_DEFCFG_MISC) >> AC_DEFCFG_MISC_SHIFT)
400
401 /* amp values */
402 #define AMP_IN_MUTE(idx) (0x7080 | ((idx)<<8))
403 #define AMP_IN_UNMUTE(idx) (0x7000 | ((idx)<<8))
404 #define AMP_OUT_MUTE 0xb080
405 #define AMP_OUT_UNMUTE 0xb000
406 #define AMP_OUT_ZERO 0xb000
407 /* pinctl values */
408 #define PIN_IN (AC_PINCTL_IN_EN)
409 #define PIN_VREFHIZ (AC_PINCTL_IN_EN | AC_PINCTL_VREF_HIZ)
410 #define PIN_VREF50 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_50)
411 #define PIN_VREFGRD (AC_PINCTL_IN_EN | AC_PINCTL_VREF_GRD)
412 #define PIN_VREF80 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_80)
413 #define PIN_VREF100 (AC_PINCTL_IN_EN | AC_PINCTL_VREF_100)
414 #define PIN_OUT (AC_PINCTL_OUT_EN)
415 #define PIN_HP (AC_PINCTL_OUT_EN | AC_PINCTL_HP_EN)
416 #define PIN_HP_AMP (AC_PINCTL_HP_EN)
417
418 unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin);
419 unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec,
420 hda_nid_t pin, unsigned int val);
421 int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin,
422 unsigned int val, bool cached);
423
424 /**
425 * _snd_hda_set_pin_ctl - Set a pin-control value safely
426 * @codec: the codec instance
427 * @pin: the pin NID to set the control
428 * @val: the pin-control value (AC_PINCTL_* bits)
429 *
430 * This function sets the pin-control value to the given pin, but
431 * filters out the invalid pin-control bits when the pin has no such
432 * capabilities. For example, when PIN_HP is passed but the pin has no
433 * HP-drive capability, the HP bit is omitted.
434 *
435 * The function doesn't check the input VREF capability bits, though.
436 * Use snd_hda_get_default_vref() to guess the right value.
437 * Also, this function is only for analog pins, not for HDMI pins.
438 */
439 static inline int
440 snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val)
441 {
442 return _snd_hda_set_pin_ctl(codec, pin, val, false);
443 }
444
445 /**
446 * snd_hda_set_pin_ctl_cache - Set a pin-control value safely
447 * @codec: the codec instance
448 * @pin: the pin NID to set the control
449 * @val: the pin-control value (AC_PINCTL_* bits)
450 *
451 * Just like snd_hda_set_pin_ctl() but write to cache as well.
452 */
453 static inline int
454 snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin,
455 unsigned int val)
456 {
457 return _snd_hda_set_pin_ctl(codec, pin, val, true);
458 }
459
460 int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid);
461 int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid,
462 unsigned int val);
463
464 #define for_each_hda_codec_node(nid, codec) \
465 for ((nid) = (codec)->core.start_nid; (nid) < (codec)->core.end_nid; (nid)++)
466
467 /* Set the codec power_state flag to indicate to allow unsol event handling;
468 * see hda_codec_unsol_event() in hda_bind.c. Calling this might confuse the
469 * state tracking, so use with care.
470 */
471 static inline void snd_hda_codec_allow_unsol_events(struct hda_codec *codec)
472 {
473 codec->core.dev.power.power_state = PMSG_ON;
474 }
475
476 /*
477 * get widget capabilities
478 */
479 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
480 {
481 if (nid < codec->core.start_nid ||
482 nid >= codec->core.start_nid + codec->core.num_nodes)
483 return 0;
484 return codec->wcaps[nid - codec->core.start_nid];
485 }
486
487 /* get the widget type from widget capability bits */
488 static inline int get_wcaps_type(unsigned int wcaps)
489 {
490 if (!wcaps)
491 return -1; /* invalid type */
492 return (wcaps & AC_WCAP_TYPE) >> AC_WCAP_TYPE_SHIFT;
493 }
494
495 static inline unsigned int get_wcaps_channels(u32 wcaps)
496 {
497 unsigned int chans;
498
499 chans = (wcaps & AC_WCAP_CHAN_CNT_EXT) >> 13;
500 chans = ((chans << 1) | 1) + 1;
501
502 return chans;
503 }
504
505 static inline void snd_hda_override_wcaps(struct hda_codec *codec,
506 hda_nid_t nid, u32 val)
507 {
508 if (nid >= codec->core.start_nid &&
509 nid < codec->core.start_nid + codec->core.num_nodes)
510 codec->wcaps[nid - codec->core.start_nid] = val;
511 }
512
513 u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction);
514 int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir,
515 unsigned int caps);
516 /**
517 * snd_hda_query_pin_caps - Query PIN capabilities
518 * @codec: the HD-auio codec
519 * @nid: the NID to query
520 *
521 * Query PIN capabilities for the given widget.
522 * Returns the obtained capability bits.
523 *
524 * When cap bits have been already read, this doesn't read again but
525 * returns the cached value.
526 */
527 static inline u32
528 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid)
529 {
530 return snd_hda_param_read(codec, nid, AC_PAR_PIN_CAP);
531
532 }
533
534 /**
535 * snd_hda_override_pin_caps - Override the pin capabilities
536 * @codec: the CODEC
537 * @nid: the NID to override
538 * @caps: the capability bits to set
539 *
540 * Override the cached PIN capabilitiy bits value by the given one.
541 *
542 * Returns zero if successful or a negative error code.
543 */
544 static inline int
545 snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid,
546 unsigned int caps)
547 {
548 return snd_hdac_override_parm(&codec->core, nid, AC_PAR_PIN_CAP, caps);
549 }
550
551 bool snd_hda_check_amp_caps(struct hda_codec *codec, hda_nid_t nid,
552 int dir, unsigned int bits);
553
554 #define nid_has_mute(codec, nid, dir) \
555 snd_hda_check_amp_caps(codec, nid, dir, (AC_AMPCAP_MUTE | AC_AMPCAP_MIN_MUTE))
556 #define nid_has_volume(codec, nid, dir) \
557 snd_hda_check_amp_caps(codec, nid, dir, AC_AMPCAP_NUM_STEPS)
558
559
560 /* flags for hda_nid_item */
561 #define HDA_NID_ITEM_AMP (1<<0)
562
563 struct hda_nid_item {
564 struct snd_kcontrol *kctl;
565 unsigned int index;
566 hda_nid_t nid;
567 unsigned short flags;
568 };
569
570 int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid,
571 struct snd_kcontrol *kctl);
572 int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl,
573 unsigned int index, hda_nid_t nid);
574 void snd_hda_ctls_clear(struct hda_codec *codec);
575
576 /*
577 * hwdep interface
578 */
579 #ifdef CONFIG_SND_HDA_HWDEP
580 int snd_hda_create_hwdep(struct hda_codec *codec);
581 #else
582 static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; }
583 #endif
584
585 void snd_hda_sysfs_init(struct hda_codec *codec);
586 void snd_hda_sysfs_clear(struct hda_codec *codec);
587
588 extern const struct attribute_group *snd_hda_dev_attr_groups[];
589
590 #ifdef CONFIG_SND_HDA_RECONFIG
591 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key);
592 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key);
593 int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp);
594 #else
595 static inline
596 const char *snd_hda_get_hint(struct hda_codec *codec, const char *key)
597 {
598 return NULL;
599 }
600
601 static inline
602 int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key)
603 {
604 return -ENOENT;
605 }
606
607 static inline
608 int 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
618 void snd_hda_schedule_power_save(struct hda_codec *codec);
619
620 struct hda_amp_list {
621 hda_nid_t nid;
622 unsigned char dir;
623 unsigned char idx;
624 };
625
626 struct hda_loopback_check {
627 const struct hda_amp_list *amplist;
628 int power_on;
629 };
630
631 int 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 */
636 static inline bool
637 snd_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(&codec->core, nid, target_state);
641 }
642
643 static 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(&codec->core, nid, target_state);
648 }
649 unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec,
650 hda_nid_t nid,
651 unsigned int power_state);
652
653 void snd_hda_codec_shutdown(struct hda_codec *codec);
654
655 /*
656 * AMP control callbacks
657 */
658 /* retrieve parameters from private_value */
659 #define get_amp_nid_(pv) ((pv) & 0xffff)
660 #define get_amp_nid(kc) get_amp_nid_((kc)->private_value)
661 #define get_amp_channels(kc) (((kc)->private_value >> 16) & 0x3)
662 #define get_amp_direction_(pv) (((pv) >> 18) & 0x1)
663 #define get_amp_direction(kc) get_amp_direction_((kc)->private_value)
664 #define get_amp_index_(pv) (((pv) >> 19) & 0xf)
665 #define get_amp_index(kc) get_amp_index_((kc)->private_value)
666 #define get_amp_offset(kc) (((kc)->private_value >> 23) & 0x3f)
667 #define get_amp_min_mute(kc) (((kc)->private_value >> 29) & 0x1)
668
669 /*
670 * enum control helper
671 */
672 int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol,
673 struct snd_ctl_elem_info *uinfo,
674 int num_items, const char * const *texts);
675 #define snd_hda_enum_bool_helper_info(kcontrol, uinfo) \
676 snd_hda_enum_helper_info(kcontrol, uinfo, 0, NULL)
677
678 /*
679 * CEA Short Audio Descriptor data
680 */
681 struct cea_sad {
682 int channels;
683 int format; /* (format == 0) indicates invalid SAD */
684 int rates;
685 int sample_bits; /* for LPCM */
686 int max_bitrate; /* for AC3...ATRAC */
687 int profile; /* for WMAPRO */
688 };
689
690 #define ELD_FIXED_BYTES 20
691 #define ELD_MAX_SIZE 256
692 #define ELD_MAX_MNL 16
693 #define ELD_MAX_SAD 16
694
695 /*
696 * ELD: EDID Like Data
697 */
698 struct parsed_hdmi_eld {
699 /*
700 * all fields will be cleared before updating ELD
701 */
702 int baseline_len;
703 int eld_ver;
704 int cea_edid_ver;
705 char monitor_name[ELD_MAX_MNL + 1];
706 int manufacture_id;
707 int product_id;
708 u64 port_id;
709 int support_hdcp;
710 int support_ai;
711 int conn_type;
712 int aud_synch_delay;
713 int spk_alloc;
714 int sad_count;
715 struct cea_sad sad[ELD_MAX_SAD];
716 };
717
718 struct hdmi_eld {
719 bool monitor_present;
720 bool eld_valid;
721 int eld_size;
722 char eld_buffer[ELD_MAX_SIZE];
723 struct parsed_hdmi_eld info;
724 };
725
726 int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid);
727 int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid,
728 unsigned char *buf, int *eld_size);
729 int snd_hdmi_parse_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e,
730 const unsigned char *buf, int size);
731 void snd_hdmi_show_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e);
732 void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e,
733 struct hda_pcm_stream *hinfo);
734
735 int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid,
736 unsigned char *buf, int *eld_size,
737 bool rev3_or_later);
738
739 #ifdef CONFIG_SND_PROC_FS
740 void snd_hdmi_print_eld_info(struct hdmi_eld *eld,
741 struct snd_info_buffer *buffer,
742 hda_nid_t pin_nid, int dev_id, hda_nid_t cvt_nid);
743 void snd_hdmi_write_eld_info(struct hdmi_eld *eld,
744 struct snd_info_buffer *buffer);
745 #endif
746
747 #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE 80
748 void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen);
749
750 void snd_hda_codec_display_power(struct hda_codec *codec, bool enable);
751
752 /*
753 */
754 #define codec_err(codec, fmt, args...) \
755 dev_err(hda_codec_dev(codec), fmt, ##args)
756 #define codec_warn(codec, fmt, args...) \
757 dev_warn(hda_codec_dev(codec), fmt, ##args)
758 #define codec_info(codec, fmt, args...) \
759 dev_info(hda_codec_dev(codec), fmt, ##args)
760 #define codec_dbg(codec, fmt, args...) \
761 dev_dbg(hda_codec_dev(codec), fmt, ##args)
762
763 #endif /* __SOUND_HDA_LOCAL_H */
Linux Kernel