xref: /openbmc/linux/sound/pci/hda/hda_local.h (revision 834be88d)
1 /*
2  * Universal Interface for Intel High Definition Audio Codec
3  *
4  * Local helper functions
5  *
6  * Copyright (c) 2004 Takashi Iwai <tiwai@suse.de>
7  *
8  *  This program is free software; you can redistribute it and/or modify it
9  *  under the terms of the GNU General Public License as published by the Free
10  *  Software Foundation; either version 2 of the License, or (at your option)
11  *  any later version.
12  *
13  *  This program is distributed in the hope that it will be useful, but WITHOUT
14  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
16  *  more details.
17  *
18  *  You should have received a copy of the GNU General Public License along with
19  *  this program; if not, write to the Free Software Foundation, Inc., 59
20  *  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  */
22 
23 #ifndef __SOUND_HDA_LOCAL_H
24 #define __SOUND_HDA_LOCAL_H
25 
26 /*
27  * for mixer controls
28  */
29 #define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) ((nid) | ((chs)<<16) | ((dir)<<18) | ((idx)<<19))
30 /* mono volume with index (index=0,1,...) (channel=1,2) */
31 #define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
32 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx,  \
33 	  .info = snd_hda_mixer_amp_volume_info, \
34 	  .get = snd_hda_mixer_amp_volume_get, \
35 	  .put = snd_hda_mixer_amp_volume_put, \
36 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
37 /* stereo volume with index */
38 #define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) \
39 	HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
40 /* mono volume */
41 #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) \
42 	HDA_CODEC_VOLUME_MONO_IDX(xname, 0, nid, channel, xindex, direction)
43 /* stereo volume */
44 #define HDA_CODEC_VOLUME(xname, nid, xindex, direction) \
45 	HDA_CODEC_VOLUME_MONO(xname, nid, 3, xindex, direction)
46 /* mono mute switch with index (index=0,1,...) (channel=1,2) */
47 #define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) \
48 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xcidx, \
49 	  .info = snd_hda_mixer_amp_switch_info, \
50 	  .get = snd_hda_mixer_amp_switch_get, \
51 	  .put = snd_hda_mixer_amp_switch_put, \
52 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, xindex, direction) }
53 /* stereo mute switch with index */
54 #define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) \
55 	HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, 3, xindex, direction)
56 /* mono mute switch */
57 #define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) \
58 	HDA_CODEC_MUTE_MONO_IDX(xname, 0, nid, channel, xindex, direction)
59 /* stereo mute switch */
60 #define HDA_CODEC_MUTE(xname, nid, xindex, direction) \
61 	HDA_CODEC_MUTE_MONO(xname, nid, 3, xindex, direction)
62 
63 int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
64 int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
65 int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
66 int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo);
67 int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
68 int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
69 /* lowlevel accessor with caching; use carefully */
70 int snd_hda_codec_amp_read(struct hda_codec *codec, hda_nid_t nid, int ch,
71 			   int direction, int index);
72 int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch,
73 			     int direction, int idx, int mask, int val);
74 
75 /* mono switch binding multiple inputs */
76 #define HDA_BIND_MUTE_MONO(xname, nid, channel, indices, direction) \
77 	{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = 0,  \
78 	  .info = snd_hda_mixer_amp_switch_info, \
79 	  .get = snd_hda_mixer_bind_switch_get, \
80 	  .put = snd_hda_mixer_bind_switch_put, \
81 	  .private_value = HDA_COMPOSE_AMP_VAL(nid, channel, indices, direction) }
82 
83 /* stereo switch binding multiple inputs */
84 #define HDA_BIND_MUTE(xname,nid,indices,dir) HDA_BIND_MUTE_MONO(xname,nid,3,indices,dir)
85 
86 int snd_hda_mixer_bind_switch_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
87 int snd_hda_mixer_bind_switch_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol);
88 
89 int snd_hda_create_spdif_out_ctls(struct hda_codec *codec, hda_nid_t nid);
90 int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid);
91 
92 /*
93  * input MUX helper
94  */
95 #define HDA_MAX_NUM_INPUTS	16
96 struct hda_input_mux_item {
97 	const char *label;
98 	unsigned int index;
99 };
100 struct hda_input_mux {
101 	unsigned int num_items;
102 	struct hda_input_mux_item items[HDA_MAX_NUM_INPUTS];
103 };
104 
105 int snd_hda_input_mux_info(const struct hda_input_mux *imux, struct snd_ctl_elem_info *uinfo);
106 int snd_hda_input_mux_put(struct hda_codec *codec, const struct hda_input_mux *imux,
107 			  struct snd_ctl_elem_value *ucontrol, hda_nid_t nid,
108 			  unsigned int *cur_val);
109 
110 /*
111  * Channel mode helper
112  */
113 struct hda_channel_mode {
114 	int channels;
115 	const struct hda_verb *sequence;
116 };
117 
118 int snd_hda_ch_mode_info(struct hda_codec *codec, struct snd_ctl_elem_info *uinfo,
119 			 const struct hda_channel_mode *chmode, int num_chmodes);
120 int snd_hda_ch_mode_get(struct hda_codec *codec, struct snd_ctl_elem_value *ucontrol,
121 			const struct hda_channel_mode *chmode, int num_chmodes,
122 			int max_channels);
123 int snd_hda_ch_mode_put(struct hda_codec *codec, struct snd_ctl_elem_value *ucontrol,
124 			const struct hda_channel_mode *chmode, int num_chmodes,
125 			int *max_channelsp);
126 
127 /*
128  * Multi-channel / digital-out PCM helper
129  */
130 
131 enum { HDA_FRONT, HDA_REAR, HDA_CLFE, HDA_SIDE }; /* index for dac_nidx */
132 enum { HDA_DIG_NONE, HDA_DIG_EXCLUSIVE, HDA_DIG_ANALOG_DUP }; /* dig_out_used */
133 
134 struct hda_multi_out {
135 	int num_dacs;		/* # of DACs, must be more than 1 */
136 	hda_nid_t *dac_nids;	/* DAC list */
137 	hda_nid_t hp_nid;	/* optional DAC for HP, 0 when not exists */
138 	hda_nid_t dig_out_nid;	/* digital out audio widget */
139 	int max_channels;	/* currently supported analog channels */
140 	int dig_out_used;	/* current usage of digital out (HDA_DIG_XXX) */
141 };
142 
143 int snd_hda_multi_out_dig_open(struct hda_codec *codec, struct hda_multi_out *mout);
144 int snd_hda_multi_out_dig_close(struct hda_codec *codec, struct hda_multi_out *mout);
145 int snd_hda_multi_out_analog_open(struct hda_codec *codec, struct hda_multi_out *mout,
146 				  struct snd_pcm_substream *substream);
147 int snd_hda_multi_out_analog_prepare(struct hda_codec *codec, struct hda_multi_out *mout,
148 				     unsigned int stream_tag,
149 				     unsigned int format,
150 				     struct snd_pcm_substream *substream);
151 int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec, struct hda_multi_out *mout);
152 
153 /*
154  * generic codec parser
155  */
156 int snd_hda_parse_generic_codec(struct hda_codec *codec);
157 
158 /*
159  * generic proc interface
160  */
161 #ifdef CONFIG_PROC_FS
162 int snd_hda_codec_proc_new(struct hda_codec *codec);
163 #else
164 static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; }
165 #endif
166 
167 /*
168  * Misc
169  */
170 struct hda_board_config {
171 	const char *modelname;
172 	int config;
173 	unsigned short pci_subvendor;
174 	unsigned short pci_subdevice;
175 };
176 
177 int snd_hda_check_board_config(struct hda_codec *codec, const struct hda_board_config *tbl);
178 int snd_hda_add_new_ctls(struct hda_codec *codec, struct snd_kcontrol_new *knew);
179 
180 /*
181  * power management
182  */
183 #ifdef CONFIG_PM
184 int snd_hda_resume_ctls(struct hda_codec *codec, struct snd_kcontrol_new *knew);
185 int snd_hda_resume_spdif_out(struct hda_codec *codec);
186 int snd_hda_resume_spdif_in(struct hda_codec *codec);
187 #endif
188 
189 /*
190  * unsolicited event handler
191  */
192 
193 #define HDA_UNSOL_QUEUE_SIZE	64
194 
195 struct hda_bus_unsolicited {
196 	/* ring buffer */
197 	u32 queue[HDA_UNSOL_QUEUE_SIZE * 2];
198 	unsigned int rp, wp;
199 
200 	/* workqueue */
201 	struct workqueue_struct *workq;
202 	struct work_struct work;
203 };
204 
205 /*
206  * Helper for automatic ping configuration
207  */
208 
209 enum {
210 	AUTO_PIN_MIC,
211 	AUTO_PIN_FRONT_MIC,
212 	AUTO_PIN_LINE,
213 	AUTO_PIN_FRONT_LINE,
214 	AUTO_PIN_CD,
215 	AUTO_PIN_AUX,
216 	AUTO_PIN_LAST
217 };
218 
219 extern const char *auto_pin_cfg_labels[AUTO_PIN_LAST];
220 
221 struct auto_pin_cfg {
222 	int line_outs;
223 	hda_nid_t line_out_pins[5]; /* sorted in the order of Front/Surr/CLFE/Side */
224 	hda_nid_t speaker_pin;
225 	hda_nid_t hp_pin;
226 	hda_nid_t input_pins[AUTO_PIN_LAST];
227 	hda_nid_t dig_out_pin;
228 	hda_nid_t dig_in_pin;
229 };
230 
231 #define get_defcfg_connect(cfg) ((cfg & AC_DEFCFG_PORT_CONN) >> AC_DEFCFG_PORT_CONN_SHIFT)
232 #define get_defcfg_association(cfg) ((cfg & AC_DEFCFG_DEF_ASSOC) >> AC_DEFCFG_ASSOC_SHIFT)
233 #define get_defcfg_location(cfg) ((cfg & AC_DEFCFG_LOCATION) >> AC_DEFCFG_LOCATION_SHIFT)
234 #define get_defcfg_sequence(cfg) (cfg & AC_DEFCFG_SEQUENCE)
235 #define get_defcfg_device(cfg) ((cfg & AC_DEFCFG_DEVICE) >> AC_DEFCFG_DEVICE_SHIFT)
236 
237 int snd_hda_parse_pin_def_config(struct hda_codec *codec, struct auto_pin_cfg *cfg,
238 				 hda_nid_t *ignore_nids);
239 
240 /* amp values */
241 #define AMP_IN_MUTE(idx)	(0x7080 | ((idx)<<8))
242 #define AMP_IN_UNMUTE(idx)	(0x7000 | ((idx)<<8))
243 #define AMP_OUT_MUTE	0xb080
244 #define AMP_OUT_UNMUTE	0xb000
245 #define AMP_OUT_ZERO	0xb000
246 /* pinctl values */
247 #define PIN_IN		0x20
248 #define PIN_VREF80	0x24
249 #define PIN_VREF50	0x21
250 #define PIN_OUT		0x40
251 #define PIN_HP		0xc0
252 #define PIN_HP_AMP	0x80
253 
254 /*
255  * get widget capabilities
256  */
257 static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid)
258 {
259 	if (nid < codec->start_nid ||
260 	    nid >= codec->start_nid + codec->num_nodes)
261 		return snd_hda_param_read(codec, nid, AC_PAR_AUDIO_WIDGET_CAP);
262 	return codec->wcaps[nid - codec->start_nid];
263 }
264 
265 
266 #endif /* __SOUND_HDA_LOCAL_H */
267