1 // SPDX-License-Identifier: (GPL-2.0 OR MIT)
3 // Copyright (c) 2018 BayLibre, SAS.
4 // Author: Jerome Brunet <jbrunet@baylibre.com>
7 #include <linux/module.h>
8 #include <linux/of_platform.h>
9 #include <sound/pcm_params.h>
10 #include <sound/soc.h>
11 #include <sound/soc-dai.h>
15 /* Maximum bit clock frequency according the datasheets */
16 #define MAX_SCLK 100000000 /* Hz */
23 static unsigned int axg_tdm_slots_total(u32 *mask)
25 unsigned int slots = 0;
31 /* Count the total number of slots provided by all 4 lanes */
32 for (i = 0; i < AXG_TDM_NUM_LANES; i++)
33 slots += hweight32(mask[i]);
38 int axg_tdm_set_tdm_slots(struct snd_soc_dai *dai, u32 *tx_mask,
39 u32 *rx_mask, unsigned int slots,
40 unsigned int slot_width)
42 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
43 struct axg_tdm_stream *tx = snd_soc_dai_dma_data_get_playback(dai);
44 struct axg_tdm_stream *rx = snd_soc_dai_dma_data_get_capture(dai);
45 unsigned int tx_slots, rx_slots;
48 tx_slots = axg_tdm_slots_total(tx_mask);
49 rx_slots = axg_tdm_slots_total(rx_mask);
51 /* We should at least have a slot for a valid interface */
52 if (!tx_slots && !rx_slots) {
53 dev_err(dai->dev, "interface has no slot\n");
64 fmt |= SNDRV_PCM_FMTBIT_S32_LE;
67 fmt |= SNDRV_PCM_FMTBIT_S24_LE;
68 fmt |= SNDRV_PCM_FMTBIT_S20_LE;
71 fmt |= SNDRV_PCM_FMTBIT_S16_LE;
74 fmt |= SNDRV_PCM_FMTBIT_S8;
77 dev_err(dai->dev, "unsupported slot width: %d\n", slot_width);
81 iface->slot_width = slot_width;
83 /* Amend the dai driver and let dpcm merge do its job */
86 dai->driver->playback.channels_max = tx_slots;
87 dai->driver->playback.formats = fmt;
92 dai->driver->capture.channels_max = rx_slots;
93 dai->driver->capture.formats = fmt;
98 EXPORT_SYMBOL_GPL(axg_tdm_set_tdm_slots);
100 static int axg_tdm_iface_set_sysclk(struct snd_soc_dai *dai, int clk_id,
101 unsigned int freq, int dir)
103 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
106 if (dir == SND_SOC_CLOCK_OUT && clk_id == 0) {
108 dev_warn(dai->dev, "master clock not provided\n");
110 ret = clk_set_rate(iface->mclk, freq);
112 iface->mclk_rate = freq;
119 static int axg_tdm_iface_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
121 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
123 switch (fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
124 case SND_SOC_DAIFMT_BP_FP:
126 dev_err(dai->dev, "cpu clock master: mclk missing\n");
131 case SND_SOC_DAIFMT_BC_FC:
134 case SND_SOC_DAIFMT_BP_FC:
135 case SND_SOC_DAIFMT_BC_FP:
136 dev_err(dai->dev, "only CBS_CFS and CBM_CFM are supported\n");
146 static int axg_tdm_iface_startup(struct snd_pcm_substream *substream,
147 struct snd_soc_dai *dai)
149 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
150 struct axg_tdm_stream *ts =
151 snd_soc_dai_get_dma_data(dai, substream);
154 if (!axg_tdm_slots_total(ts->mask)) {
155 dev_err(dai->dev, "interface has not slots\n");
159 if (snd_soc_component_active(dai->component)) {
160 /* Apply component wide rate symmetry */
161 ret = snd_pcm_hw_constraint_single(substream->runtime,
162 SNDRV_PCM_HW_PARAM_RATE,
166 /* Limit rate according to the slot number and width */
167 unsigned int max_rate =
168 MAX_SCLK / (iface->slots * iface->slot_width);
169 ret = snd_pcm_hw_constraint_minmax(substream->runtime,
170 SNDRV_PCM_HW_PARAM_RATE,
175 dev_err(dai->dev, "can't set iface rate constraint\n");
182 static int axg_tdm_iface_set_stream(struct snd_pcm_substream *substream,
183 struct snd_pcm_hw_params *params,
184 struct snd_soc_dai *dai)
186 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
187 struct axg_tdm_stream *ts = snd_soc_dai_get_dma_data(dai, substream);
188 unsigned int channels = params_channels(params);
189 unsigned int width = params_width(params);
191 /* Save rate and sample_bits for component symmetry */
192 iface->rate = params_rate(params);
194 /* Make sure this interface can cope with the stream */
195 if (axg_tdm_slots_total(ts->mask) < channels) {
196 dev_err(dai->dev, "not enough slots for channels\n");
200 if (iface->slot_width < width) {
201 dev_err(dai->dev, "incompatible slots width for stream\n");
205 /* Save the parameter for tdmout/tdmin widgets */
206 ts->physical_width = params_physical_width(params);
207 ts->width = params_width(params);
208 ts->channels = params_channels(params);
213 static int axg_tdm_iface_set_lrclk(struct snd_soc_dai *dai,
214 struct snd_pcm_hw_params *params)
216 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
217 unsigned int ratio_num;
220 ret = clk_set_rate(iface->lrclk, params_rate(params));
222 dev_err(dai->dev, "setting sample clock failed: %d\n", ret);
226 switch (iface->fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
227 case SND_SOC_DAIFMT_I2S:
228 case SND_SOC_DAIFMT_LEFT_J:
229 case SND_SOC_DAIFMT_RIGHT_J:
230 /* 50% duty cycle ratio */
234 case SND_SOC_DAIFMT_DSP_A:
235 case SND_SOC_DAIFMT_DSP_B:
237 * A zero duty cycle ratio will result in setting the mininum
238 * ratio possible which, for this clock, is 1 cycle of the
239 * parent bclk clock high and the rest low, This is exactly
249 ret = clk_set_duty_cycle(iface->lrclk, ratio_num, 2);
252 "setting sample clock duty cycle failed: %d\n", ret);
256 /* Set sample clock inversion */
257 ret = clk_set_phase(iface->lrclk,
258 axg_tdm_lrclk_invert(iface->fmt) ? 180 : 0);
261 "setting sample clock phase failed: %d\n", ret);
268 static int axg_tdm_iface_set_sclk(struct snd_soc_dai *dai,
269 struct snd_pcm_hw_params *params)
271 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
275 srate = iface->slots * iface->slot_width * params_rate(params);
277 if (!iface->mclk_rate) {
278 /* If no specific mclk is requested, default to bit clock * 2 */
279 clk_set_rate(iface->mclk, 2 * srate);
281 /* Check if we can actually get the bit clock from mclk */
282 if (iface->mclk_rate % srate) {
284 "can't derive sclk %lu from mclk %lu\n",
285 srate, iface->mclk_rate);
290 ret = clk_set_rate(iface->sclk, srate);
292 dev_err(dai->dev, "setting bit clock failed: %d\n", ret);
296 /* Set the bit clock inversion */
297 ret = clk_set_phase(iface->sclk,
298 axg_tdm_sclk_invert(iface->fmt) ? 0 : 180);
300 dev_err(dai->dev, "setting bit clock phase failed: %d\n", ret);
307 static int axg_tdm_iface_hw_params(struct snd_pcm_substream *substream,
308 struct snd_pcm_hw_params *params,
309 struct snd_soc_dai *dai)
311 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
314 switch (iface->fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
315 case SND_SOC_DAIFMT_I2S:
316 case SND_SOC_DAIFMT_LEFT_J:
317 case SND_SOC_DAIFMT_RIGHT_J:
318 if (iface->slots > 2) {
319 dev_err(dai->dev, "bad slot number for format: %d\n",
325 case SND_SOC_DAIFMT_DSP_A:
326 case SND_SOC_DAIFMT_DSP_B:
330 dev_err(dai->dev, "unsupported dai format\n");
334 ret = axg_tdm_iface_set_stream(substream, params, dai);
338 if ((iface->fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) ==
339 SND_SOC_DAIFMT_BP_FP) {
340 ret = axg_tdm_iface_set_sclk(dai, params);
344 ret = axg_tdm_iface_set_lrclk(dai, params);
352 static int axg_tdm_iface_hw_free(struct snd_pcm_substream *substream,
353 struct snd_soc_dai *dai)
355 struct axg_tdm_stream *ts = snd_soc_dai_get_dma_data(dai, substream);
357 /* Stop all attached formatters */
358 axg_tdm_stream_stop(ts);
363 static int axg_tdm_iface_prepare(struct snd_pcm_substream *substream,
364 struct snd_soc_dai *dai)
366 struct axg_tdm_stream *ts = snd_soc_dai_get_dma_data(dai, substream);
368 /* Force all attached formatters to update */
369 return axg_tdm_stream_reset(ts);
372 static int axg_tdm_iface_remove_dai(struct snd_soc_dai *dai)
376 for_each_pcm_streams(stream) {
377 struct axg_tdm_stream *ts = snd_soc_dai_dma_data_get(dai, stream);
380 axg_tdm_stream_free(ts);
386 static int axg_tdm_iface_probe_dai(struct snd_soc_dai *dai)
388 struct axg_tdm_iface *iface = snd_soc_dai_get_drvdata(dai);
391 for_each_pcm_streams(stream) {
392 struct axg_tdm_stream *ts;
394 if (!snd_soc_dai_get_widget(dai, stream))
397 ts = axg_tdm_stream_alloc(iface);
399 axg_tdm_iface_remove_dai(dai);
402 snd_soc_dai_dma_data_set(dai, stream, ts);
408 static const struct snd_soc_dai_ops axg_tdm_iface_ops = {
409 .probe = axg_tdm_iface_probe_dai,
410 .remove = axg_tdm_iface_remove_dai,
411 .set_sysclk = axg_tdm_iface_set_sysclk,
412 .set_fmt = axg_tdm_iface_set_fmt,
413 .startup = axg_tdm_iface_startup,
414 .hw_params = axg_tdm_iface_hw_params,
415 .prepare = axg_tdm_iface_prepare,
416 .hw_free = axg_tdm_iface_hw_free,
419 /* TDM Backend DAIs */
420 static const struct snd_soc_dai_driver axg_tdm_iface_dai_drv[] = {
424 .stream_name = "Playback",
426 .channels_max = AXG_TDM_CHANNEL_MAX,
427 .rates = AXG_TDM_RATES,
428 .formats = AXG_TDM_FORMATS,
431 .stream_name = "Capture",
433 .channels_max = AXG_TDM_CHANNEL_MAX,
434 .rates = AXG_TDM_RATES,
435 .formats = AXG_TDM_FORMATS,
438 .ops = &axg_tdm_iface_ops,
440 [TDM_IFACE_LOOPBACK] = {
441 .name = "TDM Loopback",
443 .stream_name = "Loopback",
445 .channels_max = AXG_TDM_CHANNEL_MAX,
446 .rates = AXG_TDM_RATES,
447 .formats = AXG_TDM_FORMATS,
449 .id = TDM_IFACE_LOOPBACK,
450 .ops = &axg_tdm_iface_ops,
454 static int axg_tdm_iface_set_bias_level(struct snd_soc_component *component,
455 enum snd_soc_bias_level level)
457 struct axg_tdm_iface *iface = snd_soc_component_get_drvdata(component);
458 enum snd_soc_bias_level now =
459 snd_soc_component_get_bias_level(component);
463 case SND_SOC_BIAS_PREPARE:
464 if (now == SND_SOC_BIAS_STANDBY)
465 ret = clk_prepare_enable(iface->mclk);
468 case SND_SOC_BIAS_STANDBY:
469 if (now == SND_SOC_BIAS_PREPARE)
470 clk_disable_unprepare(iface->mclk);
473 case SND_SOC_BIAS_OFF:
474 case SND_SOC_BIAS_ON:
481 static const struct snd_soc_dapm_widget axg_tdm_iface_dapm_widgets[] = {
482 SND_SOC_DAPM_SIGGEN("Playback Signal"),
485 static const struct snd_soc_dapm_route axg_tdm_iface_dapm_routes[] = {
486 { "Loopback", NULL, "Playback Signal" },
489 static const struct snd_soc_component_driver axg_tdm_iface_component_drv = {
490 .dapm_widgets = axg_tdm_iface_dapm_widgets,
491 .num_dapm_widgets = ARRAY_SIZE(axg_tdm_iface_dapm_widgets),
492 .dapm_routes = axg_tdm_iface_dapm_routes,
493 .num_dapm_routes = ARRAY_SIZE(axg_tdm_iface_dapm_routes),
494 .set_bias_level = axg_tdm_iface_set_bias_level,
497 static const struct of_device_id axg_tdm_iface_of_match[] = {
498 { .compatible = "amlogic,axg-tdm-iface", },
501 MODULE_DEVICE_TABLE(of, axg_tdm_iface_of_match);
503 static int axg_tdm_iface_probe(struct platform_device *pdev)
505 struct device *dev = &pdev->dev;
506 struct snd_soc_dai_driver *dai_drv;
507 struct axg_tdm_iface *iface;
510 iface = devm_kzalloc(dev, sizeof(*iface), GFP_KERNEL);
513 platform_set_drvdata(pdev, iface);
516 * Duplicate dai driver: depending on the slot masks configuration
517 * We'll change the number of channel provided by DAI stream, so dpcm
518 * channel merge can be done properly
520 dai_drv = devm_kcalloc(dev, ARRAY_SIZE(axg_tdm_iface_dai_drv),
521 sizeof(*dai_drv), GFP_KERNEL);
525 for (i = 0; i < ARRAY_SIZE(axg_tdm_iface_dai_drv); i++)
526 memcpy(&dai_drv[i], &axg_tdm_iface_dai_drv[i],
529 /* Bit clock provided on the pad */
530 iface->sclk = devm_clk_get(dev, "sclk");
531 if (IS_ERR(iface->sclk))
532 return dev_err_probe(dev, PTR_ERR(iface->sclk), "failed to get sclk\n");
534 /* Sample clock provided on the pad */
535 iface->lrclk = devm_clk_get(dev, "lrclk");
536 if (IS_ERR(iface->lrclk))
537 return dev_err_probe(dev, PTR_ERR(iface->lrclk), "failed to get lrclk\n");
540 * mclk maybe be missing when the cpu dai is in slave mode and
541 * the codec does not require it to provide a master clock.
542 * At this point, ignore the error if mclk is missing. We'll
543 * throw an error if the cpu dai is master and mclk is missing
545 iface->mclk = devm_clk_get_optional(dev, "mclk");
546 if (IS_ERR(iface->mclk))
547 return dev_err_probe(dev, PTR_ERR(iface->mclk), "failed to get mclk\n");
549 return devm_snd_soc_register_component(dev,
550 &axg_tdm_iface_component_drv, dai_drv,
551 ARRAY_SIZE(axg_tdm_iface_dai_drv));
554 static struct platform_driver axg_tdm_iface_pdrv = {
555 .probe = axg_tdm_iface_probe,
557 .name = "axg-tdm-iface",
558 .of_match_table = axg_tdm_iface_of_match,
561 module_platform_driver(axg_tdm_iface_pdrv);
563 MODULE_DESCRIPTION("Amlogic AXG TDM interface driver");
564 MODULE_AUTHOR("Jerome Brunet <jbrunet@baylibre.com>");
565 MODULE_LICENSE("GPL v2");