1 /*
2 * Universal Interface for Intel High Definition Audio Codec
3 *
4 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
5 *
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)
9 * any later version.
10 *
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
14 * more details.
15 *
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.
19 */
20
21 #ifndef __SOUND_HDA_CODEC_H
22 #define __SOUND_HDA_CODEC_H
23
24 #include <linux/kref.h>
25 #include <linux/mod_devicetable.h>
26 #include <sound/info.h>
27 #include <sound/control.h>
28 #include <sound/pcm.h>
29 #include <sound/hwdep.h>
30 #include <sound/hdaudio.h>
31 #include <sound/hda_verbs.h>
32 #include <sound/hda_regmap.h>
33
34 /*
35 * Structures
36 */
37
38 struct hda_bus;
39 struct hda_beep;
40 struct hda_codec;
41 struct hda_pcm;
42 struct hda_pcm_stream;
43
44 /*
45 * codec bus
46 *
47 * each controller needs to creata a hda_bus to assign the accessor.
48 * A hda_bus contains several codecs in the list codec_list.
49 */
50 struct hda_bus {
51 struct hdac_bus core;
52
53 struct snd_card *card;
54
55 struct pci_dev *pci;
56 const char *modelname;
57
58 struct mutex prepare_mutex;
59
60 /* assigned PCMs */
61 DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
62
63 /* misc op flags */
64 unsigned int needs_damn_long_delay :1;
65 unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
66 /* status for codec/controller */
67 unsigned int shutdown :1; /* being unloaded */
68 unsigned int response_reset:1; /* controller was reset */
69 unsigned int in_reset:1; /* during reset operation */
70 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
71 unsigned int bus_probing :1; /* during probing process */
72
73 int primary_dig_out_type; /* primary digital out PCM type */
74 unsigned int mixer_assigned; /* codec addr for mixer name */
75 };
76
77 /* from hdac_bus to hda_bus */
78 #define to_hda_bus(bus) container_of(bus, struct hda_bus, core)
79
80 /*
81 * codec preset
82 *
83 * Known codecs have the patch to build and set up the controls/PCMs
84 * better than the generic parser.
85 */
86 typedef int (*hda_codec_patch_t)(struct hda_codec *);
87
88 #define HDA_CODEC_ID_GENERIC_HDMI 0x00000101
89 #define HDA_CODEC_ID_GENERIC 0x00000201
90
91 #define HDA_CODEC_REV_ENTRY(_vid, _rev, _name, _patch) \
92 { .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
93 .api_version = HDA_DEV_LEGACY, \
94 .driver_data = (unsigned long)(_patch) }
95 #define HDA_CODEC_ENTRY(_vid, _name, _patch) \
96 HDA_CODEC_REV_ENTRY(_vid, 0, _name, _patch)
97
98 struct hda_codec_driver {
99 struct hdac_driver core;
100 const struct hda_device_id *id;
101 };
102
103 int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
104 struct module *owner);
105 #define hda_codec_driver_register(drv) \
106 __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE)
107 void hda_codec_driver_unregister(struct hda_codec_driver *drv);
108 #define module_hda_codec_driver(drv) \
109 module_driver(drv, hda_codec_driver_register, \
110 hda_codec_driver_unregister)
111
112 /* ops set by the preset patch */
113 struct hda_codec_ops {
114 int (*build_controls)(struct hda_codec *codec);
115 int (*build_pcms)(struct hda_codec *codec);
116 int (*init)(struct hda_codec *codec);
117 void (*free)(struct hda_codec *codec);
118 void (*unsol_event)(struct hda_codec *codec, unsigned int res);
119 void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
120 unsigned int power_state);
121 #ifdef CONFIG_PM
122 int (*suspend)(struct hda_codec *codec);
123 int (*resume)(struct hda_codec *codec);
124 int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
125 #endif
126 void (*reboot_notify)(struct hda_codec *codec);
127 void (*stream_pm)(struct hda_codec *codec, hda_nid_t nid, bool on);
128 };
129
130 /* PCM callbacks */
131 struct hda_pcm_ops {
132 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
133 struct snd_pcm_substream *substream);
134 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
135 struct snd_pcm_substream *substream);
136 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
137 unsigned int stream_tag, unsigned int format,
138 struct snd_pcm_substream *substream);
139 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
140 struct snd_pcm_substream *substream);
141 unsigned int (*get_delay)(struct hda_pcm_stream *info,
142 struct hda_codec *codec,
143 struct snd_pcm_substream *substream);
144 };
145
146 /* PCM information for each substream */
147 struct hda_pcm_stream {
148 unsigned int substreams; /* number of substreams, 0 = not exist*/
149 unsigned int channels_min; /* min. number of channels */
150 unsigned int channels_max; /* max. number of channels */
151 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
152 u32 rates; /* supported rates */
153 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
154 unsigned int maxbps; /* supported max. bit per sample */
155 const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
156 struct hda_pcm_ops ops;
157 };
158
159 /* PCM types */
160 enum {
161 HDA_PCM_TYPE_AUDIO,
162 HDA_PCM_TYPE_SPDIF,
163 HDA_PCM_TYPE_HDMI,
164 HDA_PCM_TYPE_MODEM,
165 HDA_PCM_NTYPES
166 };
167
168 /* for PCM creation */
169 struct hda_pcm {
170 char *name;
171 struct hda_pcm_stream stream[2];
172 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */
173 int device; /* device number to assign */
174 struct snd_pcm *pcm; /* assigned PCM instance */
175 bool own_chmap; /* codec driver provides own channel maps */
176 /* private: */
177 struct hda_codec *codec;
178 struct kref kref;
179 struct list_head list;
180 };
181
182 /* codec information */
183 struct hda_codec {
184 struct hdac_device core;
185 struct hda_bus *bus;
186 struct snd_card *card;
187 unsigned int addr; /* codec addr*/
188 u32 probe_id; /* overridden id for probing */
189
190 /* detected preset */
191 const struct hda_device_id *preset;
192 const char *modelname; /* model name for preset */
193
194 /* set by patch */
195 struct hda_codec_ops patch_ops;
196
197 /* PCM to create, set by patch_ops.build_pcms callback */
198 struct list_head pcm_list_head;
199
200 /* codec specific info */
201 void *spec;
202
203 /* beep device */
204 struct hda_beep *beep;
205 unsigned int beep_mode;
206
207 /* widget capabilities cache */
208 u32 *wcaps;
209
210 struct snd_array mixers; /* list of assigned mixer elements */
211 struct snd_array nids; /* list of mapped mixer elements */
212
213 struct list_head conn_list; /* linked-list of connection-list */
214
215 struct mutex spdif_mutex;
216 struct mutex control_mutex;
217 struct snd_array spdif_out;
218 unsigned int spdif_in_enable; /* SPDIF input enable? */
219 const hda_nid_t *slave_dig_outs; /* optional digital out slave widgets */
220 struct snd_array init_pins; /* initial (BIOS) pin configurations */
221 struct snd_array driver_pins; /* pin configs set by codec parser */
222 struct snd_array cvt_setups; /* audio convert setups */
223
224 struct mutex user_mutex;
225 #ifdef CONFIG_SND_HDA_RECONFIG
226 struct snd_array init_verbs; /* additional init verbs */
227 struct snd_array hints; /* additional hints */
228 struct snd_array user_pins; /* default pin configs to override */
229 #endif
230
231 #ifdef CONFIG_SND_HDA_HWDEP
232 struct snd_hwdep *hwdep; /* assigned hwdep device */
233 #endif
234
235 /* misc flags */
236 unsigned int in_freeing:1; /* being released */
237 unsigned int registered:1; /* codec was registered */
238 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
239 * status change
240 * (e.g. Realtek codecs)
241 */
242 unsigned int pin_amp_workaround:1; /* pin out-amp takes index
243 * (e.g. Conexant codecs)
244 */
245 unsigned int single_adc_amp:1; /* adc in-amp takes no index
246 * (e.g. CX20549 codec)
247 */
248 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
249 unsigned int pins_shutup:1; /* pins are shut up */
250 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
251 unsigned int no_jack_detect:1; /* Machine has no jack-detection */
252 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
253 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
254 unsigned int pcm_format_first:1; /* PCM format must be set first */
255 unsigned int cached_write:1; /* write only to caches */
256 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */
257 unsigned int dump_coef:1; /* dump processing coefs in codec proc file */
258 unsigned int power_save_node:1; /* advanced PM for each widget */
259 unsigned int auto_runtime_pm:1; /* enable automatic codec runtime pm */
260 #ifdef CONFIG_PM
261 unsigned long power_on_acct;
262 unsigned long power_off_acct;
263 unsigned long power_jiffies;
264 #endif
265
266 /* filter the requested power state per nid */
267 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
268 unsigned int power_state);
269
270 /* codec-specific additional proc output */
271 void (*proc_widget_hook)(struct snd_info_buffer *buffer,
272 struct hda_codec *codec, hda_nid_t nid);
273
274 /* jack detection */
275 struct snd_array jacktbl;
276 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
277 struct delayed_work jackpoll_work;
278
279 /* jack detection */
280 struct snd_array jacks;
281
282 int depop_delay; /* depop delay in ms, -1 for default delay time */
283
284 /* fix-up list */
285 int fixup_id;
286 const struct hda_fixup *fixup_list;
287 const char *fixup_name;
288
289 /* additional init verbs */
290 struct snd_array verbs;
291 };
292
293 #define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, core.dev)
294 #define hda_codec_dev(_dev) (&(_dev)->core.dev)
295
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)
300
301 /* snd_hda_codec_read/write optional flags */
302 #define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
303
304 /*
305 * constructors
306 */
307 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
308 unsigned int codec_addr, struct hda_codec **codecp);
309 int snd_hda_codec_configure(struct hda_codec *codec);
310 int snd_hda_codec_update_widgets(struct hda_codec *codec);
311
312 /*
313 * low level functions
314 */
315 static inline unsigned int
snd_hda_codec_read(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)316 snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
317 int flags,
318 unsigned int verb, unsigned int parm)
319 {
320 return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm);
321 }
322
323 static inline int
snd_hda_codec_write(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)324 snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
325 unsigned int verb, unsigned int parm)
326 {
327 return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm);
328 }
329
330 #define snd_hda_param_read(codec, nid, param) \
331 snd_hdac_read_parm(&(codec)->core, nid, param)
332 #define snd_hda_get_sub_nodes(codec, nid, start_nid) \
333 snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid)
334 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
335 hda_nid_t *conn_list, int max_conns);
336 static inline int
snd_hda_get_num_conns(struct hda_codec * codec,hda_nid_t nid)337 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
338 {
339 return snd_hda_get_connections(codec, nid, NULL, 0);
340 }
341
342 #define snd_hda_get_raw_connections(codec, nid, list, max_conns) \
343 snd_hdac_get_connections(&(codec)->core, nid, list, max_conns)
344 #define snd_hda_get_num_raw_conns(codec, nid) \
345 snd_hdac_get_connections(&(codec)->core, nid, NULL, 0);
346
347 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
348 const hda_nid_t **listp);
349 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
350 const hda_nid_t *list);
351 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
352 hda_nid_t nid, int recursive);
353 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
354 u8 *dev_list, int max_devices);
355
356 struct hda_verb {
357 hda_nid_t nid;
358 u32 verb;
359 u32 param;
360 };
361
362 void snd_hda_sequence_write(struct hda_codec *codec,
363 const struct hda_verb *seq);
364
365 /* unsolicited event */
366 static inline void
snd_hda_queue_unsol_event(struct hda_bus * bus,u32 res,u32 res_ex)367 snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex)
368 {
369 snd_hdac_bus_queue_event(&bus->core, res, res_ex);
370 }
371
372 /* cached write */
373 static inline int
snd_hda_codec_write_cache(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)374 snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
375 int flags, unsigned int verb, unsigned int parm)
376 {
377 return snd_hdac_regmap_write(&codec->core, nid, verb, parm);
378 }
379
380 #define snd_hda_codec_update_cache(codec, nid, flags, verb, parm) \
381 snd_hda_codec_write_cache(codec, nid, flags, verb, parm)
382
383 /* the struct for codec->pin_configs */
384 struct hda_pincfg {
385 hda_nid_t nid;
386 unsigned char ctrl; /* original pin control value */
387 unsigned char target; /* target pin control value */
388 unsigned int cfg; /* default configuration */
389 };
390
391 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
392 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
393 unsigned int cfg);
394 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
395 hda_nid_t nid, unsigned int cfg); /* for hwdep */
396 void snd_hda_shutup_pins(struct hda_codec *codec);
397
398 /* SPDIF controls */
399 struct hda_spdif_out {
400 hda_nid_t nid; /* Converter nid values relate to */
401 unsigned int status; /* IEC958 status bits */
402 unsigned short ctls; /* SPDIF control bits */
403 };
404 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
405 hda_nid_t nid);
406 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
407 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
408
409 /*
410 * Mixer
411 */
412 int snd_hda_codec_build_controls(struct hda_codec *codec);
413
414 /*
415 * PCM
416 */
417 int snd_hda_codec_parse_pcms(struct hda_codec *codec);
418 int snd_hda_codec_build_pcms(struct hda_codec *codec);
419
420 __printf(2, 3)
421 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
422 const char *fmt, ...);
423
snd_hda_codec_pcm_get(struct hda_pcm * pcm)424 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
425 {
426 kref_get(&pcm->kref);
427 }
428 void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
429
430 int snd_hda_codec_prepare(struct hda_codec *codec,
431 struct hda_pcm_stream *hinfo,
432 unsigned int stream,
433 unsigned int format,
434 struct snd_pcm_substream *substream);
435 void snd_hda_codec_cleanup(struct hda_codec *codec,
436 struct hda_pcm_stream *hinfo,
437 struct snd_pcm_substream *substream);
438
439 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
440 u32 stream_tag,
441 int channel_id, int format);
442 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
443 int do_now);
444 #define snd_hda_codec_cleanup_stream(codec, nid) \
445 __snd_hda_codec_cleanup_stream(codec, nid, 0)
446
447 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, bpsp) \
448 snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, bpsp)
449 #define snd_hda_is_supported_format(codec, nid, fmt) \
450 snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
451
452 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
453
454 int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec,
455 struct hda_pcm *cpcm);
456
457 /*
458 * Misc
459 */
460 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
461 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
462 unsigned int power_state);
463
464 int snd_hda_lock_devices(struct hda_bus *bus);
465 void snd_hda_unlock_devices(struct hda_bus *bus);
466 void snd_hda_bus_reset(struct hda_bus *bus);
467 void snd_hda_bus_reset_codecs(struct hda_bus *bus);
468
469 int snd_hda_codec_set_name(struct hda_codec *codec, const char *name);
470
471 /*
472 * power management
473 */
474 extern const struct dev_pm_ops hda_codec_driver_pm;
475
476 static inline
hda_call_check_power_status(struct hda_codec * codec,hda_nid_t nid)477 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
478 {
479 #ifdef CONFIG_PM
480 if (codec->patch_ops.check_power_status)
481 return codec->patch_ops.check_power_status(codec, nid);
482 #endif
483 return 0;
484 }
485
486 /*
487 * power saving
488 */
489 #define snd_hda_power_up(codec) snd_hdac_power_up(&(codec)->core)
490 #define snd_hda_power_up_pm(codec) snd_hdac_power_up_pm(&(codec)->core)
491 #define snd_hda_power_down(codec) snd_hdac_power_down(&(codec)->core)
492 #define snd_hda_power_down_pm(codec) snd_hdac_power_down_pm(&(codec)->core)
493 #ifdef CONFIG_PM
494 void snd_hda_set_power_save(struct hda_bus *bus, int delay);
495 void snd_hda_update_power_acct(struct hda_codec *codec);
496 #else
snd_hda_set_power_save(struct hda_bus * bus,int delay)497 static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {}
498 #endif
499
500 #ifdef CONFIG_SND_HDA_PATCH_LOADER
501 /*
502 * patch firmware
503 */
504 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
505 #endif
506
507 #ifdef CONFIG_SND_HDA_DSP_LOADER
508 int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
509 unsigned int size,
510 struct snd_dma_buffer *bufp);
511 void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start);
512 void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
513 struct snd_dma_buffer *dmab);
514 #else
515 static inline int
snd_hda_codec_load_dsp_prepare(struct hda_codec * codec,unsigned int format,unsigned int size,struct snd_dma_buffer * bufp)516 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
517 unsigned int size,
518 struct snd_dma_buffer *bufp)
519 {
520 return -ENOSYS;
521 }
522 static inline void
snd_hda_codec_load_dsp_trigger(struct hda_codec * codec,bool start)523 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
524 static inline void
snd_hda_codec_load_dsp_cleanup(struct hda_codec * codec,struct snd_dma_buffer * dmab)525 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
526 struct snd_dma_buffer *dmab) {}
527 #endif
528
529 #endif /* __SOUND_HDA_CODEC_H */
530