2 * ASoC machine driver for Intel Broadwell platforms with RT5677 codec
4 * Copyright (c) 2014, The Chromium OS Authors. All rights reserved.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 #include <linux/acpi.h>
20 #include <linux/module.h>
21 #include <linux/platform_device.h>
22 #include <linux/gpio/consumer.h>
23 #include <linux/delay.h>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
26 #include <sound/soc.h>
27 #include <sound/pcm_params.h>
28 #include <sound/jack.h>
30 #include "../common/sst-dsp.h"
31 #include "../haswell/sst-haswell-ipc.h"
33 #include "../../codecs/rt5677.h"
35 struct bdw_rt5677_priv {
36 struct gpio_desc *gpio_hp_en;
37 struct snd_soc_component *component;
40 static int bdw_rt5677_event_hp(struct snd_soc_dapm_widget *w,
41 struct snd_kcontrol *k, int event)
43 struct snd_soc_dapm_context *dapm = w->dapm;
44 struct snd_soc_card *card = dapm->card;
45 struct bdw_rt5677_priv *bdw_rt5677 = snd_soc_card_get_drvdata(card);
47 if (SND_SOC_DAPM_EVENT_ON(event))
50 gpiod_set_value_cansleep(bdw_rt5677->gpio_hp_en,
51 SND_SOC_DAPM_EVENT_ON(event));
56 static const struct snd_soc_dapm_widget bdw_rt5677_widgets[] = {
57 SND_SOC_DAPM_HP("Headphone", bdw_rt5677_event_hp),
58 SND_SOC_DAPM_SPK("Speaker", NULL),
59 SND_SOC_DAPM_MIC("Headset Mic", NULL),
60 SND_SOC_DAPM_MIC("Local DMICs", NULL),
61 SND_SOC_DAPM_MIC("Remote DMICs", NULL),
64 static const struct snd_soc_dapm_route bdw_rt5677_map[] = {
66 {"Speaker", NULL, "PDM1L"},
67 {"Speaker", NULL, "PDM1R"},
69 /* Headset jack connectors */
70 {"Headphone", NULL, "LOUT1"},
71 {"Headphone", NULL, "LOUT2"},
72 {"IN1P", NULL, "Headset Mic"},
73 {"IN1N", NULL, "Headset Mic"},
76 * Local DMICs: the two DMICs on the mainboard
77 * Remote DMICs: the two DMICs on the camera module
79 {"DMIC L1", NULL, "Remote DMICs"},
80 {"DMIC R1", NULL, "Remote DMICs"},
81 {"DMIC L2", NULL, "Local DMICs"},
82 {"DMIC R2", NULL, "Local DMICs"},
84 /* CODEC BE connections */
85 {"SSP0 CODEC IN", NULL, "AIF1 Capture"},
86 {"AIF1 Playback", NULL, "SSP0 CODEC OUT"},
89 static const struct snd_kcontrol_new bdw_rt5677_controls[] = {
90 SOC_DAPM_PIN_SWITCH("Speaker"),
91 SOC_DAPM_PIN_SWITCH("Headphone"),
92 SOC_DAPM_PIN_SWITCH("Headset Mic"),
93 SOC_DAPM_PIN_SWITCH("Local DMICs"),
94 SOC_DAPM_PIN_SWITCH("Remote DMICs"),
98 static struct snd_soc_jack headphone_jack;
99 static struct snd_soc_jack mic_jack;
101 static struct snd_soc_jack_pin headphone_jack_pin = {
103 .mask = SND_JACK_HEADPHONE,
106 static struct snd_soc_jack_pin mic_jack_pin = {
107 .pin = "Headset Mic",
108 .mask = SND_JACK_MICROPHONE,
111 static struct snd_soc_jack_gpio headphone_jack_gpio = {
113 .report = SND_JACK_HEADPHONE,
114 .debounce_time = 200,
117 static struct snd_soc_jack_gpio mic_jack_gpio = {
118 .name = "mic-present",
119 .report = SND_JACK_MICROPHONE,
120 .debounce_time = 200,
124 /* GPIO indexes defined by ACPI */
126 RT5677_GPIO_PLUG_DET = 0,
127 RT5677_GPIO_MIC_PRESENT_L = 1,
128 RT5677_GPIO_HOTWORD_DET_L = 2,
129 RT5677_GPIO_DSP_INT = 3,
130 RT5677_GPIO_HP_AMP_SHDN_L = 4,
133 static const struct acpi_gpio_params plug_det_gpio = { RT5677_GPIO_PLUG_DET, 0, false };
134 static const struct acpi_gpio_params mic_present_gpio = { RT5677_GPIO_MIC_PRESENT_L, 0, false };
135 static const struct acpi_gpio_params headphone_enable_gpio = { RT5677_GPIO_HP_AMP_SHDN_L, 0, false };
137 static const struct acpi_gpio_mapping bdw_rt5677_gpios[] = {
138 { "plug-det-gpios", &plug_det_gpio, 1 },
139 { "mic-present-gpios", &mic_present_gpio, 1 },
140 { "headphone-enable-gpios", &headphone_enable_gpio, 1 },
144 static int broadwell_ssp0_fixup(struct snd_soc_pcm_runtime *rtd,
145 struct snd_pcm_hw_params *params)
147 struct snd_interval *rate = hw_param_interval(params,
148 SNDRV_PCM_HW_PARAM_RATE);
149 struct snd_interval *channels = hw_param_interval(params,
150 SNDRV_PCM_HW_PARAM_CHANNELS);
152 /* The ADSP will covert the FE rate to 48k, stereo */
153 rate->min = rate->max = 48000;
154 channels->min = channels->max = 2;
156 /* set SSP0 to 16 bit */
157 params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
161 static int bdw_rt5677_hw_params(struct snd_pcm_substream *substream,
162 struct snd_pcm_hw_params *params)
164 struct snd_soc_pcm_runtime *rtd = substream->private_data;
165 struct snd_soc_dai *codec_dai = rtd->codec_dai;
168 ret = snd_soc_dai_set_sysclk(codec_dai, RT5677_SCLK_S_MCLK, 24576000,
171 dev_err(rtd->dev, "can't set codec sysclk configuration\n");
178 static const struct snd_soc_ops bdw_rt5677_ops = {
179 .hw_params = bdw_rt5677_hw_params,
182 static int bdw_rt5677_rtd_init(struct snd_soc_pcm_runtime *rtd)
184 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, DRV_NAME);
185 struct sst_pdata *pdata = dev_get_platdata(component->dev);
186 struct sst_hsw *broadwell = pdata->dsp;
189 /* Set ADSP SSP port settings */
190 ret = sst_hsw_device_set_config(broadwell, SST_HSW_DEVICE_SSP_0,
191 SST_HSW_DEVICE_MCLK_FREQ_24_MHZ,
192 SST_HSW_DEVICE_CLOCK_MASTER, 9);
194 dev_err(rtd->dev, "error: failed to set device config\n");
201 static int bdw_rt5677_init(struct snd_soc_pcm_runtime *rtd)
203 struct bdw_rt5677_priv *bdw_rt5677 =
204 snd_soc_card_get_drvdata(rtd->card);
205 struct snd_soc_component *component = rtd->codec_dai->component;
206 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
209 ret = devm_acpi_dev_add_driver_gpios(component->dev, bdw_rt5677_gpios);
211 dev_warn(component->dev, "Failed to add driver gpios\n");
213 /* Enable codec ASRC function for Stereo DAC/Stereo1 ADC/DMIC/I2S1.
214 * The ASRC clock source is clk_i2s1_asrc.
216 rt5677_sel_asrc_clk_src(component, RT5677_DA_STEREO_FILTER |
217 RT5677_AD_STEREO1_FILTER | RT5677_I2S1_SOURCE,
218 RT5677_CLK_SEL_I2S1_ASRC);
220 /* Request rt5677 GPIO for headphone amp control */
221 bdw_rt5677->gpio_hp_en = devm_gpiod_get(component->dev, "headphone-enable",
223 if (IS_ERR(bdw_rt5677->gpio_hp_en)) {
224 dev_err(component->dev, "Can't find HP_AMP_SHDN_L gpio\n");
225 return PTR_ERR(bdw_rt5677->gpio_hp_en);
228 /* Create and initialize headphone jack */
229 if (!snd_soc_card_jack_new(rtd->card, "Headphone Jack",
230 SND_JACK_HEADPHONE, &headphone_jack,
231 &headphone_jack_pin, 1)) {
232 headphone_jack_gpio.gpiod_dev = component->dev;
233 if (snd_soc_jack_add_gpios(&headphone_jack, 1,
234 &headphone_jack_gpio))
235 dev_err(component->dev, "Can't add headphone jack gpio\n");
237 dev_err(component->dev, "Can't create headphone jack\n");
240 /* Create and initialize mic jack */
241 if (!snd_soc_card_jack_new(rtd->card, "Mic Jack",
242 SND_JACK_MICROPHONE, &mic_jack,
244 mic_jack_gpio.gpiod_dev = component->dev;
245 if (snd_soc_jack_add_gpios(&mic_jack, 1, &mic_jack_gpio))
246 dev_err(component->dev, "Can't add mic jack gpio\n");
248 dev_err(component->dev, "Can't create mic jack\n");
250 bdw_rt5677->component = component;
252 snd_soc_dapm_force_enable_pin(dapm, "MICBIAS1");
256 /* broadwell digital audio interface glue - connects codec <--> CPU */
257 static struct snd_soc_dai_link bdw_rt5677_dais[] = {
258 /* Front End DAI links */
260 .name = "System PCM",
261 .stream_name = "System Playback/Capture",
262 .cpu_dai_name = "System Pin",
263 .platform_name = "haswell-pcm-audio",
265 .codec_name = "snd-soc-dummy",
266 .codec_dai_name = "snd-soc-dummy-dai",
267 .init = bdw_rt5677_rtd_init,
269 SND_SOC_DPCM_TRIGGER_POST,
270 SND_SOC_DPCM_TRIGGER_POST
276 /* Back End DAI links */
281 .cpu_dai_name = "snd-soc-dummy-dai",
282 .platform_name = "snd-soc-dummy",
284 .codec_name = "i2c-RT5677CE:00",
285 .codec_dai_name = "rt5677-aif1",
286 .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF |
287 SND_SOC_DAIFMT_CBS_CFS,
289 .ignore_pmdown_time = 1,
290 .be_hw_params_fixup = broadwell_ssp0_fixup,
291 .ops = &bdw_rt5677_ops,
294 .init = bdw_rt5677_init,
298 static int bdw_rt5677_suspend_pre(struct snd_soc_card *card)
300 struct bdw_rt5677_priv *bdw_rt5677 = snd_soc_card_get_drvdata(card);
301 struct snd_soc_dapm_context *dapm;
303 if (bdw_rt5677->component) {
304 dapm = snd_soc_component_get_dapm(bdw_rt5677->component);
305 snd_soc_dapm_disable_pin(dapm, "MICBIAS1");
310 static int bdw_rt5677_resume_post(struct snd_soc_card *card)
312 struct bdw_rt5677_priv *bdw_rt5677 = snd_soc_card_get_drvdata(card);
313 struct snd_soc_dapm_context *dapm;
315 if (bdw_rt5677->component) {
316 dapm = snd_soc_component_get_dapm(bdw_rt5677->component);
317 snd_soc_dapm_force_enable_pin(dapm, "MICBIAS1");
322 /* ASoC machine driver for Broadwell DSP + RT5677 */
323 static struct snd_soc_card bdw_rt5677_card = {
324 .name = "bdw-rt5677",
325 .owner = THIS_MODULE,
326 .dai_link = bdw_rt5677_dais,
327 .num_links = ARRAY_SIZE(bdw_rt5677_dais),
328 .dapm_widgets = bdw_rt5677_widgets,
329 .num_dapm_widgets = ARRAY_SIZE(bdw_rt5677_widgets),
330 .dapm_routes = bdw_rt5677_map,
331 .num_dapm_routes = ARRAY_SIZE(bdw_rt5677_map),
332 .controls = bdw_rt5677_controls,
333 .num_controls = ARRAY_SIZE(bdw_rt5677_controls),
334 .fully_routed = true,
335 .suspend_pre = bdw_rt5677_suspend_pre,
336 .resume_post = bdw_rt5677_resume_post,
339 static int bdw_rt5677_probe(struct platform_device *pdev)
341 struct bdw_rt5677_priv *bdw_rt5677;
343 bdw_rt5677_card.dev = &pdev->dev;
345 /* Allocate driver private struct */
346 bdw_rt5677 = devm_kzalloc(&pdev->dev, sizeof(struct bdw_rt5677_priv),
349 dev_err(&pdev->dev, "Can't allocate bdw_rt5677\n");
353 snd_soc_card_set_drvdata(&bdw_rt5677_card, bdw_rt5677);
355 return devm_snd_soc_register_card(&pdev->dev, &bdw_rt5677_card);
358 static struct platform_driver bdw_rt5677_audio = {
359 .probe = bdw_rt5677_probe,
361 .name = "bdw-rt5677",
365 module_platform_driver(bdw_rt5677_audio)
367 /* Module information */
368 MODULE_AUTHOR("Ben Zhang");
369 MODULE_DESCRIPTION("Intel Broadwell RT5677 machine driver");
370 MODULE_LICENSE("GPL v2");
371 MODULE_ALIAS("platform:bdw-rt5677");