2 * ams-delta.c -- SoC audio for Amstrad E3 (Delta) videophone
4 * Copyright (C) 2009 Janusz Krzysztofik <jkrzyszt@tis.icnet.pl>
6 * Initially based on sound/soc/omap/osk5912.x
7 * Copyright (C) 2008 Mistral Solutions
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * version 2 as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
25 #include <linux/gpio.h>
26 #include <linux/spinlock.h>
27 #include <linux/tty.h>
28 #include <linux/module.h>
30 #include <sound/soc.h>
31 #include <sound/jack.h>
33 #include <asm/mach-types.h>
35 #include <plat/board-ams-delta.h>
36 #include <plat/mcbsp.h>
38 #include "omap-mcbsp.h"
40 #include "../codecs/cx20442.h"
43 /* Board specific DAPM widgets */
44 static const struct snd_soc_dapm_widget ams_delta_dapm_widgets[] = {
46 SND_SOC_DAPM_MIC("Mouthpiece", NULL),
47 SND_SOC_DAPM_HP("Earpiece", NULL),
48 /* Handsfree/Speakerphone */
49 SND_SOC_DAPM_MIC("Microphone", NULL),
50 SND_SOC_DAPM_SPK("Speaker", NULL),
53 /* How they are connected to codec pins */
54 static const struct snd_soc_dapm_route ams_delta_audio_map[] = {
55 {"TELIN", NULL, "Mouthpiece"},
56 {"Earpiece", NULL, "TELOUT"},
58 {"MIC", NULL, "Microphone"},
59 {"Speaker", NULL, "SPKOUT"},
63 * Controls, functional after the modem line discipline is activated.
66 /* Virtual switch: audio input/output constellations */
67 static const char *ams_delta_audio_mode[] =
68 {"Mixed", "Handset", "Handsfree", "Speakerphone"};
70 /* Selection <-> pin translation */
71 #define AMS_DELTA_MOUTHPIECE 0
72 #define AMS_DELTA_EARPIECE 1
73 #define AMS_DELTA_MICROPHONE 2
74 #define AMS_DELTA_SPEAKER 3
75 #define AMS_DELTA_AGC 4
77 #define AMS_DELTA_MIXED ((1 << AMS_DELTA_EARPIECE) | \
78 (1 << AMS_DELTA_MICROPHONE))
79 #define AMS_DELTA_HANDSET ((1 << AMS_DELTA_MOUTHPIECE) | \
80 (1 << AMS_DELTA_EARPIECE))
81 #define AMS_DELTA_HANDSFREE ((1 << AMS_DELTA_MICROPHONE) | \
82 (1 << AMS_DELTA_SPEAKER))
83 #define AMS_DELTA_SPEAKERPHONE (AMS_DELTA_HANDSFREE | (1 << AMS_DELTA_AGC))
85 static const unsigned short ams_delta_audio_mode_pins[] = {
89 AMS_DELTA_SPEAKERPHONE,
92 static unsigned short ams_delta_audio_agc;
94 static int ams_delta_set_audio_mode(struct snd_kcontrol *kcontrol,
95 struct snd_ctl_elem_value *ucontrol)
97 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
98 struct snd_soc_dapm_context *dapm = &codec->dapm;
99 struct soc_enum *control = (struct soc_enum *)kcontrol->private_value;
101 int pin, changed = 0;
103 /* Refuse any mode changes if we are not able to control the codec. */
104 if (!codec->hw_write)
107 if (ucontrol->value.enumerated.item[0] >= control->max)
110 mutex_lock(&codec->mutex);
112 /* Translate selection to bitmap */
113 pins = ams_delta_audio_mode_pins[ucontrol->value.enumerated.item[0]];
115 /* Setup pins after corresponding bits if changed */
116 pin = !!(pins & (1 << AMS_DELTA_MOUTHPIECE));
117 if (pin != snd_soc_dapm_get_pin_status(dapm, "Mouthpiece")) {
120 snd_soc_dapm_enable_pin(dapm, "Mouthpiece");
122 snd_soc_dapm_disable_pin(dapm, "Mouthpiece");
124 pin = !!(pins & (1 << AMS_DELTA_EARPIECE));
125 if (pin != snd_soc_dapm_get_pin_status(dapm, "Earpiece")) {
128 snd_soc_dapm_enable_pin(dapm, "Earpiece");
130 snd_soc_dapm_disable_pin(dapm, "Earpiece");
132 pin = !!(pins & (1 << AMS_DELTA_MICROPHONE));
133 if (pin != snd_soc_dapm_get_pin_status(dapm, "Microphone")) {
136 snd_soc_dapm_enable_pin(dapm, "Microphone");
138 snd_soc_dapm_disable_pin(dapm, "Microphone");
140 pin = !!(pins & (1 << AMS_DELTA_SPEAKER));
141 if (pin != snd_soc_dapm_get_pin_status(dapm, "Speaker")) {
144 snd_soc_dapm_enable_pin(dapm, "Speaker");
146 snd_soc_dapm_disable_pin(dapm, "Speaker");
148 pin = !!(pins & (1 << AMS_DELTA_AGC));
149 if (pin != ams_delta_audio_agc) {
150 ams_delta_audio_agc = pin;
153 snd_soc_dapm_enable_pin(dapm, "AGCIN");
155 snd_soc_dapm_disable_pin(dapm, "AGCIN");
158 snd_soc_dapm_sync(dapm);
160 mutex_unlock(&codec->mutex);
165 static int ams_delta_get_audio_mode(struct snd_kcontrol *kcontrol,
166 struct snd_ctl_elem_value *ucontrol)
168 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
169 struct snd_soc_dapm_context *dapm = &codec->dapm;
170 unsigned short pins, mode;
172 pins = ((snd_soc_dapm_get_pin_status(dapm, "Mouthpiece") <<
173 AMS_DELTA_MOUTHPIECE) |
174 (snd_soc_dapm_get_pin_status(dapm, "Earpiece") <<
175 AMS_DELTA_EARPIECE));
177 pins |= (snd_soc_dapm_get_pin_status(dapm, "Microphone") <<
178 AMS_DELTA_MICROPHONE);
180 pins = ((snd_soc_dapm_get_pin_status(dapm, "Microphone") <<
181 AMS_DELTA_MICROPHONE) |
182 (snd_soc_dapm_get_pin_status(dapm, "Speaker") <<
184 (ams_delta_audio_agc << AMS_DELTA_AGC));
186 for (mode = 0; mode < ARRAY_SIZE(ams_delta_audio_mode); mode++)
187 if (pins == ams_delta_audio_mode_pins[mode])
190 if (mode >= ARRAY_SIZE(ams_delta_audio_mode))
193 ucontrol->value.enumerated.item[0] = mode;
198 static const struct soc_enum ams_delta_audio_enum[] = {
199 SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(ams_delta_audio_mode),
200 ams_delta_audio_mode),
203 static const struct snd_kcontrol_new ams_delta_audio_controls[] = {
204 SOC_ENUM_EXT("Audio Mode", ams_delta_audio_enum[0],
205 ams_delta_get_audio_mode, ams_delta_set_audio_mode),
209 static struct snd_soc_jack ams_delta_hook_switch;
210 static struct snd_soc_jack_gpio ams_delta_hook_switch_gpios[] = {
213 .name = "hook_switch",
214 .report = SND_JACK_HEADSET,
216 .debounce_time = 150,
220 /* After we are able to control the codec over the modem,
221 * the hook switch can be used for dynamic DAPM reconfiguration. */
222 static struct snd_soc_jack_pin ams_delta_hook_switch_pins[] = {
226 .mask = SND_JACK_MICROPHONE,
230 .mask = SND_JACK_HEADPHONE,
235 .mask = SND_JACK_MICROPHONE,
240 .mask = SND_JACK_HEADPHONE,
247 * Modem line discipline, required for making above controls functional.
248 * Activated from userspace with ldattach, possibly invoked from udev rule.
251 /* To actually apply any modem controlled configuration changes to the codec,
252 * we must connect codec DAI pins to the modem for a moment. Be careful not
253 * to interfere with our digital mute function that shares the same hardware. */
254 static struct timer_list cx81801_timer;
255 static bool cx81801_cmd_pending;
256 static bool ams_delta_muted;
257 static DEFINE_SPINLOCK(ams_delta_lock);
259 static void cx81801_timeout(unsigned long data)
263 spin_lock(&ams_delta_lock);
264 cx81801_cmd_pending = 0;
265 muted = ams_delta_muted;
266 spin_unlock(&ams_delta_lock);
268 /* Reconnect the codec DAI back from the modem to the CPU DAI
269 * only if digital mute still off */
271 ams_delta_latch2_write(AMS_DELTA_LATCH2_MODEM_CODEC, 0);
275 * Used for passing a codec structure pointer
276 * from the board initialization code to the tty line discipline.
278 static struct snd_soc_codec *cx20442_codec;
280 /* Line discipline .open() */
281 static int cx81801_open(struct tty_struct *tty)
289 * Pass the codec structure pointer for use by other ldisc callbacks,
290 * both the card and the codec specific parts.
292 tty->disc_data = cx20442_codec;
294 ret = v253_ops.open(tty);
297 tty->disc_data = NULL;
302 /* Line discipline .close() */
303 static void cx81801_close(struct tty_struct *tty)
305 struct snd_soc_codec *codec = tty->disc_data;
306 struct snd_soc_dapm_context *dapm = &codec->dapm;
308 del_timer_sync(&cx81801_timer);
310 /* Prevent the hook switch from further changing the DAPM pins */
311 INIT_LIST_HEAD(&ams_delta_hook_switch.pins);
318 /* Revert back to default audio input/output constellation */
319 snd_soc_dapm_disable_pin(dapm, "Mouthpiece");
320 snd_soc_dapm_enable_pin(dapm, "Earpiece");
321 snd_soc_dapm_enable_pin(dapm, "Microphone");
322 snd_soc_dapm_disable_pin(dapm, "Speaker");
323 snd_soc_dapm_disable_pin(dapm, "AGCIN");
324 snd_soc_dapm_sync(dapm);
327 /* Line discipline .hangup() */
328 static int cx81801_hangup(struct tty_struct *tty)
334 /* Line discipline .receive_buf() */
335 static void cx81801_receive(struct tty_struct *tty,
336 const unsigned char *cp, char *fp, int count)
338 struct snd_soc_codec *codec = tty->disc_data;
339 const unsigned char *c;
345 if (!codec->hw_write) {
346 /* First modem response, complete setup procedure */
348 /* Initialize timer used for config pulse generation */
349 setup_timer(&cx81801_timer, cx81801_timeout, 0);
351 v253_ops.receive_buf(tty, cp, fp, count);
353 /* Link hook switch to DAPM pins */
354 ret = snd_soc_jack_add_pins(&ams_delta_hook_switch,
355 ARRAY_SIZE(ams_delta_hook_switch_pins),
356 ams_delta_hook_switch_pins);
359 "Failed to link hook switch to DAPM pins, "
360 "will continue with hook switch unlinked.\n");
365 v253_ops.receive_buf(tty, cp, fp, count);
367 for (c = &cp[count - 1]; c >= cp; c--) {
370 /* Complete modem response received, apply config to codec */
372 spin_lock_bh(&ams_delta_lock);
373 mod_timer(&cx81801_timer, jiffies + msecs_to_jiffies(150));
374 apply = !ams_delta_muted && !cx81801_cmd_pending;
375 cx81801_cmd_pending = 1;
376 spin_unlock_bh(&ams_delta_lock);
378 /* Apply config pulse by connecting the codec to the modem
379 * if not already done */
381 ams_delta_latch2_write(AMS_DELTA_LATCH2_MODEM_CODEC,
382 AMS_DELTA_LATCH2_MODEM_CODEC);
387 /* Line discipline .write_wakeup() */
388 static void cx81801_wakeup(struct tty_struct *tty)
390 v253_ops.write_wakeup(tty);
393 static struct tty_ldisc_ops cx81801_ops = {
394 .magic = TTY_LDISC_MAGIC,
396 .owner = THIS_MODULE,
397 .open = cx81801_open,
398 .close = cx81801_close,
399 .hangup = cx81801_hangup,
400 .receive_buf = cx81801_receive,
401 .write_wakeup = cx81801_wakeup,
406 * Even if not very useful, the sound card can still work without any of the
407 * above functonality activated. You can still control its audio input/output
408 * constellation and speakerphone gain from userspace by issuing AT commands
409 * over the modem port.
412 static int ams_delta_hw_params(struct snd_pcm_substream *substream,
413 struct snd_pcm_hw_params *params)
415 struct snd_soc_pcm_runtime *rtd = substream->private_data;
417 /* Set cpu DAI configuration */
418 return snd_soc_dai_set_fmt(rtd->cpu_dai,
419 SND_SOC_DAIFMT_DSP_A |
420 SND_SOC_DAIFMT_NB_NF |
421 SND_SOC_DAIFMT_CBM_CFM);
424 static struct snd_soc_ops ams_delta_ops = {
425 .hw_params = ams_delta_hw_params,
429 /* Board specific codec bias level control */
430 static int ams_delta_set_bias_level(struct snd_soc_card *card,
431 struct snd_soc_dapm_context *dapm,
432 enum snd_soc_bias_level level)
435 case SND_SOC_BIAS_ON:
436 case SND_SOC_BIAS_PREPARE:
437 case SND_SOC_BIAS_STANDBY:
438 if (card->dapm.bias_level == SND_SOC_BIAS_OFF)
439 ams_delta_latch2_write(AMS_DELTA_LATCH2_MODEM_NRESET,
440 AMS_DELTA_LATCH2_MODEM_NRESET);
442 case SND_SOC_BIAS_OFF:
443 if (card->dapm.bias_level != SND_SOC_BIAS_OFF)
444 ams_delta_latch2_write(AMS_DELTA_LATCH2_MODEM_NRESET,
447 card->dapm.bias_level = level;
452 /* Digital mute implemented using modem/CPU multiplexer.
453 * Shares hardware with codec config pulse generation */
454 static bool ams_delta_muted = 1;
456 static int ams_delta_digital_mute(struct snd_soc_dai *dai, int mute)
460 if (ams_delta_muted == mute)
463 spin_lock_bh(&ams_delta_lock);
464 ams_delta_muted = mute;
465 apply = !cx81801_cmd_pending;
466 spin_unlock_bh(&ams_delta_lock);
469 ams_delta_latch2_write(AMS_DELTA_LATCH2_MODEM_CODEC,
470 mute ? AMS_DELTA_LATCH2_MODEM_CODEC : 0);
474 /* Our codec DAI probably doesn't have its own .ops structure */
475 static const struct snd_soc_dai_ops ams_delta_dai_ops = {
476 .digital_mute = ams_delta_digital_mute,
479 /* Will be used if the codec ever has its own digital_mute function */
480 static int ams_delta_startup(struct snd_pcm_substream *substream)
482 return ams_delta_digital_mute(NULL, 0);
485 static void ams_delta_shutdown(struct snd_pcm_substream *substream)
487 ams_delta_digital_mute(NULL, 1);
492 * Card initialization
495 static int ams_delta_cx20442_init(struct snd_soc_pcm_runtime *rtd)
497 struct snd_soc_codec *codec = rtd->codec;
498 struct snd_soc_dapm_context *dapm = &codec->dapm;
499 struct snd_soc_dai *codec_dai = rtd->codec_dai;
500 struct snd_soc_card *card = rtd->card;
502 /* Codec is ready, now add/activate board specific controls */
504 /* Store a pointer to the codec structure for tty ldisc use */
505 cx20442_codec = codec;
507 /* Set up digital mute if not provided by the codec */
508 if (!codec_dai->driver->ops) {
509 codec_dai->driver->ops = &ams_delta_dai_ops;
511 ams_delta_ops.startup = ams_delta_startup;
512 ams_delta_ops.shutdown = ams_delta_shutdown;
515 /* Set codec bias level */
516 ams_delta_set_bias_level(card, dapm, SND_SOC_BIAS_STANDBY);
518 /* Add hook switch - can be used to control the codec from userspace
519 * even if line discipline fails */
520 ret = snd_soc_jack_new(rtd->codec, "hook_switch",
521 SND_JACK_HEADSET, &ams_delta_hook_switch);
524 "Failed to allocate resources for hook switch, "
525 "will continue without one.\n");
527 ret = snd_soc_jack_add_gpios(&ams_delta_hook_switch,
528 ARRAY_SIZE(ams_delta_hook_switch_gpios),
529 ams_delta_hook_switch_gpios);
532 "Failed to set up hook switch GPIO line, "
533 "will continue with hook switch inactive.\n");
536 /* Register optional line discipline for over the modem control */
537 ret = tty_register_ldisc(N_V253, &cx81801_ops);
540 "Failed to register line discipline, "
541 "will continue without any controls.\n");
545 /* Add board specific DAPM widgets and routes */
546 ret = snd_soc_dapm_new_controls(dapm, ams_delta_dapm_widgets,
547 ARRAY_SIZE(ams_delta_dapm_widgets));
550 "Failed to register DAPM controls, "
551 "will continue without any.\n");
555 ret = snd_soc_dapm_add_routes(dapm, ams_delta_audio_map,
556 ARRAY_SIZE(ams_delta_audio_map));
559 "Failed to set up DAPM routes, "
560 "will continue with codec default map.\n");
564 /* Set up initial pin constellation */
565 snd_soc_dapm_disable_pin(dapm, "Mouthpiece");
566 snd_soc_dapm_enable_pin(dapm, "Earpiece");
567 snd_soc_dapm_enable_pin(dapm, "Microphone");
568 snd_soc_dapm_disable_pin(dapm, "Speaker");
569 snd_soc_dapm_disable_pin(dapm, "AGCIN");
570 snd_soc_dapm_disable_pin(dapm, "AGCOUT");
572 /* Add virtual switch */
573 ret = snd_soc_add_codec_controls(codec, ams_delta_audio_controls,
574 ARRAY_SIZE(ams_delta_audio_controls));
577 "Failed to register audio mode control, "
578 "will continue without it.\n");
583 /* DAI glue - connects codec <--> CPU */
584 static struct snd_soc_dai_link ams_delta_dai_link = {
586 .stream_name = "CX20442",
587 .cpu_dai_name ="omap-mcbsp-dai.0",
588 .codec_dai_name = "cx20442-voice",
589 .init = ams_delta_cx20442_init,
590 .platform_name = "omap-pcm-audio",
591 .codec_name = "cx20442-codec",
592 .ops = &ams_delta_ops,
595 /* Audio card driver */
596 static struct snd_soc_card ams_delta_audio_card = {
598 .owner = THIS_MODULE,
599 .dai_link = &ams_delta_dai_link,
601 .set_bias_level = ams_delta_set_bias_level,
604 /* Module init/exit */
605 static struct platform_device *ams_delta_audio_platform_device;
606 static struct platform_device *cx20442_platform_device;
608 static int __init ams_delta_module_init(void)
612 if (!(machine_is_ams_delta()))
615 ams_delta_audio_platform_device =
616 platform_device_alloc("soc-audio", -1);
617 if (!ams_delta_audio_platform_device)
620 platform_set_drvdata(ams_delta_audio_platform_device,
621 &ams_delta_audio_card);
623 ret = platform_device_add(ams_delta_audio_platform_device);
628 * Codec platform device could be registered from elsewhere (board?),
629 * but I do it here as it makes sense only if used with the card.
631 cx20442_platform_device =
632 platform_device_register_simple("cx20442-codec", -1, NULL, 0);
635 platform_device_put(ams_delta_audio_platform_device);
638 module_init(ams_delta_module_init);
640 static void __exit ams_delta_module_exit(void)
642 if (tty_unregister_ldisc(N_V253) != 0)
643 dev_warn(&ams_delta_audio_platform_device->dev,
644 "failed to unregister V253 line discipline\n");
646 snd_soc_jack_free_gpios(&ams_delta_hook_switch,
647 ARRAY_SIZE(ams_delta_hook_switch_gpios),
648 ams_delta_hook_switch_gpios);
650 /* Keep modem power on */
651 ams_delta_set_bias_level(&ams_delta_audio_card,
652 &ams_delta_audio_card.rtd[0].codec->dapm,
653 SND_SOC_BIAS_STANDBY);
655 platform_device_unregister(cx20442_platform_device);
656 platform_device_unregister(ams_delta_audio_platform_device);
658 module_exit(ams_delta_module_exit);
660 MODULE_AUTHOR("Janusz Krzysztofik <jkrzyszt@tis.icnet.pl>");
661 MODULE_DESCRIPTION("ALSA SoC driver for Amstrad E3 (Delta) videophone");
662 MODULE_LICENSE("GPL");