1 // SPDX-License-Identifier: GPL-2.0-only
2 // Copyright (c) 2018-2020, Intel Corporation
3 //
4 // sof-wm8804.c - ASoC machine driver for Up and Up2 board
5 // based on WM8804/Hifiberry Digi+
6
7
8 #include <linux/acpi.h>
9 #include <linux/dmi.h>
10 #include <linux/gpio/consumer.h>
11 #include <linux/gpio/machine.h>
12 #include <linux/module.h>
13 #include <linux/platform_device.h>
14 #include <linux/slab.h>
15 #include <sound/pcm.h>
16 #include <sound/pcm_params.h>
17 #include <sound/soc.h>
18 #include <sound/soc-acpi.h>
19 #include "../../codecs/wm8804.h"
20
21 struct sof_card_private {
22 struct gpio_desc *gpio_44;
23 struct gpio_desc *gpio_48;
24 int sample_rate;
25 };
26
27 #define SOF_WM8804_UP2_QUIRK BIT(0)
28
29 static unsigned long sof_wm8804_quirk;
30
sof_wm8804_quirk_cb(const struct dmi_system_id * id)31 static int sof_wm8804_quirk_cb(const struct dmi_system_id *id)
32 {
33 sof_wm8804_quirk = (unsigned long)id->driver_data;
34 return 1;
35 }
36
37 static const struct dmi_system_id sof_wm8804_quirk_table[] = {
38 {
39 .callback = sof_wm8804_quirk_cb,
40 .matches = {
41 DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
42 DMI_MATCH(DMI_PRODUCT_NAME, "UP-APL01"),
43 },
44 .driver_data = (void *)SOF_WM8804_UP2_QUIRK,
45 },
46 {}
47 };
48
sof_wm8804_hw_params(struct snd_pcm_substream * substream,struct snd_pcm_hw_params * params)49 static int sof_wm8804_hw_params(struct snd_pcm_substream *substream,
50 struct snd_pcm_hw_params *params)
51 {
52 struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
53 struct sof_card_private *ctx = snd_soc_card_get_drvdata(rtd->card);
54 struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
55 struct snd_soc_component *codec = codec_dai->component;
56 const int sysclk = 27000000; /* This is fixed on this board */
57 int samplerate;
58 long mclk_freq;
59 int mclk_div;
60 int sampling_freq;
61 bool clk_44;
62 int ret;
63
64 samplerate = params_rate(params);
65 if (samplerate == ctx->sample_rate)
66 return 0;
67
68 ctx->sample_rate = 0;
69
70 if (samplerate <= 96000) {
71 mclk_freq = samplerate * 256;
72 mclk_div = WM8804_MCLKDIV_256FS;
73 } else {
74 mclk_freq = samplerate * 128;
75 mclk_div = WM8804_MCLKDIV_128FS;
76 }
77
78 switch (samplerate) {
79 case 32000:
80 sampling_freq = 0x03;
81 break;
82 case 44100:
83 sampling_freq = 0x00;
84 break;
85 case 48000:
86 sampling_freq = 0x02;
87 break;
88 case 88200:
89 sampling_freq = 0x08;
90 break;
91 case 96000:
92 sampling_freq = 0x0a;
93 break;
94 case 176400:
95 sampling_freq = 0x0c;
96 break;
97 case 192000:
98 sampling_freq = 0x0e;
99 break;
100 default:
101 dev_err(rtd->card->dev,
102 "unsupported samplerate %d\n", samplerate);
103 return -EINVAL;
104 }
105
106 if (samplerate % 16000)
107 clk_44 = true; /* use 44.1 kHz root frequency */
108 else
109 clk_44 = false;
110
111 if (!(IS_ERR_OR_NULL(ctx->gpio_44) ||
112 IS_ERR_OR_NULL(ctx->gpio_48))) {
113 /*
114 * ensure both GPIOs are LOW first, then drive the
115 * relevant one to HIGH
116 */
117 if (clk_44) {
118 gpiod_set_value_cansleep(ctx->gpio_48, !clk_44);
119 gpiod_set_value_cansleep(ctx->gpio_44, clk_44);
120 } else {
121 gpiod_set_value_cansleep(ctx->gpio_44, clk_44);
122 gpiod_set_value_cansleep(ctx->gpio_48, !clk_44);
123 }
124 }
125
126 snd_soc_dai_set_clkdiv(codec_dai, WM8804_MCLK_DIV, mclk_div);
127 ret = snd_soc_dai_set_pll(codec_dai, 0, 0, sysclk, mclk_freq);
128 if (ret < 0) {
129 dev_err(rtd->card->dev, "Failed to set WM8804 PLL\n");
130 return ret;
131 }
132
133 ret = snd_soc_dai_set_sysclk(codec_dai, WM8804_TX_CLKSRC_PLL,
134 sysclk, SND_SOC_CLOCK_OUT);
135 if (ret < 0) {
136 dev_err(rtd->card->dev,
137 "Failed to set WM8804 SYSCLK: %d\n", ret);
138 return ret;
139 }
140
141 /* set sampling frequency status bits */
142 snd_soc_component_update_bits(codec, WM8804_SPDTX4, 0x0f,
143 sampling_freq);
144
145 ctx->sample_rate = samplerate;
146
147 return 0;
148 }
149
150 /* machine stream operations */
151 static const struct snd_soc_ops sof_wm8804_ops = {
152 .hw_params = sof_wm8804_hw_params,
153 };
154
155 SND_SOC_DAILINK_DEF(ssp5_pin,
156 DAILINK_COMP_ARRAY(COMP_CPU("SSP5 Pin")));
157
158 SND_SOC_DAILINK_DEF(ssp5_codec,
159 DAILINK_COMP_ARRAY(COMP_CODEC("i2c-1AEC8804:00", "wm8804-spdif")));
160
161 SND_SOC_DAILINK_DEF(platform,
162 DAILINK_COMP_ARRAY(COMP_PLATFORM("0000:00:0e.0")));
163
164 static struct snd_soc_dai_link dailink[] = {
165 /* back ends */
166 {
167 .name = "SSP5-Codec",
168 .id = 0,
169 .no_pcm = 1,
170 .ops = &sof_wm8804_ops,
171 SND_SOC_DAILINK_REG(ssp5_pin, ssp5_codec, platform),
172 },
173 };
174
175 /* SoC card */
176 static struct snd_soc_card sof_wm8804_card = {
177 .name = "wm8804", /* sof- prefix added automatically */
178 .owner = THIS_MODULE,
179 .dai_link = dailink,
180 .num_links = ARRAY_SIZE(dailink),
181 };
182
183 /* i2c-<HID>:00 with HID being 8 chars */
184 static char codec_name[SND_ACPI_I2C_ID_LEN];
185
186 /*
187 * to control the HifiBerry Digi+ PRO, it's required to toggle GPIO to
188 * select the clock source. On the Up2 board, this means
189 * Pin29/BCM5/Linux GPIO 430 and Pin 31/BCM6/ Linux GPIO 404.
190 *
191 * Using the ACPI device name is not very nice, but since we only use
192 * the value for the Up2 board there is no risk of conflict with other
193 * platforms.
194 */
195
196 static struct gpiod_lookup_table up2_gpios_table = {
197 /* .dev_id is set during probe */
198 .table = {
199 GPIO_LOOKUP("INT3452:01", 73, "BCM-GPIO5", GPIO_ACTIVE_HIGH),
200 GPIO_LOOKUP("INT3452:01", 74, "BCM-GPIO6", GPIO_ACTIVE_HIGH),
201 { },
202 },
203 };
204
sof_wm8804_probe(struct platform_device * pdev)205 static int sof_wm8804_probe(struct platform_device *pdev)
206 {
207 struct snd_soc_card *card;
208 struct snd_soc_acpi_mach *mach;
209 struct sof_card_private *ctx;
210 struct acpi_device *adev;
211 int dai_index = 0;
212 int ret;
213 int i;
214
215 ctx = devm_kzalloc(&pdev->dev, sizeof(*ctx), GFP_KERNEL);
216 if (!ctx)
217 return -ENOMEM;
218
219 mach = pdev->dev.platform_data;
220 card = &sof_wm8804_card;
221 card->dev = &pdev->dev;
222
223 dmi_check_system(sof_wm8804_quirk_table);
224
225 if (sof_wm8804_quirk & SOF_WM8804_UP2_QUIRK) {
226 up2_gpios_table.dev_id = dev_name(&pdev->dev);
227 gpiod_add_lookup_table(&up2_gpios_table);
228
229 /*
230 * The gpios are required for specific boards with
231 * local oscillators, and optional in other cases.
232 * Since we can't identify when they are needed, use
233 * the GPIO as non-optional
234 */
235
236 ctx->gpio_44 = devm_gpiod_get(&pdev->dev, "BCM-GPIO5",
237 GPIOD_OUT_LOW);
238 if (IS_ERR(ctx->gpio_44)) {
239 ret = PTR_ERR(ctx->gpio_44);
240 dev_err(&pdev->dev,
241 "could not get BCM-GPIO5: %d\n",
242 ret);
243 return ret;
244 }
245
246 ctx->gpio_48 = devm_gpiod_get(&pdev->dev, "BCM-GPIO6",
247 GPIOD_OUT_LOW);
248 if (IS_ERR(ctx->gpio_48)) {
249 ret = PTR_ERR(ctx->gpio_48);
250 dev_err(&pdev->dev,
251 "could not get BCM-GPIO6: %d\n",
252 ret);
253 return ret;
254 }
255 }
256
257 /* fix index of codec dai */
258 for (i = 0; i < ARRAY_SIZE(dailink); i++) {
259 if (!strcmp(dailink[i].codecs->name, "i2c-1AEC8804:00")) {
260 dai_index = i;
261 break;
262 }
263 }
264
265 /* fixup codec name based on HID */
266 adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
267 if (adev) {
268 snprintf(codec_name, sizeof(codec_name),
269 "%s%s", "i2c-", acpi_dev_name(adev));
270 dailink[dai_index].codecs->name = codec_name;
271 } else {
272 dev_err(&pdev->dev, "Error cannot find '%s' dev\n", mach->id);
273 return -ENOENT;
274 }
275
276 acpi_dev_put(adev);
277
278 snd_soc_card_set_drvdata(card, ctx);
279
280 return devm_snd_soc_register_card(&pdev->dev, card);
281 }
282
sof_wm8804_remove(struct platform_device * pdev)283 static void sof_wm8804_remove(struct platform_device *pdev)
284 {
285 if (sof_wm8804_quirk & SOF_WM8804_UP2_QUIRK)
286 gpiod_remove_lookup_table(&up2_gpios_table);
287 }
288
289 static struct platform_driver sof_wm8804_driver = {
290 .driver = {
291 .name = "sof-wm8804",
292 .pm = &snd_soc_pm_ops,
293 },
294 .probe = sof_wm8804_probe,
295 .remove = sof_wm8804_remove,
296 };
297 module_platform_driver(sof_wm8804_driver);
298
299 MODULE_DESCRIPTION("ASoC Intel(R) SOF + WM8804 Machine driver");
300 MODULE_AUTHOR("Pierre-Louis Bossart");
301 MODULE_LICENSE("GPL v2");
302 MODULE_ALIAS("platform:sof-wm8804");
303