1 // SPDX-License-Identifier: GPL-2.0-only
2 // cs42l42-sdw.c -- CS42L42 ALSA SoC audio driver SoundWire driver
4 // Copyright (C) 2022 Cirrus Logic, Inc. and
5 // Cirrus Logic International Semiconductor Ltd.
7 #include <linux/acpi.h>
8 #include <linux/device.h>
9 #include <linux/iopoll.h>
10 #include <linux/module.h>
11 #include <linux/mod_devicetable.h>
12 #include <linux/of_irq.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/soundwire/sdw.h>
15 #include <linux/soundwire/sdw_registers.h>
16 #include <linux/soundwire/sdw_type.h>
17 #include <sound/pcm.h>
18 #include <sound/pcm_params.h>
19 #include <sound/sdw.h>
20 #include <sound/soc.h>
24 #define CS42L42_SDW_CAPTURE_PORT 1
25 #define CS42L42_SDW_PLAYBACK_PORT 2
27 /* Register addresses are offset when sent over SoundWire */
28 #define CS42L42_SDW_ADDR_OFFSET 0x8000
30 #define CS42L42_SDW_MEM_ACCESS_STATUS 0xd0
31 #define CS42L42_SDW_MEM_READ_DATA 0xd8
33 #define CS42L42_SDW_LAST_LATE BIT(3)
34 #define CS42L42_SDW_CMD_IN_PROGRESS BIT(2)
35 #define CS42L42_SDW_RDATA_RDY BIT(0)
37 #define CS42L42_DELAYED_READ_POLL_US 1
38 #define CS42L42_DELAYED_READ_TIMEOUT_US 100
40 static const struct snd_soc_dapm_route cs42l42_sdw_audio_map[] = {
42 { "HP", NULL, "MIXER" },
43 { "MIXER", NULL, "DACSRC" },
44 { "DACSRC", NULL, "Playback" },
47 { "ADCSRC", NULL, "HS" },
48 { "Capture", NULL, "ADCSRC" },
51 static int cs42l42_sdw_dai_startup(struct snd_pcm_substream *substream,
52 struct snd_soc_dai *dai)
54 struct cs42l42_private *cs42l42 = snd_soc_component_get_drvdata(dai->component);
56 if (!cs42l42->init_done)
62 static int cs42l42_sdw_dai_hw_params(struct snd_pcm_substream *substream,
63 struct snd_pcm_hw_params *params,
64 struct snd_soc_dai *dai)
66 struct cs42l42_private *cs42l42 = snd_soc_component_get_drvdata(dai->component);
67 struct sdw_stream_runtime *sdw_stream = snd_soc_dai_get_dma_data(dai, substream);
68 struct sdw_stream_config stream_config = {0};
69 struct sdw_port_config port_config = {0};
75 /* Needed for PLL configuration when we are notified of new bus config */
76 cs42l42->sample_rate = params_rate(params);
78 snd_sdw_params_to_config(substream, params, &stream_config, &port_config);
80 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
81 port_config.num = CS42L42_SDW_PLAYBACK_PORT;
83 port_config.num = CS42L42_SDW_CAPTURE_PORT;
85 ret = sdw_stream_add_slave(cs42l42->sdw_peripheral, &stream_config, &port_config, 1,
88 dev_err(dai->dev, "Failed to add sdw stream: %d\n", ret);
92 cs42l42_src_config(dai->component, params_rate(params));
97 static int cs42l42_sdw_dai_prepare(struct snd_pcm_substream *substream,
98 struct snd_soc_dai *dai)
100 struct cs42l42_private *cs42l42 = snd_soc_component_get_drvdata(dai->component);
102 dev_dbg(dai->dev, "dai_prepare: sclk=%u rate=%u\n", cs42l42->sclk, cs42l42->sample_rate);
104 if (!cs42l42->sclk || !cs42l42->sample_rate)
108 * At this point we know the sample rate from hw_params, and the SWIRE_CLK from bus_config()
109 * callback. This could only fail if the ACPI or machine driver are misconfigured to allow
110 * an unsupported SWIRE_CLK and sample_rate combination.
113 return cs42l42_pll_config(dai->component, cs42l42->sclk, cs42l42->sample_rate);
116 static int cs42l42_sdw_dai_hw_free(struct snd_pcm_substream *substream,
117 struct snd_soc_dai *dai)
119 struct cs42l42_private *cs42l42 = snd_soc_component_get_drvdata(dai->component);
120 struct sdw_stream_runtime *sdw_stream = snd_soc_dai_get_dma_data(dai, substream);
122 sdw_stream_remove_slave(cs42l42->sdw_peripheral, sdw_stream);
123 cs42l42->sample_rate = 0;
128 static int cs42l42_sdw_port_prep(struct sdw_slave *slave,
129 struct sdw_prepare_ch *prepare_ch,
130 enum sdw_port_prep_ops state)
132 struct cs42l42_private *cs42l42 = dev_get_drvdata(&slave->dev);
133 unsigned int pdn_mask;
135 if (prepare_ch->num == CS42L42_SDW_PLAYBACK_PORT)
136 pdn_mask = CS42L42_HP_PDN_MASK;
138 pdn_mask = CS42L42_ADC_PDN_MASK;
140 if (state == SDW_OPS_PORT_PRE_PREP) {
141 dev_dbg(cs42l42->dev, "Prep Port pdn_mask:%x\n", pdn_mask);
142 regmap_clear_bits(cs42l42->regmap, CS42L42_PWR_CTL1, pdn_mask);
143 usleep_range(CS42L42_HP_ADC_EN_TIME_US, CS42L42_HP_ADC_EN_TIME_US + 1000);
144 } else if (state == SDW_OPS_PORT_POST_DEPREP) {
145 dev_dbg(cs42l42->dev, "Deprep Port pdn_mask:%x\n", pdn_mask);
146 regmap_set_bits(cs42l42->regmap, CS42L42_PWR_CTL1, pdn_mask);
152 static int cs42l42_sdw_dai_set_sdw_stream(struct snd_soc_dai *dai, void *sdw_stream,
155 snd_soc_dai_dma_data_set(dai, direction, sdw_stream);
160 static void cs42l42_sdw_dai_shutdown(struct snd_pcm_substream *substream,
161 struct snd_soc_dai *dai)
163 snd_soc_dai_set_dma_data(dai, substream, NULL);
166 static const struct snd_soc_dai_ops cs42l42_sdw_dai_ops = {
167 .startup = cs42l42_sdw_dai_startup,
168 .shutdown = cs42l42_sdw_dai_shutdown,
169 .hw_params = cs42l42_sdw_dai_hw_params,
170 .prepare = cs42l42_sdw_dai_prepare,
171 .hw_free = cs42l42_sdw_dai_hw_free,
172 .mute_stream = cs42l42_mute_stream,
173 .set_stream = cs42l42_sdw_dai_set_sdw_stream,
176 static struct snd_soc_dai_driver cs42l42_sdw_dai = {
177 .name = "cs42l42-sdw",
179 .stream_name = "Playback",
182 /* Restrict which rates and formats are supported */
183 .rates = SNDRV_PCM_RATE_8000_96000,
184 .formats = SNDRV_PCM_FMTBIT_S16_LE |
185 SNDRV_PCM_FMTBIT_S24_LE |
186 SNDRV_PCM_FMTBIT_S32_LE,
189 .stream_name = "Capture",
192 /* Restrict which rates and formats are supported */
193 .rates = SNDRV_PCM_RATE_8000_96000,
194 .formats = SNDRV_PCM_FMTBIT_S16_LE |
195 SNDRV_PCM_FMTBIT_S24_LE |
196 SNDRV_PCM_FMTBIT_S32_LE,
199 .ops = &cs42l42_sdw_dai_ops,
202 static int cs42l42_sdw_poll_status(struct sdw_slave *peripheral, u8 mask, u8 match)
206 ret = read_poll_timeout(sdw_read_no_pm, sdwret,
207 (sdwret < 0) || ((sdwret & mask) == match),
208 CS42L42_DELAYED_READ_POLL_US, CS42L42_DELAYED_READ_TIMEOUT_US,
209 false, peripheral, CS42L42_SDW_MEM_ACCESS_STATUS);
214 dev_err(&peripheral->dev, "MEM_ACCESS_STATUS & %#x for %#x fail: %d\n",
220 static int cs42l42_sdw_read(void *context, unsigned int reg, unsigned int *val)
222 struct sdw_slave *peripheral = context;
226 reg += CS42L42_SDW_ADDR_OFFSET;
228 ret = cs42l42_sdw_poll_status(peripheral, CS42L42_SDW_CMD_IN_PROGRESS, 0);
232 ret = sdw_read_no_pm(peripheral, reg);
234 dev_err(&peripheral->dev, "Failed to issue read @0x%x: %d\n", reg, ret);
238 data = (u8)ret; /* possible non-delayed read value */
239 ret = sdw_read_no_pm(peripheral, CS42L42_SDW_MEM_ACCESS_STATUS);
241 dev_err(&peripheral->dev, "Failed to read MEM_ACCESS_STATUS: %d\n", ret);
245 /* If read was not delayed we already have the result */
246 if ((ret & CS42L42_SDW_LAST_LATE) == 0) {
251 /* Poll for delayed read completion */
252 if ((ret & CS42L42_SDW_RDATA_RDY) == 0) {
253 ret = cs42l42_sdw_poll_status(peripheral,
254 CS42L42_SDW_RDATA_RDY, CS42L42_SDW_RDATA_RDY);
259 ret = sdw_read_no_pm(peripheral, CS42L42_SDW_MEM_READ_DATA);
261 dev_err(&peripheral->dev, "Failed to read READ_DATA: %d\n", ret);
270 static int cs42l42_sdw_write(void *context, unsigned int reg, unsigned int val)
272 struct sdw_slave *peripheral = context;
275 ret = cs42l42_sdw_poll_status(peripheral, CS42L42_SDW_CMD_IN_PROGRESS, 0);
279 return sdw_write_no_pm(peripheral, reg + CS42L42_SDW_ADDR_OFFSET, (u8)val);
282 /* Initialise cs42l42 using SoundWire - this is only called once, during initialisation */
283 static void cs42l42_sdw_init(struct sdw_slave *peripheral)
285 struct cs42l42_private *cs42l42 = dev_get_drvdata(&peripheral->dev);
288 regcache_cache_only(cs42l42->regmap, false);
290 ret = cs42l42_init(cs42l42);
292 regcache_cache_only(cs42l42->regmap, true);
296 /* Write out any cached changes that happened between probe and attach */
297 ret = regcache_sync(cs42l42->regmap);
299 dev_warn(cs42l42->dev, "Failed to sync cache: %d\n", ret);
301 /* Disable internal logic that makes clock-stop conditional */
302 regmap_clear_bits(cs42l42->regmap, CS42L42_PWR_CTL3, CS42L42_SW_CLK_STP_STAT_SEL_MASK);
305 /* This cancels the pm_runtime_get_noresume() call from cs42l42_sdw_probe(). */
306 pm_runtime_put_autosuspend(cs42l42->dev);
309 static int cs42l42_sdw_read_prop(struct sdw_slave *peripheral)
311 struct cs42l42_private *cs42l42 = dev_get_drvdata(&peripheral->dev);
312 struct sdw_slave_prop *prop = &peripheral->prop;
313 struct sdw_dpn_prop *ports;
315 ports = devm_kcalloc(cs42l42->dev, 2, sizeof(*ports), GFP_KERNEL);
319 prop->source_ports = BIT(CS42L42_SDW_CAPTURE_PORT);
320 prop->sink_ports = BIT(CS42L42_SDW_PLAYBACK_PORT);
321 prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
322 prop->scp_int1_mask = SDW_SCP_INT1_BUS_CLASH | SDW_SCP_INT1_PARITY;
325 ports[0].num = CS42L42_SDW_CAPTURE_PORT,
326 ports[0].type = SDW_DPN_FULL,
327 ports[0].ch_prep_timeout = 10,
328 prop->src_dpn_prop = &ports[0];
331 ports[1].num = CS42L42_SDW_PLAYBACK_PORT,
332 ports[1].type = SDW_DPN_FULL,
333 ports[1].ch_prep_timeout = 10,
334 prop->sink_dpn_prop = &ports[1];
339 static int cs42l42_sdw_update_status(struct sdw_slave *peripheral,
340 enum sdw_slave_status status)
342 struct cs42l42_private *cs42l42 = dev_get_drvdata(&peripheral->dev);
345 case SDW_SLAVE_ATTACHED:
346 dev_dbg(cs42l42->dev, "ATTACHED\n");
348 * Initialise codec, this only needs to be done once.
349 * When resuming from suspend, resume callback will handle re-init of codec,
350 * using regcache_sync().
352 if (!cs42l42->init_done)
353 cs42l42_sdw_init(peripheral);
355 case SDW_SLAVE_UNATTACHED:
356 dev_dbg(cs42l42->dev, "UNATTACHED\n");
365 static int cs42l42_sdw_bus_config(struct sdw_slave *peripheral,
366 struct sdw_bus_params *params)
368 struct cs42l42_private *cs42l42 = dev_get_drvdata(&peripheral->dev);
369 unsigned int new_sclk = params->curr_dr_freq / 2;
371 /* The cs42l42 cannot support a glitchless SWIRE_CLK change. */
372 if ((new_sclk != cs42l42->sclk) && cs42l42->stream_use) {
373 dev_warn(cs42l42->dev, "Rejected SCLK change while audio active\n");
377 cs42l42->sclk = new_sclk;
379 dev_dbg(cs42l42->dev, "bus_config: sclk=%u c=%u r=%u\n",
380 cs42l42->sclk, params->col, params->row);
385 static const struct sdw_slave_ops cs42l42_sdw_ops = {
386 /* No interrupt callback because only hardware INT is supported for Jack Detect in the CS42L42 */
387 .read_prop = cs42l42_sdw_read_prop,
388 .update_status = cs42l42_sdw_update_status,
389 .bus_config = cs42l42_sdw_bus_config,
390 .port_prep = cs42l42_sdw_port_prep,
393 static int __maybe_unused cs42l42_sdw_runtime_suspend(struct device *dev)
395 struct cs42l42_private *cs42l42 = dev_get_drvdata(dev);
397 dev_dbg(dev, "Runtime suspend\n");
399 if (!cs42l42->init_done)
402 /* The host controller could suspend, which would mean no register access */
403 regcache_cache_only(cs42l42->regmap, true);
408 static const struct reg_sequence __maybe_unused cs42l42_soft_reboot_seq[] = {
409 REG_SEQ0(CS42L42_SOFT_RESET_REBOOT, 0x1e),
412 static int __maybe_unused cs42l42_sdw_handle_unattach(struct cs42l42_private *cs42l42)
414 struct sdw_slave *peripheral = cs42l42->sdw_peripheral;
416 if (!peripheral->unattach_request)
419 /* Cannot access registers until master re-attaches. */
420 dev_dbg(&peripheral->dev, "Wait for initialization_complete\n");
421 if (!wait_for_completion_timeout(&peripheral->initialization_complete,
422 msecs_to_jiffies(5000))) {
423 dev_err(&peripheral->dev, "initialization_complete timed out\n");
427 peripheral->unattach_request = 0;
430 * After a bus reset there must be a reconfiguration reset to
431 * reinitialize the internal state of CS42L42.
433 regmap_multi_reg_write_bypassed(cs42l42->regmap,
434 cs42l42_soft_reboot_seq,
435 ARRAY_SIZE(cs42l42_soft_reboot_seq));
436 usleep_range(CS42L42_BOOT_TIME_US, CS42L42_BOOT_TIME_US * 2);
437 regcache_mark_dirty(cs42l42->regmap);
442 static int __maybe_unused cs42l42_sdw_runtime_resume(struct device *dev)
444 static const unsigned int ts_dbnce_ms[] = { 0, 125, 250, 500, 750, 1000, 1250, 1500};
445 struct cs42l42_private *cs42l42 = dev_get_drvdata(dev);
449 dev_dbg(dev, "Runtime resume\n");
451 if (!cs42l42->init_done)
454 ret = cs42l42_sdw_handle_unattach(cs42l42);
457 } else if (ret > 0) {
458 dbnce = max(cs42l42->ts_dbnc_rise, cs42l42->ts_dbnc_fall);
461 msleep(ts_dbnce_ms[dbnce]);
464 regcache_cache_only(cs42l42->regmap, false);
466 /* Sync LATCH_TO_VP first so the VP domain registers sync correctly */
467 regcache_sync_region(cs42l42->regmap, CS42L42_MIC_DET_CTL1, CS42L42_MIC_DET_CTL1);
468 regcache_sync(cs42l42->regmap);
473 static int __maybe_unused cs42l42_sdw_resume(struct device *dev)
475 struct cs42l42_private *cs42l42 = dev_get_drvdata(dev);
478 dev_dbg(dev, "System resume\n");
480 /* Power-up so it can re-enumerate */
481 ret = cs42l42_resume(dev);
485 /* Wait for re-attach */
486 ret = cs42l42_sdw_handle_unattach(cs42l42);
490 cs42l42_resume_restore(dev);
495 static int cs42l42_sdw_probe(struct sdw_slave *peripheral, const struct sdw_device_id *id)
497 struct snd_soc_component_driver *component_drv;
498 struct device *dev = &peripheral->dev;
499 struct cs42l42_private *cs42l42;
500 struct regmap_config *regmap_conf;
501 struct regmap *regmap;
504 cs42l42 = devm_kzalloc(dev, sizeof(*cs42l42), GFP_KERNEL);
508 if (has_acpi_companion(dev))
509 irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
511 irq = of_irq_get(dev->of_node, 0);
516 return dev_err_probe(dev, irq, "Failed to get IRQ\n");
518 regmap_conf = devm_kmemdup(dev, &cs42l42_regmap, sizeof(cs42l42_regmap), GFP_KERNEL);
521 regmap_conf->reg_bits = 16;
522 regmap_conf->num_ranges = 0;
523 regmap_conf->reg_read = cs42l42_sdw_read;
524 regmap_conf->reg_write = cs42l42_sdw_write;
526 regmap = devm_regmap_init(dev, NULL, peripheral, regmap_conf);
528 return dev_err_probe(dev, PTR_ERR(regmap), "Failed to allocate register map\n");
530 /* Start in cache-only until device is enumerated */
531 regcache_cache_only(regmap, true);
533 component_drv = devm_kmemdup(dev,
534 &cs42l42_soc_component,
535 sizeof(cs42l42_soc_component),
540 component_drv->dapm_routes = cs42l42_sdw_audio_map;
541 component_drv->num_dapm_routes = ARRAY_SIZE(cs42l42_sdw_audio_map);
544 cs42l42->regmap = regmap;
545 cs42l42->sdw_peripheral = peripheral;
547 cs42l42->devid = CS42L42_CHIP_ID;
550 * pm_runtime is needed to control bus manager suspend, and to
551 * recover from an unattach_request when the manager suspends.
553 pm_runtime_set_autosuspend_delay(cs42l42->dev, 3000);
554 pm_runtime_use_autosuspend(cs42l42->dev);
555 pm_runtime_mark_last_busy(cs42l42->dev);
556 pm_runtime_set_active(cs42l42->dev);
557 pm_runtime_get_noresume(cs42l42->dev);
558 pm_runtime_enable(cs42l42->dev);
560 ret = cs42l42_common_probe(cs42l42, component_drv, &cs42l42_sdw_dai);
567 static int cs42l42_sdw_remove(struct sdw_slave *peripheral)
569 struct cs42l42_private *cs42l42 = dev_get_drvdata(&peripheral->dev);
571 cs42l42_common_remove(cs42l42);
572 pm_runtime_disable(cs42l42->dev);
577 static const struct dev_pm_ops cs42l42_sdw_pm = {
578 SET_SYSTEM_SLEEP_PM_OPS(cs42l42_suspend, cs42l42_sdw_resume)
579 SET_RUNTIME_PM_OPS(cs42l42_sdw_runtime_suspend, cs42l42_sdw_runtime_resume, NULL)
582 static const struct sdw_device_id cs42l42_sdw_id[] = {
583 SDW_SLAVE_ENTRY(0x01FA, 0x4242, 0),
586 MODULE_DEVICE_TABLE(sdw, cs42l42_sdw_id);
588 static struct sdw_driver cs42l42_sdw_driver = {
590 .name = "cs42l42-sdw",
591 .pm = &cs42l42_sdw_pm,
593 .probe = cs42l42_sdw_probe,
594 .remove = cs42l42_sdw_remove,
595 .ops = &cs42l42_sdw_ops,
596 .id_table = cs42l42_sdw_id,
599 module_sdw_driver(cs42l42_sdw_driver);
601 MODULE_DESCRIPTION("ASoC CS42L42 SoundWire driver");
602 MODULE_AUTHOR("Richard Fitzgerald <rf@opensource.cirrus.com>");
603 MODULE_LICENSE("GPL");
604 MODULE_IMPORT_NS(SND_SOC_CS42L42_CORE);