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
;
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.
41 struct snd_card
*card
;
44 const char *modelname
;
46 struct mutex prepare_mutex
;
49 DECLARE_BITMAP(pcm_dev_bits
, SNDRV_PCM_DEVICES
);
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
64 int primary_dig_out_type
; /* primary digital out PCM type */
65 unsigned int mixer_assigned
; /* codec addr for mixer name */
68 /* from hdac_bus to hda_bus */
69 #define to_hda_bus(bus) container_of(bus, struct hda_bus, core)
75 #define HDA_CODEC_ID_SKIP_PROBE 0x00000001
76 #define HDA_CODEC_ID_GENERIC_HDMI 0x00000101
77 #define HDA_CODEC_ID_GENERIC 0x00000201
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)
89 struct hda_codec_driver
{
90 struct hdac_driver core
;
91 const struct hda_device_id
*id
;
92 const struct hda_codec_ops
*ops
;
95 #define hda_codec_to_driver(codec) \
96 container_of((codec)->core.dev.driver, struct hda_codec_driver, core.driver)
98 int __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)
102 void 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)
107 /* ops for hda codec driver */
108 struct 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
);
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
);
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 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
;
162 #define SNDRV_PCM_INVALID_DEVICE (-1)
163 /* for PCM creation */
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 */
172 struct hda_codec
*codec
;
173 struct list_head list
;
174 unsigned int disconnected
:1;
177 /* codec information */
179 struct hdac_device core
;
181 struct snd_card
*card
;
182 unsigned int addr
; /* codec addr*/
183 u32 probe_id
; /* overridden id for probing */
185 /* detected preset */
186 const struct hda_device_id
*preset
;
187 const char *modelname
; /* model name for preset */
189 /* PCM to create, set by hda_codec_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
;
200 bool beep_just_power_on
;
202 /* widget capabilities cache */
205 struct snd_array mixers
; /* list of assigned mixer elements */
206 struct snd_array nids
; /* list of mapped mixer elements */
208 struct list_head conn_list
; /* linked-list of connection-list */
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 */
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 */
226 #ifdef CONFIG_SND_HDA_HWDEP
227 struct snd_hwdep
*hwdep
; /* assigned hwdep device */
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
236 * (e.g. Realtek codecs)
238 unsigned int pin_amp_workaround
:1; /* pin out-amp takes index
239 * (e.g. Conexant codecs)
241 unsigned int single_adc_amp
:1; /* adc in-amp takes no index
242 * (e.g. CX20549 codec)
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 */
263 unsigned long power_on_acct
;
264 unsigned long power_off_acct
;
265 unsigned long power_jiffies
;
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
);
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
);
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
;
280 int depop_delay
; /* depop delay in ms, -1 for default delay time */
284 const struct hda_fixup
*fixup_list
;
285 const char *fixup_name
;
287 /* additional init verbs */
288 struct snd_array verbs
;
291 #define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, core.dev)
292 #define hda_codec_dev(_dev) (&(_dev)->core.dev)
294 #define hdac_to_hda_codec(_hdac) container_of(_hdac, struct hda_codec, core)
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)
301 /* snd_hda_codec_read/write optional flags */
302 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
307 __printf(3, 4) struct hda_codec
*
308 snd_hda_codec_device_init(struct hda_bus
*bus
, unsigned int codec_addr
,
309 const char *fmt
, ...);
310 int snd_hda_codec_new(struct hda_bus
*bus
, struct snd_card
*card
,
311 unsigned int codec_addr
, struct hda_codec
**codecp
);
312 int 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
);
315 int snd_hda_codec_configure(struct hda_codec
*codec
);
316 int snd_hda_codec_update_widgets(struct hda_codec
*codec
);
317 void snd_hda_codec_register(struct hda_codec
*codec
);
318 void snd_hda_codec_unregister(struct hda_codec
*codec
);
319 void snd_hda_codec_cleanup_for_unbind(struct hda_codec
*codec
);
322 * low level functions
324 static inline unsigned int
325 snd_hda_codec_read(struct hda_codec
*codec
, hda_nid_t nid
,
327 unsigned int verb
, unsigned int parm
)
329 return snd_hdac_codec_read(&codec
->core
, nid
, flags
, verb
, parm
);
333 snd_hda_codec_write(struct hda_codec
*codec
, hda_nid_t nid
, int flags
,
334 unsigned int verb
, unsigned int parm
)
336 return snd_hdac_codec_write(&codec
->core
, nid
, flags
, verb
, parm
);
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)
343 int snd_hda_get_connections(struct hda_codec
*codec
, hda_nid_t nid
,
344 hda_nid_t
*conn_list
, int max_conns
);
346 snd_hda_get_num_conns(struct hda_codec
*codec
, hda_nid_t nid
)
348 return snd_hda_get_connections(codec
, nid
, NULL
, 0);
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)
356 int snd_hda_get_conn_list(struct hda_codec
*codec
, hda_nid_t nid
,
357 const hda_nid_t
**listp
);
358 int snd_hda_override_conn_list(struct hda_codec
*codec
, hda_nid_t nid
, int nums
,
359 const hda_nid_t
*list
);
360 int snd_hda_get_conn_index(struct hda_codec
*codec
, hda_nid_t mux
,
361 hda_nid_t nid
, int recursive
);
362 unsigned int snd_hda_get_num_devices(struct hda_codec
*codec
, hda_nid_t nid
);
363 int snd_hda_get_devices(struct hda_codec
*codec
, hda_nid_t nid
,
364 u8
*dev_list
, int max_devices
);
365 int snd_hda_get_dev_select(struct hda_codec
*codec
, hda_nid_t nid
);
366 int snd_hda_set_dev_select(struct hda_codec
*codec
, hda_nid_t nid
, int dev_id
);
374 void snd_hda_sequence_write(struct hda_codec
*codec
,
375 const struct hda_verb
*seq
);
379 snd_hda_codec_write_cache(struct hda_codec
*codec
, hda_nid_t nid
,
380 int flags
, unsigned int verb
, unsigned int parm
)
382 return snd_hdac_regmap_write(&codec
->core
, nid
, verb
, parm
);
385 /* the struct for codec->pin_configs */
388 unsigned char ctrl
; /* original pin control value */
389 unsigned char target
; /* target pin control value */
390 unsigned int cfg
; /* default configuration */
393 unsigned int snd_hda_codec_get_pincfg(struct hda_codec
*codec
, hda_nid_t nid
);
394 int snd_hda_codec_set_pincfg(struct hda_codec
*codec
, hda_nid_t nid
,
396 int snd_hda_add_pincfg(struct hda_codec
*codec
, struct snd_array
*list
,
397 hda_nid_t nid
, unsigned int cfg
); /* for hwdep */
398 void snd_hda_shutup_pins(struct hda_codec
*codec
);
401 struct 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 */
406 struct hda_spdif_out
*snd_hda_spdif_out_of_nid(struct hda_codec
*codec
,
408 void snd_hda_spdif_ctls_unassign(struct hda_codec
*codec
, int idx
);
409 void snd_hda_spdif_ctls_assign(struct hda_codec
*codec
, int idx
, hda_nid_t nid
);
414 int snd_hda_codec_build_controls(struct hda_codec
*codec
);
419 int snd_hda_codec_parse_pcms(struct hda_codec
*codec
);
420 int snd_hda_codec_build_pcms(struct hda_codec
*codec
);
423 struct hda_pcm
*snd_hda_codec_pcm_new(struct hda_codec
*codec
,
424 const char *fmt
, ...);
426 void snd_hda_codec_cleanup_for_unbind(struct hda_codec
*codec
);
428 static inline void snd_hda_codec_pcm_get(struct hda_pcm
*pcm
)
430 refcount_inc(&pcm
->codec
->pcm_ref
);
432 void snd_hda_codec_pcm_put(struct hda_pcm
*pcm
);
434 int snd_hda_codec_prepare(struct hda_codec
*codec
,
435 struct hda_pcm_stream
*hinfo
,
438 struct snd_pcm_substream
*substream
);
439 void snd_hda_codec_cleanup(struct hda_codec
*codec
,
440 struct hda_pcm_stream
*hinfo
,
441 struct snd_pcm_substream
*substream
);
443 void snd_hda_codec_setup_stream(struct hda_codec
*codec
, hda_nid_t nid
,
445 int channel_id
, int format
);
446 void __snd_hda_codec_cleanup_stream(struct hda_codec
*codec
, hda_nid_t nid
,
448 #define snd_hda_codec_cleanup_stream(codec, nid) \
449 __snd_hda_codec_cleanup_stream(codec, nid, 0)
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)
456 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps
[];
458 int snd_hda_attach_pcm_stream(struct hda_bus
*_bus
, struct hda_codec
*codec
,
459 struct hda_pcm
*cpcm
);
464 void snd_hda_get_codec_name(struct hda_codec
*codec
, char *name
, int namelen
);
465 void snd_hda_codec_set_power_to_all(struct hda_codec
*codec
, hda_nid_t fg
,
466 unsigned int power_state
);
468 int snd_hda_lock_devices(struct hda_bus
*bus
);
469 void snd_hda_unlock_devices(struct hda_bus
*bus
);
470 void snd_hda_bus_reset(struct hda_bus
*bus
);
471 void snd_hda_bus_reset_codecs(struct hda_bus
*bus
);
473 int snd_hda_codec_set_name(struct hda_codec
*codec
, const char *name
);
478 extern const struct dev_pm_ops hda_codec_driver_pm
;
481 int hda_call_check_power_status(struct hda_codec
*codec
, hda_nid_t nid
)
483 struct hda_codec_driver
*driver
= hda_codec_to_driver(codec
);
485 if (driver
->ops
&& driver
->ops
->check_power_status
)
486 return driver
->ops
->check_power_status(codec
, nid
);
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)
497 void snd_hda_codec_set_power_save(struct hda_codec
*codec
, int delay
);
498 void snd_hda_set_power_save(struct hda_bus
*bus
, int delay
);
499 void snd_hda_update_power_acct(struct hda_codec
*codec
);
501 static inline bool hda_codec_need_resume(struct hda_codec
*codec
)
503 return !codec
->relaxed_resume
&& codec
->jacktbl
.used
;
506 #ifdef CONFIG_SND_HDA_PATCH_LOADER
510 int snd_hda_load_patch(struct hda_bus
*bus
, size_t size
, const void *buf
);
513 #ifdef CONFIG_SND_HDA_DSP_LOADER
514 int snd_hda_codec_load_dsp_prepare(struct hda_codec
*codec
, unsigned int format
,
516 struct snd_dma_buffer
*bufp
);
517 void snd_hda_codec_load_dsp_trigger(struct hda_codec
*codec
, bool start
);
518 void snd_hda_codec_load_dsp_cleanup(struct hda_codec
*codec
,
519 struct snd_dma_buffer
*dmab
);
522 snd_hda_codec_load_dsp_prepare(struct hda_codec
*codec
, unsigned int format
,
524 struct snd_dma_buffer
*bufp
)
529 snd_hda_codec_load_dsp_trigger(struct hda_codec
*codec
, bool start
) {}
531 snd_hda_codec_load_dsp_cleanup(struct hda_codec
*codec
,
532 struct snd_dma_buffer
*dmab
) {}
535 #endif /* __SOUND_HDA_CODEC_H */