xref: /linux/sound/soc/codecs/rt5575.c (revision 69050f8d6d075dc01af7a5f2f550a8067510366f)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * rt5575.c  --  ALC5575 ALSA SoC audio component driver
4  *
5  * Copyright(c) 2025 Realtek Semiconductor Corp.
6  *
7  */
8 
9 #include <linux/i2c.h>
10 #include <sound/soc.h>
11 #include <sound/tlv.h>
12 
13 #include "rt5575.h"
14 #include "rt5575-spi.h"
15 
16 static bool rt5575_readable_register(struct device *dev, unsigned int reg)
17 {
18 	switch (reg) {
19 	case RT5575_BOOT:
20 	case RT5575_ID:
21 	case RT5575_ID_1:
22 	case RT5575_MIXL_VOL:
23 	case RT5575_MIXR_VOL:
24 	case RT5575_PROMPT_VOL:
25 	case RT5575_SPK01_VOL:
26 	case RT5575_SPK23_VOL:
27 	case RT5575_MIC1_VOL:
28 	case RT5575_MIC2_VOL:
29 	case RT5575_WNC_CTRL:
30 	case RT5575_MODE_CTRL:
31 	case RT5575_I2S_RATE_CTRL:
32 	case RT5575_SLEEP_CTRL:
33 	case RT5575_ALG_BYPASS_CTRL:
34 	case RT5575_PINMUX_CTRL_2:
35 	case RT5575_GPIO_CTRL_1:
36 	case RT5575_DSP_BUS_CTRL:
37 	case RT5575_SW_INT:
38 	case RT5575_DSP_BOOT_ERR:
39 	case RT5575_DSP_READY:
40 	case RT5575_DSP_CMD_ADDR:
41 	case RT5575_EFUSE_DATA_2:
42 	case RT5575_EFUSE_DATA_3:
43 		return true;
44 	default:
45 		return false;
46 	}
47 }
48 
49 static const DECLARE_TLV_DB_SCALE(ob_tlv, -9525, 75, 0);
50 
51 static const struct snd_kcontrol_new rt5575_snd_controls[] = {
52 	SOC_DOUBLE("Speaker CH-01 Playback Switch", RT5575_SPK01_VOL, 31, 15, 1, 1),
53 	SOC_DOUBLE_TLV("Speaker CH-01 Playback Volume", RT5575_SPK01_VOL, 17, 1, 167, 0, ob_tlv),
54 	SOC_DOUBLE("Speaker CH-23 Playback Switch", RT5575_SPK23_VOL, 31, 15, 1, 1),
55 	SOC_DOUBLE_TLV("Speaker CH-23 Playback Volume", RT5575_SPK23_VOL, 17, 1, 167, 0, ob_tlv),
56 	SOC_DOUBLE("Mic1 Capture Switch", RT5575_MIC1_VOL, 31, 15, 1, 1),
57 	SOC_DOUBLE_TLV("Mic1 Capture Volume", RT5575_MIC1_VOL, 17, 1, 167, 0, ob_tlv),
58 	SOC_DOUBLE("Mic2 Capture Switch", RT5575_MIC2_VOL, 31, 15, 1, 1),
59 	SOC_DOUBLE_TLV("Mic2 Capture Volume", RT5575_MIC2_VOL, 17, 1, 167, 0, ob_tlv),
60 	SOC_DOUBLE_R("Mix Playback Switch", RT5575_MIXL_VOL, RT5575_MIXR_VOL, 31, 1, 1),
61 	SOC_DOUBLE_R_TLV("Mix Playback Volume", RT5575_MIXL_VOL, RT5575_MIXR_VOL, 1, 127, 0,
62 		ob_tlv),
63 	SOC_DOUBLE("Prompt Playback Switch", RT5575_PROMPT_VOL, 31, 15, 1, 1),
64 	SOC_DOUBLE_TLV("Prompt Playback Volume", RT5575_PROMPT_VOL, 17, 1, 167, 0, ob_tlv),
65 };
66 
67 static const struct snd_soc_dapm_widget rt5575_dapm_widgets[] = {
68 	SND_SOC_DAPM_AIF_IN("AIF1RX", "AIF1 Playback", 0, SND_SOC_NOPM, 0, 0),
69 	SND_SOC_DAPM_AIF_OUT("AIF1TX", "AIF1 Capture", 0, SND_SOC_NOPM, 0, 0),
70 	SND_SOC_DAPM_AIF_IN("AIF2RX", "AIF2 Playback", 0, SND_SOC_NOPM, 0, 0),
71 	SND_SOC_DAPM_AIF_OUT("AIF2TX", "AIF2 Capture", 0, SND_SOC_NOPM, 0, 0),
72 	SND_SOC_DAPM_AIF_IN("AIF3RX", "AIF3 Playback", 0, SND_SOC_NOPM, 0, 0),
73 	SND_SOC_DAPM_AIF_OUT("AIF3TX", "AIF3 Capture", 0, SND_SOC_NOPM, 0, 0),
74 	SND_SOC_DAPM_AIF_IN("AIF4RX", "AIF4 Playback", 0, SND_SOC_NOPM, 0, 0),
75 	SND_SOC_DAPM_AIF_OUT("AIF4TX", "AIF4 Capture", 0, SND_SOC_NOPM, 0, 0),
76 
77 	SND_SOC_DAPM_INPUT("INPUT"),
78 	SND_SOC_DAPM_OUTPUT("OUTPUT"),
79 };
80 
81 static const struct snd_soc_dapm_route rt5575_dapm_routes[] = {
82 	{ "AIF1TX", NULL, "INPUT" },
83 	{ "AIF2TX", NULL, "INPUT" },
84 	{ "AIF3TX", NULL, "INPUT" },
85 	{ "AIF4TX", NULL, "INPUT" },
86 	{ "OUTPUT", NULL, "AIF1RX" },
87 	{ "OUTPUT", NULL, "AIF2RX" },
88 	{ "OUTPUT", NULL, "AIF3RX" },
89 	{ "OUTPUT", NULL, "AIF4RX" },
90 };
91 
92 static long long rt5575_get_priv_id(struct rt5575_priv *rt5575)
93 {
94 	int priv_id_low, priv_id_high;
95 
96 	regmap_write(rt5575->regmap, RT5575_EFUSE_PID, 0xa0000000);
97 	regmap_read(rt5575->regmap, RT5575_EFUSE_DATA_2, &priv_id_low);
98 	regmap_read(rt5575->regmap, RT5575_EFUSE_DATA_3, &priv_id_high);
99 	regmap_write(rt5575->regmap, RT5575_EFUSE_PID, 0);
100 
101 	return ((long long)priv_id_high << 32) | (long long)priv_id_low;
102 }
103 
104 static int rt5575_probe(struct snd_soc_component *component)
105 {
106 	struct rt5575_priv *rt5575 = snd_soc_component_get_drvdata(component);
107 	struct device *dev = component->dev;
108 
109 	rt5575->component = component;
110 
111 	dev_info(dev, "Private ID: %llx\n", rt5575_get_priv_id(rt5575));
112 
113 	return 0;
114 }
115 
116 #define RT5575_STEREO_RATES SNDRV_PCM_RATE_8000_192000
117 #define RT5575_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
118 			SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S8 | \
119 			SNDRV_PCM_FMTBIT_S32_LE)
120 
121 static struct snd_soc_dai_driver rt5575_dai[] = {
122 	{
123 		.name = "rt5575-aif1",
124 		.id = RT5575_AIF1,
125 		.playback = {
126 			.stream_name = "AIF1 Playback",
127 			.channels_min = 1,
128 			.channels_max = 8,
129 			.rates = RT5575_STEREO_RATES,
130 			.formats = RT5575_FORMATS,
131 		},
132 		.capture = {
133 			.stream_name = "AIF1 Capture",
134 			.channels_min = 1,
135 			.channels_max = 8,
136 			.rates = RT5575_STEREO_RATES,
137 			.formats = RT5575_FORMATS,
138 		},
139 	},
140 	{
141 		.name = "rt5575-aif2",
142 		.id = RT5575_AIF2,
143 		.playback = {
144 			.stream_name = "AIF2 Playback",
145 			.channels_min = 1,
146 			.channels_max = 8,
147 			.rates = RT5575_STEREO_RATES,
148 			.formats = RT5575_FORMATS,
149 		},
150 		.capture = {
151 			.stream_name = "AIF2 Capture",
152 			.channels_min = 1,
153 			.channels_max = 8,
154 			.rates = RT5575_STEREO_RATES,
155 			.formats = RT5575_FORMATS,
156 		},
157 	},
158 	{
159 		.name = "rt5575-aif3",
160 		.id = RT5575_AIF3,
161 		.playback = {
162 			.stream_name = "AIF3 Playback",
163 			.channels_min = 1,
164 			.channels_max = 8,
165 			.rates = RT5575_STEREO_RATES,
166 			.formats = RT5575_FORMATS,
167 		},
168 		.capture = {
169 			.stream_name = "AIF3 Capture",
170 			.channels_min = 1,
171 			.channels_max = 8,
172 			.rates = RT5575_STEREO_RATES,
173 			.formats = RT5575_FORMATS,
174 		},
175 	},
176 	{
177 		.name = "rt5575-aif4",
178 		.id = RT5575_AIF4,
179 		.playback = {
180 			.stream_name = "AIF4 Playback",
181 			.channels_min = 1,
182 			.channels_max = 8,
183 			.rates = RT5575_STEREO_RATES,
184 			.formats = RT5575_FORMATS,
185 		},
186 		.capture = {
187 			.stream_name = "AIF4 Capture",
188 			.channels_min = 1,
189 			.channels_max = 8,
190 			.rates = RT5575_STEREO_RATES,
191 			.formats = RT5575_FORMATS,
192 		},
193 	},
194 };
195 
196 static const struct snd_soc_component_driver rt5575_soc_component_dev = {
197 	.probe = rt5575_probe,
198 	.controls = rt5575_snd_controls,
199 	.num_controls = ARRAY_SIZE(rt5575_snd_controls),
200 	.dapm_widgets = rt5575_dapm_widgets,
201 	.num_dapm_widgets = ARRAY_SIZE(rt5575_dapm_widgets),
202 	.dapm_routes = rt5575_dapm_routes,
203 	.num_dapm_routes = ARRAY_SIZE(rt5575_dapm_routes),
204 	.use_pmdown_time = 1,
205 	.endianness = 1,
206 };
207 
208 static const struct regmap_config rt5575_dsp_regmap = {
209 	.name = "dsp",
210 	.reg_bits = 32,
211 	.val_bits = 32,
212 	.reg_stride = 2,
213 };
214 
215 static int rt5575_i2c_read(void *context, unsigned int reg, unsigned int *val)
216 {
217 	struct i2c_client *client = context;
218 	struct rt5575_priv *rt5575 = i2c_get_clientdata(client);
219 
220 	return regmap_read(rt5575->dsp_regmap, reg | RT5575_DSP_MAPPING, val);
221 }
222 
223 static int rt5575_i2c_write(void *context, unsigned int reg, unsigned int val)
224 {
225 	struct i2c_client *client = context;
226 	struct rt5575_priv *rt5575 = i2c_get_clientdata(client);
227 
228 	return regmap_write(rt5575->dsp_regmap, reg | RT5575_DSP_MAPPING, val);
229 }
230 
231 static const struct regmap_config rt5575_regmap = {
232 	.reg_bits = 16,
233 	.val_bits = 32,
234 	.reg_stride = 4,
235 	.max_register = 0xfffc,
236 	.readable_reg = rt5575_readable_register,
237 	.reg_read = rt5575_i2c_read,
238 	.reg_write = rt5575_i2c_write,
239 	.use_single_read = true,
240 	.use_single_write = true,
241 };
242 
243 static int rt5575_fw_load_by_spi(struct rt5575_priv *rt5575)
244 {
245 	struct i2c_client *i2c = rt5575->i2c;
246 	struct spi_device *spi;
247 	struct device *dev = &i2c->dev;
248 	int ret;
249 
250 	spi = rt5575_spi_get_device(dev);
251 	if (!spi) {
252 		dev_err(dev, "Failed to get spi_device\n");
253 		return -ENODEV;
254 	}
255 
256 	regmap_write(rt5575->dsp_regmap, 0xfafafafa, 0x00000004);
257 	regmap_write(rt5575->dsp_regmap, 0x18008064, 0x00000000);
258 	regmap_write(rt5575->dsp_regmap, 0x18008068, 0x0002ffff);
259 
260 	ret = rt5575_spi_fw_load(spi);
261 	if (ret) {
262 		dev_err(dev, "Load firmware failure: %d\n", ret);
263 		return -ENODEV;
264 	}
265 
266 	regmap_write(rt5575->dsp_regmap, 0x18000000, 0x00000000);
267 	regmap_update_bits(rt5575->regmap, RT5575_SW_INT, 1, 1);
268 
269 	regmap_read_poll_timeout(rt5575->regmap, RT5575_SW_INT, ret, !ret, 100000, 10000000);
270 	if (ret) {
271 		dev_err(dev, "Run firmware failure: %d\n", ret);
272 		return -ENODEV;
273 	}
274 
275 	return 0;
276 }
277 
278 static int rt5575_i2c_probe(struct i2c_client *i2c)
279 {
280 	struct rt5575_priv *rt5575;
281 	int ret, val, boot;
282 	struct device *dev = &i2c->dev;
283 
284 	rt5575 = devm_kzalloc(dev, sizeof(struct rt5575_priv), GFP_KERNEL);
285 	if (!rt5575)
286 		return -ENOMEM;
287 
288 	i2c_set_clientdata(i2c, rt5575);
289 
290 	rt5575->i2c = i2c;
291 
292 	rt5575->dsp_regmap = devm_regmap_init_i2c(i2c, &rt5575_dsp_regmap);
293 	if (IS_ERR(rt5575->dsp_regmap)) {
294 		ret = PTR_ERR(rt5575->dsp_regmap);
295 		dev_err(dev, "Failed to allocate DSP register map: %d\n", ret);
296 		return ret;
297 	}
298 
299 	rt5575->regmap = devm_regmap_init(dev, NULL, i2c, &rt5575_regmap);
300 	if (IS_ERR(rt5575->regmap)) {
301 		ret = PTR_ERR(rt5575->regmap);
302 		dev_err(dev, "Failed to allocate register map: %d\n", ret);
303 		return ret;
304 	}
305 
306 	regmap_read(rt5575->regmap, RT5575_ID, &val);
307 	if (val != RT5575_DEVICE_ID) {
308 		dev_err(dev, "Device with ID register %08x is not rt5575\n", val);
309 		return -ENODEV;
310 	}
311 
312 	regmap_read(rt5575->regmap, RT5575_BOOT, &boot);
313 	if ((boot & RT5575_BOOT_MASK) == RT5575_BOOT_SPI) {
314 		if (!IS_ENABLED(CONFIG_SND_SOC_RT5575_SPI)) {
315 			dev_err(dev, "Please enable CONFIG_SND_SOC_RT5575_SPI\n");
316 			return -ENODEV;
317 		}
318 
319 		if (rt5575_fw_load_by_spi(rt5575))
320 			return -ENODEV;
321 	}
322 
323 	return devm_snd_soc_register_component(dev, &rt5575_soc_component_dev, rt5575_dai,
324 					       ARRAY_SIZE(rt5575_dai));
325 }
326 
327 static const struct i2c_device_id rt5575_i2c_id[] = {
328 	{ "rt5575" },
329 	{ }
330 };
331 MODULE_DEVICE_TABLE(i2c, rt5575_i2c_id);
332 
333 static const struct of_device_id rt5575_of_match[] = {
334 	{ .compatible = "realtek,rt5575" },
335 	{ }
336 };
337 MODULE_DEVICE_TABLE(of, rt5575_of_match);
338 
339 static struct i2c_driver rt5575_i2c_driver = {
340 	.driver = {
341 		.name = "rt5575",
342 		.owner = THIS_MODULE,
343 		.of_match_table = rt5575_of_match,
344 	},
345 	.probe = rt5575_i2c_probe,
346 	.id_table = rt5575_i2c_id,
347 };
348 module_i2c_driver(rt5575_i2c_driver);
349 
350 MODULE_DESCRIPTION("ASoC ALC5575 driver");
351 MODULE_AUTHOR("Oder Chiou <oder_chiou@realtek.com>");
352 MODULE_LICENSE("GPL");
353