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
28 struct hda_bus;
29 struct hda_beep;
30 struct hda_codec;
31 struct hda_pcm;
32 struct 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 */
40 struct 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 */
79 typedef 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
92 struct hda_codec_driver {
93 struct hdac_driver core;
94 const struct hda_device_id *id;
95 };
96
97 int __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)
101 void 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 */
107 struct 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 */
124 struct 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 */
140 struct 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 */
153 enum {
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 */
163 struct 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 */
177 struct 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 unsigned int no_stream_clean_at_suspend:1; /* do not clean streams at suspend */
262 unsigned int ctl_dev_id:1; /* old control element id build behaviour */
263
264 #ifdef CONFIG_PM
265 unsigned long power_on_acct;
266 unsigned long power_off_acct;
267 unsigned long power_jiffies;
268 #endif
269
270 /* filter the requested power state per nid */
271 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
272 unsigned int power_state);
273
274 /* codec-specific additional proc output */
275 void (*proc_widget_hook)(struct snd_info_buffer *buffer,
276 struct hda_codec *codec, hda_nid_t nid);
277
278 /* jack detection */
279 struct snd_array jacktbl;
280 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
281 struct delayed_work jackpoll_work;
282
283 int depop_delay; /* depop delay in ms, -1 for default delay time */
284
285 /* fix-up list */
286 int fixup_id;
287 const struct hda_fixup *fixup_list;
288 const char *fixup_name;
289
290 /* additional init verbs */
291 struct snd_array verbs;
292 };
293
294 #define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, core.dev)
295 #define hda_codec_dev(_dev) (&(_dev)->core.dev)
296
297 #define hdac_to_hda_codec(_hdac) container_of(_hdac, struct hda_codec, core)
298
299 #define list_for_each_codec(c, bus) \
300 list_for_each_entry(c, &(bus)->core.codec_list, core.list)
301 #define list_for_each_codec_safe(c, n, bus) \
302 list_for_each_entry_safe(c, n, &(bus)->core.codec_list, core.list)
303
304 /* snd_hda_codec_read/write optional flags */
305 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
306
307 /*
308 * constructors
309 */
310 __printf(3, 4) struct hda_codec *
311 snd_hda_codec_device_init(struct hda_bus *bus, unsigned int codec_addr,
312 const char *fmt, ...);
313 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
314 unsigned int codec_addr, struct hda_codec **codecp);
315 int snd_hda_codec_device_new(struct hda_bus *bus, struct snd_card *card,
316 unsigned int codec_addr, struct hda_codec *codec,
317 bool snddev_managed);
318 int snd_hda_codec_configure(struct hda_codec *codec);
319 int snd_hda_codec_update_widgets(struct hda_codec *codec);
320 void snd_hda_codec_register(struct hda_codec *codec);
321 void snd_hda_codec_unregister(struct hda_codec *codec);
322 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
323
324 /*
325 * low level functions
326 */
327 static inline unsigned int
snd_hda_codec_read(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)328 snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
329 int flags,
330 unsigned int verb, unsigned int parm)
331 {
332 return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm);
333 }
334
335 static inline int
snd_hda_codec_write(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)336 snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
337 unsigned int verb, unsigned int parm)
338 {
339 return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm);
340 }
341
342 #define snd_hda_param_read(codec, nid, param) \
343 snd_hdac_read_parm(&(codec)->core, nid, param)
344 #define snd_hda_get_sub_nodes(codec, nid, start_nid) \
345 snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid)
346 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
347 hda_nid_t *conn_list, int max_conns);
348 static inline int
snd_hda_get_num_conns(struct hda_codec * codec,hda_nid_t nid)349 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
350 {
351 return snd_hda_get_connections(codec, nid, NULL, 0);
352 }
353
354 #define snd_hda_get_raw_connections(codec, nid, list, max_conns) \
355 snd_hdac_get_connections(&(codec)->core, nid, list, max_conns)
356 #define snd_hda_get_num_raw_conns(codec, nid) \
357 snd_hdac_get_connections(&(codec)->core, nid, NULL, 0)
358
359 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
360 const hda_nid_t **listp);
361 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
362 const hda_nid_t *list);
363 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
364 hda_nid_t nid, int recursive);
365 unsigned int snd_hda_get_num_devices(struct hda_codec *codec, hda_nid_t nid);
366 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
367 u8 *dev_list, int max_devices);
368 int snd_hda_get_dev_select(struct hda_codec *codec, hda_nid_t nid);
369 int snd_hda_set_dev_select(struct hda_codec *codec, hda_nid_t nid, int dev_id);
370
371 struct hda_verb {
372 hda_nid_t nid;
373 u32 verb;
374 u32 param;
375 };
376
377 void snd_hda_sequence_write(struct hda_codec *codec,
378 const struct hda_verb *seq);
379
380 /* cached write */
381 static inline int
snd_hda_codec_write_cache(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)382 snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
383 int flags, unsigned int verb, unsigned int parm)
384 {
385 return snd_hdac_regmap_write(&codec->core, nid, verb, parm);
386 }
387
388 /* the struct for codec->pin_configs */
389 struct hda_pincfg {
390 hda_nid_t nid;
391 unsigned char ctrl; /* original pin control value */
392 unsigned char target; /* target pin control value */
393 unsigned int cfg; /* default configuration */
394 };
395
396 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
397 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
398 unsigned int cfg);
399 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
400 hda_nid_t nid, unsigned int cfg); /* for hwdep */
401 void snd_hda_shutup_pins(struct hda_codec *codec);
402
403 /* SPDIF controls */
404 struct hda_spdif_out {
405 hda_nid_t nid; /* Converter nid values relate to */
406 unsigned int status; /* IEC958 status bits */
407 unsigned short ctls; /* SPDIF control bits */
408 };
409 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
410 hda_nid_t nid);
411 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
412 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
413
414 /*
415 * Mixer
416 */
417 int snd_hda_codec_build_controls(struct hda_codec *codec);
418
419 /*
420 * PCM
421 */
422 int snd_hda_codec_parse_pcms(struct hda_codec *codec);
423 int snd_hda_codec_build_pcms(struct hda_codec *codec);
424
425 __printf(2, 3)
426 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
427 const char *fmt, ...);
428
429 void snd_hda_codec_cleanup_for_unbind(struct hda_codec *codec);
430
snd_hda_codec_pcm_get(struct hda_pcm * pcm)431 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
432 {
433 refcount_inc(&pcm->codec->pcm_ref);
434 }
435 void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
436
437 int snd_hda_codec_prepare(struct hda_codec *codec,
438 struct hda_pcm_stream *hinfo,
439 unsigned int stream,
440 unsigned int format,
441 struct snd_pcm_substream *substream);
442 void snd_hda_codec_cleanup(struct hda_codec *codec,
443 struct hda_pcm_stream *hinfo,
444 struct snd_pcm_substream *substream);
445
446 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
447 u32 stream_tag,
448 int channel_id, int format);
449 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
450 int do_now);
451 #define snd_hda_codec_cleanup_stream(codec, nid) \
452 __snd_hda_codec_cleanup_stream(codec, nid, 0)
453
454 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, bpsp) \
455 snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, bpsp)
456 #define snd_hda_is_supported_format(codec, nid, fmt) \
457 snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
458
459 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
460
461 int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec,
462 struct hda_pcm *cpcm);
463
464 /*
465 * Misc
466 */
467 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
468 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
469 unsigned int power_state);
470
471 int snd_hda_lock_devices(struct hda_bus *bus);
472 void snd_hda_unlock_devices(struct hda_bus *bus);
473 void snd_hda_bus_reset(struct hda_bus *bus);
474 void snd_hda_bus_reset_codecs(struct hda_bus *bus);
475
476 int snd_hda_codec_set_name(struct hda_codec *codec, const char *name);
477
478 /*
479 * power management
480 */
481 extern const struct dev_pm_ops hda_codec_driver_pm;
482
483 static inline
hda_call_check_power_status(struct hda_codec * codec,hda_nid_t nid)484 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
485 {
486 #ifdef CONFIG_PM
487 if (codec->patch_ops.check_power_status)
488 return codec->patch_ops.check_power_status(codec, nid);
489 #endif
490 return 0;
491 }
492
493 /*
494 * power saving
495 */
496 #define snd_hda_power_up(codec) snd_hdac_power_up(&(codec)->core)
497 #define snd_hda_power_up_pm(codec) snd_hdac_power_up_pm(&(codec)->core)
498 #define snd_hda_power_down(codec) snd_hdac_power_down(&(codec)->core)
499 #define snd_hda_power_down_pm(codec) snd_hdac_power_down_pm(&(codec)->core)
500 #ifdef CONFIG_PM
501 void snd_hda_codec_set_power_save(struct hda_codec *codec, int delay);
502 void snd_hda_set_power_save(struct hda_bus *bus, int delay);
503 void snd_hda_update_power_acct(struct hda_codec *codec);
504 #else
snd_hda_codec_set_power_save(struct hda_codec * codec,int delay)505 static inline void snd_hda_codec_set_power_save(struct hda_codec *codec, int delay) {}
snd_hda_set_power_save(struct hda_bus * bus,int delay)506 static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {}
507 #endif
508
hda_codec_need_resume(struct hda_codec * codec)509 static inline bool hda_codec_need_resume(struct hda_codec *codec)
510 {
511 return !codec->relaxed_resume && codec->jacktbl.used;
512 }
513
514 #ifdef CONFIG_SND_HDA_PATCH_LOADER
515 /*
516 * patch firmware
517 */
518 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
519 #endif
520
521 #ifdef CONFIG_SND_HDA_DSP_LOADER
522 int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
523 unsigned int size,
524 struct snd_dma_buffer *bufp);
525 void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start);
526 void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
527 struct snd_dma_buffer *dmab);
528 #else
529 static inline int
snd_hda_codec_load_dsp_prepare(struct hda_codec * codec,unsigned int format,unsigned int size,struct snd_dma_buffer * bufp)530 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
531 unsigned int size,
532 struct snd_dma_buffer *bufp)
533 {
534 return -ENOSYS;
535 }
536 static inline void
snd_hda_codec_load_dsp_trigger(struct hda_codec * codec,bool start)537 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
538 static inline void
snd_hda_codec_load_dsp_cleanup(struct hda_codec * codec,struct snd_dma_buffer * dmab)539 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
540 struct snd_dma_buffer *dmab) {}
541 #endif
542
543 #endif /* __SOUND_HDA_CODEC_H */
544