Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Universal Interface for Intel High Definition Audio Codec
4 *
5 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
6 */
7
8#ifndef __SOUND_HDA_CODEC_H
9#define __SOUND_HDA_CODEC_H
10
11#include <linux/refcount.h>
12#include <linux/mod_devicetable.h>
13#include <sound/info.h>
14#include <sound/control.h>
15#include <sound/pcm.h>
16#include <sound/hwdep.h>
17#include <sound/hdaudio.h>
18#include <sound/hda_verbs.h>
19#include <sound/hda_regmap.h>
20
21#define IS_BXT(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0x5a98)
22#define IS_CFL(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0xa348)
23
24/*
25 * Structures
26 */
27
28struct hda_bus;
29struct hda_beep;
30struct hda_codec;
31struct hda_pcm;
32struct hda_pcm_stream;
33
34/*
35 * codec bus
36 *
37 * each controller needs to creata a hda_bus to assign the accessor.
38 * A hda_bus contains several codecs in the list codec_list.
39 */
40struct hda_bus {
41 struct hdac_bus core;
42
43 struct snd_card *card;
44
45 struct pci_dev *pci;
46 const char *modelname;
47
48 struct mutex prepare_mutex;
49
50 /* assigned PCMs */
51 DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
52
53 /* misc op flags */
54 unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
55 /* status for codec/controller */
56 unsigned int shutdown :1; /* being unloaded */
57 unsigned int response_reset:1; /* controller was reset */
58 unsigned int in_reset:1; /* during reset operation */
59 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
60 unsigned int bus_probing :1; /* during probing process */
61 unsigned int keep_power:1; /* keep power up for notification */
62 unsigned int jackpoll_in_suspend:1; /* keep jack polling during
63 * runtime suspend
64 */
65
66 int primary_dig_out_type; /* primary digital out PCM type */
67 unsigned int mixer_assigned; /* codec addr for mixer name */
68};
69
70/* from hdac_bus to hda_bus */
71#define to_hda_bus(bus) container_of(bus, struct hda_bus, core)
72
73/*
74 * codec preset
75 *
76 * Known codecs have the patch to build and set up the controls/PCMs
77 * better than the generic parser.
78 */
79typedef int (*hda_codec_patch_t)(struct hda_codec *);
80
81#define HDA_CODEC_ID_SKIP_PROBE 0x00000001
82#define HDA_CODEC_ID_GENERIC_HDMI 0x00000101
83#define HDA_CODEC_ID_GENERIC 0x00000201
84
85#define HDA_CODEC_REV_ENTRY(_vid, _rev, _name, _patch) \
86 { .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
87 .api_version = HDA_DEV_LEGACY, \
88 .driver_data = (unsigned long)(_patch) }
89#define HDA_CODEC_ENTRY(_vid, _name, _patch) \
90 HDA_CODEC_REV_ENTRY(_vid, 0, _name, _patch)
91
92struct hda_codec_driver {
93 struct hdac_driver core;
94 const struct hda_device_id *id;
95};
96
97int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
98 struct module *owner);
99#define hda_codec_driver_register(drv) \
100 __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE)
101void hda_codec_driver_unregister(struct hda_codec_driver *drv);
102#define module_hda_codec_driver(drv) \
103 module_driver(drv, hda_codec_driver_register, \
104 hda_codec_driver_unregister)
105
106/* ops set by the preset patch */
107struct hda_codec_ops {
108 int (*build_controls)(struct hda_codec *codec);
109 int (*build_pcms)(struct hda_codec *codec);
110 int (*init)(struct hda_codec *codec);
111 void (*free)(struct hda_codec *codec);
112 void (*unsol_event)(struct hda_codec *codec, unsigned int res);
113 void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
114 unsigned int power_state);
115#ifdef CONFIG_PM
116 int (*suspend)(struct hda_codec *codec);
117 int (*resume)(struct hda_codec *codec);
118 int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
119#endif
120 void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on);
121};
122
123/* PCM callbacks */
124struct hda_pcm_ops {
125 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
126 struct snd_pcm_substream *substream);
127 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
128 struct snd_pcm_substream *substream);
129 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
130 unsigned int stream_tag, unsigned int format,
131 struct snd_pcm_substream *substream);
132 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
133 struct snd_pcm_substream *substream);
134 unsigned int (*get_delay)(struct hda_pcm_stream *info,
135 struct hda_codec *codec,
136 struct snd_pcm_substream *substream);
137};
138
139/* PCM information for each substream */
140struct hda_pcm_stream {
141 unsigned int substreams; /* number of substreams, 0 = not exist*/
142 unsigned int channels_min; /* min. number of channels */
143 unsigned int channels_max; /* max. number of channels */
144 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
145 u32 rates; /* supported rates */
146 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
147 unsigned int maxbps; /* supported max. bit per sample */
148 const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
149 struct hda_pcm_ops ops;
150};
151
152/* PCM types */
153enum {
154 HDA_PCM_TYPE_AUDIO,
155 HDA_PCM_TYPE_SPDIF,
156 HDA_PCM_TYPE_HDMI,
157 HDA_PCM_TYPE_MODEM,
158 HDA_PCM_NTYPES
159};
160
161#define SNDRV_PCM_INVALID_DEVICE (-1)
162/* for PCM creation */
163struct hda_pcm {
164 char *name;
165 struct hda_pcm_stream stream[2];
166 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */
167 int device; /* device number to assign */
168 struct snd_pcm *pcm; /* assigned PCM instance */
169 bool own_chmap; /* codec driver provides own channel maps */
170 /* private: */
171 struct hda_codec *codec;
172 struct list_head list;
173 unsigned int disconnected:1;
174};
175
176/* codec information */
177struct hda_codec {
178 struct hdac_device core;
179 struct hda_bus *bus;
180 struct snd_card *card;
181 unsigned int addr; /* codec addr*/
182 u32 probe_id; /* overridden id for probing */
183
184 /* detected preset */
185 const struct hda_device_id *preset;
186 const char *modelname; /* model name for preset */
187
188 /* set by patch */
189 struct hda_codec_ops patch_ops;
190
191 /* PCM to create, set by patch_ops.build_pcms callback */
192 struct list_head pcm_list_head;
193 refcount_t pcm_ref;
194 wait_queue_head_t remove_sleep;
195
196 /* codec specific info */
197 void *spec;
198
199 /* beep device */
200 struct hda_beep *beep;
201 unsigned int beep_mode;
202
203 /* widget capabilities cache */
204 u32 *wcaps;
205
206 struct snd_array mixers; /* list of assigned mixer elements */
207 struct snd_array nids; /* list of mapped mixer elements */
208
209 struct list_head conn_list; /* linked-list of connection-list */
210
211 struct mutex spdif_mutex;
212 struct mutex control_mutex;
213 struct snd_array spdif_out;
214 unsigned int spdif_in_enable; /* SPDIF input enable? */
215 const hda_nid_t *follower_dig_outs; /* optional digital out follower widgets */
216 struct snd_array init_pins; /* initial (BIOS) pin configurations */
217 struct snd_array driver_pins; /* pin configs set by codec parser */
218 struct snd_array cvt_setups; /* audio convert setups */
219
220 struct mutex user_mutex;
221#ifdef CONFIG_SND_HDA_RECONFIG
222 struct snd_array init_verbs; /* additional init verbs */
223 struct snd_array hints; /* additional hints */
224 struct snd_array user_pins; /* default pin configs to override */
225#endif
226
227#ifdef CONFIG_SND_HDA_HWDEP
228 struct snd_hwdep *hwdep; /* assigned hwdep device */
229#endif
230
231 /* misc flags */
232 unsigned int configured:1; /* codec was configured */
233 unsigned int in_freeing:1; /* being released */
234 unsigned int display_power_control:1; /* needs display power */
235 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
236 * status change
237 * (e.g. Realtek codecs)
238 */
239 unsigned int pin_amp_workaround:1; /* pin out-amp takes index
240 * (e.g. Conexant codecs)
241 */
242 unsigned int single_adc_amp:1; /* adc in-amp takes no index
243 * (e.g. CX20549 codec)
244 */
245 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
246 unsigned int pins_shutup:1; /* pins are shut up */
247 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
248 unsigned int no_jack_detect:1; /* Machine has no jack-detection */
249 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
250 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
251 unsigned int pcm_format_first:1; /* PCM format must be set first */
252 unsigned int cached_write:1; /* write only to caches */
253 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */
254 unsigned int dump_coef:1; /* dump processing coefs in codec proc file */
255 unsigned int power_save_node:1; /* advanced PM for each widget */
256 unsigned int auto_runtime_pm:1; /* enable automatic codec runtime pm */
257 unsigned int force_pin_prefix:1; /* Add location prefix */
258 unsigned int link_down_at_suspend:1; /* link down at runtime suspend */
259 unsigned int relaxed_resume:1; /* don't resume forcibly for jack */
260 unsigned int forced_resume:1; /* forced resume for jack */
261
262#ifdef CONFIG_PM
263 unsigned long power_on_acct;
264 unsigned long power_off_acct;
265 unsigned long power_jiffies;
266#endif
267
268 /* filter the requested power state per nid */
269 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
270 unsigned int power_state);
271
272 /* codec-specific additional proc output */
273 void (*proc_widget_hook)(struct snd_info_buffer *buffer,
274 struct hda_codec *codec, hda_nid_t nid);
275
276 /* jack detection */
277 struct snd_array jacktbl;
278 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
279 struct delayed_work jackpoll_work;
280
281 int depop_delay; /* depop delay in ms, -1 for default delay time */
282
283 /* fix-up list */
284 int fixup_id;
285 const struct hda_fixup *fixup_list;
286 const char *fixup_name;
287
288 /* additional init verbs */
289 struct snd_array verbs;
290};
291
292#define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, core.dev)
293#define hda_codec_dev(_dev) (&(_dev)->core.dev)
294
295#define hdac_to_hda_codec(_hdac) container_of(_hdac, struct hda_codec, core)
296
297#define list_for_each_codec(c, bus) \
298 list_for_each_entry(c, &(bus)->core.codec_list, core.list)
299#define list_for_each_codec_safe(c, n, bus) \
300 list_for_each_entry_safe(c, n, &(bus)->core.codec_list, core.list)
301
302/* snd_hda_codec_read/write optional flags */
303#define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
304
305/*
306 * constructors
307 */
308__printf(3, 4) struct hda_codec *
309snd_hda_codec_device_init(struct hda_bus *bus, unsigned int codec_addr,
310 const char *fmt, ...);
311int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
312 unsigned int codec_addr, struct hda_codec **codecp);
313int snd_hda_codec_device_new(struct hda_bus *bus, struct snd_card *card,
314 unsigned int codec_addr, struct hda_codec *codec,
315 bool snddev_managed);
316int snd_hda_codec_configure(struct hda_codec *codec);
317int snd_hda_codec_update_widgets(struct hda_codec *codec);
318void snd_hda_codec_register(struct hda_codec *codec);
319void snd_hda_codec_unregister(struct hda_codec *codec);
320void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
321
322/*
323 * low level functions
324 */
325static inline unsigned int
326snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
327 int flags,
328 unsigned int verb, unsigned int parm)
329{
330 return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm);
331}
332
333static inline int
334snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
335 unsigned int verb, unsigned int parm)
336{
337 return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm);
338}
339
340#define snd_hda_param_read(codec, nid, param) \
341 snd_hdac_read_parm(&(codec)->core, nid, param)
342#define snd_hda_get_sub_nodes(codec, nid, start_nid) \
343 snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid)
344int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
345 hda_nid_t *conn_list, int max_conns);
346static inline int
347snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
348{
349 return snd_hda_get_connections(codec, nid, NULL, 0);
350}
351
352#define snd_hda_get_raw_connections(codec, nid, list, max_conns) \
353 snd_hdac_get_connections(&(codec)->core, nid, list, max_conns)
354#define snd_hda_get_num_raw_conns(codec, nid) \
355 snd_hdac_get_connections(&(codec)->core, nid, NULL, 0)
356
357int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
358 const hda_nid_t **listp);
359int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
360 const hda_nid_t *list);
361int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
362 hda_nid_t nid, int recursive);
363unsigned int snd_hda_get_num_devices(struct hda_codec *codec, hda_nid_t nid);
364int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
365 u8 *dev_list, int max_devices);
366int snd_hda_get_dev_select(struct hda_codec *codec, hda_nid_t nid);
367int snd_hda_set_dev_select(struct hda_codec *codec, hda_nid_t nid, int dev_id);
368
369struct hda_verb {
370 hda_nid_t nid;
371 u32 verb;
372 u32 param;
373};
374
375void snd_hda_sequence_write(struct hda_codec *codec,
376 const struct hda_verb *seq);
377
378/* cached write */
379static inline int
380snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
381 int flags, unsigned int verb, unsigned int parm)
382{
383 return snd_hdac_regmap_write(&codec->core, nid, verb, parm);
384}
385
386/* the struct for codec->pin_configs */
387struct hda_pincfg {
388 hda_nid_t nid;
389 unsigned char ctrl; /* original pin control value */
390 unsigned char target; /* target pin control value */
391 unsigned int cfg; /* default configuration */
392};
393
394unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
395int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
396 unsigned int cfg);
397int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
398 hda_nid_t nid, unsigned int cfg); /* for hwdep */
399void snd_hda_shutup_pins(struct hda_codec *codec);
400
401/* SPDIF controls */
402struct hda_spdif_out {
403 hda_nid_t nid; /* Converter nid values relate to */
404 unsigned int status; /* IEC958 status bits */
405 unsigned short ctls; /* SPDIF control bits */
406};
407struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
408 hda_nid_t nid);
409void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
410void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
411
412/*
413 * Mixer
414 */
415int snd_hda_codec_build_controls(struct hda_codec *codec);
416
417/*
418 * PCM
419 */
420int snd_hda_codec_parse_pcms(struct hda_codec *codec);
421int snd_hda_codec_build_pcms(struct hda_codec *codec);
422
423__printf(2, 3)
424struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
425 const char *fmt, ...);
426
427void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
428
429static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
430{
431 refcount_inc(&pcm->codec->pcm_ref);
432}
433void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
434
435int snd_hda_codec_prepare(struct hda_codec *codec,
436 struct hda_pcm_stream *hinfo,
437 unsigned int stream,
438 unsigned int format,
439 struct snd_pcm_substream *substream);
440void snd_hda_codec_cleanup(struct hda_codec *codec,
441 struct hda_pcm_stream *hinfo,
442 struct snd_pcm_substream *substream);
443
444void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
445 u32 stream_tag,
446 int channel_id, int format);
447void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
448 int do_now);
449#define snd_hda_codec_cleanup_stream(codec, nid) \
450 __snd_hda_codec_cleanup_stream(codec, nid, 0)
451
452#define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, bpsp) \
453 snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, bpsp)
454#define snd_hda_is_supported_format(codec, nid, fmt) \
455 snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
456
457extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
458
459int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec,
460 struct hda_pcm *cpcm);
461
462/*
463 * Misc
464 */
465void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
466void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
467 unsigned int power_state);
468
469int snd_hda_lock_devices(struct hda_bus *bus);
470void snd_hda_unlock_devices(struct hda_bus *bus);
471void snd_hda_bus_reset(struct hda_bus *bus);
472void snd_hda_bus_reset_codecs(struct hda_bus *bus);
473
474int snd_hda_codec_set_name(struct hda_codec *codec, const char *name);
475
476/*
477 * power management
478 */
479extern const struct dev_pm_ops hda_codec_driver_pm;
480
481static inline
482int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
483{
484#ifdef CONFIG_PM
485 if (codec->patch_ops.check_power_status)
486 return codec->patch_ops.check_power_status(codec, nid);
487#endif
488 return 0;
489}
490
491/*
492 * power saving
493 */
494#define snd_hda_power_up(codec) snd_hdac_power_up(&(codec)->core)
495#define snd_hda_power_up_pm(codec) snd_hdac_power_up_pm(&(codec)->core)
496#define snd_hda_power_down(codec) snd_hdac_power_down(&(codec)->core)
497#define snd_hda_power_down_pm(codec) snd_hdac_power_down_pm(&(codec)->core)
498#ifdef CONFIG_PM
499void snd_hda_codec_set_power_save(struct hda_codec *codec, int delay);
500void snd_hda_set_power_save(struct hda_bus *bus, int delay);
501void snd_hda_update_power_acct(struct hda_codec *codec);
502#else
503static inline void snd_hda_codec_set_power_save(struct hda_codec *codec, int delay) {}
504static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {}
505#endif
506
507static inline bool hda_codec_need_resume(struct hda_codec *codec)
508{
509 return !codec->relaxed_resume && codec->jacktbl.used;
510}
511
512#ifdef CONFIG_SND_HDA_PATCH_LOADER
513/*
514 * patch firmware
515 */
516int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
517#endif
518
519#ifdef CONFIG_SND_HDA_DSP_LOADER
520int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
521 unsigned int size,
522 struct snd_dma_buffer *bufp);
523void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start);
524void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
525 struct snd_dma_buffer *dmab);
526#else
527static inline int
528snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
529 unsigned int size,
530 struct snd_dma_buffer *bufp)
531{
532 return -ENOSYS;
533}
534static inline void
535snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
536static inline void
537snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
538 struct snd_dma_buffer *dmab) {}
539#endif
540
541#endif /* __SOUND_HDA_CODEC_H */