1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * arizona.h - Wolfson Arizona class device shared support 4 * 5 * Copyright 2012 Wolfson Microelectronics plc 6 * 7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com> 8 */ 9 10 #ifndef _ASOC_ARIZONA_H 11 #define _ASOC_ARIZONA_H 12 13 #include <linux/completion.h> 14 #include <linux/notifier.h> 15 #include <linux/mfd/arizona/core.h> 16 17 #include <sound/soc.h> 18 19 #include "wm_adsp.h" 20 21 #define ARIZONA_CLK_SYSCLK 1 22 #define ARIZONA_CLK_ASYNCCLK 2 23 #define ARIZONA_CLK_OPCLK 3 24 #define ARIZONA_CLK_ASYNC_OPCLK 4 25 26 #define ARIZONA_CLK_SRC_MCLK1 0x0 27 #define ARIZONA_CLK_SRC_MCLK2 0x1 28 #define ARIZONA_CLK_SRC_FLL1 0x4 29 #define ARIZONA_CLK_SRC_FLL2 0x5 30 #define ARIZONA_CLK_SRC_AIF1BCLK 0x8 31 #define ARIZONA_CLK_SRC_AIF2BCLK 0x9 32 #define ARIZONA_CLK_SRC_AIF3BCLK 0xa 33 34 #define ARIZONA_FLL_SRC_NONE -1 35 #define ARIZONA_FLL_SRC_MCLK1 0 36 #define ARIZONA_FLL_SRC_MCLK2 1 37 #define ARIZONA_FLL_SRC_SLIMCLK 3 38 #define ARIZONA_FLL_SRC_FLL1 4 39 #define ARIZONA_FLL_SRC_FLL2 5 40 #define ARIZONA_FLL_SRC_AIF1BCLK 8 41 #define ARIZONA_FLL_SRC_AIF2BCLK 9 42 #define ARIZONA_FLL_SRC_AIF3BCLK 10 43 #define ARIZONA_FLL_SRC_AIF1LRCLK 12 44 #define ARIZONA_FLL_SRC_AIF2LRCLK 13 45 #define ARIZONA_FLL_SRC_AIF3LRCLK 14 46 47 #define ARIZONA_MIXER_VOL_MASK 0x00FE 48 #define ARIZONA_MIXER_VOL_SHIFT 1 49 #define ARIZONA_MIXER_VOL_WIDTH 7 50 51 #define ARIZONA_CLK_6MHZ 0 52 #define ARIZONA_CLK_12MHZ 1 53 #define ARIZONA_CLK_24MHZ 2 54 #define ARIZONA_CLK_49MHZ 3 55 #define ARIZONA_CLK_73MHZ 4 56 #define ARIZONA_CLK_98MHZ 5 57 #define ARIZONA_CLK_147MHZ 6 58 59 #define ARIZONA_MAX_DAI 10 60 #define ARIZONA_MAX_ADSP 4 61 62 #define ARIZONA_DVFS_SR1_RQ 0x001 63 #define ARIZONA_DVFS_ADSP1_RQ 0x100 64 65 /* Notifier events */ 66 #define ARIZONA_NOTIFY_VOICE_TRIGGER 0x1 67 68 struct wm_adsp; 69 70 struct arizona_dai_priv { 71 int clk; 72 73 struct snd_pcm_hw_constraint_list constraint; 74 }; 75 76 struct arizona_priv { 77 struct wm_adsp adsp[ARIZONA_MAX_ADSP]; 78 struct arizona *arizona; 79 int sysclk; 80 int asyncclk; 81 struct arizona_dai_priv dai[ARIZONA_MAX_DAI]; 82 83 int num_inputs; 84 unsigned int in_pending; 85 86 unsigned int out_up_pending; 87 unsigned int out_up_delay; 88 unsigned int out_down_pending; 89 unsigned int out_down_delay; 90 91 unsigned int dvfs_reqs; 92 struct mutex dvfs_lock; 93 bool dvfs_cached; 94 95 /* Variables used by arizona-jack.c code */ 96 struct mutex lock; 97 struct delayed_work hpdet_work; 98 struct delayed_work micd_detect_work; 99 struct delayed_work micd_timeout_work; 100 struct snd_soc_jack *jack; 101 struct regulator *micvdd; 102 struct gpio_desc *micd_pol_gpio; 103 struct gpio_desc *hpdet_id_gpio; 104 105 u16 last_jackdet; 106 107 int micd_mode; 108 const struct arizona_micd_config *micd_modes; 109 int micd_num_modes; 110 111 int micd_button_mask; 112 const struct arizona_micd_range *micd_ranges; 113 int num_micd_ranges; 114 115 bool micd_reva; 116 bool micd_clamp; 117 118 bool hpdet_active; 119 bool hpdet_done; 120 bool hpdet_retried; 121 122 bool mic; 123 bool detecting; 124 125 int num_hpdet_res; 126 unsigned int hpdet_res[3]; 127 128 int jack_flips; 129 int hpdet_ip_version; 130 }; 131 132 struct arizona_voice_trigger_info { 133 int core; 134 }; 135 136 #define ARIZONA_NUM_MIXER_INPUTS 104 137 138 extern const unsigned int arizona_mixer_tlv[]; 139 extern const char * const arizona_mixer_texts[ARIZONA_NUM_MIXER_INPUTS]; 140 extern unsigned int arizona_mixer_values[ARIZONA_NUM_MIXER_INPUTS]; 141 142 #define ARIZONA_GAINMUX_CONTROLS(name, base) \ 143 SOC_SINGLE_RANGE_TLV(name " Input Volume", base + 1, \ 144 ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \ 145 arizona_mixer_tlv) 146 147 #define ARIZONA_MIXER_CONTROLS(name, base) \ 148 SOC_SINGLE_RANGE_TLV(name " Input 1 Volume", base + 1, \ 149 ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \ 150 arizona_mixer_tlv), \ 151 SOC_SINGLE_RANGE_TLV(name " Input 2 Volume", base + 3, \ 152 ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \ 153 arizona_mixer_tlv), \ 154 SOC_SINGLE_RANGE_TLV(name " Input 3 Volume", base + 5, \ 155 ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \ 156 arizona_mixer_tlv), \ 157 SOC_SINGLE_RANGE_TLV(name " Input 4 Volume", base + 7, \ 158 ARIZONA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \ 159 arizona_mixer_tlv) 160 161 #define ARIZONA_MUX_ENUM_DECL(name, reg) \ 162 SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL( \ 163 name, reg, 0, 0xff, arizona_mixer_texts, arizona_mixer_values) 164 165 #define ARIZONA_MUX_CTL_DECL(name) \ 166 const struct snd_kcontrol_new name##_mux = \ 167 SOC_DAPM_ENUM("Route", name##_enum) 168 169 #define ARIZONA_MUX_ENUMS(name, base_reg) \ 170 static ARIZONA_MUX_ENUM_DECL(name##_enum, base_reg); \ 171 static ARIZONA_MUX_CTL_DECL(name) 172 173 #define ARIZONA_MIXER_ENUMS(name, base_reg) \ 174 ARIZONA_MUX_ENUMS(name##_in1, base_reg); \ 175 ARIZONA_MUX_ENUMS(name##_in2, base_reg + 2); \ 176 ARIZONA_MUX_ENUMS(name##_in3, base_reg + 4); \ 177 ARIZONA_MUX_ENUMS(name##_in4, base_reg + 6) 178 179 #define ARIZONA_DSP_AUX_ENUMS(name, base_reg) \ 180 ARIZONA_MUX_ENUMS(name##_aux1, base_reg); \ 181 ARIZONA_MUX_ENUMS(name##_aux2, base_reg + 8); \ 182 ARIZONA_MUX_ENUMS(name##_aux3, base_reg + 16); \ 183 ARIZONA_MUX_ENUMS(name##_aux4, base_reg + 24); \ 184 ARIZONA_MUX_ENUMS(name##_aux5, base_reg + 32); \ 185 ARIZONA_MUX_ENUMS(name##_aux6, base_reg + 40) 186 187 #define ARIZONA_MUX(name, ctrl) \ 188 SND_SOC_DAPM_MUX(name, SND_SOC_NOPM, 0, 0, ctrl) 189 190 #define ARIZONA_MUX_WIDGETS(name, name_str) \ 191 ARIZONA_MUX(name_str " Input", &name##_mux) 192 193 #define ARIZONA_MIXER_WIDGETS(name, name_str) \ 194 ARIZONA_MUX(name_str " Input 1", &name##_in1_mux), \ 195 ARIZONA_MUX(name_str " Input 2", &name##_in2_mux), \ 196 ARIZONA_MUX(name_str " Input 3", &name##_in3_mux), \ 197 ARIZONA_MUX(name_str " Input 4", &name##_in4_mux), \ 198 SND_SOC_DAPM_MIXER(name_str " Mixer", SND_SOC_NOPM, 0, 0, NULL, 0) 199 200 #define ARIZONA_DSP_WIDGETS(name, name_str) \ 201 ARIZONA_MIXER_WIDGETS(name##L, name_str "L"), \ 202 ARIZONA_MIXER_WIDGETS(name##R, name_str "R"), \ 203 ARIZONA_MUX(name_str " Aux 1", &name##_aux1_mux), \ 204 ARIZONA_MUX(name_str " Aux 2", &name##_aux2_mux), \ 205 ARIZONA_MUX(name_str " Aux 3", &name##_aux3_mux), \ 206 ARIZONA_MUX(name_str " Aux 4", &name##_aux4_mux), \ 207 ARIZONA_MUX(name_str " Aux 5", &name##_aux5_mux), \ 208 ARIZONA_MUX(name_str " Aux 6", &name##_aux6_mux) 209 210 #define ARIZONA_MUX_ROUTES(widget, name) \ 211 { widget, NULL, name " Input" }, \ 212 ARIZONA_MIXER_INPUT_ROUTES(name " Input") 213 214 #define ARIZONA_MIXER_ROUTES(widget, name) \ 215 { widget, NULL, name " Mixer" }, \ 216 { name " Mixer", NULL, name " Input 1" }, \ 217 { name " Mixer", NULL, name " Input 2" }, \ 218 { name " Mixer", NULL, name " Input 3" }, \ 219 { name " Mixer", NULL, name " Input 4" }, \ 220 ARIZONA_MIXER_INPUT_ROUTES(name " Input 1"), \ 221 ARIZONA_MIXER_INPUT_ROUTES(name " Input 2"), \ 222 ARIZONA_MIXER_INPUT_ROUTES(name " Input 3"), \ 223 ARIZONA_MIXER_INPUT_ROUTES(name " Input 4") 224 225 #define ARIZONA_DSP_ROUTES(name) \ 226 { name, NULL, name " Preloader"}, \ 227 { name " Preloader", NULL, "SYSCLK" }, \ 228 { name " Preload", NULL, name " Preloader"}, \ 229 { name, NULL, name " Aux 1" }, \ 230 { name, NULL, name " Aux 2" }, \ 231 { name, NULL, name " Aux 3" }, \ 232 { name, NULL, name " Aux 4" }, \ 233 { name, NULL, name " Aux 5" }, \ 234 { name, NULL, name " Aux 6" }, \ 235 ARIZONA_MIXER_INPUT_ROUTES(name " Aux 1"), \ 236 ARIZONA_MIXER_INPUT_ROUTES(name " Aux 2"), \ 237 ARIZONA_MIXER_INPUT_ROUTES(name " Aux 3"), \ 238 ARIZONA_MIXER_INPUT_ROUTES(name " Aux 4"), \ 239 ARIZONA_MIXER_INPUT_ROUTES(name " Aux 5"), \ 240 ARIZONA_MIXER_INPUT_ROUTES(name " Aux 6"), \ 241 ARIZONA_MIXER_ROUTES(name, name "L"), \ 242 ARIZONA_MIXER_ROUTES(name, name "R") 243 244 #define ARIZONA_EQ_CONTROL(xname, xbase) \ 245 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 246 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \ 247 .put = arizona_eq_coeff_put, .private_value = \ 248 ((unsigned long)&(struct soc_bytes) { .base = xbase, \ 249 .num_regs = 20, .mask = ~ARIZONA_EQ1_B1_MODE }) } 250 251 #define ARIZONA_LHPF_CONTROL(xname, xbase) \ 252 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ 253 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \ 254 .put = arizona_lhpf_coeff_put, .private_value = \ 255 ((unsigned long)&(struct soc_bytes) { .base = xbase, \ 256 .num_regs = 1 }) } 257 258 #define ARIZONA_RATE_ENUM_SIZE 4 259 #define ARIZONA_SAMPLE_RATE_ENUM_SIZE 14 260 261 /* SND_JACK_* mask for supported cable/switch types */ 262 #define ARIZONA_JACK_MASK (SND_JACK_HEADSET | SND_JACK_LINEOUT | SND_JACK_MECHANICAL) 263 264 extern const char * const arizona_rate_text[ARIZONA_RATE_ENUM_SIZE]; 265 extern const unsigned int arizona_rate_val[ARIZONA_RATE_ENUM_SIZE]; 266 extern const char * const arizona_sample_rate_text[ARIZONA_SAMPLE_RATE_ENUM_SIZE]; 267 extern const unsigned int arizona_sample_rate_val[ARIZONA_SAMPLE_RATE_ENUM_SIZE]; 268 269 extern const struct soc_enum arizona_isrc_fsl[]; 270 extern const struct soc_enum arizona_isrc_fsh[]; 271 extern const struct soc_enum arizona_asrc_rate1; 272 273 extern const struct soc_enum arizona_in_vi_ramp; 274 extern const struct soc_enum arizona_in_vd_ramp; 275 276 extern const struct soc_enum arizona_out_vi_ramp; 277 extern const struct soc_enum arizona_out_vd_ramp; 278 279 extern const struct soc_enum arizona_lhpf1_mode; 280 extern const struct soc_enum arizona_lhpf2_mode; 281 extern const struct soc_enum arizona_lhpf3_mode; 282 extern const struct soc_enum arizona_lhpf4_mode; 283 284 extern const struct soc_enum arizona_ng_hold; 285 extern const struct soc_enum arizona_in_hpf_cut_enum; 286 extern const struct soc_enum arizona_in_dmic_osr[]; 287 288 extern const struct snd_kcontrol_new arizona_adsp2_rate_controls[]; 289 290 extern const struct soc_enum arizona_anc_input_src[]; 291 extern const struct soc_enum arizona_anc_ng_enum; 292 extern const struct soc_enum arizona_output_anc_src[]; 293 294 extern const struct snd_kcontrol_new arizona_voice_trigger_switch[]; 295 296 int arizona_in_ev(struct snd_soc_dapm_widget *w, struct snd_kcontrol *kcontrol, 297 int event); 298 int arizona_out_ev(struct snd_soc_dapm_widget *w, struct snd_kcontrol *kcontrol, 299 int event); 300 int arizona_hp_ev(struct snd_soc_dapm_widget *w, struct snd_kcontrol *kcontrol, 301 int event); 302 int arizona_anc_ev(struct snd_soc_dapm_widget *w, struct snd_kcontrol *kcontrol, 303 int event); 304 305 int arizona_eq_coeff_put(struct snd_kcontrol *kcontrol, 306 struct snd_ctl_elem_value *ucontrol); 307 int arizona_lhpf_coeff_put(struct snd_kcontrol *kcontrol, 308 struct snd_ctl_elem_value *ucontrol); 309 310 int arizona_clk_ev(struct snd_soc_dapm_widget *w, struct snd_kcontrol *kcontrol, 311 int event); 312 int arizona_set_sysclk(struct snd_soc_component *component, int clk_id, int source, 313 unsigned int freq, int dir); 314 315 extern const struct snd_soc_dai_ops arizona_dai_ops; 316 extern const struct snd_soc_dai_ops arizona_simple_dai_ops; 317 318 #define ARIZONA_FLL_NAME_LEN 20 319 320 struct arizona_fll { 321 struct arizona *arizona; 322 int id; 323 unsigned int base; 324 unsigned int vco_mult; 325 326 unsigned int fout; 327 int sync_src; 328 unsigned int sync_freq; 329 int ref_src; 330 unsigned int ref_freq; 331 332 char lock_name[ARIZONA_FLL_NAME_LEN]; 333 char clock_ok_name[ARIZONA_FLL_NAME_LEN]; 334 }; 335 336 int arizona_dvfs_up(struct snd_soc_component *component, unsigned int flags); 337 int arizona_dvfs_down(struct snd_soc_component *component, unsigned int flags); 338 int arizona_dvfs_sysclk_ev(struct snd_soc_dapm_widget *w, 339 struct snd_kcontrol *kcontrol, int event); 340 void arizona_init_dvfs(struct arizona_priv *priv); 341 342 int arizona_init_fll(struct arizona *arizona, int id, int base, 343 int lock_irq, int ok_irq, struct arizona_fll *fll); 344 int arizona_set_fll_refclk(struct arizona_fll *fll, int source, 345 unsigned int Fref, unsigned int Fout); 346 int arizona_set_fll(struct arizona_fll *fll, int source, 347 unsigned int Fref, unsigned int Fout); 348 349 int arizona_init_spk(struct snd_soc_component *component); 350 int arizona_init_gpio(struct snd_soc_component *component); 351 int arizona_init_mono(struct snd_soc_component *component); 352 353 int arizona_init_common(struct arizona *arizona); 354 int arizona_init_vol_limit(struct arizona *arizona); 355 356 int arizona_init_spk_irqs(struct arizona *arizona); 357 int arizona_free_spk_irqs(struct arizona *arizona); 358 359 int arizona_init_dai(struct arizona_priv *priv, int id); 360 361 int arizona_set_output_mode(struct snd_soc_component *component, int output, 362 bool diff); 363 364 bool arizona_input_analog(struct snd_soc_component *component, int shift); 365 366 const char *arizona_sample_rate_val_to_name(unsigned int rate_val); 367 368 static inline int arizona_register_notifier(struct snd_soc_component *component, 369 struct notifier_block *nb, 370 int (*notify) 371 (struct notifier_block *nb, 372 unsigned long action, void *data)) 373 { 374 struct arizona_priv *priv = snd_soc_component_get_drvdata(component); 375 struct arizona *arizona = priv->arizona; 376 377 nb->notifier_call = notify; 378 379 return blocking_notifier_chain_register(&arizona->notifier, nb); 380 } 381 382 static inline int arizona_unregister_notifier(struct snd_soc_component *component, 383 struct notifier_block *nb) 384 { 385 struct arizona_priv *priv = snd_soc_component_get_drvdata(component); 386 struct arizona *arizona = priv->arizona; 387 388 return blocking_notifier_chain_unregister(&arizona->notifier, nb); 389 } 390 391 int arizona_of_get_audio_pdata(struct arizona *arizona); 392 393 int arizona_jack_codec_dev_probe(struct arizona_priv *info, struct device *dev); 394 int arizona_jack_codec_dev_remove(struct arizona_priv *info); 395 396 int arizona_jack_set_jack(struct snd_soc_component *component, 397 struct snd_soc_jack *jack, void *data); 398 399 #endif 400