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