1 // SPDX-License-Identifier: GPL-2.0-only
3 // Components shared between ASoC and HDA CS35L56 drivers
5 // Copyright (C) 2023 Cirrus Logic, Inc. and
6 // Cirrus Logic International Semiconductor Ltd.
8 #include <linux/firmware/cirrus/wmfw.h>
9 #include <linux/gpio/consumer.h>
10 #include <linux/regmap.h>
11 #include <linux/regulator/consumer.h>
12 #include <linux/types.h>
13 #include <sound/cs-amp-lib.h>
17 static const struct reg_sequence cs35l56_patch[] = {
19 * Firmware can change these to non-defaults to satisfy SDCA.
20 * Ensure that they are at known defaults.
22 { CS35L56_SWIRE_DP3_CH1_INPUT, 0x00000018 },
23 { CS35L56_SWIRE_DP3_CH2_INPUT, 0x00000019 },
24 { CS35L56_SWIRE_DP3_CH3_INPUT, 0x00000029 },
25 { CS35L56_SWIRE_DP3_CH4_INPUT, 0x00000028 },
27 /* These are not reset by a soft-reset, so patch to defaults. */
28 { CS35L56_MAIN_RENDER_USER_MUTE, 0x00000000 },
29 { CS35L56_MAIN_RENDER_USER_VOLUME, 0x00000000 },
30 { CS35L56_MAIN_POSTURE_NUMBER, 0x00000000 },
33 int cs35l56_set_patch(struct cs35l56_base *cs35l56_base)
35 return regmap_register_patch(cs35l56_base->regmap, cs35l56_patch,
36 ARRAY_SIZE(cs35l56_patch));
38 EXPORT_SYMBOL_NS_GPL(cs35l56_set_patch, SND_SOC_CS35L56_SHARED);
40 static const struct reg_default cs35l56_reg_defaults[] = {
41 /* no defaults for OTP_MEM - first read populates cache */
44 * No defaults for ASP1 control or ASP1TX mixer. See
45 * cs35l56_populate_asp1_register_defaults() and
46 * cs35l56_sync_asp1_mixer_widgets_with_firmware().
49 { CS35L56_SWIRE_DP3_CH1_INPUT, 0x00000018 },
50 { CS35L56_SWIRE_DP3_CH2_INPUT, 0x00000019 },
51 { CS35L56_SWIRE_DP3_CH3_INPUT, 0x00000029 },
52 { CS35L56_SWIRE_DP3_CH4_INPUT, 0x00000028 },
53 { CS35L56_IRQ1_MASK_1, 0x83ffffff },
54 { CS35L56_IRQ1_MASK_2, 0xffff7fff },
55 { CS35L56_IRQ1_MASK_4, 0xe0ffffff },
56 { CS35L56_IRQ1_MASK_8, 0xfc000fff },
57 { CS35L56_IRQ1_MASK_18, 0x1f7df0ff },
58 { CS35L56_IRQ1_MASK_20, 0x15c00000 },
59 { CS35L56_MAIN_RENDER_USER_MUTE, 0x00000000 },
60 { CS35L56_MAIN_RENDER_USER_VOLUME, 0x00000000 },
61 { CS35L56_MAIN_POSTURE_NUMBER, 0x00000000 },
64 static bool cs35l56_is_dsp_memory(unsigned int reg)
67 case CS35L56_DSP1_XMEM_PACKED_0 ... CS35L56_DSP1_XMEM_PACKED_6143:
68 case CS35L56_DSP1_XMEM_UNPACKED32_0 ... CS35L56_DSP1_XMEM_UNPACKED32_4095:
69 case CS35L56_DSP1_XMEM_UNPACKED24_0 ... CS35L56_DSP1_XMEM_UNPACKED24_8191:
70 case CS35L56_DSP1_YMEM_PACKED_0 ... CS35L56_DSP1_YMEM_PACKED_4604:
71 case CS35L56_DSP1_YMEM_UNPACKED32_0 ... CS35L56_DSP1_YMEM_UNPACKED32_3070:
72 case CS35L56_DSP1_YMEM_UNPACKED24_0 ... CS35L56_DSP1_YMEM_UNPACKED24_6141:
73 case CS35L56_DSP1_PMEM_0 ... CS35L56_DSP1_PMEM_5114:
80 static bool cs35l56_readable_reg(struct device *dev, unsigned int reg)
87 case CS35L56_SFT_RESET:
88 case CS35L56_GLOBAL_ENABLES:
89 case CS35L56_BLOCK_ENABLES:
90 case CS35L56_BLOCK_ENABLES2:
91 case CS35L56_REFCLK_INPUT:
92 case CS35L56_GLOBAL_SAMPLE_RATE:
93 case CS35L56_OTP_MEM_53:
94 case CS35L56_OTP_MEM_54:
95 case CS35L56_OTP_MEM_55:
96 case CS35L56_ASP1_ENABLES1:
97 case CS35L56_ASP1_CONTROL1:
98 case CS35L56_ASP1_CONTROL2:
99 case CS35L56_ASP1_CONTROL3:
100 case CS35L56_ASP1_FRAME_CONTROL1:
101 case CS35L56_ASP1_FRAME_CONTROL5:
102 case CS35L56_ASP1_DATA_CONTROL1:
103 case CS35L56_ASP1_DATA_CONTROL5:
104 case CS35L56_DACPCM1_INPUT:
105 case CS35L56_DACPCM2_INPUT:
106 case CS35L56_ASP1TX1_INPUT:
107 case CS35L56_ASP1TX2_INPUT:
108 case CS35L56_ASP1TX3_INPUT:
109 case CS35L56_ASP1TX4_INPUT:
110 case CS35L56_DSP1RX1_INPUT:
111 case CS35L56_DSP1RX2_INPUT:
112 case CS35L56_SWIRE_DP3_CH1_INPUT:
113 case CS35L56_SWIRE_DP3_CH2_INPUT:
114 case CS35L56_SWIRE_DP3_CH3_INPUT:
115 case CS35L56_SWIRE_DP3_CH4_INPUT:
116 case CS35L56_IRQ1_CFG:
117 case CS35L56_IRQ1_STATUS:
118 case CS35L56_IRQ1_EINT_1 ... CS35L56_IRQ1_EINT_8:
119 case CS35L56_IRQ1_EINT_18:
120 case CS35L56_IRQ1_EINT_20:
121 case CS35L56_IRQ1_MASK_1:
122 case CS35L56_IRQ1_MASK_2:
123 case CS35L56_IRQ1_MASK_4:
124 case CS35L56_IRQ1_MASK_8:
125 case CS35L56_IRQ1_MASK_18:
126 case CS35L56_IRQ1_MASK_20:
127 case CS35L56_DSP_VIRTUAL1_MBOX_1:
128 case CS35L56_DSP_VIRTUAL1_MBOX_2:
129 case CS35L56_DSP_VIRTUAL1_MBOX_3:
130 case CS35L56_DSP_VIRTUAL1_MBOX_4:
131 case CS35L56_DSP_VIRTUAL1_MBOX_5:
132 case CS35L56_DSP_VIRTUAL1_MBOX_6:
133 case CS35L56_DSP_VIRTUAL1_MBOX_7:
134 case CS35L56_DSP_VIRTUAL1_MBOX_8:
135 case CS35L56_DSP_RESTRICT_STS1:
136 case CS35L56_DSP1_SYS_INFO_ID ... CS35L56_DSP1_SYS_INFO_END:
137 case CS35L56_DSP1_AHBM_WINDOW_DEBUG_0:
138 case CS35L56_DSP1_AHBM_WINDOW_DEBUG_1:
139 case CS35L56_DSP1_SCRATCH1:
140 case CS35L56_DSP1_SCRATCH2:
141 case CS35L56_DSP1_SCRATCH3:
142 case CS35L56_DSP1_SCRATCH4:
145 return cs35l56_is_dsp_memory(reg);
149 static bool cs35l56_precious_reg(struct device *dev, unsigned int reg)
152 case CS35L56_DSP1_XMEM_PACKED_0 ... CS35L56_DSP1_XMEM_PACKED_6143:
153 case CS35L56_DSP1_YMEM_PACKED_0 ... CS35L56_DSP1_YMEM_PACKED_4604:
154 case CS35L56_DSP1_PMEM_0 ... CS35L56_DSP1_PMEM_5114:
161 static bool cs35l56_volatile_reg(struct device *dev, unsigned int reg)
168 case CS35L56_SFT_RESET:
169 case CS35L56_GLOBAL_ENABLES: /* owned by firmware */
170 case CS35L56_BLOCK_ENABLES: /* owned by firmware */
171 case CS35L56_BLOCK_ENABLES2: /* owned by firmware */
172 case CS35L56_REFCLK_INPUT: /* owned by firmware */
173 case CS35L56_GLOBAL_SAMPLE_RATE: /* owned by firmware */
174 case CS35L56_DACPCM1_INPUT: /* owned by firmware */
175 case CS35L56_DACPCM2_INPUT: /* owned by firmware */
176 case CS35L56_DSP1RX1_INPUT: /* owned by firmware */
177 case CS35L56_DSP1RX2_INPUT: /* owned by firmware */
178 case CS35L56_IRQ1_STATUS:
179 case CS35L56_IRQ1_EINT_1 ... CS35L56_IRQ1_EINT_8:
180 case CS35L56_IRQ1_EINT_18:
181 case CS35L56_IRQ1_EINT_20:
182 case CS35L56_DSP_VIRTUAL1_MBOX_1:
183 case CS35L56_DSP_VIRTUAL1_MBOX_2:
184 case CS35L56_DSP_VIRTUAL1_MBOX_3:
185 case CS35L56_DSP_VIRTUAL1_MBOX_4:
186 case CS35L56_DSP_VIRTUAL1_MBOX_5:
187 case CS35L56_DSP_VIRTUAL1_MBOX_6:
188 case CS35L56_DSP_VIRTUAL1_MBOX_7:
189 case CS35L56_DSP_VIRTUAL1_MBOX_8:
190 case CS35L56_DSP_RESTRICT_STS1:
191 case CS35L56_DSP1_SYS_INFO_ID ... CS35L56_DSP1_SYS_INFO_END:
192 case CS35L56_DSP1_AHBM_WINDOW_DEBUG_0:
193 case CS35L56_DSP1_AHBM_WINDOW_DEBUG_1:
194 case CS35L56_DSP1_SCRATCH1:
195 case CS35L56_DSP1_SCRATCH2:
196 case CS35L56_DSP1_SCRATCH3:
197 case CS35L56_DSP1_SCRATCH4:
199 case CS35L56_MAIN_RENDER_USER_MUTE:
200 case CS35L56_MAIN_RENDER_USER_VOLUME:
201 case CS35L56_MAIN_POSTURE_NUMBER:
204 return cs35l56_is_dsp_memory(reg);
208 static const struct reg_sequence cs35l56_asp1_defaults[] = {
209 REG_SEQ0(CS35L56_ASP1_ENABLES1, 0x00000000),
210 REG_SEQ0(CS35L56_ASP1_CONTROL1, 0x00000028),
211 REG_SEQ0(CS35L56_ASP1_CONTROL2, 0x18180200),
212 REG_SEQ0(CS35L56_ASP1_CONTROL3, 0x00000002),
213 REG_SEQ0(CS35L56_ASP1_FRAME_CONTROL1, 0x03020100),
214 REG_SEQ0(CS35L56_ASP1_FRAME_CONTROL5, 0x00020100),
215 REG_SEQ0(CS35L56_ASP1_DATA_CONTROL1, 0x00000018),
216 REG_SEQ0(CS35L56_ASP1_DATA_CONTROL5, 0x00000018),
220 * The firmware can have control of the ASP so we don't provide regmap
221 * with defaults for these registers, to prevent a regcache_sync() from
222 * overwriting the firmware settings. But if the machine driver hooks up
223 * the ASP it means the driver is taking control of the ASP, so then the
224 * registers are populated with the defaults.
226 int cs35l56_init_asp1_regs_for_driver_control(struct cs35l56_base *cs35l56_base)
228 if (!cs35l56_base->fw_owns_asp1)
231 cs35l56_base->fw_owns_asp1 = false;
233 return regmap_multi_reg_write(cs35l56_base->regmap, cs35l56_asp1_defaults,
234 ARRAY_SIZE(cs35l56_asp1_defaults));
236 EXPORT_SYMBOL_NS_GPL(cs35l56_init_asp1_regs_for_driver_control, SND_SOC_CS35L56_SHARED);
239 * The firmware boot sequence can overwrite the ASP1 config registers so that
240 * they don't match regmap's view of their values. Rewrite the values from the
241 * regmap cache into the hardware registers.
243 int cs35l56_force_sync_asp1_registers_from_cache(struct cs35l56_base *cs35l56_base)
245 struct reg_sequence asp1_regs[ARRAY_SIZE(cs35l56_asp1_defaults)];
248 if (cs35l56_base->fw_owns_asp1)
251 memcpy(asp1_regs, cs35l56_asp1_defaults, sizeof(asp1_regs));
253 /* Read current values from regmap cache into the write sequence */
254 for (i = 0; i < ARRAY_SIZE(asp1_regs); ++i) {
255 ret = regmap_read(cs35l56_base->regmap, asp1_regs[i].reg, &asp1_regs[i].def);
260 /* Write the values cache-bypassed so that they will be written to silicon */
261 ret = regmap_multi_reg_write_bypassed(cs35l56_base->regmap, asp1_regs,
262 ARRAY_SIZE(asp1_regs));
269 dev_err(cs35l56_base->dev, "Failed to sync ASP1 registers: %d\n", ret);
273 EXPORT_SYMBOL_NS_GPL(cs35l56_force_sync_asp1_registers_from_cache, SND_SOC_CS35L56_SHARED);
275 int cs35l56_mbox_send(struct cs35l56_base *cs35l56_base, unsigned int command)
280 regmap_write(cs35l56_base->regmap, CS35L56_DSP_VIRTUAL1_MBOX_1, command);
281 ret = regmap_read_poll_timeout(cs35l56_base->regmap, CS35L56_DSP_VIRTUAL1_MBOX_1,
283 CS35L56_MBOX_POLL_US, CS35L56_MBOX_TIMEOUT_US);
285 dev_warn(cs35l56_base->dev, "MBOX command %#x failed: %d\n", command, ret);
291 EXPORT_SYMBOL_NS_GPL(cs35l56_mbox_send, SND_SOC_CS35L56_SHARED);
293 int cs35l56_firmware_shutdown(struct cs35l56_base *cs35l56_base)
299 ret = cs35l56_mbox_send(cs35l56_base, CS35L56_MBOX_CMD_SHUTDOWN);
303 if (cs35l56_base->rev < CS35L56_REVID_B0)
304 reg = CS35L56_DSP1_PM_CUR_STATE_A1;
306 reg = CS35L56_DSP1_PM_CUR_STATE;
308 ret = regmap_read_poll_timeout(cs35l56_base->regmap, reg,
309 val, (val == CS35L56_HALO_STATE_SHUTDOWN),
310 CS35L56_HALO_STATE_POLL_US,
311 CS35L56_HALO_STATE_TIMEOUT_US);
313 dev_err(cs35l56_base->dev, "Failed to poll PM_CUR_STATE to 1 is %d (ret %d)\n",
317 EXPORT_SYMBOL_NS_GPL(cs35l56_firmware_shutdown, SND_SOC_CS35L56_SHARED);
319 int cs35l56_wait_for_firmware_boot(struct cs35l56_base *cs35l56_base)
322 unsigned int val = 0;
323 int read_ret, poll_ret;
325 if (cs35l56_base->rev < CS35L56_REVID_B0)
326 reg = CS35L56_DSP1_HALO_STATE_A1;
328 reg = CS35L56_DSP1_HALO_STATE;
331 * The regmap must remain in cache-only until the chip has
332 * booted, so use a bypassed read of the status register.
334 poll_ret = read_poll_timeout(regmap_read_bypassed, read_ret,
335 (val < 0xFFFF) && (val >= CS35L56_HALO_STATE_BOOT_DONE),
336 CS35L56_HALO_STATE_POLL_US,
337 CS35L56_HALO_STATE_TIMEOUT_US,
339 cs35l56_base->regmap, reg, &val);
342 dev_err(cs35l56_base->dev, "Firmware boot timed out(%d): HALO_STATE=%#x\n",
349 EXPORT_SYMBOL_NS_GPL(cs35l56_wait_for_firmware_boot, SND_SOC_CS35L56_SHARED);
351 void cs35l56_wait_control_port_ready(void)
353 /* Wait for control port to be ready (datasheet tIRS). */
354 usleep_range(CS35L56_CONTROL_PORT_READY_US, 2 * CS35L56_CONTROL_PORT_READY_US);
356 EXPORT_SYMBOL_NS_GPL(cs35l56_wait_control_port_ready, SND_SOC_CS35L56_SHARED);
358 void cs35l56_wait_min_reset_pulse(void)
360 /* Satisfy minimum reset pulse width spec */
361 usleep_range(CS35L56_RESET_PULSE_MIN_US, 2 * CS35L56_RESET_PULSE_MIN_US);
363 EXPORT_SYMBOL_NS_GPL(cs35l56_wait_min_reset_pulse, SND_SOC_CS35L56_SHARED);
365 static const struct reg_sequence cs35l56_system_reset_seq[] = {
366 REG_SEQ0(CS35L56_DSP1_HALO_STATE, 0),
367 REG_SEQ0(CS35L56_DSP_VIRTUAL1_MBOX_1, CS35L56_MBOX_CMD_SYSTEM_RESET),
370 void cs35l56_system_reset(struct cs35l56_base *cs35l56_base, bool is_soundwire)
373 * Must enter cache-only first so there can't be any more register
374 * accesses other than the controlled system reset sequence below.
376 regcache_cache_only(cs35l56_base->regmap, true);
377 regmap_multi_reg_write_bypassed(cs35l56_base->regmap,
378 cs35l56_system_reset_seq,
379 ARRAY_SIZE(cs35l56_system_reset_seq));
381 /* On SoundWire the registers won't be accessible until it re-enumerates. */
385 cs35l56_wait_control_port_ready();
387 /* Leave in cache-only. This will be revoked when the chip has rebooted. */
389 EXPORT_SYMBOL_NS_GPL(cs35l56_system_reset, SND_SOC_CS35L56_SHARED);
391 int cs35l56_irq_request(struct cs35l56_base *cs35l56_base, int irq)
398 ret = devm_request_threaded_irq(cs35l56_base->dev, irq, NULL, cs35l56_irq,
399 IRQF_ONESHOT | IRQF_SHARED | IRQF_TRIGGER_LOW,
400 "cs35l56", cs35l56_base);
402 cs35l56_base->irq = irq;
404 dev_err(cs35l56_base->dev, "Failed to get IRQ: %d\n", ret);
408 EXPORT_SYMBOL_NS_GPL(cs35l56_irq_request, SND_SOC_CS35L56_SHARED);
410 irqreturn_t cs35l56_irq(int irq, void *data)
412 struct cs35l56_base *cs35l56_base = data;
413 unsigned int status1 = 0, status8 = 0, status20 = 0;
414 unsigned int mask1, mask8, mask20;
418 irqreturn_t ret = IRQ_NONE;
420 if (!cs35l56_base->init_done)
423 mutex_lock(&cs35l56_base->irq_lock);
425 rv = pm_runtime_resume_and_get(cs35l56_base->dev);
427 dev_err(cs35l56_base->dev, "irq: failed to get pm_runtime: %d\n", rv);
431 regmap_read(cs35l56_base->regmap, CS35L56_IRQ1_STATUS, &val);
432 if ((val & CS35L56_IRQ1_STS_MASK) == 0) {
433 dev_dbg(cs35l56_base->dev, "Spurious IRQ: no pending interrupt\n");
438 regmap_read(cs35l56_base->regmap, CS35L56_IRQ1_EINT_1, &status1);
439 regmap_read(cs35l56_base->regmap, CS35L56_IRQ1_MASK_1, &mask1);
441 regmap_write(cs35l56_base->regmap, CS35L56_IRQ1_EINT_1, status1);
443 regmap_read(cs35l56_base->regmap, CS35L56_IRQ1_EINT_8, &status8);
444 regmap_read(cs35l56_base->regmap, CS35L56_IRQ1_MASK_8, &mask8);
446 regmap_write(cs35l56_base->regmap, CS35L56_IRQ1_EINT_8, status8);
448 regmap_read(cs35l56_base->regmap, CS35L56_IRQ1_EINT_20, &status20);
449 regmap_read(cs35l56_base->regmap, CS35L56_IRQ1_MASK_20, &mask20);
451 /* We don't want EINT20 but they default to unmasked: force mask */
452 regmap_write(cs35l56_base->regmap, CS35L56_IRQ1_MASK_20, 0xffffffff);
454 dev_dbg(cs35l56_base->dev, "%s: %#x %#x\n", __func__, status1, status8);
456 /* Check to see if unmasked bits are active */
457 if (!status1 && !status8 && !status20)
460 if (status1 & CS35L56_AMP_SHORT_ERR_EINT1_MASK)
461 dev_crit(cs35l56_base->dev, "Amp short error\n");
463 if (status8 & CS35L56_TEMP_ERR_EINT1_MASK)
464 dev_crit(cs35l56_base->dev, "Overtemp error\n");
469 pm_runtime_put(cs35l56_base->dev);
471 mutex_unlock(&cs35l56_base->irq_lock);
475 EXPORT_SYMBOL_NS_GPL(cs35l56_irq, SND_SOC_CS35L56_SHARED);
477 int cs35l56_is_fw_reload_needed(struct cs35l56_base *cs35l56_base)
483 * In secure mode FIRMWARE_MISSING is cleared by the BIOS loader so
484 * can't be used here to test for memory retention.
485 * Assume that tuning must be re-loaded.
487 if (cs35l56_base->secured)
490 ret = pm_runtime_resume_and_get(cs35l56_base->dev);
492 dev_err(cs35l56_base->dev, "Failed to runtime_get: %d\n", ret);
496 ret = regmap_read(cs35l56_base->regmap, CS35L56_PROTECTION_STATUS, &val);
498 dev_err(cs35l56_base->dev, "Failed to read PROTECTION_STATUS: %d\n", ret);
500 ret = !!(val & CS35L56_FIRMWARE_MISSING);
502 pm_runtime_put_autosuspend(cs35l56_base->dev);
506 EXPORT_SYMBOL_NS_GPL(cs35l56_is_fw_reload_needed, SND_SOC_CS35L56_SHARED);
508 static const struct reg_sequence cs35l56_hibernate_seq[] = {
509 /* This must be the last register access */
510 REG_SEQ0(CS35L56_DSP_VIRTUAL1_MBOX_1, CS35L56_MBOX_CMD_ALLOW_AUTO_HIBERNATE),
513 static const struct reg_sequence cs35l56_hibernate_wake_seq[] = {
514 REG_SEQ0(CS35L56_DSP_VIRTUAL1_MBOX_1, CS35L56_MBOX_CMD_WAKEUP),
517 static void cs35l56_issue_wake_event(struct cs35l56_base *cs35l56_base)
520 * Dummy transactions to trigger I2C/SPI auto-wake. Issue two
521 * transactions to meet the minimum required time from the rising edge
522 * to the last falling edge of wake.
524 * It uses bypassed write because we must wake the chip before
525 * disabling regmap cache-only.
527 * This can NAK on I2C which will terminate the write sequence so the
528 * single-write sequence is issued twice.
530 regmap_multi_reg_write_bypassed(cs35l56_base->regmap,
531 cs35l56_hibernate_wake_seq,
532 ARRAY_SIZE(cs35l56_hibernate_wake_seq));
534 usleep_range(CS35L56_WAKE_HOLD_TIME_US, 2 * CS35L56_WAKE_HOLD_TIME_US);
536 regmap_multi_reg_write_bypassed(cs35l56_base->regmap,
537 cs35l56_hibernate_wake_seq,
538 ARRAY_SIZE(cs35l56_hibernate_wake_seq));
540 cs35l56_wait_control_port_ready();
543 int cs35l56_runtime_suspend_common(struct cs35l56_base *cs35l56_base)
548 if (!cs35l56_base->init_done)
551 /* Firmware must have entered a power-save state */
552 ret = regmap_read_poll_timeout(cs35l56_base->regmap,
553 CS35L56_TRANSDUCER_ACTUAL_PS,
554 val, (val >= CS35L56_PS3),
556 CS35L56_PS3_TIMEOUT_US);
558 dev_warn(cs35l56_base->dev, "PS3 wait failed: %d\n", ret);
560 /* Clear BOOT_DONE so it can be used to detect a reboot */
561 regmap_write(cs35l56_base->regmap, CS35L56_IRQ1_EINT_4, CS35L56_OTP_BOOT_DONE_MASK);
563 if (!cs35l56_base->can_hibernate) {
564 regcache_cache_only(cs35l56_base->regmap, true);
565 dev_dbg(cs35l56_base->dev, "Suspended: no hibernate");
571 * Must enter cache-only first so there can't be any more register
572 * accesses other than the controlled hibernate sequence below.
574 regcache_cache_only(cs35l56_base->regmap, true);
576 regmap_multi_reg_write_bypassed(cs35l56_base->regmap,
577 cs35l56_hibernate_seq,
578 ARRAY_SIZE(cs35l56_hibernate_seq));
580 dev_dbg(cs35l56_base->dev, "Suspended: hibernate");
584 EXPORT_SYMBOL_NS_GPL(cs35l56_runtime_suspend_common, SND_SOC_CS35L56_SHARED);
586 int cs35l56_runtime_resume_common(struct cs35l56_base *cs35l56_base, bool is_soundwire)
591 if (!cs35l56_base->init_done)
594 if (!cs35l56_base->can_hibernate)
597 /* Must be done before releasing cache-only */
599 cs35l56_issue_wake_event(cs35l56_base);
602 ret = cs35l56_wait_for_firmware_boot(cs35l56_base);
604 dev_err(cs35l56_base->dev, "Hibernate wake failed: %d\n", ret);
608 regcache_cache_only(cs35l56_base->regmap, false);
610 ret = cs35l56_mbox_send(cs35l56_base, CS35L56_MBOX_CMD_PREVENT_AUTO_HIBERNATE);
614 /* BOOT_DONE will be 1 if the amp reset */
615 regmap_read(cs35l56_base->regmap, CS35L56_IRQ1_EINT_4, &val);
616 if (val & CS35L56_OTP_BOOT_DONE_MASK) {
617 dev_dbg(cs35l56_base->dev, "Registers reset in suspend\n");
618 regcache_mark_dirty(cs35l56_base->regmap);
621 regcache_sync(cs35l56_base->regmap);
623 dev_dbg(cs35l56_base->dev, "Resumed");
628 regcache_cache_only(cs35l56_base->regmap, true);
630 regmap_multi_reg_write_bypassed(cs35l56_base->regmap,
631 cs35l56_hibernate_seq,
632 ARRAY_SIZE(cs35l56_hibernate_seq));
636 EXPORT_SYMBOL_NS_GPL(cs35l56_runtime_resume_common, SND_SOC_CS35L56_SHARED);
638 static const struct cs_dsp_region cs35l56_dsp1_regions[] = {
639 { .type = WMFW_HALO_PM_PACKED, .base = CS35L56_DSP1_PMEM_0 },
640 { .type = WMFW_HALO_XM_PACKED, .base = CS35L56_DSP1_XMEM_PACKED_0 },
641 { .type = WMFW_HALO_YM_PACKED, .base = CS35L56_DSP1_YMEM_PACKED_0 },
642 { .type = WMFW_ADSP2_XM, .base = CS35L56_DSP1_XMEM_UNPACKED24_0 },
643 { .type = WMFW_ADSP2_YM, .base = CS35L56_DSP1_YMEM_UNPACKED24_0 },
646 void cs35l56_init_cs_dsp(struct cs35l56_base *cs35l56_base, struct cs_dsp *cs_dsp)
649 cs_dsp->type = WMFW_HALO;
651 cs_dsp->dev = cs35l56_base->dev;
652 cs_dsp->regmap = cs35l56_base->regmap;
653 cs_dsp->base = CS35L56_DSP1_CORE_BASE;
654 cs_dsp->base_sysinfo = CS35L56_DSP1_SYS_INFO_ID;
655 cs_dsp->mem = cs35l56_dsp1_regions;
656 cs_dsp->num_mems = ARRAY_SIZE(cs35l56_dsp1_regions);
657 cs_dsp->no_core_startstop = true;
659 EXPORT_SYMBOL_NS_GPL(cs35l56_init_cs_dsp, SND_SOC_CS35L56_SHARED);
670 static_assert((sizeof(struct cs35l56_pte) % sizeof(u32)) == 0);
672 static int cs35l56_read_silicon_uid(struct cs35l56_base *cs35l56_base, u64 *uid)
674 struct cs35l56_pte pte;
678 ret = regmap_raw_read(cs35l56_base->regmap, CS35L56_OTP_MEM_53, &pte, sizeof(pte));
680 dev_err(cs35l56_base->dev, "Failed to read OTP: %d\n", ret);
684 unique_id = (u32)pte.lot[2] | ((u32)pte.lot[1] << 8) | ((u32)pte.lot[0] << 16);
686 unique_id |= (u32)pte.x | ((u32)pte.y << 8) | ((u32)pte.wafer_id << 16) |
687 ((u32)pte.dvs << 24);
689 dev_dbg(cs35l56_base->dev, "UniqueID = %#llx\n", unique_id);
696 /* Firmware calibration controls */
697 const struct cirrus_amp_cal_controls cs35l56_calibration_controls = {
699 .mem_region = WMFW_ADSP2_YM,
700 .ambient = "CAL_AMBIENT",
702 .status = "CAL_STATUS",
703 .checksum = "CAL_CHECKSUM",
705 EXPORT_SYMBOL_NS_GPL(cs35l56_calibration_controls, SND_SOC_CS35L56_SHARED);
707 int cs35l56_get_calibration(struct cs35l56_base *cs35l56_base)
712 /* Driver can't apply calibration to a secured part, so skip */
713 if (cs35l56_base->secured)
716 ret = cs35l56_read_silicon_uid(cs35l56_base, &silicon_uid);
720 ret = cs_amp_get_efi_calibration_data(cs35l56_base->dev, silicon_uid,
721 cs35l56_base->cal_index,
722 &cs35l56_base->cal_data);
724 /* Only return an error status if probe should be aborted */
725 if ((ret == -ENOENT) || (ret == -EOVERFLOW))
731 cs35l56_base->cal_data_valid = true;
735 EXPORT_SYMBOL_NS_GPL(cs35l56_get_calibration, SND_SOC_CS35L56_SHARED);
737 int cs35l56_read_prot_status(struct cs35l56_base *cs35l56_base,
738 bool *fw_missing, unsigned int *fw_version)
740 unsigned int prot_status;
743 ret = regmap_read(cs35l56_base->regmap, CS35L56_PROTECTION_STATUS, &prot_status);
745 dev_err(cs35l56_base->dev, "Get PROTECTION_STATUS failed: %d\n", ret);
749 *fw_missing = !!(prot_status & CS35L56_FIRMWARE_MISSING);
751 ret = regmap_read(cs35l56_base->regmap, CS35L56_DSP1_FW_VER, fw_version);
753 dev_err(cs35l56_base->dev, "Get FW VER failed: %d\n", ret);
759 EXPORT_SYMBOL_NS_GPL(cs35l56_read_prot_status, SND_SOC_CS35L56_SHARED);
761 int cs35l56_hw_init(struct cs35l56_base *cs35l56_base)
764 unsigned int devid, revid, otpid, secured, fw_ver;
768 * When the system is not using a reset_gpio ensure the device is
769 * awake, otherwise the device has just been released from reset and
770 * the driver must wait for the control port to become usable.
772 if (!cs35l56_base->reset_gpio)
773 cs35l56_issue_wake_event(cs35l56_base);
775 cs35l56_wait_control_port_ready();
778 * The HALO_STATE register is in different locations on Ax and B0
779 * devices so the REVID needs to be determined before waiting for the
782 ret = regmap_read_bypassed(cs35l56_base->regmap, CS35L56_REVID, &revid);
784 dev_err(cs35l56_base->dev, "Get Revision ID failed\n");
787 cs35l56_base->rev = revid & (CS35L56_AREVID_MASK | CS35L56_MTLREVID_MASK);
789 ret = cs35l56_wait_for_firmware_boot(cs35l56_base);
793 ret = regmap_read_bypassed(cs35l56_base->regmap, CS35L56_DEVID, &devid);
795 dev_err(cs35l56_base->dev, "Get Device ID failed\n");
798 devid &= CS35L56_DEVID_MASK;
806 dev_err(cs35l56_base->dev, "Unknown device %x\n", devid);
810 cs35l56_base->type = devid & 0xFF;
812 /* Silicon is now identified and booted so exit cache-only */
813 regcache_cache_only(cs35l56_base->regmap, false);
815 ret = regmap_read(cs35l56_base->regmap, CS35L56_DSP_RESTRICT_STS1, &secured);
817 dev_err(cs35l56_base->dev, "Get Secure status failed\n");
821 /* When any bus is restricted treat the device as secured */
822 if (secured & CS35L56_RESTRICTED_MASK)
823 cs35l56_base->secured = true;
825 ret = regmap_read(cs35l56_base->regmap, CS35L56_OTPID, &otpid);
827 dev_err(cs35l56_base->dev, "Get OTP ID failed\n");
831 ret = cs35l56_read_prot_status(cs35l56_base, &fw_missing, &fw_ver);
835 dev_info(cs35l56_base->dev, "Cirrus Logic CS35L%02X%s Rev %02X OTP%d fw:%d.%d.%d (patched=%u)\n",
836 cs35l56_base->type, cs35l56_base->secured ? "s" : "", cs35l56_base->rev, otpid,
837 fw_ver >> 16, (fw_ver >> 8) & 0xff, fw_ver & 0xff, !fw_missing);
839 /* Wake source and *_BLOCKED interrupts default to unmasked, so mask them */
840 regmap_write(cs35l56_base->regmap, CS35L56_IRQ1_MASK_20, 0xffffffff);
841 regmap_update_bits(cs35l56_base->regmap, CS35L56_IRQ1_MASK_1,
842 CS35L56_AMP_SHORT_ERR_EINT1_MASK,
844 regmap_update_bits(cs35l56_base->regmap, CS35L56_IRQ1_MASK_8,
845 CS35L56_TEMP_ERR_EINT1_MASK,
850 EXPORT_SYMBOL_NS_GPL(cs35l56_hw_init, SND_SOC_CS35L56_SHARED);
852 int cs35l56_get_speaker_id(struct cs35l56_base *cs35l56_base)
854 struct gpio_descs *descs;
858 /* Read the speaker type qualifier from the motherboard GPIOs */
859 descs = gpiod_get_array_optional(cs35l56_base->dev, "spk-id", GPIOD_IN);
862 } else if (IS_ERR(descs)) {
863 ret = PTR_ERR(descs);
864 return dev_err_probe(cs35l56_base->dev, ret, "Failed to get spk-id-gpios\n");
868 for (i = 0; i < descs->ndescs; i++) {
869 ret = gpiod_get_value_cansleep(descs->desc[i]);
871 dev_err_probe(cs35l56_base->dev, ret, "Failed to read spk-id[%d]\n", i);
875 speaker_id |= (ret << i);
878 dev_dbg(cs35l56_base->dev, "Speaker ID = %d\n", speaker_id);
881 gpiod_put_array(descs);
885 EXPORT_SYMBOL_NS_GPL(cs35l56_get_speaker_id, SND_SOC_CS35L56_SHARED);
887 static const u32 cs35l56_bclk_valid_for_pll_freq_table[] = {
919 int cs35l56_get_bclk_freq_id(unsigned int freq)
926 /* The BCLK frequency must be a valid PLL REFCLK */
927 for (i = 0; i < ARRAY_SIZE(cs35l56_bclk_valid_for_pll_freq_table); ++i) {
928 if (cs35l56_bclk_valid_for_pll_freq_table[i] == freq)
934 EXPORT_SYMBOL_NS_GPL(cs35l56_get_bclk_freq_id, SND_SOC_CS35L56_SHARED);
936 static const char * const cs35l56_supplies[/* auto-sized */] = {
942 void cs35l56_fill_supply_names(struct regulator_bulk_data *data)
946 BUILD_BUG_ON(ARRAY_SIZE(cs35l56_supplies) != CS35L56_NUM_BULK_SUPPLIES);
947 for (i = 0; i < ARRAY_SIZE(cs35l56_supplies); i++)
948 data[i].supply = cs35l56_supplies[i];
950 EXPORT_SYMBOL_NS_GPL(cs35l56_fill_supply_names, SND_SOC_CS35L56_SHARED);
952 const char * const cs35l56_tx_input_texts[] = {
953 "None", "ASP1RX1", "ASP1RX2", "VMON", "IMON", "ERRVOL", "CLASSH",
954 "VDDBMON", "VBSTMON", "DSP1TX1", "DSP1TX2", "DSP1TX3", "DSP1TX4",
955 "DSP1TX5", "DSP1TX6", "DSP1TX7", "DSP1TX8", "TEMPMON",
956 "INTERPOLATOR", "SDW1RX1", "SDW1RX2",
958 EXPORT_SYMBOL_NS_GPL(cs35l56_tx_input_texts, SND_SOC_CS35L56_SHARED);
960 const unsigned int cs35l56_tx_input_values[] = {
961 CS35L56_INPUT_SRC_NONE,
962 CS35L56_INPUT_SRC_ASP1RX1,
963 CS35L56_INPUT_SRC_ASP1RX2,
964 CS35L56_INPUT_SRC_VMON,
965 CS35L56_INPUT_SRC_IMON,
966 CS35L56_INPUT_SRC_ERR_VOL,
967 CS35L56_INPUT_SRC_CLASSH,
968 CS35L56_INPUT_SRC_VDDBMON,
969 CS35L56_INPUT_SRC_VBSTMON,
970 CS35L56_INPUT_SRC_DSP1TX1,
971 CS35L56_INPUT_SRC_DSP1TX2,
972 CS35L56_INPUT_SRC_DSP1TX3,
973 CS35L56_INPUT_SRC_DSP1TX4,
974 CS35L56_INPUT_SRC_DSP1TX5,
975 CS35L56_INPUT_SRC_DSP1TX6,
976 CS35L56_INPUT_SRC_DSP1TX7,
977 CS35L56_INPUT_SRC_DSP1TX8,
978 CS35L56_INPUT_SRC_TEMPMON,
979 CS35L56_INPUT_SRC_INTERPOLATOR,
980 CS35L56_INPUT_SRC_SWIRE_DP1_CHANNEL1,
981 CS35L56_INPUT_SRC_SWIRE_DP1_CHANNEL2,
983 EXPORT_SYMBOL_NS_GPL(cs35l56_tx_input_values, SND_SOC_CS35L56_SHARED);
985 struct regmap_config cs35l56_regmap_i2c = {
989 .reg_format_endian = REGMAP_ENDIAN_BIG,
990 .val_format_endian = REGMAP_ENDIAN_BIG,
991 .max_register = CS35L56_DSP1_PMEM_5114,
992 .reg_defaults = cs35l56_reg_defaults,
993 .num_reg_defaults = ARRAY_SIZE(cs35l56_reg_defaults),
994 .volatile_reg = cs35l56_volatile_reg,
995 .readable_reg = cs35l56_readable_reg,
996 .precious_reg = cs35l56_precious_reg,
997 .cache_type = REGCACHE_MAPLE,
999 EXPORT_SYMBOL_NS_GPL(cs35l56_regmap_i2c, SND_SOC_CS35L56_SHARED);
1001 struct regmap_config cs35l56_regmap_spi = {
1006 .reg_format_endian = REGMAP_ENDIAN_BIG,
1007 .val_format_endian = REGMAP_ENDIAN_BIG,
1008 .max_register = CS35L56_DSP1_PMEM_5114,
1009 .reg_defaults = cs35l56_reg_defaults,
1010 .num_reg_defaults = ARRAY_SIZE(cs35l56_reg_defaults),
1011 .volatile_reg = cs35l56_volatile_reg,
1012 .readable_reg = cs35l56_readable_reg,
1013 .precious_reg = cs35l56_precious_reg,
1014 .cache_type = REGCACHE_MAPLE,
1016 EXPORT_SYMBOL_NS_GPL(cs35l56_regmap_spi, SND_SOC_CS35L56_SHARED);
1018 struct regmap_config cs35l56_regmap_sdw = {
1022 .reg_format_endian = REGMAP_ENDIAN_LITTLE,
1023 .val_format_endian = REGMAP_ENDIAN_BIG,
1024 .max_register = CS35L56_DSP1_PMEM_5114,
1025 .reg_defaults = cs35l56_reg_defaults,
1026 .num_reg_defaults = ARRAY_SIZE(cs35l56_reg_defaults),
1027 .volatile_reg = cs35l56_volatile_reg,
1028 .readable_reg = cs35l56_readable_reg,
1029 .precious_reg = cs35l56_precious_reg,
1030 .cache_type = REGCACHE_MAPLE,
1032 EXPORT_SYMBOL_NS_GPL(cs35l56_regmap_sdw, SND_SOC_CS35L56_SHARED);
1034 MODULE_DESCRIPTION("ASoC CS35L56 Shared");
1035 MODULE_AUTHOR("Richard Fitzgerald <rf@opensource.cirrus.com>");
1036 MODULE_AUTHOR("Simon Trimmer <simont@opensource.cirrus.com>");
1037 MODULE_LICENSE("GPL");
1038 MODULE_IMPORT_NS(SND_SOC_CS_AMP_LIB);