2 * Universal Interface for Intel High Definition Audio Codec
4 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; either version 2 of the License, or (at your option)
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along with
17 * this program; if not, write to the Free Software Foundation, Inc., 59
18 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #ifndef __SOUND_HDA_CODEC_H
22 #define __SOUND_HDA_CODEC_H
24 #include <sound/info.h>
25 #include <sound/control.h>
26 #include <sound/pcm.h>
27 #include <sound/hwdep.h>
28 #include <sound/hda_verbs.h>
36 unsigned int elem_size;
37 unsigned int alloc_align;
41 void *snd_array_new(struct snd_array *array);
42 void snd_array_free(struct snd_array *array);
43 static inline void snd_array_init(struct snd_array *array, unsigned int size,
46 array->elem_size = size;
47 array->alloc_align = align;
50 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
52 return array->list + idx * array->elem_size;
55 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
57 return (unsigned long)(ptr - array->list) / array->elem_size;
68 struct hda_pcm_stream;
69 struct hda_bus_unsolicited;
72 typedef u16 hda_nid_t;
76 /* send a single command */
77 int (*command)(struct hda_bus *bus, unsigned int cmd);
78 /* get a response from the last command */
79 unsigned int (*get_response)(struct hda_bus *bus, unsigned int addr);
80 /* free the private data */
81 void (*private_free)(struct hda_bus *);
82 /* attach a PCM stream */
83 int (*attach_pcm)(struct hda_bus *bus, struct hda_codec *codec,
85 /* reset bus for retry verb */
86 void (*bus_reset)(struct hda_bus *bus);
88 /* notify power-up/down from codec to controller */
89 void (*pm_notify)(struct hda_bus *bus, bool power_up);
91 #ifdef CONFIG_SND_HDA_DSP_LOADER
92 /* prepare DSP transfer */
93 int (*load_dsp_prepare)(struct hda_bus *bus, unsigned int format,
94 unsigned int byte_size,
95 struct snd_dma_buffer *bufp);
96 /* start/stop DSP transfer */
97 void (*load_dsp_trigger)(struct hda_bus *bus, bool start);
98 /* clean up DSP transfer */
99 void (*load_dsp_cleanup)(struct hda_bus *bus,
100 struct snd_dma_buffer *dmab);
104 /* template to pass to the bus constructor */
105 struct hda_bus_template {
108 const char *modelname;
110 struct hda_bus_ops ops;
116 * each controller needs to creata a hda_bus to assign the accessor.
117 * A hda_bus contains several codecs in the list codec_list.
120 struct snd_card *card;
122 /* copied from template */
125 const char *modelname;
127 struct hda_bus_ops ops;
129 /* codec linked list */
130 struct list_head codec_list;
131 unsigned int num_codecs;
132 /* link caddr -> codec */
133 struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
135 struct mutex cmd_mutex;
136 struct mutex prepare_mutex;
138 /* unsolicited event queue */
139 struct hda_bus_unsolicited *unsol;
141 struct workqueue_struct *workq; /* common workqueue for codecs */
144 DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
147 unsigned int needs_damn_long_delay :1;
148 unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
149 unsigned int sync_write:1; /* sync after verb write */
150 /* status for codec/controller */
151 unsigned int shutdown :1; /* being unloaded */
152 unsigned int rirb_error:1; /* error in codec communication */
153 unsigned int response_reset:1; /* controller was reset */
154 unsigned int in_reset:1; /* during reset operation */
155 unsigned int power_keep_link_on:1; /* don't power off HDA link */
156 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
158 int primary_dig_out_type; /* primary digital out PCM type */
164 * Known codecs have the patch to build and set up the controls/PCMs
165 * better than the generic parser.
167 struct hda_codec_preset {
171 unsigned int subs_mask;
175 int (*patch)(struct hda_codec *codec);
178 struct hda_codec_preset_list {
179 const struct hda_codec_preset *preset;
180 struct module *owner;
181 struct list_head list;
185 int snd_hda_add_codec_preset(struct hda_codec_preset_list *preset);
186 int snd_hda_delete_codec_preset(struct hda_codec_preset_list *preset);
188 /* ops set by the preset patch */
189 struct hda_codec_ops {
190 int (*build_controls)(struct hda_codec *codec);
191 int (*build_pcms)(struct hda_codec *codec);
192 int (*init)(struct hda_codec *codec);
193 void (*free)(struct hda_codec *codec);
194 void (*unsol_event)(struct hda_codec *codec, unsigned int res);
195 void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
196 unsigned int power_state);
198 int (*suspend)(struct hda_codec *codec);
199 int (*resume)(struct hda_codec *codec);
200 int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
202 void (*reboot_notify)(struct hda_codec *codec);
205 /* record for amp information cache */
206 struct hda_cache_head {
207 u32 key:31; /* hash key */
209 u16 val; /* assigned value */
213 struct hda_amp_info {
214 struct hda_cache_head head;
215 u32 amp_caps; /* amp capabilities */
216 u16 vol[2]; /* current volume & mute */
219 struct hda_cache_rec {
220 u16 hash[64]; /* hash table for index */
221 struct snd_array buf; /* record entries */
226 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
227 struct snd_pcm_substream *substream);
228 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
229 struct snd_pcm_substream *substream);
230 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
231 unsigned int stream_tag, unsigned int format,
232 struct snd_pcm_substream *substream);
233 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
234 struct snd_pcm_substream *substream);
235 unsigned int (*get_delay)(struct hda_pcm_stream *info,
236 struct hda_codec *codec,
237 struct snd_pcm_substream *substream);
240 /* PCM information for each substream */
241 struct hda_pcm_stream {
242 unsigned int substreams; /* number of substreams, 0 = not exist*/
243 unsigned int channels_min; /* min. number of channels */
244 unsigned int channels_max; /* max. number of channels */
245 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
246 u32 rates; /* supported rates */
247 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
248 unsigned int maxbps; /* supported max. bit per sample */
249 const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
250 struct hda_pcm_ops ops;
262 /* for PCM creation */
265 struct hda_pcm_stream stream[2];
266 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */
267 int device; /* device number to assign */
268 struct snd_pcm *pcm; /* assigned PCM instance */
269 bool own_chmap; /* codec driver provides own channel maps */
272 /* codec information */
275 unsigned int addr; /* codec addr*/
276 struct list_head list; /* list point */
278 hda_nid_t afg; /* AFG node id */
279 hda_nid_t mfg; /* MFG node id */
290 /* detected preset */
291 const struct hda_codec_preset *preset;
292 struct module *owner;
293 int (*parser)(struct hda_codec *codec);
294 const char *vendor_name; /* codec vendor name */
295 const char *chip_name; /* codec chip name */
296 const char *modelname; /* model name for preset */
299 struct hda_codec_ops patch_ops;
301 /* PCM to create, set by patch_ops.build_pcms callback */
302 unsigned int num_pcms;
303 struct hda_pcm *pcm_info;
305 /* codec specific info */
309 struct hda_beep *beep;
310 unsigned int beep_mode;
312 /* widget capabilities cache */
313 unsigned int num_nodes;
317 struct snd_array mixers; /* list of assigned mixer elements */
318 struct snd_array nids; /* list of mapped mixer elements */
320 struct hda_cache_rec amp_cache; /* cache for amp access */
321 struct hda_cache_rec cmd_cache; /* cache for other commands */
323 struct list_head conn_list; /* linked-list of connection-list */
325 struct mutex spdif_mutex;
326 struct mutex control_mutex;
327 struct mutex hash_mutex;
328 struct snd_array spdif_out;
329 unsigned int spdif_in_enable; /* SPDIF input enable? */
330 const hda_nid_t *slave_dig_outs; /* optional digital out slave widgets */
331 struct snd_array init_pins; /* initial (BIOS) pin configurations */
332 struct snd_array driver_pins; /* pin configs set by codec parser */
333 struct snd_array cvt_setups; /* audio convert setups */
335 #ifdef CONFIG_SND_HDA_HWDEP
336 struct mutex user_mutex;
337 struct snd_hwdep *hwdep; /* assigned hwdep device */
338 struct snd_array init_verbs; /* additional init verbs */
339 struct snd_array hints; /* additional hints */
340 struct snd_array user_pins; /* default pin configs to override */
344 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
346 * (e.g. Realtek codecs)
348 unsigned int pin_amp_workaround:1; /* pin out-amp takes index
349 * (e.g. Conexant codecs)
351 unsigned int single_adc_amp:1; /* adc in-amp takes no index
352 * (e.g. CX20549 codec)
354 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
355 unsigned int pins_shutup:1; /* pins are shut up */
356 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
357 unsigned int no_jack_detect:1; /* Machine has no jack-detection */
358 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
359 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
360 unsigned int pcm_format_first:1; /* PCM format must be set first */
361 unsigned int epss:1; /* supporting EPSS? */
362 unsigned int cached_write:1; /* write only to caches */
363 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */
365 unsigned int power_on :1; /* current (global) power-state */
366 unsigned int d3_stop_clk:1; /* support D3 operation without BCLK */
367 unsigned int pm_up_notified:1; /* PM notified to controller */
368 unsigned int in_pm:1; /* suspend/resume being performed */
369 int power_transition; /* power-state in transition */
370 int power_count; /* current (global) power refcount */
371 struct delayed_work power_work; /* delayed task for powerdown */
372 unsigned long power_on_acct;
373 unsigned long power_off_acct;
374 unsigned long power_jiffies;
375 spinlock_t power_lock;
378 /* filter the requested power state per nid */
379 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
380 unsigned int power_state);
382 /* codec-specific additional proc output */
383 void (*proc_widget_hook)(struct snd_info_buffer *buffer,
384 struct hda_codec *codec, hda_nid_t nid);
387 struct snd_array jacktbl;
388 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
389 struct delayed_work jackpoll_work;
391 #ifdef CONFIG_SND_HDA_INPUT_JACK
393 struct snd_array jacks;
396 int depop_delay; /* depop delay in ms, -1 for default delay time */
400 const struct hda_fixup *fixup_list;
401 const char *fixup_name;
403 /* additional init verbs */
404 struct snd_array verbs;
409 HDA_INPUT, HDA_OUTPUT
412 /* snd_hda_codec_read/write optional flags */
413 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
418 int snd_hda_bus_new(struct snd_card *card, const struct hda_bus_template *temp,
419 struct hda_bus **busp);
420 int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
421 struct hda_codec **codecp);
422 int snd_hda_codec_configure(struct hda_codec *codec);
423 int snd_hda_codec_update_widgets(struct hda_codec *codec);
426 * low level functions
428 unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
430 unsigned int verb, unsigned int parm);
431 int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
432 unsigned int verb, unsigned int parm);
433 #define snd_hda_param_read(codec, nid, param) \
434 snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
435 int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
436 hda_nid_t *start_id);
437 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
438 hda_nid_t *conn_list, int max_conns);
440 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
442 return snd_hda_get_connections(codec, nid, NULL, 0);
444 int snd_hda_get_num_raw_conns(struct hda_codec *codec, hda_nid_t nid);
445 int snd_hda_get_raw_connections(struct hda_codec *codec, hda_nid_t nid,
446 hda_nid_t *conn_list, int max_conns);
447 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
448 const hda_nid_t **listp);
449 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
450 const hda_nid_t *list);
451 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
452 hda_nid_t nid, int recursive);
453 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
454 u8 *dev_list, int max_devices);
455 int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
456 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
464 void snd_hda_sequence_write(struct hda_codec *codec,
465 const struct hda_verb *seq);
467 /* unsolicited event */
468 int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
471 int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
472 int flags, unsigned int verb, unsigned int parm);
473 void snd_hda_sequence_write_cache(struct hda_codec *codec,
474 const struct hda_verb *seq);
475 int snd_hda_codec_update_cache(struct hda_codec *codec, hda_nid_t nid,
476 int flags, unsigned int verb, unsigned int parm);
477 void snd_hda_codec_resume_cache(struct hda_codec *codec);
478 /* both for cmd & amp caches */
479 void snd_hda_codec_flush_cache(struct hda_codec *codec);
481 /* the struct for codec->pin_configs */
484 unsigned char ctrl; /* original pin control value */
485 unsigned char target; /* target pin control value */
486 unsigned int cfg; /* default configuration */
489 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
490 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
492 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
493 hda_nid_t nid, unsigned int cfg); /* for hwdep */
494 void snd_hda_shutup_pins(struct hda_codec *codec);
497 struct hda_spdif_out {
498 hda_nid_t nid; /* Converter nid values relate to */
499 unsigned int status; /* IEC958 status bits */
500 unsigned short ctls; /* SPDIF control bits */
502 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
504 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
505 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
510 int snd_hda_build_controls(struct hda_bus *bus);
511 int snd_hda_codec_build_controls(struct hda_codec *codec);
516 int snd_hda_build_pcms(struct hda_bus *bus);
517 int snd_hda_codec_build_pcms(struct hda_codec *codec);
519 int snd_hda_codec_prepare(struct hda_codec *codec,
520 struct hda_pcm_stream *hinfo,
523 struct snd_pcm_substream *substream);
524 void snd_hda_codec_cleanup(struct hda_codec *codec,
525 struct hda_pcm_stream *hinfo,
526 struct snd_pcm_substream *substream);
528 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
530 int channel_id, int format);
531 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
533 #define snd_hda_codec_cleanup_stream(codec, nid) \
534 __snd_hda_codec_cleanup_stream(codec, nid, 0)
535 unsigned int snd_hda_calc_stream_format(unsigned int rate,
536 unsigned int channels,
539 unsigned short spdif_ctls);
540 int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
541 unsigned int format);
543 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
548 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
549 void snd_hda_bus_reboot_notify(struct hda_bus *bus);
550 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
551 unsigned int power_state);
553 int snd_hda_lock_devices(struct hda_bus *bus);
554 void snd_hda_unlock_devices(struct hda_bus *bus);
560 int snd_hda_suspend(struct hda_bus *bus);
561 int snd_hda_resume(struct hda_bus *bus);
565 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
568 if (codec->patch_ops.check_power_status)
569 return codec->patch_ops.check_power_status(codec, nid);
575 * get widget information
577 const char *snd_hda_get_jack_connectivity(u32 cfg);
578 const char *snd_hda_get_jack_type(u32 cfg);
579 const char *snd_hda_get_jack_location(u32 cfg);
585 void snd_hda_power_save(struct hda_codec *codec, int delta, bool d3wait);
586 void snd_hda_update_power_acct(struct hda_codec *codec);
588 static inline void snd_hda_power_save(struct hda_codec *codec, int delta,
593 * snd_hda_power_up - Power-up the codec
594 * @codec: HD-audio codec
596 * Increment the power-up counter and power up the hardware really when
599 static inline void snd_hda_power_up(struct hda_codec *codec)
601 snd_hda_power_save(codec, 1, false);
605 * snd_hda_power_up_d3wait - Power-up the codec after waiting for any pending
606 * D3 transition to complete. This differs from snd_hda_power_up() when
607 * power_transition == -1. snd_hda_power_up sees this case as a nop,
608 * snd_hda_power_up_d3wait waits for the D3 transition to complete then powers
610 * @codec: HD-audio codec
612 * Cancel any power down operation hapenning on the work queue, then power up.
614 static inline void snd_hda_power_up_d3wait(struct hda_codec *codec)
616 snd_hda_power_save(codec, 1, true);
620 * snd_hda_power_down - Power-down the codec
621 * @codec: HD-audio codec
623 * Decrement the power-up counter and schedules the power-off work if
624 * the counter rearches to zero.
626 static inline void snd_hda_power_down(struct hda_codec *codec)
628 snd_hda_power_save(codec, -1, false);
632 * snd_hda_power_sync - Synchronize the power-save status
633 * @codec: HD-audio codec
635 * Synchronize the actual power state with the power account;
636 * called when power_save parameter is changed
638 static inline void snd_hda_power_sync(struct hda_codec *codec)
640 snd_hda_power_save(codec, 0, false);
643 #ifdef CONFIG_SND_HDA_PATCH_LOADER
647 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
650 #ifdef CONFIG_SND_HDA_DSP_LOADER
652 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
654 struct snd_dma_buffer *bufp)
656 return codec->bus->ops.load_dsp_prepare(codec->bus, format, size, bufp);
659 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start)
661 return codec->bus->ops.load_dsp_trigger(codec->bus, start);
664 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
665 struct snd_dma_buffer *dmab)
667 return codec->bus->ops.load_dsp_cleanup(codec->bus, dmab);
671 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
673 struct snd_dma_buffer *bufp)
678 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
680 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
681 struct snd_dma_buffer *dmab) {}
685 * Codec modularization
688 /* Export symbols only for communication with codec drivers;
689 * When built in kernel, all HD-audio drivers are supposed to be statically
690 * linked to the kernel. Thus, the symbols don't have to (or shouldn't) be
691 * exported unless it's built as a module.
694 #define EXPORT_SYMBOL_HDA(sym) EXPORT_SYMBOL_GPL(sym)
696 #define EXPORT_SYMBOL_HDA(sym)
699 #endif /* __SOUND_HDA_CODEC_H */