Merge tag 'clk-fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux.git] / sound / soc / codecs / cs35l56-sdw.c
blob3f91cb3f9ae70fe720bb04b87e3c86fba157a7e4
1 // SPDX-License-Identifier: GPL-2.0-only
2 //
3 // CS35L56 ALSA SoC audio driver SoundWire binding
4 //
5 // Copyright (C) 2023 Cirrus Logic, Inc. and
6 // Cirrus Logic International Semiconductor Ltd.
8 #include <linux/delay.h>
9 #include <linux/device.h>
10 #include <linux/err.h>
11 #include <linux/module.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/regmap.h>
14 #include <linux/soundwire/sdw.h>
15 #include <linux/soundwire/sdw_registers.h>
16 #include <linux/soundwire/sdw_type.h>
17 #include <linux/swab.h>
18 #include <linux/types.h>
19 #include <linux/workqueue.h>
21 #include "cs35l56.h"
23 /* Register addresses are offset when sent over SoundWire */
24 #define CS35L56_SDW_ADDR_OFFSET 0x8000
26 /* Cirrus bus bridge registers */
27 #define CS35L56_SDW_MEM_ACCESS_STATUS 0xd0
28 #define CS35L56_SDW_MEM_READ_DATA 0xd8
30 #define CS35L56_SDW_LAST_LATE BIT(3)
31 #define CS35L56_SDW_CMD_IN_PROGRESS BIT(2)
32 #define CS35L56_SDW_RDATA_RDY BIT(0)
34 #define CS35L56_LATE_READ_POLL_US 10
35 #define CS35L56_LATE_READ_TIMEOUT_US 1000
37 static int cs35l56_sdw_poll_mem_status(struct sdw_slave *peripheral,
38 unsigned int mask,
39 unsigned int match)
41 int ret, val;
43 ret = read_poll_timeout(sdw_read_no_pm, val,
44 (val < 0) || ((val & mask) == match),
45 CS35L56_LATE_READ_POLL_US, CS35L56_LATE_READ_TIMEOUT_US,
46 false, peripheral, CS35L56_SDW_MEM_ACCESS_STATUS);
47 if (ret < 0)
48 return ret;
50 if (val < 0)
51 return val;
53 return 0;
56 static int cs35l56_sdw_slow_read(struct sdw_slave *peripheral, unsigned int reg,
57 u8 *buf, size_t val_size)
59 int ret, i;
61 reg += CS35L56_SDW_ADDR_OFFSET;
63 for (i = 0; i < val_size; i += sizeof(u32)) {
64 /* Poll for bus bridge idle */
65 ret = cs35l56_sdw_poll_mem_status(peripheral,
66 CS35L56_SDW_CMD_IN_PROGRESS,
67 0);
68 if (ret < 0) {
69 dev_err(&peripheral->dev, "!CMD_IN_PROGRESS fail: %d\n", ret);
70 return ret;
73 /* Reading LSByte triggers read of register to holding buffer */
74 sdw_read_no_pm(peripheral, reg + i);
76 /* Wait for data available */
77 ret = cs35l56_sdw_poll_mem_status(peripheral,
78 CS35L56_SDW_RDATA_RDY,
79 CS35L56_SDW_RDATA_RDY);
80 if (ret < 0) {
81 dev_err(&peripheral->dev, "RDATA_RDY fail: %d\n", ret);
82 return ret;
85 /* Read data from buffer */
86 ret = sdw_nread_no_pm(peripheral, CS35L56_SDW_MEM_READ_DATA,
87 sizeof(u32), &buf[i]);
88 if (ret) {
89 dev_err(&peripheral->dev, "Late read @%#x failed: %d\n", reg + i, ret);
90 return ret;
93 swab32s((u32 *)&buf[i]);
96 return 0;
99 static int cs35l56_sdw_read_one(struct sdw_slave *peripheral, unsigned int reg, void *buf)
101 int ret;
103 ret = sdw_nread_no_pm(peripheral, reg, 4, (u8 *)buf);
104 if (ret != 0) {
105 dev_err(&peripheral->dev, "Read failed @%#x:%d\n", reg, ret);
106 return ret;
109 swab32s((u32 *)buf);
111 return 0;
114 static int cs35l56_sdw_read(void *context, const void *reg_buf,
115 const size_t reg_size, void *val_buf,
116 size_t val_size)
118 struct sdw_slave *peripheral = context;
119 u8 *buf8 = val_buf;
120 unsigned int reg, bytes;
121 int ret;
123 reg = le32_to_cpu(*(const __le32 *)reg_buf);
125 if (cs35l56_is_otp_register(reg))
126 return cs35l56_sdw_slow_read(peripheral, reg, buf8, val_size);
128 reg += CS35L56_SDW_ADDR_OFFSET;
130 if (val_size == 4)
131 return cs35l56_sdw_read_one(peripheral, reg, val_buf);
133 while (val_size) {
134 bytes = SDW_REG_NO_PAGE - (reg & SDW_REGADDR); /* to end of page */
135 if (bytes > val_size)
136 bytes = val_size;
138 ret = sdw_nread_no_pm(peripheral, reg, bytes, buf8);
139 if (ret != 0) {
140 dev_err(&peripheral->dev, "Read failed @%#x..%#x:%d\n",
141 reg, reg + bytes - 1, ret);
142 return ret;
145 swab32_array((u32 *)buf8, bytes / 4);
146 val_size -= bytes;
147 reg += bytes;
148 buf8 += bytes;
151 return 0;
154 static inline void cs35l56_swab_copy(void *dest, const void *src, size_t nbytes)
156 u32 *dest32 = dest;
157 const u32 *src32 = src;
159 for (; nbytes > 0; nbytes -= 4)
160 *dest32++ = swab32(*src32++);
163 static int cs35l56_sdw_write_one(struct sdw_slave *peripheral, unsigned int reg, const void *buf)
165 u32 val_le = swab32(*(u32 *)buf);
166 int ret;
168 ret = sdw_nwrite_no_pm(peripheral, reg, 4, (u8 *)&val_le);
169 if (ret != 0) {
170 dev_err(&peripheral->dev, "Write failed @%#x:%d\n", reg, ret);
171 return ret;
174 return 0;
177 static int cs35l56_sdw_gather_write(void *context,
178 const void *reg_buf, size_t reg_size,
179 const void *val_buf, size_t val_size)
181 struct sdw_slave *peripheral = context;
182 const u8 *src_be = val_buf;
183 u32 val_le_buf[64]; /* Define u32 so it is 32-bit aligned */
184 unsigned int reg, bytes;
185 int ret;
187 reg = le32_to_cpu(*(const __le32 *)reg_buf);
188 reg += CS35L56_SDW_ADDR_OFFSET;
190 if (val_size == 4)
191 return cs35l56_sdw_write_one(peripheral, reg, src_be);
193 while (val_size) {
194 bytes = SDW_REG_NO_PAGE - (reg & SDW_REGADDR); /* to end of page */
195 if (bytes > val_size)
196 bytes = val_size;
197 if (bytes > sizeof(val_le_buf))
198 bytes = sizeof(val_le_buf);
200 cs35l56_swab_copy(val_le_buf, src_be, bytes);
202 ret = sdw_nwrite_no_pm(peripheral, reg, bytes, (u8 *)val_le_buf);
203 if (ret != 0) {
204 dev_err(&peripheral->dev, "Write failed @%#x..%#x:%d\n",
205 reg, reg + bytes - 1, ret);
206 return ret;
209 val_size -= bytes;
210 reg += bytes;
211 src_be += bytes;
214 return 0;
217 static int cs35l56_sdw_write(void *context, const void *val_buf, size_t val_size)
219 const u8 *src_buf = val_buf;
221 /* First word of val_buf contains the destination address */
222 return cs35l56_sdw_gather_write(context, &src_buf[0], 4, &src_buf[4], val_size - 4);
226 * Registers are big-endian on I2C and SPI but little-endian on SoundWire.
227 * Exported firmware controls are big-endian on I2C/SPI but little-endian on
228 * SoundWire. Firmware files are always big-endian and are opaque blobs.
229 * Present a big-endian regmap and hide the endianness swap, so that the ALSA
230 * byte controls always have the same byte order, and firmware file blobs
231 * can be written verbatim.
233 static const struct regmap_bus cs35l56_regmap_bus_sdw = {
234 .read = cs35l56_sdw_read,
235 .write = cs35l56_sdw_write,
236 .gather_write = cs35l56_sdw_gather_write,
237 .reg_format_endian_default = REGMAP_ENDIAN_LITTLE,
238 .val_format_endian_default = REGMAP_ENDIAN_BIG,
241 static int cs35l56_sdw_set_cal_index(struct cs35l56_private *cs35l56)
243 int ret;
245 /* SoundWire UniqueId is used to index the calibration array */
246 ret = sdw_read_no_pm(cs35l56->sdw_peripheral, SDW_SCP_DEVID_0);
247 if (ret < 0)
248 return ret;
250 cs35l56->base.cal_index = ret & 0xf;
252 return 0;
255 static void cs35l56_sdw_init(struct sdw_slave *peripheral)
257 struct cs35l56_private *cs35l56 = dev_get_drvdata(&peripheral->dev);
258 int ret;
260 pm_runtime_get_noresume(cs35l56->base.dev);
262 if (cs35l56->base.cal_index < 0) {
263 ret = cs35l56_sdw_set_cal_index(cs35l56);
264 if (ret < 0)
265 goto out;
268 ret = cs35l56_init(cs35l56);
269 if (ret < 0) {
270 regcache_cache_only(cs35l56->base.regmap, true);
271 goto out;
275 * cs35l56_init can return with !init_done if it triggered
276 * a soft reset.
278 if (cs35l56->base.init_done) {
279 /* Enable SoundWire interrupts */
280 sdw_write_no_pm(peripheral, CS35L56_SDW_GEN_INT_MASK_1,
281 CS35L56_SDW_INT_MASK_CODEC_IRQ);
284 out:
285 pm_runtime_mark_last_busy(cs35l56->base.dev);
286 pm_runtime_put_autosuspend(cs35l56->base.dev);
289 static int cs35l56_sdw_interrupt(struct sdw_slave *peripheral,
290 struct sdw_slave_intr_status *status)
292 struct cs35l56_private *cs35l56 = dev_get_drvdata(&peripheral->dev);
294 /* SoundWire core holds our pm_runtime when calling this function. */
296 dev_dbg(cs35l56->base.dev, "int control_port=%#x\n", status->control_port);
298 if ((status->control_port & SDW_SCP_INT1_IMPL_DEF) == 0)
299 return 0;
302 * Prevent bus manager suspending and possibly issuing a
303 * bus-reset before the queued work has run.
305 pm_runtime_get_noresume(cs35l56->base.dev);
308 * Mask and clear until it has been handled. The read of GEN_INT_STAT_1
309 * is required as per the SoundWire spec for interrupt status bits
310 * to clear. GEN_INT_MASK_1 masks the _inputs_ to GEN_INT_STAT1.
311 * None of the interrupts are time-critical so use the
312 * power-efficient queue.
314 sdw_write_no_pm(peripheral, CS35L56_SDW_GEN_INT_MASK_1, 0);
315 sdw_read_no_pm(peripheral, CS35L56_SDW_GEN_INT_STAT_1);
316 sdw_write_no_pm(peripheral, CS35L56_SDW_GEN_INT_STAT_1, 0xFF);
317 queue_work(system_power_efficient_wq, &cs35l56->sdw_irq_work);
319 return 0;
322 static void cs35l56_sdw_irq_work(struct work_struct *work)
324 struct cs35l56_private *cs35l56 = container_of(work,
325 struct cs35l56_private,
326 sdw_irq_work);
328 cs35l56_irq(-1, &cs35l56->base);
330 /* unmask interrupts */
331 if (!cs35l56->sdw_irq_no_unmask)
332 sdw_write_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_MASK_1,
333 CS35L56_SDW_INT_MASK_CODEC_IRQ);
335 pm_runtime_put_autosuspend(cs35l56->base.dev);
338 static int cs35l56_sdw_read_prop(struct sdw_slave *peripheral)
340 struct cs35l56_private *cs35l56 = dev_get_drvdata(&peripheral->dev);
341 struct sdw_slave_prop *prop = &peripheral->prop;
342 struct sdw_dpn_prop *ports;
344 ports = devm_kcalloc(cs35l56->base.dev, 2, sizeof(*ports), GFP_KERNEL);
345 if (!ports)
346 return -ENOMEM;
348 prop->source_ports = BIT(CS35L56_SDW1_CAPTURE_PORT);
349 prop->sink_ports = BIT(CS35L56_SDW1_PLAYBACK_PORT);
350 prop->paging_support = true;
351 prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
352 prop->scp_int1_mask = SDW_SCP_INT1_BUS_CLASH | SDW_SCP_INT1_PARITY | SDW_SCP_INT1_IMPL_DEF;
354 /* DP1 - playback */
355 ports[0].num = CS35L56_SDW1_PLAYBACK_PORT;
356 ports[0].type = SDW_DPN_FULL;
357 ports[0].ch_prep_timeout = 10;
358 prop->sink_dpn_prop = &ports[0];
360 /* DP3 - capture */
361 ports[1].num = CS35L56_SDW1_CAPTURE_PORT;
362 ports[1].type = SDW_DPN_FULL;
363 ports[1].ch_prep_timeout = 10;
364 prop->src_dpn_prop = &ports[1];
366 return 0;
369 static int cs35l56_sdw_update_status(struct sdw_slave *peripheral,
370 enum sdw_slave_status status)
372 struct cs35l56_private *cs35l56 = dev_get_drvdata(&peripheral->dev);
374 switch (status) {
375 case SDW_SLAVE_ATTACHED:
376 dev_dbg(cs35l56->base.dev, "%s: ATTACHED\n", __func__);
377 if (cs35l56->sdw_attached)
378 break;
380 if (!cs35l56->base.init_done || cs35l56->soft_resetting)
381 cs35l56_sdw_init(peripheral);
383 cs35l56->sdw_attached = true;
384 break;
385 case SDW_SLAVE_UNATTACHED:
386 dev_dbg(cs35l56->base.dev, "%s: UNATTACHED\n", __func__);
387 cs35l56->sdw_attached = false;
388 break;
389 default:
390 break;
393 return 0;
396 static int __maybe_unused cs35l56_sdw_clk_stop(struct sdw_slave *peripheral,
397 enum sdw_clk_stop_mode mode,
398 enum sdw_clk_stop_type type)
400 struct cs35l56_private *cs35l56 = dev_get_drvdata(&peripheral->dev);
402 dev_dbg(cs35l56->base.dev, "%s: mode:%d type:%d\n", __func__, mode, type);
404 return 0;
407 static const struct sdw_slave_ops cs35l56_sdw_ops = {
408 .read_prop = cs35l56_sdw_read_prop,
409 .interrupt_callback = cs35l56_sdw_interrupt,
410 .update_status = cs35l56_sdw_update_status,
411 #ifdef DEBUG
412 .clk_stop = cs35l56_sdw_clk_stop,
413 #endif
416 static int __maybe_unused cs35l56_sdw_handle_unattach(struct cs35l56_private *cs35l56)
418 struct sdw_slave *peripheral = cs35l56->sdw_peripheral;
420 if (peripheral->unattach_request) {
421 /* Cannot access registers until bus is re-initialized. */
422 dev_dbg(cs35l56->base.dev, "Wait for initialization_complete\n");
423 if (!wait_for_completion_timeout(&peripheral->initialization_complete,
424 msecs_to_jiffies(5000))) {
425 dev_err(cs35l56->base.dev, "initialization_complete timed out\n");
426 return -ETIMEDOUT;
429 peripheral->unattach_request = 0;
432 * Don't call regcache_mark_dirty(), we can't be sure that the
433 * Manager really did issue a Bus Reset.
437 return 0;
440 static int __maybe_unused cs35l56_sdw_runtime_suspend(struct device *dev)
442 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
444 if (!cs35l56->base.init_done)
445 return 0;
447 return cs35l56_runtime_suspend_common(&cs35l56->base);
450 static int __maybe_unused cs35l56_sdw_runtime_resume(struct device *dev)
452 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
453 int ret;
455 dev_dbg(dev, "Runtime resume\n");
457 if (!cs35l56->base.init_done)
458 return 0;
460 ret = cs35l56_sdw_handle_unattach(cs35l56);
461 if (ret < 0)
462 return ret;
464 ret = cs35l56_runtime_resume_common(&cs35l56->base, true);
465 if (ret)
466 return ret;
468 /* Re-enable SoundWire interrupts */
469 sdw_write_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_MASK_1,
470 CS35L56_SDW_INT_MASK_CODEC_IRQ);
472 return 0;
475 static int __maybe_unused cs35l56_sdw_system_suspend(struct device *dev)
477 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
479 if (!cs35l56->base.init_done)
480 return 0;
483 * Disable SoundWire interrupts.
484 * Flush - don't cancel because that could leave an unbalanced pm_runtime_get.
486 cs35l56->sdw_irq_no_unmask = true;
487 flush_work(&cs35l56->sdw_irq_work);
489 /* Mask interrupts and flush in case sdw_irq_work was queued again */
490 sdw_write_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_MASK_1, 0);
491 sdw_read_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_STAT_1);
492 sdw_write_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_STAT_1, 0xFF);
493 flush_work(&cs35l56->sdw_irq_work);
495 return cs35l56_system_suspend(dev);
498 static int __maybe_unused cs35l56_sdw_system_resume(struct device *dev)
500 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
502 cs35l56->sdw_irq_no_unmask = false;
503 /* runtime_resume re-enables the interrupt */
505 return cs35l56_system_resume(dev);
508 static int cs35l56_sdw_probe(struct sdw_slave *peripheral, const struct sdw_device_id *id)
510 struct device *dev = &peripheral->dev;
511 struct cs35l56_private *cs35l56;
512 int ret;
514 cs35l56 = devm_kzalloc(dev, sizeof(*cs35l56), GFP_KERNEL);
515 if (!cs35l56)
516 return -ENOMEM;
518 cs35l56->base.dev = dev;
519 cs35l56->sdw_peripheral = peripheral;
520 INIT_WORK(&cs35l56->sdw_irq_work, cs35l56_sdw_irq_work);
522 dev_set_drvdata(dev, cs35l56);
524 cs35l56->base.regmap = devm_regmap_init(dev, &cs35l56_regmap_bus_sdw,
525 peripheral, &cs35l56_regmap_sdw);
526 if (IS_ERR(cs35l56->base.regmap)) {
527 ret = PTR_ERR(cs35l56->base.regmap);
528 return dev_err_probe(dev, ret, "Failed to allocate register map\n");
531 /* Start in cache-only until device is enumerated */
532 regcache_cache_only(cs35l56->base.regmap, true);
534 ret = cs35l56_common_probe(cs35l56);
535 if (ret != 0)
536 return ret;
538 return 0;
541 static int cs35l56_sdw_remove(struct sdw_slave *peripheral)
543 struct cs35l56_private *cs35l56 = dev_get_drvdata(&peripheral->dev);
545 /* Disable SoundWire interrupts */
546 cs35l56->sdw_irq_no_unmask = true;
547 cancel_work_sync(&cs35l56->sdw_irq_work);
548 sdw_write_no_pm(peripheral, CS35L56_SDW_GEN_INT_MASK_1, 0);
549 sdw_read_no_pm(peripheral, CS35L56_SDW_GEN_INT_STAT_1);
550 sdw_write_no_pm(peripheral, CS35L56_SDW_GEN_INT_STAT_1, 0xFF);
552 cs35l56_remove(cs35l56);
554 return 0;
557 static const struct dev_pm_ops cs35l56_sdw_pm = {
558 SET_RUNTIME_PM_OPS(cs35l56_sdw_runtime_suspend, cs35l56_sdw_runtime_resume, NULL)
559 SYSTEM_SLEEP_PM_OPS(cs35l56_sdw_system_suspend, cs35l56_sdw_system_resume)
560 LATE_SYSTEM_SLEEP_PM_OPS(cs35l56_system_suspend_late, cs35l56_system_resume_early)
561 /* NOIRQ stage not needed, SoundWire doesn't use a hard IRQ */
564 static const struct sdw_device_id cs35l56_sdw_id[] = {
565 SDW_SLAVE_ENTRY(0x01FA, 0x3556, 0),
566 SDW_SLAVE_ENTRY(0x01FA, 0x3557, 0),
569 MODULE_DEVICE_TABLE(sdw, cs35l56_sdw_id);
571 static struct sdw_driver cs35l56_sdw_driver = {
572 .driver = {
573 .name = "cs35l56",
574 .pm = pm_ptr(&cs35l56_sdw_pm),
576 .probe = cs35l56_sdw_probe,
577 .remove = cs35l56_sdw_remove,
578 .ops = &cs35l56_sdw_ops,
579 .id_table = cs35l56_sdw_id,
582 module_sdw_driver(cs35l56_sdw_driver);
584 MODULE_DESCRIPTION("ASoC CS35L56 SoundWire driver");
585 MODULE_IMPORT_NS("SND_SOC_CS35L56_CORE");
586 MODULE_IMPORT_NS("SND_SOC_CS35L56_SHARED");
587 MODULE_AUTHOR("Richard Fitzgerald <rf@opensource.cirrus.com>");
588 MODULE_AUTHOR("Simon Trimmer <simont@opensource.cirrus.com>");
589 MODULE_LICENSE("GPL");