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