xref: /linux/sound/soc/loongson/loongson_card.c (revision c20313e98b04ce543936431b6122dd639d3a8346)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Loongson ASoC Audio Machine driver
4 //
5 // Copyright (C) 2023-2026 Loongson Technology Corporation Limited
6 // Author: Yingkun Meng <mengyingkun@loongson.cn>
7 //         Binbin Zhou <zhoubinbin@loongson.cn>
8 //
9 
10 #include <linux/acpi.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/module.h>
13 #include <linux/pci.h>
14 #include <sound/jack.h>
15 #include <sound/pcm_params.h>
16 #include <sound/soc.h>
17 #include <sound/soc-acpi.h>
18 
19 static char codec_name[SND_ACPI_I2C_ID_LEN];
20 
21 struct loongson_card_data {
22 	struct snd_soc_card snd_card;
23 	unsigned int mclk_fs;
24 	struct gpio_desc *gpiod_hp_det;
25 	struct gpio_desc *gpiod_hp_ctl;
26 	struct gpio_desc *gpiod_spkr_en;
27 	const struct loongson_card_config *cfg;
28 };
29 
30 struct loongson_card_config {
31 	unsigned int fmt;
32 	bool add_hp_jack;
33 	bool add_dapm_widgets;
34 	bool add_dapm_routes;
35 };
36 
37 static const struct loongson_card_config ls2k1000_card_config = {
38 	.fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_IB_NF | SND_SOC_DAIFMT_CBC_CFC,
39 	.add_hp_jack = false,
40 	.add_dapm_widgets = false,
41 	.add_dapm_routes = false,
42 };
43 
44 static const struct loongson_card_config ls2k0300_forever_pi_card_config = {
45 	.fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF | SND_SOC_DAIFMT_CBC_CFC,
46 	.add_hp_jack = false,
47 	.add_dapm_widgets = false,
48 	.add_dapm_routes = false,
49 };
50 
51 static const struct loongson_card_config ls2k0300_dl2k0300b_card_config = {
52 	.fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF | SND_SOC_DAIFMT_CBC_CFC,
53 	.add_hp_jack = true,
54 	.add_dapm_widgets = true,
55 	.add_dapm_routes = true,
56 };
57 
58 static int loongson_asoc_machine_event(struct snd_soc_dapm_widget *w,
59 				       struct snd_kcontrol *k, int event)
60 {
61 	struct snd_soc_card *card = snd_soc_dapm_to_card(w->dapm);
62 	struct loongson_card_data *priv = snd_soc_card_get_drvdata(card);
63 
64 	if (!snd_soc_dapm_widget_name_cmp(w, "Speaker"))
65 		gpiod_set_value_cansleep(priv->gpiod_spkr_en,
66 					 SND_SOC_DAPM_EVENT_ON(event));
67 
68 	if (!snd_soc_dapm_widget_name_cmp(w, "Headphone"))
69 		gpiod_set_value_cansleep(priv->gpiod_hp_ctl,
70 					 SND_SOC_DAPM_EVENT_ON(event));
71 
72 	return 0;
73 }
74 
75 static const struct snd_soc_dapm_widget loongson_asoc_dapm_widgets[] = {
76 	SND_SOC_DAPM_HP("Headphone", loongson_asoc_machine_event),
77 	SND_SOC_DAPM_SPK("Speaker", loongson_asoc_machine_event),
78 };
79 
80 /* Headphones Jack */
81 
82 static struct snd_soc_jack loongson_asoc_hp_jack;
83 
84 static struct snd_soc_jack_pin loongson_asoc_hp_jack_pins[] = {
85 	{
86 		.pin = "Headphone",
87 		.mask = SND_JACK_HEADPHONE
88 	},
89 	{
90 		.pin = "Speaker",
91 		.mask = SND_JACK_HEADPHONE,
92 		.invert = 1
93 	},
94 };
95 
96 static struct snd_soc_jack_gpio loongson_asoc_hp_jack_gpio = {
97 	.name = "Headphones detection",
98 	.report = SND_JACK_HEADPHONE,
99 	.debounce_time = 150,
100 };
101 
102 static int loongson_asoc_machine_init(struct snd_soc_pcm_runtime *rtd)
103 {
104 	struct snd_soc_card *card = rtd->card;
105 	struct loongson_card_data *ls_priv = snd_soc_card_get_drvdata(card);
106 	int ret = 0;
107 
108 	if (!ls_priv->cfg->add_hp_jack || !ls_priv->gpiod_hp_det)
109 		return 0;
110 
111 	ret = snd_soc_card_jack_new_pins(card, "Headphones Jack",
112 					 SND_JACK_HEADPHONE,
113 					 &loongson_asoc_hp_jack,
114 					 loongson_asoc_hp_jack_pins,
115 					 ARRAY_SIZE(loongson_asoc_hp_jack_pins));
116 	if (ret) {
117 		dev_err(rtd->dev, "Headphones Jack creation failed: %d\n", ret);
118 		return ret;
119 	}
120 
121 	loongson_asoc_hp_jack_gpio.desc = ls_priv->gpiod_hp_det;
122 
123 	ret = snd_soc_jack_add_gpios(&loongson_asoc_hp_jack, 1, &loongson_asoc_hp_jack_gpio);
124 	if (ret)
125 		dev_err(rtd->dev, "Headphone GPIO not added: %d\n", ret);
126 
127 	return ret;
128 }
129 
130 static int loongson_card_hw_params(struct snd_pcm_substream *substream,
131 				   struct snd_pcm_hw_params *params)
132 {
133 	struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
134 	struct loongson_card_data *ls_card = snd_soc_card_get_drvdata(rtd->card);
135 	struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
136 	struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, 0);
137 	int ret, mclk;
138 
139 	if (!ls_card->mclk_fs)
140 		return 0;
141 
142 	mclk = ls_card->mclk_fs * params_rate(params);
143 	ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk, SND_SOC_CLOCK_OUT);
144 	if (ret < 0) {
145 		dev_err(codec_dai->dev, "cpu_dai clock not set\n");
146 		return ret;
147 	}
148 
149 	ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk, SND_SOC_CLOCK_IN);
150 	if (ret < 0) {
151 		dev_err(codec_dai->dev, "codec_dai clock not set\n");
152 		return ret;
153 	}
154 
155 	return snd_soc_runtime_set_dai_fmt(rtd, ls_card->cfg->fmt);
156 }
157 
158 static const struct snd_soc_ops loongson_ops = {
159 	.hw_params = loongson_card_hw_params,
160 };
161 
162 SND_SOC_DAILINK_DEFS(analog,
163 	DAILINK_COMP_ARRAY(COMP_CPU("loongson-i2s")),
164 	DAILINK_COMP_ARRAY(COMP_EMPTY()),
165 	DAILINK_COMP_ARRAY(COMP_EMPTY()));
166 
167 static struct snd_soc_dai_link loongson_dai_links[] = {
168 	{
169 		.name = "Loongson Audio Port",
170 		.stream_name = "Loongson Audio",
171 		.init = loongson_asoc_machine_init,
172 		SND_SOC_DAILINK_REG(analog),
173 		.ops = &loongson_ops,
174 	},
175 };
176 
177 static struct acpi_device *loongson_card_acpi_find_device(struct snd_soc_card *card,
178 							  const char *name)
179 {
180 	struct fwnode_handle *fwnode = card->dev->fwnode;
181 	struct fwnode_reference_args args;
182 	int status;
183 
184 	memset(&args, 0, sizeof(args));
185 	status = acpi_node_get_property_reference(fwnode, name, 0, &args);
186 	if (status || !is_acpi_device_node(args.fwnode)) {
187 		dev_err(card->dev, "No matching phy in ACPI table\n");
188 		return NULL;
189 	}
190 
191 	return to_acpi_device_node(args.fwnode);
192 }
193 
194 static int loongson_card_parse_acpi(struct loongson_card_data *data)
195 {
196 	struct snd_soc_card *card = &data->snd_card;
197 	const char *codec_dai_name;
198 	struct acpi_device *adev;
199 	struct device *phy_dev;
200 	int i, ret;
201 
202 	/* fixup platform name based on reference node */
203 	adev = loongson_card_acpi_find_device(card, "cpu");
204 	if (!adev)
205 		return -ENOENT;
206 
207 	phy_dev = acpi_get_first_physical_node(adev);
208 	if (!phy_dev)
209 		return -EPROBE_DEFER;
210 
211 	/* fixup codec name based on reference node */
212 	adev = loongson_card_acpi_find_device(card, "codec");
213 	if (!adev)
214 		return -ENOENT;
215 	snprintf(codec_name, sizeof(codec_name), "i2c-%s", acpi_dev_name(adev));
216 
217 	ret = device_property_read_string(card->dev, "codec-dai-name", &codec_dai_name);
218 	if (ret)
219 		return ret;
220 
221 	for (i = 0; i < card->num_links; i++) {
222 		loongson_dai_links[i].platforms->name = dev_name(phy_dev);
223 		loongson_dai_links[i].codecs->name = codec_name;
224 		loongson_dai_links[i].codecs->dai_name = codec_dai_name;
225 	}
226 
227 	return 0;
228 }
229 
230 static int loongson_card_parse_of(struct loongson_card_data *data)
231 {
232 	struct snd_soc_card *card = &data->snd_card;
233 	struct device_node *cpu, *codec;
234 	struct device *dev = card->dev;
235 	int ret, i;
236 
237 	data->gpiod_hp_det = devm_gpiod_get_optional(dev, "hp-det", GPIOD_IN);
238 	if (IS_ERR(data->gpiod_hp_det))
239 		return PTR_ERR(data->gpiod_hp_det);
240 
241 	data->gpiod_hp_ctl = devm_gpiod_get_optional(dev, "hp-ctl", GPIOD_OUT_LOW);
242 	if (IS_ERR(data->gpiod_hp_ctl))
243 		return PTR_ERR(data->gpiod_hp_ctl);
244 
245 	data->gpiod_spkr_en = devm_gpiod_get_optional(dev, "spkr-en", GPIOD_OUT_LOW);
246 	if (IS_ERR(data->gpiod_spkr_en))
247 		return PTR_ERR(data->gpiod_spkr_en);
248 
249 	if (data->cfg->add_dapm_routes) {
250 		ret = snd_soc_of_parse_audio_routing(card, "audio-routing");
251 		if (ret)
252 			return ret;
253 	}
254 
255 	cpu = of_get_child_by_name(dev->of_node, "cpu");
256 	if (!cpu) {
257 		dev_err(dev, "platform property missing or invalid\n");
258 		return -EINVAL;
259 	}
260 
261 	codec = of_get_child_by_name(dev->of_node, "codec");
262 	if (!codec) {
263 		dev_err(dev, "audio-codec property missing or invalid\n");
264 		of_node_put(cpu);
265 		return -EINVAL;
266 	}
267 
268 	for (i = 0; i < card->num_links; i++) {
269 		ret = snd_soc_of_get_dlc(cpu, NULL, loongson_dai_links[i].cpus, 0);
270 		if (ret < 0) {
271 			dev_err(dev, "getting cpu dlc error (%d)\n", ret);
272 			goto err;
273 		}
274 		loongson_dai_links[i].platforms->of_node = loongson_dai_links[i].cpus->of_node;
275 
276 		ret = snd_soc_of_get_dlc(codec, NULL, loongson_dai_links[i].codecs, 0);
277 		if (ret < 0) {
278 			dev_err(dev, "getting codec dlc error (%d)\n", ret);
279 			goto err;
280 		}
281 	}
282 
283 	of_node_put(cpu);
284 	of_node_put(codec);
285 
286 	return 0;
287 
288 err:
289 	of_node_put(cpu);
290 	of_node_put(codec);
291 	return ret;
292 }
293 
294 static int loongson_asoc_card_probe(struct platform_device *pdev)
295 {
296 	struct loongson_card_data *ls_priv;
297 	struct device *dev = &pdev->dev;
298 	struct snd_soc_card *card;
299 	int ret;
300 
301 	ls_priv = devm_kzalloc(dev, sizeof(*ls_priv), GFP_KERNEL);
302 	if (!ls_priv)
303 		return -ENOMEM;
304 
305 	ls_priv->cfg = (const struct loongson_card_config *)device_get_match_data(dev);
306 	if (!ls_priv->cfg)
307 		return -EINVAL;
308 
309 	card = &ls_priv->snd_card;
310 
311 	card->dev = dev;
312 	card->owner = THIS_MODULE;
313 	card->dai_link = loongson_dai_links;
314 	card->num_links = ARRAY_SIZE(loongson_dai_links);
315 
316 	if (ls_priv->cfg->add_dapm_widgets) {
317 		card->dapm_widgets = loongson_asoc_dapm_widgets;
318 		card->num_dapm_widgets = ARRAY_SIZE(loongson_asoc_dapm_widgets);
319 	}
320 
321 	snd_soc_card_set_drvdata(card, ls_priv);
322 
323 	ret = device_property_read_string(dev, "model", &card->name);
324 	if (ret)
325 		return dev_err_probe(dev, ret, "Error parsing card name\n");
326 
327 	ret = device_property_read_u32(dev, "mclk-fs", &ls_priv->mclk_fs);
328 	if (ret)
329 		return dev_err_probe(dev, ret, "Error parsing mclk-fs\n");
330 
331 	ret = has_acpi_companion(dev) ? loongson_card_parse_acpi(ls_priv)
332 				      : loongson_card_parse_of(ls_priv);
333 	if (ret)
334 		return dev_err_probe(dev, ret, "Error parsing acpi/of properties\n");
335 
336 	return devm_snd_soc_register_card(dev, card);
337 }
338 
339 static const struct of_device_id loongson_asoc_dt_ids[] = {
340 	/* Loongson-2K1000/Loongson-2K2000/LS7A */
341 	{
342 		.compatible = "loongson,ls-audio-card",
343 		.data = &ls2k1000_card_config
344 	},
345 	{
346 		.compatible = "loongson,ls2k0300-forever-pi-audio-card",
347 		.data = &ls2k0300_forever_pi_card_config
348 	},
349 	{
350 		.compatible = "loongson,ls2k0300-dl2k0300b-audio-card",
351 		.data = &ls2k0300_dl2k0300b_card_config
352 	},
353 	{ /* sentinel */ },
354 };
355 MODULE_DEVICE_TABLE(of, loongson_asoc_dt_ids);
356 
357 static struct platform_driver loongson_audio_driver = {
358 	.probe = loongson_asoc_card_probe,
359 	.driver = {
360 		.name = "loongson-asoc-card",
361 		.pm = &snd_soc_pm_ops,
362 		.of_match_table = loongson_asoc_dt_ids,
363 	},
364 };
365 module_platform_driver(loongson_audio_driver);
366 
367 MODULE_DESCRIPTION("Loongson ASoc Sound Card driver");
368 MODULE_AUTHOR("Loongson Technology Corporation Limited");
369 MODULE_LICENSE("GPL");
370