1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Universal Interface for Intel High Definition Audio Codec
5 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
8 #ifndef __SOUND_HDA_CODEC_H
9 #define __SOUND_HDA_CODEC_H
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>
29 struct hda_pcm_stream;
34 * each controller needs to creata a hda_bus to assign the accessor.
35 * A hda_bus contains several codecs in the list codec_list.
40 struct snd_card *card;
43 const char *modelname;
45 struct mutex prepare_mutex;
48 DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
51 unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
52 /* status for codec/controller */
53 unsigned int shutdown :1; /* being unloaded */
54 unsigned int response_reset:1; /* controller was reset */
55 unsigned int in_reset:1; /* during reset operation */
56 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
57 unsigned int bus_probing :1; /* during probing process */
58 unsigned int keep_power:1; /* keep power up for notification */
59 unsigned int jackpoll_in_suspend:1; /* keep jack polling during
63 int primary_dig_out_type; /* primary digital out PCM type */
64 unsigned int mixer_assigned; /* codec addr for mixer name */
67 /* from hdac_bus to hda_bus */
68 #define to_hda_bus(bus) container_of(bus, struct hda_bus, core)
73 * Known codecs have the patch to build and set up the controls/PCMs
74 * better than the generic parser.
76 typedef int (*hda_codec_patch_t)(struct hda_codec *);
78 #define HDA_CODEC_ID_SKIP_PROBE 0x00000001
79 #define HDA_CODEC_ID_GENERIC_HDMI 0x00000101
80 #define HDA_CODEC_ID_GENERIC 0x00000201
82 #define HDA_CODEC_REV_ENTRY(_vid, _rev, _name, _patch) \
83 { .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
84 .api_version = HDA_DEV_LEGACY, \
85 .driver_data = (unsigned long)(_patch) }
86 #define HDA_CODEC_ENTRY(_vid, _name, _patch) \
87 HDA_CODEC_REV_ENTRY(_vid, 0, _name, _patch)
89 struct hda_codec_driver {
90 struct hdac_driver core;
91 const struct hda_device_id *id;
94 int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
95 struct module *owner);
96 #define hda_codec_driver_register(drv) \
97 __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE)
98 void hda_codec_driver_unregister(struct hda_codec_driver *drv);
99 #define module_hda_codec_driver(drv) \
100 module_driver(drv, hda_codec_driver_register, \
101 hda_codec_driver_unregister)
103 /* ops set by the preset patch */
104 struct hda_codec_ops {
105 int (*build_controls)(struct hda_codec *codec);
106 int (*build_pcms)(struct hda_codec *codec);
107 int (*init)(struct hda_codec *codec);
108 void (*free)(struct hda_codec *codec);
109 void (*unsol_event)(struct hda_codec *codec, unsigned int res);
110 void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
111 unsigned int power_state);
113 int (*suspend)(struct hda_codec *codec);
114 int (*resume)(struct hda_codec *codec);
115 int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
117 void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on);
122 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
123 struct snd_pcm_substream *substream);
124 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
125 struct snd_pcm_substream *substream);
126 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
127 unsigned int stream_tag, unsigned int format,
128 struct snd_pcm_substream *substream);
129 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
130 struct snd_pcm_substream *substream);
131 unsigned int (*get_delay)(struct hda_pcm_stream *info,
132 struct hda_codec *codec,
133 struct snd_pcm_substream *substream);
136 /* PCM information for each substream */
137 struct hda_pcm_stream {
138 unsigned int substreams; /* number of substreams, 0 = not exist*/
139 unsigned int channels_min; /* min. number of channels */
140 unsigned int channels_max; /* max. number of channels */
141 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
142 u32 rates; /* supported rates */
143 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
144 u32 subformats; /* for S32_LE format, SNDRV_PCM_SUBFMTBIT_* */
145 unsigned int maxbps; /* supported max. bit per sample */
146 const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
147 struct hda_pcm_ops ops;
159 #define SNDRV_PCM_INVALID_DEVICE (-1)
160 /* for PCM creation */
163 struct hda_pcm_stream stream[2];
164 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */
165 int device; /* device number to assign */
166 struct snd_pcm *pcm; /* assigned PCM instance */
167 bool own_chmap; /* codec driver provides own channel maps */
169 struct hda_codec *codec;
170 struct list_head list;
171 unsigned int disconnected:1;
174 /* codec information */
176 struct hdac_device core;
178 struct snd_card *card;
179 unsigned int addr; /* codec addr*/
180 u32 probe_id; /* overridden id for probing */
182 /* detected preset */
183 const struct hda_device_id *preset;
184 const char *modelname; /* model name for preset */
187 struct hda_codec_ops patch_ops;
189 /* PCM to create, set by patch_ops.build_pcms callback */
190 struct list_head pcm_list_head;
192 wait_queue_head_t remove_sleep;
194 /* codec specific info */
198 struct hda_beep *beep;
199 unsigned int beep_mode;
201 /* widget capabilities cache */
204 struct snd_array mixers; /* list of assigned mixer elements */
205 struct snd_array nids; /* list of mapped mixer elements */
207 struct list_head conn_list; /* linked-list of connection-list */
209 struct mutex spdif_mutex;
210 struct mutex control_mutex;
211 struct snd_array spdif_out;
212 unsigned int spdif_in_enable; /* SPDIF input enable? */
213 const hda_nid_t *follower_dig_outs; /* optional digital out follower widgets */
214 struct snd_array init_pins; /* initial (BIOS) pin configurations */
215 struct snd_array driver_pins; /* pin configs set by codec parser */
216 struct snd_array cvt_setups; /* audio convert setups */
218 struct mutex user_mutex;
219 #ifdef CONFIG_SND_HDA_RECONFIG
220 struct snd_array init_verbs; /* additional init verbs */
221 struct snd_array hints; /* additional hints */
222 struct snd_array user_pins; /* default pin configs to override */
225 #ifdef CONFIG_SND_HDA_HWDEP
226 struct snd_hwdep *hwdep; /* assigned hwdep device */
230 unsigned int configured:1; /* codec was configured */
231 unsigned int in_freeing:1; /* being released */
232 unsigned int display_power_control:1; /* needs display power */
233 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
235 * (e.g. Realtek codecs)
237 unsigned int pin_amp_workaround:1; /* pin out-amp takes index
238 * (e.g. Conexant codecs)
240 unsigned int single_adc_amp:1; /* adc in-amp takes no index
241 * (e.g. CX20549 codec)
243 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
244 unsigned int pins_shutup:1; /* pins are shut up */
245 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
246 unsigned int no_jack_detect:1; /* Machine has no jack-detection */
247 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
248 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
249 unsigned int pcm_format_first:1; /* PCM format must be set first */
250 unsigned int cached_write:1; /* write only to caches */
251 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */
252 unsigned int dump_coef:1; /* dump processing coefs in codec proc file */
253 unsigned int power_save_node:1; /* advanced PM for each widget */
254 unsigned int auto_runtime_pm:1; /* enable automatic codec runtime pm */
255 unsigned int force_pin_prefix:1; /* Add location prefix */
256 unsigned int link_down_at_suspend:1; /* link down at runtime suspend */
257 unsigned int relaxed_resume:1; /* don't resume forcibly for jack */
258 unsigned int forced_resume:1; /* forced resume for jack */
259 unsigned int no_stream_clean_at_suspend:1; /* do not clean streams at suspend */
260 unsigned int ctl_dev_id:1; /* old control element id build behaviour */
263 unsigned long power_on_acct;
264 unsigned long power_off_acct;
265 unsigned long power_jiffies;
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);
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);
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;
281 int depop_delay; /* depop delay in ms, -1 for default delay time */
285 const struct hda_fixup *fixup_list;
286 const char *fixup_name;
288 /* additional init verbs */
289 struct snd_array verbs;
292 #define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, core.dev)
293 #define hda_codec_dev(_dev) (&(_dev)->core.dev)
295 #define hdac_to_hda_codec(_hdac) container_of(_hdac, struct hda_codec, core)
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)
302 /* snd_hda_codec_read/write optional flags */
303 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
308 __printf(3, 4) struct hda_codec *
309 snd_hda_codec_device_init(struct hda_bus *bus, unsigned int codec_addr,
310 const char *fmt, ...);
311 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
312 unsigned int codec_addr, struct hda_codec **codecp);
313 int 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);
316 int snd_hda_codec_configure(struct hda_codec *codec);
317 int snd_hda_codec_update_widgets(struct hda_codec *codec);
318 void snd_hda_codec_register(struct hda_codec *codec);
319 void snd_hda_codec_unregister(struct hda_codec *codec);
320 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
323 * low level functions
325 static inline unsigned int
326 snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
328 unsigned int verb, unsigned int parm)
330 return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm);
334 snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
335 unsigned int verb, unsigned int parm)
337 return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm);
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)
344 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
345 hda_nid_t *conn_list, int max_conns);
347 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
349 return snd_hda_get_connections(codec, nid, NULL, 0);
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)
357 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
358 const hda_nid_t **listp);
359 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
360 const hda_nid_t *list);
361 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
362 hda_nid_t nid, int recursive);
363 unsigned int snd_hda_get_num_devices(struct hda_codec *codec, hda_nid_t nid);
364 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
365 u8 *dev_list, int max_devices);
366 int snd_hda_get_dev_select(struct hda_codec *codec, hda_nid_t nid);
367 int snd_hda_set_dev_select(struct hda_codec *codec, hda_nid_t nid, int dev_id);
375 void snd_hda_sequence_write(struct hda_codec *codec,
376 const struct hda_verb *seq);
380 snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
381 int flags, unsigned int verb, unsigned int parm)
383 return snd_hdac_regmap_write(&codec->core, nid, verb, parm);
386 /* the struct for codec->pin_configs */
389 unsigned char ctrl; /* original pin control value */
390 unsigned char target; /* target pin control value */
391 unsigned int cfg; /* default configuration */
394 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
395 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
397 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
398 hda_nid_t nid, unsigned int cfg); /* for hwdep */
399 void snd_hda_shutup_pins(struct hda_codec *codec);
402 struct 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 */
407 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
409 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
410 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
415 int snd_hda_codec_build_controls(struct hda_codec *codec);
420 int snd_hda_codec_parse_pcms(struct hda_codec *codec);
421 int snd_hda_codec_build_pcms(struct hda_codec *codec);
424 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
425 const char *fmt, ...);
427 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
429 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
431 refcount_inc(&pcm->codec->pcm_ref);
433 void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
435 int snd_hda_codec_prepare(struct hda_codec *codec,
436 struct hda_pcm_stream *hinfo,
439 struct snd_pcm_substream *substream);
440 void snd_hda_codec_cleanup(struct hda_codec *codec,
441 struct hda_pcm_stream *hinfo,
442 struct snd_pcm_substream *substream);
444 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
446 int channel_id, int format);
447 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
449 #define snd_hda_codec_cleanup_stream(codec, nid) \
450 __snd_hda_codec_cleanup_stream(codec, nid, 0)
452 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, subfmtp, bpsp) \
453 snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, subfmtp, bpsp)
454 #define snd_hda_is_supported_format(codec, nid, fmt) \
455 snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
457 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
459 int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec,
460 struct hda_pcm *cpcm);
465 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
466 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
467 unsigned int power_state);
469 int snd_hda_lock_devices(struct hda_bus *bus);
470 void snd_hda_unlock_devices(struct hda_bus *bus);
471 void snd_hda_bus_reset(struct hda_bus *bus);
472 void snd_hda_bus_reset_codecs(struct hda_bus *bus);
474 int snd_hda_codec_set_name(struct hda_codec *codec, const char *name);
479 extern const struct dev_pm_ops hda_codec_driver_pm;
482 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
485 if (codec->patch_ops.check_power_status)
486 return codec->patch_ops.check_power_status(codec, nid);
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)
499 void snd_hda_codec_set_power_save(struct hda_codec *codec, int delay);
500 void snd_hda_set_power_save(struct hda_bus *bus, int delay);
501 void snd_hda_update_power_acct(struct hda_codec *codec);
503 static inline void snd_hda_codec_set_power_save(struct hda_codec *codec, int delay) {}
504 static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {}
507 static inline bool hda_codec_need_resume(struct hda_codec *codec)
509 return !codec->relaxed_resume && codec->jacktbl.used;
512 #ifdef CONFIG_SND_HDA_PATCH_LOADER
516 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
519 #ifdef CONFIG_SND_HDA_DSP_LOADER
520 int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
522 struct snd_dma_buffer *bufp);
523 void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start);
524 void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
525 struct snd_dma_buffer *dmab);
528 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
530 struct snd_dma_buffer *bufp)
535 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
537 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
538 struct snd_dma_buffer *dmab) {}
541 #endif /* __SOUND_HDA_CODEC_H */