xref: /openbmc/linux/sound/soc/tegra/tegra_wm8903.c (revision 3419ae78)
1 /*
2  * tegra_wm8903.c - Tegra machine ASoC driver for boards using WM8903 codec.
3  *
4  * Author: Stephen Warren <swarren@nvidia.com>
5  * Copyright (C) 2010-2012 - NVIDIA, Inc.
6  *
7  * Based on code copyright/by:
8  *
9  * (c) 2009, 2010 Nvidia Graphics Pvt. Ltd.
10  *
11  * Copyright 2007 Wolfson Microelectronics PLC.
12  * Author: Graeme Gregory
13  *         graeme.gregory@wolfsonmicro.com or linux@wolfsonmicro.com
14  *
15  * This program is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU General Public License
17  * version 2 as published by the Free Software Foundation.
18  *
19  * This program is distributed in the hope that it will be useful, but
20  * WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
22  * General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
27  * 02110-1301 USA
28  *
29  */
30 
31 #include <asm/mach-types.h>
32 
33 #include <linux/module.h>
34 #include <linux/platform_device.h>
35 #include <linux/slab.h>
36 #include <linux/gpio.h>
37 #include <linux/of_gpio.h>
38 
39 #include <mach/tegra_wm8903_pdata.h>
40 
41 #include <sound/core.h>
42 #include <sound/jack.h>
43 #include <sound/pcm.h>
44 #include <sound/pcm_params.h>
45 #include <sound/soc.h>
46 
47 #include "../codecs/wm8903.h"
48 
49 #include "tegra_asoc_utils.h"
50 
51 #define DRV_NAME "tegra-snd-wm8903"
52 
53 #define GPIO_SPKR_EN    BIT(0)
54 #define GPIO_HP_MUTE    BIT(1)
55 #define GPIO_INT_MIC_EN BIT(2)
56 #define GPIO_EXT_MIC_EN BIT(3)
57 #define GPIO_HP_DET     BIT(4)
58 
59 struct tegra_wm8903 {
60 	struct tegra_wm8903_platform_data pdata;
61 	struct tegra_asoc_utils_data util_data;
62 	int gpio_requested;
63 };
64 
65 static int tegra_wm8903_hw_params(struct snd_pcm_substream *substream,
66 					struct snd_pcm_hw_params *params)
67 {
68 	struct snd_soc_pcm_runtime *rtd = substream->private_data;
69 	struct snd_soc_dai *codec_dai = rtd->codec_dai;
70 	struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
71 	struct snd_soc_codec *codec = rtd->codec;
72 	struct snd_soc_card *card = codec->card;
73 	struct tegra_wm8903 *machine = snd_soc_card_get_drvdata(card);
74 	int srate, mclk;
75 	int err;
76 
77 	srate = params_rate(params);
78 	switch (srate) {
79 	case 64000:
80 	case 88200:
81 	case 96000:
82 		mclk = 128 * srate;
83 		break;
84 	default:
85 		mclk = 256 * srate;
86 		break;
87 	}
88 	/* FIXME: Codec only requires >= 3MHz if OSR==0 */
89 	while (mclk < 6000000)
90 		mclk *= 2;
91 
92 	err = tegra_asoc_utils_set_rate(&machine->util_data, srate, mclk);
93 	if (err < 0) {
94 		dev_err(card->dev, "Can't configure clocks\n");
95 		return err;
96 	}
97 
98 	err = snd_soc_dai_set_fmt(codec_dai,
99 					SND_SOC_DAIFMT_I2S |
100 					SND_SOC_DAIFMT_NB_NF |
101 					SND_SOC_DAIFMT_CBS_CFS);
102 	if (err < 0) {
103 		dev_err(card->dev, "codec_dai fmt not set\n");
104 		return err;
105 	}
106 
107 	err = snd_soc_dai_set_fmt(cpu_dai,
108 					SND_SOC_DAIFMT_I2S |
109 					SND_SOC_DAIFMT_NB_NF |
110 					SND_SOC_DAIFMT_CBS_CFS);
111 	if (err < 0) {
112 		dev_err(card->dev, "cpu_dai fmt not set\n");
113 		return err;
114 	}
115 
116 	err = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
117 					SND_SOC_CLOCK_IN);
118 	if (err < 0) {
119 		dev_err(card->dev, "codec_dai clock not set\n");
120 		return err;
121 	}
122 
123 	return 0;
124 }
125 
126 static struct snd_soc_ops tegra_wm8903_ops = {
127 	.hw_params = tegra_wm8903_hw_params,
128 };
129 
130 static struct snd_soc_jack tegra_wm8903_hp_jack;
131 
132 static struct snd_soc_jack_pin tegra_wm8903_hp_jack_pins[] = {
133 	{
134 		.pin = "Headphone Jack",
135 		.mask = SND_JACK_HEADPHONE,
136 	},
137 };
138 
139 static struct snd_soc_jack_gpio tegra_wm8903_hp_jack_gpio = {
140 	.name = "headphone detect",
141 	.report = SND_JACK_HEADPHONE,
142 	.debounce_time = 150,
143 	.invert = 1,
144 };
145 
146 static struct snd_soc_jack tegra_wm8903_mic_jack;
147 
148 static struct snd_soc_jack_pin tegra_wm8903_mic_jack_pins[] = {
149 	{
150 		.pin = "Mic Jack",
151 		.mask = SND_JACK_MICROPHONE,
152 	},
153 };
154 
155 static int tegra_wm8903_event_int_spk(struct snd_soc_dapm_widget *w,
156 					struct snd_kcontrol *k, int event)
157 {
158 	struct snd_soc_dapm_context *dapm = w->dapm;
159 	struct snd_soc_card *card = dapm->card;
160 	struct tegra_wm8903 *machine = snd_soc_card_get_drvdata(card);
161 	struct tegra_wm8903_platform_data *pdata = &machine->pdata;
162 
163 	if (!(machine->gpio_requested & GPIO_SPKR_EN))
164 		return 0;
165 
166 	gpio_set_value_cansleep(pdata->gpio_spkr_en,
167 				SND_SOC_DAPM_EVENT_ON(event));
168 
169 	return 0;
170 }
171 
172 static int tegra_wm8903_event_hp(struct snd_soc_dapm_widget *w,
173 					struct snd_kcontrol *k, int event)
174 {
175 	struct snd_soc_dapm_context *dapm = w->dapm;
176 	struct snd_soc_card *card = dapm->card;
177 	struct tegra_wm8903 *machine = snd_soc_card_get_drvdata(card);
178 	struct tegra_wm8903_platform_data *pdata = &machine->pdata;
179 
180 	if (!(machine->gpio_requested & GPIO_HP_MUTE))
181 		return 0;
182 
183 	gpio_set_value_cansleep(pdata->gpio_hp_mute,
184 				!SND_SOC_DAPM_EVENT_ON(event));
185 
186 	return 0;
187 }
188 
189 static const struct snd_soc_dapm_widget tegra_wm8903_dapm_widgets[] = {
190 	SND_SOC_DAPM_SPK("Int Spk", tegra_wm8903_event_int_spk),
191 	SND_SOC_DAPM_HP("Headphone Jack", tegra_wm8903_event_hp),
192 	SND_SOC_DAPM_MIC("Mic Jack", NULL),
193 };
194 
195 static const struct snd_soc_dapm_route harmony_audio_map[] = {
196 	{"Headphone Jack", NULL, "HPOUTR"},
197 	{"Headphone Jack", NULL, "HPOUTL"},
198 	{"Int Spk", NULL, "ROP"},
199 	{"Int Spk", NULL, "RON"},
200 	{"Int Spk", NULL, "LOP"},
201 	{"Int Spk", NULL, "LON"},
202 	{"Mic Jack", NULL, "MICBIAS"},
203 	{"IN1L", NULL, "Mic Jack"},
204 };
205 
206 static const struct snd_soc_dapm_route seaboard_audio_map[] = {
207 	{"Headphone Jack", NULL, "HPOUTR"},
208 	{"Headphone Jack", NULL, "HPOUTL"},
209 	{"Int Spk", NULL, "ROP"},
210 	{"Int Spk", NULL, "RON"},
211 	{"Int Spk", NULL, "LOP"},
212 	{"Int Spk", NULL, "LON"},
213 	{"Mic Jack", NULL, "MICBIAS"},
214 	{"IN1R", NULL, "Mic Jack"},
215 };
216 
217 static const struct snd_soc_dapm_route kaen_audio_map[] = {
218 	{"Headphone Jack", NULL, "HPOUTR"},
219 	{"Headphone Jack", NULL, "HPOUTL"},
220 	{"Int Spk", NULL, "ROP"},
221 	{"Int Spk", NULL, "RON"},
222 	{"Int Spk", NULL, "LOP"},
223 	{"Int Spk", NULL, "LON"},
224 	{"Mic Jack", NULL, "MICBIAS"},
225 	{"IN2R", NULL, "Mic Jack"},
226 };
227 
228 static const struct snd_soc_dapm_route aebl_audio_map[] = {
229 	{"Headphone Jack", NULL, "HPOUTR"},
230 	{"Headphone Jack", NULL, "HPOUTL"},
231 	{"Int Spk", NULL, "LINEOUTR"},
232 	{"Int Spk", NULL, "LINEOUTL"},
233 	{"Mic Jack", NULL, "MICBIAS"},
234 	{"IN1R", NULL, "Mic Jack"},
235 };
236 
237 static const struct snd_kcontrol_new tegra_wm8903_controls[] = {
238 	SOC_DAPM_PIN_SWITCH("Int Spk"),
239 };
240 
241 static int tegra_wm8903_init(struct snd_soc_pcm_runtime *rtd)
242 {
243 	struct snd_soc_codec *codec = rtd->codec;
244 	struct snd_soc_dapm_context *dapm = &codec->dapm;
245 	struct snd_soc_card *card = codec->card;
246 	struct tegra_wm8903 *machine = snd_soc_card_get_drvdata(card);
247 	struct tegra_wm8903_platform_data *pdata = &machine->pdata;
248 	struct device_node *np = card->dev->of_node;
249 	int ret;
250 
251 	if (card->dev->platform_data) {
252 		memcpy(pdata, card->dev->platform_data, sizeof(*pdata));
253 	} else if (np) {
254 		/*
255 		 * This part must be in init() rather than probe() in order to
256 		 * guarantee that the WM8903 has been probed, and hence its
257 		 * GPIO controller registered, which is a pre-condition for
258 		 * of_get_named_gpio() to be able to map the phandles in the
259 		 * properties to the controller node. Given this, all
260 		 * pdata handling is in init() for consistency.
261 		 */
262 		pdata->gpio_spkr_en = of_get_named_gpio(np,
263 						"nvidia,spkr-en-gpios", 0);
264 		pdata->gpio_hp_mute = of_get_named_gpio(np,
265 						"nvidia,hp-mute-gpios", 0);
266 		pdata->gpio_hp_det = of_get_named_gpio(np,
267 						"nvidia,hp-det-gpios", 0);
268 		pdata->gpio_int_mic_en = of_get_named_gpio(np,
269 						"nvidia,int-mic-en-gpios", 0);
270 		pdata->gpio_ext_mic_en = of_get_named_gpio(np,
271 						"nvidia,ext-mic-en-gpios", 0);
272 	} else {
273 		dev_err(card->dev, "No platform data supplied\n");
274 		return -EINVAL;
275 	}
276 
277 	if (gpio_is_valid(pdata->gpio_spkr_en)) {
278 		ret = gpio_request(pdata->gpio_spkr_en, "spkr_en");
279 		if (ret) {
280 			dev_err(card->dev, "cannot get spkr_en gpio\n");
281 			return ret;
282 		}
283 		machine->gpio_requested |= GPIO_SPKR_EN;
284 
285 		gpio_direction_output(pdata->gpio_spkr_en, 0);
286 	}
287 
288 	if (gpio_is_valid(pdata->gpio_hp_mute)) {
289 		ret = gpio_request(pdata->gpio_hp_mute, "hp_mute");
290 		if (ret) {
291 			dev_err(card->dev, "cannot get hp_mute gpio\n");
292 			return ret;
293 		}
294 		machine->gpio_requested |= GPIO_HP_MUTE;
295 
296 		gpio_direction_output(pdata->gpio_hp_mute, 1);
297 	}
298 
299 	if (gpio_is_valid(pdata->gpio_int_mic_en)) {
300 		ret = gpio_request(pdata->gpio_int_mic_en, "int_mic_en");
301 		if (ret) {
302 			dev_err(card->dev, "cannot get int_mic_en gpio\n");
303 			return ret;
304 		}
305 		machine->gpio_requested |= GPIO_INT_MIC_EN;
306 
307 		/* Disable int mic; enable signal is active-high */
308 		gpio_direction_output(pdata->gpio_int_mic_en, 0);
309 	}
310 
311 	if (gpio_is_valid(pdata->gpio_ext_mic_en)) {
312 		ret = gpio_request(pdata->gpio_ext_mic_en, "ext_mic_en");
313 		if (ret) {
314 			dev_err(card->dev, "cannot get ext_mic_en gpio\n");
315 			return ret;
316 		}
317 		machine->gpio_requested |= GPIO_EXT_MIC_EN;
318 
319 		/* Enable ext mic; enable signal is active-low */
320 		gpio_direction_output(pdata->gpio_ext_mic_en, 0);
321 	}
322 
323 	if (gpio_is_valid(pdata->gpio_hp_det)) {
324 		tegra_wm8903_hp_jack_gpio.gpio = pdata->gpio_hp_det;
325 		snd_soc_jack_new(codec, "Headphone Jack", SND_JACK_HEADPHONE,
326 				&tegra_wm8903_hp_jack);
327 		snd_soc_jack_add_pins(&tegra_wm8903_hp_jack,
328 					ARRAY_SIZE(tegra_wm8903_hp_jack_pins),
329 					tegra_wm8903_hp_jack_pins);
330 		snd_soc_jack_add_gpios(&tegra_wm8903_hp_jack,
331 					1,
332 					&tegra_wm8903_hp_jack_gpio);
333 		machine->gpio_requested |= GPIO_HP_DET;
334 	}
335 
336 	snd_soc_jack_new(codec, "Mic Jack", SND_JACK_MICROPHONE,
337 			 &tegra_wm8903_mic_jack);
338 	snd_soc_jack_add_pins(&tegra_wm8903_mic_jack,
339 			      ARRAY_SIZE(tegra_wm8903_mic_jack_pins),
340 			      tegra_wm8903_mic_jack_pins);
341 	wm8903_mic_detect(codec, &tegra_wm8903_mic_jack, SND_JACK_MICROPHONE,
342 				0);
343 
344 	snd_soc_dapm_force_enable_pin(dapm, "MICBIAS");
345 
346 	return 0;
347 }
348 
349 static int tegra_wm8903_remove(struct snd_soc_card *card)
350 {
351 	struct snd_soc_pcm_runtime *rtd = &(card->rtd[0]);
352 	struct snd_soc_dai *codec_dai = rtd->codec_dai;
353 	struct snd_soc_codec *codec = codec_dai->codec;
354 
355 	wm8903_mic_detect(codec, NULL, 0, 0);
356 
357 	return 0;
358 }
359 
360 static struct snd_soc_dai_link tegra_wm8903_dai = {
361 	.name = "WM8903",
362 	.stream_name = "WM8903 PCM",
363 	.codec_name = "wm8903.0-001a",
364 	.platform_name = "tegra20-i2s.0",
365 	.cpu_dai_name = "tegra20-i2s.0",
366 	.codec_dai_name = "wm8903-hifi",
367 	.init = tegra_wm8903_init,
368 	.ops = &tegra_wm8903_ops,
369 };
370 
371 static struct snd_soc_card snd_soc_tegra_wm8903 = {
372 	.name = "tegra-wm8903",
373 	.owner = THIS_MODULE,
374 	.dai_link = &tegra_wm8903_dai,
375 	.num_links = 1,
376 
377 	.remove = tegra_wm8903_remove,
378 
379 	.controls = tegra_wm8903_controls,
380 	.num_controls = ARRAY_SIZE(tegra_wm8903_controls),
381 	.dapm_widgets = tegra_wm8903_dapm_widgets,
382 	.num_dapm_widgets = ARRAY_SIZE(tegra_wm8903_dapm_widgets),
383 	.fully_routed = true,
384 };
385 
386 static __devinit int tegra_wm8903_driver_probe(struct platform_device *pdev)
387 {
388 	struct snd_soc_card *card = &snd_soc_tegra_wm8903;
389 	struct tegra_wm8903 *machine;
390 	int ret;
391 
392 	if (!pdev->dev.platform_data && !pdev->dev.of_node) {
393 		dev_err(&pdev->dev, "No platform data supplied\n");
394 		return -EINVAL;
395 	}
396 
397 	machine = devm_kzalloc(&pdev->dev, sizeof(struct tegra_wm8903),
398 			       GFP_KERNEL);
399 	if (!machine) {
400 		dev_err(&pdev->dev, "Can't allocate tegra_wm8903 struct\n");
401 		ret = -ENOMEM;
402 		goto err;
403 	}
404 
405 	card->dev = &pdev->dev;
406 	platform_set_drvdata(pdev, card);
407 	snd_soc_card_set_drvdata(card, machine);
408 
409 	if (pdev->dev.of_node) {
410 		ret = snd_soc_of_parse_card_name(card, "nvidia,model");
411 		if (ret)
412 			goto err;
413 
414 		ret = snd_soc_of_parse_audio_routing(card,
415 						     "nvidia,audio-routing");
416 		if (ret)
417 			goto err;
418 
419 		tegra_wm8903_dai.codec_name = NULL;
420 		tegra_wm8903_dai.codec_of_node = of_parse_phandle(
421 				pdev->dev.of_node, "nvidia,audio-codec", 0);
422 		if (!tegra_wm8903_dai.codec_of_node) {
423 			dev_err(&pdev->dev,
424 				"Property 'nvidia,audio-codec' missing or invalid\n");
425 			ret = -EINVAL;
426 			goto err;
427 		}
428 
429 		tegra_wm8903_dai.cpu_dai_name = NULL;
430 		tegra_wm8903_dai.cpu_dai_of_node = of_parse_phandle(
431 				pdev->dev.of_node, "nvidia,i2s-controller", 0);
432 		if (!tegra_wm8903_dai.cpu_dai_of_node) {
433 			dev_err(&pdev->dev,
434 				"Property 'nvidia,i2s-controller' missing or invalid\n");
435 			ret = -EINVAL;
436 			goto err;
437 		}
438 
439 		tegra_wm8903_dai.platform_name = NULL;
440 		tegra_wm8903_dai.platform_of_node =
441 					tegra_wm8903_dai.cpu_dai_of_node;
442 	} else {
443 		if (machine_is_harmony()) {
444 			card->dapm_routes = harmony_audio_map;
445 			card->num_dapm_routes = ARRAY_SIZE(harmony_audio_map);
446 		} else if (machine_is_seaboard()) {
447 			card->dapm_routes = seaboard_audio_map;
448 			card->num_dapm_routes = ARRAY_SIZE(seaboard_audio_map);
449 		} else if (machine_is_kaen()) {
450 			card->dapm_routes = kaen_audio_map;
451 			card->num_dapm_routes = ARRAY_SIZE(kaen_audio_map);
452 		} else {
453 			card->dapm_routes = aebl_audio_map;
454 			card->num_dapm_routes = ARRAY_SIZE(aebl_audio_map);
455 		}
456 	}
457 
458 	ret = tegra_asoc_utils_init(&machine->util_data, &pdev->dev);
459 	if (ret)
460 		goto err;
461 
462 	ret = snd_soc_register_card(card);
463 	if (ret) {
464 		dev_err(&pdev->dev, "snd_soc_register_card failed (%d)\n",
465 			ret);
466 		goto err_fini_utils;
467 	}
468 
469 	return 0;
470 
471 err_fini_utils:
472 	tegra_asoc_utils_fini(&machine->util_data);
473 err:
474 	return ret;
475 }
476 
477 static int __devexit tegra_wm8903_driver_remove(struct platform_device *pdev)
478 {
479 	struct snd_soc_card *card = platform_get_drvdata(pdev);
480 	struct tegra_wm8903 *machine = snd_soc_card_get_drvdata(card);
481 	struct tegra_wm8903_platform_data *pdata = &machine->pdata;
482 
483 	if (machine->gpio_requested & GPIO_HP_DET)
484 		snd_soc_jack_free_gpios(&tegra_wm8903_hp_jack,
485 					1,
486 					&tegra_wm8903_hp_jack_gpio);
487 	if (machine->gpio_requested & GPIO_EXT_MIC_EN)
488 		gpio_free(pdata->gpio_ext_mic_en);
489 	if (machine->gpio_requested & GPIO_INT_MIC_EN)
490 		gpio_free(pdata->gpio_int_mic_en);
491 	if (machine->gpio_requested & GPIO_HP_MUTE)
492 		gpio_free(pdata->gpio_hp_mute);
493 	if (machine->gpio_requested & GPIO_SPKR_EN)
494 		gpio_free(pdata->gpio_spkr_en);
495 	machine->gpio_requested = 0;
496 
497 	snd_soc_unregister_card(card);
498 
499 	tegra_asoc_utils_fini(&machine->util_data);
500 
501 	return 0;
502 }
503 
504 static const struct of_device_id tegra_wm8903_of_match[] __devinitconst = {
505 	{ .compatible = "nvidia,tegra-audio-wm8903", },
506 	{},
507 };
508 
509 static struct platform_driver tegra_wm8903_driver = {
510 	.driver = {
511 		.name = DRV_NAME,
512 		.owner = THIS_MODULE,
513 		.pm = &snd_soc_pm_ops,
514 		.of_match_table = tegra_wm8903_of_match,
515 	},
516 	.probe = tegra_wm8903_driver_probe,
517 	.remove = __devexit_p(tegra_wm8903_driver_remove),
518 };
519 module_platform_driver(tegra_wm8903_driver);
520 
521 MODULE_AUTHOR("Stephen Warren <swarren@nvidia.com>");
522 MODULE_DESCRIPTION("Tegra+WM8903 machine ASoC driver");
523 MODULE_LICENSE("GPL");
524 MODULE_ALIAS("platform:" DRV_NAME);
525 MODULE_DEVICE_TABLE(of, tegra_wm8903_of_match);
526