1 // SPDX-License-Identifier: GPL-2.0-only
3 * ASoC machine driver for Intel Broadwell platforms with RT5677 codec
5 * Copyright (c) 2014, The Chromium OS Authors. All rights reserved.
8 #include <linux/acpi.h>
9 #include <linux/module.h>
10 #include <linux/platform_device.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/delay.h>
13 #include <sound/core.h>
14 #include <sound/pcm.h>
15 #include <sound/soc.h>
16 #include <sound/pcm_params.h>
17 #include <sound/jack.h>
18 #include <sound/soc-acpi.h>
20 #include "../common/sst-dsp.h"
21 #include "../haswell/sst-haswell-ipc.h"
23 #include "../../codecs/rt5677.h"
25 struct bdw_rt5677_priv {
26 struct gpio_desc *gpio_hp_en;
27 struct snd_soc_component *component;
30 static int bdw_rt5677_event_hp(struct snd_soc_dapm_widget *w,
31 struct snd_kcontrol *k, int event)
33 struct snd_soc_dapm_context *dapm = w->dapm;
34 struct snd_soc_card *card = dapm->card;
35 struct bdw_rt5677_priv *bdw_rt5677 = snd_soc_card_get_drvdata(card);
37 if (SND_SOC_DAPM_EVENT_ON(event))
40 gpiod_set_value_cansleep(bdw_rt5677->gpio_hp_en,
41 SND_SOC_DAPM_EVENT_ON(event));
46 static const struct snd_soc_dapm_widget bdw_rt5677_widgets[] = {
47 SND_SOC_DAPM_HP("Headphone", bdw_rt5677_event_hp),
48 SND_SOC_DAPM_SPK("Speaker", NULL),
49 SND_SOC_DAPM_MIC("Headset Mic", NULL),
50 SND_SOC_DAPM_MIC("Local DMICs", NULL),
51 SND_SOC_DAPM_MIC("Remote DMICs", NULL),
54 static const struct snd_soc_dapm_route bdw_rt5677_map[] = {
56 {"Speaker", NULL, "PDM1L"},
57 {"Speaker", NULL, "PDM1R"},
59 /* Headset jack connectors */
60 {"Headphone", NULL, "LOUT1"},
61 {"Headphone", NULL, "LOUT2"},
62 {"IN1P", NULL, "Headset Mic"},
63 {"IN1N", NULL, "Headset Mic"},
66 * Local DMICs: the two DMICs on the mainboard
67 * Remote DMICs: the two DMICs on the camera module
69 {"DMIC L1", NULL, "Remote DMICs"},
70 {"DMIC R1", NULL, "Remote DMICs"},
71 {"DMIC L2", NULL, "Local DMICs"},
72 {"DMIC R2", NULL, "Local DMICs"},
74 /* CODEC BE connections */
75 {"SSP0 CODEC IN", NULL, "AIF1 Capture"},
76 {"AIF1 Playback", NULL, "SSP0 CODEC OUT"},
77 {"DSP Capture", NULL, "DSP Buffer"},
79 /* DSP Clock Connections */
80 { "DSP Buffer", NULL, "SSP0 CODEC IN" },
81 { "SSP0 CODEC IN", NULL, "DSPTX" },
84 static const struct snd_kcontrol_new bdw_rt5677_controls[] = {
85 SOC_DAPM_PIN_SWITCH("Speaker"),
86 SOC_DAPM_PIN_SWITCH("Headphone"),
87 SOC_DAPM_PIN_SWITCH("Headset Mic"),
88 SOC_DAPM_PIN_SWITCH("Local DMICs"),
89 SOC_DAPM_PIN_SWITCH("Remote DMICs"),
93 static struct snd_soc_jack headphone_jack;
94 static struct snd_soc_jack mic_jack;
96 static struct snd_soc_jack_pin headphone_jack_pin = {
98 .mask = SND_JACK_HEADPHONE,
101 static struct snd_soc_jack_pin mic_jack_pin = {
102 .pin = "Headset Mic",
103 .mask = SND_JACK_MICROPHONE,
106 static struct snd_soc_jack_gpio headphone_jack_gpio = {
108 .report = SND_JACK_HEADPHONE,
109 .debounce_time = 200,
112 static struct snd_soc_jack_gpio mic_jack_gpio = {
113 .name = "mic-present",
114 .report = SND_JACK_MICROPHONE,
115 .debounce_time = 200,
119 /* GPIO indexes defined by ACPI */
121 RT5677_GPIO_PLUG_DET = 0,
122 RT5677_GPIO_MIC_PRESENT_L = 1,
123 RT5677_GPIO_HOTWORD_DET_L = 2,
124 RT5677_GPIO_DSP_INT = 3,
125 RT5677_GPIO_HP_AMP_SHDN_L = 4,
128 static const struct acpi_gpio_params plug_det_gpio = { RT5677_GPIO_PLUG_DET, 0, false };
129 static const struct acpi_gpio_params mic_present_gpio = { RT5677_GPIO_MIC_PRESENT_L, 0, false };
130 static const struct acpi_gpio_params headphone_enable_gpio = { RT5677_GPIO_HP_AMP_SHDN_L, 0, false };
132 static const struct acpi_gpio_mapping bdw_rt5677_gpios[] = {
133 { "plug-det-gpios", &plug_det_gpio, 1 },
134 { "mic-present-gpios", &mic_present_gpio, 1 },
135 { "headphone-enable-gpios", &headphone_enable_gpio, 1 },
139 static int broadwell_ssp0_fixup(struct snd_soc_pcm_runtime *rtd,
140 struct snd_pcm_hw_params *params)
142 struct snd_interval *rate = hw_param_interval(params,
143 SNDRV_PCM_HW_PARAM_RATE);
144 struct snd_interval *channels = hw_param_interval(params,
145 SNDRV_PCM_HW_PARAM_CHANNELS);
147 /* The ADSP will covert the FE rate to 48k, stereo */
148 rate->min = rate->max = 48000;
149 channels->min = channels->max = 2;
151 /* set SSP0 to 16 bit */
152 params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
156 static int bdw_rt5677_hw_params(struct snd_pcm_substream *substream,
157 struct snd_pcm_hw_params *params)
159 struct snd_soc_pcm_runtime *rtd = substream->private_data;
160 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
163 ret = snd_soc_dai_set_sysclk(codec_dai, RT5677_SCLK_S_MCLK, 24576000,
166 dev_err(rtd->dev, "can't set codec sysclk configuration\n");
173 static int bdw_rt5677_dsp_hw_params(struct snd_pcm_substream *substream,
174 struct snd_pcm_hw_params *params)
176 struct snd_soc_pcm_runtime *rtd = substream->private_data;
177 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
180 ret = snd_soc_dai_set_sysclk(codec_dai, RT5677_SCLK_S_PLL1, 24576000,
183 dev_err(rtd->dev, "can't set codec sysclk configuration\n");
186 ret = snd_soc_dai_set_pll(codec_dai, 0, RT5677_PLL1_S_MCLK,
189 dev_err(rtd->dev, "can't set codec pll configuration\n");
196 static const struct snd_soc_ops bdw_rt5677_ops = {
197 .hw_params = bdw_rt5677_hw_params,
200 static const struct snd_soc_ops bdw_rt5677_dsp_ops = {
201 .hw_params = bdw_rt5677_dsp_hw_params,
204 #if !IS_ENABLED(CONFIG_SND_SOC_SOF_BROADWELL)
205 static int bdw_rt5677_rtd_init(struct snd_soc_pcm_runtime *rtd)
207 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
208 struct sst_pdata *pdata = dev_get_platdata(component->dev);
209 struct sst_hsw *broadwell = pdata->dsp;
212 /* Set ADSP SSP port settings */
213 ret = sst_hsw_device_set_config(broadwell, SST_HSW_DEVICE_SSP_0,
214 SST_HSW_DEVICE_MCLK_FREQ_24_MHZ,
215 SST_HSW_DEVICE_CLOCK_MASTER, 9);
217 dev_err(rtd->dev, "error: failed to set device config\n");
225 static const unsigned int channels[] = {
229 static const struct snd_pcm_hw_constraint_list constraints_channels = {
230 .count = ARRAY_SIZE(channels),
235 static int bdw_rt5677_fe_startup(struct snd_pcm_substream *substream)
237 struct snd_pcm_runtime *runtime = substream->runtime;
239 /* Board supports stereo configuration only */
240 runtime->hw.channels_max = 2;
241 return snd_pcm_hw_constraint_list(runtime, 0,
242 SNDRV_PCM_HW_PARAM_CHANNELS,
243 &constraints_channels);
246 static const struct snd_soc_ops bdw_rt5677_fe_ops = {
247 .startup = bdw_rt5677_fe_startup,
250 static int bdw_rt5677_init(struct snd_soc_pcm_runtime *rtd)
252 struct bdw_rt5677_priv *bdw_rt5677 =
253 snd_soc_card_get_drvdata(rtd->card);
254 struct snd_soc_component *component = asoc_rtd_to_codec(rtd, 0)->component;
255 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
258 ret = devm_acpi_dev_add_driver_gpios(component->dev, bdw_rt5677_gpios);
260 dev_warn(component->dev, "Failed to add driver gpios\n");
262 /* Enable codec ASRC function for Stereo DAC/Stereo1 ADC/DMIC/I2S1.
263 * The ASRC clock source is clk_i2s1_asrc.
265 rt5677_sel_asrc_clk_src(component, RT5677_DA_STEREO_FILTER |
266 RT5677_AD_STEREO1_FILTER | RT5677_I2S1_SOURCE,
267 RT5677_CLK_SEL_I2S1_ASRC);
268 /* Enable codec ASRC function for Mono ADC L.
269 * The ASRC clock source is clk_sys2_asrc.
271 rt5677_sel_asrc_clk_src(component, RT5677_AD_MONO_L_FILTER,
272 RT5677_CLK_SEL_SYS2);
274 /* Request rt5677 GPIO for headphone amp control */
275 bdw_rt5677->gpio_hp_en = devm_gpiod_get(component->dev, "headphone-enable",
277 if (IS_ERR(bdw_rt5677->gpio_hp_en)) {
278 dev_err(component->dev, "Can't find HP_AMP_SHDN_L gpio\n");
279 return PTR_ERR(bdw_rt5677->gpio_hp_en);
282 /* Create and initialize headphone jack */
283 if (!snd_soc_card_jack_new(rtd->card, "Headphone Jack",
284 SND_JACK_HEADPHONE, &headphone_jack,
285 &headphone_jack_pin, 1)) {
286 headphone_jack_gpio.gpiod_dev = component->dev;
287 if (snd_soc_jack_add_gpios(&headphone_jack, 1,
288 &headphone_jack_gpio))
289 dev_err(component->dev, "Can't add headphone jack gpio\n");
291 dev_err(component->dev, "Can't create headphone jack\n");
294 /* Create and initialize mic jack */
295 if (!snd_soc_card_jack_new(rtd->card, "Mic Jack",
296 SND_JACK_MICROPHONE, &mic_jack,
298 mic_jack_gpio.gpiod_dev = component->dev;
299 if (snd_soc_jack_add_gpios(&mic_jack, 1, &mic_jack_gpio))
300 dev_err(component->dev, "Can't add mic jack gpio\n");
302 dev_err(component->dev, "Can't create mic jack\n");
304 bdw_rt5677->component = component;
306 snd_soc_dapm_force_enable_pin(dapm, "MICBIAS1");
310 /* broadwell digital audio interface glue - connects codec <--> CPU */
311 SND_SOC_DAILINK_DEF(dummy,
312 DAILINK_COMP_ARRAY(COMP_DUMMY()));
314 SND_SOC_DAILINK_DEF(fe,
315 DAILINK_COMP_ARRAY(COMP_CPU("System Pin")));
317 SND_SOC_DAILINK_DEF(platform,
318 DAILINK_COMP_ARRAY(COMP_PLATFORM("haswell-pcm-audio")));
320 SND_SOC_DAILINK_DEF(be,
321 DAILINK_COMP_ARRAY(COMP_CODEC("i2c-RT5677CE:00", "rt5677-aif1")));
323 #if IS_ENABLED(CONFIG_SND_SOC_SOF_BROADWELL)
324 SND_SOC_DAILINK_DEF(ssp0_port,
325 DAILINK_COMP_ARRAY(COMP_CPU("ssp0-port")));
328 /* Wake on voice interface */
329 SND_SOC_DAILINK_DEFS(dsp,
330 DAILINK_COMP_ARRAY(COMP_CPU("spi-RT5677AA:00")),
331 DAILINK_COMP_ARRAY(COMP_CODEC("i2c-RT5677CE:00", "rt5677-dspbuffer")),
332 DAILINK_COMP_ARRAY(COMP_PLATFORM("spi-RT5677AA:00")));
334 static struct snd_soc_dai_link bdw_rt5677_dais[] = {
335 /* Front End DAI links */
337 .name = "System PCM",
338 .stream_name = "System Playback/Capture",
340 #if !IS_ENABLED(CONFIG_SND_SOC_SOF_BROADWELL)
341 .init = bdw_rt5677_rtd_init,
344 SND_SOC_DPCM_TRIGGER_POST,
345 SND_SOC_DPCM_TRIGGER_POST
349 .ops = &bdw_rt5677_fe_ops,
350 SND_SOC_DAILINK_REG(fe, dummy, platform),
356 .stream_name = "Wake on Voice",
357 .ops = &bdw_rt5677_dsp_ops,
358 SND_SOC_DAILINK_REG(dsp),
361 /* Back End DAI links */
367 .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF |
368 SND_SOC_DAIFMT_CBS_CFS,
369 .ignore_pmdown_time = 1,
370 .be_hw_params_fixup = broadwell_ssp0_fixup,
371 .ops = &bdw_rt5677_ops,
374 .init = bdw_rt5677_init,
375 #if !IS_ENABLED(CONFIG_SND_SOC_SOF_BROADWELL)
376 SND_SOC_DAILINK_REG(dummy, be, dummy),
378 SND_SOC_DAILINK_REG(ssp0_port, be, platform),
383 static int bdw_rt5677_suspend_pre(struct snd_soc_card *card)
385 struct bdw_rt5677_priv *bdw_rt5677 = snd_soc_card_get_drvdata(card);
386 struct snd_soc_dapm_context *dapm;
388 if (bdw_rt5677->component) {
389 dapm = snd_soc_component_get_dapm(bdw_rt5677->component);
390 snd_soc_dapm_disable_pin(dapm, "MICBIAS1");
395 static int bdw_rt5677_resume_post(struct snd_soc_card *card)
397 struct bdw_rt5677_priv *bdw_rt5677 = snd_soc_card_get_drvdata(card);
398 struct snd_soc_dapm_context *dapm;
400 if (bdw_rt5677->component) {
401 dapm = snd_soc_component_get_dapm(bdw_rt5677->component);
402 snd_soc_dapm_force_enable_pin(dapm, "MICBIAS1");
407 /* ASoC machine driver for Broadwell DSP + RT5677 */
408 static struct snd_soc_card bdw_rt5677_card = {
409 .name = "bdw-rt5677",
410 .owner = THIS_MODULE,
411 .dai_link = bdw_rt5677_dais,
412 .num_links = ARRAY_SIZE(bdw_rt5677_dais),
413 .dapm_widgets = bdw_rt5677_widgets,
414 .num_dapm_widgets = ARRAY_SIZE(bdw_rt5677_widgets),
415 .dapm_routes = bdw_rt5677_map,
416 .num_dapm_routes = ARRAY_SIZE(bdw_rt5677_map),
417 .controls = bdw_rt5677_controls,
418 .num_controls = ARRAY_SIZE(bdw_rt5677_controls),
419 .fully_routed = true,
420 .suspend_pre = bdw_rt5677_suspend_pre,
421 .resume_post = bdw_rt5677_resume_post,
424 static int bdw_rt5677_probe(struct platform_device *pdev)
426 struct bdw_rt5677_priv *bdw_rt5677;
427 struct snd_soc_acpi_mach *mach;
430 bdw_rt5677_card.dev = &pdev->dev;
432 /* Allocate driver private struct */
433 bdw_rt5677 = devm_kzalloc(&pdev->dev, sizeof(struct bdw_rt5677_priv),
436 dev_err(&pdev->dev, "Can't allocate bdw_rt5677\n");
440 /* override plaform name, if required */
441 mach = pdev->dev.platform_data;
442 ret = snd_soc_fixup_dai_links_platform_name(&bdw_rt5677_card,
443 mach->mach_params.platform);
447 snd_soc_card_set_drvdata(&bdw_rt5677_card, bdw_rt5677);
449 return devm_snd_soc_register_card(&pdev->dev, &bdw_rt5677_card);
452 static struct platform_driver bdw_rt5677_audio = {
453 .probe = bdw_rt5677_probe,
455 .name = "bdw-rt5677",
459 module_platform_driver(bdw_rt5677_audio)
461 /* Module information */
462 MODULE_AUTHOR("Ben Zhang");
463 MODULE_DESCRIPTION("Intel Broadwell RT5677 machine driver");
464 MODULE_LICENSE("GPL v2");
465 MODULE_ALIAS("platform:bdw-rt5677");