blob: 1fa3dd9baf5225b5dba1573e3bafdda671ebb35e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 <sound/info.h>
25#include <sound/control.h>
26#include <sound/pcm.h>
Takashi Iwai28073142007-07-27 18:58:06 +020027#include <sound/hwdep.h>
Takashi Iwaied326362013-12-09 14:28:36 +010028#include <sound/hda_verbs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30/*
Takashi Iwaib2e18592008-07-30 15:01:44 +020031 * generic arrays
32 */
33struct snd_array {
34 unsigned int used;
35 unsigned int alloced;
36 unsigned int elem_size;
37 unsigned int alloc_align;
38 void *list;
39};
40
41void *snd_array_new(struct snd_array *array);
42void snd_array_free(struct snd_array *array);
43static inline void snd_array_init(struct snd_array *array, unsigned int size,
44 unsigned int align)
45{
46 array->elem_size = size;
47 array->alloc_align = align;
48}
49
Takashi Iwaif43aa022008-11-10 16:24:26 +010050static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
51{
52 return array->list + idx * array->elem_size;
53}
54
55static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
56{
57 return (unsigned long)(ptr - array->list) / array->elem_size;
58}
59
Takashi Iwaib2e18592008-07-30 15:01:44 +020060/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 * Structures
62 */
63
64struct hda_bus;
Matthew Ranostay1cd22242008-07-18 18:20:52 +020065struct hda_beep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066struct hda_codec;
67struct hda_pcm;
68struct hda_pcm_stream;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70/* NID type */
71typedef u16 hda_nid_t;
72
73/* bus operators */
74struct hda_bus_ops {
75 /* send a single command */
Takashi Iwai33fa35e2008-11-06 16:50:40 +010076 int (*command)(struct hda_bus *bus, unsigned int cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 /* get a response from the last command */
Wu Fengguangdeadff12009-08-01 18:45:16 +080078 unsigned int (*get_response)(struct hda_bus *bus, unsigned int addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 /* free the private data */
80 void (*private_free)(struct hda_bus *);
Takashi Iwai176d5332008-07-30 15:01:44 +020081 /* attach a PCM stream */
Takashi Iwai33fa35e2008-11-06 16:50:40 +010082 int (*attach_pcm)(struct hda_bus *bus, struct hda_codec *codec,
83 struct hda_pcm *pcm);
Takashi Iwai8dd78332009-06-02 01:16:07 +020084 /* reset bus for retry verb */
85 void (*bus_reset)(struct hda_bus *bus);
Takashi Iwai83012a72012-08-24 18:38:08 +020086#ifdef CONFIG_PM
Joe Perches561de312007-12-18 13:13:47 +010087 /* notify power-up/down from codec to controller */
Takashi Iwai68467f52012-08-28 09:14:29 -070088 void (*pm_notify)(struct hda_bus *bus, bool power_up);
Takashi Iwaicb53c622007-08-10 17:21:45 +020089#endif
Takashi Iwai1d1a4562012-09-20 20:29:13 -070090#ifdef CONFIG_SND_HDA_DSP_LOADER
91 /* prepare DSP transfer */
92 int (*load_dsp_prepare)(struct hda_bus *bus, unsigned int format,
93 unsigned int byte_size,
94 struct snd_dma_buffer *bufp);
95 /* start/stop DSP transfer */
96 void (*load_dsp_trigger)(struct hda_bus *bus, bool start);
97 /* clean up DSP transfer */
98 void (*load_dsp_cleanup)(struct hda_bus *bus,
99 struct snd_dma_buffer *dmab);
100#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101};
102
Takashi Iwai922c88a2015-02-17 14:46:40 +0100103/* unsolicited event handler */
104#define HDA_UNSOL_QUEUE_SIZE 64
105struct hda_bus_unsolicited {
106 /* ring buffer */
107 u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
108 unsigned int rp, wp;
109 /* workqueue */
110 struct work_struct work;
111};
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113/*
114 * codec bus
115 *
116 * each controller needs to creata a hda_bus to assign the accessor.
117 * A hda_bus contains several codecs in the list codec_list.
118 */
119struct hda_bus {
Takashi Iwaic8b6bf92005-11-17 14:57:47 +0100120 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 void *private_data;
123 struct pci_dev *pci;
124 const char *modelname;
Takashi Iwaifee2fba2008-11-27 12:43:28 +0100125 int *power_save;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 struct hda_bus_ops ops;
127
128 /* codec linked list */
129 struct list_head codec_list;
Mengdong Lin0e24dbb2013-11-26 23:00:51 -0500130 unsigned int num_codecs;
Takashi Iwaid01ce992007-07-27 16:52:19 +0200131 /* link caddr -> codec */
132 struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
Ingo Molnar62932df2006-01-16 16:34:20 +0100134 struct mutex cmd_mutex;
Takashi Iwai3f50ac62010-08-20 09:44:36 +0200135 struct mutex prepare_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137 /* unsolicited event queue */
Takashi Iwai922c88a2015-02-17 14:46:40 +0100138 struct hda_bus_unsolicited unsol;
Takashi Iwaie8c0ee52009-02-05 07:34:28 +0100139 char workq_name[16];
Takashi Iwai6acaed32009-01-12 10:09:24 +0100140 struct workqueue_struct *workq; /* common workqueue for codecs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Takashi Iwai529bd6c2008-11-27 14:17:01 +0100142 /* assigned PCMs */
143 DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
144
Takashi Iwai52987652008-01-16 16:09:47 +0100145 /* misc op flags */
146 unsigned int needs_damn_long_delay :1;
Takashi Iwaib20f3b82009-06-02 01:20:22 +0200147 unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
148 unsigned int sync_write:1; /* sync after verb write */
149 /* status for codec/controller */
Takashi Iwaib94d35392008-11-21 09:08:06 +0100150 unsigned int shutdown :1; /* being unloaded */
Takashi Iwaib6132912009-03-24 07:36:09 +0100151 unsigned int rirb_error:1; /* error in codec communication */
Takashi Iwai8dd78332009-06-02 01:16:07 +0200152 unsigned int response_reset:1; /* controller was reset */
153 unsigned int in_reset:1; /* during reset operation */
Wu Fengguang0287d972009-12-11 20:15:11 +0800154 unsigned int power_keep_link_on:1; /* don't power off HDA link */
Takashi Iwai63e51fd2013-06-06 14:20:19 +0200155 unsigned int no_response_fallback:1; /* don't fallback at RIRB error */
Takashi Iwaiea9b43a2013-02-12 17:02:41 +0100156
157 int primary_dig_out_type; /* primary digital out PCM type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158};
159
160/*
161 * codec preset
162 *
163 * Known codecs have the patch to build and set up the controls/PCMs
164 * better than the generic parser.
165 */
166struct hda_codec_preset {
167 unsigned int id;
168 unsigned int mask;
169 unsigned int subs;
170 unsigned int subs_mask;
171 unsigned int rev;
Marc Boucherca7cfae2008-01-22 15:32:25 +0100172 hda_nid_t afg, mfg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 const char *name;
174 int (*patch)(struct hda_codec *codec);
175};
176
Takashi Iwaid8a766a2015-02-17 15:25:37 +0100177#define HDA_CODEC_ID_GENERIC_HDMI 0x00000101
178#define HDA_CODEC_ID_GENERIC 0x00000201
179
180struct hda_codec_driver {
181 struct device_driver driver;
Takashi Iwai1289e9e2008-11-27 15:47:11 +0100182 const struct hda_codec_preset *preset;
Takashi Iwai1289e9e2008-11-27 15:47:11 +0100183};
184
Takashi Iwaid8a766a2015-02-17 15:25:37 +0100185int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
186 struct module *owner);
187#define hda_codec_driver_register(drv) \
188 __hda_codec_driver_register(drv, KBUILD_MODNAME, THIS_MODULE)
189void hda_codec_driver_unregister(struct hda_codec_driver *drv);
190#define module_hda_codec_driver(drv) \
191 module_driver(drv, hda_codec_driver_register, \
192 hda_codec_driver_unregister)
Takashi Iwai1289e9e2008-11-27 15:47:11 +0100193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194/* ops set by the preset patch */
195struct hda_codec_ops {
196 int (*build_controls)(struct hda_codec *codec);
197 int (*build_pcms)(struct hda_codec *codec);
198 int (*init)(struct hda_codec *codec);
199 void (*free)(struct hda_codec *codec);
200 void (*unsol_event)(struct hda_codec *codec, unsigned int res);
Takashi Iwai4d7fbdb2011-07-26 10:33:10 +0200201 void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
202 unsigned int power_state);
Takashi Iwai2a439522011-07-26 09:52:50 +0200203#ifdef CONFIG_PM
Takashi Iwai68cb2b52012-07-02 15:20:37 +0200204 int (*suspend)(struct hda_codec *codec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 int (*resume)(struct hda_codec *codec);
Takashi Iwaicb53c622007-08-10 17:21:45 +0200206 int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
207#endif
Takashi Iwaifb8d1a32009-11-10 16:02:29 +0100208 void (*reboot_notify)(struct hda_codec *codec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209};
210
211/* record for amp information cache */
Takashi Iwai01751f52007-08-10 16:59:39 +0200212struct hda_cache_head {
Takashi Iwaic370dd62012-12-13 18:30:04 +0100213 u32 key:31; /* hash key */
214 u32 dirty:1;
Takashi Iwai01751f52007-08-10 16:59:39 +0200215 u16 val; /* assigned value */
Takashi Iwaic370dd62012-12-13 18:30:04 +0100216 u16 next;
Takashi Iwai01751f52007-08-10 16:59:39 +0200217};
218
219struct hda_amp_info {
220 struct hda_cache_head head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 u32 amp_caps; /* amp capabilities */
Jaroslav Kysela7f0e2f82006-07-05 17:39:14 +0200222 u16 vol[2]; /* current volume & mute */
Takashi Iwai01751f52007-08-10 16:59:39 +0200223};
224
225struct hda_cache_rec {
226 u16 hash[64]; /* hash table for index */
Takashi Iwai603c4012008-07-30 15:01:44 +0200227 struct snd_array buf; /* record entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228};
229
230/* PCM callbacks */
231struct hda_pcm_ops {
232 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
Takashi Iwaic8b6bf92005-11-17 14:57:47 +0100233 struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
Takashi Iwaic8b6bf92005-11-17 14:57:47 +0100235 struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
237 unsigned int stream_tag, unsigned int format,
Takashi Iwaic8b6bf92005-11-17 14:57:47 +0100238 struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
Takashi Iwaic8b6bf92005-11-17 14:57:47 +0100240 struct snd_pcm_substream *substream);
Takashi Iwai21229612013-04-05 07:27:45 +0200241 unsigned int (*get_delay)(struct hda_pcm_stream *info,
242 struct hda_codec *codec,
243 struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244};
245
246/* PCM information for each substream */
247struct hda_pcm_stream {
Takashi Iwaid01ce992007-07-27 16:52:19 +0200248 unsigned int substreams; /* number of substreams, 0 = not exist*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 unsigned int channels_min; /* min. number of channels */
250 unsigned int channels_max; /* max. number of channels */
251 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
252 u32 rates; /* supported rates */
253 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
254 unsigned int maxbps; /* supported max. bit per sample */
Takashi Iwaiee81abb2012-11-08 17:12:10 +0100255 const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 struct hda_pcm_ops ops;
257};
258
Takashi Iwai7ba72ba2008-02-06 14:03:20 +0100259/* PCM types */
260enum {
261 HDA_PCM_TYPE_AUDIO,
262 HDA_PCM_TYPE_SPDIF,
263 HDA_PCM_TYPE_HDMI,
264 HDA_PCM_TYPE_MODEM,
265 HDA_PCM_NTYPES
266};
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268/* for PCM creation */
269struct hda_pcm {
270 char *name;
271 struct hda_pcm_stream stream[2];
Takashi Iwai7ba72ba2008-02-06 14:03:20 +0100272 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */
Takashi Iwai176d5332008-07-30 15:01:44 +0200273 int device; /* device number to assign */
274 struct snd_pcm *pcm; /* assigned PCM instance */
Takashi Iwai9c9a5172012-07-31 11:35:35 +0200275 bool own_chmap; /* codec driver provides own channel maps */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276};
277
278/* codec information */
279struct hda_codec {
Takashi Iwai13aeaf62014-02-25 07:53:47 +0100280 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 struct hda_bus *bus;
282 unsigned int addr; /* codec addr*/
283 struct list_head list; /* list point */
284
285 hda_nid_t afg; /* AFG node id */
Sasha Khapyorsky673b6832005-08-11 11:00:16 +0200286 hda_nid_t mfg; /* MFG node id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
288 /* ids */
Jaroslav Kysela79c944a2010-07-19 15:52:39 +0200289 u8 afg_function_id;
290 u8 mfg_function_id;
291 u8 afg_unsol;
292 u8 mfg_unsol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 u32 vendor_id;
294 u32 subsystem_id;
295 u32 revision_id;
Takashi Iwaid8a766a2015-02-17 15:25:37 +0100296 u32 probe_id; /* overridden id for probing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
298 /* detected preset */
299 const struct hda_codec_preset *preset;
Takashi Iwai812a2cc2009-05-16 10:00:49 +0200300 const char *vendor_name; /* codec vendor name */
301 const char *chip_name; /* codec chip name */
Takashi Iwaif44ac832008-07-30 15:01:45 +0200302 const char *modelname; /* model name for preset */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
304 /* set by patch */
305 struct hda_codec_ops patch_ops;
306
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 /* PCM to create, set by patch_ops.build_pcms callback */
308 unsigned int num_pcms;
309 struct hda_pcm *pcm_info;
310
311 /* codec specific info */
312 void *spec;
313
Matthew Ranostay1cd22242008-07-18 18:20:52 +0200314 /* beep device */
315 struct hda_beep *beep;
Jaroslav Kysela2dca0bb2009-11-13 18:41:52 +0100316 unsigned int beep_mode;
Matthew Ranostay1cd22242008-07-18 18:20:52 +0200317
Takashi Iwai54d17402005-11-21 16:33:22 +0100318 /* widget capabilities cache */
319 unsigned int num_nodes;
320 hda_nid_t start_nid;
321 u32 *wcaps;
322
Takashi Iwaid13bd412008-07-30 15:01:45 +0200323 struct snd_array mixers; /* list of assigned mixer elements */
Jaroslav Kysela5b0cb1d2009-12-08 16:13:32 +0100324 struct snd_array nids; /* list of mapped mixer elements */
Takashi Iwaid13bd412008-07-30 15:01:45 +0200325
Takashi Iwai01751f52007-08-10 16:59:39 +0200326 struct hda_cache_rec amp_cache; /* cache for amp access */
Takashi Iwaib3ac5632007-08-10 17:03:40 +0200327 struct hda_cache_rec cmd_cache; /* cache for other commands */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Takashi Iwaiee8e7652013-01-03 15:25:11 +0100329 struct list_head conn_list; /* linked-list of connection-list */
Takashi Iwaia12d3e12011-04-07 15:55:15 +0200330
Ingo Molnar62932df2006-01-16 16:34:20 +0100331 struct mutex spdif_mutex;
Wu Fengguang5a9e02e2009-01-09 16:45:24 +0800332 struct mutex control_mutex;
Takashi Iwaic3b6bcc2012-05-10 16:11:15 +0200333 struct mutex hash_mutex;
Stephen Warren7c935972011-06-01 11:14:17 -0600334 struct snd_array spdif_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 unsigned int spdif_in_enable; /* SPDIF input enable? */
Takashi Iwaidda14412011-05-02 11:29:30 +0200336 const hda_nid_t *slave_dig_outs; /* optional digital out slave widgets */
Takashi Iwai3be14142009-02-20 14:11:16 +0100337 struct snd_array init_pins; /* initial (BIOS) pin configurations */
Takashi Iwai346ff702009-02-23 09:42:57 +0100338 struct snd_array driver_pins; /* pin configs set by codec parser */
Takashi Iwaieb541332010-08-06 13:48:11 +0200339 struct snd_array cvt_setups; /* audio convert setups */
Takashi Iwai28073142007-07-27 18:58:06 +0200340
Takashi Iwai09b70e82013-01-10 18:21:56 +0100341 struct mutex user_mutex;
Takashi Iwaib989d042014-02-25 11:54:06 +0100342#ifdef CONFIG_SND_HDA_RECONFIG
Takashi Iwai11aeff02008-07-30 15:01:46 +0200343 struct snd_array init_verbs; /* additional init verbs */
Takashi Iwai1e1be432008-07-30 15:01:46 +0200344 struct snd_array hints; /* additional hints */
Takashi Iwai346ff702009-02-23 09:42:57 +0100345 struct snd_array user_pins; /* default pin configs to override */
Takashi Iwai11aeff02008-07-30 15:01:46 +0200346#endif
Takashi Iwaicb53c622007-08-10 17:21:45 +0200347
Takashi Iwai648a8d22014-02-25 10:38:13 +0100348#ifdef CONFIG_SND_HDA_HWDEP
349 struct snd_hwdep *hwdep; /* assigned hwdep device */
350#endif
351
Takashi Iwai963f8032008-08-11 10:04:40 +0200352 /* misc flags */
353 unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
354 * status change
355 * (e.g. Realtek codecs)
356 */
Takashi Iwai9421f952009-03-12 17:06:07 +0100357 unsigned int pin_amp_workaround:1; /* pin out-amp takes index
358 * (e.g. Conexant codecs)
359 */
Michael Karcher4f324562012-04-06 15:34:15 +0200360 unsigned int single_adc_amp:1; /* adc in-amp takes no index
361 * (e.g. CX20549 codec)
362 */
Takashi Iwai0e7adbe2010-10-25 10:37:11 +0200363 unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
Takashi Iwaiac0547d2010-07-05 16:50:13 +0200364 unsigned int pins_shutup:1; /* pins are shut up */
Takashi Iwai729d55b2009-12-25 22:49:01 +0100365 unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
Takashi Iwai71b1e9e2012-02-13 11:55:02 +0100366 unsigned int no_jack_detect:1; /* Machine has no jack-detection */
Takashi Iwaiecac3ed2012-12-21 15:23:01 +0100367 unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
Takashi Iwai9cc159c2012-12-21 15:31:41 +0100368 unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
Takashi Iwaied360812012-08-08 17:12:52 +0200369 unsigned int pcm_format_first:1; /* PCM format must be set first */
Takashi Iwai983f6b92012-08-28 09:18:01 -0700370 unsigned int epss:1; /* supporting EPSS? */
Takashi Iwaic370dd62012-12-13 18:30:04 +0100371 unsigned int cached_write:1; /* write only to caches */
Mengdong Linf1aa0682013-08-26 21:35:21 -0400372 unsigned int dp_mst:1; /* support DP1.2 Multi-stream transport */
David Henningssoncd262512014-01-29 10:37:10 +0100373 unsigned int dump_coef:1; /* dump processing coefs in codec proc file */
Takashi Iwai83012a72012-08-24 18:38:08 +0200374#ifdef CONFIG_PM
Takashi Iwaia221e282007-08-16 16:35:33 +0200375 unsigned int power_on :1; /* current (global) power-state */
Takashi Iwai4b927342012-08-28 16:39:25 -0700376 unsigned int d3_stop_clk:1; /* support D3 operation without BCLK */
Takashi Iwaia40e0a82013-11-20 12:41:20 +0100377 unsigned int pm_up_notified:1; /* PM notified to controller */
Takashi Iwai989c3182012-11-19 14:14:58 +0100378 unsigned int in_pm:1; /* suspend/resume being performed */
Takashi Iwaia2d96e72012-05-09 12:36:22 +0200379 int power_transition; /* power-state in transition */
Takashi Iwaicb53c622007-08-10 17:21:45 +0200380 int power_count; /* current (global) power refcount */
381 struct delayed_work power_work; /* delayed task for powerdown */
Takashi Iwaia2f63092009-11-11 09:34:25 +0100382 unsigned long power_on_acct;
383 unsigned long power_off_acct;
384 unsigned long power_jiffies;
Takashi Iwai5536c6d2012-05-08 17:08:10 +0200385 spinlock_t power_lock;
Takashi Iwaicb53c622007-08-10 17:21:45 +0200386#endif
Takashi Iwaidaead532008-11-28 12:55:36 +0100387
Takashi Iwai9419ab62013-01-24 17:23:35 +0100388 /* filter the requested power state per nid */
389 unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
390 unsigned int power_state);
391
Takashi Iwaidaead532008-11-28 12:55:36 +0100392 /* codec-specific additional proc output */
393 void (*proc_widget_hook)(struct snd_info_buffer *buffer,
394 struct hda_codec *codec, hda_nid_t nid);
Takashi Iwaicd372fb2011-03-03 14:40:14 +0100395
Takashi Iwai1835a0f2011-10-27 22:12:46 +0200396 /* jack detection */
397 struct snd_array jacktbl;
David Henningsson26a6cb62012-10-09 15:04:21 +0200398 unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
399 struct delayed_work jackpoll_work;
Takashi Iwai1835a0f2011-10-27 22:12:46 +0200400
Takashi Iwaicd372fb2011-03-03 14:40:14 +0100401#ifdef CONFIG_SND_HDA_INPUT_JACK
402 /* jack detection */
403 struct snd_array jacks;
404#endif
Takashi Iwaic9ce6b22012-12-18 18:12:44 +0100405
Mengdong Lin7f132922013-11-29 01:48:45 -0500406 int depop_delay; /* depop delay in ms, -1 for default delay time */
407
Takashi Iwaic9ce6b22012-12-18 18:12:44 +0100408 /* fix-up list */
409 int fixup_id;
410 const struct hda_fixup *fixup_list;
411 const char *fixup_name;
412
413 /* additional init verbs */
414 struct snd_array verbs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415};
416
Takashi Iwaid8a766a2015-02-17 15:25:37 +0100417#define dev_to_hda_codec(_dev) container_of(_dev, struct hda_codec, dev)
418#define hda_codec_dev(_dev) (&(_dev)->dev)
419
420extern struct bus_type snd_hda_bus_type;
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/* direction */
423enum {
424 HDA_INPUT, HDA_OUTPUT
425};
426
Takashi Iwai63e51fd2013-06-06 14:20:19 +0200427/* snd_hda_codec_read/write optional flags */
428#define HDA_RW_NO_RESPONSE_FALLBACK (1 << 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
430/*
431 * constructors
432 */
Takashi Iwaief744972015-02-17 13:56:29 +0100433int snd_hda_bus_new(struct snd_card *card, struct hda_bus **busp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
Takashi Iwaia1e21c92009-06-17 09:33:52 +0200435 struct hda_codec **codecp);
436int snd_hda_codec_configure(struct hda_codec *codec);
Mengdong Lina15d05d2013-02-08 17:09:31 -0500437int snd_hda_codec_update_widgets(struct hda_codec *codec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
439/*
440 * low level functions
441 */
Takashi Iwaid01ce992007-07-27 16:52:19 +0200442unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
Takashi Iwaie7ecc272013-06-06 14:00:23 +0200443 int flags,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 unsigned int verb, unsigned int parm);
Takashi Iwaie7ecc272013-06-06 14:00:23 +0200445int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int flags,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 unsigned int verb, unsigned int parm);
Takashi Iwaid01ce992007-07-27 16:52:19 +0200447#define snd_hda_param_read(codec, nid, param) \
448 snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
449int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
450 hda_nid_t *start_id);
451int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
452 hda_nid_t *conn_list, int max_conns);
Takashi Iwai09cf03b2012-05-19 17:21:25 +0200453static inline int
454snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
455{
456 return snd_hda_get_connections(codec, nid, NULL, 0);
457}
Takashi Iwai4eea3092013-02-07 18:18:19 +0100458int snd_hda_get_num_raw_conns(struct hda_codec *codec, hda_nid_t nid);
Takashi Iwai9e7717c2011-07-11 15:42:52 +0200459int snd_hda_get_raw_connections(struct hda_codec *codec, hda_nid_t nid,
460 hda_nid_t *conn_list, int max_conns);
Takashi Iwaiee8e7652013-01-03 15:25:11 +0100461int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
462 const hda_nid_t **listp);
Takashi Iwaib2f934a2011-07-04 16:23:26 +0200463int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
464 const hda_nid_t *list);
Takashi Iwai8d087c72011-06-28 12:45:47 +0200465int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
466 hda_nid_t nid, int recursive);
Mengdong Linf1aa0682013-08-26 21:35:21 -0400467int snd_hda_get_devices(struct hda_codec *codec, hda_nid_t nid,
468 u8 *dev_list, int max_devices);
Stephen Warren384a48d2011-06-01 11:14:21 -0600469int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
470 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
472struct hda_verb {
473 hda_nid_t nid;
474 u32 verb;
475 u32 param;
476};
477
Takashi Iwaid01ce992007-07-27 16:52:19 +0200478void snd_hda_sequence_write(struct hda_codec *codec,
479 const struct hda_verb *seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481/* unsolicited event */
482int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
483
Takashi Iwaib3ac5632007-08-10 17:03:40 +0200484/* cached write */
485int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
Takashi Iwaie7ecc272013-06-06 14:00:23 +0200486 int flags, unsigned int verb, unsigned int parm);
Takashi Iwaib3ac5632007-08-10 17:03:40 +0200487void snd_hda_sequence_write_cache(struct hda_codec *codec,
488 const struct hda_verb *seq);
Takashi Iwaia68d5a52010-03-30 18:03:44 +0200489int snd_hda_codec_update_cache(struct hda_codec *codec, hda_nid_t nid,
Takashi Iwaie7ecc272013-06-06 14:00:23 +0200490 int flags, unsigned int verb, unsigned int parm);
Takashi Iwaib3ac5632007-08-10 17:03:40 +0200491void snd_hda_codec_resume_cache(struct hda_codec *codec);
Takashi Iwaidc870f32013-01-22 15:24:30 +0100492/* both for cmd & amp caches */
493void snd_hda_codec_flush_cache(struct hda_codec *codec);
Takashi Iwai0c3d47b2012-12-20 11:41:54 +0100494
Takashi Iwai3be14142009-02-20 14:11:16 +0100495/* the struct for codec->pin_configs */
496struct hda_pincfg {
497 hda_nid_t nid;
Takashi Iwaid7fdc002013-01-10 08:38:04 +0100498 unsigned char ctrl; /* original pin control value */
499 unsigned char target; /* target pin control value */
Takashi Iwaiac0547d2010-07-05 16:50:13 +0200500 unsigned int cfg; /* default configuration */
Takashi Iwai3be14142009-02-20 14:11:16 +0100501};
502
503unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
504int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
505 unsigned int cfg);
506int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
507 hda_nid_t nid, unsigned int cfg); /* for hwdep */
Takashi Iwai92ee6162009-12-27 11:18:59 +0100508void snd_hda_shutup_pins(struct hda_codec *codec);
Takashi Iwai3be14142009-02-20 14:11:16 +0100509
Stephen Warren7c935972011-06-01 11:14:17 -0600510/* SPDIF controls */
511struct hda_spdif_out {
512 hda_nid_t nid; /* Converter nid values relate to */
513 unsigned int status; /* IEC958 status bits */
514 unsigned short ctls; /* SPDIF control bits */
515};
516struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
517 hda_nid_t nid);
Stephen Warren74b654c2011-06-01 11:14:18 -0600518void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
519void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
Stephen Warren7c935972011-06-01 11:14:17 -0600520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521/*
522 * Mixer
523 */
524int snd_hda_build_controls(struct hda_bus *bus);
Takashi Iwai6c1f45e2008-07-30 15:01:45 +0200525int snd_hda_codec_build_controls(struct hda_codec *codec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
527/*
528 * PCM
529 */
530int snd_hda_build_pcms(struct hda_bus *bus);
Takashi Iwai529bd6c2008-11-27 14:17:01 +0100531int snd_hda_codec_build_pcms(struct hda_codec *codec);
Takashi Iwaieb541332010-08-06 13:48:11 +0200532
533int snd_hda_codec_prepare(struct hda_codec *codec,
534 struct hda_pcm_stream *hinfo,
535 unsigned int stream,
536 unsigned int format,
537 struct snd_pcm_substream *substream);
538void snd_hda_codec_cleanup(struct hda_codec *codec,
539 struct hda_pcm_stream *hinfo,
540 struct snd_pcm_substream *substream);
541
Takashi Iwaid01ce992007-07-27 16:52:19 +0200542void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
543 u32 stream_tag,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 int channel_id, int format);
Takashi Iwaif0cea792010-08-13 11:56:53 +0200545void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
546 int do_now);
547#define snd_hda_codec_cleanup_stream(codec, nid) \
548 __snd_hda_codec_cleanup_stream(codec, nid, 0)
Takashi Iwai6194b992014-06-06 18:12:16 +0200549unsigned int snd_hda_calc_stream_format(struct hda_codec *codec,
550 unsigned int rate,
Takashi Iwaid01ce992007-07-27 16:52:19 +0200551 unsigned int channels,
552 unsigned int format,
Anssi Hannula32c168c2010-08-03 13:28:57 +0300553 unsigned int maxbps,
554 unsigned short spdif_ctls);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
556 unsigned int format);
557
Takashi Iwaiee81abb2012-11-08 17:12:10 +0100558extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
559
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560/*
561 * Misc
562 */
563void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
Takashi Iwaifb8d1a32009-11-10 16:02:29 +0100564void snd_hda_bus_reboot_notify(struct hda_bus *bus);
Takashi Iwai4d7fbdb2011-07-26 10:33:10 +0200565void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
Takashi Iwai9419ab62013-01-24 17:23:35 +0100566 unsigned int power_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Takashi Iwaid3d020b2012-04-26 12:11:44 +0200568int snd_hda_lock_devices(struct hda_bus *bus);
569void snd_hda_unlock_devices(struct hda_bus *bus);
Takashi Iwai59ed1ea2015-02-18 15:39:59 +0100570void snd_hda_bus_reset(struct hda_bus *bus);
Takashi Iwaid3d020b2012-04-26 12:11:44 +0200571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572/*
573 * power management
574 */
Takashi Iwai59ed1ea2015-02-18 15:39:59 +0100575extern const struct dev_pm_ops hda_codec_driver_pm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Takashi Iwai9e5341b2010-09-21 09:57:06 +0200577static inline
578int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
579{
Takashi Iwai83012a72012-08-24 18:38:08 +0200580#ifdef CONFIG_PM
Takashi Iwai9e5341b2010-09-21 09:57:06 +0200581 if (codec->patch_ops.check_power_status)
582 return codec->patch_ops.check_power_status(codec, nid);
Takashi Iwaiff2b7e22011-06-28 08:59:30 +0200583#endif
Takashi Iwai9e5341b2010-09-21 09:57:06 +0200584 return 0;
585}
Takashi Iwai9e5341b2010-09-21 09:57:06 +0200586
Takashi Iwaicb53c622007-08-10 17:21:45 +0200587/*
Matthew Ranostay50a9f792008-10-25 01:05:45 -0400588 * get widget information
589 */
590const char *snd_hda_get_jack_connectivity(u32 cfg);
591const char *snd_hda_get_jack_type(u32 cfg);
592const char *snd_hda_get_jack_location(u32 cfg);
593
594/*
Takashi Iwaicb53c622007-08-10 17:21:45 +0200595 * power saving
596 */
Takashi Iwai83012a72012-08-24 18:38:08 +0200597#ifdef CONFIG_PM
Takashi Iwaic376e2c2012-08-14 17:12:47 +0200598void snd_hda_power_save(struct hda_codec *codec, int delta, bool d3wait);
Takashi Iwaia2f63092009-11-11 09:34:25 +0100599void snd_hda_update_power_acct(struct hda_codec *codec);
Takashi Iwaicb53c622007-08-10 17:21:45 +0200600#else
Takashi Iwaic376e2c2012-08-14 17:12:47 +0200601static inline void snd_hda_power_save(struct hda_codec *codec, int delta,
602 bool d3wait) {}
Takashi Iwaicb53c622007-08-10 17:21:45 +0200603#endif
604
Takashi Iwaic376e2c2012-08-14 17:12:47 +0200605/**
606 * snd_hda_power_up - Power-up the codec
607 * @codec: HD-audio codec
608 *
609 * Increment the power-up counter and power up the hardware really when
610 * not turned on yet.
611 */
612static inline void snd_hda_power_up(struct hda_codec *codec)
613{
614 snd_hda_power_save(codec, 1, false);
615}
616
617/**
618 * snd_hda_power_up_d3wait - Power-up the codec after waiting for any pending
619 * D3 transition to complete. This differs from snd_hda_power_up() when
620 * power_transition == -1. snd_hda_power_up sees this case as a nop,
621 * snd_hda_power_up_d3wait waits for the D3 transition to complete then powers
622 * back up.
623 * @codec: HD-audio codec
624 *
625 * Cancel any power down operation hapenning on the work queue, then power up.
626 */
627static inline void snd_hda_power_up_d3wait(struct hda_codec *codec)
628{
629 snd_hda_power_save(codec, 1, true);
630}
631
632/**
633 * snd_hda_power_down - Power-down the codec
634 * @codec: HD-audio codec
635 *
636 * Decrement the power-up counter and schedules the power-off work if
637 * the counter rearches to zero.
638 */
639static inline void snd_hda_power_down(struct hda_codec *codec)
640{
641 snd_hda_power_save(codec, -1, false);
642}
643
644/**
645 * snd_hda_power_sync - Synchronize the power-save status
646 * @codec: HD-audio codec
647 *
648 * Synchronize the actual power state with the power account;
649 * called when power_save parameter is changed
650 */
651static inline void snd_hda_power_sync(struct hda_codec *codec)
652{
653 snd_hda_power_save(codec, 0, false);
654}
655
Takashi Iwai4ea6fbc2009-06-17 09:52:54 +0200656#ifdef CONFIG_SND_HDA_PATCH_LOADER
657/*
658 * patch firmware
659 */
Takashi Iwai4918cda2012-08-09 12:33:28 +0200660int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
Takashi Iwai4ea6fbc2009-06-17 09:52:54 +0200661#endif
662
Takashi Iwai1d1a4562012-09-20 20:29:13 -0700663#ifdef CONFIG_SND_HDA_DSP_LOADER
664static inline int
665snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
666 unsigned int size,
667 struct snd_dma_buffer *bufp)
668{
669 return codec->bus->ops.load_dsp_prepare(codec->bus, format, size, bufp);
670}
671static inline void
672snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start)
673{
674 return codec->bus->ops.load_dsp_trigger(codec->bus, start);
675}
676static inline void
677snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
678 struct snd_dma_buffer *dmab)
679{
680 return codec->bus->ops.load_dsp_cleanup(codec->bus, dmab);
681}
682#else
683static inline int
684snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
685 unsigned int size,
686 struct snd_dma_buffer *bufp)
687{
Ian Minetta3af4802012-09-20 20:29:19 -0700688 return -ENOSYS;
Takashi Iwai1d1a4562012-09-20 20:29:13 -0700689}
690static inline void
691snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
692static inline void
693snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
694 struct snd_dma_buffer *dmab) {}
695#endif
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697#endif /* __SOUND_HDA_CODEC_H */