xref: /openbmc/linux/sound/soc/codecs/arizona.h (revision 80ebec68)
1 /*
2  * arizona.h - Wolfson Arizona class device shared support
3  *
4  * Copyright 2012 Wolfson Microelectronics plc
5  *
6  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12 
13 #ifndef _ASOC_ARIZONA_H
14 #define _ASOC_ARIZONA_H
15 
16 #include <linux/completion.h>
17 
18 #include <sound/soc.h>
19 
20 #include "wm_adsp.h"
21 
22 #define ARIZONA_CLK_SYSCLK         1
23 #define ARIZONA_CLK_ASYNCCLK       2
24 #define ARIZONA_CLK_OPCLK          3
25 #define ARIZONA_CLK_ASYNC_OPCLK    4
26 
27 #define ARIZONA_CLK_SRC_MCLK1    0x0
28 #define ARIZONA_CLK_SRC_MCLK2    0x1
29 #define ARIZONA_CLK_SRC_FLL1     0x4
30 #define ARIZONA_CLK_SRC_FLL2     0x5
31 #define ARIZONA_CLK_SRC_AIF1BCLK 0x8
32 #define ARIZONA_CLK_SRC_AIF2BCLK 0x9
33 #define ARIZONA_CLK_SRC_AIF3BCLK 0xa
34 
35 #define ARIZONA_FLL_SRC_NONE      -1
36 #define ARIZONA_FLL_SRC_MCLK1      0
37 #define ARIZONA_FLL_SRC_MCLK2      1
38 #define ARIZONA_FLL_SRC_SLIMCLK    3
39 #define ARIZONA_FLL_SRC_FLL1       4
40 #define ARIZONA_FLL_SRC_FLL2       5
41 #define ARIZONA_FLL_SRC_AIF1BCLK   8
42 #define ARIZONA_FLL_SRC_AIF2BCLK   9
43 #define ARIZONA_FLL_SRC_AIF3BCLK  10
44 #define ARIZONA_FLL_SRC_AIF1LRCLK 12
45 #define ARIZONA_FLL_SRC_AIF2LRCLK 13
46 #define ARIZONA_FLL_SRC_AIF3LRCLK 14
47 
48 #define ARIZONA_MIXER_VOL_MASK             0x00FE
49 #define ARIZONA_MIXER_VOL_SHIFT                 1
50 #define ARIZONA_MIXER_VOL_WIDTH                 7
51 
52 #define ARIZONA_CLK_6MHZ   0
53 #define ARIZONA_CLK_12MHZ  1
54 #define ARIZONA_CLK_24MHZ  2
55 #define ARIZONA_CLK_49MHZ  3
56 #define ARIZONA_CLK_73MHZ  4
57 #define ARIZONA_CLK_98MHZ  5
58 #define ARIZONA_CLK_147MHZ 6
59 
60 #define ARIZONA_MAX_DAI  10
61 #define ARIZONA_MAX_ADSP 4
62 
63 #define ARIZONA_DVFS_SR1_RQ	0x001
64 #define ARIZONA_DVFS_ADSP1_RQ	0x100
65 
66 /* Notifier events */
67 #define ARIZONA_NOTIFY_VOICE_TRIGGER   0x1
68 
69 struct arizona;
70 struct wm_adsp;
71 
72 struct arizona_dai_priv {
73 	int clk;
74 
75 	struct snd_pcm_hw_constraint_list constraint;
76 };
77 
78 struct arizona_priv {
79 	struct wm_adsp adsp[ARIZONA_MAX_ADSP];
80 	struct arizona *arizona;
81 	int sysclk;
82 	int asyncclk;
83 	struct arizona_dai_priv dai[ARIZONA_MAX_DAI];
84 
85 	int num_inputs;
86 	unsigned int in_pending;
87 
88 	unsigned int out_up_pending;
89 	unsigned int out_up_delay;
90 	unsigned int out_down_pending;
91 	unsigned int out_down_delay;
92 
93 	unsigned int dvfs_reqs;
94 	struct mutex dvfs_lock;
95 	bool dvfs_cached;
96 };
97 
98 struct arizona_voice_trigger_info {
99 	int core;
100 };
101 
102 #define ARIZONA_NUM_MIXER_INPUTS 104
103 
104 extern const unsigned int arizona_mixer_tlv[];
105 extern const char * const arizona_mixer_texts[ARIZONA_NUM_MIXER_INPUTS];
106 extern unsigned int arizona_mixer_values[ARIZONA_NUM_MIXER_INPUTS];
107 
108 #define ARIZONA_GAINMUX_CONTROLS(name, base) \
109 	SOC_SINGLE_RANGE_TLV(name " Input Volume", base + 1,		\
110 			     ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0,	\
111 			     arizona_mixer_tlv)
112 
113 #define ARIZONA_MIXER_CONTROLS(name, base) \
114 	SOC_SINGLE_RANGE_TLV(name " Input 1 Volume", base + 1,		\
115 			     ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0,	\
116 			     arizona_mixer_tlv),			\
117 	SOC_SINGLE_RANGE_TLV(name " Input 2 Volume", base + 3,		\
118 			     ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0,	\
119 			     arizona_mixer_tlv),			\
120 	SOC_SINGLE_RANGE_TLV(name " Input 3 Volume", base + 5,		\
121 			     ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0,	\
122 			     arizona_mixer_tlv),			\
123 	SOC_SINGLE_RANGE_TLV(name " Input 4 Volume", base + 7,		\
124 			     ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0,	\
125 			     arizona_mixer_tlv)
126 
127 #define ARIZONA_MUX_ENUM_DECL(name, reg) \
128 	SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL( \
129 		name, reg, 0, 0xff, arizona_mixer_texts, arizona_mixer_values)
130 
131 #define ARIZONA_MUX_CTL_DECL(name) \
132 	const struct snd_kcontrol_new name##_mux =	\
133 		SOC_DAPM_ENUM("Route", name##_enum)
134 
135 #define ARIZONA_MUX_ENUMS(name, base_reg) \
136 	static ARIZONA_MUX_ENUM_DECL(name##_enum, base_reg);      \
137 	static ARIZONA_MUX_CTL_DECL(name)
138 
139 #define ARIZONA_MIXER_ENUMS(name, base_reg) \
140 	ARIZONA_MUX_ENUMS(name##_in1, base_reg);     \
141 	ARIZONA_MUX_ENUMS(name##_in2, base_reg + 2); \
142 	ARIZONA_MUX_ENUMS(name##_in3, base_reg + 4); \
143 	ARIZONA_MUX_ENUMS(name##_in4, base_reg + 6)
144 
145 #define ARIZONA_DSP_AUX_ENUMS(name, base_reg) \
146 	ARIZONA_MUX_ENUMS(name##_aux1, base_reg);	\
147 	ARIZONA_MUX_ENUMS(name##_aux2, base_reg + 8);	\
148 	ARIZONA_MUX_ENUMS(name##_aux3, base_reg + 16);	\
149 	ARIZONA_MUX_ENUMS(name##_aux4, base_reg + 24);	\
150 	ARIZONA_MUX_ENUMS(name##_aux5, base_reg + 32);	\
151 	ARIZONA_MUX_ENUMS(name##_aux6, base_reg + 40)
152 
153 #define ARIZONA_MUX(name, ctrl) \
154 	SND_SOC_DAPM_MUX(name, SND_SOC_NOPM, 0, 0, ctrl)
155 
156 #define ARIZONA_MUX_WIDGETS(name, name_str) \
157 	ARIZONA_MUX(name_str " Input", &name##_mux)
158 
159 #define ARIZONA_MIXER_WIDGETS(name, name_str)	\
160 	ARIZONA_MUX(name_str " Input 1", &name##_in1_mux), \
161 	ARIZONA_MUX(name_str " Input 2", &name##_in2_mux), \
162 	ARIZONA_MUX(name_str " Input 3", &name##_in3_mux), \
163 	ARIZONA_MUX(name_str " Input 4", &name##_in4_mux), \
164 	SND_SOC_DAPM_MIXER(name_str " Mixer", SND_SOC_NOPM, 0, 0, NULL, 0)
165 
166 #define ARIZONA_DSP_WIDGETS(name, name_str) \
167 	ARIZONA_MIXER_WIDGETS(name##L, name_str "L"), \
168 	ARIZONA_MIXER_WIDGETS(name##R, name_str "R"), \
169 	ARIZONA_MUX(name_str " Aux 1", &name##_aux1_mux), \
170 	ARIZONA_MUX(name_str " Aux 2", &name##_aux2_mux), \
171 	ARIZONA_MUX(name_str " Aux 3", &name##_aux3_mux), \
172 	ARIZONA_MUX(name_str " Aux 4", &name##_aux4_mux), \
173 	ARIZONA_MUX(name_str " Aux 5", &name##_aux5_mux), \
174 	ARIZONA_MUX(name_str " Aux 6", &name##_aux6_mux)
175 
176 #define ARIZONA_MUX_ROUTES(widget, name) \
177 	{ widget, NULL, name " Input" }, \
178 	ARIZONA_MIXER_INPUT_ROUTES(name " Input")
179 
180 #define ARIZONA_MIXER_ROUTES(widget, name) \
181 	{ widget, NULL, name " Mixer" },         \
182 	{ name " Mixer", NULL, name " Input 1" }, \
183 	{ name " Mixer", NULL, name " Input 2" }, \
184 	{ name " Mixer", NULL, name " Input 3" }, \
185 	{ name " Mixer", NULL, name " Input 4" }, \
186 	ARIZONA_MIXER_INPUT_ROUTES(name " Input 1"), \
187 	ARIZONA_MIXER_INPUT_ROUTES(name " Input 2"), \
188 	ARIZONA_MIXER_INPUT_ROUTES(name " Input 3"), \
189 	ARIZONA_MIXER_INPUT_ROUTES(name " Input 4")
190 
191 #define ARIZONA_DSP_ROUTES(name) \
192 	{ name, NULL, name " Preloader"}, \
193 	{ name " Preloader", NULL, "SYSCLK" }, \
194 	{ name, NULL, name " Aux 1" }, \
195 	{ name, NULL, name " Aux 2" }, \
196 	{ name, NULL, name " Aux 3" }, \
197 	{ name, NULL, name " Aux 4" }, \
198 	{ name, NULL, name " Aux 5" }, \
199 	{ name, NULL, name " Aux 6" }, \
200 	ARIZONA_MIXER_INPUT_ROUTES(name " Aux 1"), \
201 	ARIZONA_MIXER_INPUT_ROUTES(name " Aux 2"), \
202 	ARIZONA_MIXER_INPUT_ROUTES(name " Aux 3"), \
203 	ARIZONA_MIXER_INPUT_ROUTES(name " Aux 4"), \
204 	ARIZONA_MIXER_INPUT_ROUTES(name " Aux 5"), \
205 	ARIZONA_MIXER_INPUT_ROUTES(name " Aux 6"), \
206 	ARIZONA_MIXER_ROUTES(name, name "L"), \
207 	ARIZONA_MIXER_ROUTES(name, name "R")
208 
209 #define ARIZONA_EQ_CONTROL(xname, xbase)                      \
210 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
211 	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
212 	.put = arizona_eq_coeff_put, .private_value =         \
213 	((unsigned long)&(struct soc_bytes) { .base = xbase,  \
214 	 .num_regs = 20, .mask = ~ARIZONA_EQ1_B1_MODE }) }
215 
216 #define ARIZONA_LHPF_CONTROL(xname, xbase)                    \
217 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,   \
218 	.info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
219 	.put = arizona_lhpf_coeff_put, .private_value =       \
220 	((unsigned long)&(struct soc_bytes) { .base = xbase,  \
221 	 .num_regs = 1 }) }
222 
223 #define ARIZONA_RATE_ENUM_SIZE 4
224 #define ARIZONA_SAMPLE_RATE_ENUM_SIZE 14
225 
226 extern const char * const arizona_rate_text[ARIZONA_RATE_ENUM_SIZE];
227 extern const unsigned int arizona_rate_val[ARIZONA_RATE_ENUM_SIZE];
228 extern const char * const arizona_sample_rate_text[ARIZONA_SAMPLE_RATE_ENUM_SIZE];
229 extern const unsigned int arizona_sample_rate_val[ARIZONA_SAMPLE_RATE_ENUM_SIZE];
230 
231 extern const struct soc_enum arizona_isrc_fsl[];
232 extern const struct soc_enum arizona_isrc_fsh[];
233 extern const struct soc_enum arizona_asrc_rate1;
234 
235 extern const struct soc_enum arizona_in_vi_ramp;
236 extern const struct soc_enum arizona_in_vd_ramp;
237 
238 extern const struct soc_enum arizona_out_vi_ramp;
239 extern const struct soc_enum arizona_out_vd_ramp;
240 
241 extern const struct soc_enum arizona_lhpf1_mode;
242 extern const struct soc_enum arizona_lhpf2_mode;
243 extern const struct soc_enum arizona_lhpf3_mode;
244 extern const struct soc_enum arizona_lhpf4_mode;
245 
246 extern const struct soc_enum arizona_ng_hold;
247 extern const struct soc_enum arizona_in_hpf_cut_enum;
248 extern const struct soc_enum arizona_in_dmic_osr[];
249 
250 extern const struct snd_kcontrol_new arizona_adsp2_rate_controls[];
251 
252 extern const struct soc_enum arizona_anc_input_src[];
253 extern const struct soc_enum arizona_anc_ng_enum;
254 extern const struct soc_enum arizona_output_anc_src[];
255 
256 extern const struct snd_kcontrol_new arizona_voice_trigger_switch[];
257 
258 extern int arizona_in_ev(struct snd_soc_dapm_widget *w,
259 			 struct snd_kcontrol *kcontrol,
260 			 int event);
261 extern int arizona_out_ev(struct snd_soc_dapm_widget *w,
262 			  struct snd_kcontrol *kcontrol,
263 			  int event);
264 extern int arizona_hp_ev(struct snd_soc_dapm_widget *w,
265 			 struct snd_kcontrol *kcontrol,
266 			 int event);
267 extern int arizona_anc_ev(struct snd_soc_dapm_widget *w,
268 			  struct snd_kcontrol *kcontrol,
269 			  int event);
270 
271 extern int arizona_eq_coeff_put(struct snd_kcontrol *kcontrol,
272 				struct snd_ctl_elem_value *ucontrol);
273 extern int arizona_lhpf_coeff_put(struct snd_kcontrol *kcontrol,
274 				  struct snd_ctl_elem_value *ucontrol);
275 
276 extern int arizona_set_sysclk(struct snd_soc_codec *codec, int clk_id,
277 			      int source, unsigned int freq, int dir);
278 
279 extern const struct snd_soc_dai_ops arizona_dai_ops;
280 extern const struct snd_soc_dai_ops arizona_simple_dai_ops;
281 
282 #define ARIZONA_FLL_NAME_LEN 20
283 
284 struct arizona_fll {
285 	struct arizona *arizona;
286 	int id;
287 	unsigned int base;
288 	unsigned int vco_mult;
289 
290 	unsigned int fout;
291 	int sync_src;
292 	unsigned int sync_freq;
293 	int ref_src;
294 	unsigned int ref_freq;
295 
296 	char lock_name[ARIZONA_FLL_NAME_LEN];
297 	char clock_ok_name[ARIZONA_FLL_NAME_LEN];
298 };
299 
300 extern int arizona_dvfs_up(struct snd_soc_codec *codec, unsigned int flags);
301 extern int arizona_dvfs_down(struct snd_soc_codec *codec, unsigned int flags);
302 extern int arizona_dvfs_sysclk_ev(struct snd_soc_dapm_widget *w,
303 				  struct snd_kcontrol *kcontrol, int event);
304 extern void arizona_init_dvfs(struct arizona_priv *priv);
305 
306 extern int arizona_init_fll(struct arizona *arizona, int id, int base,
307 			    int lock_irq, int ok_irq, struct arizona_fll *fll);
308 extern int arizona_set_fll_refclk(struct arizona_fll *fll, int source,
309 				  unsigned int Fref, unsigned int Fout);
310 extern int arizona_set_fll(struct arizona_fll *fll, int source,
311 			   unsigned int Fref, unsigned int Fout);
312 
313 extern int arizona_init_spk(struct snd_soc_codec *codec);
314 extern int arizona_init_gpio(struct snd_soc_codec *codec);
315 extern int arizona_init_mono(struct snd_soc_codec *codec);
316 extern int arizona_init_notifiers(struct snd_soc_codec *codec);
317 
318 extern int arizona_free_spk(struct snd_soc_codec *codec);
319 
320 extern int arizona_init_dai(struct arizona_priv *priv, int dai);
321 
322 int arizona_set_output_mode(struct snd_soc_codec *codec, int output,
323 			    bool diff);
324 
325 extern bool arizona_input_analog(struct snd_soc_codec *codec, int shift);
326 
327 extern const char *arizona_sample_rate_val_to_name(unsigned int rate_val);
328 
329 extern int arizona_register_notifier(struct snd_soc_codec *codec,
330 				     struct notifier_block *nb,
331 				     int (*notify)(struct notifier_block *nb,
332 						   unsigned long action,
333 						   void *data));
334 extern int arizona_unregister_notifier(struct snd_soc_codec *codec,
335 				       struct notifier_block *nb);
336 
337 #endif
338