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>
6 #include <linux/clk-provider.h>
7 #include <linux/clkdev.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;
39 int rbga_rate_for_441khz; /* RBGA */
40 int rbgb_rate_for_48khz; /* RBGB */
43 #define LRCLK_ASYNC (1 << 0)
44 #define AUDIO_OUT_48 (1 << 1)
46 #define for_each_rsnd_clk(pos, adg, i) \
49 ((pos) = adg->clk[i]); \
51 #define for_each_rsnd_clkout(pos, adg, i) \
54 ((pos) = adg->clkout[i]); \
56 #define rsnd_priv_to_adg(priv) ((struct rsnd_adg *)(priv)->adg)
58 static const char * const clk_name[] = {
65 static u32 rsnd_adg_calculate_rbgx(unsigned long div)
72 for (i = 3; i >= 0; i--) {
73 int ratio = 2 << (i * 2);
74 if (0 == (div % ratio))
75 return (u32)((i << 8) | ((div / ratio) - 1));
81 static u32 rsnd_adg_ssi_ws_timing_gen2(struct rsnd_dai_stream *io)
83 struct rsnd_mod *ssi_mod = rsnd_io_to_mod_ssi(io);
84 int id = rsnd_mod_id(ssi_mod);
87 if (rsnd_ssi_is_pin_sharing(io)) {
103 return (0x6 + ws) << 8;
106 static void __rsnd_adg_get_timesel_ratio(struct rsnd_priv *priv,
107 struct rsnd_dai_stream *io,
108 unsigned int target_rate,
109 unsigned int *target_val,
110 unsigned int *target_en)
112 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
113 struct device *dev = rsnd_priv_to_dev(priv);
115 unsigned int val, en;
116 unsigned int min, diff;
117 unsigned int sel_rate[] = {
118 adg->clk_rate[CLKA], /* 0000: CLKA */
119 adg->clk_rate[CLKB], /* 0001: CLKB */
120 adg->clk_rate[CLKC], /* 0010: CLKC */
121 adg->rbga_rate_for_441khz, /* 0011: RBGA */
122 adg->rbgb_rate_for_48khz, /* 0100: RBGB */
128 for (sel = 0; sel < ARRAY_SIZE(sel_rate); sel++) {
136 for (div = 2; div <= 98304; div += step) {
137 diff = abs(target_rate - sel_rate[sel] / div);
139 val = (sel << 8) | idx;
141 en = 1 << (sel + 1); /* fixme */
145 * step of 0_0000 / 0_0001 / 0_1101
148 if ((idx > 2) && (idx % 2))
159 dev_err(dev, "no Input clock\n");
168 static void rsnd_adg_get_timesel_ratio(struct rsnd_priv *priv,
169 struct rsnd_dai_stream *io,
170 unsigned int in_rate,
171 unsigned int out_rate,
172 u32 *in, u32 *out, u32 *en)
174 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
175 unsigned int target_rate;
181 /* default = SSI WS */
183 _out = rsnd_adg_ssi_ws_timing_gen2(io);
188 if (runtime->rate != in_rate) {
189 target_rate = out_rate;
191 } else if (runtime->rate != out_rate) {
192 target_rate = in_rate;
197 __rsnd_adg_get_timesel_ratio(priv, io,
209 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *cmd_mod,
210 struct rsnd_dai_stream *io)
212 struct rsnd_priv *priv = rsnd_mod_to_priv(cmd_mod);
213 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
214 struct rsnd_mod *adg_mod = rsnd_mod_get(adg);
215 int id = rsnd_mod_id(cmd_mod);
216 int shift = (id % 2) ? 16 : 0;
219 rsnd_adg_get_timesel_ratio(priv, io,
220 rsnd_src_get_in_rate(priv, io),
221 rsnd_src_get_out_rate(priv, io),
225 mask = 0x0f1f << shift;
227 rsnd_mod_bset(adg_mod, CMDOUT_TIMSEL, mask, val);
232 int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
233 struct rsnd_dai_stream *io,
234 unsigned int in_rate,
235 unsigned int out_rate)
237 struct rsnd_priv *priv = rsnd_mod_to_priv(src_mod);
238 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
239 struct rsnd_mod *adg_mod = rsnd_mod_get(adg);
242 int id = rsnd_mod_id(src_mod);
243 int shift = (id % 2) ? 16 : 0;
245 rsnd_mod_confirm_src(src_mod);
247 rsnd_adg_get_timesel_ratio(priv, io,
253 mask = 0x0f1f << shift;
255 rsnd_mod_bset(adg_mod, SRCIN_TIMSEL(id / 2), mask, in);
256 rsnd_mod_bset(adg_mod, SRCOUT_TIMSEL(id / 2), mask, out);
259 rsnd_mod_bset(adg_mod, DIV_EN, en, en);
264 static void rsnd_adg_set_ssi_clk(struct rsnd_mod *ssi_mod, u32 val)
266 struct rsnd_priv *priv = rsnd_mod_to_priv(ssi_mod);
267 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
268 struct rsnd_mod *adg_mod = rsnd_mod_get(adg);
269 struct device *dev = rsnd_priv_to_dev(priv);
270 int id = rsnd_mod_id(ssi_mod);
271 int shift = (id % 4) * 8;
272 u32 mask = 0xFF << shift;
274 rsnd_mod_confirm_ssi(ssi_mod);
279 * SSI 8 is not connected to ADG.
280 * it works with SSI 7
285 rsnd_mod_bset(adg_mod, AUDIO_CLK_SEL(id / 4), mask, val);
287 dev_dbg(dev, "AUDIO_CLK_SEL is 0x%x\n", val);
290 int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate)
292 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
302 * find suitable clock from
303 * AUDIO_CLKA/AUDIO_CLKB/AUDIO_CLKC/AUDIO_CLKI.
305 for (i = 0; i < CLKMAX; i++)
306 if (rate == adg->clk_rate[i])
310 * find divided clock from BRGA/BRGB
312 if (rate == adg->rbga_rate_for_441khz)
315 if (rate == adg->rbgb_rate_for_48khz)
321 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *ssi_mod)
323 rsnd_adg_set_ssi_clk(ssi_mod, 0);
328 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *ssi_mod, unsigned int rate)
330 struct rsnd_priv *priv = rsnd_mod_to_priv(ssi_mod);
331 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
332 struct device *dev = rsnd_priv_to_dev(priv);
333 struct rsnd_mod *adg_mod = rsnd_mod_get(adg);
337 data = rsnd_adg_clk_query(priv, rate);
341 rsnd_adg_set_ssi_clk(ssi_mod, data);
343 if (rsnd_flags_has(adg, LRCLK_ASYNC)) {
344 if (rsnd_flags_has(adg, AUDIO_OUT_48))
347 if (0 == (rate % 8000))
351 rsnd_mod_bset(adg_mod, BRGCKR, 0x80770000, adg->ckr | ckr);
352 rsnd_mod_write(adg_mod, BRRA, adg->rbga);
353 rsnd_mod_write(adg_mod, BRRB, adg->rbgb);
355 dev_dbg(dev, "CLKOUT is based on BRG%c (= %dHz)\n",
357 (ckr) ? adg->rbgb_rate_for_48khz :
358 adg->rbga_rate_for_441khz);
363 void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable)
365 struct rsnd_adg *adg = rsnd_priv_to_adg(priv);
366 struct device *dev = rsnd_priv_to_dev(priv);
370 for_each_rsnd_clk(clk, adg, i) {
372 int ret = clk_prepare_enable(clk);
375 * We shouldn't use clk_get_rate() under
376 * atomic context. Let's keep it when
377 * rsnd_adg_clk_enable() was called
379 adg->clk_rate[i] = 0;
381 dev_warn(dev, "can't use clk %d\n", i);
383 adg->clk_rate[i] = clk_get_rate(clk);
385 if (adg->clk_rate[i])
386 clk_disable_unprepare(clk);
387 adg->clk_rate[i] = 0;
392 #define NULL_CLK "rsnd_adg_null"
393 static struct clk *rsnd_adg_null_clk_get(struct rsnd_priv *priv)
395 struct device *dev = rsnd_priv_to_dev(priv);
397 if (!priv->null_hw) {
401 _hw = clk_hw_register_fixed_rate_with_accuracy(dev, NULL_CLK, NULL, 0, 0, 0);
405 ret = of_clk_add_hw_provider(dev->of_node, of_clk_hw_simple_get, _hw);
407 clk_hw_unregister_fixed_rate(_hw);
412 return clk_hw_get_clk(priv->null_hw, NULL_CLK);
415 static void rsnd_adg_get_clkin(struct rsnd_priv *priv,
416 struct rsnd_adg *adg)
418 struct device *dev = rsnd_priv_to_dev(priv);
421 for (i = 0; i < CLKMAX; i++) {
422 struct clk *clk = devm_clk_get(dev, clk_name[i]);
425 clk = rsnd_adg_null_clk_get(priv);
427 dev_err(dev, "no adg clock (%s)\n", clk_name[i]);
433 static void rsnd_adg_get_clkout(struct rsnd_priv *priv,
434 struct rsnd_adg *adg)
437 struct device *dev = rsnd_priv_to_dev(priv);
438 struct device_node *np = dev->of_node;
439 struct property *prop;
440 u32 ckr, rbgx, rbga, rbgb;
443 u32 req_rate[REQ_SIZE] = {};
445 unsigned long req_48kHz_rate, req_441kHz_rate;
447 const char *parent_clk_name = NULL;
448 static const char * const clkout_name[] = {
449 [CLKOUT] = "audio_clkout",
450 [CLKOUT1] = "audio_clkout1",
451 [CLKOUT2] = "audio_clkout2",
452 [CLKOUT3] = "audio_clkout3",
462 rbga = 2; /* default 1/6 */
463 rbgb = 2; /* default 1/6 */
466 * ADG supports BRRA/BRRB output only
467 * this means all clkout0/1/2/3 will be same rate
469 prop = of_find_property(np, "clock-frequency", NULL);
471 goto rsnd_adg_get_clkout_end;
473 req_size = prop->length / sizeof(u32);
474 if (req_size > REQ_SIZE) {
476 "too many clock-frequency, use top %d\n", REQ_SIZE);
480 of_property_read_u32_array(np, "clock-frequency", req_rate, req_size);
483 for (i = 0; i < req_size; i++) {
484 if (0 == (req_rate[i] % 44100))
485 req_441kHz_rate = req_rate[i];
486 if (0 == (req_rate[i] % 48000))
487 req_48kHz_rate = req_rate[i];
490 if (req_rate[0] % 48000 == 0)
491 rsnd_flags_set(adg, AUDIO_OUT_48);
493 if (of_get_property(np, "clkout-lr-asynchronous", NULL))
494 rsnd_flags_set(adg, LRCLK_ASYNC);
497 * This driver is assuming that AUDIO_CLKA/AUDIO_CLKB/AUDIO_CLKC
498 * have 44.1kHz or 48kHz base clocks for now.
500 * SSI itself can divide parent clock by 1/1 - 1/16
502 * rsnd_adg_ssi_clk_try_start()
503 * rsnd_ssi_master_clk_start()
505 adg->rbga_rate_for_441khz = 0;
506 adg->rbgb_rate_for_48khz = 0;
507 for_each_rsnd_clk(clk, adg, i) {
508 rate = clk_get_rate(clk);
510 if (0 == rate) /* not used */
514 if (!adg->rbga_rate_for_441khz && (0 == rate % 44100)) {
517 div = rate / req_441kHz_rate;
518 rbgx = rsnd_adg_calculate_rbgx(div);
519 if (BRRx_MASK(rbgx) == rbgx) {
521 adg->rbga_rate_for_441khz = rate / div;
522 ckr |= brg_table[i] << 20;
523 if (req_441kHz_rate &&
524 !rsnd_flags_has(adg, AUDIO_OUT_48))
525 parent_clk_name = __clk_get_name(clk);
530 if (!adg->rbgb_rate_for_48khz && (0 == rate % 48000)) {
533 div = rate / req_48kHz_rate;
534 rbgx = rsnd_adg_calculate_rbgx(div);
535 if (BRRx_MASK(rbgx) == rbgx) {
537 adg->rbgb_rate_for_48khz = rate / div;
538 ckr |= brg_table[i] << 16;
539 if (req_48kHz_rate &&
540 rsnd_flags_has(adg, AUDIO_OUT_48))
541 parent_clk_name = __clk_get_name(clk);
547 * ADG supports BRRA/BRRB output only.
548 * this means all clkout0/1/2/3 will be * same rate
551 of_property_read_u32(np, "#clock-cells", &count);
556 clk = clk_register_fixed_rate(dev, clkout_name[CLKOUT],
557 parent_clk_name, 0, req_rate[0]);
559 adg->clkout[CLKOUT] = clk;
560 of_clk_add_provider(np, of_clk_src_simple_get, clk);
567 for (i = 0; i < CLKOUTMAX; i++) {
568 clk = clk_register_fixed_rate(dev, clkout_name[i],
572 adg->clkout[i] = clk;
574 adg->onecell.clks = adg->clkout;
575 adg->onecell.clk_num = CLKOUTMAX;
576 of_clk_add_provider(np, of_clk_src_onecell_get,
580 rsnd_adg_get_clkout_end:
587 static void rsnd_adg_clk_dbg_info(struct rsnd_priv *priv, struct rsnd_adg *adg)
589 struct device *dev = rsnd_priv_to_dev(priv);
593 for_each_rsnd_clk(clk, adg, i)
594 dev_dbg(dev, "%s : %pa : %ld\n",
595 clk_name[i], clk, clk_get_rate(clk));
597 dev_dbg(dev, "BRGCKR = 0x%08x, BRRA/BRRB = 0x%x/0x%x\n",
598 adg->ckr, adg->rbga, adg->rbgb);
599 dev_dbg(dev, "BRGA (for 44100 base) = %d\n", adg->rbga_rate_for_441khz);
600 dev_dbg(dev, "BRGB (for 48000 base) = %d\n", adg->rbgb_rate_for_48khz);
603 * Actual CLKOUT will be exchanged in rsnd_adg_ssi_clk_try_start()
604 * by BRGCKR::BRGCKR_31
606 for_each_rsnd_clkout(clk, adg, i)
607 dev_dbg(dev, "clkout %d : %pa : %ld\n", i,
608 clk, clk_get_rate(clk));
611 #define rsnd_adg_clk_dbg_info(priv, adg)
614 int rsnd_adg_probe(struct rsnd_priv *priv)
616 struct rsnd_adg *adg;
617 struct device *dev = rsnd_priv_to_dev(priv);
620 adg = devm_kzalloc(dev, sizeof(*adg), GFP_KERNEL);
624 ret = rsnd_mod_init(priv, &adg->mod, &adg_ops,
629 rsnd_adg_get_clkin(priv, adg);
630 rsnd_adg_get_clkout(priv, adg);
631 rsnd_adg_clk_dbg_info(priv, adg);
635 rsnd_adg_clk_enable(priv);
640 void rsnd_adg_remove(struct rsnd_priv *priv)
642 struct device *dev = rsnd_priv_to_dev(priv);
643 struct device_node *np = dev->of_node;
644 struct rsnd_adg *adg = priv->adg;
648 for_each_rsnd_clkout(clk, adg, i)
650 clk_unregister_fixed_rate(adg->clkout[i]);
652 clk_hw_unregister_fixed_rate(priv->null_hw);
654 of_clk_del_provider(np);
656 rsnd_adg_clk_disable(priv);