xref: /OK3568_Linux_fs/kernel/sound/soc/codecs/wm8524.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * wm8524.c  --  WM8524 ALSA SoC Audio driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright 2009 Wolfson Microelectronics plc
6*4882a593Smuzhiyun  * Copyright 2017 NXP
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * Based on WM8523 ALSA SoC Audio driver written by Mark Brown
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/module.h>
12*4882a593Smuzhiyun #include <linux/moduleparam.h>
13*4882a593Smuzhiyun #include <linux/init.h>
14*4882a593Smuzhiyun #include <linux/delay.h>
15*4882a593Smuzhiyun #include <linux/slab.h>
16*4882a593Smuzhiyun #include <linux/gpio/consumer.h>
17*4882a593Smuzhiyun #include <linux/of_device.h>
18*4882a593Smuzhiyun #include <sound/core.h>
19*4882a593Smuzhiyun #include <sound/pcm.h>
20*4882a593Smuzhiyun #include <sound/pcm_params.h>
21*4882a593Smuzhiyun #include <sound/soc.h>
22*4882a593Smuzhiyun #include <sound/initval.h>
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #define WM8524_NUM_RATES 7
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun /* codec private data */
27*4882a593Smuzhiyun struct wm8524_priv {
28*4882a593Smuzhiyun 	struct gpio_desc *mute;
29*4882a593Smuzhiyun 	unsigned int sysclk;
30*4882a593Smuzhiyun 	unsigned int rate_constraint_list[WM8524_NUM_RATES];
31*4882a593Smuzhiyun 	struct snd_pcm_hw_constraint_list rate_constraint;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun static const struct snd_soc_dapm_widget wm8524_dapm_widgets[] = {
36*4882a593Smuzhiyun SND_SOC_DAPM_DAC("DAC", "Playback", SND_SOC_NOPM, 0, 0),
37*4882a593Smuzhiyun SND_SOC_DAPM_OUTPUT("LINEVOUTL"),
38*4882a593Smuzhiyun SND_SOC_DAPM_OUTPUT("LINEVOUTR"),
39*4882a593Smuzhiyun };
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun static const struct snd_soc_dapm_route wm8524_dapm_routes[] = {
42*4882a593Smuzhiyun 	{ "LINEVOUTL", NULL, "DAC" },
43*4882a593Smuzhiyun 	{ "LINEVOUTR", NULL, "DAC" },
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun static const struct {
47*4882a593Smuzhiyun 	int value;
48*4882a593Smuzhiyun 	int ratio;
49*4882a593Smuzhiyun } lrclk_ratios[WM8524_NUM_RATES] = {
50*4882a593Smuzhiyun 	{ 1, 128 },
51*4882a593Smuzhiyun 	{ 2, 192 },
52*4882a593Smuzhiyun 	{ 3, 256 },
53*4882a593Smuzhiyun 	{ 4, 384 },
54*4882a593Smuzhiyun 	{ 5, 512 },
55*4882a593Smuzhiyun 	{ 6, 768 },
56*4882a593Smuzhiyun 	{ 7, 1152 },
57*4882a593Smuzhiyun };
58*4882a593Smuzhiyun 
wm8524_startup(struct snd_pcm_substream * substream,struct snd_soc_dai * dai)59*4882a593Smuzhiyun static int wm8524_startup(struct snd_pcm_substream *substream,
60*4882a593Smuzhiyun 			  struct snd_soc_dai *dai)
61*4882a593Smuzhiyun {
62*4882a593Smuzhiyun 	struct snd_soc_component *component = dai->component;
63*4882a593Smuzhiyun 	struct wm8524_priv *wm8524 = snd_soc_component_get_drvdata(component);
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	/* The set of sample rates that can be supported depends on the
66*4882a593Smuzhiyun 	 * MCLK supplied to the CODEC - enforce this.
67*4882a593Smuzhiyun 	 */
68*4882a593Smuzhiyun 	if (!wm8524->sysclk) {
69*4882a593Smuzhiyun 		dev_err(component->dev,
70*4882a593Smuzhiyun 			"No MCLK configured, call set_sysclk() on init\n");
71*4882a593Smuzhiyun 		return -EINVAL;
72*4882a593Smuzhiyun 	}
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	snd_pcm_hw_constraint_list(substream->runtime, 0,
75*4882a593Smuzhiyun 				   SNDRV_PCM_HW_PARAM_RATE,
76*4882a593Smuzhiyun 				   &wm8524->rate_constraint);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	gpiod_set_value_cansleep(wm8524->mute, 1);
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun 	return 0;
81*4882a593Smuzhiyun }
82*4882a593Smuzhiyun 
wm8524_shutdown(struct snd_pcm_substream * substream,struct snd_soc_dai * dai)83*4882a593Smuzhiyun static void wm8524_shutdown(struct snd_pcm_substream *substream,
84*4882a593Smuzhiyun 			  struct snd_soc_dai *dai)
85*4882a593Smuzhiyun {
86*4882a593Smuzhiyun 	struct snd_soc_component *component = dai->component;
87*4882a593Smuzhiyun 	struct wm8524_priv *wm8524 = snd_soc_component_get_drvdata(component);
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun 	gpiod_set_value_cansleep(wm8524->mute, 0);
90*4882a593Smuzhiyun }
91*4882a593Smuzhiyun 
wm8524_set_dai_sysclk(struct snd_soc_dai * codec_dai,int clk_id,unsigned int freq,int dir)92*4882a593Smuzhiyun static int wm8524_set_dai_sysclk(struct snd_soc_dai *codec_dai,
93*4882a593Smuzhiyun 		int clk_id, unsigned int freq, int dir)
94*4882a593Smuzhiyun {
95*4882a593Smuzhiyun 	struct snd_soc_component *component = codec_dai->component;
96*4882a593Smuzhiyun 	struct wm8524_priv *wm8524 = snd_soc_component_get_drvdata(component);
97*4882a593Smuzhiyun 	unsigned int val;
98*4882a593Smuzhiyun 	int i, j = 0;
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	wm8524->sysclk = freq;
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 	wm8524->rate_constraint.count = 0;
103*4882a593Smuzhiyun 	for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
104*4882a593Smuzhiyun 		val = freq / lrclk_ratios[i].ratio;
105*4882a593Smuzhiyun 		/* Check that it's a standard rate since core can't
106*4882a593Smuzhiyun 		 * cope with others and having the odd rates confuses
107*4882a593Smuzhiyun 		 * constraint matching.
108*4882a593Smuzhiyun 		 */
109*4882a593Smuzhiyun 		switch (val) {
110*4882a593Smuzhiyun 		case 8000:
111*4882a593Smuzhiyun 		case 32000:
112*4882a593Smuzhiyun 		case 44100:
113*4882a593Smuzhiyun 		case 48000:
114*4882a593Smuzhiyun 		case 88200:
115*4882a593Smuzhiyun 		case 96000:
116*4882a593Smuzhiyun 		case 176400:
117*4882a593Smuzhiyun 		case 192000:
118*4882a593Smuzhiyun 			dev_dbg(component->dev, "Supported sample rate: %dHz\n",
119*4882a593Smuzhiyun 				val);
120*4882a593Smuzhiyun 			wm8524->rate_constraint_list[j++] = val;
121*4882a593Smuzhiyun 			wm8524->rate_constraint.count++;
122*4882a593Smuzhiyun 			break;
123*4882a593Smuzhiyun 		default:
124*4882a593Smuzhiyun 			dev_dbg(component->dev, "Skipping sample rate: %dHz\n",
125*4882a593Smuzhiyun 				val);
126*4882a593Smuzhiyun 		}
127*4882a593Smuzhiyun 	}
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 	/* Need at least one supported rate... */
130*4882a593Smuzhiyun 	if (wm8524->rate_constraint.count == 0)
131*4882a593Smuzhiyun 		return -EINVAL;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	return 0;
134*4882a593Smuzhiyun }
135*4882a593Smuzhiyun 
wm8524_set_fmt(struct snd_soc_dai * codec_dai,unsigned int fmt)136*4882a593Smuzhiyun static int wm8524_set_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
137*4882a593Smuzhiyun {
138*4882a593Smuzhiyun 	fmt &= (SND_SOC_DAIFMT_FORMAT_MASK | SND_SOC_DAIFMT_INV_MASK |
139*4882a593Smuzhiyun 		SND_SOC_DAIFMT_MASTER_MASK);
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 	if (fmt != (SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF |
142*4882a593Smuzhiyun 		    SND_SOC_DAIFMT_CBS_CFS)) {
143*4882a593Smuzhiyun 		dev_err(codec_dai->dev, "Invalid DAI format\n");
144*4882a593Smuzhiyun 		return -EINVAL;
145*4882a593Smuzhiyun 	}
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 	return 0;
148*4882a593Smuzhiyun }
149*4882a593Smuzhiyun 
wm8524_mute_stream(struct snd_soc_dai * dai,int mute,int stream)150*4882a593Smuzhiyun static int wm8524_mute_stream(struct snd_soc_dai *dai, int mute, int stream)
151*4882a593Smuzhiyun {
152*4882a593Smuzhiyun 	struct wm8524_priv *wm8524 = snd_soc_component_get_drvdata(dai->component);
153*4882a593Smuzhiyun 
154*4882a593Smuzhiyun 	if (wm8524->mute)
155*4882a593Smuzhiyun 		gpiod_set_value_cansleep(wm8524->mute, mute);
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun 	return 0;
158*4882a593Smuzhiyun }
159*4882a593Smuzhiyun 
160*4882a593Smuzhiyun #define WM8524_RATES SNDRV_PCM_RATE_8000_192000
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun #define WM8524_FORMATS (SNDRV_PCM_FMTBIT_S16_LE |\
163*4882a593Smuzhiyun 			SNDRV_PCM_FMTBIT_S24_LE |\
164*4882a593Smuzhiyun 			SNDRV_PCM_FMTBIT_S32_LE)
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun static const struct snd_soc_dai_ops wm8524_dai_ops = {
167*4882a593Smuzhiyun 	.startup	= wm8524_startup,
168*4882a593Smuzhiyun 	.shutdown	= wm8524_shutdown,
169*4882a593Smuzhiyun 	.set_sysclk	= wm8524_set_dai_sysclk,
170*4882a593Smuzhiyun 	.set_fmt	= wm8524_set_fmt,
171*4882a593Smuzhiyun 	.mute_stream	= wm8524_mute_stream,
172*4882a593Smuzhiyun };
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun static struct snd_soc_dai_driver wm8524_dai = {
175*4882a593Smuzhiyun 	.name = "wm8524-hifi",
176*4882a593Smuzhiyun 	.playback = {
177*4882a593Smuzhiyun 		.stream_name = "Playback",
178*4882a593Smuzhiyun 		.channels_min = 2,
179*4882a593Smuzhiyun 		.channels_max = 2,
180*4882a593Smuzhiyun 		.rates = WM8524_RATES,
181*4882a593Smuzhiyun 		.formats = WM8524_FORMATS,
182*4882a593Smuzhiyun 	},
183*4882a593Smuzhiyun 	.ops = &wm8524_dai_ops,
184*4882a593Smuzhiyun };
185*4882a593Smuzhiyun 
wm8524_probe(struct snd_soc_component * component)186*4882a593Smuzhiyun static int wm8524_probe(struct snd_soc_component *component)
187*4882a593Smuzhiyun {
188*4882a593Smuzhiyun 	struct wm8524_priv *wm8524 = snd_soc_component_get_drvdata(component);
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun 	wm8524->rate_constraint.list = &wm8524->rate_constraint_list[0];
191*4882a593Smuzhiyun 	wm8524->rate_constraint.count =
192*4882a593Smuzhiyun 		ARRAY_SIZE(wm8524->rate_constraint_list);
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun 	return 0;
195*4882a593Smuzhiyun }
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun static const struct snd_soc_component_driver soc_component_dev_wm8524 = {
198*4882a593Smuzhiyun 	.probe			= wm8524_probe,
199*4882a593Smuzhiyun 	.dapm_widgets		= wm8524_dapm_widgets,
200*4882a593Smuzhiyun 	.num_dapm_widgets	= ARRAY_SIZE(wm8524_dapm_widgets),
201*4882a593Smuzhiyun 	.dapm_routes		= wm8524_dapm_routes,
202*4882a593Smuzhiyun 	.num_dapm_routes	= ARRAY_SIZE(wm8524_dapm_routes),
203*4882a593Smuzhiyun 	.idle_bias_on		= 1,
204*4882a593Smuzhiyun 	.use_pmdown_time	= 1,
205*4882a593Smuzhiyun 	.endianness		= 1,
206*4882a593Smuzhiyun 	.non_legacy_dai_naming	= 1,
207*4882a593Smuzhiyun };
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun static const struct of_device_id wm8524_of_match[] = {
210*4882a593Smuzhiyun 	{ .compatible = "wlf,wm8524" },
211*4882a593Smuzhiyun 	{ /* sentinel*/ }
212*4882a593Smuzhiyun };
213*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, wm8524_of_match);
214*4882a593Smuzhiyun 
wm8524_codec_probe(struct platform_device * pdev)215*4882a593Smuzhiyun static int wm8524_codec_probe(struct platform_device *pdev)
216*4882a593Smuzhiyun {
217*4882a593Smuzhiyun 	struct wm8524_priv *wm8524;
218*4882a593Smuzhiyun 	int ret;
219*4882a593Smuzhiyun 
220*4882a593Smuzhiyun 	wm8524 = devm_kzalloc(&pdev->dev, sizeof(struct wm8524_priv),
221*4882a593Smuzhiyun 						  GFP_KERNEL);
222*4882a593Smuzhiyun 	if (wm8524 == NULL)
223*4882a593Smuzhiyun 		return -ENOMEM;
224*4882a593Smuzhiyun 
225*4882a593Smuzhiyun 	platform_set_drvdata(pdev, wm8524);
226*4882a593Smuzhiyun 
227*4882a593Smuzhiyun 	wm8524->mute = devm_gpiod_get(&pdev->dev, "wlf,mute", GPIOD_OUT_LOW);
228*4882a593Smuzhiyun 	if (IS_ERR(wm8524->mute)) {
229*4882a593Smuzhiyun 		ret = PTR_ERR(wm8524->mute);
230*4882a593Smuzhiyun 		dev_err(&pdev->dev, "Failed to get mute line: %d\n", ret);
231*4882a593Smuzhiyun 		return ret;
232*4882a593Smuzhiyun 	}
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun 	ret = devm_snd_soc_register_component(&pdev->dev,
235*4882a593Smuzhiyun 			&soc_component_dev_wm8524, &wm8524_dai, 1);
236*4882a593Smuzhiyun 	if (ret < 0)
237*4882a593Smuzhiyun 		dev_err(&pdev->dev, "Failed to register component: %d\n", ret);
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 	return ret;
240*4882a593Smuzhiyun }
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun static struct platform_driver wm8524_codec_driver = {
243*4882a593Smuzhiyun 	.probe		= wm8524_codec_probe,
244*4882a593Smuzhiyun 	.driver		= {
245*4882a593Smuzhiyun 		.name	= "wm8524-codec",
246*4882a593Smuzhiyun 		.of_match_table = wm8524_of_match,
247*4882a593Smuzhiyun 	},
248*4882a593Smuzhiyun };
249*4882a593Smuzhiyun module_platform_driver(wm8524_codec_driver);
250*4882a593Smuzhiyun 
251*4882a593Smuzhiyun MODULE_DESCRIPTION("ASoC WM8524 driver");
252*4882a593Smuzhiyun MODULE_AUTHOR("Mihai Serban <mihai.serban@nxp.com>");
253*4882a593Smuzhiyun MODULE_ALIAS("platform:wm8524-codec");
254*4882a593Smuzhiyun MODULE_LICENSE("GPL");
255