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 
298 /* snd_hda_codec_read/write optional flags */
299 #define HDA_RW_NO_RESPONSE_FALLBACK	(1 << 0)
300 
301 /*
302  * constructors
303  */
304 int snd_hda_codec_new(struct hda_bus *bus, struct snd_card *card,
305 		      unsigned int codec_addr, struct hda_codec **codecp);
306 int snd_hda_codec_configure(struct hda_codec *codec);
307 int snd_hda_codec_update_widgets(struct hda_codec *codec);
308 
309 /*
310  * low level functions
311  */
312 static inline unsigned int
snd_hda_codec_read(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)313 snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
314 				int flags,
315 				unsigned int verb, unsigned int parm)
316 {
317 	return snd_hdac_codec_read(&codec->core, nid, flags, verb, parm);
318 }
319 
320 static inline int
snd_hda_codec_write(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)321 snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
322 			unsigned int verb, unsigned int parm)
323 {
324 	return snd_hdac_codec_write(&codec->core, nid, flags, verb, parm);
325 }
326 
327 #define snd_hda_param_read(codec, nid, param) \
328 	snd_hdac_read_parm(&(codec)->core, nid, param)
329 #define snd_hda_get_sub_nodes(codec, nid, start_nid) \
330 	snd_hdac_get_sub_nodes(&(codec)->core, nid, start_nid)
331 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
332 			    hda_nid_t *conn_list, int max_conns);
333 static inline int
snd_hda_get_num_conns(struct hda_codec * codec,hda_nid_t nid)334 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
335 {
336 	return snd_hda_get_connections(codec, nid, NULL, 0);
337 }
338 
339 #define snd_hda_get_raw_connections(codec, nid, list, max_conns) \
340 	snd_hdac_get_connections(&(codec)->core, nid, list, max_conns)
341 #define snd_hda_get_num_raw_conns(codec, nid) \
342 	snd_hdac_get_connections(&(codec)->core, nid, NULL, 0);
343 
344 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
345 			  const hda_nid_t **listp);
346 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
347 			  const hda_nid_t *list);
348 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
349 			   hda_nid_t nid, int recursive);
350 int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
351 			u8 *dev_list, int max_devices);
352 
353 struct hda_verb {
354 	hda_nid_t nid;
355 	u32 verb;
356 	u32 param;
357 };
358 
359 void snd_hda_sequence_write(struct hda_codec *codec,
360 			    const struct hda_verb *seq);
361 
362 /* unsolicited event */
363 static inline void
snd_hda_queue_unsol_event(struct hda_bus * bus,u32 res,u32 res_ex)364 snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex)
365 {
366 	snd_hdac_bus_queue_event(&bus->core, res, res_ex);
367 }
368 
369 /* cached write */
370 static inline int
snd_hda_codec_write_cache(struct hda_codec * codec,hda_nid_t nid,int flags,unsigned int verb,unsigned int parm)371 snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
372 			  int flags, unsigned int verb, unsigned int parm)
373 {
374 	return snd_hdac_regmap_write(&codec->core, nid, verb, parm);
375 }
376 
377 #define snd_hda_codec_update_cache(codec, nid, flags, verb, parm) \
378 	snd_hda_codec_write_cache(codec, nid, flags, verb, parm)
379 
380 /* the struct for codec->pin_configs */
381 struct hda_pincfg {
382 	hda_nid_t nid;
383 	unsigned char ctrl;	/* original pin control value */
384 	unsigned char target;	/* target pin control value */
385 	unsigned int cfg;	/* default configuration */
386 };
387 
388 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
389 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
390 			     unsigned int cfg);
391 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
392 		       hda_nid_t nid, unsigned int cfg); /* for hwdep */
393 void snd_hda_shutup_pins(struct hda_codec *codec);
394 
395 /* SPDIF controls */
396 struct hda_spdif_out {
397 	hda_nid_t nid;		/* Converter nid values relate to */
398 	unsigned int status;	/* IEC958 status bits */
399 	unsigned short ctls;	/* SPDIF control bits */
400 };
401 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
402 					       hda_nid_t nid);
403 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
404 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
405 
406 /*
407  * Mixer
408  */
409 int snd_hda_codec_build_controls(struct hda_codec *codec);
410 
411 /*
412  * PCM
413  */
414 int snd_hda_codec_parse_pcms(struct hda_codec *codec);
415 int snd_hda_codec_build_pcms(struct hda_codec *codec);
416 
417 __printf(2, 3)
418 struct hda_pcm *snd_hda_codec_pcm_new(struct hda_codec *codec,
419 				      const char *fmt, ...);
420 
snd_hda_codec_pcm_get(struct hda_pcm * pcm)421 static inline void snd_hda_codec_pcm_get(struct hda_pcm *pcm)
422 {
423 	kref_get(&pcm->kref);
424 }
425 void snd_hda_codec_pcm_put(struct hda_pcm *pcm);
426 
427 int snd_hda_codec_prepare(struct hda_codec *codec,
428 			  struct hda_pcm_stream *hinfo,
429 			  unsigned int stream,
430 			  unsigned int format,
431 			  struct snd_pcm_substream *substream);
432 void snd_hda_codec_cleanup(struct hda_codec *codec,
433 			   struct hda_pcm_stream *hinfo,
434 			   struct snd_pcm_substream *substream);
435 
436 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
437 				u32 stream_tag,
438 				int channel_id, int format);
439 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
440 				    int do_now);
441 #define snd_hda_codec_cleanup_stream(codec, nid) \
442 	__snd_hda_codec_cleanup_stream(codec, nid, 0)
443 
444 #define snd_hda_query_supported_pcm(codec, nid, ratesp, fmtsp, bpsp) \
445 	snd_hdac_query_supported_pcm(&(codec)->core, nid, ratesp, fmtsp, bpsp)
446 #define snd_hda_is_supported_format(codec, nid, fmt) \
447 	snd_hdac_is_supported_format(&(codec)->core, nid, fmt)
448 
449 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
450 
451 int snd_hda_attach_pcm_stream(struct hda_bus *_bus, struct hda_codec *codec,
452 			      struct hda_pcm *cpcm);
453 
454 /*
455  * Misc
456  */
457 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
458 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
459 				    unsigned int power_state);
460 
461 int snd_hda_lock_devices(struct hda_bus *bus);
462 void snd_hda_unlock_devices(struct hda_bus *bus);
463 void snd_hda_bus_reset(struct hda_bus *bus);
464 void snd_hda_bus_reset_codecs(struct hda_bus *bus);
465 
466 int snd_hda_codec_set_name(struct hda_codec *codec, const char *name);
467 
468 /*
469  * power management
470  */
471 extern const struct dev_pm_ops hda_codec_driver_pm;
472 
473 static inline
hda_call_check_power_status(struct hda_codec * codec,hda_nid_t nid)474 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
475 {
476 #ifdef CONFIG_PM
477 	if (codec->patch_ops.check_power_status)
478 		return codec->patch_ops.check_power_status(codec, nid);
479 #endif
480 	return 0;
481 }
482 
483 /*
484  * power saving
485  */
486 #define snd_hda_power_up(codec)		snd_hdac_power_up(&(codec)->core)
487 #define snd_hda_power_up_pm(codec)	snd_hdac_power_up_pm(&(codec)->core)
488 #define snd_hda_power_down(codec)	snd_hdac_power_down(&(codec)->core)
489 #define snd_hda_power_down_pm(codec)	snd_hdac_power_down_pm(&(codec)->core)
490 #ifdef CONFIG_PM
491 void snd_hda_set_power_save(struct hda_bus *bus, int delay);
492 void snd_hda_update_power_acct(struct hda_codec *codec);
493 #else
snd_hda_set_power_save(struct hda_bus * bus,int delay)494 static inline void snd_hda_set_power_save(struct hda_bus *bus, int delay) {}
495 #endif
496 
497 #ifdef CONFIG_SND_HDA_PATCH_LOADER
498 /*
499  * patch firmware
500  */
501 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
502 #endif
503 
504 #ifdef CONFIG_SND_HDA_DSP_LOADER
505 int snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
506 				   unsigned int size,
507 				   struct snd_dma_buffer *bufp);
508 void snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start);
509 void snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
510 				    struct snd_dma_buffer *dmab);
511 #else
512 static inline int
snd_hda_codec_load_dsp_prepare(struct hda_codec * codec,unsigned int format,unsigned int size,struct snd_dma_buffer * bufp)513 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
514 				unsigned int size,
515 				struct snd_dma_buffer *bufp)
516 {
517 	return -ENOSYS;
518 }
519 static inline void
snd_hda_codec_load_dsp_trigger(struct hda_codec * codec,bool start)520 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
521 static inline void
snd_hda_codec_load_dsp_cleanup(struct hda_codec * codec,struct snd_dma_buffer * dmab)522 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
523 				struct snd_dma_buffer *dmab) {}
524 #endif
525 
526 #endif /* __SOUND_HDA_CODEC_H */
527