]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - sound/pci/hda/hda_codec.h
Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6-omap-h63xx.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 #if defined(CONFIG_PM) || defined(CONFIG_SND_HDA_POWER_SAVE)
30 #define SND_HDA_NEEDS_RESUME    /* resume control code is required */
31 #endif
32
33 /*
34  * nodes
35  */
36 #define AC_NODE_ROOT            0x00
37
38 /*
39  * function group types
40  */
41 enum {
42         AC_GRP_AUDIO_FUNCTION = 0x01,
43         AC_GRP_MODEM_FUNCTION = 0x02,
44 };
45         
46 /*
47  * widget types
48  */
49 enum {
50         AC_WID_AUD_OUT,         /* Audio Out */
51         AC_WID_AUD_IN,          /* Audio In */
52         AC_WID_AUD_MIX,         /* Audio Mixer */
53         AC_WID_AUD_SEL,         /* Audio Selector */
54         AC_WID_PIN,             /* Pin Complex */
55         AC_WID_POWER,           /* Power */
56         AC_WID_VOL_KNB,         /* Volume Knob */
57         AC_WID_BEEP,            /* Beep Generator */
58         AC_WID_VENDOR = 0x0f    /* Vendor specific */
59 };
60
61 /*
62  * GET verbs
63  */
64 #define AC_VERB_GET_STREAM_FORMAT               0x0a00
65 #define AC_VERB_GET_AMP_GAIN_MUTE               0x0b00
66 #define AC_VERB_GET_PROC_COEF                   0x0c00
67 #define AC_VERB_GET_COEF_INDEX                  0x0d00
68 #define AC_VERB_PARAMETERS                      0x0f00
69 #define AC_VERB_GET_CONNECT_SEL                 0x0f01
70 #define AC_VERB_GET_CONNECT_LIST                0x0f02
71 #define AC_VERB_GET_PROC_STATE                  0x0f03
72 #define AC_VERB_GET_SDI_SELECT                  0x0f04
73 #define AC_VERB_GET_POWER_STATE                 0x0f05
74 #define AC_VERB_GET_CONV                        0x0f06
75 #define AC_VERB_GET_PIN_WIDGET_CONTROL          0x0f07
76 #define AC_VERB_GET_UNSOLICITED_RESPONSE        0x0f08
77 #define AC_VERB_GET_PIN_SENSE                   0x0f09
78 #define AC_VERB_GET_BEEP_CONTROL                0x0f0a
79 #define AC_VERB_GET_EAPD_BTLENABLE              0x0f0c
80 #define AC_VERB_GET_DIGI_CONVERT_1              0x0f0d
81 #define AC_VERB_GET_DIGI_CONVERT_2              0x0f0e
82 #define AC_VERB_GET_VOLUME_KNOB_CONTROL         0x0f0f
83 /* f10-f1a: GPIO */
84 #define AC_VERB_GET_GPIO_DATA                   0x0f15
85 #define AC_VERB_GET_GPIO_MASK                   0x0f16
86 #define AC_VERB_GET_GPIO_DIRECTION              0x0f17
87 #define AC_VERB_GET_GPIO_WAKE_MASK              0x0f18
88 #define AC_VERB_GET_GPIO_UNSOLICITED_RSP_MASK   0x0f19
89 #define AC_VERB_GET_GPIO_STICKY_MASK            0x0f1a
90 #define AC_VERB_GET_CONFIG_DEFAULT              0x0f1c
91 /* f20: AFG/MFG */
92 #define AC_VERB_GET_SUBSYSTEM_ID                0x0f20
93
94 /*
95  * SET verbs
96  */
97 #define AC_VERB_SET_STREAM_FORMAT               0x200
98 #define AC_VERB_SET_AMP_GAIN_MUTE               0x300
99 #define AC_VERB_SET_PROC_COEF                   0x400
100 #define AC_VERB_SET_COEF_INDEX                  0x500
101 #define AC_VERB_SET_CONNECT_SEL                 0x701
102 #define AC_VERB_SET_PROC_STATE                  0x703
103 #define AC_VERB_SET_SDI_SELECT                  0x704
104 #define AC_VERB_SET_POWER_STATE                 0x705
105 #define AC_VERB_SET_CHANNEL_STREAMID            0x706
106 #define AC_VERB_SET_PIN_WIDGET_CONTROL          0x707
107 #define AC_VERB_SET_UNSOLICITED_ENABLE          0x708
108 #define AC_VERB_SET_PIN_SENSE                   0x709
109 #define AC_VERB_SET_BEEP_CONTROL                0x70a
110 #define AC_VERB_SET_EAPD_BTLENABLE              0x70c
111 #define AC_VERB_SET_DIGI_CONVERT_1              0x70d
112 #define AC_VERB_SET_DIGI_CONVERT_2              0x70e
113 #define AC_VERB_SET_VOLUME_KNOB_CONTROL         0x70f
114 #define AC_VERB_SET_GPIO_DATA                   0x715
115 #define AC_VERB_SET_GPIO_MASK                   0x716
116 #define AC_VERB_SET_GPIO_DIRECTION              0x717
117 #define AC_VERB_SET_GPIO_WAKE_MASK              0x718
118 #define AC_VERB_SET_GPIO_UNSOLICITED_RSP_MASK   0x719
119 #define AC_VERB_SET_GPIO_STICKY_MASK            0x71a
120 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_0      0x71c
121 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_1      0x71d
122 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_2      0x71e
123 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_3      0x71f
124 #define AC_VERB_SET_CODEC_RESET                 0x7ff
125
126 /*
127  * Parameter IDs
128  */
129 #define AC_PAR_VENDOR_ID                0x00
130 #define AC_PAR_SUBSYSTEM_ID             0x01
131 #define AC_PAR_REV_ID                   0x02
132 #define AC_PAR_NODE_COUNT               0x04
133 #define AC_PAR_FUNCTION_TYPE            0x05
134 #define AC_PAR_AUDIO_FG_CAP             0x08
135 #define AC_PAR_AUDIO_WIDGET_CAP         0x09
136 #define AC_PAR_PCM                      0x0a
137 #define AC_PAR_STREAM                   0x0b
138 #define AC_PAR_PIN_CAP                  0x0c
139 #define AC_PAR_AMP_IN_CAP               0x0d
140 #define AC_PAR_CONNLIST_LEN             0x0e
141 #define AC_PAR_POWER_STATE              0x0f
142 #define AC_PAR_PROC_CAP                 0x10
143 #define AC_PAR_GPIO_CAP                 0x11
144 #define AC_PAR_AMP_OUT_CAP              0x12
145 #define AC_PAR_VOL_KNB_CAP              0x13
146
147 /*
148  * AC_VERB_PARAMETERS results (32bit)
149  */
150
151 /* Function Group Type */
152 #define AC_FGT_TYPE                     (0xff<<0)
153 #define AC_FGT_TYPE_SHIFT               0
154 #define AC_FGT_UNSOL_CAP                (1<<8)
155
156 /* Audio Function Group Capabilities */
157 #define AC_AFG_OUT_DELAY                (0xf<<0)
158 #define AC_AFG_IN_DELAY                 (0xf<<8)
159 #define AC_AFG_BEEP_GEN                 (1<<16)
160
161 /* Audio Widget Capabilities */
162 #define AC_WCAP_STEREO                  (1<<0)  /* stereo I/O */
163 #define AC_WCAP_IN_AMP                  (1<<1)  /* AMP-in present */
164 #define AC_WCAP_OUT_AMP                 (1<<2)  /* AMP-out present */
165 #define AC_WCAP_AMP_OVRD                (1<<3)  /* AMP-parameter override */
166 #define AC_WCAP_FORMAT_OVRD             (1<<4)  /* format override */
167 #define AC_WCAP_STRIPE                  (1<<5)  /* stripe */
168 #define AC_WCAP_PROC_WID                (1<<6)  /* Proc Widget */
169 #define AC_WCAP_UNSOL_CAP               (1<<7)  /* Unsol capable */
170 #define AC_WCAP_CONN_LIST               (1<<8)  /* connection list */
171 #define AC_WCAP_DIGITAL                 (1<<9)  /* digital I/O */
172 #define AC_WCAP_POWER                   (1<<10) /* power control */
173 #define AC_WCAP_LR_SWAP                 (1<<11) /* L/R swap */
174 #define AC_WCAP_DELAY                   (0xf<<16)
175 #define AC_WCAP_DELAY_SHIFT             16
176 #define AC_WCAP_TYPE                    (0xf<<20)
177 #define AC_WCAP_TYPE_SHIFT              20
178
179 /* supported PCM rates and bits */
180 #define AC_SUPPCM_RATES                 (0xfff << 0)
181 #define AC_SUPPCM_BITS_8                (1<<16)
182 #define AC_SUPPCM_BITS_16               (1<<17)
183 #define AC_SUPPCM_BITS_20               (1<<18)
184 #define AC_SUPPCM_BITS_24               (1<<19)
185 #define AC_SUPPCM_BITS_32               (1<<20)
186
187 /* supported PCM stream format */
188 #define AC_SUPFMT_PCM                   (1<<0)
189 #define AC_SUPFMT_FLOAT32               (1<<1)
190 #define AC_SUPFMT_AC3                   (1<<2)
191
192 /* GP I/O count */
193 #define AC_GPIO_IO_COUNT                (0xff<<0)
194 #define AC_GPIO_O_COUNT                 (0xff<<8)
195 #define AC_GPIO_O_COUNT_SHIFT           8
196 #define AC_GPIO_I_COUNT                 (0xff<<16)
197 #define AC_GPIO_I_COUNT_SHIFT           16
198 #define AC_GPIO_UNSOLICITED             (1<<30)
199 #define AC_GPIO_WAKE                    (1<<31)
200
201 /* Converter stream, channel */
202 #define AC_CONV_CHANNEL                 (0xf<<0)
203 #define AC_CONV_STREAM                  (0xf<<4)
204 #define AC_CONV_STREAM_SHIFT            4
205
206 /* Input converter SDI select */
207 #define AC_SDI_SELECT                   (0xf<<0)
208
209 /* Unsolicited response */
210 #define AC_UNSOL_TAG                    (0x3f<<0)
211 #define AC_UNSOL_ENABLED                (1<<7)
212
213 /* Pin widget capabilies */
214 #define AC_PINCAP_IMP_SENSE             (1<<0)  /* impedance sense capable */
215 #define AC_PINCAP_TRIG_REQ              (1<<1)  /* trigger required */
216 #define AC_PINCAP_PRES_DETECT           (1<<2)  /* presence detect capable */
217 #define AC_PINCAP_HP_DRV                (1<<3)  /* headphone drive capable */
218 #define AC_PINCAP_OUT                   (1<<4)  /* output capable */
219 #define AC_PINCAP_IN                    (1<<5)  /* input capable */
220 #define AC_PINCAP_BALANCE               (1<<6)  /* balanced I/O capable */
221 /* Note: This LR_SWAP pincap is defined in the Realtek ALC883 specification,
222  *       but is marked reserved in the Intel HDA specification.
223  */
224 #define AC_PINCAP_LR_SWAP               (1<<7)  /* L/R swap */
225 #define AC_PINCAP_VREF                  (0x37<<8)
226 #define AC_PINCAP_VREF_SHIFT            8
227 #define AC_PINCAP_EAPD                  (1<<16) /* EAPD capable */
228 /* Vref status (used in pin cap) */
229 #define AC_PINCAP_VREF_HIZ              (1<<0)  /* Hi-Z */
230 #define AC_PINCAP_VREF_50               (1<<1)  /* 50% */
231 #define AC_PINCAP_VREF_GRD              (1<<2)  /* ground */
232 #define AC_PINCAP_VREF_80               (1<<4)  /* 80% */
233 #define AC_PINCAP_VREF_100              (1<<5)  /* 100% */
234
235 /* Amplifier capabilities */
236 #define AC_AMPCAP_OFFSET                (0x7f<<0)  /* 0dB offset */
237 #define AC_AMPCAP_OFFSET_SHIFT          0
238 #define AC_AMPCAP_NUM_STEPS             (0x7f<<8)  /* number of steps */
239 #define AC_AMPCAP_NUM_STEPS_SHIFT       8
240 #define AC_AMPCAP_STEP_SIZE             (0x7f<<16) /* step size 0-32dB
241                                                     * in 0.25dB
242                                                     */
243 #define AC_AMPCAP_STEP_SIZE_SHIFT       16
244 #define AC_AMPCAP_MUTE                  (1<<31)    /* mute capable */
245 #define AC_AMPCAP_MUTE_SHIFT            31
246
247 /* Connection list */
248 #define AC_CLIST_LENGTH                 (0x7f<<0)
249 #define AC_CLIST_LONG                   (1<<7)
250
251 /* Supported power status */
252 #define AC_PWRST_D0SUP                  (1<<0)
253 #define AC_PWRST_D1SUP                  (1<<1)
254 #define AC_PWRST_D2SUP                  (1<<2)
255 #define AC_PWRST_D3SUP                  (1<<3)
256
257 /* Power state values */
258 #define AC_PWRST_SETTING                (0xf<<0)
259 #define AC_PWRST_ACTUAL                 (0xf<<4)
260 #define AC_PWRST_ACTUAL_SHIFT           4
261 #define AC_PWRST_D0                     0x00
262 #define AC_PWRST_D1                     0x01
263 #define AC_PWRST_D2                     0x02
264 #define AC_PWRST_D3                     0x03
265
266 /* Processing capabilies */
267 #define AC_PCAP_BENIGN                  (1<<0)
268 #define AC_PCAP_NUM_COEF                (0xff<<8)
269 #define AC_PCAP_NUM_COEF_SHIFT          8
270
271 /* Volume knobs capabilities */
272 #define AC_KNBCAP_NUM_STEPS             (0x7f<<0)
273 #define AC_KNBCAP_DELTA                 (1<<7)
274
275 /*
276  * Control Parameters
277  */
278
279 /* Amp gain/mute */
280 #define AC_AMP_MUTE                     (1<<7)
281 #define AC_AMP_GAIN                     (0x7f)
282 #define AC_AMP_GET_INDEX                (0xf<<0)
283
284 #define AC_AMP_GET_LEFT                 (1<<13)
285 #define AC_AMP_GET_RIGHT                (0<<13)
286 #define AC_AMP_GET_OUTPUT               (1<<15)
287 #define AC_AMP_GET_INPUT                (0<<15)
288
289 #define AC_AMP_SET_INDEX                (0xf<<8)
290 #define AC_AMP_SET_INDEX_SHIFT          8
291 #define AC_AMP_SET_RIGHT                (1<<12)
292 #define AC_AMP_SET_LEFT                 (1<<13)
293 #define AC_AMP_SET_INPUT                (1<<14)
294 #define AC_AMP_SET_OUTPUT               (1<<15)
295
296 /* DIGITAL1 bits */
297 #define AC_DIG1_ENABLE                  (1<<0)
298 #define AC_DIG1_V                       (1<<1)
299 #define AC_DIG1_VCFG                    (1<<2)
300 #define AC_DIG1_EMPHASIS                (1<<3)
301 #define AC_DIG1_COPYRIGHT               (1<<4)
302 #define AC_DIG1_NONAUDIO                (1<<5)
303 #define AC_DIG1_PROFESSIONAL            (1<<6)
304 #define AC_DIG1_LEVEL                   (1<<7)
305
306 /* DIGITAL2 bits */
307 #define AC_DIG2_CC                      (0x7f<<0)
308
309 /* Pin widget control - 8bit */
310 #define AC_PINCTL_VREFEN                (0x7<<0)
311 #define AC_PINCTL_VREF_HIZ              0       /* Hi-Z */
312 #define AC_PINCTL_VREF_50               1       /* 50% */
313 #define AC_PINCTL_VREF_GRD              2       /* ground */
314 #define AC_PINCTL_VREF_80               4       /* 80% */
315 #define AC_PINCTL_VREF_100              5       /* 100% */
316 #define AC_PINCTL_IN_EN                 (1<<5)
317 #define AC_PINCTL_OUT_EN                (1<<6)
318 #define AC_PINCTL_HP_EN                 (1<<7)
319
320 /* Unsolicited response - 8bit */
321 #define AC_USRSP_EN                     (1<<7)
322
323 /* Pin sense - 32bit */
324 #define AC_PINSENSE_IMPEDANCE_MASK      (0x7fffffff)
325 #define AC_PINSENSE_PRESENCE            (1<<31)
326
327 /* EAPD/BTL enable - 32bit */
328 #define AC_EAPDBTL_BALANCED             (1<<0)
329 #define AC_EAPDBTL_EAPD                 (1<<1)
330 #define AC_EAPDBTL_LR_SWAP              (1<<2)
331
332 /* configuration default - 32bit */
333 #define AC_DEFCFG_SEQUENCE              (0xf<<0)
334 #define AC_DEFCFG_DEF_ASSOC             (0xf<<4)
335 #define AC_DEFCFG_ASSOC_SHIFT           4
336 #define AC_DEFCFG_MISC                  (0xf<<8)
337 #define AC_DEFCFG_MISC_SHIFT            8
338 #define AC_DEFCFG_MISC_NO_PRESENCE      (1<<0)
339 #define AC_DEFCFG_COLOR                 (0xf<<12)
340 #define AC_DEFCFG_COLOR_SHIFT           12
341 #define AC_DEFCFG_CONN_TYPE             (0xf<<16)
342 #define AC_DEFCFG_CONN_TYPE_SHIFT       16
343 #define AC_DEFCFG_DEVICE                (0xf<<20)
344 #define AC_DEFCFG_DEVICE_SHIFT          20
345 #define AC_DEFCFG_LOCATION              (0x3f<<24)
346 #define AC_DEFCFG_LOCATION_SHIFT        24
347 #define AC_DEFCFG_PORT_CONN             (0x3<<30)
348 #define AC_DEFCFG_PORT_CONN_SHIFT       30
349
350 /* device device types (0x0-0xf) */
351 enum {
352         AC_JACK_LINE_OUT,
353         AC_JACK_SPEAKER,
354         AC_JACK_HP_OUT,
355         AC_JACK_CD,
356         AC_JACK_SPDIF_OUT,
357         AC_JACK_DIG_OTHER_OUT,
358         AC_JACK_MODEM_LINE_SIDE,
359         AC_JACK_MODEM_HAND_SIDE,
360         AC_JACK_LINE_IN,
361         AC_JACK_AUX,
362         AC_JACK_MIC_IN,
363         AC_JACK_TELEPHONY,
364         AC_JACK_SPDIF_IN,
365         AC_JACK_DIG_OTHER_IN,
366         AC_JACK_OTHER = 0xf,
367 };
368
369 /* jack connection types (0x0-0xf) */
370 enum {
371         AC_JACK_CONN_UNKNOWN,
372         AC_JACK_CONN_1_8,
373         AC_JACK_CONN_1_4,
374         AC_JACK_CONN_ATAPI,
375         AC_JACK_CONN_RCA,
376         AC_JACK_CONN_OPTICAL,
377         AC_JACK_CONN_OTHER_DIGITAL,
378         AC_JACK_CONN_OTHER_ANALOG,
379         AC_JACK_CONN_DIN,
380         AC_JACK_CONN_XLR,
381         AC_JACK_CONN_RJ11,
382         AC_JACK_CONN_COMB,
383         AC_JACK_CONN_OTHER = 0xf,
384 };
385
386 /* jack colors (0x0-0xf) */
387 enum {
388         AC_JACK_COLOR_UNKNOWN,
389         AC_JACK_COLOR_BLACK,
390         AC_JACK_COLOR_GREY,
391         AC_JACK_COLOR_BLUE,
392         AC_JACK_COLOR_GREEN,
393         AC_JACK_COLOR_RED,
394         AC_JACK_COLOR_ORANGE,
395         AC_JACK_COLOR_YELLOW,
396         AC_JACK_COLOR_PURPLE,
397         AC_JACK_COLOR_PINK,
398         AC_JACK_COLOR_WHITE = 0xe,
399         AC_JACK_COLOR_OTHER,
400 };
401
402 /* Jack location (0x0-0x3f) */
403 /* common case */
404 enum {
405         AC_JACK_LOC_NONE,
406         AC_JACK_LOC_REAR,
407         AC_JACK_LOC_FRONT,
408         AC_JACK_LOC_LEFT,
409         AC_JACK_LOC_RIGHT,
410         AC_JACK_LOC_TOP,
411         AC_JACK_LOC_BOTTOM,
412 };
413 /* bits 4-5 */
414 enum {
415         AC_JACK_LOC_EXTERNAL = 0x00,
416         AC_JACK_LOC_INTERNAL = 0x10,
417         AC_JACK_LOC_SEPARATE = 0x20,
418         AC_JACK_LOC_OTHER    = 0x30,
419 };
420 enum {
421         /* external on primary chasis */
422         AC_JACK_LOC_REAR_PANEL = 0x07,
423         AC_JACK_LOC_DRIVE_BAY,
424         /* internal */
425         AC_JACK_LOC_RISER = 0x17,
426         AC_JACK_LOC_HDMI,
427         AC_JACK_LOC_ATAPI,
428         /* others */
429         AC_JACK_LOC_MOBILE_IN = 0x37,
430         AC_JACK_LOC_MOBILE_OUT,
431 };
432
433 /* Port connectivity (0-3) */
434 enum {
435         AC_JACK_PORT_COMPLEX,
436         AC_JACK_PORT_NONE,
437         AC_JACK_PORT_FIXED,
438         AC_JACK_PORT_BOTH,
439 };
440
441 /* max. connections to a widget */
442 #define HDA_MAX_CONNECTIONS     32
443
444 /* max. codec address */
445 #define HDA_MAX_CODEC_ADDRESS   0x0f
446
447 /*
448  * Structures
449  */
450
451 struct hda_bus;
452 struct hda_codec;
453 struct hda_pcm;
454 struct hda_pcm_stream;
455 struct hda_bus_unsolicited;
456
457 /* NID type */
458 typedef u16 hda_nid_t;
459
460 /* bus operators */
461 struct hda_bus_ops {
462         /* send a single command */
463         int (*command)(struct hda_codec *codec, hda_nid_t nid, int direct,
464                        unsigned int verb, unsigned int parm);
465         /* get a response from the last command */
466         unsigned int (*get_response)(struct hda_codec *codec);
467         /* free the private data */
468         void (*private_free)(struct hda_bus *);
469 #ifdef CONFIG_SND_HDA_POWER_SAVE
470         /* notify power-up/down from codec to controller */
471         void (*pm_notify)(struct hda_codec *codec);
472 #endif
473 };
474
475 /* template to pass to the bus constructor */
476 struct hda_bus_template {
477         void *private_data;
478         struct pci_dev *pci;
479         const char *modelname;
480         struct hda_bus_ops ops;
481 };
482
483 /*
484  * codec bus
485  *
486  * each controller needs to creata a hda_bus to assign the accessor.
487  * A hda_bus contains several codecs in the list codec_list.
488  */
489 struct hda_bus {
490         struct snd_card *card;
491
492         /* copied from template */
493         void *private_data;
494         struct pci_dev *pci;
495         const char *modelname;
496         struct hda_bus_ops ops;
497
498         /* codec linked list */
499         struct list_head codec_list;
500         /* link caddr -> codec */
501         struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
502
503         struct mutex cmd_mutex;
504
505         /* unsolicited event queue */
506         struct hda_bus_unsolicited *unsol;
507
508         struct snd_info_entry *proc;
509
510         /* misc op flags */
511         unsigned int needs_damn_long_delay :1;
512 };
513
514 /*
515  * codec preset
516  *
517  * Known codecs have the patch to build and set up the controls/PCMs
518  * better than the generic parser.
519  */
520 struct hda_codec_preset {
521         unsigned int id;
522         unsigned int mask;
523         unsigned int subs;
524         unsigned int subs_mask;
525         unsigned int rev;
526         hda_nid_t afg, mfg;
527         const char *name;
528         int (*patch)(struct hda_codec *codec);
529 };
530         
531 /* ops set by the preset patch */
532 struct hda_codec_ops {
533         int (*build_controls)(struct hda_codec *codec);
534         int (*build_pcms)(struct hda_codec *codec);
535         int (*init)(struct hda_codec *codec);
536         void (*free)(struct hda_codec *codec);
537         void (*unsol_event)(struct hda_codec *codec, unsigned int res);
538 #ifdef SND_HDA_NEEDS_RESUME
539         int (*suspend)(struct hda_codec *codec, pm_message_t state);
540         int (*resume)(struct hda_codec *codec);
541 #endif
542 #ifdef CONFIG_SND_HDA_POWER_SAVE
543         int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
544 #endif
545 };
546
547 /* record for amp information cache */
548 struct hda_cache_head {
549         u32 key;                /* hash key */
550         u16 val;                /* assigned value */
551         u16 next;               /* next link; -1 = terminal */
552 };
553
554 struct hda_amp_info {
555         struct hda_cache_head head;
556         u32 amp_caps;           /* amp capabilities */
557         u16 vol[2];             /* current volume & mute */
558 };
559
560 struct hda_cache_rec {
561         u16 hash[64];                   /* hash table for index */
562         unsigned int num_entries;       /* number of assigned entries */
563         unsigned int size;              /* allocated size */
564         unsigned int record_size;       /* record size (including header) */
565         void *buffer;                   /* hash table entries */
566 };
567
568 /* PCM callbacks */
569 struct hda_pcm_ops {
570         int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
571                     struct snd_pcm_substream *substream);
572         int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
573                      struct snd_pcm_substream *substream);
574         int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
575                        unsigned int stream_tag, unsigned int format,
576                        struct snd_pcm_substream *substream);
577         int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
578                        struct snd_pcm_substream *substream);
579 };
580
581 /* PCM information for each substream */
582 struct hda_pcm_stream {
583         unsigned int substreams;        /* number of substreams, 0 = not exist*/
584         unsigned int channels_min;      /* min. number of channels */
585         unsigned int channels_max;      /* max. number of channels */
586         hda_nid_t nid;  /* default NID to query rates/formats/bps, or set up */
587         u32 rates;      /* supported rates */
588         u64 formats;    /* supported formats (SNDRV_PCM_FMTBIT_) */
589         unsigned int maxbps;    /* supported max. bit per sample */
590         struct hda_pcm_ops ops;
591 };
592
593 /* PCM types */
594 enum {
595         HDA_PCM_TYPE_AUDIO,
596         HDA_PCM_TYPE_SPDIF,
597         HDA_PCM_TYPE_HDMI,
598         HDA_PCM_TYPE_MODEM,
599         HDA_PCM_NTYPES
600 };
601
602 /* for PCM creation */
603 struct hda_pcm {
604         char *name;
605         struct hda_pcm_stream stream[2];
606         unsigned int pcm_type;  /* HDA_PCM_TYPE_XXX */
607         int device;     /* assigned device number */
608 };
609
610 /* codec information */
611 struct hda_codec {
612         struct hda_bus *bus;
613         unsigned int addr;      /* codec addr*/
614         struct list_head list;  /* list point */
615
616         hda_nid_t afg;  /* AFG node id */
617         hda_nid_t mfg;  /* MFG node id */
618
619         /* ids */
620         u32 vendor_id;
621         u32 subsystem_id;
622         u32 revision_id;
623
624         /* detected preset */
625         const struct hda_codec_preset *preset;
626
627         /* set by patch */
628         struct hda_codec_ops patch_ops;
629
630         /* PCM to create, set by patch_ops.build_pcms callback */
631         unsigned int num_pcms;
632         struct hda_pcm *pcm_info;
633
634         /* codec specific info */
635         void *spec;
636
637         /* widget capabilities cache */
638         unsigned int num_nodes;
639         hda_nid_t start_nid;
640         u32 *wcaps;
641
642         struct hda_cache_rec amp_cache; /* cache for amp access */
643         struct hda_cache_rec cmd_cache; /* cache for other commands */
644
645         struct mutex spdif_mutex;
646         unsigned int spdif_status;      /* IEC958 status bits */
647         unsigned short spdif_ctls;      /* SPDIF control bits */
648         unsigned int spdif_in_enable;   /* SPDIF input enable? */
649
650         struct snd_hwdep *hwdep;        /* assigned hwdep device */
651
652 #ifdef CONFIG_SND_HDA_POWER_SAVE
653         unsigned int power_on :1;       /* current (global) power-state */
654         unsigned int power_transition :1; /* power-state in transition */
655         int power_count;        /* current (global) power refcount */
656         struct delayed_work power_work; /* delayed task for powerdown */
657 #endif
658 };
659
660 /* direction */
661 enum {
662         HDA_INPUT, HDA_OUTPUT
663 };
664
665
666 /*
667  * constructors
668  */
669 int snd_hda_bus_new(struct snd_card *card, const struct hda_bus_template *temp,
670                     struct hda_bus **busp);
671 int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
672                       struct hda_codec **codecp);
673
674 /*
675  * low level functions
676  */
677 unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
678                                 int direct,
679                                 unsigned int verb, unsigned int parm);
680 int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int direct,
681                         unsigned int verb, unsigned int parm);
682 #define snd_hda_param_read(codec, nid, param) \
683         snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
684 int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
685                           hda_nid_t *start_id);
686 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
687                             hda_nid_t *conn_list, int max_conns);
688
689 struct hda_verb {
690         hda_nid_t nid;
691         u32 verb;
692         u32 param;
693 };
694
695 void snd_hda_sequence_write(struct hda_codec *codec,
696                             const struct hda_verb *seq);
697
698 /* unsolicited event */
699 int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
700
701 /* cached write */
702 #ifdef SND_HDA_NEEDS_RESUME
703 int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
704                               int direct, unsigned int verb, unsigned int parm);
705 void snd_hda_sequence_write_cache(struct hda_codec *codec,
706                                   const struct hda_verb *seq);
707 void snd_hda_codec_resume_cache(struct hda_codec *codec);
708 #else
709 #define snd_hda_codec_write_cache       snd_hda_codec_write
710 #define snd_hda_sequence_write_cache    snd_hda_sequence_write
711 #endif
712
713 /*
714  * Mixer
715  */
716 int snd_hda_build_controls(struct hda_bus *bus);
717
718 /*
719  * PCM
720  */
721 int snd_hda_build_pcms(struct hda_bus *bus);
722 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
723                                 u32 stream_tag,
724                                 int channel_id, int format);
725 void snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid);
726 unsigned int snd_hda_calc_stream_format(unsigned int rate,
727                                         unsigned int channels,
728                                         unsigned int format,
729                                         unsigned int maxbps);
730 int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
731                                 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
732 int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
733                                 unsigned int format);
734
735 /*
736  * Misc
737  */
738 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
739
740 /*
741  * power management
742  */
743 #ifdef CONFIG_PM
744 int snd_hda_suspend(struct hda_bus *bus, pm_message_t state);
745 int snd_hda_resume(struct hda_bus *bus);
746 #endif
747
748 /*
749  * power saving
750  */
751 #ifdef CONFIG_SND_HDA_POWER_SAVE
752 void snd_hda_power_up(struct hda_codec *codec);
753 void snd_hda_power_down(struct hda_codec *codec);
754 #define snd_hda_codec_needs_resume(codec) codec->power_count
755 int snd_hda_codecs_inuse(struct hda_bus *bus);
756 #else
757 static inline void snd_hda_power_up(struct hda_codec *codec) {}
758 static inline void snd_hda_power_down(struct hda_codec *codec) {}
759 #define snd_hda_codec_needs_resume(codec) 1
760 #define snd_hda_codecs_inuse(bus) 1
761 #endif
762
763 #endif /* __SOUND_HDA_CODEC_H */