ALSA: usb-audio: add BOSS GT-10 support
[deliverable/linux.git] / sound / pci / hda / hda_codec.h
CommitLineData
1da177e4
LT
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>
2807314d 27#include <sound/hwdep.h>
1da177e4 28
cb53c626
TI
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
1da177e4
LT
33/*
34 * nodes
35 */
36#define AC_NODE_ROOT 0x00
37
38/*
39 * function group types
40 */
41enum {
42 AC_GRP_AUDIO_FUNCTION = 0x01,
43 AC_GRP_MODEM_FUNCTION = 0x02,
44};
45
46/*
47 * widget types
48 */
49enum {
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
3982d17e 80#define AC_VERB_GET_DIGI_CONVERT_1 0x0f0d
a1855d80 81#define AC_VERB_GET_DIGI_CONVERT_2 0x0f0e /* unused */
1da177e4
LT
82#define AC_VERB_GET_VOLUME_KNOB_CONTROL 0x0f0f
83/* f10-f1a: GPIO */
16ded525
TI
84#define AC_VERB_GET_GPIO_DATA 0x0f15
85#define AC_VERB_GET_GPIO_MASK 0x0f16
86#define AC_VERB_GET_GPIO_DIRECTION 0x0f17
797760ab 87#define AC_VERB_GET_GPIO_WAKE_MASK 0x0f18
3982d17e 88#define AC_VERB_GET_GPIO_UNSOLICITED_RSP_MASK 0x0f19
797760ab 89#define AC_VERB_GET_GPIO_STICKY_MASK 0x0f1a
1da177e4 90#define AC_VERB_GET_CONFIG_DEFAULT 0x0f1c
86284e45
TI
91/* f20: AFG/MFG */
92#define AC_VERB_GET_SUBSYSTEM_ID 0x0f20
1da177e4
LT
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
a2a20939 110#define AC_VERB_SET_EAPD_BTLENABLE 0x70c
1da177e4
LT
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
16ded525
TI
114#define AC_VERB_SET_GPIO_DATA 0x715
115#define AC_VERB_SET_GPIO_MASK 0x716
116#define AC_VERB_SET_GPIO_DIRECTION 0x717
797760ab 117#define AC_VERB_SET_GPIO_WAKE_MASK 0x718
3982d17e 118#define AC_VERB_SET_GPIO_UNSOLICITED_RSP_MASK 0x719
797760ab 119#define AC_VERB_SET_GPIO_STICKY_MASK 0x71a
1da177e4
LT
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
e1716139 145#define AC_PAR_VOL_KNB_CAP 0x13
1da177e4
LT
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
797760ab
AP
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
1da177e4
LT
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 */
3982d17e
AP
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 */
1a12de1e 225#define AC_PINCAP_VREF (0x37<<8)
1da177e4
LT
226#define AC_PINCAP_VREF_SHIFT 8
227#define AC_PINCAP_EAPD (1<<16) /* EAPD capable */
1a12de1e
M
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% */
1da177e4
LT
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
d01ce99f
TI
240#define AC_AMPCAP_STEP_SIZE (0x7f<<16) /* step size 0-32dB
241 * in 0.25dB
242 */
1da177e4
LT
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
54d17403 257/* Power state values */
797760ab
AP
258#define AC_PWRST_SETTING (0xf<<0)
259#define AC_PWRST_ACTUAL (0xf<<4)
260#define AC_PWRST_ACTUAL_SHIFT 4
54d17403
TI
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
1da177e4
LT
266/* Processing capabilies */
267#define AC_PCAP_BENIGN (1<<0)
268#define AC_PCAP_NUM_COEF (0xff<<8)
797760ab 269#define AC_PCAP_NUM_COEF_SHIFT 8
1da177e4
LT
270
271/* Volume knobs capabilities */
272#define AC_KNBCAP_NUM_STEPS (0x7f<<0)
38fcaf8e 273#define AC_KNBCAP_DELTA (1<<7)
1da177e4
LT
274
275/*
276 * Control Parameters
277 */
278
279/* Amp gain/mute */
d427c77e 280#define AC_AMP_MUTE (1<<7)
1da177e4
LT
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
797760ab
AP
306/* DIGITAL2 bits */
307#define AC_DIG2_CC (0x7f<<0)
308
1da177e4
LT
309/* Pin widget control - 8bit */
310#define AC_PINCTL_VREFEN (0x7<<0)
98f759a6
TI
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% */
1da177e4
LT
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
4e55096e
M
320/* Unsolicited response - 8bit */
321#define AC_USRSP_EN (1<<7)
322
797760ab
AP
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
1da177e4
LT
332/* configuration default - 32bit */
333#define AC_DEFCFG_SEQUENCE (0xf<<0)
334#define AC_DEFCFG_DEF_ASSOC (0xf<<4)
d21b37ea 335#define AC_DEFCFG_ASSOC_SHIFT 4
1da177e4 336#define AC_DEFCFG_MISC (0xf<<8)
d21b37ea 337#define AC_DEFCFG_MISC_SHIFT 8
797760ab 338#define AC_DEFCFG_MISC_NO_PRESENCE (1<<0)
1da177e4
LT
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) */
351enum {
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) */
370enum {
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) */
387enum {
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 */
404enum {
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 */
414enum {
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};
420enum {
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) */
434enum {
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 */
54d17403 442#define HDA_MAX_CONNECTIONS 32
1da177e4
LT
443
444/* max. codec address */
445#define HDA_MAX_CODEC_ADDRESS 0x0f
446
447/*
448 * Structures
449 */
450
451struct hda_bus;
1cd2224c 452struct hda_beep;
1da177e4
LT
453struct hda_codec;
454struct hda_pcm;
455struct hda_pcm_stream;
456struct hda_bus_unsolicited;
457
458/* NID type */
459typedef u16 hda_nid_t;
460
461/* bus operators */
462struct hda_bus_ops {
463 /* send a single command */
464 int (*command)(struct hda_codec *codec, hda_nid_t nid, int direct,
465 unsigned int verb, unsigned int parm);
466 /* get a response from the last command */
467 unsigned int (*get_response)(struct hda_codec *codec);
468 /* free the private data */
469 void (*private_free)(struct hda_bus *);
cb53c626 470#ifdef CONFIG_SND_HDA_POWER_SAVE
561de31a 471 /* notify power-up/down from codec to controller */
cb53c626
TI
472 void (*pm_notify)(struct hda_codec *codec);
473#endif
1da177e4
LT
474};
475
476/* template to pass to the bus constructor */
477struct hda_bus_template {
478 void *private_data;
479 struct pci_dev *pci;
480 const char *modelname;
481 struct hda_bus_ops ops;
482};
483
484/*
485 * codec bus
486 *
487 * each controller needs to creata a hda_bus to assign the accessor.
488 * A hda_bus contains several codecs in the list codec_list.
489 */
490struct hda_bus {
c8b6bf9b 491 struct snd_card *card;
1da177e4
LT
492
493 /* copied from template */
494 void *private_data;
495 struct pci_dev *pci;
496 const char *modelname;
497 struct hda_bus_ops ops;
498
499 /* codec linked list */
500 struct list_head codec_list;
d01ce99f
TI
501 /* link caddr -> codec */
502 struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
1da177e4 503
62932df8 504 struct mutex cmd_mutex;
1da177e4
LT
505
506 /* unsolicited event queue */
507 struct hda_bus_unsolicited *unsol;
508
c8b6bf9b 509 struct snd_info_entry *proc;
52987656
TI
510
511 /* misc op flags */
512 unsigned int needs_damn_long_delay :1;
1da177e4
LT
513};
514
515/*
516 * codec preset
517 *
518 * Known codecs have the patch to build and set up the controls/PCMs
519 * better than the generic parser.
520 */
521struct hda_codec_preset {
522 unsigned int id;
523 unsigned int mask;
524 unsigned int subs;
525 unsigned int subs_mask;
526 unsigned int rev;
ca7cfae9 527 hda_nid_t afg, mfg;
1da177e4
LT
528 const char *name;
529 int (*patch)(struct hda_codec *codec);
530};
531
532/* ops set by the preset patch */
533struct hda_codec_ops {
534 int (*build_controls)(struct hda_codec *codec);
535 int (*build_pcms)(struct hda_codec *codec);
536 int (*init)(struct hda_codec *codec);
537 void (*free)(struct hda_codec *codec);
538 void (*unsol_event)(struct hda_codec *codec, unsigned int res);
cb53c626 539#ifdef SND_HDA_NEEDS_RESUME
1da177e4
LT
540 int (*suspend)(struct hda_codec *codec, pm_message_t state);
541 int (*resume)(struct hda_codec *codec);
542#endif
cb53c626
TI
543#ifdef CONFIG_SND_HDA_POWER_SAVE
544 int (*check_power_status)(struct hda_codec *codec, hda_nid_t nid);
545#endif
1da177e4
LT
546};
547
548/* record for amp information cache */
01751f54 549struct hda_cache_head {
1da177e4 550 u32 key; /* hash key */
01751f54
TI
551 u16 val; /* assigned value */
552 u16 next; /* next link; -1 = terminal */
553};
554
555struct hda_amp_info {
556 struct hda_cache_head head;
1da177e4 557 u32 amp_caps; /* amp capabilities */
7f0e2f8b 558 u16 vol[2]; /* current volume & mute */
01751f54
TI
559};
560
561struct hda_cache_rec {
562 u16 hash[64]; /* hash table for index */
563 unsigned int num_entries; /* number of assigned entries */
564 unsigned int size; /* allocated size */
565 unsigned int record_size; /* record size (including header) */
566 void *buffer; /* hash table entries */
1da177e4
LT
567};
568
569/* PCM callbacks */
570struct hda_pcm_ops {
571 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
c8b6bf9b 572 struct snd_pcm_substream *substream);
1da177e4 573 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
c8b6bf9b 574 struct snd_pcm_substream *substream);
1da177e4
LT
575 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
576 unsigned int stream_tag, unsigned int format,
c8b6bf9b 577 struct snd_pcm_substream *substream);
1da177e4 578 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
c8b6bf9b 579 struct snd_pcm_substream *substream);
1da177e4
LT
580};
581
582/* PCM information for each substream */
583struct hda_pcm_stream {
d01ce99f 584 unsigned int substreams; /* number of substreams, 0 = not exist*/
1da177e4
LT
585 unsigned int channels_min; /* min. number of channels */
586 unsigned int channels_max; /* max. number of channels */
587 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
588 u32 rates; /* supported rates */
589 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
590 unsigned int maxbps; /* supported max. bit per sample */
591 struct hda_pcm_ops ops;
592};
593
7ba72ba1
TI
594/* PCM types */
595enum {
596 HDA_PCM_TYPE_AUDIO,
597 HDA_PCM_TYPE_SPDIF,
598 HDA_PCM_TYPE_HDMI,
599 HDA_PCM_TYPE_MODEM,
600 HDA_PCM_NTYPES
601};
602
1da177e4
LT
603/* for PCM creation */
604struct hda_pcm {
605 char *name;
606 struct hda_pcm_stream stream[2];
7ba72ba1
TI
607 unsigned int pcm_type; /* HDA_PCM_TYPE_XXX */
608 int device; /* assigned device number */
1da177e4
LT
609};
610
611/* codec information */
612struct hda_codec {
613 struct hda_bus *bus;
614 unsigned int addr; /* codec addr*/
615 struct list_head list; /* list point */
616
617 hda_nid_t afg; /* AFG node id */
673b683a 618 hda_nid_t mfg; /* MFG node id */
1da177e4
LT
619
620 /* ids */
621 u32 vendor_id;
622 u32 subsystem_id;
623 u32 revision_id;
624
625 /* detected preset */
626 const struct hda_codec_preset *preset;
627
628 /* set by patch */
629 struct hda_codec_ops patch_ops;
630
1da177e4
LT
631 /* PCM to create, set by patch_ops.build_pcms callback */
632 unsigned int num_pcms;
633 struct hda_pcm *pcm_info;
634
635 /* codec specific info */
636 void *spec;
637
1cd2224c
MR
638 /* beep device */
639 struct hda_beep *beep;
640
54d17403
TI
641 /* widget capabilities cache */
642 unsigned int num_nodes;
643 hda_nid_t start_nid;
644 u32 *wcaps;
645
01751f54 646 struct hda_cache_rec amp_cache; /* cache for amp access */
b3ac5636 647 struct hda_cache_rec cmd_cache; /* cache for other commands */
1da177e4 648
62932df8 649 struct mutex spdif_mutex;
1da177e4
LT
650 unsigned int spdif_status; /* IEC958 status bits */
651 unsigned short spdif_ctls; /* SPDIF control bits */
652 unsigned int spdif_in_enable; /* SPDIF input enable? */
2807314d
TI
653
654 struct snd_hwdep *hwdep; /* assigned hwdep device */
cb53c626
TI
655
656#ifdef CONFIG_SND_HDA_POWER_SAVE
a221e287
TI
657 unsigned int power_on :1; /* current (global) power-state */
658 unsigned int power_transition :1; /* power-state in transition */
cb53c626
TI
659 int power_count; /* current (global) power refcount */
660 struct delayed_work power_work; /* delayed task for powerdown */
661#endif
1da177e4
LT
662};
663
664/* direction */
665enum {
666 HDA_INPUT, HDA_OUTPUT
667};
668
669
670/*
671 * constructors
672 */
c8b6bf9b 673int snd_hda_bus_new(struct snd_card *card, const struct hda_bus_template *temp,
1da177e4
LT
674 struct hda_bus **busp);
675int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
676 struct hda_codec **codecp);
677
678/*
679 * low level functions
680 */
d01ce99f
TI
681unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
682 int direct,
1da177e4
LT
683 unsigned int verb, unsigned int parm);
684int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int direct,
685 unsigned int verb, unsigned int parm);
d01ce99f
TI
686#define snd_hda_param_read(codec, nid, param) \
687 snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
688int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
689 hda_nid_t *start_id);
690int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
691 hda_nid_t *conn_list, int max_conns);
1da177e4
LT
692
693struct hda_verb {
694 hda_nid_t nid;
695 u32 verb;
696 u32 param;
697};
698
d01ce99f
TI
699void snd_hda_sequence_write(struct hda_codec *codec,
700 const struct hda_verb *seq);
1da177e4
LT
701
702/* unsolicited event */
703int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
704
b3ac5636 705/* cached write */
cb53c626 706#ifdef SND_HDA_NEEDS_RESUME
b3ac5636
TI
707int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
708 int direct, unsigned int verb, unsigned int parm);
709void snd_hda_sequence_write_cache(struct hda_codec *codec,
710 const struct hda_verb *seq);
711void snd_hda_codec_resume_cache(struct hda_codec *codec);
82beb8fd
TI
712#else
713#define snd_hda_codec_write_cache snd_hda_codec_write
714#define snd_hda_sequence_write_cache snd_hda_sequence_write
715#endif
b3ac5636 716
1da177e4
LT
717/*
718 * Mixer
719 */
720int snd_hda_build_controls(struct hda_bus *bus);
721
722/*
723 * PCM
724 */
725int snd_hda_build_pcms(struct hda_bus *bus);
d01ce99f
TI
726void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
727 u32 stream_tag,
1da177e4 728 int channel_id, int format);
888afa15 729void snd_hda_codec_cleanup_stream(struct hda_codec *codec, hda_nid_t nid);
d01ce99f
TI
730unsigned int snd_hda_calc_stream_format(unsigned int rate,
731 unsigned int channels,
732 unsigned int format,
733 unsigned int maxbps);
1da177e4
LT
734int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
735 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
736int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
737 unsigned int format);
738
739/*
740 * Misc
741 */
742void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
743
744/*
745 * power management
746 */
747#ifdef CONFIG_PM
748int snd_hda_suspend(struct hda_bus *bus, pm_message_t state);
749int snd_hda_resume(struct hda_bus *bus);
750#endif
751
cb53c626
TI
752/*
753 * power saving
754 */
755#ifdef CONFIG_SND_HDA_POWER_SAVE
756void snd_hda_power_up(struct hda_codec *codec);
757void snd_hda_power_down(struct hda_codec *codec);
d804ad92
ML
758#define snd_hda_codec_needs_resume(codec) codec->power_count
759int snd_hda_codecs_inuse(struct hda_bus *bus);
cb53c626
TI
760#else
761static inline void snd_hda_power_up(struct hda_codec *codec) {}
762static inline void snd_hda_power_down(struct hda_codec *codec) {}
d804ad92
ML
763#define snd_hda_codec_needs_resume(codec) 1
764#define snd_hda_codecs_inuse(bus) 1
cb53c626
TI
765#endif
766
1da177e4 767#endif /* __SOUND_HDA_CODEC_H */
This page took 0.446621 seconds and 5 git commands to generate.