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 <linux/kref.h>
25 #include <sound/info.h>
26 #include <sound/control.h>
27 #include <sound/pcm.h>
28 #include <sound/hwdep.h>
29 #include <sound/hda_verbs.h>
37 unsigned int elem_size;
38 unsigned int alloc_align;
42 void *snd_array_new(struct snd_array *array);
43 void snd_array_free(struct snd_array *array);
44 static inline void snd_array_init(struct snd_array *array, unsigned int size,
47 array->elem_size = size;
48 array->alloc_align = align;
51 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
53 return array->list + idx * array->elem_size;
56 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
58 return (unsigned long)(ptr - array->list) / array->elem_size;
69 struct hda_pcm_stream;
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);
87 #ifdef CONFIG_SND_HDA_DSP_LOADER
88 /* prepare DSP transfer */
89 int (*load_dsp_prepare)(struct hda_bus *bus, unsigned int format,
90 unsigned int byte_size,
91 struct snd_dma_buffer *bufp);
92 /* start/stop DSP transfer */
93 void (*load_dsp_trigger)(struct hda_bus *bus, bool start);
94 /* clean up DSP transfer */
95 void (*load_dsp_cleanup)(struct hda_bus *bus,
96 struct snd_dma_buffer *dmab);
100 /* unsolicited event handler */
101 #define HDA_UNSOL_QUEUE_SIZE 64
102 struct hda_bus_unsolicited {
104 u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
107 struct work_struct work;
113 * each controller needs to creata a hda_bus to assign the accessor.
114 * A hda_bus contains several codecs in the list codec_list.
117 struct snd_card *card;
121 const char *modelname;
122 struct hda_bus_ops ops;
124 /* codec linked list */
125 struct list_head codec_list;
126 unsigned int num_codecs;
127 /* link caddr -> codec */
128 struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
130 struct mutex cmd_mutex;
131 struct mutex prepare_mutex;
133 /* unsolicited event queue */
134 struct hda_bus_unsolicited unsol;
137 DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
140 unsigned int needs_damn_long_delay :1;
141 unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
142 unsigned int sync_write:1; /* sync after verb write */
143 /* status for codec/controller */
144 unsigned int shutdown :1; /* being unloaded */
145 unsigned int rirb_error:1; /* error in codec communication */
146 unsigned int response_reset:1; /* controller was reset */
147 unsigned int in_reset:1; /* during reset operation */
148 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
150 int primary_dig_out_type; /* primary digital out PCM type */
151 unsigned long codec_powered; /* bit flags of powered codecs */
157 * Known codecs have the patch to build and set up the controls/PCMs
158 * better than the generic parser.
160 struct hda_codec_preset {
164 unsigned int subs_mask;
168 int (*patch)(struct hda_codec *codec);
171 #define HDA_CODEC_ID_GENERIC_HDMI 0x00000101
172 #define HDA_CODEC_ID_GENERIC 0x00000201
174 struct hda_codec_driver {
175 struct device_driver driver;
176 const struct hda_codec_preset *preset;
179 int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
180 struct module *owner);
181 #define hda_codec_driver_register(drv) \
182 __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE)
183 void hda_codec_driver_unregister(struct hda_codec_driver *drv);
184 #define module_hda_codec_driver(drv) \
185 module_driver(drv, hda_codec_driver_register, \
186 hda_codec_driver_unregister)
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);
203 void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on);
206 /* record for amp information cache */
207 struct hda_cache_head {
208 u32 key:31; /* hash key */
210 u16 val; /* assigned value */
214 struct hda_amp_info {
215 struct hda_cache_head head;
216 u32 amp_caps; /* amp capabilities */
217 u16 vol[2]; /* current volume & mute */
220 struct hda_cache_rec {
221 u16 hash[64]; /* hash table for index */
222 struct snd_array buf; /* record entries */
227 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
228 struct snd_pcm_substream *substream);
229 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
230 struct snd_pcm_substream *substream);
231 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
232 unsigned int stream_tag, unsigned int format,
233 struct snd_pcm_substream *substream);
234 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
235 struct snd_pcm_substream *substream);
236 unsigned int (*get_delay)(struct hda_pcm_stream *info,
237 struct hda_codec *codec,
238 struct snd_pcm_substream *substream);
241 /* PCM information for each substream */
242 struct hda_pcm_stream {
243 unsigned int substreams; /* number of substreams, 0 = not exist*/
244 unsigned int channels_min; /* min. number of channels */
245 unsigned int channels_max; /* max. number of channels */
246 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
247 u32 rates; /* supported rates */
248 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
249 unsigned int maxbps; /* supported max. bit per sample */
250 const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
251 struct hda_pcm_ops ops;
263 /* for PCM creation */
266 struct hda_pcm_stream stream[2];
267 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */
268 int device; /* device number to assign */
269 struct snd_pcm *pcm; /* assigned PCM instance */
270 bool own_chmap; /* codec driver provides own channel maps */
272 struct hda_codec *codec;
274 struct list_head list;
277 /* codec information */
281 struct snd_card *card;
282 unsigned int addr; /* codec addr*/
283 struct list_head list; /* list point */
285 hda_nid_t afg; /* AFG node id */
286 hda_nid_t mfg; /* MFG node id */
296 u32 probe_id; /* overridden id for probing */
298 /* detected preset */
299 const struct hda_codec_preset *preset;
300 const char *vendor_name; /* codec vendor name */
301 const char *chip_name; /* codec chip name */
302 const char *modelname; /* model name for preset */
305 struct hda_codec_ops patch_ops;
307 /* PCM to create, set by patch_ops.build_pcms callback */
308 struct list_head pcm_list_head;
310 /* codec specific info */
314 struct hda_beep *beep;
315 unsigned int beep_mode;
317 /* widget capabilities cache */
318 unsigned int num_nodes;
322 struct snd_array mixers; /* list of assigned mixer elements */
323 struct snd_array nids; /* list of mapped mixer elements */
325 struct hda_cache_rec amp_cache; /* cache for amp access */
326 struct hda_cache_rec cmd_cache; /* cache for other commands */
328 struct list_head conn_list; /* linked-list of connection-list */
330 struct mutex spdif_mutex;
331 struct mutex control_mutex;
332 struct mutex hash_mutex;
333 struct snd_array spdif_out;
334 unsigned int spdif_in_enable; /* SPDIF input enable? */
335 const hda_nid_t *slave_dig_outs; /* optional digital out slave widgets */
336 struct snd_array init_pins; /* initial (BIOS) pin configurations */
337 struct snd_array driver_pins; /* pin configs set by codec parser */
338 struct snd_array cvt_setups; /* audio convert setups */
340 struct mutex user_mutex;
341 #ifdef CONFIG_SND_HDA_RECONFIG
342 struct snd_array init_verbs; /* additional init verbs */
343 struct snd_array hints; /* additional hints */
344 struct snd_array user_pins; /* default pin configs to override */
347 #ifdef CONFIG_SND_HDA_HWDEP
348 struct snd_hwdep *hwdep; /* assigned hwdep device */
352 unsigned int in_freeing:1; /* being released */
353 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
355 * (e.g. Realtek codecs)
357 unsigned int pin_amp_workaround:1; /* pin out-amp takes index
358 * (e.g. Conexant codecs)
360 unsigned int single_adc_amp:1; /* adc in-amp takes no index
361 * (e.g. CX20549 codec)
363 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
364 unsigned int pins_shutup:1; /* pins are shut up */
365 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
366 unsigned int no_jack_detect:1; /* Machine has no jack-detection */
367 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
368 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
369 unsigned int pcm_format_first:1; /* PCM format must be set first */
370 unsigned int epss:1; /* supporting EPSS? */
371 unsigned int cached_write:1; /* write only to caches */
372 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */
373 unsigned int dump_coef:1; /* dump processing coefs in codec proc file */
374 unsigned int power_save_node:1; /* advanced PM for each widget */
376 unsigned int d3_stop_clk:1; /* support D3 operation without BCLK */
377 atomic_t in_pm; /* suspend/resume being performed */
378 unsigned long power_on_acct;
379 unsigned long power_off_acct;
380 unsigned long power_jiffies;
383 /* filter the requested power state per nid */
384 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
385 unsigned int power_state);
387 /* codec-specific additional proc output */
388 void (*proc_widget_hook)(struct snd_info_buffer *buffer,
389 struct hda_codec *codec, hda_nid_t nid);
392 struct snd_array jacktbl;
393 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
394 struct delayed_work jackpoll_work;
396 #ifdef CONFIG_SND_HDA_INPUT_JACK
398 struct snd_array jacks;
401 int depop_delay; /* depop delay in ms, -1 for default delay time */
405 const struct hda_fixup *fixup_list;
406 const char *fixup_name;
408 /* additional init verbs */
409 struct snd_array verbs;
412 #define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, dev)
413 #define hda_codec_dev(_dev) (&(_dev)->dev)
415 extern struct bus_type snd_hda_bus_type;
419 HDA_INPUT, HDA_OUTPUT
422 /* snd_hda_codec_read/write optional flags */
423 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
428 int snd_hda_bus_new(struct snd_card *card, struct hda_bus **busp);
429 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
430 unsigned int codec_addr, struct hda_codec **codecp);
431 int snd_hda_codec_configure(struct hda_codec *codec);
432 int snd_hda_codec_update_widgets(struct hda_codec *codec);
435 * low level functions
437 unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
439 unsigned int verb, unsigned int parm);
440 int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
441 unsigned int verb, unsigned int parm);
442 #define snd_hda_param_read(codec, nid, param) \
443 snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
444 int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
445 hda_nid_t *start_id);
446 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
447 hda_nid_t *conn_list, int max_conns);
449 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
451 return snd_hda_get_connections(codec, nid, NULL, 0);
453 int snd_hda_get_num_raw_conns(struct hda_codec *codec, hda_nid_t nid);
454 int snd_hda_get_raw_connections(struct hda_codec *codec, hda_nid_t nid,
455 hda_nid_t *conn_list, int max_conns);
456 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
457 const hda_nid_t **listp);
458 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
459 const hda_nid_t *list);
460 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
461 hda_nid_t nid, int recursive);
462 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
463 u8 *dev_list, int max_devices);
464 int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
465 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
473 void snd_hda_sequence_write(struct hda_codec *codec,
474 const struct hda_verb *seq);
476 /* unsolicited event */
477 int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
480 int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
481 int flags, unsigned int verb, unsigned int parm);
482 void snd_hda_sequence_write_cache(struct hda_codec *codec,
483 const struct hda_verb *seq);
484 int snd_hda_codec_update_cache(struct hda_codec *codec, hda_nid_t nid,
485 int flags, unsigned int verb, unsigned int parm);
486 void snd_hda_codec_resume_cache(struct hda_codec *codec);
487 /* both for cmd & amp caches */
488 void snd_hda_codec_flush_cache(struct hda_codec *codec);
490 /* the struct for codec->pin_configs */
493 unsigned char ctrl; /* original pin control value */
494 unsigned char target; /* target pin control value */
495 unsigned int cfg; /* default configuration */
498 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
499 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
501 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
502 hda_nid_t nid, unsigned int cfg); /* for hwdep */
503 void snd_hda_shutup_pins(struct hda_codec *codec);
506 struct hda_spdif_out {
507 hda_nid_t nid; /* Converter nid values relate to */
508 unsigned int status; /* IEC958 status bits */
509 unsigned short ctls; /* SPDIF control bits */
511 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
513 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
514 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
519 int snd_hda_codec_build_controls(struct hda_codec *codec);
524 int snd_hda_codec_parse_pcms(struct hda_codec *codec);
525 int snd_hda_codec_build_pcms(struct hda_codec *codec);
528 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
529 const char *fmt, ...);
531 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
533 kref_get(&pcm->kref);
535 void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
537 int snd_hda_codec_prepare(struct hda_codec *codec,
538 struct hda_pcm_stream *hinfo,
541 struct snd_pcm_substream *substream);
542 void snd_hda_codec_cleanup(struct hda_codec *codec,
543 struct hda_pcm_stream *hinfo,
544 struct snd_pcm_substream *substream);
546 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
548 int channel_id, int format);
549 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
551 #define snd_hda_codec_cleanup_stream(codec, nid) \
552 __snd_hda_codec_cleanup_stream(codec, nid, 0)
553 unsigned int snd_hda_calc_stream_format(struct hda_codec *codec,
555 unsigned int channels,
558 unsigned short spdif_ctls);
559 int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
560 unsigned int format);
562 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
567 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
568 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
569 unsigned int power_state);
571 int snd_hda_lock_devices(struct hda_bus *bus);
572 void snd_hda_unlock_devices(struct hda_bus *bus);
573 void snd_hda_bus_reset(struct hda_bus *bus);
578 extern const struct dev_pm_ops hda_codec_driver_pm;
581 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
584 if (codec->patch_ops.check_power_status)
585 return codec->patch_ops.check_power_status(codec, nid);
591 * get widget information
593 const char *snd_hda_get_jack_connectivity(u32 cfg);
594 const char *snd_hda_get_jack_type(u32 cfg);
595 const char *snd_hda_get_jack_location(u32 cfg);
601 void snd_hda_power_up(struct hda_codec *codec);
602 void snd_hda_power_down(struct hda_codec *codec);
603 void snd_hda_set_power_save(struct hda_bus *bus, int delay);
604 void snd_hda_update_power_acct(struct hda_codec *codec);
606 static inline void snd_hda_power_up(struct hda_codec *codec) {}
607 static inline void snd_hda_power_down(struct hda_codec *codec) {}
608 static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {}
611 #ifdef CONFIG_SND_HDA_PATCH_LOADER
615 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
618 #ifdef CONFIG_SND_HDA_DSP_LOADER
620 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
622 struct snd_dma_buffer *bufp)
624 return codec->bus->ops.load_dsp_prepare(codec->bus, format, size, bufp);
627 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start)
629 return codec->bus->ops.load_dsp_trigger(codec->bus, start);
632 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
633 struct snd_dma_buffer *dmab)
635 return codec->bus->ops.load_dsp_cleanup(codec->bus, dmab);
639 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
641 struct snd_dma_buffer *bufp)
646 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
648 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
649 struct snd_dma_buffer *dmab) {}
652 #endif /* __SOUND_HDA_CODEC_H */