bytcr_wm5102.c

  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 *  bytcr_wm5102.c - ASoc Machine driver for Intel Baytrail platforms with a
  4 *                   Wolfson Microelectronics WM5102 codec
  5 *
  6 *  Copyright (C) 2020 Hans de Goede <hdegoede@redhat.com>
  7 *  Loosely based on bytcr_rt5640.c which is:
  8 *  Copyright (C) 2014-2020 Intel Corp
  9 *  Author: Subhransu S. Prusty <subhransu.s.prusty@intel.com>
 10 */
 11
 12#include <linux/acpi.h>
 13#include <linux/bitfield.h>
 14#include <linux/clk.h>
 15#include <linux/device.h>
 16#include <linux/init.h>
 17#include <linux/module.h>
 18#include <linux/moduleparam.h>
 19#include <linux/platform_data/x86/soc.h>
 20#include <linux/platform_device.h>
 21#include <linux/slab.h>
 22#include <linux/spi/spi.h>
 23#include <sound/jack.h>
 24#include <sound/pcm.h>
 25#include <sound/pcm_params.h>
 26#include <sound/soc.h>
 27#include <sound/soc-acpi.h>
 28#include "../../codecs/wm5102.h"
 29#include "../atom/sst-atom-controls.h"
 30
 31#define WM5102_MAX_SYSCLK_4K	49152000 /* max sysclk for 4K family */
 32#define WM5102_MAX_SYSCLK_11025	45158400 /* max sysclk for 11.025K family */
 33
 34struct byt_wm5102_private {
 35	struct snd_soc_jack jack;
 36	struct clk *mclk;
 37	struct gpio_desc *spkvdd_en_gpio;
 38	int mclk_freq;
 39};
 40
 41#define BYT_WM5102_IN_MAP		GENMASK(3, 0)
 42#define BYT_WM5102_OUT_MAP		GENMASK(7, 4)
 43#define BYT_WM5102_SSP2			BIT(16)
 44#define BYT_WM5102_MCLK_19_2MHZ		BIT(17)
 45
 46enum {
 47	BYT_WM5102_INTMIC_IN3L_HSMIC_IN1L,
 48	BYT_WM5102_INTMIC_IN1L_HSMIC_IN2L,
 49};
 50
 51/* Note these values are pre-shifted for easy use of setting quirks */
 52enum {
 53	BYT_WM5102_SPK_SPK_MAP		= FIELD_PREP_CONST(BYT_WM5102_OUT_MAP, 0),
 54	BYT_WM5102_SPK_HPOUT2_MAP	= FIELD_PREP_CONST(BYT_WM5102_OUT_MAP, 1),
 55};
 56
 57static unsigned long quirk;
 58
 59static int quirk_override = -1;
 60module_param_named(quirk, quirk_override, int, 0444);
 61MODULE_PARM_DESC(quirk, "Board-specific quirk override");
 62
 63static void log_quirks(struct device *dev)
 64{
 65	switch (quirk & BYT_WM5102_IN_MAP) {
 66	case BYT_WM5102_INTMIC_IN3L_HSMIC_IN1L:
 67		dev_info_once(dev, "quirk INTMIC_IN3L_HSMIC_IN1L enabled\n");
 68		break;
 69	case BYT_WM5102_INTMIC_IN1L_HSMIC_IN2L:
 70		dev_info_once(dev, "quirk INTMIC_IN1L_HSMIC_IN2L enabled\n");
 71		break;
 72	default:
 73		dev_warn_once(dev, "quirk sets invalid input map: 0x%lx, defaulting to INTMIC_IN3L_HSMIC_IN1L\n",
 74			      quirk & BYT_WM5102_IN_MAP);
 75		quirk &= ~BYT_WM5102_IN_MAP;
 76		quirk |= BYT_WM5102_INTMIC_IN3L_HSMIC_IN1L;
 77		break;
 78	}
 79	switch (quirk & BYT_WM5102_OUT_MAP) {
 80	case BYT_WM5102_SPK_SPK_MAP:
 81		dev_info_once(dev, "quirk SPK_SPK_MAP enabled\n");
 82		break;
 83	case BYT_WM5102_SPK_HPOUT2_MAP:
 84		dev_info_once(dev, "quirk SPK_HPOUT2_MAP enabled\n");
 85		break;
 86	default:
 87		dev_warn_once(dev, "quirk sets invalid output map: 0x%lx, defaulting to SPK_SPK_MAP\n",
 88			      quirk & BYT_WM5102_OUT_MAP);
 89		quirk &= ~BYT_WM5102_OUT_MAP;
 90		quirk |= BYT_WM5102_SPK_SPK_MAP;
 91		break;
 92	}
 93	if (quirk & BYT_WM5102_SSP2)
 94		dev_info_once(dev, "quirk SSP2 enabled");
 95	if (quirk & BYT_WM5102_MCLK_19_2MHZ)
 96		dev_info_once(dev, "quirk MCLK 19.2MHz enabled");
 97}
 98
 99static int byt_wm5102_spkvdd_power_event(struct snd_soc_dapm_widget *w,
100	struct snd_kcontrol *kcontrol, int event)
101{
102	struct snd_soc_card *card = snd_soc_dapm_to_card(w->dapm);
103	struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(card);
104
105	gpiod_set_value_cansleep(priv->spkvdd_en_gpio,
106				 !!SND_SOC_DAPM_EVENT_ON(event));
107
108	return 0;
109}
110
111static int byt_wm5102_prepare_and_enable_pll1(struct snd_soc_dai *codec_dai, int rate)
112{
113	struct snd_soc_component *codec_component = codec_dai->component;
114	struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(codec_component->card);
115	int sr_mult = ((rate % 4000) == 0) ?
116		(WM5102_MAX_SYSCLK_4K / rate) :
117		(WM5102_MAX_SYSCLK_11025 / rate);
118	int ret;
119
120	/* Reset FLL1 */
121	snd_soc_dai_set_pll(codec_dai, WM5102_FLL1_REFCLK, ARIZONA_FLL_SRC_NONE, 0, 0);
122	snd_soc_dai_set_pll(codec_dai, WM5102_FLL1, ARIZONA_FLL_SRC_NONE, 0, 0);
123
124	/* Configure the FLL1 PLL before selecting it */
125	ret = snd_soc_dai_set_pll(codec_dai, WM5102_FLL1, ARIZONA_CLK_SRC_MCLK1,
126				  priv->mclk_freq, rate * sr_mult);
127	if (ret) {
128		dev_err(codec_component->dev, "Error setting PLL: %d\n", ret);
129		return ret;
130	}
131
132	ret = snd_soc_component_set_sysclk(codec_component, ARIZONA_CLK_SYSCLK,
133					   ARIZONA_CLK_SRC_FLL1, rate * sr_mult,
134					   SND_SOC_CLOCK_IN);
135	if (ret) {
136		dev_err(codec_component->dev, "Error setting SYSCLK: %d\n", ret);
137		return ret;
138	}
139
140	ret = snd_soc_dai_set_sysclk(codec_dai, ARIZONA_CLK_SYSCLK,
141				     rate * 512, SND_SOC_CLOCK_IN);
142	if (ret) {
143		dev_err(codec_component->dev, "Error setting clock: %d\n", ret);
144		return ret;
145	}
146
147	return 0;
148}
149
150static int platform_clock_control(struct snd_soc_dapm_widget *w,
151				  struct snd_kcontrol *k, int event)
152{
153	struct snd_soc_card *card = snd_soc_dapm_to_card(w->dapm);
154	struct snd_soc_dai *codec_dai;
155	struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(card);
156	int ret;
157
158	codec_dai = snd_soc_card_get_codec_dai(card, "wm5102-aif1");
159	if (!codec_dai) {
160		dev_err(card->dev, "Error codec DAI not found\n");
161		return -EIO;
162	}
163
164	if (SND_SOC_DAPM_EVENT_ON(event)) {
165		ret = clk_prepare_enable(priv->mclk);
166		if (ret) {
167			dev_err(card->dev, "Error enabling MCLK: %d\n", ret);
168			return ret;
169		}
170		ret = byt_wm5102_prepare_and_enable_pll1(codec_dai, 48000);
171		if (ret) {
172			dev_err(card->dev, "Error setting codec sysclk: %d\n", ret);
173			return ret;
174		}
175	} else {
176		/*
177		 * The WM5102 has a separate 32KHz clock for jack-detect
178		 * so we can disable the PLL, followed by disabling the
179		 * platform clock which is the source-clock for the PLL.
180		 */
181		snd_soc_dai_set_pll(codec_dai, WM5102_FLL1, ARIZONA_FLL_SRC_NONE, 0, 0);
182		clk_disable_unprepare(priv->mclk);
183	}
184
185	return 0;
186}
187
188static const struct snd_soc_dapm_widget byt_wm5102_widgets[] = {
189	SND_SOC_DAPM_HP("Headphone", NULL),
190	SND_SOC_DAPM_MIC("Headset Mic", NULL),
191	SND_SOC_DAPM_MIC("Internal Mic", NULL),
192	SND_SOC_DAPM_SPK("Speaker", NULL),
193	SND_SOC_DAPM_LINE("Line Out", NULL),
194	SND_SOC_DAPM_SUPPLY("Platform Clock", SND_SOC_NOPM, 0, 0,
195			    platform_clock_control, SND_SOC_DAPM_PRE_PMU |
196			    SND_SOC_DAPM_POST_PMD),
197	SND_SOC_DAPM_SUPPLY("Speaker VDD", SND_SOC_NOPM, 0, 0,
198			    byt_wm5102_spkvdd_power_event,
199			    SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
200};
201
202static const struct snd_soc_dapm_route byt_wm5102_audio_map[] = {
203	{"Headphone", NULL, "Platform Clock"},
204	{"Headset Mic", NULL, "Platform Clock"},
205	{"Internal Mic", NULL, "Platform Clock"},
206	{"Speaker", NULL, "Platform Clock"},
207	{"Speaker", NULL, "Speaker VDD"},
208
209	{"Headphone", NULL, "HPOUT1L"},
210	{"Headphone", NULL, "HPOUT1R"},
211
212	/*
213	 * The Headset Mix uses MICBIAS1 or 2 depending on if a CTIA/OMTP Headset
214	 * is connected, as the MICBIAS is applied after the CTIA/OMTP cross-switch.
215	 */
216	{"Headset Mic", NULL, "MICBIAS1"},
217	{"Headset Mic", NULL, "MICBIAS2"},
218	{"Internal Mic", NULL, "MICBIAS3"},
219};
220
221static const struct snd_soc_dapm_route bytcr_wm5102_ssp0_map[] = {
222	{"AIF1 Playback", NULL, "ssp0 Tx"},
223	{"ssp0 Tx", NULL, "modem_out"},
224	{"modem_in", NULL, "ssp0 Rx"},
225	{"ssp0 Rx", NULL, "AIF1 Capture"},
226};
227
228static const struct snd_soc_dapm_route bytcr_wm5102_ssp2_map[] = {
229	{"AIF1 Playback", NULL, "ssp2 Tx"},
230	{"ssp2 Tx", NULL, "codec_out0"},
231	{"ssp2 Tx", NULL, "codec_out1"},
232	{"codec_in0", NULL, "ssp2 Rx"},
233	{"codec_in1", NULL, "ssp2 Rx"},
234	{"ssp2 Rx", NULL, "AIF1 Capture"},
235};
236
237static const struct snd_soc_dapm_route byt_wm5102_spk_spk_map[] = {
238	{"Speaker", NULL, "SPKOUTLP"},
239	{"Speaker", NULL, "SPKOUTLN"},
240	{"Speaker", NULL, "SPKOUTRP"},
241	{"Speaker", NULL, "SPKOUTRN"},
242};
243
244static const struct snd_soc_dapm_route byt_wm5102_spk_hpout2_map[] = {
245	{"Speaker", NULL, "HPOUT2L"},
246	{"Speaker", NULL, "HPOUT2R"},
247};
248
249static const struct snd_soc_dapm_route byt_wm5102_intmic_in3l_hsmic_in1l_map[] = {
250	{"IN3L", NULL, "Internal Mic"},
251	{"IN1L", NULL, "Headset Mic"},
252};
253
254static const struct snd_soc_dapm_route byt_wm5102_intmic_in1l_hsmic_in2l_map[] = {
255	{"IN1L", NULL, "Internal Mic"},
256	{"IN2L", NULL, "Headset Mic"},
257};
258
259static const struct snd_kcontrol_new byt_wm5102_controls[] = {
260	SOC_DAPM_PIN_SWITCH("Headphone"),
261	SOC_DAPM_PIN_SWITCH("Headset Mic"),
262	SOC_DAPM_PIN_SWITCH("Internal Mic"),
263	SOC_DAPM_PIN_SWITCH("Speaker"),
264	SOC_DAPM_PIN_SWITCH("Line Out"),
265};
266
267static struct snd_soc_jack_pin byt_wm5102_pins[] = {
268	{
269		.pin	= "Headphone",
270		.mask	= SND_JACK_HEADPHONE,
271	},
272	{
273		.pin	= "Headset Mic",
274		.mask	= SND_JACK_MICROPHONE,
275	},
276	{
277		.pin	= "Line Out",
278		.mask	= SND_JACK_LINEOUT,
279	},
280};
281
282static int byt_wm5102_init(struct snd_soc_pcm_runtime *runtime)
283{
284	struct snd_soc_card *card = runtime->card;
285	struct snd_soc_dapm_context *dapm = snd_soc_card_to_dapm(card);
286	struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(card);
287	struct snd_soc_component *component = snd_soc_rtd_to_codec(runtime, 0)->component;
288	const struct snd_soc_dapm_route *custom_map = NULL;
289	int ret, jack_type, num_routes = 0;
290
291	snd_soc_dapm_set_idle_bias(dapm, false);
292
293	ret = snd_soc_add_card_controls(card, byt_wm5102_controls,
294					ARRAY_SIZE(byt_wm5102_controls));
295	if (ret) {
296		dev_err(card->dev, "Error adding card controls: %d\n", ret);
297		return ret;
298	}
299
300	switch (quirk & BYT_WM5102_IN_MAP) {
301	case BYT_WM5102_INTMIC_IN3L_HSMIC_IN1L:
302		custom_map = byt_wm5102_intmic_in3l_hsmic_in1l_map;
303		num_routes = ARRAY_SIZE(byt_wm5102_intmic_in3l_hsmic_in1l_map);
304		break;
305	case BYT_WM5102_INTMIC_IN1L_HSMIC_IN2L:
306		custom_map = byt_wm5102_intmic_in1l_hsmic_in2l_map;
307		num_routes = ARRAY_SIZE(byt_wm5102_intmic_in1l_hsmic_in2l_map);
308		break;
309	}
310	ret = snd_soc_dapm_add_routes(dapm, custom_map, num_routes);
311	if (ret)
312		return ret;
313
314	switch (quirk & BYT_WM5102_OUT_MAP) {
315	case BYT_WM5102_SPK_SPK_MAP:
316		custom_map = byt_wm5102_spk_spk_map;
317		num_routes = ARRAY_SIZE(byt_wm5102_spk_spk_map);
318		break;
319	case BYT_WM5102_SPK_HPOUT2_MAP:
320		custom_map = byt_wm5102_spk_hpout2_map;
321		num_routes = ARRAY_SIZE(byt_wm5102_spk_hpout2_map);
322		break;
323	}
324	ret = snd_soc_dapm_add_routes(dapm, custom_map, num_routes);
325	if (ret)
326		return ret;
327
328	if (quirk & BYT_WM5102_SSP2) {
329		custom_map = bytcr_wm5102_ssp2_map;
330		num_routes = ARRAY_SIZE(bytcr_wm5102_ssp2_map);
331	} else {
332		custom_map = bytcr_wm5102_ssp0_map;
333		num_routes = ARRAY_SIZE(bytcr_wm5102_ssp0_map);
334	}
335	ret = snd_soc_dapm_add_routes(dapm, custom_map, num_routes);
336	if (ret)
337		return ret;
338
339	if (quirk & BYT_WM5102_MCLK_19_2MHZ)
340		priv->mclk_freq = 19200000;
341	else
342		priv->mclk_freq = 25000000;
343
344	/*
345	 * The firmware might enable the clock at boot (this information
346	 * may or may not be reflected in the enable clock register).
347	 * To change the rate we must disable the clock first to cover these
348	 * cases. Due to common clock framework restrictions that do not allow
349	 * to disable a clock that has not been enabled, we need to enable
350	 * the clock first.
351	 */
352	ret = clk_prepare_enable(priv->mclk);
353	if (!ret)
354		clk_disable_unprepare(priv->mclk);
355
356	ret = clk_set_rate(priv->mclk, priv->mclk_freq);
357	if (ret) {
358		dev_err(card->dev, "Error setting MCLK rate: %d\n", ret);
359		return ret;
360	}
361
362	jack_type = ARIZONA_JACK_MASK | SND_JACK_BTN_0 | SND_JACK_BTN_1 |
363		    SND_JACK_BTN_2 | SND_JACK_BTN_3;
364	ret = snd_soc_card_jack_new_pins(card, "Headset", jack_type,
365					 &priv->jack, byt_wm5102_pins,
366					 ARRAY_SIZE(byt_wm5102_pins));
367	if (ret) {
368		dev_err(card->dev, "Error creating jack: %d\n", ret);
369		return ret;
370	}
371
372	snd_soc_component_set_jack(component, &priv->jack, NULL);
373
374	return 0;
375}
376
377static int byt_wm5102_codec_fixup(struct snd_soc_pcm_runtime *rtd,
378				  struct snd_pcm_hw_params *params)
379{
380	struct snd_interval *rate = hw_param_interval(params,
381						      SNDRV_PCM_HW_PARAM_RATE);
382	struct snd_interval *channels = hw_param_interval(params,
383							  SNDRV_PCM_HW_PARAM_CHANNELS);
384	int ret, bits;
385
386	/* The DSP will convert the FE rate to 48k, stereo */
387	rate->min = 48000;
388	rate->max = 48000;
389	channels->min = 2;
390	channels->max = 2;
391
392	if (quirk & BYT_WM5102_SSP2) {
393		/* set SSP2 to 24-bit */
394		params_set_format(params, SNDRV_PCM_FORMAT_S24_LE);
395		bits = 24;
396	} else {
397		/* set SSP0 to 16-bit */
398		params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
399		bits = 16;
400	}
401
402	/*
403	 * Default mode for SSP configuration is TDM 4 slot, override config
404	 * with explicit setting to I2S 2ch 16-bit. The word length is set with
405	 * dai_set_tdm_slot() since there is no other API exposed
406	 */
407	ret = snd_soc_dai_set_fmt(snd_soc_rtd_to_cpu(rtd, 0),
408				  SND_SOC_DAIFMT_I2S     |
409				  SND_SOC_DAIFMT_NB_NF   |
410				  SND_SOC_DAIFMT_BP_FP);
411	if (ret) {
412		dev_err(rtd->dev, "Error setting format to I2S: %d\n", ret);
413		return ret;
414	}
415
416	ret = snd_soc_dai_set_tdm_slot(snd_soc_rtd_to_cpu(rtd, 0), 0x3, 0x3, 2, bits);
417	if (ret) {
418		dev_err(rtd->dev, "Error setting I2S config: %d\n", ret);
419		return ret;
420	}
421
422	return 0;
423}
424
425static int byt_wm5102_aif1_startup(struct snd_pcm_substream *substream)
426{
427	return snd_pcm_hw_constraint_single(substream->runtime,
428					    SNDRV_PCM_HW_PARAM_RATE, 48000);
429}
430
431static const struct snd_soc_ops byt_wm5102_aif1_ops = {
432	.startup = byt_wm5102_aif1_startup,
433};
434
435SND_SOC_DAILINK_DEF(dummy,
436	DAILINK_COMP_ARRAY(COMP_DUMMY()));
437
438SND_SOC_DAILINK_DEF(media,
439	DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));
440
441SND_SOC_DAILINK_DEF(deepbuffer,
442	DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));
443
444SND_SOC_DAILINK_DEF(ssp0_port,
445	DAILINK_COMP_ARRAY(COMP_CPU("ssp0-port")));
446
447SND_SOC_DAILINK_DEF(ssp0_codec,
448	DAILINK_COMP_ARRAY(COMP_CODEC(
449	/*
450	 * Note there is no need to overwrite the codec-name as is done in
451	 * other bytcr machine drivers, because the codec is a MFD child-dev.
452	 */
453	"wm5102-codec",
454	"wm5102-aif1")));
455
456SND_SOC_DAILINK_DEF(platform,
457	DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));
458
459static struct snd_soc_dai_link byt_wm5102_dais[] = {
460	[MERR_DPCM_AUDIO] = {
461		.name = "Baytrail Audio Port",
462		.stream_name = "Baytrail Audio",
463		.nonatomic = true,
464		.dynamic = 1,
465		.ops = &byt_wm5102_aif1_ops,
466		SND_SOC_DAILINK_REG(media, dummy, platform),
467
468	},
469	[MERR_DPCM_DEEP_BUFFER] = {
470		.name = "Deep-Buffer Audio Port",
471		.stream_name = "Deep-Buffer Audio",
472		.nonatomic = true,
473		.dynamic = 1,
474		.playback_only = 1,
475		.ops = &byt_wm5102_aif1_ops,
476		SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
477	},
478		/* back ends */
479	{
480		/*
481		 * This dailink is updated dynamically to point to SSP0 or SSP2.
482		 * Yet its name is always kept as "SSP2-Codec" because the SOF
483		 * tplg files hardcode "SSP2-Codec" even in byt-foo-ssp0.tplg.
484		 */
485		.name = "SSP2-Codec",
486		.id = 0,
487		.no_pcm = 1,
488		.dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
489						| SND_SOC_DAIFMT_CBC_CFC,
490		.be_hw_params_fixup = byt_wm5102_codec_fixup,
491		.init = byt_wm5102_init,
492		SND_SOC_DAILINK_REG(ssp0_port, ssp0_codec, platform),
493	},
494};
495
496/* use space before codec name to simplify card ID, and simplify driver name */
497#define SOF_CARD_NAME "bytcht wm5102" /* card name will be 'sof-bytcht wm5102' */
498#define SOF_DRIVER_NAME "SOF"
499
500#define CARD_NAME "bytcr-wm5102"
501#define DRIVER_NAME NULL /* card name will be used for driver name */
502
503/* SoC card */
504static struct snd_soc_card byt_wm5102_card = {
505	.owner = THIS_MODULE,
506	.dai_link = byt_wm5102_dais,
507	.num_links = ARRAY_SIZE(byt_wm5102_dais),
508	.dapm_widgets = byt_wm5102_widgets,
509	.num_dapm_widgets = ARRAY_SIZE(byt_wm5102_widgets),
510	.dapm_routes = byt_wm5102_audio_map,
511	.num_dapm_routes = ARRAY_SIZE(byt_wm5102_audio_map),
512	.fully_routed = true,
513};
514
515static char byt_wm5102_components[64]; /* = "cfg-spk:* cfg-int-mic:* cfg-hs-mic:* ..." */
516
517static int snd_byt_wm5102_mc_probe(struct platform_device *pdev)
518{
519	static const char * const out_map_name[] = { "spk", "hpout2" };
520	static const char * const intmic_map_name[] = { "in3l", "in1l" };
521	static const char * const hsmic_map_name[] = { "in1l", "in2l" };
522	char codec_name[SND_ACPI_I2C_ID_LEN];
523	struct device *dev = &pdev->dev;
524	struct byt_wm5102_private *priv;
525	struct snd_soc_acpi_mach *mach;
526	const char *platform_name;
527	struct acpi_device *adev;
528	struct device *codec_dev;
529	int dai_index = 0;
530	bool sof_parent;
531	int i, ret;
532
533	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
534	if (!priv)
535		return -ENOMEM;
536
537	/* Get MCLK */
538	priv->mclk = devm_clk_get(dev, "pmc_plt_clk_3");
539	if (IS_ERR(priv->mclk))
540		return dev_err_probe(dev, PTR_ERR(priv->mclk), "getting pmc_plt_clk_3\n");
541
542	/*
543	 * Get speaker VDD enable GPIO:
544	 * 1. Get codec-device-name
545	 * 2. Get codec-device
546	 * 3. Get GPIO from codec-device
547	 */
548	mach = dev->platform_data;
549	adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
550	if (adev) {
551		snprintf(codec_name, sizeof(codec_name), "spi-%s", acpi_dev_name(adev));
552		acpi_dev_put(adev);
553	} else {
554		/* Special case for when the codec is missing from the DSTD */
555		strscpy(codec_name, "spi-wm5102", sizeof(codec_name));
556	}
557
558	codec_dev = bus_find_device_by_name(&spi_bus_type, NULL, codec_name);
559	if (!codec_dev)
560		return -EPROBE_DEFER;
561
562	/* Note no devm_ here since we call gpiod_get on codec_dev rather then dev */
563	priv->spkvdd_en_gpio = gpiod_get(codec_dev, "wlf,spkvdd-ena", GPIOD_OUT_LOW);
564	put_device(codec_dev);
565
566	if (IS_ERR(priv->spkvdd_en_gpio)) {
567		ret = PTR_ERR(priv->spkvdd_en_gpio);
568		/*
569		 * The spkvdd gpio-lookup is registered by: drivers/mfd/arizona-spi.c,
570		 * so -ENOENT means that arizona-spi hasn't probed yet.
571		 */
572		if (ret == -ENOENT)
573			ret = -EPROBE_DEFER;
574
575		return dev_err_probe(dev, ret, "getting spkvdd-GPIO\n");
576	}
577
578	if (soc_intel_is_cht()) {
579		/*
580		 * CHT always uses SSP2 and 19.2 MHz; and
581		 * the one currently supported CHT design uses HPOUT2 as
582		 * speaker output and has the intmic on IN1L + hsmic on IN2L.
583		 */
584		quirk = BYT_WM5102_SSP2 | BYT_WM5102_MCLK_19_2MHZ |
585			BYT_WM5102_INTMIC_IN1L_HSMIC_IN2L |
586			BYT_WM5102_SPK_HPOUT2_MAP;
587	}
588	if (quirk_override != -1) {
589		dev_info_once(dev, "Overriding quirk 0x%lx => 0x%x\n",
590			      quirk, quirk_override);
591		quirk = quirk_override;
592	}
593	log_quirks(dev);
594
595	snprintf(byt_wm5102_components, sizeof(byt_wm5102_components),
596		 "cfg-spk:%s cfg-intmic:%s cfg-hsmic:%s",
597		 out_map_name[FIELD_GET(BYT_WM5102_OUT_MAP, quirk)],
598		 intmic_map_name[FIELD_GET(BYT_WM5102_IN_MAP, quirk)],
599		 hsmic_map_name[FIELD_GET(BYT_WM5102_IN_MAP, quirk)]);
600	byt_wm5102_card.components = byt_wm5102_components;
601
602	/* find index of codec dai */
603	for (i = 0; i < ARRAY_SIZE(byt_wm5102_dais); i++) {
604		if (byt_wm5102_dais[i].num_codecs &&
605		    !strcmp(byt_wm5102_dais[i].codecs->name,
606			    "wm5102-codec")) {
607			dai_index = i;
608			break;
609		}
610	}
611
612	/* override platform name, if required */
613	byt_wm5102_card.dev = dev;
614	platform_name = mach->mach_params.platform;
615	ret = snd_soc_fixup_dai_links_platform_name(&byt_wm5102_card, platform_name);
616	if (ret)
617		goto out_put_gpio;
618
619	/* override SSP port, if required */
620	if (quirk & BYT_WM5102_SSP2)
621		byt_wm5102_dais[dai_index].cpus->dai_name = "ssp2-port";
622
623	/* set card and driver name and pm-ops */
624	sof_parent = snd_soc_acpi_sof_parent(dev);
625	if (sof_parent) {
626		byt_wm5102_card.name = SOF_CARD_NAME;
627		byt_wm5102_card.driver_name = SOF_DRIVER_NAME;
628		dev->driver->pm = &snd_soc_pm_ops;
629	} else {
630		byt_wm5102_card.name = CARD_NAME;
631		byt_wm5102_card.driver_name = DRIVER_NAME;
632	}
633
634	snd_soc_card_set_drvdata(&byt_wm5102_card, priv);
635	ret = devm_snd_soc_register_card(dev, &byt_wm5102_card);
636	if (ret) {
637		dev_err_probe(dev, ret, "registering card\n");
638		goto out_put_gpio;
639	}
640
641	platform_set_drvdata(pdev, &byt_wm5102_card);
642	return 0;
643
644out_put_gpio:
645	gpiod_put(priv->spkvdd_en_gpio);
646	return ret;
647}
648
649static void snd_byt_wm5102_mc_remove(struct platform_device *pdev)
650{
651	struct snd_soc_card *card = platform_get_drvdata(pdev);
652	struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(card);
653
654	gpiod_put(priv->spkvdd_en_gpio);
655}
656
657static struct platform_driver snd_byt_wm5102_mc_driver = {
658	.driver = {
659		.name = "bytcr_wm5102",
660	},
661	.probe = snd_byt_wm5102_mc_probe,
662	.remove = snd_byt_wm5102_mc_remove,
663};
664
665module_platform_driver(snd_byt_wm5102_mc_driver);
666
667MODULE_DESCRIPTION("ASoC Baytrail with WM5102 codec machine driver");
668MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
669MODULE_LICENSE("GPL v2");
670MODULE_ALIAS("platform:bytcr_wm5102");