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>
27 #include <sound/hwdep.h>
32 #define AC_NODE_ROOT 0x00
35 * function group types
38 AC_GRP_AUDIO_FUNCTION = 0x01,
39 AC_GRP_MODEM_FUNCTION = 0x02,
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 */
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 0x0f0d
77 #define AC_VERB_GET_VOLUME_KNOB_CONTROL 0x0f0f
79 #define AC_VERB_GET_GPIO_DATA 0x0f15
80 #define AC_VERB_GET_GPIO_MASK 0x0f16
81 #define AC_VERB_GET_GPIO_DIRECTION 0x0f17
82 #define AC_VERB_GET_CONFIG_DEFAULT 0x0f1c
84 #define AC_VERB_GET_SUBSYSTEM_ID 0x0f20
89 #define AC_VERB_SET_STREAM_FORMAT 0x200
90 #define AC_VERB_SET_AMP_GAIN_MUTE 0x300
91 #define AC_VERB_SET_PROC_COEF 0x400
92 #define AC_VERB_SET_COEF_INDEX 0x500
93 #define AC_VERB_SET_CONNECT_SEL 0x701
94 #define AC_VERB_SET_PROC_STATE 0x703
95 #define AC_VERB_SET_SDI_SELECT 0x704
96 #define AC_VERB_SET_POWER_STATE 0x705
97 #define AC_VERB_SET_CHANNEL_STREAMID 0x706
98 #define AC_VERB_SET_PIN_WIDGET_CONTROL 0x707
99 #define AC_VERB_SET_UNSOLICITED_ENABLE 0x708
100 #define AC_VERB_SET_PIN_SENSE 0x709
101 #define AC_VERB_SET_BEEP_CONTROL 0x70a
102 #define AC_VERB_SET_EAPD_BTLENABLE 0x70c
103 #define AC_VERB_SET_DIGI_CONVERT_1 0x70d
104 #define AC_VERB_SET_DIGI_CONVERT_2 0x70e
105 #define AC_VERB_SET_VOLUME_KNOB_CONTROL 0x70f
106 #define AC_VERB_SET_GPIO_DATA 0x715
107 #define AC_VERB_SET_GPIO_MASK 0x716
108 #define AC_VERB_SET_GPIO_DIRECTION 0x717
109 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_0 0x71c
110 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_1 0x71d
111 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_2 0x71e
112 #define AC_VERB_SET_CONFIG_DEFAULT_BYTES_3 0x71f
113 #define AC_VERB_SET_CODEC_RESET 0x7ff
118 #define AC_PAR_VENDOR_ID 0x00
119 #define AC_PAR_SUBSYSTEM_ID 0x01
120 #define AC_PAR_REV_ID 0x02
121 #define AC_PAR_NODE_COUNT 0x04
122 #define AC_PAR_FUNCTION_TYPE 0x05
123 #define AC_PAR_AUDIO_FG_CAP 0x08
124 #define AC_PAR_AUDIO_WIDGET_CAP 0x09
125 #define AC_PAR_PCM 0x0a
126 #define AC_PAR_STREAM 0x0b
127 #define AC_PAR_PIN_CAP 0x0c
128 #define AC_PAR_AMP_IN_CAP 0x0d
129 #define AC_PAR_CONNLIST_LEN 0x0e
130 #define AC_PAR_POWER_STATE 0x0f
131 #define AC_PAR_PROC_CAP 0x10
132 #define AC_PAR_GPIO_CAP 0x11
133 #define AC_PAR_AMP_OUT_CAP 0x12
136 * AC_VERB_PARAMETERS results (32bit)
139 /* Function Group Type */
140 #define AC_FGT_TYPE (0xff<<0)
141 #define AC_FGT_TYPE_SHIFT 0
142 #define AC_FGT_UNSOL_CAP (1<<8)
144 /* Audio Function Group Capabilities */
145 #define AC_AFG_OUT_DELAY (0xf<<0)
146 #define AC_AFG_IN_DELAY (0xf<<8)
147 #define AC_AFG_BEEP_GEN (1<<16)
149 /* Audio Widget Capabilities */
150 #define AC_WCAP_STEREO (1<<0) /* stereo I/O */
151 #define AC_WCAP_IN_AMP (1<<1) /* AMP-in present */
152 #define AC_WCAP_OUT_AMP (1<<2) /* AMP-out present */
153 #define AC_WCAP_AMP_OVRD (1<<3) /* AMP-parameter override */
154 #define AC_WCAP_FORMAT_OVRD (1<<4) /* format override */
155 #define AC_WCAP_STRIPE (1<<5) /* stripe */
156 #define AC_WCAP_PROC_WID (1<<6) /* Proc Widget */
157 #define AC_WCAP_UNSOL_CAP (1<<7) /* Unsol capable */
158 #define AC_WCAP_CONN_LIST (1<<8) /* connection list */
159 #define AC_WCAP_DIGITAL (1<<9) /* digital I/O */
160 #define AC_WCAP_POWER (1<<10) /* power control */
161 #define AC_WCAP_LR_SWAP (1<<11) /* L/R swap */
162 #define AC_WCAP_DELAY (0xf<<16)
163 #define AC_WCAP_DELAY_SHIFT 16
164 #define AC_WCAP_TYPE (0xf<<20)
165 #define AC_WCAP_TYPE_SHIFT 20
167 /* supported PCM rates and bits */
168 #define AC_SUPPCM_RATES (0xfff << 0)
169 #define AC_SUPPCM_BITS_8 (1<<16)
170 #define AC_SUPPCM_BITS_16 (1<<17)
171 #define AC_SUPPCM_BITS_20 (1<<18)
172 #define AC_SUPPCM_BITS_24 (1<<19)
173 #define AC_SUPPCM_BITS_32 (1<<20)
175 /* supported PCM stream format */
176 #define AC_SUPFMT_PCM (1<<0)
177 #define AC_SUPFMT_FLOAT32 (1<<1)
178 #define AC_SUPFMT_AC3 (1<<2)
180 /* Pin widget capabilies */
181 #define AC_PINCAP_IMP_SENSE (1<<0) /* impedance sense capable */
182 #define AC_PINCAP_TRIG_REQ (1<<1) /* trigger required */
183 #define AC_PINCAP_PRES_DETECT (1<<2) /* presence detect capable */
184 #define AC_PINCAP_HP_DRV (1<<3) /* headphone drive capable */
185 #define AC_PINCAP_OUT (1<<4) /* output capable */
186 #define AC_PINCAP_IN (1<<5) /* input capable */
187 #define AC_PINCAP_BALANCE (1<<6) /* balanced I/O capable */
188 #define AC_PINCAP_VREF (0x37<<8)
189 #define AC_PINCAP_VREF_SHIFT 8
190 #define AC_PINCAP_EAPD (1<<16) /* EAPD capable */
191 /* Vref status (used in pin cap) */
192 #define AC_PINCAP_VREF_HIZ (1<<0) /* Hi-Z */
193 #define AC_PINCAP_VREF_50 (1<<1) /* 50% */
194 #define AC_PINCAP_VREF_GRD (1<<2) /* ground */
195 #define AC_PINCAP_VREF_80 (1<<4) /* 80% */
196 #define AC_PINCAP_VREF_100 (1<<5) /* 100% */
198 /* Amplifier capabilities */
199 #define AC_AMPCAP_OFFSET (0x7f<<0) /* 0dB offset */
200 #define AC_AMPCAP_OFFSET_SHIFT 0
201 #define AC_AMPCAP_NUM_STEPS (0x7f<<8) /* number of steps */
202 #define AC_AMPCAP_NUM_STEPS_SHIFT 8
203 #define AC_AMPCAP_STEP_SIZE (0x7f<<16) /* step size 0-32dB
206 #define AC_AMPCAP_STEP_SIZE_SHIFT 16
207 #define AC_AMPCAP_MUTE (1<<31) /* mute capable */
208 #define AC_AMPCAP_MUTE_SHIFT 31
210 /* Connection list */
211 #define AC_CLIST_LENGTH (0x7f<<0)
212 #define AC_CLIST_LONG (1<<7)
214 /* Supported power status */
215 #define AC_PWRST_D0SUP (1<<0)
216 #define AC_PWRST_D1SUP (1<<1)
217 #define AC_PWRST_D2SUP (1<<2)
218 #define AC_PWRST_D3SUP (1<<3)
220 /* Power state values */
221 #define AC_PWRST_D0 0x00
222 #define AC_PWRST_D1 0x01
223 #define AC_PWRST_D2 0x02
224 #define AC_PWRST_D3 0x03
226 /* Processing capabilies */
227 #define AC_PCAP_BENIGN (1<<0)
228 #define AC_PCAP_NUM_COEF (0xff<<8)
230 /* Volume knobs capabilities */
231 #define AC_KNBCAP_NUM_STEPS (0x7f<<0)
232 #define AC_KNBCAP_DELTA (1<<8)
239 #define AC_AMP_MUTE (1<<7)
240 #define AC_AMP_GAIN (0x7f)
241 #define AC_AMP_GET_INDEX (0xf<<0)
243 #define AC_AMP_GET_LEFT (1<<13)
244 #define AC_AMP_GET_RIGHT (0<<13)
245 #define AC_AMP_GET_OUTPUT (1<<15)
246 #define AC_AMP_GET_INPUT (0<<15)
248 #define AC_AMP_SET_INDEX (0xf<<8)
249 #define AC_AMP_SET_INDEX_SHIFT 8
250 #define AC_AMP_SET_RIGHT (1<<12)
251 #define AC_AMP_SET_LEFT (1<<13)
252 #define AC_AMP_SET_INPUT (1<<14)
253 #define AC_AMP_SET_OUTPUT (1<<15)
256 #define AC_DIG1_ENABLE (1<<0)
257 #define AC_DIG1_V (1<<1)
258 #define AC_DIG1_VCFG (1<<2)
259 #define AC_DIG1_EMPHASIS (1<<3)
260 #define AC_DIG1_COPYRIGHT (1<<4)
261 #define AC_DIG1_NONAUDIO (1<<5)
262 #define AC_DIG1_PROFESSIONAL (1<<6)
263 #define AC_DIG1_LEVEL (1<<7)
265 /* Pin widget control - 8bit */
266 #define AC_PINCTL_VREFEN (0x7<<0)
267 #define AC_PINCTL_VREF_HIZ 0 /* Hi-Z */
268 #define AC_PINCTL_VREF_50 1 /* 50% */
269 #define AC_PINCTL_VREF_GRD 2 /* ground */
270 #define AC_PINCTL_VREF_80 4 /* 80% */
271 #define AC_PINCTL_VREF_100 5 /* 100% */
272 #define AC_PINCTL_IN_EN (1<<5)
273 #define AC_PINCTL_OUT_EN (1<<6)
274 #define AC_PINCTL_HP_EN (1<<7)
276 /* Unsolicited response - 8bit */
277 #define AC_USRSP_EN (1<<7)
279 /* configuration default - 32bit */
280 #define AC_DEFCFG_SEQUENCE (0xf<<0)
281 #define AC_DEFCFG_DEF_ASSOC (0xf<<4)
282 #define AC_DEFCFG_ASSOC_SHIFT 4
283 #define AC_DEFCFG_MISC (0xf<<8)
284 #define AC_DEFCFG_MISC_SHIFT 8
285 #define AC_DEFCFG_COLOR (0xf<<12)
286 #define AC_DEFCFG_COLOR_SHIFT 12
287 #define AC_DEFCFG_CONN_TYPE (0xf<<16)
288 #define AC_DEFCFG_CONN_TYPE_SHIFT 16
289 #define AC_DEFCFG_DEVICE (0xf<<20)
290 #define AC_DEFCFG_DEVICE_SHIFT 20
291 #define AC_DEFCFG_LOCATION (0x3f<<24)
292 #define AC_DEFCFG_LOCATION_SHIFT 24
293 #define AC_DEFCFG_PORT_CONN (0x3<<30)
294 #define AC_DEFCFG_PORT_CONN_SHIFT 30
296 /* device device types (0x0-0xf) */
303 AC_JACK_DIG_OTHER_OUT,
304 AC_JACK_MODEM_LINE_SIDE,
305 AC_JACK_MODEM_HAND_SIDE,
311 AC_JACK_DIG_OTHER_IN,
315 /* jack connection types (0x0-0xf) */
317 AC_JACK_CONN_UNKNOWN,
322 AC_JACK_CONN_OPTICAL,
323 AC_JACK_CONN_OTHER_DIGITAL,
324 AC_JACK_CONN_OTHER_ANALOG,
329 AC_JACK_CONN_OTHER = 0xf,
332 /* jack colors (0x0-0xf) */
334 AC_JACK_COLOR_UNKNOWN,
340 AC_JACK_COLOR_ORANGE,
341 AC_JACK_COLOR_YELLOW,
342 AC_JACK_COLOR_PURPLE,
344 AC_JACK_COLOR_WHITE = 0xe,
348 /* Jack location (0x0-0x3f) */
361 AC_JACK_LOC_EXTERNAL = 0x00,
362 AC_JACK_LOC_INTERNAL = 0x10,
363 AC_JACK_LOC_SEPARATE = 0x20,
364 AC_JACK_LOC_OTHER = 0x30,
367 /* external on primary chasis */
368 AC_JACK_LOC_REAR_PANEL = 0x07,
369 AC_JACK_LOC_DRIVE_BAY,
371 AC_JACK_LOC_RISER = 0x17,
375 AC_JACK_LOC_MOBILE_IN = 0x37,
376 AC_JACK_LOC_MOBILE_OUT,
379 /* Port connectivity (0-3) */
381 AC_JACK_PORT_COMPLEX,
387 /* max. connections to a widget */
388 #define HDA_MAX_CONNECTIONS 32
390 /* max. codec address */
391 #define HDA_MAX_CODEC_ADDRESS 0x0f
400 struct hda_pcm_stream;
401 struct hda_bus_unsolicited;
404 typedef u16 hda_nid_t;
408 /* send a single command */
409 int (*command)(struct hda_codec *codec, hda_nid_t nid, int direct,
410 unsigned int verb, unsigned int parm);
411 /* get a response from the last command */
412 unsigned int (*get_response)(struct hda_codec *codec);
413 /* free the private data */
414 void (*private_free)(struct hda_bus *);
417 /* template to pass to the bus constructor */
418 struct hda_bus_template {
421 const char *modelname;
422 struct hda_bus_ops ops;
428 * each controller needs to creata a hda_bus to assign the accessor.
429 * A hda_bus contains several codecs in the list codec_list.
432 struct snd_card *card;
434 /* copied from template */
437 const char *modelname;
438 struct hda_bus_ops ops;
440 /* codec linked list */
441 struct list_head codec_list;
442 /* link caddr -> codec */
443 struct hda_codec *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
445 struct mutex cmd_mutex;
447 /* unsolicited event queue */
448 struct hda_bus_unsolicited *unsol;
450 struct snd_info_entry *proc;
456 * Known codecs have the patch to build and set up the controls/PCMs
457 * better than the generic parser.
459 struct hda_codec_preset {
463 unsigned int subs_mask;
466 int (*patch)(struct hda_codec *codec);
469 /* ops set by the preset patch */
470 struct hda_codec_ops {
471 int (*build_controls)(struct hda_codec *codec);
472 int (*build_pcms)(struct hda_codec *codec);
473 int (*init)(struct hda_codec *codec);
474 void (*free)(struct hda_codec *codec);
475 void (*unsol_event)(struct hda_codec *codec, unsigned int res);
477 int (*suspend)(struct hda_codec *codec, pm_message_t state);
478 int (*resume)(struct hda_codec *codec);
482 /* record for amp information cache */
483 struct hda_cache_head {
484 u32 key; /* hash key */
485 u16 val; /* assigned value */
486 u16 next; /* next link; -1 = terminal */
489 struct hda_amp_info {
490 struct hda_cache_head head;
491 u32 amp_caps; /* amp capabilities */
492 u16 vol[2]; /* current volume & mute */
495 struct hda_cache_rec {
496 u16 hash[64]; /* hash table for index */
497 unsigned int num_entries; /* number of assigned entries */
498 unsigned int size; /* allocated size */
499 unsigned int record_size; /* record size (including header) */
500 void *buffer; /* hash table entries */
505 int (*open)(struct hda_pcm_stream *info, struct hda_codec *codec,
506 struct snd_pcm_substream *substream);
507 int (*close)(struct hda_pcm_stream *info, struct hda_codec *codec,
508 struct snd_pcm_substream *substream);
509 int (*prepare)(struct hda_pcm_stream *info, struct hda_codec *codec,
510 unsigned int stream_tag, unsigned int format,
511 struct snd_pcm_substream *substream);
512 int (*cleanup)(struct hda_pcm_stream *info, struct hda_codec *codec,
513 struct snd_pcm_substream *substream);
516 /* PCM information for each substream */
517 struct hda_pcm_stream {
518 unsigned int substreams; /* number of substreams, 0 = not exist*/
519 unsigned int channels_min; /* min. number of channels */
520 unsigned int channels_max; /* max. number of channels */
521 hda_nid_t nid; /* default NID to query rates/formats/bps, or set up */
522 u32 rates; /* supported rates */
523 u64 formats; /* supported formats (SNDRV_PCM_FMTBIT_) */
524 unsigned int maxbps; /* supported max. bit per sample */
525 struct hda_pcm_ops ops;
528 /* for PCM creation */
531 struct hda_pcm_stream stream[2];
532 unsigned int is_modem; /* modem codec? */
535 /* codec information */
538 unsigned int addr; /* codec addr*/
539 struct list_head list; /* list point */
541 hda_nid_t afg; /* AFG node id */
542 hda_nid_t mfg; /* MFG node id */
549 /* detected preset */
550 const struct hda_codec_preset *preset;
553 struct hda_codec_ops patch_ops;
555 /* PCM to create, set by patch_ops.build_pcms callback */
556 unsigned int num_pcms;
557 struct hda_pcm *pcm_info;
559 /* codec specific info */
562 /* widget capabilities cache */
563 unsigned int num_nodes;
567 struct hda_cache_rec amp_cache; /* cache for amp access */
568 struct hda_cache_rec cmd_cache; /* cache for other commands */
570 struct mutex spdif_mutex;
571 unsigned int spdif_status; /* IEC958 status bits */
572 unsigned short spdif_ctls; /* SPDIF control bits */
573 unsigned int spdif_in_enable; /* SPDIF input enable? */
575 struct snd_hwdep *hwdep; /* assigned hwdep device */
580 HDA_INPUT, HDA_OUTPUT
587 int snd_hda_bus_new(struct snd_card *card, const struct hda_bus_template *temp,
588 struct hda_bus **busp);
589 int snd_hda_codec_new(struct hda_bus *bus, unsigned int codec_addr,
590 struct hda_codec **codecp);
593 * low level functions
595 unsigned int snd_hda_codec_read(struct hda_codec *codec, hda_nid_t nid,
597 unsigned int verb, unsigned int parm);
598 int snd_hda_codec_write(struct hda_codec *codec, hda_nid_t nid, int direct,
599 unsigned int verb, unsigned int parm);
600 #define snd_hda_param_read(codec, nid, param) \
601 snd_hda_codec_read(codec, nid, 0, AC_VERB_PARAMETERS, param)
602 int snd_hda_get_sub_nodes(struct hda_codec *codec, hda_nid_t nid,
603 hda_nid_t *start_id);
604 int snd_hda_get_connections(struct hda_codec *codec, hda_nid_t nid,
605 hda_nid_t *conn_list, int max_conns);
613 void snd_hda_sequence_write(struct hda_codec *codec,
614 const struct hda_verb *seq);
616 /* unsolicited event */
617 int snd_hda_queue_unsol_event(struct hda_bus *bus, u32 res, u32 res_ex);
621 int snd_hda_codec_write_cache(struct hda_codec *codec, hda_nid_t nid,
622 int direct, unsigned int verb, unsigned int parm);
623 void snd_hda_sequence_write_cache(struct hda_codec *codec,
624 const struct hda_verb *seq);
625 void snd_hda_codec_resume_cache(struct hda_codec *codec);
627 #define snd_hda_codec_write_cache snd_hda_codec_write
628 #define snd_hda_sequence_write_cache snd_hda_sequence_write
634 int snd_hda_build_controls(struct hda_bus *bus);
639 int snd_hda_build_pcms(struct hda_bus *bus);
640 void snd_hda_codec_setup_stream(struct hda_codec *codec, hda_nid_t nid,
642 int channel_id, int format);
643 unsigned int snd_hda_calc_stream_format(unsigned int rate,
644 unsigned int channels,
646 unsigned int maxbps);
647 int snd_hda_query_supported_pcm(struct hda_codec *codec, hda_nid_t nid,
648 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
649 int snd_hda_is_supported_format(struct hda_codec *codec, hda_nid_t nid,
650 unsigned int format);
655 void snd_hda_get_codec_name(struct hda_codec *codec, char *name, int namelen);
661 int snd_hda_suspend(struct hda_bus *bus, pm_message_t state);
662 int snd_hda_resume(struct hda_bus *bus);
665 #endif /* __SOUND_HDA_CODEC_H */