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