2 * madera.h - Cirrus Logic Madera class codecs common support
4 * Copyright 2015-2017 Cirrus Logic
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
14 #include <linux/completion.h>
16 #include <sound/soc.h>
17 #include <sound/madera-pdata.h>
21 #define MADERA_FLL1_REFCLK 1
22 #define MADERA_FLL2_REFCLK 2
23 #define MADERA_FLL3_REFCLK 3
24 #define MADERA_FLLAO_REFCLK 4
25 #define MADERA_FLL1_SYNCCLK 5
26 #define MADERA_FLL2_SYNCCLK 6
27 #define MADERA_FLL3_SYNCCLK 7
28 #define MADERA_FLLAO_SYNCCLK 8
30 #define MADERA_FLL_SRC_NONE -1
31 #define MADERA_FLL_SRC_MCLK1 0
32 #define MADERA_FLL_SRC_MCLK2 1
33 #define MADERA_FLL_SRC_SLIMCLK 3
34 #define MADERA_FLL_SRC_FLL1 4
35 #define MADERA_FLL_SRC_FLL2 5
36 #define MADERA_FLL_SRC_AIF1BCLK 8
37 #define MADERA_FLL_SRC_AIF2BCLK 9
38 #define MADERA_FLL_SRC_AIF3BCLK 10
39 #define MADERA_FLL_SRC_AIF4BCLK 11
40 #define MADERA_FLL_SRC_AIF1LRCLK 12
41 #define MADERA_FLL_SRC_AIF2LRCLK 13
42 #define MADERA_FLL_SRC_AIF3LRCLK 14
43 #define MADERA_FLL_SRC_AIF4LRCLK 15
45 #define MADERA_CLK_SYSCLK_1 1
46 #define MADERA_CLK_ASYNCCLK_1 2
47 #define MADERA_CLK_OPCLK 3
48 #define MADERA_CLK_ASYNC_OPCLK 4
49 #define MADERA_CLK_SYSCLK_2 5
50 #define MADERA_CLK_SYSCLK_3 6
51 #define MADERA_CLK_ASYNCCLK_2 7
52 #define MADERA_CLK_DSPCLK 8
54 #define MADERA_CLK_SRC_MCLK1 0x0
55 #define MADERA_CLK_SRC_MCLK2 0x1
56 #define MADERA_CLK_SRC_FLL1 0x4
57 #define MADERA_CLK_SRC_FLL2 0x5
58 #define MADERA_CLK_SRC_FLL3 0x6
59 #define MADERA_CLK_SRC_FLLAO_HI 0x7
60 #define MADERA_CLK_SRC_FLL1_DIV6 0x7
61 #define MADERA_CLK_SRC_AIF1BCLK 0x8
62 #define MADERA_CLK_SRC_AIF2BCLK 0x9
63 #define MADERA_CLK_SRC_AIF3BCLK 0xA
64 #define MADERA_CLK_SRC_AIF4BCLK 0xB
65 #define MADERA_CLK_SRC_FLLAO 0xF
67 #define MADERA_MIXER_VOL_MASK 0x00FE
68 #define MADERA_MIXER_VOL_SHIFT 1
69 #define MADERA_MIXER_VOL_WIDTH 7
71 #define MADERA_DOM_GRP_FX 0
72 #define MADERA_DOM_GRP_ASRC1_RATE_1 1
73 #define MADERA_DOM_GRP_ASRC1_RATE_2 2
74 #define MADERA_DOM_GRP_ASRC2_RATE_1 3
75 #define MADERA_DOM_GRP_ASRC2_RATE_2 4
76 #define MADERA_DOM_GRP_ISRC1_DEC 5
77 #define MADERA_DOM_GRP_ISRC1_INT 6
78 #define MADERA_DOM_GRP_ISRC2_DEC 7
79 #define MADERA_DOM_GRP_ISRC2_INT 8
80 #define MADERA_DOM_GRP_ISRC3_DEC 9
81 #define MADERA_DOM_GRP_ISRC3_INT 10
82 #define MADERA_DOM_GRP_ISRC4_DEC 11
83 #define MADERA_DOM_GRP_ISRC4_INT 12
84 #define MADERA_DOM_GRP_OUT 13
85 #define MADERA_DOM_GRP_SPD 14
86 #define MADERA_DOM_GRP_DSP1 15
87 #define MADERA_DOM_GRP_DSP2 16
88 #define MADERA_DOM_GRP_DSP3 17
89 #define MADERA_DOM_GRP_DSP4 18
90 #define MADERA_DOM_GRP_DSP5 19
91 #define MADERA_DOM_GRP_DSP6 20
92 #define MADERA_DOM_GRP_DSP7 21
93 #define MADERA_DOM_GRP_AIF1 22
94 #define MADERA_DOM_GRP_AIF2 23
95 #define MADERA_DOM_GRP_AIF3 24
96 #define MADERA_DOM_GRP_AIF4 25
97 #define MADERA_DOM_GRP_SLIMBUS 26
98 #define MADERA_DOM_GRP_PWM 27
99 #define MADERA_DOM_GRP_DFC 28
100 #define MADERA_N_DOM_GRPS 29
102 #define MADERA_MAX_DAI 11
103 #define MADERA_MAX_ADSP 7
105 #define MADERA_NUM_MIXER_INPUTS 146
110 struct madera_voice_trigger_info
{
111 /** Which core triggered, 1-based (1 = DSP1, ...) */
115 struct madera_dai_priv
{
117 struct snd_pcm_hw_constraint_list constraint
;
121 struct wm_adsp adsp
[MADERA_MAX_ADSP
];
122 struct madera
*madera
;
127 struct madera_dai_priv dai
[MADERA_MAX_DAI
];
131 unsigned int in_pending
;
133 unsigned int out_up_pending
;
134 unsigned int out_up_delay
;
135 unsigned int out_down_pending
;
136 unsigned int out_down_delay
;
138 unsigned int adsp_rate_cache
[MADERA_MAX_ADSP
];
140 struct mutex rate_lock
;
142 int tdm_width
[MADERA_MAX_AIF
];
143 int tdm_slots
[MADERA_MAX_AIF
];
145 int domain_group_ref
[MADERA_N_DOM_GRPS
];
148 struct madera_fll_cfg
{
159 struct madera
*madera
;
166 unsigned int sync_freq
;
169 unsigned int ref_freq
;
170 struct madera_fll_cfg ref_cfg
;
174 struct soc_enum mixer_enum
;
178 extern const unsigned int madera_ana_tlv
[];
179 extern const unsigned int madera_eq_tlv
[];
180 extern const unsigned int madera_digital_tlv
[];
181 extern const unsigned int madera_noise_tlv
[];
182 extern const unsigned int madera_ng_tlv
[];
184 extern const unsigned int madera_mixer_tlv
[];
185 extern const char * const madera_mixer_texts
[MADERA_NUM_MIXER_INPUTS
];
186 extern unsigned int madera_mixer_values
[MADERA_NUM_MIXER_INPUTS
];
188 #define MADERA_GAINMUX_CONTROLS(name, base) \
189 SOC_SINGLE_RANGE_TLV(name " Input Volume", base + 1, \
190 MADERA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \
193 #define MADERA_MIXER_CONTROLS(name, base) \
194 SOC_SINGLE_RANGE_TLV(name " Input 1 Volume", base + 1, \
195 MADERA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \
197 SOC_SINGLE_RANGE_TLV(name " Input 2 Volume", base + 3, \
198 MADERA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \
200 SOC_SINGLE_RANGE_TLV(name " Input 3 Volume", base + 5, \
201 MADERA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \
203 SOC_SINGLE_RANGE_TLV(name " Input 4 Volume", base + 7, \
204 MADERA_MIXER_VOL_SHIFT, 0x20, 0x50, 0, \
207 #define MADERA_MUX_ENUM_DECL(name, reg) \
208 SOC_VALUE_ENUM_SINGLE_AUTODISABLE_DECL( \
209 name, reg, 0, 0xff, madera_mixer_texts, madera_mixer_values)
211 #define MADERA_MUX_CTL_DECL(name) \
212 const struct snd_kcontrol_new name##_mux = \
213 SOC_DAPM_ENUM("Route", name##_enum)
215 #define MADERA_MUX_ENUMS(name, base_reg) \
216 static MADERA_MUX_ENUM_DECL(name##_enum, base_reg); \
217 static MADERA_MUX_CTL_DECL(name)
219 #define MADERA_MIXER_ENUMS(name, base_reg) \
220 MADERA_MUX_ENUMS(name##_in1, base_reg); \
221 MADERA_MUX_ENUMS(name##_in2, base_reg + 2); \
222 MADERA_MUX_ENUMS(name##_in3, base_reg + 4); \
223 MADERA_MUX_ENUMS(name##_in4, base_reg + 6)
225 #define MADERA_DSP_AUX_ENUMS(name, base_reg) \
226 MADERA_MUX_ENUMS(name##_aux1, base_reg); \
227 MADERA_MUX_ENUMS(name##_aux2, base_reg + 8); \
228 MADERA_MUX_ENUMS(name##_aux3, base_reg + 16); \
229 MADERA_MUX_ENUMS(name##_aux4, base_reg + 24); \
230 MADERA_MUX_ENUMS(name##_aux5, base_reg + 32); \
231 MADERA_MUX_ENUMS(name##_aux6, base_reg + 40)
233 #define MADERA_MUX(name, ctrl) \
234 SND_SOC_DAPM_MUX(name, SND_SOC_NOPM, 0, 0, ctrl)
236 #define MADERA_MUX_WIDGETS(name, name_str) \
237 MADERA_MUX(name_str " Input 1", &name##_mux)
239 #define MADERA_MIXER_WIDGETS(name, name_str) \
240 MADERA_MUX(name_str " Input 1", &name##_in1_mux), \
241 MADERA_MUX(name_str " Input 2", &name##_in2_mux), \
242 MADERA_MUX(name_str " Input 3", &name##_in3_mux), \
243 MADERA_MUX(name_str " Input 4", &name##_in4_mux), \
244 SND_SOC_DAPM_MIXER(name_str " Mixer", SND_SOC_NOPM, 0, 0, NULL, 0)
246 #define MADERA_DSP_WIDGETS(name, name_str) \
247 MADERA_MIXER_WIDGETS(name##L, name_str "L"), \
248 MADERA_MIXER_WIDGETS(name##R, name_str "R"), \
249 MADERA_MUX(name_str " Aux 1", &name##_aux1_mux), \
250 MADERA_MUX(name_str " Aux 2", &name##_aux2_mux), \
251 MADERA_MUX(name_str " Aux 3", &name##_aux3_mux), \
252 MADERA_MUX(name_str " Aux 4", &name##_aux4_mux), \
253 MADERA_MUX(name_str " Aux 5", &name##_aux5_mux), \
254 MADERA_MUX(name_str " Aux 6", &name##_aux6_mux)
256 #define MADERA_MUX_ROUTES(widget, name) \
257 { widget, NULL, name " Input 1" }, \
258 MADERA_MIXER_INPUT_ROUTES(name " Input 1")
260 #define MADERA_MIXER_ROUTES(widget, name) \
261 { widget, NULL, name " Mixer" }, \
262 { name " Mixer", NULL, name " Input 1" }, \
263 { name " Mixer", NULL, name " Input 2" }, \
264 { name " Mixer", NULL, name " Input 3" }, \
265 { name " Mixer", NULL, name " Input 4" }, \
266 MADERA_MIXER_INPUT_ROUTES(name " Input 1"), \
267 MADERA_MIXER_INPUT_ROUTES(name " Input 2"), \
268 MADERA_MIXER_INPUT_ROUTES(name " Input 3"), \
269 MADERA_MIXER_INPUT_ROUTES(name " Input 4")
271 #define MADERA_DSP_ROUTES(name) \
272 { name, NULL, name " Preloader"}, \
273 { name " Preloader", NULL, "SYSCLK"}, \
274 { name " Preloader", NULL, "DSPCLK"}, \
275 { name, NULL, name " Aux 1" }, \
276 { name, NULL, name " Aux 2" }, \
277 { name, NULL, name " Aux 3" }, \
278 { name, NULL, name " Aux 4" }, \
279 { name, NULL, name " Aux 5" }, \
280 { name, NULL, name " Aux 6" }, \
281 MADERA_MIXER_INPUT_ROUTES(name " Aux 1"), \
282 MADERA_MIXER_INPUT_ROUTES(name " Aux 2"), \
283 MADERA_MIXER_INPUT_ROUTES(name " Aux 3"), \
284 MADERA_MIXER_INPUT_ROUTES(name " Aux 4"), \
285 MADERA_MIXER_INPUT_ROUTES(name " Aux 5"), \
286 MADERA_MIXER_INPUT_ROUTES(name " Aux 6"), \
287 MADERA_MIXER_ROUTES(name, name "L"), \
288 MADERA_MIXER_ROUTES(name, name "R")
290 #define MADERA_SAMPLE_RATE_CONTROL(name, domain) \
291 SOC_ENUM(name, madera_sample_rate[(domain) - 2])
293 #define MADERA_RATE_ENUM(xname, xenum) \
294 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
295 .info = snd_soc_info_enum_double, \
296 .get = snd_soc_get_enum_double, .put = madera_rate_put, \
297 .private_value = (unsigned long)&xenum }
299 #define MADERA_EQ_CONTROL(xname, xbase) \
300 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
301 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
302 .put = madera_eq_coeff_put, .private_value = \
303 ((unsigned long)&(struct soc_bytes) { .base = xbase, \
304 .num_regs = 20, .mask = ~MADERA_EQ1_B1_MODE }) }
306 #define MADERA_LHPF_CONTROL(xname, xbase) \
307 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
308 .info = snd_soc_bytes_info, .get = snd_soc_bytes_get, \
309 .put = madera_lhpf_coeff_put, .private_value = \
310 ((unsigned long)&(struct soc_bytes) { .base = xbase, \
313 #define MADERA_RATES SNDRV_PCM_RATE_KNOT
315 #define MADERA_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
316 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
318 #define MADERA_OSR_ENUM_SIZE 5
319 #define MADERA_SYNC_RATE_ENUM_SIZE 3
320 #define MADERA_ASYNC_RATE_ENUM_SIZE 2
321 #define MADERA_RATE_ENUM_SIZE \
322 (MADERA_SYNC_RATE_ENUM_SIZE + MADERA_ASYNC_RATE_ENUM_SIZE)
323 #define MADERA_SAMPLE_RATE_ENUM_SIZE 16
324 #define MADERA_DFC_TYPE_ENUM_SIZE 5
325 #define MADERA_DFC_WIDTH_ENUM_SIZE 5
327 extern const struct snd_soc_dai_ops madera_dai_ops
;
328 extern const struct snd_soc_dai_ops madera_simple_dai_ops
;
330 extern const struct snd_kcontrol_new madera_inmux
[];
332 extern const char * const madera_rate_text
[MADERA_RATE_ENUM_SIZE
];
333 extern const unsigned int madera_rate_val
[MADERA_RATE_ENUM_SIZE
];
334 extern const char * const madera_sample_rate_text
[MADERA_SAMPLE_RATE_ENUM_SIZE
];
335 extern const unsigned int madera_sample_rate_val
[MADERA_SAMPLE_RATE_ENUM_SIZE
];
336 extern const char * const madera_dfc_width_text
[MADERA_DFC_WIDTH_ENUM_SIZE
];
337 extern const unsigned int madera_dfc_width_val
[MADERA_DFC_WIDTH_ENUM_SIZE
];
338 extern const char * const madera_dfc_type_text
[MADERA_DFC_TYPE_ENUM_SIZE
];
339 extern const unsigned int madera_dfc_type_val
[MADERA_DFC_TYPE_ENUM_SIZE
];
341 extern const struct soc_enum madera_sample_rate
[];
342 extern const struct soc_enum madera_isrc_fsl
[];
343 extern const struct soc_enum madera_isrc_fsh
[];
344 extern const struct soc_enum madera_asrc1_rate
[];
345 extern const struct soc_enum madera_asrc2_rate
[];
346 extern const struct soc_enum madera_dfc_width
[];
347 extern const struct soc_enum madera_dfc_type
[];
348 extern const struct soc_enum madera_spdif_rate
;
350 extern const struct soc_enum madera_in_vi_ramp
;
351 extern const struct soc_enum madera_in_vd_ramp
;
353 extern const struct soc_enum madera_out_vi_ramp
;
354 extern const struct soc_enum madera_out_vd_ramp
;
356 extern const struct soc_enum madera_lhpf1_mode
;
357 extern const struct soc_enum madera_lhpf2_mode
;
358 extern const struct soc_enum madera_lhpf3_mode
;
359 extern const struct soc_enum madera_lhpf4_mode
;
361 extern const struct soc_enum madera_ng_hold
;
362 extern const struct soc_enum madera_in_hpf_cut_enum
;
363 extern const struct soc_enum madera_in_dmic_osr
[];
365 extern const struct soc_enum madera_output_anc_src
[];
366 extern const struct soc_enum madera_anc_input_src
[];
367 extern const struct soc_enum madera_anc_ng_enum
;
369 extern const struct snd_kcontrol_new madera_dsp_trigger_output_mux
[];
370 extern const struct snd_kcontrol_new madera_drc_activity_output_mux
[];
372 extern const struct snd_kcontrol_new madera_adsp_rate_controls
[];
374 const char *madera_sample_rate_val_to_name(unsigned int rate_val
);
376 int madera_dfc_put(struct snd_kcontrol
*kcontrol
,
377 struct snd_ctl_elem_value
*ucontrol
);
379 int madera_lp_mode_put(struct snd_kcontrol
*kcontrol
,
380 struct snd_ctl_elem_value
*ucontrol
);
382 int madera_out1_demux_put(struct snd_kcontrol
*kcontrol
,
383 struct snd_ctl_elem_value
*ucontrol
);
385 int madera_dre_put(struct snd_kcontrol
*kcontrol
,
386 struct snd_ctl_elem_value
*ucontrol
);
388 int madera_rate_put(struct snd_kcontrol
*kcontrol
,
389 struct snd_ctl_elem_value
*ucontrol
);
391 int madera_eq_coeff_put(struct snd_kcontrol
*kcontrol
,
392 struct snd_ctl_elem_value
*ucontrol
);
393 int madera_lhpf_coeff_put(struct snd_kcontrol
*kcontrol
,
394 struct snd_ctl_elem_value
*ucontrol
);
396 int madera_sysclk_ev(struct snd_soc_dapm_widget
*w
,
397 struct snd_kcontrol
*kcontrol
, int event
);
398 int madera_spk_ev(struct snd_soc_dapm_widget
*w
,
399 struct snd_kcontrol
*kcontrol
, int event
);
400 int madera_in_ev(struct snd_soc_dapm_widget
*w
,
401 struct snd_kcontrol
*kcontrol
, int event
);
402 int madera_out_ev(struct snd_soc_dapm_widget
*w
,
403 struct snd_kcontrol
*kcontrol
, int event
);
404 int madera_hp_ev(struct snd_soc_dapm_widget
*w
,
405 struct snd_kcontrol
*kcontrol
, int event
);
406 int madera_anc_ev(struct snd_soc_dapm_widget
*w
,
407 struct snd_kcontrol
*kcontrol
, int event
);
408 int madera_domain_clk_ev(struct snd_soc_dapm_widget
*w
,
409 struct snd_kcontrol
*kcontrol
,
412 int madera_adsp_rate_info(struct snd_kcontrol
*kcontrol
,
413 struct snd_ctl_elem_info
*uinfo
);
414 int madera_adsp_rate_get(struct snd_kcontrol
*kcontrol
,
415 struct snd_ctl_elem_value
*ucontrol
);
416 int madera_adsp_rate_put(struct snd_kcontrol
*kcontrol
,
417 struct snd_ctl_elem_value
*ucontrol
);
418 int madera_set_adsp_clk(struct madera_priv
*priv
, int dsp_num
,
421 int madera_set_sysclk(struct snd_soc_codec
*codec
, int clk_id
, int source
,
422 unsigned int freq
, int dir
);
423 int madera_get_legacy_dspclk_setting(struct madera
*madera
, unsigned int freq
);
424 void madera_spin_sysclk(struct madera_priv
*priv
);
426 int madera_init_fll(struct madera
*madera
, int id
, int base
,
427 struct madera_fll
*fll
);
428 int madera_set_fll_refclk(struct madera_fll
*fll
, int source
,
429 unsigned int Fref
, unsigned int Fout
);
430 int madera_set_fll_syncclk(struct madera_fll
*fll
, int source
,
431 unsigned int Fref
, unsigned int Fout
);
432 int madera_set_fll_ao_refclk(struct madera_fll
*fll
, int source
,
433 unsigned int fin
, unsigned int fout
);
435 int madera_core_init(struct madera_priv
*priv
);
436 int madera_core_destroy(struct madera_priv
*priv
);
437 int madera_init_overheat(struct madera_priv
*priv
);
438 int madera_free_overheat(struct madera_priv
*priv
);
439 int madera_init_inputs(struct snd_soc_codec
*codec
,
440 const char * const *dmic_inputs
,
442 const char * const *dmic_refs
,
444 int madera_init_outputs(struct snd_soc_codec
*codec
, int n_mono_routes
);
445 int madera_init_bus_error_irq(struct madera_priv
*priv
, int dsp_num
,
446 irq_handler_t handler
);
447 void madera_destroy_bus_error_irq(struct madera_priv
*priv
, int dsp_num
);
449 int madera_init_dai(struct madera_priv
*priv
, int dai
);
451 int madera_set_output_mode(struct snd_soc_codec
*codec
, int output
, bool diff
);
453 /* Following functions are for use by machine drivers */
454 static inline int madera_register_notifier(struct snd_soc_codec
*codec
,
455 struct notifier_block
*nb
)
457 struct madera
*madera
= dev_get_drvdata(codec
->dev
->parent
);
459 return blocking_notifier_chain_register(&madera
->notifier
, nb
);
462 static inline int madera_unregister_notifier(struct snd_soc_codec
*codec
,
463 struct notifier_block
*nb
)
465 struct madera
*madera
= dev_get_drvdata(codec
->dev
->parent
);
467 return blocking_notifier_chain_unregister(&madera
->notifier
, nb
);