Merge branch 'topic/hda-ca0132-dsp' into for-next
[~shefty/rdma-dev.git] / sound / pci / hda / hda_codec.h
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 <sound/info.h>
25 #include <sound/control.h>
26 #include <sound/pcm.h>
27 #include <sound/hwdep.h>
28
29 /*
30  * nodes
31  */
32 #define AC_NODE_ROOT            0x00
33
34 /*
35  * function group types
36  */
37 enum {
38         AC_GRP_AUDIO_FUNCTION = 0x01,
39         AC_GRP_MODEM_FUNCTION = 0x02,
40 };
41         
42 /*
43  * widget types
44  */
45 enum {
46         AC_WID_AUD_OUT,         /* Audio Out */
47         AC_WID_AUD_IN,          /* Audio In */
48         AC_WID_AUD_MIX,         /* Audio Mixer */
49         AC_WID_AUD_SEL,         /* Audio Selector */
50         AC_WID_PIN,             /* Pin Complex */
51         AC_WID_POWER,           /* Power */
52         AC_WID_VOL_KNB,         /* Volume Knob */
53         AC_WID_BEEP,            /* Beep Generator */
54         AC_WID_VENDOR = 0x0f    /* Vendor specific */
55 };
56
57 /*
58  * GET verbs
59  */
60 #define AC_VERB_GET_STREAM_FORMAT               0x0a00
61 #define AC_VERB_GET_AMP_GAIN_MUTE               0x0b00
62 #define AC_VERB_GET_PROC_COEF                   0x0c00
63 #define AC_VERB_GET_COEF_INDEX                  0x0d00
64 #define AC_VERB_PARAMETERS                      0x0f00
65 #define AC_VERB_GET_CONNECT_SEL                 0x0f01
66 #define AC_VERB_GET_CONNECT_LIST                0x0f02
67 #define AC_VERB_GET_PROC_STATE                  0x0f03
68 #define AC_VERB_GET_SDI_SELECT                  0x0f04
69 #define AC_VERB_GET_POWER_STATE                 0x0f05
70 #define AC_VERB_GET_CONV                        0x0f06
71 #define AC_VERB_GET_PIN_WIDGET_CONTROL          0x0f07
72 #define AC_VERB_GET_UNSOLICITED_RESPONSE        0x0f08
73 #define AC_VERB_GET_PIN_SENSE                   0x0f09
74 #define AC_VERB_GET_BEEP_CONTROL                0x0f0a
75 #define AC_VERB_GET_EAPD_BTLENABLE              0x0f0c
76 #define AC_VERB_GET_DIGI_CONVERT_1              0x0f0d
77 #define AC_VERB_GET_DIGI_CONVERT_2              0x0f0e /* unused */
78 #define AC_VERB_GET_VOLUME_KNOB_CONTROL         0x0f0f
79 /* f10-f1a: GPIO */
80 #define AC_VERB_GET_GPIO_DATA                   0x0f15
81 #define AC_VERB_GET_GPIO_MASK                   0x0f16
82 #define AC_VERB_GET_GPIO_DIRECTION              0x0f17
83 #define AC_VERB_GET_GPIO_WAKE_MASK              0x0f18
84 #define AC_VERB_GET_GPIO_UNSOLICITED_RSP_MASK   0x0f19
85 #define AC_VERB_GET_GPIO_STICKY_MASK            0x0f1a
86 #define AC_VERB_GET_CONFIG_DEFAULT              0x0f1c
87 /* f20: AFG/MFG */
88 #define AC_VERB_GET_SUBSYSTEM_ID                0x0f20
89 #define AC_VERB_GET_CVT_CHAN_COUNT              0x0f2d
90 #define AC_VERB_GET_HDMI_DIP_SIZE               0x0f2e
91 #define AC_VERB_GET_HDMI_ELDD                   0x0f2f
92 #define AC_VERB_GET_HDMI_DIP_INDEX              0x0f30
93 #define AC_VERB_GET_HDMI_DIP_DATA               0x0f31
94 #define AC_VERB_GET_HDMI_DIP_XMIT               0x0f32
95 #define AC_VERB_GET_HDMI_CP_CTRL                0x0f33
96 #define AC_VERB_GET_HDMI_CHAN_SLOT              0x0f34
97
98 /*
99  * SET verbs
100  */
101 #define AC_VERB_SET_STREAM_FORMAT               0x200
102 #define AC_VERB_SET_AMP_GAIN_MUTE               0x300
103 #define AC_VERB_SET_PROC_COEF                   0x400
104 #define AC_VERB_SET_COEF_INDEX                  0x500
105 #define AC_VERB_SET_CONNECT_SEL                 0x701
106 #define AC_VERB_SET_PROC_STATE                  0x703
107 #define AC_VERB_SET_SDI_SELECT                  0x704
108 #define AC_VERB_SET_POWER_STATE                 0x705
109 #define AC_VERB_SET_CHANNEL_STREAMID            0x706
110 #define AC_VERB_SET_PIN_WIDGET_CONTROL          0x707
111 #define AC_VERB_SET_UNSOLICITED_ENABLE          0x708
112 #define AC_VERB_SET_PIN_SENSE                   0x709
113 #define AC_VERB_SET_BEEP_CONTROL                0x70a
114 #define AC_VERB_SET_EAPD_BTLENABLE              0x70c
115 #define AC_VERB_SET_DIGI_CONVERT_1              0x70d
116 #define AC_VERB_SET_DIGI_CONVERT_2              0x70e
117 #define AC_VERB_SET_VOLUME_KNOB_CONTROL         0x70f
118 #define AC_VERB_SET_GPIO_DATA                   0x715
119 #define AC_VERB_SET_GPIO_MASK                   0x716
120 #define AC_VERB_SET_GPIO_DIRECTION              0x717
121 #define AC_VERB_SET_GPIO_WAKE_MASK              0x718
122 #define AC_VERB_SET_GPIO_UNSOLICITED_RSP_MASK   0x719
123 #define AC_VERB_SET_GPIO_STICKY_MASK            0x71a
124 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_0      0x71c
125 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_1      0x71d
126 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_2      0x71e
127 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_3      0x71f
128 #define AC_VERB_SET_EAPD                                0x788
129 #define AC_VERB_SET_CODEC_RESET                 0x7ff
130 #define AC_VERB_SET_CVT_CHAN_COUNT              0x72d
131 #define AC_VERB_SET_HDMI_DIP_INDEX              0x730
132 #define AC_VERB_SET_HDMI_DIP_DATA               0x731
133 #define AC_VERB_SET_HDMI_DIP_XMIT               0x732
134 #define AC_VERB_SET_HDMI_CP_CTRL                0x733
135 #define AC_VERB_SET_HDMI_CHAN_SLOT              0x734
136
137 /*
138  * Parameter IDs
139  */
140 #define AC_PAR_VENDOR_ID                0x00
141 #define AC_PAR_SUBSYSTEM_ID             0x01
142 #define AC_PAR_REV_ID                   0x02
143 #define AC_PAR_NODE_COUNT               0x04
144 #define AC_PAR_FUNCTION_TYPE            0x05
145 #define AC_PAR_AUDIO_FG_CAP             0x08
146 #define AC_PAR_AUDIO_WIDGET_CAP         0x09
147 #define AC_PAR_PCM                      0x0a
148 #define AC_PAR_STREAM                   0x0b
149 #define AC_PAR_PIN_CAP                  0x0c
150 #define AC_PAR_AMP_IN_CAP               0x0d
151 #define AC_PAR_CONNLIST_LEN             0x0e
152 #define AC_PAR_POWER_STATE              0x0f
153 #define AC_PAR_PROC_CAP                 0x10
154 #define AC_PAR_GPIO_CAP                 0x11
155 #define AC_PAR_AMP_OUT_CAP              0x12
156 #define AC_PAR_VOL_KNB_CAP              0x13
157 #define AC_PAR_HDMI_LPCM_CAP            0x20
158
159 /*
160  * AC_VERB_PARAMETERS results (32bit)
161  */
162
163 /* Function Group Type */
164 #define AC_FGT_TYPE                     (0xff<<0)
165 #define AC_FGT_TYPE_SHIFT               0
166 #define AC_FGT_UNSOL_CAP                (1<<8)
167
168 /* Audio Function Group Capabilities */
169 #define AC_AFG_OUT_DELAY                (0xf<<0)
170 #define AC_AFG_IN_DELAY                 (0xf<<8)
171 #define AC_AFG_BEEP_GEN                 (1<<16)
172
173 /* Audio Widget Capabilities */
174 #define AC_WCAP_STEREO                  (1<<0)  /* stereo I/O */
175 #define AC_WCAP_IN_AMP                  (1<<1)  /* AMP-in present */
176 #define AC_WCAP_OUT_AMP                 (1<<2)  /* AMP-out present */
177 #define AC_WCAP_AMP_OVRD                (1<<3)  /* AMP-parameter override */
178 #define AC_WCAP_FORMAT_OVRD             (1<<4)  /* format override */
179 #define AC_WCAP_STRIPE                  (1<<5)  /* stripe */
180 #define AC_WCAP_PROC_WID                (1<<6)  /* Proc Widget */
181 #define AC_WCAP_UNSOL_CAP               (1<<7)  /* Unsol capable */
182 #define AC_WCAP_CONN_LIST               (1<<8)  /* connection list */
183 #define AC_WCAP_DIGITAL                 (1<<9)  /* digital I/O */
184 #define AC_WCAP_POWER                   (1<<10) /* power control */
185 #define AC_WCAP_LR_SWAP                 (1<<11) /* L/R swap */
186 #define AC_WCAP_CP_CAPS                 (1<<12) /* content protection */
187 #define AC_WCAP_CHAN_CNT_EXT            (7<<13) /* channel count ext */
188 #define AC_WCAP_DELAY                   (0xf<<16)
189 #define AC_WCAP_DELAY_SHIFT             16
190 #define AC_WCAP_TYPE                    (0xf<<20)
191 #define AC_WCAP_TYPE_SHIFT              20
192
193 /* supported PCM rates and bits */
194 #define AC_SUPPCM_RATES                 (0xfff << 0)
195 #define AC_SUPPCM_BITS_8                (1<<16)
196 #define AC_SUPPCM_BITS_16               (1<<17)
197 #define AC_SUPPCM_BITS_20               (1<<18)
198 #define AC_SUPPCM_BITS_24               (1<<19)
199 #define AC_SUPPCM_BITS_32               (1<<20)
200
201 /* supported PCM stream format */
202 #define AC_SUPFMT_PCM                   (1<<0)
203 #define AC_SUPFMT_FLOAT32               (1<<1)
204 #define AC_SUPFMT_AC3                   (1<<2)
205
206 /* GP I/O count */
207 #define AC_GPIO_IO_COUNT                (0xff<<0)
208 #define AC_GPIO_O_COUNT                 (0xff<<8)
209 #define AC_GPIO_O_COUNT_SHIFT           8
210 #define AC_GPIO_I_COUNT                 (0xff<<16)
211 #define AC_GPIO_I_COUNT_SHIFT           16
212 #define AC_GPIO_UNSOLICITED             (1<<30)
213 #define AC_GPIO_WAKE                    (1<<31)
214
215 /* Converter stream, channel */
216 #define AC_CONV_CHANNEL                 (0xf<<0)
217 #define AC_CONV_STREAM                  (0xf<<4)
218 #define AC_CONV_STREAM_SHIFT            4
219
220 /* Input converter SDI select */
221 #define AC_SDI_SELECT                   (0xf<<0)
222
223 /* stream format id */
224 #define AC_FMT_CHAN_SHIFT               0
225 #define AC_FMT_CHAN_MASK                (0x0f << 0)
226 #define AC_FMT_BITS_SHIFT               4
227 #define AC_FMT_BITS_MASK                (7 << 4)
228 #define AC_FMT_BITS_8                   (0 << 4)
229 #define AC_FMT_BITS_16                  (1 << 4)
230 #define AC_FMT_BITS_20                  (2 << 4)
231 #define AC_FMT_BITS_24                  (3 << 4)
232 #define AC_FMT_BITS_32                  (4 << 4)
233 #define AC_FMT_DIV_SHIFT                8
234 #define AC_FMT_DIV_MASK                 (7 << 8)
235 #define AC_FMT_MULT_SHIFT               11
236 #define AC_FMT_MULT_MASK                (7 << 11)
237 #define AC_FMT_BASE_SHIFT               14
238 #define AC_FMT_BASE_48K                 (0 << 14)
239 #define AC_FMT_BASE_44K                 (1 << 14)
240 #define AC_FMT_TYPE_SHIFT               15
241 #define AC_FMT_TYPE_PCM                 (0 << 15)
242 #define AC_FMT_TYPE_NON_PCM             (1 << 15)
243
244 /* Unsolicited response control */
245 #define AC_UNSOL_TAG                    (0x3f<<0)
246 #define AC_UNSOL_ENABLED                (1<<7)
247 #define AC_USRSP_EN                     AC_UNSOL_ENABLED
248
249 /* Unsolicited responses */
250 #define AC_UNSOL_RES_TAG                (0x3f<<26)
251 #define AC_UNSOL_RES_TAG_SHIFT          26
252 #define AC_UNSOL_RES_SUBTAG             (0x1f<<21)
253 #define AC_UNSOL_RES_SUBTAG_SHIFT       21
254 #define AC_UNSOL_RES_ELDV               (1<<1)  /* ELD Data valid (for HDMI) */
255 #define AC_UNSOL_RES_PD                 (1<<0)  /* pinsense detect */
256 #define AC_UNSOL_RES_CP_STATE           (1<<1)  /* content protection */
257 #define AC_UNSOL_RES_CP_READY           (1<<0)  /* content protection */
258
259 /* Pin widget capabilies */
260 #define AC_PINCAP_IMP_SENSE             (1<<0)  /* impedance sense capable */
261 #define AC_PINCAP_TRIG_REQ              (1<<1)  /* trigger required */
262 #define AC_PINCAP_PRES_DETECT           (1<<2)  /* presence detect capable */
263 #define AC_PINCAP_HP_DRV                (1<<3)  /* headphone drive capable */
264 #define AC_PINCAP_OUT                   (1<<4)  /* output capable */
265 #define AC_PINCAP_IN                    (1<<5)  /* input capable */
266 #define AC_PINCAP_BALANCE               (1<<6)  /* balanced I/O capable */
267 /* Note: This LR_SWAP pincap is defined in the Realtek ALC883 specification,
268  *       but is marked reserved in the Intel HDA specification.
269  */
270 #define AC_PINCAP_LR_SWAP               (1<<7)  /* L/R swap */
271 /* Note: The same bit as LR_SWAP is newly defined as HDMI capability
272  *       in HD-audio specification
273  */
274 #define AC_PINCAP_HDMI                  (1<<7)  /* HDMI pin */
275 #define AC_PINCAP_DP                    (1<<24) /* DisplayPort pin, can
276                                                  * coexist with AC_PINCAP_HDMI
277                                                  */
278 #define AC_PINCAP_VREF                  (0x37<<8)
279 #define AC_PINCAP_VREF_SHIFT            8
280 #define AC_PINCAP_EAPD                  (1<<16) /* EAPD capable */
281 #define AC_PINCAP_HBR                   (1<<27) /* High Bit Rate */
282 /* Vref status (used in pin cap) */
283 #define AC_PINCAP_VREF_HIZ              (1<<0)  /* Hi-Z */
284 #define AC_PINCAP_VREF_50               (1<<1)  /* 50% */
285 #define AC_PINCAP_VREF_GRD              (1<<2)  /* ground */
286 #define AC_PINCAP_VREF_80               (1<<4)  /* 80% */
287 #define AC_PINCAP_VREF_100              (1<<5)  /* 100% */
288
289 /* Amplifier capabilities */
290 #define AC_AMPCAP_OFFSET                (0x7f<<0)  /* 0dB offset */
291 #define AC_AMPCAP_OFFSET_SHIFT          0
292 #define AC_AMPCAP_NUM_STEPS             (0x7f<<8)  /* number of steps */
293 #define AC_AMPCAP_NUM_STEPS_SHIFT       8
294 #define AC_AMPCAP_STEP_SIZE             (0x7f<<16) /* step size 0-32dB
295                                                     * in 0.25dB
296                                                     */
297 #define AC_AMPCAP_STEP_SIZE_SHIFT       16
298 #define AC_AMPCAP_MUTE                  (1<<31)    /* mute capable */
299 #define AC_AMPCAP_MUTE_SHIFT            31
300
301 /* driver-specific amp-caps: using bits 24-30 */
302 #define AC_AMPCAP_MIN_MUTE              (1 << 30) /* min-volume = mute */
303
304 /* Connection list */
305 #define AC_CLIST_LENGTH                 (0x7f<<0)
306 #define AC_CLIST_LONG                   (1<<7)
307
308 /* Supported power status */
309 #define AC_PWRST_D0SUP                  (1<<0)
310 #define AC_PWRST_D1SUP                  (1<<1)
311 #define AC_PWRST_D2SUP                  (1<<2)
312 #define AC_PWRST_D3SUP                  (1<<3)
313 #define AC_PWRST_D3COLDSUP              (1<<4)
314 #define AC_PWRST_S3D3COLDSUP            (1<<29)
315 #define AC_PWRST_CLKSTOP                (1<<30)
316 #define AC_PWRST_EPSS                   (1U<<31)
317
318 /* Power state values */
319 #define AC_PWRST_SETTING                (0xf<<0)
320 #define AC_PWRST_ACTUAL                 (0xf<<4)
321 #define AC_PWRST_ACTUAL_SHIFT           4
322 #define AC_PWRST_D0                     0x00
323 #define AC_PWRST_D1                     0x01
324 #define AC_PWRST_D2                     0x02
325 #define AC_PWRST_D3                     0x03
326 #define AC_PWRST_ERROR                  (1<<8)
327 #define AC_PWRST_CLK_STOP_OK            (1<<9)
328 #define AC_PWRST_SETTING_RESET          (1<<10)
329
330 /* Processing capabilies */
331 #define AC_PCAP_BENIGN                  (1<<0)
332 #define AC_PCAP_NUM_COEF                (0xff<<8)
333 #define AC_PCAP_NUM_COEF_SHIFT          8
334
335 /* Volume knobs capabilities */
336 #define AC_KNBCAP_NUM_STEPS             (0x7f<<0)
337 #define AC_KNBCAP_DELTA                 (1<<7)
338
339 /* HDMI LPCM capabilities */
340 #define AC_LPCMCAP_48K_CP_CHNS          (0x0f<<0) /* max channels w/ CP-on */   
341 #define AC_LPCMCAP_48K_NO_CHNS          (0x0f<<4) /* max channels w/o CP-on */
342 #define AC_LPCMCAP_48K_20BIT            (1<<8)  /* 20b bitrate supported */
343 #define AC_LPCMCAP_48K_24BIT            (1<<9)  /* 24b bitrate supported */
344 #define AC_LPCMCAP_96K_CP_CHNS          (0x0f<<10) /* max channels w/ CP-on */  
345 #define AC_LPCMCAP_96K_NO_CHNS          (0x0f<<14) /* max channels w/o CP-on */
346 #define AC_LPCMCAP_96K_20BIT            (1<<18) /* 20b bitrate supported */
347 #define AC_LPCMCAP_96K_24BIT            (1<<19) /* 24b bitrate supported */
348 #define AC_LPCMCAP_192K_CP_CHNS         (0x0f<<20) /* max channels w/ CP-on */  
349 #define AC_LPCMCAP_192K_NO_CHNS         (0x0f<<24) /* max channels w/o CP-on */
350 #define AC_LPCMCAP_192K_20BIT           (1<<28) /* 20b bitrate supported */
351 #define AC_LPCMCAP_192K_24BIT           (1<<29) /* 24b bitrate supported */
352 #define AC_LPCMCAP_44K                  (1<<30) /* 44.1kHz support */
353 #define AC_LPCMCAP_44K_MS               (1<<31) /* 44.1kHz-multiplies support */
354
355 /*
356  * Control Parameters
357  */
358
359 /* Amp gain/mute */
360 #define AC_AMP_MUTE                     (1<<7)
361 #define AC_AMP_GAIN                     (0x7f)
362 #define AC_AMP_GET_INDEX                (0xf<<0)
363
364 #define AC_AMP_GET_LEFT                 (1<<13)
365 #define AC_AMP_GET_RIGHT                (0<<13)
366 #define AC_AMP_GET_OUTPUT               (1<<15)
367 #define AC_AMP_GET_INPUT                (0<<15)
368
369 #define AC_AMP_SET_INDEX                (0xf<<8)
370 #define AC_AMP_SET_INDEX_SHIFT          8
371 #define AC_AMP_SET_RIGHT                (1<<12)
372 #define AC_AMP_SET_LEFT                 (1<<13)
373 #define AC_AMP_SET_INPUT                (1<<14)
374 #define AC_AMP_SET_OUTPUT               (1<<15)
375
376 /* DIGITAL1 bits */
377 #define AC_DIG1_ENABLE                  (1<<0)
378 #define AC_DIG1_V                       (1<<1)
379 #define AC_DIG1_VCFG                    (1<<2)
380 #define AC_DIG1_EMPHASIS                (1<<3)
381 #define AC_DIG1_COPYRIGHT               (1<<4)
382 #define AC_DIG1_NONAUDIO                (1<<5)
383 #define AC_DIG1_PROFESSIONAL            (1<<6)
384 #define AC_DIG1_LEVEL                   (1<<7)
385
386 /* DIGITAL2 bits */
387 #define AC_DIG2_CC                      (0x7f<<0)
388
389 /* DIGITAL3 bits */
390 #define AC_DIG3_ICT                     (0xf<<0)
391 #define AC_DIG3_KAE                     (1<<7)
392
393 /* Pin widget control - 8bit */
394 #define AC_PINCTL_EPT                   (0x3<<0)
395 #define AC_PINCTL_EPT_NATIVE            0
396 #define AC_PINCTL_EPT_HBR               3
397 #define AC_PINCTL_VREFEN                (0x7<<0)
398 #define AC_PINCTL_VREF_HIZ              0       /* Hi-Z */
399 #define AC_PINCTL_VREF_50               1       /* 50% */
400 #define AC_PINCTL_VREF_GRD              2       /* ground */
401 #define AC_PINCTL_VREF_80               4       /* 80% */
402 #define AC_PINCTL_VREF_100              5       /* 100% */
403 #define AC_PINCTL_IN_EN                 (1<<5)
404 #define AC_PINCTL_OUT_EN                (1<<6)
405 #define AC_PINCTL_HP_EN                 (1<<7)
406
407 /* Pin sense - 32bit */
408 #define AC_PINSENSE_IMPEDANCE_MASK      (0x7fffffff)
409 #define AC_PINSENSE_PRESENCE            (1<<31)
410 #define AC_PINSENSE_ELDV                (1<<30) /* ELD valid (HDMI) */
411
412 /* EAPD/BTL enable - 32bit */
413 #define AC_EAPDBTL_BALANCED             (1<<0)
414 #define AC_EAPDBTL_EAPD                 (1<<1)
415 #define AC_EAPDBTL_LR_SWAP              (1<<2)
416
417 /* HDMI ELD data */
418 #define AC_ELDD_ELD_VALID               (1<<31)
419 #define AC_ELDD_ELD_DATA                0xff
420
421 /* HDMI DIP size */
422 #define AC_DIPSIZE_ELD_BUF              (1<<3) /* ELD buf size of packet size */
423 #define AC_DIPSIZE_PACK_IDX             (0x07<<0) /* packet index */
424
425 /* HDMI DIP index */
426 #define AC_DIPIDX_PACK_IDX              (0x07<<5) /* packet idnex */
427 #define AC_DIPIDX_BYTE_IDX              (0x1f<<0) /* byte index */
428
429 /* HDMI DIP xmit (transmit) control */
430 #define AC_DIPXMIT_MASK                 (0x3<<6)
431 #define AC_DIPXMIT_DISABLE              (0x0<<6) /* disable xmit */
432 #define AC_DIPXMIT_ONCE                 (0x2<<6) /* xmit once then disable */
433 #define AC_DIPXMIT_BEST                 (0x3<<6) /* best effort */
434
435 /* HDMI content protection (CP) control */
436 #define AC_CPCTRL_CES                   (1<<9) /* current encryption state */
437 #define AC_CPCTRL_READY                 (1<<8) /* ready bit */
438 #define AC_CPCTRL_SUBTAG                (0x1f<<3) /* subtag for unsol-resp */
439 #define AC_CPCTRL_STATE                 (3<<0) /* current CP request state */
440
441 /* Converter channel <-> HDMI slot mapping */
442 #define AC_CVTMAP_HDMI_SLOT             (0xf<<0) /* HDMI slot number */
443 #define AC_CVTMAP_CHAN                  (0xf<<4) /* converter channel number */
444
445 /* configuration default - 32bit */
446 #define AC_DEFCFG_SEQUENCE              (0xf<<0)
447 #define AC_DEFCFG_DEF_ASSOC             (0xf<<4)
448 #define AC_DEFCFG_ASSOC_SHIFT           4
449 #define AC_DEFCFG_MISC                  (0xf<<8)
450 #define AC_DEFCFG_MISC_SHIFT            8
451 #define AC_DEFCFG_MISC_NO_PRESENCE      (1<<0)
452 #define AC_DEFCFG_COLOR                 (0xf<<12)
453 #define AC_DEFCFG_COLOR_SHIFT           12
454 #define AC_DEFCFG_CONN_TYPE             (0xf<<16)
455 #define AC_DEFCFG_CONN_TYPE_SHIFT       16
456 #define AC_DEFCFG_DEVICE                (0xf<<20)
457 #define AC_DEFCFG_DEVICE_SHIFT          20
458 #define AC_DEFCFG_LOCATION              (0x3f<<24)
459 #define AC_DEFCFG_LOCATION_SHIFT        24
460 #define AC_DEFCFG_PORT_CONN             (0x3<<30)
461 #define AC_DEFCFG_PORT_CONN_SHIFT       30
462
463 /* device device types (0x0-0xf) */
464 enum {
465         AC_JACK_LINE_OUT,
466         AC_JACK_SPEAKER,
467         AC_JACK_HP_OUT,
468         AC_JACK_CD,
469         AC_JACK_SPDIF_OUT,
470         AC_JACK_DIG_OTHER_OUT,
471         AC_JACK_MODEM_LINE_SIDE,
472         AC_JACK_MODEM_HAND_SIDE,
473         AC_JACK_LINE_IN,
474         AC_JACK_AUX,
475         AC_JACK_MIC_IN,
476         AC_JACK_TELEPHONY,
477         AC_JACK_SPDIF_IN,
478         AC_JACK_DIG_OTHER_IN,
479         AC_JACK_OTHER = 0xf,
480 };
481
482 /* jack connection types (0x0-0xf) */
483 enum {
484         AC_JACK_CONN_UNKNOWN,
485         AC_JACK_CONN_1_8,
486         AC_JACK_CONN_1_4,
487         AC_JACK_CONN_ATAPI,
488         AC_JACK_CONN_RCA,
489         AC_JACK_CONN_OPTICAL,
490         AC_JACK_CONN_OTHER_DIGITAL,
491         AC_JACK_CONN_OTHER_ANALOG,
492         AC_JACK_CONN_DIN,
493         AC_JACK_CONN_XLR,
494         AC_JACK_CONN_RJ11,
495         AC_JACK_CONN_COMB,
496         AC_JACK_CONN_OTHER = 0xf,
497 };
498
499 /* jack colors (0x0-0xf) */
500 enum {
501         AC_JACK_COLOR_UNKNOWN,
502         AC_JACK_COLOR_BLACK,
503         AC_JACK_COLOR_GREY,
504         AC_JACK_COLOR_BLUE,
505         AC_JACK_COLOR_GREEN,
506         AC_JACK_COLOR_RED,
507         AC_JACK_COLOR_ORANGE,
508         AC_JACK_COLOR_YELLOW,
509         AC_JACK_COLOR_PURPLE,
510         AC_JACK_COLOR_PINK,
511         AC_JACK_COLOR_WHITE = 0xe,
512         AC_JACK_COLOR_OTHER,
513 };
514
515 /* Jack location (0x0-0x3f) */
516 /* common case */
517 enum {
518         AC_JACK_LOC_NONE,
519         AC_JACK_LOC_REAR,
520         AC_JACK_LOC_FRONT,
521         AC_JACK_LOC_LEFT,
522         AC_JACK_LOC_RIGHT,
523         AC_JACK_LOC_TOP,
524         AC_JACK_LOC_BOTTOM,
525 };
526 /* bits 4-5 */
527 enum {
528         AC_JACK_LOC_EXTERNAL = 0x00,
529         AC_JACK_LOC_INTERNAL = 0x10,
530         AC_JACK_LOC_SEPARATE = 0x20,
531         AC_JACK_LOC_OTHER    = 0x30,
532 };
533 enum {
534         /* external on primary chasis */
535         AC_JACK_LOC_REAR_PANEL = 0x07,
536         AC_JACK_LOC_DRIVE_BAY,
537         /* internal */
538         AC_JACK_LOC_RISER = 0x17,
539         AC_JACK_LOC_HDMI,
540         AC_JACK_LOC_ATAPI,
541         /* others */
542         AC_JACK_LOC_MOBILE_IN = 0x37,
543         AC_JACK_LOC_MOBILE_OUT,
544 };
545
546 /* Port connectivity (0-3) */
547 enum {
548         AC_JACK_PORT_COMPLEX,
549         AC_JACK_PORT_NONE,
550         AC_JACK_PORT_FIXED,
551         AC_JACK_PORT_BOTH,
552 };
553
554 /* max. connections to a widget */
555 #define HDA_MAX_CONNECTIONS     32
556
557 /* max. codec address */
558 #define HDA_MAX_CODEC_ADDRESS   0x0f
559
560 /*
561  * generic arrays
562  */
563 struct snd_array {
564         unsigned int used;
565         unsigned int alloced;
566         unsigned int elem_size;
567         unsigned int alloc_align;
568         void *list;
569 };
570
571 void *snd_array_new(struct snd_array *array);
572 void snd_array_free(struct snd_array *array);
573 static inline void snd_array_init(struct snd_array *array, unsigned int size,
574                                   unsigned int align)
575 {
576         array->elem_size = size;
577         array->alloc_align = align;
578 }
579
580 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
581 {
582         return array->list + idx * array->elem_size;
583 }
584
585 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
586 {
587         return (unsigned long)(ptr - array->list) / array->elem_size;
588 }
589
590 /*
591  * Structures
592  */
593
594 struct hda_bus;
595 struct hda_beep;
596 struct hda_codec;
597 struct hda_pcm;
598 struct hda_pcm_stream;
599 struct hda_bus_unsolicited;
600
601 /* NID type */
602 typedef u16 hda_nid_t;
603
604 /* bus operators */
605 struct hda_bus_ops {
606         /* send a single command */
607         int (*command)(struct hda_bus *bus, unsigned int cmd);
608         /* get a response from the last command */
609         unsigned int (*get_response)(struct hda_bus *bus, unsigned int addr);
610         /* free the private data */
611         void (*private_free)(struct hda_bus *);
612         /* attach a PCM stream */
613         int (*attach_pcm)(struct hda_bus *bus, struct hda_codec *codec,
614                           struct hda_pcm *pcm);
615         /* reset bus for retry verb */
616         void (*bus_reset)(struct hda_bus *bus);
617 #ifdef CONFIG_PM
618         /* notify power-up/down from codec to controller */
619         void (*pm_notify)(struct hda_bus *bus, bool power_up);
620 #endif
621 #ifdef CONFIG_SND_HDA_DSP_LOADER
622         /* prepare DSP transfer */
623         int (*load_dsp_prepare)(struct hda_bus *bus, unsigned int format,
624                                 unsigned int byte_size,
625                                 struct snd_dma_buffer *bufp);
626         /* start/stop DSP transfer */
627         void (*load_dsp_trigger)(struct hda_bus *bus, bool start);
628         /* clean up DSP transfer */
629         void (*load_dsp_cleanup)(struct hda_bus *bus,
630                                  struct snd_dma_buffer *dmab);
631 #endif
632 };
633
634 /* template to pass to the bus constructor */
635 struct hda_bus_template {
636         void *private_data;
637         struct pci_dev *pci;
638         const char *modelname;
639         int *power_save;
640         struct hda_bus_ops ops;
641 };
642
643 /*
644  * codec bus
645  *
646  * each controller needs to creata a hda_bus to assign the accessor.
647  * A hda_bus contains several codecs in the list codec_list.
648  */
649 struct hda_bus {
650         struct snd_card *card;
651
652         /* copied from template */
653         void *private_data;
654         struct pci_dev *pci;
655         const char *modelname;
656         int *power_save;
657         struct hda_bus_ops ops;
658
659         /* codec linked list */
660         struct list_head codec_list;
661         /* link caddr -> codec */
662         struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
663
664         struct mutex cmd_mutex;
665         struct mutex prepare_mutex;
666
667         /* unsolicited event queue */
668         struct hda_bus_unsolicited *unsol;
669         char workq_name[16];
670         struct workqueue_struct *workq; /* common workqueue for codecs */
671
672         /* assigned PCMs */
673         DECLARE_BITMAP(pcm_dev_bits, SNDRV_PCM_DEVICES);
674
675         /* misc op flags */
676         unsigned int needs_damn_long_delay :1;
677         unsigned int allow_bus_reset:1; /* allow bus reset at fatal error */
678         unsigned int sync_write:1;      /* sync after verb write */
679         /* status for codec/controller */
680         unsigned int shutdown :1;       /* being unloaded */
681         unsigned int rirb_error:1;      /* error in codec communication */
682         unsigned int response_reset:1;  /* controller was reset */
683         unsigned int in_reset:1;        /* during reset operation */
684         unsigned int power_keep_link_on:1; /* don't power off HDA link */
685 };
686
687 /*
688  * codec preset
689  *
690  * Known codecs have the patch to build and set up the controls/PCMs
691  * better than the generic parser.
692  */
693 struct hda_codec_preset {
694         unsigned int id;
695         unsigned int mask;
696         unsigned int subs;
697         unsigned int subs_mask;
698         unsigned int rev;
699         hda_nid_t afg, mfg;
700         const char *name;
701         int (*patch)(struct hda_codec *codec);
702 };
703         
704 struct hda_codec_preset_list {
705         const struct hda_codec_preset *preset;
706         struct module *owner;
707         struct list_head list;
708 };
709
710 /* initial hook */
711 int snd_hda_add_codec_preset(struct hda_codec_preset_list *preset);
712 int snd_hda_delete_codec_preset(struct hda_codec_preset_list *preset);
713
714 /* ops set by the preset patch */
715 struct hda_codec_ops {
716         int (*build_controls)(struct hda_codec *codec);
717         int (*build_pcms)(struct hda_codec *codec);
718         int (*init)(struct hda_codec *codec);
719         void (*free)(struct hda_codec *codec);
720         void (*unsol_event)(struct hda_codec *codec, unsigned int res);
721         void (*set_power_state)(struct hda_codec *codec, hda_nid_t fg,
722                                 unsigned int power_state);
723 #ifdef CONFIG_PM
724         int (*suspend)(struct hda_codec *codec);
725         int (*resume)(struct hda_codec *codec);
726         int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
727 #endif
728         void (*reboot_notify)(struct hda_codec *codec);
729 };
730
731 /* record for amp information cache */
732 struct hda_cache_head {
733         u32 key:31;             /* hash key */
734         u32 dirty:1;
735         u16 val;                /* assigned value */
736         u16 next;
737 };
738
739 struct hda_amp_info {
740         struct hda_cache_head head;
741         u32 amp_caps;           /* amp capabilities */
742         u16 vol[2];             /* current volume & mute */
743 };
744
745 struct hda_cache_rec {
746         u16 hash[64];                   /* hash table for index */
747         struct snd_array buf;           /* record entries */
748 };
749
750 /* PCM callbacks */
751 struct hda_pcm_ops {
752         int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
753                     struct snd_pcm_substream *substream);
754         int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
755                      struct snd_pcm_substream *substream);
756         int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
757                        unsigned int stream_tag, unsigned int format,
758                        struct snd_pcm_substream *substream);
759         int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
760                        struct snd_pcm_substream *substream);
761 };
762
763 /* PCM information for each substream */
764 struct hda_pcm_stream {
765         unsigned int substreams;        /* number of substreams, 0 = not exist*/
766         unsigned int channels_min;      /* min. number of channels */
767         unsigned int channels_max;      /* max. number of channels */
768         hda_nid_t nid;  /* default NID to query rates/formats/bps, or set up */
769         u32 rates;      /* supported rates */
770         u64 formats;    /* supported formats (SNDRV_PCM_FMTBIT_) */
771         unsigned int maxbps;    /* supported max. bit per sample */
772         const struct snd_pcm_chmap_elem *chmap; /* chmap to override */
773         struct hda_pcm_ops ops;
774 };
775
776 /* PCM types */
777 enum {
778         HDA_PCM_TYPE_AUDIO,
779         HDA_PCM_TYPE_SPDIF,
780         HDA_PCM_TYPE_HDMI,
781         HDA_PCM_TYPE_MODEM,
782         HDA_PCM_NTYPES
783 };
784
785 /* for PCM creation */
786 struct hda_pcm {
787         char *name;
788         struct hda_pcm_stream stream[2];
789         unsigned int pcm_type;  /* HDA_PCM_TYPE_XXX */
790         int device;             /* device number to assign */
791         struct snd_pcm *pcm;    /* assigned PCM instance */
792         bool own_chmap;         /* codec driver provides own channel maps */
793 };
794
795 /* codec information */
796 struct hda_codec {
797         struct hda_bus *bus;
798         unsigned int addr;      /* codec addr*/
799         struct list_head list;  /* list point */
800
801         hda_nid_t afg;  /* AFG node id */
802         hda_nid_t mfg;  /* MFG node id */
803
804         /* ids */
805         u8 afg_function_id;
806         u8 mfg_function_id;
807         u8 afg_unsol;
808         u8 mfg_unsol;
809         u32 vendor_id;
810         u32 subsystem_id;
811         u32 revision_id;
812
813         /* detected preset */
814         const struct hda_codec_preset *preset;
815         struct module *owner;
816         const char *vendor_name;        /* codec vendor name */
817         const char *chip_name;          /* codec chip name */
818         const char *modelname;  /* model name for preset */
819
820         /* set by patch */
821         struct hda_codec_ops patch_ops;
822
823         /* PCM to create, set by patch_ops.build_pcms callback */
824         unsigned int num_pcms;
825         struct hda_pcm *pcm_info;
826
827         /* codec specific info */
828         void *spec;
829
830         /* beep device */
831         struct hda_beep *beep;
832         unsigned int beep_mode;
833
834         /* widget capabilities cache */
835         unsigned int num_nodes;
836         hda_nid_t start_nid;
837         u32 *wcaps;
838
839         struct snd_array mixers;        /* list of assigned mixer elements */
840         struct snd_array nids;          /* list of mapped mixer elements */
841
842         struct hda_cache_rec amp_cache; /* cache for amp access */
843         struct hda_cache_rec cmd_cache; /* cache for other commands */
844
845         struct list_head conn_list;     /* linked-list of connection-list */
846
847         struct mutex spdif_mutex;
848         struct mutex control_mutex;
849         struct mutex hash_mutex;
850         struct snd_array spdif_out;
851         unsigned int spdif_in_enable;   /* SPDIF input enable? */
852         int primary_dig_out_type;       /* primary digital out PCM type */
853         const hda_nid_t *slave_dig_outs; /* optional digital out slave widgets */
854         struct snd_array init_pins;     /* initial (BIOS) pin configurations */
855         struct snd_array driver_pins;   /* pin configs set by codec parser */
856         struct snd_array cvt_setups;    /* audio convert setups */
857
858 #ifdef CONFIG_SND_HDA_HWDEP
859         struct mutex user_mutex;
860         struct snd_hwdep *hwdep;        /* assigned hwdep device */
861         struct snd_array init_verbs;    /* additional init verbs */
862         struct snd_array hints;         /* additional hints */
863         struct snd_array user_pins;     /* default pin configs to override */
864 #endif
865
866         /* misc flags */
867         unsigned int spdif_status_reset :1; /* needs to toggle SPDIF for each
868                                              * status change
869                                              * (e.g. Realtek codecs)
870                                              */
871         unsigned int pin_amp_workaround:1; /* pin out-amp takes index
872                                             * (e.g. Conexant codecs)
873                                             */
874         unsigned int single_adc_amp:1; /* adc in-amp takes no index
875                                         * (e.g. CX20549 codec)
876                                         */
877         unsigned int no_sticky_stream:1; /* no sticky-PCM stream assignment */
878         unsigned int pins_shutup:1;     /* pins are shut up */
879         unsigned int no_trigger_sense:1; /* don't trigger at pin-sensing */
880         unsigned int no_jack_detect:1;  /* Machine has no jack-detection */
881         unsigned int inv_eapd:1; /* broken h/w: inverted EAPD control */
882         unsigned int inv_jack_detect:1; /* broken h/w: inverted detection bit */
883         unsigned int pcm_format_first:1; /* PCM format must be set first */
884         unsigned int epss:1;            /* supporting EPSS? */
885         unsigned int cached_write:1;    /* write only to caches */
886 #ifdef CONFIG_PM
887         unsigned int power_on :1;       /* current (global) power-state */
888         unsigned int d3_stop_clk:1;     /* support D3 operation without BCLK */
889         unsigned int pm_down_notified:1; /* PM notified to controller */
890         unsigned int in_pm:1;           /* suspend/resume being performed */
891         int power_transition;   /* power-state in transition */
892         int power_count;        /* current (global) power refcount */
893         struct delayed_work power_work; /* delayed task for powerdown */
894         unsigned long power_on_acct;
895         unsigned long power_off_acct;
896         unsigned long power_jiffies;
897         spinlock_t power_lock;
898 #endif
899
900         /* filter the requested power state per nid */
901         unsigned int (*power_filter)(struct hda_codec *codec, hda_nid_t nid,
902                                      unsigned int power_state);
903
904         /* codec-specific additional proc output */
905         void (*proc_widget_hook)(struct snd_info_buffer *buffer,
906                                  struct hda_codec *codec, hda_nid_t nid);
907
908         /* jack detection */
909         struct snd_array jacktbl;
910         unsigned long jackpoll_interval; /* In jiffies. Zero means no poll, rely on unsol events */
911         struct delayed_work jackpoll_work;
912
913 #ifdef CONFIG_SND_HDA_INPUT_JACK
914         /* jack detection */
915         struct snd_array jacks;
916 #endif
917
918         /* fix-up list */
919         int fixup_id;
920         const struct hda_fixup *fixup_list;
921         const char *fixup_name;
922
923         /* additional init verbs */
924         struct snd_array verbs;
925 };
926
927 /* direction */
928 enum {
929         HDA_INPUT, HDA_OUTPUT
930 };
931
932
933 /*
934  * constructors
935  */
936 int snd_hda_bus_new(struct snd_card *card, const struct hda_bus_template *temp,
937                     struct hda_bus **busp);
938 int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
939                       struct hda_codec **codecp);
940 int snd_hda_codec_configure(struct hda_codec *codec);
941
942 /*
943  * low level functions
944  */
945 unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
946                                 int direct,
947                                 unsigned int verb, unsigned int parm);
948 int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int direct,
949                         unsigned int verb, unsigned int parm);
950 #define snd_hda_param_read(codec, nid, param) \
951         snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
952 int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
953                           hda_nid_t *start_id);
954 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
955                             hda_nid_t *conn_list, int max_conns);
956 static inline int
957 snd_hda_get_num_conns(struct hda_codec *codec, hda_nid_t nid)
958 {
959         return snd_hda_get_connections(codec, nid, NULL, 0);
960 }
961 int snd_hda_get_raw_connections(struct hda_codec *codec, hda_nid_t nid,
962                             hda_nid_t *conn_list, int max_conns);
963 int snd_hda_get_conn_list(struct hda_codec *codec, hda_nid_t nid,
964                           const hda_nid_t **listp);
965 int snd_hda_override_conn_list(struct hda_codec *codec, hda_nid_t nid, int nums,
966                           const hda_nid_t *list);
967 int snd_hda_get_conn_index(struct hda_codec *codec, hda_nid_t mux,
968                            hda_nid_t nid, int recursive);
969 int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
970                                 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
971
972 struct hda_verb {
973         hda_nid_t nid;
974         u32 verb;
975         u32 param;
976 };
977
978 void snd_hda_sequence_write(struct hda_codec *codec,
979                             const struct hda_verb *seq);
980
981 /* unsolicited event */
982 int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
983
984 /* cached write */
985 int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
986                               int direct, unsigned int verb, unsigned int parm);
987 void snd_hda_sequence_write_cache(struct hda_codec *codec,
988                                   const struct hda_verb *seq);
989 int snd_hda_codec_update_cache(struct hda_codec *codec, hda_nid_t nid,
990                               int direct, unsigned int verb, unsigned int parm);
991 void snd_hda_codec_resume_cache(struct hda_codec *codec);
992 /* both for cmd & amp caches */
993 void snd_hda_codec_flush_cache(struct hda_codec *codec);
994
995 /* the struct for codec->pin_configs */
996 struct hda_pincfg {
997         hda_nid_t nid;
998         unsigned char ctrl;     /* original pin control value */
999         unsigned char target;   /* target pin control value */
1000         unsigned int cfg;       /* default configuration */
1001 };
1002
1003 unsigned int snd_hda_codec_get_pincfg(struct hda_codec *codec, hda_nid_t nid);
1004 int snd_hda_codec_set_pincfg(struct hda_codec *codec, hda_nid_t nid,
1005                              unsigned int cfg);
1006 int snd_hda_add_pincfg(struct hda_codec *codec, struct snd_array *list,
1007                        hda_nid_t nid, unsigned int cfg); /* for hwdep */
1008 void snd_hda_shutup_pins(struct hda_codec *codec);
1009
1010 /* SPDIF controls */
1011 struct hda_spdif_out {
1012         hda_nid_t nid;          /* Converter nid values relate to */
1013         unsigned int status;    /* IEC958 status bits */
1014         unsigned short ctls;    /* SPDIF control bits */
1015 };
1016 struct hda_spdif_out *snd_hda_spdif_out_of_nid(struct hda_codec *codec,
1017                                                hda_nid_t nid);
1018 void snd_hda_spdif_ctls_unassign(struct hda_codec *codec, int idx);
1019 void snd_hda_spdif_ctls_assign(struct hda_codec *codec, int idx, hda_nid_t nid);
1020
1021 /*
1022  * Mixer
1023  */
1024 int snd_hda_build_controls(struct hda_bus *bus);
1025 int snd_hda_codec_build_controls(struct hda_codec *codec);
1026
1027 /*
1028  * PCM
1029  */
1030 int snd_hda_build_pcms(struct hda_bus *bus);
1031 int snd_hda_codec_build_pcms(struct hda_codec *codec);
1032
1033 int snd_hda_codec_prepare(struct hda_codec *codec,
1034                           struct hda_pcm_stream *hinfo,
1035                           unsigned int stream,
1036                           unsigned int format,
1037                           struct snd_pcm_substream *substream);
1038 void snd_hda_codec_cleanup(struct hda_codec *codec,
1039                            struct hda_pcm_stream *hinfo,
1040                            struct snd_pcm_substream *substream);
1041
1042 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
1043                                 u32 stream_tag,
1044                                 int channel_id, int format);
1045 void __snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid,
1046                                     int do_now);
1047 #define snd_hda_codec_cleanup_stream(codec, nid) \
1048         __snd_hda_codec_cleanup_stream(codec, nid, 0)
1049 unsigned int snd_hda_calc_stream_format(unsigned int rate,
1050                                         unsigned int channels,
1051                                         unsigned int format,
1052                                         unsigned int maxbps,
1053                                         unsigned short spdif_ctls);
1054 int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
1055                                 unsigned int format);
1056
1057 extern const struct snd_pcm_chmap_elem snd_pcm_2_1_chmaps[];
1058
1059 /*
1060  * Misc
1061  */
1062 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
1063 void snd_hda_bus_reboot_notify(struct hda_bus *bus);
1064 void snd_hda_codec_set_power_to_all(struct hda_codec *codec, hda_nid_t fg,
1065                                     unsigned int power_state);
1066
1067 int snd_hda_lock_devices(struct hda_bus *bus);
1068 void snd_hda_unlock_devices(struct hda_bus *bus);
1069
1070 /*
1071  * power management
1072  */
1073 #ifdef CONFIG_PM
1074 int snd_hda_suspend(struct hda_bus *bus);
1075 int snd_hda_resume(struct hda_bus *bus);
1076 #endif
1077
1078 static inline
1079 int hda_call_check_power_status(struct hda_codec *codec, hda_nid_t nid)
1080 {
1081 #ifdef CONFIG_PM
1082         if (codec->patch_ops.check_power_status)
1083                 return codec->patch_ops.check_power_status(codec, nid);
1084 #endif
1085         return 0;
1086 }
1087
1088 /*
1089  * get widget information
1090  */
1091 const char *snd_hda_get_jack_connectivity(u32 cfg);
1092 const char *snd_hda_get_jack_type(u32 cfg);
1093 const char *snd_hda_get_jack_location(u32 cfg);
1094
1095 /*
1096  * power saving
1097  */
1098 #ifdef CONFIG_PM
1099 void snd_hda_power_save(struct hda_codec *codec, int delta, bool d3wait);
1100 void snd_hda_update_power_acct(struct hda_codec *codec);
1101 #else
1102 static inline void snd_hda_power_save(struct hda_codec *codec, int delta,
1103                                       bool d3wait) {}
1104 #endif
1105
1106 /**
1107  * snd_hda_power_up - Power-up the codec
1108  * @codec: HD-audio codec
1109  *
1110  * Increment the power-up counter and power up the hardware really when
1111  * not turned on yet.
1112  */
1113 static inline void snd_hda_power_up(struct hda_codec *codec)
1114 {
1115         snd_hda_power_save(codec, 1, false);
1116 }
1117
1118 /**
1119  * snd_hda_power_up_d3wait - Power-up the codec after waiting for any pending
1120  *   D3 transition to complete.  This differs from snd_hda_power_up() when
1121  *   power_transition == -1.  snd_hda_power_up sees this case as a nop,
1122  *   snd_hda_power_up_d3wait waits for the D3 transition to complete then powers
1123  *   back up.
1124  * @codec: HD-audio codec
1125  *
1126  * Cancel any power down operation hapenning on the work queue, then power up.
1127  */
1128 static inline void snd_hda_power_up_d3wait(struct hda_codec *codec)
1129 {
1130         snd_hda_power_save(codec, 1, true);
1131 }
1132
1133 /**
1134  * snd_hda_power_down - Power-down the codec
1135  * @codec: HD-audio codec
1136  *
1137  * Decrement the power-up counter and schedules the power-off work if
1138  * the counter rearches to zero.
1139  */
1140 static inline void snd_hda_power_down(struct hda_codec *codec)
1141 {
1142         snd_hda_power_save(codec, -1, false);
1143 }
1144
1145 /**
1146  * snd_hda_power_sync - Synchronize the power-save status
1147  * @codec: HD-audio codec
1148  *
1149  * Synchronize the actual power state with the power account;
1150  * called when power_save parameter is changed
1151  */
1152 static inline void snd_hda_power_sync(struct hda_codec *codec)
1153 {
1154         snd_hda_power_save(codec, 0, false);
1155 }
1156
1157 #ifdef CONFIG_SND_HDA_PATCH_LOADER
1158 /*
1159  * patch firmware
1160  */
1161 int snd_hda_load_patch(struct hda_bus *bus, size_t size, const void *buf);
1162 #endif
1163
1164 #ifdef CONFIG_SND_HDA_DSP_LOADER
1165 static inline int
1166 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
1167                                 unsigned int size,
1168                                 struct snd_dma_buffer *bufp)
1169 {
1170         return codec->bus->ops.load_dsp_prepare(codec->bus, format, size, bufp);
1171 }
1172 static inline void
1173 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start)
1174 {
1175         return codec->bus->ops.load_dsp_trigger(codec->bus, start);
1176 }
1177 static inline void
1178 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
1179                                 struct snd_dma_buffer *dmab)
1180 {
1181         return codec->bus->ops.load_dsp_cleanup(codec->bus, dmab);
1182 }
1183 #else
1184 static inline int
1185 snd_hda_codec_load_dsp_prepare(struct hda_codec *codec, unsigned int format,
1186                                 unsigned int size,
1187                                 struct snd_dma_buffer *bufp)
1188 {
1189         return -ENOSYS;
1190 }
1191 static inline void
1192 snd_hda_codec_load_dsp_trigger(struct hda_codec *codec, bool start) {}
1193 static inline void
1194 snd_hda_codec_load_dsp_cleanup(struct hda_codec *codec,
1195                                 struct snd_dma_buffer *dmab) {}
1196 #endif
1197
1198 /*
1199  * Codec modularization
1200  */
1201
1202 /* Export symbols only for communication with codec drivers;
1203  * When built in kernel, all HD-audio drivers are supposed to be statically
1204  * linked to the kernel.  Thus, the symbols don't have to (or shouldn't) be
1205  * exported unless it's built as a module.
1206  */
1207 #ifdef MODULE
1208 #define EXPORT_SYMBOL_HDA(sym) EXPORT_SYMBOL_GPL(sym)
1209 #else
1210 #define EXPORT_SYMBOL_HDA(sym)
1211 #endif
1212
1213 #endif /* __SOUND_HDA_CODEC_H */