Skip to content

Commit 1d78e19

Browse files
brooniebroonie
committed
ASoC: Initial support for Cirrus Logic CS35L56
Merge series from Richard Fitzgerald <rf@opensource.cirrus.com>: The CS35L56 is a high-performance boosted mono audio amplifier. Supported control interfaces are I2C, SPI or SoundWire. Supported audio interfaces are I2S/TDM or SoundWire. The CS35L56 has a self-booting firmware in ROM, with the ability to patch the firmware and/or apply tunings. Patches #1 to thesofproject#7 add support to cs_dsp and wm_adsp for self-booting firmware and the ability to apply a .bin file without having to apply a .wmfw.
2 parents 4af574f + e496112 commit 1d78e19

File tree

14 files changed

+3005
-16
lines changed

14 files changed

+3005
-16
lines changed

‎MAINTAINERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4905,6 +4905,7 @@ L: patches@opensource.cirrus.com
49054905
S: Maintained
49064906
F: Documentation/devicetree/bindings/sound/cirrus,cs*
49074907
F: include/dt-bindings/sound/cs*
4908+
F: include/sound/cs*
49084909
F: sound/pci/hda/cs*
49094910
F: sound/pci/hda/hda_cs_dsp_ctl.*
49104911
F: sound/soc/codecs/cs*

‎drivers/firmware/cirrus/cs_dsp.c‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,7 @@ struct cs_dsp_ops {
301301
static const struct cs_dsp_ops cs_dsp_adsp1_ops;
302302
static const struct cs_dsp_ops cs_dsp_adsp2_ops[];
303303
static const struct cs_dsp_ops cs_dsp_halo_ops;
304+
static const struct cs_dsp_ops cs_dsp_halo_ao_ops;
304305

305306
struct cs_dsp_buf {
306307
struct list_head list;
@@ -1300,6 +1301,9 @@ static int cs_dsp_load(struct cs_dsp *dsp, const struct firmware *firmware,
13001301
int regions = 0;
13011302
int ret, offset, type;
13021303

1304+
if (!firmware)
1305+
return 0;
1306+
13031307
ret = -EINVAL;
13041308

13051309
pos = sizeof(*header) + sizeof(*adsp1_sizes) + sizeof(*footer);
@@ -2821,7 +2825,10 @@ EXPORT_SYMBOL_NS_GPL(cs_dsp_adsp2_init, FW_CS_DSP);
28212825
*/
28222826
int cs_dsp_halo_init(struct cs_dsp *dsp)
28232827
{
2824-
dsp->ops = &cs_dsp_halo_ops;
2828+
if (dsp->no_core_startstop)
2829+
dsp->ops = &cs_dsp_halo_ao_ops;
2830+
else
2831+
dsp->ops = &cs_dsp_halo_ops;
28252832

28262833
return cs_dsp_common_init(dsp);
28272834
}
@@ -3187,6 +3194,14 @@ static const struct cs_dsp_ops cs_dsp_halo_ops = {
31873194
.stop_core = cs_dsp_halo_stop_core,
31883195
};
31893196

3197+
static const struct cs_dsp_ops cs_dsp_halo_ao_ops = {
3198+
.parse_sizes = cs_dsp_adsp2_parse_sizes,
3199+
.validate_version = cs_dsp_halo_validate_version,
3200+
.setup_algs = cs_dsp_halo_setup_algs,
3201+
.region_to_reg = cs_dsp_halo_region_to_reg,
3202+
.show_fw_status = cs_dsp_halo_show_fw_status,
3203+
};
3204+
31903205
/**
31913206
* cs_dsp_chunk_write() - Format data to a DSP memory chunk
31923207
* @ch: Pointer to the chunk structure

‎include/linux/firmware/cirrus/cs_dsp.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ struct cs_dsp {
156156
unsigned int sysclk_reg;
157157
unsigned int sysclk_mask;
158158
unsigned int sysclk_shift;
159+
bool no_core_startstop;
159160

160161
struct list_head alg_regions;
161162

‎include/sound/cs35l56.h‎

Lines changed: 266 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,266 @@
1+
/* SPDX-License-Identifier: GPL-2.0-only */
2+
/*
3+
* Common definitions for Cirrus Logic CS35L56 smart amp
4+
*
5+
* Copyright (C) 2023 Cirrus Logic, Inc. and
6+
* Cirrus Logic International Semiconductor Ltd.
7+
*/
8+
9+
#ifndef __CS35L56_H
10+
#define __CS35L56_H
11+
12+
#include <linux/firmware/cirrus/cs_dsp.h>
13+
#include <linux/regulator/consumer.h>
14+
#include <linux/regmap.h>
15+
16+
#define CS35L56_DEVID 0x0000000
17+
#define CS35L56_REVID 0x0000004
18+
#define CS35L56_RELID 0x000000C
19+
#define CS35L56_OTPID 0x0000010
20+
#define CS35L56_SFT_RESET 0x0000020
21+
#define CS35L56_GLOBAL_ENABLES 0x0002014
22+
#define CS35L56_BLOCK_ENABLES 0x0002018
23+
#define CS35L56_BLOCK_ENABLES2 0x000201C
24+
#define CS35L56_REFCLK_INPUT 0x0002C04
25+
#define CS35L56_GLOBAL_SAMPLE_RATE 0x0002C0C
26+
#define CS35L56_ASP1_ENABLES1 0x0004800
27+
#define CS35L56_ASP1_CONTROL1 0x0004804
28+
#define CS35L56_ASP1_CONTROL2 0x0004808
29+
#define CS35L56_ASP1_CONTROL3 0x000480C
30+
#define CS35L56_ASP1_FRAME_CONTROL1 0x0004810
31+
#define CS35L56_ASP1_FRAME_CONTROL5 0x0004820
32+
#define CS35L56_ASP1_DATA_CONTROL1 0x0004830
33+
#define CS35L56_ASP1_DATA_CONTROL5 0x0004840
34+
#define CS35L56_DACPCM1_INPUT 0x0004C00
35+
#define CS35L56_DACPCM2_INPUT 0x0004C08
36+
#define CS35L56_ASP1TX1_INPUT 0x0004C20
37+
#define CS35L56_ASP1TX2_INPUT 0x0004C24
38+
#define CS35L56_ASP1TX3_INPUT 0x0004C28
39+
#define CS35L56_ASP1TX4_INPUT 0x0004C2C
40+
#define CS35L56_DSP1RX1_INPUT 0x0004C40
41+
#define CS35L56_DSP1RX2_INPUT 0x0004C44
42+
#define CS35L56_SWIRE_DP3_CH1_INPUT 0x0004C70
43+
#define CS35L56_SWIRE_DP3_CH2_INPUT 0x0004C74
44+
#define CS35L56_SWIRE_DP3_CH3_INPUT 0x0004C78
45+
#define CS35L56_SWIRE_DP3_CH4_INPUT 0x0004C7C
46+
#define CS35L56_SWIRE_DP3_CH5_INPUT 0x0004C80
47+
#define CS35L56_SWIRE_DP3_CH6_INPUT 0x0004C84
48+
#define CS35L56_IRQ1_CFG 0x000E000
49+
#define CS35L56_IRQ1_STATUS 0x000E004
50+
#define CS35L56_IRQ1_EINT_1 0x000E010
51+
#define CS35L56_IRQ1_EINT_2 0x000E014
52+
#define CS35L56_IRQ1_EINT_4 0x000E01C
53+
#define CS35L56_IRQ1_EINT_8 0x000E02C
54+
#define CS35L56_IRQ1_EINT_18 0x000E054
55+
#define CS35L56_IRQ1_EINT_20 0x000E05C
56+
#define CS35L56_IRQ1_MASK_1 0x000E090
57+
#define CS35L56_IRQ1_MASK_2 0x000E094
58+
#define CS35L56_IRQ1_MASK_4 0x000E09C
59+
#define CS35L56_IRQ1_MASK_8 0x000E0AC
60+
#define CS35L56_IRQ1_MASK_18 0x000E0D4
61+
#define CS35L56_IRQ1_MASK_20 0x000E0DC
62+
#define CS35L56_DSP_VIRTUAL1_MBOX_1 0x0011020
63+
#define CS35L56_DSP_VIRTUAL1_MBOX_2 0x0011024
64+
#define CS35L56_DSP_VIRTUAL1_MBOX_3 0x0011028
65+
#define CS35L56_DSP_VIRTUAL1_MBOX_4 0x001102C
66+
#define CS35L56_DSP_VIRTUAL1_MBOX_5 0x0011030
67+
#define CS35L56_DSP_VIRTUAL1_MBOX_6 0x0011034
68+
#define CS35L56_DSP_VIRTUAL1_MBOX_7 0x0011038
69+
#define CS35L56_DSP_VIRTUAL1_MBOX_8 0x001103C
70+
#define CS35L56_DSP_RESTRICT_STS1 0x00190F0
71+
#define CS35L56_DSP1_XMEM_PACKED_0 0x2000000
72+
#define CS35L56_DSP1_XMEM_PACKED_6143 0x2005FFC
73+
#define CS35L56_DSP1_XMEM_UNPACKED32_0 0x2400000
74+
#define CS35L56_DSP1_XMEM_UNPACKED32_4095 0x2403FFC
75+
#define CS35L56_DSP1_SYS_INFO_ID 0x25E0000
76+
#define CS35L56_DSP1_SYS_INFO_END 0x25E004C
77+
#define CS35L56_DSP1_AHBM_WINDOW_DEBUG_0 0x25E2040
78+
#define CS35L56_DSP1_AHBM_WINDOW_DEBUG_1 0x25E2044
79+
#define CS35L56_DSP1_XMEM_UNPACKED24_0 0x2800000
80+
#define CS35L56_DSP1_HALO_STATE_A1 0x2801E58
81+
#define CS35L56_DSP1_HALO_STATE 0x28021E0
82+
#define CS35L56_DSP1_PM_CUR_STATE_A1 0x2804000
83+
#define CS35L56_DSP1_PM_CUR_STATE 0x2804308
84+
#define CS35L56_DSP1_XMEM_UNPACKED24_8191 0x2807FFC
85+
#define CS35L56_DSP1_CORE_BASE 0x2B80000
86+
#define CS35L56_DSP1_SCRATCH1 0x2B805C0
87+
#define CS35L56_DSP1_SCRATCH2 0x2B805C8
88+
#define CS35L56_DSP1_SCRATCH3 0x2B805D0
89+
#define CS35L56_DSP1_SCRATCH4 0x2B805D8
90+
#define CS35L56_DSP1_YMEM_PACKED_0 0x2C00000
91+
#define CS35L56_DSP1_YMEM_PACKED_4604 0x2C047F0
92+
#define CS35L56_DSP1_YMEM_UNPACKED32_0 0x3000000
93+
#define CS35L56_DSP1_YMEM_UNPACKED32_3070 0x3002FF8
94+
#define CS35L56_DSP1_YMEM_UNPACKED24_0 0x3400000
95+
#define CS35L56_MAIN_RENDER_USER_MUTE 0x3400024
96+
#define CS35L56_MAIN_RENDER_USER_VOLUME 0x340002C
97+
#define CS35L56_MAIN_POSTURE_NUMBER 0x3400094
98+
#define CS35L56_TRANSDUCER_ACTUAL_PS 0x3400150
99+
#define CS35L56_DSP1_YMEM_UNPACKED24_6141 0x3405FF4
100+
#define CS35L56_DSP1_PMEM_0 0x3800000
101+
#define CS35L56_DSP1_PMEM_5114 0x3804FE8
102+
103+
/* DEVID */
104+
#define CS35L56_DEVID_MASK 0x00FFFFFF
105+
106+
/* REVID */
107+
#define CS35L56_AREVID_MASK 0x000000F0
108+
#define CS35L56_MTLREVID_MASK 0x0000000F
109+
#define CS35L56_REVID_B0 0x000000B0
110+
111+
/* ASP_ENABLES1 */
112+
#define CS35L56_ASP_RX2_EN_SHIFT 17
113+
#define CS35L56_ASP_RX1_EN_SHIFT 16
114+
#define CS35L56_ASP_TX4_EN_SHIFT 3
115+
#define CS35L56_ASP_TX3_EN_SHIFT 2
116+
#define CS35L56_ASP_TX2_EN_SHIFT 1
117+
#define CS35L56_ASP_TX1_EN_SHIFT 0
118+
119+
/* ASP_CONTROL1 */
120+
#define CS35L56_ASP_BCLK_FREQ_MASK 0x0000003F
121+
#define CS35L56_ASP_BCLK_FREQ_SHIFT 0
122+
123+
/* ASP_CONTROL2 */
124+
#define CS35L56_ASP_RX_WIDTH_MASK 0xFF000000
125+
#define CS35L56_ASP_RX_WIDTH_SHIFT 24
126+
#define CS35L56_ASP_TX_WIDTH_MASK 0x00FF0000
127+
#define CS35L56_ASP_TX_WIDTH_SHIFT 16
128+
#define CS35L56_ASP_FMT_MASK 0x00000700
129+
#define CS35L56_ASP_FMT_SHIFT 8
130+
#define CS35L56_ASP_BCLK_INV_MASK 0x00000040
131+
#define CS35L56_ASP_FSYNC_INV_MASK 0x00000004
132+
133+
/* ASP_CONTROL3 */
134+
#define CS35L56_ASP1_DOUT_HIZ_CTRL_MASK 0x00000003
135+
136+
/* ASP_DATA_CONTROL1 */
137+
#define CS35L56_ASP_TX_WL_MASK 0x0000003F
138+
139+
/* ASP_DATA_CONTROL5 */
140+
#define CS35L56_ASP_RX_WL_MASK 0x0000003F
141+
142+
/* ASPTXn_INPUT */
143+
#define CS35L56_ASP_TXn_SRC_MASK 0x0000007F
144+
145+
/* SWIRETX[1..7]_SRC SDWTXn INPUT */
146+
#define CS35L56_SWIRETXn_SRC_MASK 0x0000007F
147+
148+
/* IRQ1_STATUS */
149+
#define CS35L56_IRQ1_STS_MASK 0x00000001
150+
151+
/* IRQ1_EINT_1 */
152+
#define CS35L56_AMP_SHORT_ERR_EINT1_MASK 0x80000000
153+
154+
/* IRQ1_EINT_2 */
155+
#define CS35L56_DSP_VIRTUAL2_MBOX_WR_EINT1_MASK 0x00200000
156+
157+
/* IRQ1_EINT_4 */
158+
#define CS35L56_OTP_BOOT_DONE_MASK 0x00000002
159+
160+
/* IRQ1_EINT_8 */
161+
#define CS35L56_TEMP_ERR_EINT1_MASK 0x80000000
162+
163+
/* Mixer input sources */
164+
#define CS35L56_INPUT_SRC_NONE 0x00
165+
#define CS35L56_INPUT_SRC_ASP1RX1 0x08
166+
#define CS35L56_INPUT_SRC_ASP1RX2 0x09
167+
#define CS35L56_INPUT_SRC_VMON 0x18
168+
#define CS35L56_INPUT_SRC_IMON 0x19
169+
#define CS35L56_INPUT_SRC_ERR_VOL 0x20
170+
#define CS35L56_INPUT_SRC_CLASSH 0x21
171+
#define CS35L56_INPUT_SRC_VDDBMON 0x28
172+
#define CS35L56_INPUT_SRC_VBSTMON 0x29
173+
#define CS35L56_INPUT_SRC_DSP1TX1 0x32
174+
#define CS35L56_INPUT_SRC_DSP1TX2 0x33
175+
#define CS35L56_INPUT_SRC_DSP1TX3 0x34
176+
#define CS35L56_INPUT_SRC_DSP1TX4 0x35
177+
#define CS35L56_INPUT_SRC_DSP1TX5 0x36
178+
#define CS35L56_INPUT_SRC_DSP1TX6 0x37
179+
#define CS35L56_INPUT_SRC_DSP1TX7 0x38
180+
#define CS35L56_INPUT_SRC_DSP1TX8 0x39
181+
#define CS35L56_INPUT_SRC_TEMPMON 0x3A
182+
#define CS35L56_INPUT_SRC_INTERPOLATOR 0x40
183+
#define CS35L56_INPUT_SRC_SWIRE_RX1 0x44
184+
#define CS35L56_INPUT_SRC_SWIRE_RX2 0x45
185+
#define CS35L56_INPUT_SRC_SWIRE_RX3 0x46
186+
#define CS35L56_INPUT_MASK 0x7F
187+
188+
#define CS35L56_NUM_INPUT_SRC 22
189+
190+
/* ASP formats */
191+
#define CS35L56_ASP_FMT_DSP_A 0
192+
#define CS35L56_ASP_FMT_I2S 2
193+
194+
/* ASP HiZ modes */
195+
#define CS35L56_ASP_UNUSED_HIZ_OFF_HIZ 3
196+
197+
/* MAIN_RENDER_ACTUAL_PS */
198+
#define CS35L56_PS0 0
199+
#define CS35L56_PS3 3
200+
201+
/* CS35L56_DSP_RESTRICT_STS1 */
202+
#define CS35L56_RESTRICTED_MASK 0x7
203+
204+
/* CS35L56_MAIN_RENDER_USER_MUTE */
205+
#define CS35L56_MAIN_RENDER_USER_MUTE_MASK 1
206+
207+
/* CS35L56_MAIN_RENDER_USER_VOLUME */
208+
#define CS35L56_MAIN_RENDER_USER_VOLUME_MIN -400
209+
#define CS35L56_MAIN_RENDER_USER_VOLUME_MAX 400
210+
#define CS35L56_MAIN_RENDER_USER_VOLUME_MASK 0x0000FFC0
211+
#define CS35L56_MAIN_RENDER_USER_VOLUME_SHIFT 6
212+
#define CS35L56_MAIN_RENDER_USER_VOLUME_SIGNBIT 9
213+
214+
/* CS35L56_MAIN_POSTURE_NUMBER */
215+
#define CS35L56_MAIN_POSTURE_MIN 0
216+
#define CS35L56_MAIN_POSTURE_MAX 255
217+
#define CS35L56_MAIN_POSTURE_MASK CS35L56_MAIN_POSTURE_MAX
218+
219+
/* Software Values */
220+
#define CS35L56_HALO_STATE_SHUTDOWN 1
221+
#define CS35L56_HALO_STATE_BOOT_DONE 2
222+
223+
#define CS35L56_MBOX_CMD_AUDIO_PLAY 0x0B000001
224+
#define CS35L56_MBOX_CMD_AUDIO_PAUSE 0x0B000002
225+
#define CS35L56_MBOX_CMD_HIBERNATE_NOW 0x02000001
226+
#define CS35L56_MBOX_CMD_WAKEUP 0x02000002
227+
#define CS35L56_MBOX_CMD_PREVENT_AUTO_HIBERNATE 0x02000003
228+
#define CS35L56_MBOX_CMD_ALLOW_AUTO_HIBERNATE 0x02000004
229+
#define CS35L56_MBOX_CMD_SHUTDOWN 0x02000005
230+
#define CS35L56_MBOX_CMD_SYSTEM_RESET 0x02000007
231+
232+
#define CS35L56_MBOX_TIMEOUT_US 5000
233+
#define CS35L56_MBOX_POLL_US 250
234+
235+
#define CS35L56_PS0_POLL_US 500
236+
#define CS35L56_PS0_TIMEOUT_US 50000
237+
#define CS35L56_PS3_POLL_US 500
238+
#define CS35L56_PS3_TIMEOUT_US 300000
239+
240+
#define CS35L56_CONTROL_PORT_READY_US 2200
241+
#define CS35L56_HALO_STATE_POLL_US 1000
242+
#define CS35L56_HALO_STATE_TIMEOUT_US 50000
243+
#define CS35L56_HIBERNATE_WAKE_POLL_US 500
244+
#define CS35L56_HIBERNATE_WAKE_TIMEOUT_US 5000
245+
#define CS35L56_RESET_PULSE_MIN_US 1100
246+
247+
#define CS35L56_SDW1_PLAYBACK_PORT 1
248+
#define CS35L56_SDW1_CAPTURE_PORT 3
249+
250+
#define CS35L56_NUM_BULK_SUPPLIES 3
251+
#define CS35L56_NUM_DSP_REGIONS 5
252+
253+
extern struct regmap_config cs35l56_regmap_i2c;
254+
extern struct regmap_config cs35l56_regmap_spi;
255+
extern struct regmap_config cs35l56_regmap_sdw;
256+
257+
extern const struct cs_dsp_region cs35l56_dsp1_regions[CS35L56_NUM_DSP_REGIONS];
258+
extern const char * const cs35l56_tx_input_texts[CS35L56_NUM_INPUT_SRC];
259+
extern const unsigned int cs35l56_tx_input_values[CS35L56_NUM_INPUT_SRC];
260+
261+
void cs35l56_patch(struct device *dev, struct regmap *regmap, u8 revid);
262+
void cs35l56_reread_firmware_registers(struct device *dev, struct regmap *regmap);
263+
int cs35l56_get_bclk_freq_id(unsigned int freq);
264+
void cs35l56_fill_supply_names(struct regulator_bulk_data *data);
265+
266+
#endif /* ifndef __CS35L56_H */

‎sound/soc/codecs/Kconfig‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ config SND_SOC_ALL_CODECS
6868
imply SND_SOC_CS35L41_I2C
6969
imply SND_SOC_CS35L45_I2C
7070
imply SND_SOC_CS35L45_SPI
71+
imply SND_SOC_CS35L56_I2C
72+
imply SND_SOC_CS35L56_SPI
73+
imply SND_SOC_CS35L56_SDW
7174
imply SND_SOC_CS42L42
7275
imply SND_SOC_CS42L42_SDW
7376
imply SND_SOC_CS42L51_I2C
@@ -366,6 +369,7 @@ config SND_SOC_WM_ADSP
366369
default y if SND_SOC_CS35L41_I2C=y
367370
default y if SND_SOC_CS35L45_SPI=y
368371
default y if SND_SOC_CS35L45_I2C=y
372+
default y if SND_SOC_CS35L56=y
369373
default m if SND_SOC_MADERA=m
370374
default m if SND_SOC_CS47L24=m
371375
default m if SND_SOC_WM5102=m
@@ -375,6 +379,7 @@ config SND_SOC_WM_ADSP
375379
default m if SND_SOC_CS35L41_I2C=m
376380
default m if SND_SOC_CS35L45_SPI=m
377381
default m if SND_SOC_CS35L45_I2C=m
382+
default m if SND_SOC_CS35L56=m
378383

379384
config SND_SOC_AB8500_CODEC
380385
tristate
@@ -715,6 +720,41 @@ config SND_SOC_CS35L45_I2C
715720
Enable support for Cirrus Logic CS35L45 smart speaker amplifier
716721
with I2C control.
717722

723+
config SND_SOC_CS35L56
724+
tristate
725+
726+
config SND_SOC_CS35L56_SHARED
727+
tristate
728+
729+
config SND_SOC_CS35L56_I2C
730+
tristate "Cirrus Logic CS35L56 CODEC (I2C)"
731+
depends on I2C
732+
depends on SOUNDWIRE || !SOUNDWIRE
733+
select REGMAP_I2C
734+
select SND_SOC_CS35L56
735+
select SND_SOC_CS35L56_SHARED
736+
help
737+
Enable support for Cirrus Logic CS35L56 boosted amplifier with I2C control
738+
739+
config SND_SOC_CS35L56_SPI
740+
tristate "Cirrus Logic CS35L56 CODEC (SPI)"
741+
depends on SPI_MASTER
742+
depends on SOUNDWIRE || !SOUNDWIRE
743+
select REGMAP_SPI
744+
select SND_SOC_CS35L56
745+
select SND_SOC_CS35L56_SHARED
746+
help
747+
Enable support for Cirrus Logic CS35L56 boosted amplifier with SPI control
748+
749+
config SND_SOC_CS35L56_SDW
750+
tristate "Cirrus Logic CS35L56 CODEC (SDW)"
751+
depends on SOUNDWIRE
752+
select REGMAP
753+
select SND_SOC_CS35L56
754+
select SND_SOC_CS35L56_SHARED
755+
help
756+
Enable support for Cirrus Logic CS35L56 boosted amplifier with SoundWire control
757+
718758
config SND_SOC_CS42L42_CORE
719759
tristate
720760

0 commit comments

Comments
 (0)