1 // SPDX-License-Identifier: GPL-2.0
3 // Helper routines for R-Car sound ADG.
5 // Copyright (C) 2013 Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 #include <linux/clk-provider.h>
22 #define BRRx_MASK(x) (0x3FF & x)
24 static struct rsnd_mod_ops adg_ops = {
29 struct clk *clk[CLKMAX];
30 struct clk *clkout[CLKOUTMAX];
31 struct clk_onecell_data onecell;
38 int rbga_rate_for_441khz; /* RBGA */
39 int rbgb_rate_for_48khz; /* RBGB */
42 #define LRCLK_ASYNC (1 << 0)
43 #define AUDIO_OUT_48 (1 << 1)
45 #define for_each_rsnd_clk(pos, adg, i) \
48 ((pos) = adg->clk[i]); \
50 #define for_each_rsnd_clkout(pos, adg, i) \
53 ((pos) = adg->clkout[i]); \
55 #define rsnd_priv_to_adg(priv) ((struct rsnd_adg *)(priv)->adg)
57 static const char * const clk_name[] = {
64 static u32 rsnd_adg_calculate_rbgx(unsigned long div)
71 for (i = 3; i >= 0; i--) {
73 if (0 == (div % ratio))
74 return (u32)((i << 8) | ((div / ratio) - 1));
80 static u32 rsnd_adg_ssi_ws_timing_gen2(struct rsnd_dai_stream *io)
82 struct rsnd_mod *ssi_mod = rsnd_io_to_mod_ssi(io);
83 int id = rsnd_mod_id(ssi_mod);
86 if (rsnd_ssi_is_pin_sharing(io)) {
101 return (0x6 + ws) << 8;
104 static void __rsnd_adg_get_timesel_ratio(struct rsnd_priv *priv,
105 struct rsnd_dai_stream *io,
106 unsigned int target_rate,
107 unsigned int *target_val,
108 unsigned int *target_en)
110 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
111 struct device *dev = rsnd_priv_to_dev(priv);
112 int idx, sel, div, step;
113 unsigned int val, en;
114 unsigned int min, diff;
115 unsigned int sel_rate[] = {
116 clk_get_rate(adg->clk[CLKA]), /* 0000: CLKA */
117 clk_get_rate(adg->clk[CLKB]), /* 0001: CLKB */
118 clk_get_rate(adg->clk[CLKC]), /* 0010: CLKC */
119 adg->rbga_rate_for_441khz, /* 0011: RBGA */
120 adg->rbgb_rate_for_48khz, /* 0100: RBGB */
126 for (sel = 0; sel < ARRAY_SIZE(sel_rate); sel++) {
133 for (div = 2; div <= 98304; div += step) {
134 diff = abs(target_rate - sel_rate[sel] / div);
136 val = (sel << 8) | idx;
138 en = 1 << (sel + 1); /* fixme */
142 * step of 0_0000 / 0_0001 / 0_1101
145 if ((idx > 2) && (idx % 2))
156 dev_err(dev, "no Input clock\n");
165 static void rsnd_adg_get_timesel_ratio(struct rsnd_priv *priv,
166 struct rsnd_dai_stream *io,
167 unsigned int in_rate,
168 unsigned int out_rate,
169 u32 *in, u32 *out, u32 *en)
171 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
172 unsigned int target_rate;
178 /* default = SSI WS */
180 _out = rsnd_adg_ssi_ws_timing_gen2(io);
185 if (runtime->rate != in_rate) {
186 target_rate = out_rate;
188 } else if (runtime->rate != out_rate) {
189 target_rate = in_rate;
194 __rsnd_adg_get_timesel_ratio(priv, io,
206 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *cmd_mod,
207 struct rsnd_dai_stream *io)
209 struct rsnd_priv *priv = rsnd_mod_to_priv(cmd_mod);
210 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
211 struct rsnd_mod *adg_mod = rsnd_mod_get(adg);
212 int id = rsnd_mod_id(cmd_mod);
213 int shift = (id % 2) ? 16 : 0;
216 rsnd_adg_get_timesel_ratio(priv, io,
217 rsnd_src_get_in_rate(priv, io),
218 rsnd_src_get_out_rate(priv, io),
222 mask = 0x0f1f << shift;
224 rsnd_mod_bset(adg_mod, CMDOUT_TIMSEL, mask, val);
229 int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
230 struct rsnd_dai_stream *io,
231 unsigned int in_rate,
232 unsigned int out_rate)
234 struct rsnd_priv *priv = rsnd_mod_to_priv(src_mod);
235 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
236 struct rsnd_mod *adg_mod = rsnd_mod_get(adg);
239 int id = rsnd_mod_id(src_mod);
240 int shift = (id % 2) ? 16 : 0;
242 rsnd_mod_confirm_src(src_mod);
244 rsnd_adg_get_timesel_ratio(priv, io,
250 mask = 0x0f1f << shift;
254 rsnd_mod_bset(adg_mod, SRCIN_TIMSEL0, mask, in);
255 rsnd_mod_bset(adg_mod, SRCOUT_TIMSEL0, mask, out);
258 rsnd_mod_bset(adg_mod, SRCIN_TIMSEL1, mask, in);
259 rsnd_mod_bset(adg_mod, SRCOUT_TIMSEL1, mask, out);
262 rsnd_mod_bset(adg_mod, SRCIN_TIMSEL2, mask, in);
263 rsnd_mod_bset(adg_mod, SRCOUT_TIMSEL2, mask, out);
266 rsnd_mod_bset(adg_mod, SRCIN_TIMSEL3, mask, in);
267 rsnd_mod_bset(adg_mod, SRCOUT_TIMSEL3, mask, out);
270 rsnd_mod_bset(adg_mod, SRCIN_TIMSEL4, mask, in);
271 rsnd_mod_bset(adg_mod, SRCOUT_TIMSEL4, mask, out);
276 rsnd_mod_bset(adg_mod, DIV_EN, en, en);
281 static void rsnd_adg_set_ssi_clk(struct rsnd_mod *ssi_mod, u32 val)
283 struct rsnd_priv *priv = rsnd_mod_to_priv(ssi_mod);
284 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
285 struct rsnd_mod *adg_mod = rsnd_mod_get(adg);
286 struct device *dev = rsnd_priv_to_dev(priv);
287 int id = rsnd_mod_id(ssi_mod);
288 int shift = (id % 4) * 8;
289 u32 mask = 0xFF << shift;
291 rsnd_mod_confirm_ssi(ssi_mod);
296 * SSI 8 is not connected to ADG.
297 * it works with SSI 7
304 rsnd_mod_bset(adg_mod, AUDIO_CLK_SEL0, mask, val);
307 rsnd_mod_bset(adg_mod, AUDIO_CLK_SEL1, mask, val);
310 rsnd_mod_bset(adg_mod, AUDIO_CLK_SEL2, mask, val);
314 dev_dbg(dev, "AUDIO_CLK_SEL is 0x%x\n", val);
317 int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate)
319 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
330 * find suitable clock from
331 * AUDIO_CLKA/AUDIO_CLKB/AUDIO_CLKC/AUDIO_CLKI.
333 for_each_rsnd_clk(clk, adg, i) {
334 if (rate == clk_get_rate(clk))
339 * find divided clock from BRGA/BRGB
341 if (rate == adg->rbga_rate_for_441khz)
344 if (rate == adg->rbgb_rate_for_48khz)
350 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *ssi_mod)
352 rsnd_adg_set_ssi_clk(ssi_mod, 0);
357 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *ssi_mod, unsigned int rate)
359 struct rsnd_priv *priv = rsnd_mod_to_priv(ssi_mod);
360 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
361 struct device *dev = rsnd_priv_to_dev(priv);
362 struct rsnd_mod *adg_mod = rsnd_mod_get(adg);
366 data = rsnd_adg_clk_query(priv, rate);
370 rsnd_adg_set_ssi_clk(ssi_mod, data);
372 if (rsnd_flags_has(adg, LRCLK_ASYNC)) {
373 if (rsnd_flags_has(adg, AUDIO_OUT_48))
376 if (0 == (rate % 8000))
380 rsnd_mod_bset(adg_mod, BRGCKR, 0x80770000, adg->ckr | ckr);
381 rsnd_mod_write(adg_mod, BRRA, adg->rbga);
382 rsnd_mod_write(adg_mod, BRRB, adg->rbgb);
384 dev_dbg(dev, "CLKOUT is based on BRG%c (= %dHz)\n",
386 (ckr) ? adg->rbgb_rate_for_48khz :
387 adg->rbga_rate_for_441khz);
392 void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable)
394 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
395 struct device *dev = rsnd_priv_to_dev(priv);
399 for_each_rsnd_clk(clk, adg, i) {
402 ret = clk_prepare_enable(clk);
404 clk_disable_unprepare(clk);
407 dev_warn(dev, "can't use clk %d\n", i);
411 static void rsnd_adg_get_clkin(struct rsnd_priv *priv,
412 struct rsnd_adg *adg)
414 struct device *dev = rsnd_priv_to_dev(priv);
418 for (i = 0; i < CLKMAX; i++) {
419 clk = devm_clk_get(dev, clk_name[i]);
420 adg->clk[i] = IS_ERR(clk) ? NULL : clk;
424 static void rsnd_adg_get_clkout(struct rsnd_priv *priv,
425 struct rsnd_adg *adg)
428 struct device *dev = rsnd_priv_to_dev(priv);
429 struct device_node *np = dev->of_node;
430 struct property *prop;
431 u32 ckr, rbgx, rbga, rbgb;
434 u32 req_rate[REQ_SIZE] = {};
436 unsigned long req_48kHz_rate, req_441kHz_rate;
438 const char *parent_clk_name = NULL;
439 static const char * const clkout_name[] = {
440 [CLKOUT] = "audio_clkout",
441 [CLKOUT1] = "audio_clkout1",
442 [CLKOUT2] = "audio_clkout2",
443 [CLKOUT3] = "audio_clkout3",
453 rbga = 2; /* default 1/6 */
454 rbgb = 2; /* default 1/6 */
457 * ADG supports BRRA/BRRB output only
458 * this means all clkout0/1/2/3 will be same rate
460 prop = of_find_property(np, "clock-frequency", NULL);
462 goto rsnd_adg_get_clkout_end;
464 req_size = prop->length / sizeof(u32);
466 of_property_read_u32_array(np, "clock-frequency", req_rate, req_size);
469 for (i = 0; i < req_size; i++) {
470 if (0 == (req_rate[i] % 44100))
471 req_441kHz_rate = req_rate[i];
472 if (0 == (req_rate[i] % 48000))
473 req_48kHz_rate = req_rate[i];
476 if (req_rate[0] % 48000 == 0)
477 rsnd_flags_set(adg, AUDIO_OUT_48);
479 if (of_get_property(np, "clkout-lr-asynchronous", NULL))
480 rsnd_flags_set(adg, LRCLK_ASYNC);
483 * This driver is assuming that AUDIO_CLKA/AUDIO_CLKB/AUDIO_CLKC
484 * have 44.1kHz or 48kHz base clocks for now.
486 * SSI itself can divide parent clock by 1/1 - 1/16
488 * rsnd_adg_ssi_clk_try_start()
489 * rsnd_ssi_master_clk_start()
491 adg->rbga_rate_for_441khz = 0;
492 adg->rbgb_rate_for_48khz = 0;
493 for_each_rsnd_clk(clk, adg, i) {
494 rate = clk_get_rate(clk);
496 if (0 == rate) /* not used */
500 if (!adg->rbga_rate_for_441khz && (0 == rate % 44100)) {
503 div = rate / req_441kHz_rate;
504 rbgx = rsnd_adg_calculate_rbgx(div);
505 if (BRRx_MASK(rbgx) == rbgx) {
507 adg->rbga_rate_for_441khz = rate / div;
508 ckr |= brg_table[i] << 20;
509 if (req_441kHz_rate &&
510 !rsnd_flags_has(adg, AUDIO_OUT_48))
511 parent_clk_name = __clk_get_name(clk);
516 if (!adg->rbgb_rate_for_48khz && (0 == rate % 48000)) {
519 div = rate / req_48kHz_rate;
520 rbgx = rsnd_adg_calculate_rbgx(div);
521 if (BRRx_MASK(rbgx) == rbgx) {
523 adg->rbgb_rate_for_48khz = rate / div;
524 ckr |= brg_table[i] << 16;
525 if (req_48kHz_rate &&
526 rsnd_flags_has(adg, AUDIO_OUT_48))
527 parent_clk_name = __clk_get_name(clk);
533 * ADG supports BRRA/BRRB output only.
534 * this means all clkout0/1/2/3 will be * same rate
537 of_property_read_u32(np, "#clock-cells", &count);
542 clk = clk_register_fixed_rate(dev, clkout_name[CLKOUT],
543 parent_clk_name, 0, req_rate[0]);
545 adg->clkout[CLKOUT] = clk;
546 of_clk_add_provider(np, of_clk_src_simple_get, clk);
553 for (i = 0; i < CLKOUTMAX; i++) {
554 clk = clk_register_fixed_rate(dev, clkout_name[i],
558 adg->clkout[i] = clk;
560 adg->onecell.clks = adg->clkout;
561 adg->onecell.clk_num = CLKOUTMAX;
562 of_clk_add_provider(np, of_clk_src_onecell_get,
566 rsnd_adg_get_clkout_end:
573 static void rsnd_adg_clk_dbg_info(struct rsnd_priv *priv, struct rsnd_adg *adg)
575 struct device *dev = rsnd_priv_to_dev(priv);
579 for_each_rsnd_clk(clk, adg, i)
580 dev_dbg(dev, "%s : %p : %ld\n",
581 clk_name[i], clk, clk_get_rate(clk));
583 dev_dbg(dev, "BRGCKR = 0x%08x, BRRA/BRRB = 0x%x/0x%x\n",
584 adg->ckr, adg->rbga, adg->rbgb);
585 dev_dbg(dev, "BRGA (for 44100 base) = %d\n", adg->rbga_rate_for_441khz);
586 dev_dbg(dev, "BRGB (for 48000 base) = %d\n", adg->rbgb_rate_for_48khz);
589 * Actual CLKOUT will be exchanged in rsnd_adg_ssi_clk_try_start()
590 * by BRGCKR::BRGCKR_31
592 for_each_rsnd_clkout(clk, adg, i)
593 dev_dbg(dev, "clkout %d : %p : %ld\n", i,
594 clk, clk_get_rate(clk));
597 #define rsnd_adg_clk_dbg_info(priv, adg)
600 int rsnd_adg_probe(struct rsnd_priv *priv)
602 struct rsnd_adg *adg;
603 struct device *dev = rsnd_priv_to_dev(priv);
606 adg = devm_kzalloc(dev, sizeof(*adg), GFP_KERNEL);
610 ret = rsnd_mod_init(priv, &adg->mod, &adg_ops,
615 rsnd_adg_get_clkin(priv, adg);
616 rsnd_adg_get_clkout(priv, adg);
617 rsnd_adg_clk_dbg_info(priv, adg);
621 rsnd_adg_clk_enable(priv);
626 void rsnd_adg_remove(struct rsnd_priv *priv)
628 struct device *dev = rsnd_priv_to_dev(priv);
629 struct device_node *np = dev->of_node;
630 struct rsnd_adg *adg = priv->adg;
634 for_each_rsnd_clkout(clk, adg, i)
636 clk_unregister_fixed_rate(adg->clkout[i]);
638 of_clk_del_provider(np);
640 rsnd_adg_clk_disable(priv);