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