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;
71 typedef u16 hda_nid_t;
75 /* send a single command */
76 int (*command)(struct hda_bus *bus, unsigned int cmd);
77 /* get a response from the last command */
78 unsigned int (*get_response)(struct hda_bus *bus, unsigned int addr);
79 /* free the private data */
80 void (*private_free)(struct hda_bus *);
81 /* attach a PCM stream */
82 int (*attach_pcm)(struct hda_bus *bus, struct hda_codec *codec,
84 /* reset bus for retry verb */
85 void (*bus_reset)(struct hda_bus *bus);
87 /* notify power-up/down from codec to controller */
88 void (*pm_notify)(struct hda_bus *bus, bool power_up);
90 #ifdef CONFIG_SND_HDA_DSP_LOADER
91 /* prepare DSP transfer */
92 int (*load_dsp_prepare)(struct hda_bus *bus, unsigned int format,
93 unsigned int byte_size,
94 struct snd_dma_buffer *bufp);
95 /* start/stop DSP transfer */
96 void (*load_dsp_trigger)(struct hda_bus *bus, bool start);
97 /* clean up DSP transfer */
98 void (*load_dsp_cleanup)(struct hda_bus *bus,
99 struct snd_dma_buffer *dmab);
103 /* unsolicited event handler */
104 #define HDA_UNSOL_QUEUE_SIZE 64
105 struct hda_bus_unsolicited {
107 u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
110 struct work_struct work;
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;
124 const char *modelname;
126 struct hda_bus_ops ops;
128 /* codec linked list */
129 struct list_head codec_list;
130 unsigned int num_codecs;
131 /* link caddr -> codec */
132 struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
134 struct mutex cmd_mutex;
135 struct mutex prepare_mutex;
137 /* unsolicited event queue */
138 struct hda_bus_unsolicited unsol;
140 struct workqueue_struct *workq; /* common workqueue for codecs */
143 DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
146 unsigned int needs_damn_long_delay :1;
147 unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
148 unsigned int sync_write:1; /* sync after verb write */
149 /* status for codec/controller */
150 unsigned int shutdown :1; /* being unloaded */
151 unsigned int rirb_error:1; /* error in codec communication */
152 unsigned int response_reset:1; /* controller was reset */
153 unsigned int in_reset:1; /* during reset operation */
154 unsigned int power_keep_link_on:1; /* don't power off HDA link */
155 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
157 int primary_dig_out_type; /* primary digital out PCM type */
163 * Known codecs have the patch to build and set up the controls/PCMs
164 * better than the generic parser.
166 struct hda_codec_preset {
170 unsigned int subs_mask;
174 int (*patch)(struct hda_codec *codec);
177 struct hda_codec_preset_list {
178 const struct hda_codec_preset *preset;
179 struct module *owner;
180 struct list_head list;
184 int snd_hda_add_codec_preset(struct hda_codec_preset_list *preset);
185 int snd_hda_delete_codec_preset(struct hda_codec_preset_list *preset);
187 /* ops set by the preset patch */
188 struct hda_codec_ops {
189 int (*build_controls)(struct hda_codec *codec);
190 int (*build_pcms)(struct hda_codec *codec);
191 int (*init)(struct hda_codec *codec);
192 void (*free)(struct hda_codec *codec);
193 void (*unsol_event)(struct hda_codec *codec, unsigned int res);
194 void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
195 unsigned int power_state);
197 int (*suspend)(struct hda_codec *codec);
198 int (*resume)(struct hda_codec *codec);
199 int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
201 void (*reboot_notify)(struct hda_codec *codec);
204 /* record for amp information cache */
205 struct hda_cache_head {
206 u32 key:31; /* hash key */
208 u16 val; /* assigned value */
212 struct hda_amp_info {
213 struct hda_cache_head head;
214 u32 amp_caps; /* amp capabilities */
215 u16 vol[2]; /* current volume & mute */
218 struct hda_cache_rec {
219 u16 hash[64]; /* hash table for index */
220 struct snd_array buf; /* record entries */
225 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
226 struct snd_pcm_substream *substream);
227 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
228 struct snd_pcm_substream *substream);
229 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
230 unsigned int stream_tag, unsigned int format,
231 struct snd_pcm_substream *substream);
232 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
233 struct snd_pcm_substream *substream);
234 unsigned int (*get_delay)(struct hda_pcm_stream *info,
235 struct hda_codec *codec,
236 struct snd_pcm_substream *substream);
239 /* PCM information for each substream */
240 struct hda_pcm_stream {
241 unsigned int substreams; /* number of substreams, 0 = not exist*/
242 unsigned int channels_min; /* min. number of channels */
243 unsigned int channels_max; /* max. number of channels */
244 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
245 u32 rates; /* supported rates */
246 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
247 unsigned int maxbps; /* supported max. bit per sample */
248 const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
249 struct hda_pcm_ops ops;
261 /* for PCM creation */
264 struct hda_pcm_stream stream[2];
265 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */
266 int device; /* device number to assign */
267 struct snd_pcm *pcm; /* assigned PCM instance */
268 bool own_chmap; /* codec driver provides own channel maps */
271 /* 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 struct mutex user_mutex;
336 #ifdef CONFIG_SND_HDA_RECONFIG
337 struct snd_array init_verbs; /* additional init verbs */
338 struct snd_array hints; /* additional hints */
339 struct snd_array user_pins; /* default pin configs to override */
342 #ifdef CONFIG_SND_HDA_HWDEP
343 struct snd_hwdep *hwdep; /* assigned hwdep device */
347 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
349 * (e.g. Realtek codecs)
351 unsigned int pin_amp_workaround:1; /* pin out-amp takes index
352 * (e.g. Conexant codecs)
354 unsigned int single_adc_amp:1; /* adc in-amp takes no index
355 * (e.g. CX20549 codec)
357 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
358 unsigned int pins_shutup:1; /* pins are shut up */
359 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
360 unsigned int no_jack_detect:1; /* Machine has no jack-detection */
361 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
362 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
363 unsigned int pcm_format_first:1; /* PCM format must be set first */
364 unsigned int epss:1; /* supporting EPSS? */
365 unsigned int cached_write:1; /* write only to caches */
366 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */
367 unsigned int dump_coef:1; /* dump processing coefs in codec proc file */
369 unsigned int power_on :1; /* current (global) power-state */
370 unsigned int d3_stop_clk:1; /* support D3 operation without BCLK */
371 unsigned int pm_up_notified:1; /* PM notified to controller */
372 unsigned int in_pm:1; /* suspend/resume being performed */
373 int power_transition; /* power-state in transition */
374 int power_count; /* current (global) power refcount */
375 struct delayed_work power_work; /* delayed task for powerdown */
376 unsigned long power_on_acct;
377 unsigned long power_off_acct;
378 unsigned long power_jiffies;
379 spinlock_t power_lock;
382 /* filter the requested power state per nid */
383 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
384 unsigned int power_state);
386 /* codec-specific additional proc output */
387 void (*proc_widget_hook)(struct snd_info_buffer *buffer,
388 struct hda_codec *codec, hda_nid_t nid);
391 struct snd_array jacktbl;
392 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
393 struct delayed_work jackpoll_work;
395 #ifdef CONFIG_SND_HDA_INPUT_JACK
397 struct snd_array jacks;
400 int depop_delay; /* depop delay in ms, -1 for default delay time */
404 const struct hda_fixup *fixup_list;
405 const char *fixup_name;
407 /* additional init verbs */
408 struct snd_array verbs;
413 HDA_INPUT, HDA_OUTPUT
416 /* snd_hda_codec_read/write optional flags */
417 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
422 int snd_hda_bus_new(struct snd_card *card, struct hda_bus **busp);
423 int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
424 struct hda_codec **codecp);
425 int snd_hda_codec_configure(struct hda_codec *codec);
426 int snd_hda_codec_update_widgets(struct hda_codec *codec);
429 * low level functions
431 unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
433 unsigned int verb, unsigned int parm);
434 int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
435 unsigned int verb, unsigned int parm);
436 #define snd_hda_param_read(codec, nid, param) \
437 snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
438 int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
439 hda_nid_t *start_id);
440 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
441 hda_nid_t *conn_list, int max_conns);
443 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
445 return snd_hda_get_connections(codec, nid, NULL, 0);
447 int snd_hda_get_num_raw_conns(struct hda_codec *codec, hda_nid_t nid);
448 int snd_hda_get_raw_connections(struct hda_codec *codec, hda_nid_t nid,
449 hda_nid_t *conn_list, int max_conns);
450 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
451 const hda_nid_t **listp);
452 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
453 const hda_nid_t *list);
454 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
455 hda_nid_t nid, int recursive);
456 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
457 u8 *dev_list, int max_devices);
458 int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
459 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
467 void snd_hda_sequence_write(struct hda_codec *codec,
468 const struct hda_verb *seq);
470 /* unsolicited event */
471 int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
474 int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
475 int flags, unsigned int verb, unsigned int parm);
476 void snd_hda_sequence_write_cache(struct hda_codec *codec,
477 const struct hda_verb *seq);
478 int snd_hda_codec_update_cache(struct hda_codec *codec, hda_nid_t nid,
479 int flags, unsigned int verb, unsigned int parm);
480 void snd_hda_codec_resume_cache(struct hda_codec *codec);
481 /* both for cmd & amp caches */
482 void snd_hda_codec_flush_cache(struct hda_codec *codec);
484 /* the struct for codec->pin_configs */
487 unsigned char ctrl; /* original pin control value */
488 unsigned char target; /* target pin control value */
489 unsigned int cfg; /* default configuration */
492 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
493 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
495 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
496 hda_nid_t nid, unsigned int cfg); /* for hwdep */
497 void snd_hda_shutup_pins(struct hda_codec *codec);
500 struct hda_spdif_out {
501 hda_nid_t nid; /* Converter nid values relate to */
502 unsigned int status; /* IEC958 status bits */
503 unsigned short ctls; /* SPDIF control bits */
505 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
507 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
508 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
513 int snd_hda_build_controls(struct hda_bus *bus);
514 int snd_hda_codec_build_controls(struct hda_codec *codec);
519 int snd_hda_build_pcms(struct hda_bus *bus);
520 int snd_hda_codec_build_pcms(struct hda_codec *codec);
522 int snd_hda_codec_prepare(struct hda_codec *codec,
523 struct hda_pcm_stream *hinfo,
526 struct snd_pcm_substream *substream);
527 void snd_hda_codec_cleanup(struct hda_codec *codec,
528 struct hda_pcm_stream *hinfo,
529 struct snd_pcm_substream *substream);
531 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
533 int channel_id, int format);
534 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
536 #define snd_hda_codec_cleanup_stream(codec, nid) \
537 __snd_hda_codec_cleanup_stream(codec, nid, 0)
538 unsigned int snd_hda_calc_stream_format(struct hda_codec *codec,
540 unsigned int channels,
543 unsigned short spdif_ctls);
544 int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
545 unsigned int format);
547 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
552 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
553 void snd_hda_bus_reboot_notify(struct hda_bus *bus);
554 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
555 unsigned int power_state);
557 int snd_hda_lock_devices(struct hda_bus *bus);
558 void snd_hda_unlock_devices(struct hda_bus *bus);
564 int snd_hda_suspend(struct hda_bus *bus);
565 int snd_hda_resume(struct hda_bus *bus);
569 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
572 if (codec->patch_ops.check_power_status)
573 return codec->patch_ops.check_power_status(codec, nid);
579 * get widget information
581 const char *snd_hda_get_jack_connectivity(u32 cfg);
582 const char *snd_hda_get_jack_type(u32 cfg);
583 const char *snd_hda_get_jack_location(u32 cfg);
589 void snd_hda_power_save(struct hda_codec *codec, int delta, bool d3wait);
590 void snd_hda_update_power_acct(struct hda_codec *codec);
592 static inline void snd_hda_power_save(struct hda_codec *codec, int delta,
597 * snd_hda_power_up - Power-up the codec
598 * @codec: HD-audio codec
600 * Increment the power-up counter and power up the hardware really when
603 static inline void snd_hda_power_up(struct hda_codec *codec)
605 snd_hda_power_save(codec, 1, false);
609 * snd_hda_power_up_d3wait - Power-up the codec after waiting for any pending
610 * D3 transition to complete. This differs from snd_hda_power_up() when
611 * power_transition == -1. snd_hda_power_up sees this case as a nop,
612 * snd_hda_power_up_d3wait waits for the D3 transition to complete then powers
614 * @codec: HD-audio codec
616 * Cancel any power down operation hapenning on the work queue, then power up.
618 static inline void snd_hda_power_up_d3wait(struct hda_codec *codec)
620 snd_hda_power_save(codec, 1, true);
624 * snd_hda_power_down - Power-down the codec
625 * @codec: HD-audio codec
627 * Decrement the power-up counter and schedules the power-off work if
628 * the counter rearches to zero.
630 static inline void snd_hda_power_down(struct hda_codec *codec)
632 snd_hda_power_save(codec, -1, false);
636 * snd_hda_power_sync - Synchronize the power-save status
637 * @codec: HD-audio codec
639 * Synchronize the actual power state with the power account;
640 * called when power_save parameter is changed
642 static inline void snd_hda_power_sync(struct hda_codec *codec)
644 snd_hda_power_save(codec, 0, false);
647 #ifdef CONFIG_SND_HDA_PATCH_LOADER
651 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
654 #ifdef CONFIG_SND_HDA_DSP_LOADER
656 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
658 struct snd_dma_buffer *bufp)
660 return codec->bus->ops.load_dsp_prepare(codec->bus, format, size, bufp);
663 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start)
665 return codec->bus->ops.load_dsp_trigger(codec->bus, start);
668 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
669 struct snd_dma_buffer *dmab)
671 return codec->bus->ops.load_dsp_cleanup(codec->bus, dmab);
675 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
677 struct snd_dma_buffer *bufp)
682 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
684 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
685 struct snd_dma_buffer *dmab) {}
688 #endif /* __SOUND_HDA_CODEC_H */