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