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/kref.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>
21 #define IS_BXT(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0x5a98)
22 #define IS_CFL(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0xa348)
32 struct hda_pcm_stream
;
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.
43 struct snd_card
*card
;
46 const char *modelname
;
48 struct mutex prepare_mutex
;
51 DECLARE_BITMAP(pcm_dev_bits
, SNDRV_PCM_DEVICES
);
54 unsigned int needs_damn_long_delay
:1;
55 unsigned int allow_bus_reset
:1; /* allow bus reset at fatal error */
56 /* status for codec/controller */
57 unsigned int shutdown
:1; /* being unloaded */
58 unsigned int response_reset
:1; /* controller was reset */
59 unsigned int in_reset
:1; /* during reset operation */
60 unsigned int no_response_fallback
:1; /* don't fallback at RIRB error */
61 unsigned int bus_probing
:1; /* during probing process */
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 (*reboot_notify
)(struct hda_codec
*codec
);
118 void (*stream_pm
)(struct hda_codec
*codec
, hda_nid_t nid
, bool on
);
123 int (*open
)(struct hda_pcm_stream
*info
, struct hda_codec
*codec
,
124 struct snd_pcm_substream
*substream
);
125 int (*close
)(struct hda_pcm_stream
*info
, struct hda_codec
*codec
,
126 struct snd_pcm_substream
*substream
);
127 int (*prepare
)(struct hda_pcm_stream
*info
, struct hda_codec
*codec
,
128 unsigned int stream_tag
, unsigned int format
,
129 struct snd_pcm_substream
*substream
);
130 int (*cleanup
)(struct hda_pcm_stream
*info
, struct hda_codec
*codec
,
131 struct snd_pcm_substream
*substream
);
132 unsigned int (*get_delay
)(struct hda_pcm_stream
*info
,
133 struct hda_codec
*codec
,
134 struct snd_pcm_substream
*substream
);
137 /* PCM information for each substream */
138 struct hda_pcm_stream
{
139 unsigned int substreams
; /* number of substreams, 0 = not exist*/
140 unsigned int channels_min
; /* min. number of channels */
141 unsigned int channels_max
; /* max. number of channels */
142 hda_nid_t nid
; /* default NID to query rates/formats/bps, or set up */
143 u32 rates
; /* supported rates */
144 u64 formats
; /* supported formats (SNDRV_PCM_FMTBIT_) */
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
;
171 struct list_head list
;
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 /* codec specific info */
196 struct hda_beep
*beep
;
197 unsigned int beep_mode
;
199 /* widget capabilities cache */
202 struct snd_array mixers
; /* list of assigned mixer elements */
203 struct snd_array nids
; /* list of mapped mixer elements */
205 struct list_head conn_list
; /* linked-list of connection-list */
207 struct mutex spdif_mutex
;
208 struct mutex control_mutex
;
209 struct snd_array spdif_out
;
210 unsigned int spdif_in_enable
; /* SPDIF input enable? */
211 const hda_nid_t
*slave_dig_outs
; /* optional digital out slave widgets */
212 struct snd_array init_pins
; /* initial (BIOS) pin configurations */
213 struct snd_array driver_pins
; /* pin configs set by codec parser */
214 struct snd_array cvt_setups
; /* audio convert setups */
216 struct mutex user_mutex
;
217 #ifdef CONFIG_SND_HDA_RECONFIG
218 struct snd_array init_verbs
; /* additional init verbs */
219 struct snd_array hints
; /* additional hints */
220 struct snd_array user_pins
; /* default pin configs to override */
223 #ifdef CONFIG_SND_HDA_HWDEP
224 struct snd_hwdep
*hwdep
; /* assigned hwdep device */
228 unsigned int in_freeing
:1; /* being released */
229 unsigned int registered
:1; /* codec was registered */
230 unsigned int display_power_control
:1; /* needs display power */
231 unsigned int spdif_status_reset
:1; /* needs to toggle SPDIF for each
233 * (e.g. Realtek codecs)
235 unsigned int pin_amp_workaround
:1; /* pin out-amp takes index
236 * (e.g. Conexant codecs)
238 unsigned int single_adc_amp
:1; /* adc in-amp takes no index
239 * (e.g. CX20549 codec)
241 unsigned int no_sticky_stream
:1; /* no sticky-PCM stream assignment */
242 unsigned int pins_shutup
:1; /* pins are shut up */
243 unsigned int no_trigger_sense
:1; /* don't trigger at pin-sensing */
244 unsigned int no_jack_detect
:1; /* Machine has no jack-detection */
245 unsigned int inv_eapd
:1; /* broken h/w: inverted EAPD control */
246 unsigned int inv_jack_detect
:1; /* broken h/w: inverted detection bit */
247 unsigned int pcm_format_first
:1; /* PCM format must be set first */
248 unsigned int cached_write
:1; /* write only to caches */
249 unsigned int dp_mst
:1; /* support DP1.2 Multi-stream transport */
250 unsigned int dump_coef
:1; /* dump processing coefs in codec proc file */
251 unsigned int power_save_node
:1; /* advanced PM for each widget */
252 unsigned int auto_runtime_pm
:1; /* enable automatic codec runtime pm */
253 unsigned int force_pin_prefix
:1; /* Add location prefix */
254 unsigned int link_down_at_suspend
:1; /* link down at runtime suspend */
256 unsigned long power_on_acct
;
257 unsigned long power_off_acct
;
258 unsigned long power_jiffies
;
261 /* filter the requested power state per nid */
262 unsigned int (*power_filter
)(struct hda_codec
*codec
, hda_nid_t nid
,
263 unsigned int power_state
);
265 /* codec-specific additional proc output */
266 void (*proc_widget_hook
)(struct snd_info_buffer
*buffer
,
267 struct hda_codec
*codec
, hda_nid_t nid
);
270 struct snd_array jacktbl
;
271 unsigned long jackpoll_interval
; /* In jiffies. Zero means no poll, rely on unsol events */
272 struct delayed_work jackpoll_work
;
274 int depop_delay
; /* depop delay in ms, -1 for default delay time */
278 const struct hda_fixup
*fixup_list
;
279 const char *fixup_name
;
281 /* additional init verbs */
282 struct snd_array verbs
;
285 #define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, core.dev)
286 #define hda_codec_dev(_dev) (&(_dev)->core.dev)
288 #define list_for_each_codec(c, bus) \
289 list_for_each_entry(c, &(bus)->core.codec_list, core.list)
290 #define list_for_each_codec_safe(c, n, bus) \
291 list_for_each_entry_safe(c, n, &(bus)->core.codec_list, core.list)
293 /* snd_hda_codec_read/write optional flags */
294 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
299 int snd_hda_codec_new(struct hda_bus
*bus
, struct snd_card
*card
,
300 unsigned int codec_addr
, struct hda_codec
**codecp
);
301 int snd_hda_codec_device_new(struct hda_bus
*bus
, struct snd_card
*card
,
302 unsigned int codec_addr
, struct hda_codec
*codec
);
303 int snd_hda_codec_configure(struct hda_codec
*codec
);
304 int snd_hda_codec_update_widgets(struct hda_codec
*codec
);
307 * low level functions
309 static inline unsigned int
310 snd_hda_codec_read(struct hda_codec
*codec
, hda_nid_t nid
,
312 unsigned int verb
, unsigned int parm
)
314 return snd_hdac_codec_read(&codec
->core
, nid
, flags
, verb
, parm
);
318 snd_hda_codec_write(struct hda_codec
*codec
, hda_nid_t nid
, int flags
,
319 unsigned int verb
, unsigned int parm
)
321 return snd_hdac_codec_write(&codec
->core
, nid
, flags
, verb
, parm
);
324 #define snd_hda_param_read(codec, nid, param) \
325 snd_hdac_read_parm(&(codec)->core, nid, param)
326 #define snd_hda_get_sub_nodes(codec, nid, start_nid) \
327 snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid)
328 int snd_hda_get_connections(struct hda_codec
*codec
, hda_nid_t nid
,
329 hda_nid_t
*conn_list
, int max_conns
);
331 snd_hda_get_num_conns(struct hda_codec
*codec
, hda_nid_t nid
)
333 return snd_hda_get_connections(codec
, nid
, NULL
, 0);
336 #define snd_hda_get_raw_connections(codec, nid, list, max_conns) \
337 snd_hdac_get_connections(&(codec)->core, nid, list, max_conns)
338 #define snd_hda_get_num_raw_conns(codec, nid) \
339 snd_hdac_get_connections(&(codec)->core, nid, NULL, 0);
341 int snd_hda_get_conn_list(struct hda_codec
*codec
, hda_nid_t nid
,
342 const hda_nid_t
**listp
);
343 int snd_hda_override_conn_list(struct hda_codec
*codec
, hda_nid_t nid
, int nums
,
344 const hda_nid_t
*list
);
345 int snd_hda_get_conn_index(struct hda_codec
*codec
, hda_nid_t mux
,
346 hda_nid_t nid
, int recursive
);
347 unsigned int snd_hda_get_num_devices(struct hda_codec
*codec
, hda_nid_t nid
);
348 int snd_hda_get_devices(struct hda_codec
*codec
, hda_nid_t nid
,
349 u8
*dev_list
, int max_devices
);
350 int snd_hda_get_dev_select(struct hda_codec
*codec
, hda_nid_t nid
);
351 int snd_hda_set_dev_select(struct hda_codec
*codec
, hda_nid_t nid
, int dev_id
);
359 void snd_hda_sequence_write(struct hda_codec
*codec
,
360 const struct hda_verb
*seq
);
362 /* unsolicited event */
364 snd_hda_queue_unsol_event(struct hda_bus
*bus
, u32 res
, u32 res_ex
)
366 snd_hdac_bus_queue_event(&bus
->core
, res
, res_ex
);
371 snd_hda_codec_write_cache(struct hda_codec
*codec
, hda_nid_t nid
,
372 int flags
, unsigned int verb
, unsigned int parm
)
374 return snd_hdac_regmap_write(&codec
->core
, nid
, verb
, parm
);
377 /* the struct for codec->pin_configs */
380 unsigned char ctrl
; /* original pin control value */
381 unsigned char target
; /* target pin control value */
382 unsigned int cfg
; /* default configuration */
385 unsigned int snd_hda_codec_get_pincfg(struct hda_codec
*codec
, hda_nid_t nid
);
386 int snd_hda_codec_set_pincfg(struct hda_codec
*codec
, hda_nid_t nid
,
388 int snd_hda_add_pincfg(struct hda_codec
*codec
, struct snd_array
*list
,
389 hda_nid_t nid
, unsigned int cfg
); /* for hwdep */
390 void snd_hda_shutup_pins(struct hda_codec
*codec
);
393 struct hda_spdif_out
{
394 hda_nid_t nid
; /* Converter nid values relate to */
395 unsigned int status
; /* IEC958 status bits */
396 unsigned short ctls
; /* SPDIF control bits */
398 struct hda_spdif_out
*snd_hda_spdif_out_of_nid(struct hda_codec
*codec
,
400 void snd_hda_spdif_ctls_unassign(struct hda_codec
*codec
, int idx
);
401 void snd_hda_spdif_ctls_assign(struct hda_codec
*codec
, int idx
, hda_nid_t nid
);
406 int snd_hda_codec_build_controls(struct hda_codec
*codec
);
411 int snd_hda_codec_parse_pcms(struct hda_codec
*codec
);
412 int snd_hda_codec_build_pcms(struct hda_codec
*codec
);
415 struct hda_pcm
*snd_hda_codec_pcm_new(struct hda_codec
*codec
,
416 const char *fmt
, ...);
418 static inline void snd_hda_codec_pcm_get(struct hda_pcm
*pcm
)
420 kref_get(&pcm
->kref
);
422 void snd_hda_codec_pcm_put(struct hda_pcm
*pcm
);
424 int snd_hda_codec_prepare(struct hda_codec
*codec
,
425 struct hda_pcm_stream
*hinfo
,
428 struct snd_pcm_substream
*substream
);
429 void snd_hda_codec_cleanup(struct hda_codec
*codec
,
430 struct hda_pcm_stream
*hinfo
,
431 struct snd_pcm_substream
*substream
);
433 void snd_hda_codec_setup_stream(struct hda_codec
*codec
, hda_nid_t nid
,
435 int channel_id
, int format
);
436 void __snd_hda_codec_cleanup_stream(struct hda_codec
*codec
, hda_nid_t nid
,
438 #define snd_hda_codec_cleanup_stream(codec, nid) \
439 __snd_hda_codec_cleanup_stream(codec, nid, 0)
441 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, bpsp) \
442 snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, bpsp)
443 #define snd_hda_is_supported_format(codec, nid, fmt) \
444 snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
446 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps
[];
448 int snd_hda_attach_pcm_stream(struct hda_bus
*_bus
, struct hda_codec
*codec
,
449 struct hda_pcm
*cpcm
);
454 void snd_hda_get_codec_name(struct hda_codec
*codec
, char *name
, int namelen
);
455 void snd_hda_codec_set_power_to_all(struct hda_codec
*codec
, hda_nid_t fg
,
456 unsigned int power_state
);
458 int snd_hda_lock_devices(struct hda_bus
*bus
);
459 void snd_hda_unlock_devices(struct hda_bus
*bus
);
460 void snd_hda_bus_reset(struct hda_bus
*bus
);
461 void snd_hda_bus_reset_codecs(struct hda_bus
*bus
);
463 int snd_hda_codec_set_name(struct hda_codec
*codec
, const char *name
);
468 extern const struct dev_pm_ops hda_codec_driver_pm
;
471 int hda_call_check_power_status(struct hda_codec
*codec
, hda_nid_t nid
)
474 if (codec
->patch_ops
.check_power_status
)
475 return codec
->patch_ops
.check_power_status(codec
, nid
);
483 #define snd_hda_power_up(codec) snd_hdac_power_up(&(codec)->core)
484 #define snd_hda_power_up_pm(codec) snd_hdac_power_up_pm(&(codec)->core)
485 #define snd_hda_power_down(codec) snd_hdac_power_down(&(codec)->core)
486 #define snd_hda_power_down_pm(codec) snd_hdac_power_down_pm(&(codec)->core)
488 void snd_hda_set_power_save(struct hda_bus
*bus
, int delay
);
489 void snd_hda_update_power_acct(struct hda_codec
*codec
);
491 static inline void snd_hda_set_power_save(struct hda_bus
*bus
, int delay
) {}
494 #ifdef CONFIG_SND_HDA_PATCH_LOADER
498 int snd_hda_load_patch(struct hda_bus
*bus
, size_t size
, const void *buf
);
501 #ifdef CONFIG_SND_HDA_DSP_LOADER
502 int snd_hda_codec_load_dsp_prepare(struct hda_codec
*codec
, unsigned int format
,
504 struct snd_dma_buffer
*bufp
);
505 void snd_hda_codec_load_dsp_trigger(struct hda_codec
*codec
, bool start
);
506 void snd_hda_codec_load_dsp_cleanup(struct hda_codec
*codec
,
507 struct snd_dma_buffer
*dmab
);
510 snd_hda_codec_load_dsp_prepare(struct hda_codec
*codec
, unsigned int format
,
512 struct snd_dma_buffer
*bufp
)
517 snd_hda_codec_load_dsp_trigger(struct hda_codec
*codec
, bool start
) {}
519 snd_hda_codec_load_dsp_cleanup(struct hda_codec
*codec
,
520 struct snd_dma_buffer
*dmab
) {}
523 #endif /* __SOUND_HDA_CODEC_H */