1 // SPDX-License-Identifier: GPL-2.0-only
3 // rt1318-sdw.c -- rt1318 SDCA ALSA SoC amplifier audio driver
5 // Copyright(c) 2022 Realtek Semiconductor Corp.
8 #include <linux/delay.h>
9 #include <linux/device.h>
10 #include <linux/pm_runtime.h>
11 #include <linux/mod_devicetable.h>
12 #include <linux/module.h>
13 #include <linux/regmap.h>
14 #include <linux/dmi.h>
15 #include <linux/firmware.h>
16 #include <sound/core.h>
17 #include <sound/pcm.h>
18 #include <sound/pcm_params.h>
19 #include <sound/soc-dapm.h>
20 #include <sound/initval.h>
21 #include "rt1318-sdw.h"
23 static const struct reg_sequence rt1318_blind_write[] = {
162 static const struct reg_default rt1318_reg_defaults[] = {
239 { SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_UDMPU21, RT1318_SDCA_CTL_UDMPU_CLUSTER, 0), 0x00 },
240 { SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_FU21, RT1318_SDCA_CTL_FU_MUTE, CH_L), 0x01 },
241 { SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_FU21, RT1318_SDCA_CTL_FU_MUTE, CH_R), 0x01 },
242 { SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_PDE23, RT1318_SDCA_CTL_REQ_POWER_STATE, 0), 0x03 },
243 { SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_CS21, RT1318_SDCA_CTL_SAMPLE_FREQ_INDEX, 0), 0x09 },
246 static bool rt1318_readable_register(struct device *dev, unsigned int reg)
251 case 0x3004 ... 0x3005:
252 case 0x3202 ... 0x3203:
254 case 0xc000 ... 0xc00f:
255 case 0xc120 ... 0xc125:
256 case 0xc200 ... 0xc20e:
257 case 0xc300 ... 0xc303:
258 case 0xc320 ... 0xc322:
260 case 0xc430 ... 0xc431:
261 case 0xca00 ... 0xca02:
262 case 0xca10 ... 0xca12:
263 case 0xcb00 ... 0xcb0b:
264 case 0xcc00 ... 0xcce5:
265 case 0xcd00 ... 0xcde5:
266 case 0xce00 ... 0xce6a:
267 case 0xcf00 ... 0xcf53:
268 case 0xd000 ... 0xd0cc:
269 case 0xd100 ... 0xd1b9:
270 case 0xdb00 ... 0xdc53:
271 case 0xdd00 ... 0xde53:
272 case 0xdf00 ... 0xdf6b:
274 case 0xeb00 ... 0xebcc:
275 case 0xec00 ... 0xecb9:
276 case 0xed00 ... 0xed06:
277 case 0xf010 ... 0xf014:
278 case 0xf800 ... 0xf807:
279 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_UDMPU21, RT1318_SDCA_CTL_UDMPU_CLUSTER, 0):
280 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_FU21, RT1318_SDCA_CTL_FU_MUTE, CH_L):
281 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_FU21, RT1318_SDCA_CTL_FU_MUTE, CH_R):
282 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_PDE23, RT1318_SDCA_CTL_REQ_POWER_STATE, 0):
283 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_CS21, RT1318_SDCA_CTL_SAMPLE_FREQ_INDEX, 0):
284 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_SAPU, RT1318_SDCA_CTL_SAPU_PROTECTION_MODE, 0):
285 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_SAPU, RT1318_SDCA_CTL_SAPU_PROTECTION_STATUS, 0):
292 static bool rt1318_volatile_register(struct device *dev, unsigned int reg)
296 case 0x3000 ... 0x3001:
300 case 0xc430 ... 0xc431:
303 case 0xdb1d ... 0xdb1f:
306 case 0xdb8a ... 0xdb92:
307 case 0xdbc5 ... 0xdbc8:
308 case 0xdc2b ... 0xdc49:
311 case 0xdd1d ... 0xdd1f:
313 case 0xdd8a ... 0xdd92:
314 case 0xddc5 ... 0xddc8:
315 case 0xde2b ... 0xde44:
316 case 0xdf4a ... 0xdf55:
317 case 0xe224 ... 0xe23b:
321 case 0xebcb ... 0xebcc:
322 case 0xed03 ... 0xed06:
323 case 0xf010 ... 0xf014:
324 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_SAPU, RT1318_SDCA_CTL_SAPU_PROTECTION_MODE, 0):
325 case SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_SAPU, RT1318_SDCA_CTL_SAPU_PROTECTION_STATUS, 0):
332 static const struct regmap_config rt1318_sdw_regmap = {
335 .readable_reg = rt1318_readable_register,
336 .volatile_reg = rt1318_volatile_register,
337 .max_register = 0x41081488,
338 .reg_defaults = rt1318_reg_defaults,
339 .num_reg_defaults = ARRAY_SIZE(rt1318_reg_defaults),
340 .cache_type = REGCACHE_RBTREE,
341 .use_single_read = true,
342 .use_single_write = true,
345 static int rt1318_read_prop(struct sdw_slave *slave)
347 struct sdw_slave_prop *prop = &slave->prop;
352 struct sdw_dpn_prop *dpn;
354 prop->scp_int1_mask = SDW_SCP_INT1_BUS_CLASH | SDW_SCP_INT1_PARITY;
355 prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
356 prop->is_sdca = true;
358 prop->paging_support = true;
360 /* first we need to allocate memory for set bits in port lists */
361 prop->source_ports = BIT(2);
362 prop->sink_ports = BIT(1);
364 nval = hweight32(prop->source_ports);
365 prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
366 sizeof(*prop->src_dpn_prop), GFP_KERNEL);
367 if (!prop->src_dpn_prop)
371 dpn = prop->src_dpn_prop;
372 addr = prop->source_ports;
373 for_each_set_bit(bit, &addr, 32) {
375 dpn[i].type = SDW_DPN_FULL;
376 dpn[i].simple_ch_prep_sm = true;
377 dpn[i].ch_prep_timeout = 10;
381 /* do this again for sink now */
382 nval = hweight32(prop->sink_ports);
383 prop->sink_dpn_prop = devm_kcalloc(&slave->dev, nval,
384 sizeof(*prop->sink_dpn_prop), GFP_KERNEL);
385 if (!prop->sink_dpn_prop)
389 dpn = prop->sink_dpn_prop;
390 addr = prop->sink_ports;
391 for_each_set_bit(bit, &addr, 32) {
393 dpn[j].type = SDW_DPN_FULL;
394 dpn[j].simple_ch_prep_sm = true;
395 dpn[j].ch_prep_timeout = 10;
399 /* set the timeout values */
400 prop->clk_stop_timeout = 20;
405 static int rt1318_io_init(struct device *dev, struct sdw_slave *slave)
407 struct rt1318_sdw_priv *rt1318 = dev_get_drvdata(dev);
412 if (rt1318->first_hw_init) {
413 regcache_cache_only(rt1318->regmap, false);
414 regcache_cache_bypass(rt1318->regmap, true);
417 * PM runtime is only enabled when a Slave reports as Attached
420 /* set autosuspend parameters */
421 pm_runtime_set_autosuspend_delay(&slave->dev, 3000);
422 pm_runtime_use_autosuspend(&slave->dev);
424 /* update count of parent 'active' children */
425 pm_runtime_set_active(&slave->dev);
427 /* make sure the device does not suspend immediately */
428 pm_runtime_mark_last_busy(&slave->dev);
430 pm_runtime_enable(&slave->dev);
433 pm_runtime_get_noresume(&slave->dev);
436 regmap_multi_reg_write(rt1318->regmap, rt1318_blind_write,
437 ARRAY_SIZE(rt1318_blind_write));
439 if (rt1318->first_hw_init) {
440 regcache_cache_bypass(rt1318->regmap, false);
441 regcache_mark_dirty(rt1318->regmap);
444 /* Mark Slave initialization complete */
445 rt1318->first_hw_init = true;
446 rt1318->hw_init = true;
448 pm_runtime_mark_last_busy(&slave->dev);
449 pm_runtime_put_autosuspend(&slave->dev);
451 dev_dbg(&slave->dev, "%s hw_init complete\n", __func__);
455 static int rt1318_update_status(struct sdw_slave *slave,
456 enum sdw_slave_status status)
458 struct rt1318_sdw_priv *rt1318 = dev_get_drvdata(&slave->dev);
460 /* Update the status */
461 rt1318->status = status;
463 if (status == SDW_SLAVE_UNATTACHED)
464 rt1318->hw_init = false;
467 * Perform initialization only if slave status is present and
468 * hw_init flag is false
470 if (rt1318->hw_init || rt1318->status != SDW_SLAVE_ATTACHED)
473 /* perform I/O transfers required for Slave initialization */
474 return rt1318_io_init(&slave->dev, slave);
477 static int rt1318_classd_event(struct snd_soc_dapm_widget *w,
478 struct snd_kcontrol *kcontrol, int event)
480 struct snd_soc_component *component =
481 snd_soc_dapm_to_component(w->dapm);
482 struct rt1318_sdw_priv *rt1318 = snd_soc_component_get_drvdata(component);
483 unsigned char ps0 = 0x0, ps3 = 0x3;
486 case SND_SOC_DAPM_POST_PMU:
487 regmap_write(rt1318->regmap,
488 SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_PDE23,
489 RT1318_SDCA_CTL_REQ_POWER_STATE, 0),
492 case SND_SOC_DAPM_PRE_PMD:
493 regmap_write(rt1318->regmap,
494 SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_PDE23,
495 RT1318_SDCA_CTL_REQ_POWER_STATE, 0),
506 static const char * const rt1318_rx_data_ch_select[] = {
519 static SOC_ENUM_SINGLE_DECL(rt1318_rx_data_ch_enum,
520 SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_UDMPU21, RT1318_SDCA_CTL_UDMPU_CLUSTER, 0), 0,
521 rt1318_rx_data_ch_select);
523 static const struct snd_kcontrol_new rt1318_snd_controls[] = {
525 /* UDMPU Cluster Selection */
526 SOC_ENUM("RX Channel Select", rt1318_rx_data_ch_enum),
529 static const struct snd_kcontrol_new rt1318_sto_dac =
530 SOC_DAPM_DOUBLE_R("Switch",
531 SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_FU21, RT1318_SDCA_CTL_FU_MUTE, CH_L),
532 SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_FU21, RT1318_SDCA_CTL_FU_MUTE, CH_R),
535 static const struct snd_soc_dapm_widget rt1318_dapm_widgets[] = {
536 /* Audio Interface */
537 SND_SOC_DAPM_AIF_IN("DP1RX", "DP1 Playback", 0, SND_SOC_NOPM, 0, 0),
538 SND_SOC_DAPM_AIF_OUT("DP2TX", "DP2 Capture", 0, SND_SOC_NOPM, 0, 0),
540 /* Digital Interface */
541 SND_SOC_DAPM_SWITCH("DAC", SND_SOC_NOPM, 0, 0, &rt1318_sto_dac),
544 SND_SOC_DAPM_PGA_E("CLASS D", SND_SOC_NOPM, 0, 0, NULL, 0,
545 rt1318_classd_event, SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
546 SND_SOC_DAPM_OUTPUT("SPOL"),
547 SND_SOC_DAPM_OUTPUT("SPOR"),
549 SND_SOC_DAPM_PGA("FB Data", SND_SOC_NOPM, 0, 0, NULL, 0),
550 SND_SOC_DAPM_SIGGEN("FB Gen"),
553 static const struct snd_soc_dapm_route rt1318_dapm_routes[] = {
554 { "DAC", "Switch", "DP1RX" },
555 { "CLASS D", NULL, "DAC" },
556 { "SPOL", NULL, "CLASS D" },
557 { "SPOR", NULL, "CLASS D" },
559 { "FB Data", NULL, "FB Gen" },
560 { "DP2TX", NULL, "FB Data" },
563 static int rt1318_set_sdw_stream(struct snd_soc_dai *dai, void *sdw_stream,
566 struct sdw_stream_data *stream;
571 stream = kzalloc(sizeof(*stream), GFP_KERNEL);
575 stream->sdw_stream = sdw_stream;
577 /* Use tx_mask or rx_mask to configure stream tag and set dma_data */
578 if (direction == SNDRV_PCM_STREAM_PLAYBACK)
579 dai->playback_dma_data = stream;
581 dai->capture_dma_data = stream;
586 static void rt1318_sdw_shutdown(struct snd_pcm_substream *substream,
587 struct snd_soc_dai *dai)
589 struct sdw_stream_data *stream;
591 stream = snd_soc_dai_get_dma_data(dai, substream);
592 snd_soc_dai_set_dma_data(dai, substream, NULL);
596 static int rt1318_sdw_hw_params(struct snd_pcm_substream *substream,
597 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
599 struct snd_soc_component *component = dai->component;
600 struct rt1318_sdw_priv *rt1318 =
601 snd_soc_component_get_drvdata(component);
602 struct sdw_stream_config stream_config;
603 struct sdw_port_config port_config;
604 enum sdw_data_direction direction;
605 struct sdw_stream_data *stream;
606 int retval, port, num_channels, ch_mask;
607 unsigned int sampling_rate;
609 dev_dbg(dai->dev, "%s %s", __func__, dai->name);
610 stream = snd_soc_dai_get_dma_data(dai, substream);
615 if (!rt1318->sdw_slave)
618 /* SoundWire specific configuration */
619 /* port 1 for playback */
620 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
621 direction = SDW_DATA_DIR_RX;
624 direction = SDW_DATA_DIR_TX;
628 num_channels = params_channels(params);
629 ch_mask = (1 << num_channels) - 1;
631 stream_config.frame_rate = params_rate(params);
632 stream_config.ch_count = num_channels;
633 stream_config.bps = snd_pcm_format_width(params_format(params));
634 stream_config.direction = direction;
636 port_config.ch_mask = ch_mask;
637 port_config.num = port;
639 retval = sdw_stream_add_slave(rt1318->sdw_slave, &stream_config,
640 &port_config, 1, stream->sdw_stream);
642 dev_err(dai->dev, "Unable to configure port\n");
646 /* sampling rate configuration */
647 switch (params_rate(params)) {
649 sampling_rate = RT1318_SDCA_RATE_16000HZ;
652 sampling_rate = RT1318_SDCA_RATE_32000HZ;
655 sampling_rate = RT1318_SDCA_RATE_44100HZ;
658 sampling_rate = RT1318_SDCA_RATE_48000HZ;
661 sampling_rate = RT1318_SDCA_RATE_96000HZ;
664 sampling_rate = RT1318_SDCA_RATE_192000HZ;
667 dev_err(component->dev, "Rate %d is not supported\n",
668 params_rate(params));
672 /* set sampling frequency */
673 regmap_write(rt1318->regmap,
674 SDW_SDCA_CTL(FUNC_NUM_SMART_AMP, RT1318_SDCA_ENT_CS21, RT1318_SDCA_CTL_SAMPLE_FREQ_INDEX, 0),
680 static int rt1318_sdw_pcm_hw_free(struct snd_pcm_substream *substream,
681 struct snd_soc_dai *dai)
683 struct snd_soc_component *component = dai->component;
684 struct rt1318_sdw_priv *rt1318 =
685 snd_soc_component_get_drvdata(component);
686 struct sdw_stream_data *stream =
687 snd_soc_dai_get_dma_data(dai, substream);
689 if (!rt1318->sdw_slave)
692 sdw_stream_remove_slave(rt1318->sdw_slave, stream->sdw_stream);
697 * slave_ops: callbacks for get_clock_stop_mode, clock_stop and
698 * port_prep are not defined for now
700 static const struct sdw_slave_ops rt1318_slave_ops = {
701 .read_prop = rt1318_read_prop,
702 .update_status = rt1318_update_status,
705 static int rt1318_sdw_component_probe(struct snd_soc_component *component)
708 struct rt1318_sdw_priv *rt1318 = snd_soc_component_get_drvdata(component);
710 rt1318->component = component;
712 ret = pm_runtime_resume(component->dev);
713 dev_dbg(&rt1318->sdw_slave->dev, "%s pm_runtime_resume, ret=%d", __func__, ret);
714 if (ret < 0 && ret != -EACCES)
720 static const struct snd_soc_component_driver soc_component_sdw_rt1318 = {
721 .probe = rt1318_sdw_component_probe,
722 .controls = rt1318_snd_controls,
723 .num_controls = ARRAY_SIZE(rt1318_snd_controls),
724 .dapm_widgets = rt1318_dapm_widgets,
725 .num_dapm_widgets = ARRAY_SIZE(rt1318_dapm_widgets),
726 .dapm_routes = rt1318_dapm_routes,
727 .num_dapm_routes = ARRAY_SIZE(rt1318_dapm_routes),
731 static const struct snd_soc_dai_ops rt1318_aif_dai_ops = {
732 .hw_params = rt1318_sdw_hw_params,
733 .hw_free = rt1318_sdw_pcm_hw_free,
734 .set_stream = rt1318_set_sdw_stream,
735 .shutdown = rt1318_sdw_shutdown,
738 #define RT1318_STEREO_RATES (SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
739 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_192000)
740 #define RT1318_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE | \
741 SNDRV_PCM_FMTBIT_S32_LE)
743 static struct snd_soc_dai_driver rt1318_sdw_dai[] = {
745 .name = "rt1318-aif",
747 .stream_name = "DP1 Playback",
750 .rates = RT1318_STEREO_RATES,
751 .formats = RT1318_FORMATS,
754 .stream_name = "DP2 Capture",
757 .rates = RT1318_STEREO_RATES,
758 .formats = RT1318_FORMATS,
760 .ops = &rt1318_aif_dai_ops,
764 static int rt1318_sdw_init(struct device *dev, struct regmap *regmap,
765 struct sdw_slave *slave)
767 struct rt1318_sdw_priv *rt1318;
770 rt1318 = devm_kzalloc(dev, sizeof(*rt1318), GFP_KERNEL);
774 dev_set_drvdata(dev, rt1318);
775 rt1318->sdw_slave = slave;
776 rt1318->regmap = regmap;
779 * Mark hw_init to false
780 * HW init will be performed when device reports present
782 rt1318->hw_init = false;
783 rt1318->first_hw_init = false;
785 ret = devm_snd_soc_register_component(dev,
786 &soc_component_sdw_rt1318,
788 ARRAY_SIZE(rt1318_sdw_dai));
790 dev_dbg(&slave->dev, "%s\n", __func__);
795 static int rt1318_sdw_probe(struct sdw_slave *slave,
796 const struct sdw_device_id *id)
798 struct regmap *regmap;
800 /* Regmap Initialization */
801 regmap = devm_regmap_init_sdw(slave, &rt1318_sdw_regmap);
803 return PTR_ERR(regmap);
805 return rt1318_sdw_init(&slave->dev, regmap, slave);
808 static int rt1318_sdw_remove(struct sdw_slave *slave)
810 struct rt1318_sdw_priv *rt1318 = dev_get_drvdata(&slave->dev);
812 if (rt1318->first_hw_init)
813 pm_runtime_disable(&slave->dev);
818 static const struct sdw_device_id rt1318_id[] = {
819 SDW_SLAVE_ENTRY_EXT(0x025d, 0x1318, 0x3, 0x1, 0),
822 MODULE_DEVICE_TABLE(sdw, rt1318_id);
824 static int __maybe_unused rt1318_dev_suspend(struct device *dev)
826 struct rt1318_sdw_priv *rt1318 = dev_get_drvdata(dev);
828 if (!rt1318->hw_init)
831 regcache_cache_only(rt1318->regmap, true);
835 #define RT1318_PROBE_TIMEOUT 5000
837 static int __maybe_unused rt1318_dev_resume(struct device *dev)
839 struct sdw_slave *slave = dev_to_sdw_dev(dev);
840 struct rt1318_sdw_priv *rt1318 = dev_get_drvdata(dev);
843 if (!rt1318->first_hw_init)
846 if (!slave->unattach_request)
849 time = wait_for_completion_timeout(&slave->initialization_complete,
850 msecs_to_jiffies(RT1318_PROBE_TIMEOUT));
852 dev_err(&slave->dev, "Initialization not complete, timed out\n");
857 slave->unattach_request = 0;
858 regcache_cache_only(rt1318->regmap, false);
859 regcache_sync(rt1318->regmap);
864 static const struct dev_pm_ops rt1318_pm = {
865 SET_SYSTEM_SLEEP_PM_OPS(rt1318_dev_suspend, rt1318_dev_resume)
866 SET_RUNTIME_PM_OPS(rt1318_dev_suspend, rt1318_dev_resume, NULL)
869 static struct sdw_driver rt1318_sdw_driver = {
871 .name = "rt1318-sdca",
872 .owner = THIS_MODULE,
875 .probe = rt1318_sdw_probe,
876 .remove = rt1318_sdw_remove,
877 .ops = &rt1318_slave_ops,
878 .id_table = rt1318_id,
880 module_sdw_driver(rt1318_sdw_driver);
882 MODULE_DESCRIPTION("ASoC RT1318 driver SDCA SDW");
883 MODULE_AUTHOR("Shuming Fan <shumingf@realtek.com>");
884 MODULE_LICENSE("GPL");