2 * Universal Interface for Intel High Definition Audio Codec
4 * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
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)
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
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.
21 #ifndef __SOUND_HDA_CODEC_H
22 #define __SOUND_HDA_CODEC_H
24 #include <sound/info.h>
25 #include <sound/control.h>
26 #include <sound/pcm.h>
31 #define AC_NODE_ROOT 0x00
34 * function group types
37 AC_GRP_AUDIO_FUNCTION
= 0x01,
38 AC_GRP_MODEM_FUNCTION
= 0x02,
45 AC_WID_AUD_OUT
, /* Audio Out */
46 AC_WID_AUD_IN
, /* Audio In */
47 AC_WID_AUD_MIX
, /* Audio Mixer */
48 AC_WID_AUD_SEL
, /* Audio Selector */
49 AC_WID_PIN
, /* Pin Complex */
50 AC_WID_POWER
, /* Power */
51 AC_WID_VOL_KNB
, /* Volume Knob */
52 AC_WID_BEEP
, /* Beep Generator */
53 AC_WID_VENDOR
= 0x0f /* Vendor specific */
59 #define AC_VERB_GET_STREAM_FORMAT 0x0a00
60 #define AC_VERB_GET_AMP_GAIN_MUTE 0x0b00
61 #define AC_VERB_GET_PROC_COEF 0x0c00
62 #define AC_VERB_GET_COEF_INDEX 0x0d00
63 #define AC_VERB_PARAMETERS 0x0f00
64 #define AC_VERB_GET_CONNECT_SEL 0x0f01
65 #define AC_VERB_GET_CONNECT_LIST 0x0f02
66 #define AC_VERB_GET_PROC_STATE 0x0f03
67 #define AC_VERB_GET_SDI_SELECT 0x0f04
68 #define AC_VERB_GET_POWER_STATE 0x0f05
69 #define AC_VERB_GET_CONV 0x0f06
70 #define AC_VERB_GET_PIN_WIDGET_CONTROL 0x0f07
71 #define AC_VERB_GET_UNSOLICITED_RESPONSE 0x0f08
72 #define AC_VERB_GET_PIN_SENSE 0x0f09
73 #define AC_VERB_GET_BEEP_CONTROL 0x0f0a
74 #define AC_VERB_GET_EAPD_BTLENABLE 0x0f0c
75 #define AC_VERB_GET_DIGI_CONVERT 0x0f0d
76 #define AC_VERB_GET_VOLUME_KNOB_CONTROL 0x0f0f
78 #define AC_VERB_GET_GPIO_DATA 0x0f15
79 #define AC_VERB_GET_GPIO_MASK 0x0f16
80 #define AC_VERB_GET_GPIO_DIRECTION 0x0f17
81 #define AC_VERB_GET_CONFIG_DEFAULT 0x0f1c
83 #define AC_VERB_GET_SUBSYSTEM_ID 0x0f20
88 #define AC_VERB_SET_STREAM_FORMAT 0x200
89 #define AC_VERB_SET_AMP_GAIN_MUTE 0x300
90 #define AC_VERB_SET_PROC_COEF 0x400
91 #define AC_VERB_SET_COEF_INDEX 0x500
92 #define AC_VERB_SET_CONNECT_SEL 0x701
93 #define AC_VERB_SET_PROC_STATE 0x703
94 #define AC_VERB_SET_SDI_SELECT 0x704
95 #define AC_VERB_SET_POWER_STATE 0x705
96 #define AC_VERB_SET_CHANNEL_STREAMID 0x706
97 #define AC_VERB_SET_PIN_WIDGET_CONTROL 0x707
98 #define AC_VERB_SET_UNSOLICITED_ENABLE 0x708
99 #define AC_VERB_SET_PIN_SENSE 0x709
100 #define AC_VERB_SET_BEEP_CONTROL 0x70a
101 #define AC_VERB_SET_EAPD_BTLENALBE 0x70c
102 #define AC_VERB_SET_DIGI_CONVERT_1 0x70d
103 #define AC_VERB_SET_DIGI_CONVERT_2 0x70e
104 #define AC_VERB_SET_VOLUME_KNOB_CONTROL 0x70f
105 #define AC_VERB_SET_GPIO_DATA 0x715
106 #define AC_VERB_SET_GPIO_MASK 0x716
107 #define AC_VERB_SET_GPIO_DIRECTION 0x717
108 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_0 0x71c
109 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_1 0x71d
110 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_2 0x71e
111 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_3 0x71f
112 #define AC_VERB_SET_CODEC_RESET 0x7ff
117 #define AC_PAR_VENDOR_ID 0x00
118 #define AC_PAR_SUBSYSTEM_ID 0x01
119 #define AC_PAR_REV_ID 0x02
120 #define AC_PAR_NODE_COUNT 0x04
121 #define AC_PAR_FUNCTION_TYPE 0x05
122 #define AC_PAR_AUDIO_FG_CAP 0x08
123 #define AC_PAR_AUDIO_WIDGET_CAP 0x09
124 #define AC_PAR_PCM 0x0a
125 #define AC_PAR_STREAM 0x0b
126 #define AC_PAR_PIN_CAP 0x0c
127 #define AC_PAR_AMP_IN_CAP 0x0d
128 #define AC_PAR_CONNLIST_LEN 0x0e
129 #define AC_PAR_POWER_STATE 0x0f
130 #define AC_PAR_PROC_CAP 0x10
131 #define AC_PAR_GPIO_CAP 0x11
132 #define AC_PAR_AMP_OUT_CAP 0x12
135 * AC_VERB_PARAMETERS results (32bit)
138 /* Function Group Type */
139 #define AC_FGT_TYPE (0xff<<0)
140 #define AC_FGT_TYPE_SHIFT 0
141 #define AC_FGT_UNSOL_CAP (1<<8)
143 /* Audio Function Group Capabilities */
144 #define AC_AFG_OUT_DELAY (0xf<<0)
145 #define AC_AFG_IN_DELAY (0xf<<8)
146 #define AC_AFG_BEEP_GEN (1<<16)
148 /* Audio Widget Capabilities */
149 #define AC_WCAP_STEREO (1<<0) /* stereo I/O */
150 #define AC_WCAP_IN_AMP (1<<1) /* AMP-in present */
151 #define AC_WCAP_OUT_AMP (1<<2) /* AMP-out present */
152 #define AC_WCAP_AMP_OVRD (1<<3) /* AMP-parameter override */
153 #define AC_WCAP_FORMAT_OVRD (1<<4) /* format override */
154 #define AC_WCAP_STRIPE (1<<5) /* stripe */
155 #define AC_WCAP_PROC_WID (1<<6) /* Proc Widget */
156 #define AC_WCAP_UNSOL_CAP (1<<7) /* Unsol capable */
157 #define AC_WCAP_CONN_LIST (1<<8) /* connection list */
158 #define AC_WCAP_DIGITAL (1<<9) /* digital I/O */
159 #define AC_WCAP_POWER (1<<10) /* power control */
160 #define AC_WCAP_LR_SWAP (1<<11) /* L/R swap */
161 #define AC_WCAP_DELAY (0xf<<16)
162 #define AC_WCAP_DELAY_SHIFT 16
163 #define AC_WCAP_TYPE (0xf<<20)
164 #define AC_WCAP_TYPE_SHIFT 20
166 /* supported PCM rates and bits */
167 #define AC_SUPPCM_RATES (0xfff << 0)
168 #define AC_SUPPCM_BITS_8 (1<<16)
169 #define AC_SUPPCM_BITS_16 (1<<17)
170 #define AC_SUPPCM_BITS_20 (1<<18)
171 #define AC_SUPPCM_BITS_24 (1<<19)
172 #define AC_SUPPCM_BITS_32 (1<<20)
174 /* supported PCM stream format */
175 #define AC_SUPFMT_PCM (1<<0)
176 #define AC_SUPFMT_FLOAT32 (1<<1)
177 #define AC_SUPFMT_AC3 (1<<2)
179 /* Pin widget capabilies */
180 #define AC_PINCAP_IMP_SENSE (1<<0) /* impedance sense capable */
181 #define AC_PINCAP_TRIG_REQ (1<<1) /* trigger required */
182 #define AC_PINCAP_PRES_DETECT (1<<2) /* presence detect capable */
183 #define AC_PINCAP_HP_DRV (1<<3) /* headphone drive capable */
184 #define AC_PINCAP_OUT (1<<4) /* output capable */
185 #define AC_PINCAP_IN (1<<5) /* input capable */
186 #define AC_PINCAP_BALANCE (1<<6) /* balanced I/O capable */
187 #define AC_PINCAP_VREF (0x37<<8)
188 #define AC_PINCAP_VREF_SHIFT 8
189 #define AC_PINCAP_EAPD (1<<16) /* EAPD capable */
190 /* Vref status (used in pin cap) */
191 #define AC_PINCAP_VREF_HIZ (1<<0) /* Hi-Z */
192 #define AC_PINCAP_VREF_50 (1<<1) /* 50% */
193 #define AC_PINCAP_VREF_GRD (1<<2) /* ground */
194 #define AC_PINCAP_VREF_80 (1<<4) /* 80% */
195 #define AC_PINCAP_VREF_100 (1<<5) /* 100% */
197 /* Amplifier capabilities */
198 #define AC_AMPCAP_OFFSET (0x7f<<0) /* 0dB offset */
199 #define AC_AMPCAP_OFFSET_SHIFT 0
200 #define AC_AMPCAP_NUM_STEPS (0x7f<<8) /* number of steps */
201 #define AC_AMPCAP_NUM_STEPS_SHIFT 8
202 #define AC_AMPCAP_STEP_SIZE (0x7f<<16) /* step size 0-32dB in 0.25dB */
203 #define AC_AMPCAP_STEP_SIZE_SHIFT 16
204 #define AC_AMPCAP_MUTE (1<<31) /* mute capable */
205 #define AC_AMPCAP_MUTE_SHIFT 31
207 /* Connection list */
208 #define AC_CLIST_LENGTH (0x7f<<0)
209 #define AC_CLIST_LONG (1<<7)
211 /* Supported power status */
212 #define AC_PWRST_D0SUP (1<<0)
213 #define AC_PWRST_D1SUP (1<<1)
214 #define AC_PWRST_D2SUP (1<<2)
215 #define AC_PWRST_D3SUP (1<<3)
217 /* Processing capabilies */
218 #define AC_PCAP_BENIGN (1<<0)
219 #define AC_PCAP_NUM_COEF (0xff<<8)
221 /* Volume knobs capabilities */
222 #define AC_KNBCAP_NUM_STEPS (0x7f<<0)
223 #define AC_KNBCAP_DELTA (1<<8)
230 #define AC_AMP_MUTE (1<<8)
231 #define AC_AMP_GAIN (0x7f)
232 #define AC_AMP_GET_INDEX (0xf<<0)
234 #define AC_AMP_GET_LEFT (1<<13)
235 #define AC_AMP_GET_RIGHT (0<<13)
236 #define AC_AMP_GET_OUTPUT (1<<15)
237 #define AC_AMP_GET_INPUT (0<<15)
239 #define AC_AMP_SET_INDEX (0xf<<8)
240 #define AC_AMP_SET_INDEX_SHIFT 8
241 #define AC_AMP_SET_RIGHT (1<<12)
242 #define AC_AMP_SET_LEFT (1<<13)
243 #define AC_AMP_SET_INPUT (1<<14)
244 #define AC_AMP_SET_OUTPUT (1<<15)
247 #define AC_DIG1_ENABLE (1<<0)
248 #define AC_DIG1_V (1<<1)
249 #define AC_DIG1_VCFG (1<<2)
250 #define AC_DIG1_EMPHASIS (1<<3)
251 #define AC_DIG1_COPYRIGHT (1<<4)
252 #define AC_DIG1_NONAUDIO (1<<5)
253 #define AC_DIG1_PROFESSIONAL (1<<6)
254 #define AC_DIG1_LEVEL (1<<7)
256 /* Pin widget control - 8bit */
257 #define AC_PINCTL_VREFEN (0x7<<0)
258 #define AC_PINCTL_VREF_HIZ 0 /* Hi-Z */
259 #define AC_PINCTL_VREF_50 1 /* 50% */
260 #define AC_PINCTL_VREF_GRD 2 /* ground */
261 #define AC_PINCTL_VREF_80 4 /* 80% */
262 #define AC_PINCTL_VREF_100 5 /* 100% */
263 #define AC_PINCTL_IN_EN (1<<5)
264 #define AC_PINCTL_OUT_EN (1<<6)
265 #define AC_PINCTL_HP_EN (1<<7)
267 /* Unsolicited response - 8bit */
268 #define AC_USRSP_EN (1<<7)
270 /* configuration default - 32bit */
271 #define AC_DEFCFG_SEQUENCE (0xf<<0)
272 #define AC_DEFCFG_DEF_ASSOC (0xf<<4)
273 #define AC_DEFCFG_ASSOC_SHIFT 4
274 #define AC_DEFCFG_MISC (0xf<<8)
275 #define AC_DEFCFG_MISC_SHIFT 8
276 #define AC_DEFCFG_COLOR (0xf<<12)
277 #define AC_DEFCFG_COLOR_SHIFT 12
278 #define AC_DEFCFG_CONN_TYPE (0xf<<16)
279 #define AC_DEFCFG_CONN_TYPE_SHIFT 16
280 #define AC_DEFCFG_DEVICE (0xf<<20)
281 #define AC_DEFCFG_DEVICE_SHIFT 20
282 #define AC_DEFCFG_LOCATION (0x3f<<24)
283 #define AC_DEFCFG_LOCATION_SHIFT 24
284 #define AC_DEFCFG_PORT_CONN (0x3<<30)
285 #define AC_DEFCFG_PORT_CONN_SHIFT 30
287 /* device device types (0x0-0xf) */
294 AC_JACK_DIG_OTHER_OUT
,
295 AC_JACK_MODEM_LINE_SIDE
,
296 AC_JACK_MODEM_HAND_SIDE
,
302 AC_JACK_DIG_OTHER_IN
,
306 /* jack connection types (0x0-0xf) */
308 AC_JACK_CONN_UNKNOWN
,
313 AC_JACK_CONN_OPTICAL
,
314 AC_JACK_CONN_OTHER_DIGITAL
,
315 AC_JACK_CONN_OTHER_ANALOG
,
320 AC_JACK_CONN_OTHER
= 0xf,
323 /* jack colors (0x0-0xf) */
325 AC_JACK_COLOR_UNKNOWN
,
331 AC_JACK_COLOR_ORANGE
,
332 AC_JACK_COLOR_YELLOW
,
333 AC_JACK_COLOR_PURPLE
,
335 AC_JACK_COLOR_WHITE
= 0xe,
339 /* Jack location (0x0-0x3f) */
352 AC_JACK_LOC_EXTERNAL
= 0x00,
353 AC_JACK_LOC_INTERNAL
= 0x10,
354 AC_JACK_LOC_SEPARATE
= 0x20,
355 AC_JACK_LOC_OTHER
= 0x30,
358 /* external on primary chasis */
359 AC_JACK_LOC_REAR_PANEL
= 0x07,
360 AC_JACK_LOC_DRIVE_BAY
,
362 AC_JACK_LOC_RISER
= 0x17,
366 AC_JACK_LOC_MOBILE_IN
= 0x37,
367 AC_JACK_LOC_MOBILE_OUT
,
370 /* Port connectivity (0-3) */
372 AC_JACK_PORT_COMPLEX
,
378 /* max. connections to a widget */
379 #define HDA_MAX_CONNECTIONS 16
381 /* max. codec address */
382 #define HDA_MAX_CODEC_ADDRESS 0x0f
391 struct hda_pcm_stream
;
392 struct hda_bus_unsolicited
;
395 typedef u16 hda_nid_t
;
399 /* send a single command */
400 int (*command
)(struct hda_codec
*codec
, hda_nid_t nid
, int direct
,
401 unsigned int verb
, unsigned int parm
);
402 /* get a response from the last command */
403 unsigned int (*get_response
)(struct hda_codec
*codec
);
404 /* free the private data */
405 void (*private_free
)(struct hda_bus
*);
408 /* template to pass to the bus constructor */
409 struct hda_bus_template
{
412 const char *modelname
;
413 struct hda_bus_ops ops
;
419 * each controller needs to creata a hda_bus to assign the accessor.
420 * A hda_bus contains several codecs in the list codec_list.
425 /* copied from template */
428 const char *modelname
;
429 struct hda_bus_ops ops
;
431 /* codec linked list */
432 struct list_head codec_list
;
433 struct hda_codec
*caddr_tbl
[HDA_MAX_CODEC_ADDRESS
+ 1]; /* caddr -> codec */
435 struct semaphore cmd_mutex
;
437 /* unsolicited event queue */
438 struct hda_bus_unsolicited
*unsol
;
440 snd_info_entry_t
*proc
;
446 * Known codecs have the patch to build and set up the controls/PCMs
447 * better than the generic parser.
449 struct hda_codec_preset
{
453 unsigned int subs_mask
;
456 int (*patch
)(struct hda_codec
*codec
);
459 /* ops set by the preset patch */
460 struct hda_codec_ops
{
461 int (*build_controls
)(struct hda_codec
*codec
);
462 int (*build_pcms
)(struct hda_codec
*codec
);
463 int (*init
)(struct hda_codec
*codec
);
464 void (*free
)(struct hda_codec
*codec
);
465 void (*unsol_event
)(struct hda_codec
*codec
, unsigned int res
);
467 int (*suspend
)(struct hda_codec
*codec
, pm_message_t state
);
468 int (*resume
)(struct hda_codec
*codec
);
472 /* record for amp information cache */
473 struct hda_amp_info
{
474 u32 key
; /* hash key */
475 u32 amp_caps
; /* amp capabilities */
476 u16 vol
[2]; /* current volume & mute*/
477 u16 status
; /* update flag */
478 u16 next
; /* next link */
483 int (*open
)(struct hda_pcm_stream
*info
, struct hda_codec
*codec
,
484 snd_pcm_substream_t
*substream
);
485 int (*close
)(struct hda_pcm_stream
*info
, struct hda_codec
*codec
,
486 snd_pcm_substream_t
*substream
);
487 int (*prepare
)(struct hda_pcm_stream
*info
, struct hda_codec
*codec
,
488 unsigned int stream_tag
, unsigned int format
,
489 snd_pcm_substream_t
*substream
);
490 int (*cleanup
)(struct hda_pcm_stream
*info
, struct hda_codec
*codec
,
491 snd_pcm_substream_t
*substream
);
494 /* PCM information for each substream */
495 struct hda_pcm_stream
{
496 unsigned int substreams
; /* number of substreams, 0 = not exist */
497 unsigned int channels_min
; /* min. number of channels */
498 unsigned int channels_max
; /* max. number of channels */
499 hda_nid_t nid
; /* default NID to query rates/formats/bps, or set up */
500 u32 rates
; /* supported rates */
501 u64 formats
; /* supported formats (SNDRV_PCM_FMTBIT_) */
502 unsigned int maxbps
; /* supported max. bit per sample */
503 struct hda_pcm_ops ops
;
506 /* for PCM creation */
509 struct hda_pcm_stream stream
[2];
510 unsigned int is_modem
; /* modem codec? */
513 /* codec information */
516 unsigned int addr
; /* codec addr*/
517 struct list_head list
; /* list point */
519 hda_nid_t afg
; /* AFG node id */
520 hda_nid_t mfg
; /* MFG node id */
527 /* detected preset */
528 const struct hda_codec_preset
*preset
;
531 struct hda_codec_ops patch_ops
;
533 /* resume phase - all controls should update even if
534 * the values are not changed
536 unsigned int in_resume
;
538 /* PCM to create, set by patch_ops.build_pcms callback */
539 unsigned int num_pcms
;
540 struct hda_pcm
*pcm_info
;
542 /* codec specific info */
545 /* hash for amp access */
548 struct hda_amp_info amp_info
[128]; /* big enough? */
550 struct semaphore spdif_mutex
;
551 unsigned int spdif_status
; /* IEC958 status bits */
552 unsigned short spdif_ctls
; /* SPDIF control bits */
553 unsigned int spdif_in_enable
; /* SPDIF input enable? */
558 HDA_INPUT
, HDA_OUTPUT
565 int snd_hda_bus_new(snd_card_t
*card
, const struct hda_bus_template
*temp
,
566 struct hda_bus
**busp
);
567 int snd_hda_codec_new(struct hda_bus
*bus
, unsigned int codec_addr
,
568 struct hda_codec
**codecp
);
571 * low level functions
573 unsigned int snd_hda_codec_read(struct hda_codec
*codec
, hda_nid_t nid
, int direct
,
574 unsigned int verb
, unsigned int parm
);
575 int snd_hda_codec_write(struct hda_codec
*codec
, hda_nid_t nid
, int direct
,
576 unsigned int verb
, unsigned int parm
);
577 #define snd_hda_param_read(codec, nid, param) snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
578 int snd_hda_get_sub_nodes(struct hda_codec
*codec
, hda_nid_t nid
, hda_nid_t
*start_id
);
579 int snd_hda_get_connections(struct hda_codec
*codec
, hda_nid_t nid
, hda_nid_t
*conn_list
, int max_conns
);
587 void snd_hda_sequence_write(struct hda_codec
*codec
, const struct hda_verb
*seq
);
589 /* unsolicited event */
590 int snd_hda_queue_unsol_event(struct hda_bus
*bus
, u32 res
, u32 res_ex
);
595 int snd_hda_build_controls(struct hda_bus
*bus
);
600 int snd_hda_build_pcms(struct hda_bus
*bus
);
601 void snd_hda_codec_setup_stream(struct hda_codec
*codec
, hda_nid_t nid
, u32 stream_tag
,
602 int channel_id
, int format
);
603 unsigned int snd_hda_calc_stream_format(unsigned int rate
, unsigned int channels
,
604 unsigned int format
, unsigned int maxbps
);
605 int snd_hda_query_supported_pcm(struct hda_codec
*codec
, hda_nid_t nid
,
606 u32
*ratesp
, u64
*formatsp
, unsigned int *bpsp
);
607 int snd_hda_is_supported_format(struct hda_codec
*codec
, hda_nid_t nid
,
608 unsigned int format
);
613 void snd_hda_get_codec_name(struct hda_codec
*codec
, char *name
, int namelen
);
619 int snd_hda_suspend(struct hda_bus
*bus
, pm_message_t state
);
620 int snd_hda_resume(struct hda_bus
*bus
);
623 #endif /* __SOUND_HDA_CODEC_H */