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 <mach/board-ams-delta.h>
36 #include <linux/platform_data/asoc-ti-mcbsp.h>
38 #include "omap-mcbsp.h"
39 #include "../codecs/cx20442.h"
42 /* Board specific DAPM widgets */
43 static const struct snd_soc_dapm_widget ams_delta_dapm_widgets
[] = {
45 SND_SOC_DAPM_MIC("Mouthpiece", NULL
),
46 SND_SOC_DAPM_HP("Earpiece", NULL
),
47 /* Handsfree/Speakerphone */
48 SND_SOC_DAPM_MIC("Microphone", NULL
),
49 SND_SOC_DAPM_SPK("Speaker", NULL
),
52 /* How they are connected to codec pins */
53 static const struct snd_soc_dapm_route ams_delta_audio_map
[] = {
54 {"TELIN", NULL
, "Mouthpiece"},
55 {"Earpiece", NULL
, "TELOUT"},
57 {"MIC", NULL
, "Microphone"},
58 {"Speaker", NULL
, "SPKOUT"},
62 * Controls, functional after the modem line discipline is activated.
65 /* Virtual switch: audio input/output constellations */
66 static const char *ams_delta_audio_mode
[] =
67 {"Mixed", "Handset", "Handsfree", "Speakerphone"};
69 /* Selection <-> pin translation */
70 #define AMS_DELTA_MOUTHPIECE 0
71 #define AMS_DELTA_EARPIECE 1
72 #define AMS_DELTA_MICROPHONE 2
73 #define AMS_DELTA_SPEAKER 3
74 #define AMS_DELTA_AGC 4
76 #define AMS_DELTA_MIXED ((1 << AMS_DELTA_EARPIECE) | \
77 (1 << AMS_DELTA_MICROPHONE))
78 #define AMS_DELTA_HANDSET ((1 << AMS_DELTA_MOUTHPIECE) | \
79 (1 << AMS_DELTA_EARPIECE))
80 #define AMS_DELTA_HANDSFREE ((1 << AMS_DELTA_MICROPHONE) | \
81 (1 << AMS_DELTA_SPEAKER))
82 #define AMS_DELTA_SPEAKERPHONE (AMS_DELTA_HANDSFREE | (1 << AMS_DELTA_AGC))
84 static const unsigned short ams_delta_audio_mode_pins
[] = {
88 AMS_DELTA_SPEAKERPHONE
,
91 static unsigned short ams_delta_audio_agc
;
93 static int ams_delta_set_audio_mode(struct snd_kcontrol
*kcontrol
,
94 struct snd_ctl_elem_value
*ucontrol
)
96 struct snd_soc_codec
*codec
= snd_kcontrol_chip(kcontrol
);
97 struct snd_soc_dapm_context
*dapm
= &codec
->dapm
;
98 struct soc_enum
*control
= (struct soc_enum
*)kcontrol
->private_value
;
100 int pin
, changed
= 0;
102 /* Refuse any mode changes if we are not able to control the codec. */
103 if (!codec
->hw_write
)
106 if (ucontrol
->value
.enumerated
.item
[0] >= control
->items
)
109 snd_soc_dapm_mutex_lock(dapm
);
111 /* Translate selection to bitmap */
112 pins
= ams_delta_audio_mode_pins
[ucontrol
->value
.enumerated
.item
[0]];
114 /* Setup pins after corresponding bits if changed */
115 pin
= !!(pins
& (1 << AMS_DELTA_MOUTHPIECE
));
117 if (pin
!= snd_soc_dapm_get_pin_status(dapm
, "Mouthpiece")) {
120 snd_soc_dapm_enable_pin_unlocked(dapm
, "Mouthpiece");
122 snd_soc_dapm_disable_pin_unlocked(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_unlocked(dapm
, "Earpiece");
130 snd_soc_dapm_disable_pin_unlocked(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_unlocked(dapm
, "Microphone");
138 snd_soc_dapm_disable_pin_unlocked(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_unlocked(dapm
, "Speaker");
146 snd_soc_dapm_disable_pin_unlocked(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_unlocked(dapm
, "AGCIN");
155 snd_soc_dapm_disable_pin_unlocked(dapm
, "AGCIN");
159 snd_soc_dapm_sync_unlocked(dapm
);
161 snd_soc_dapm_mutex_unlock(dapm
);
166 static int ams_delta_get_audio_mode(struct snd_kcontrol
*kcontrol
,
167 struct snd_ctl_elem_value
*ucontrol
)
169 struct snd_soc_codec
*codec
= snd_kcontrol_chip(kcontrol
);
170 struct snd_soc_dapm_context
*dapm
= &codec
->dapm
;
171 unsigned short pins
, mode
;
173 pins
= ((snd_soc_dapm_get_pin_status(dapm
, "Mouthpiece") <<
174 AMS_DELTA_MOUTHPIECE
) |
175 (snd_soc_dapm_get_pin_status(dapm
, "Earpiece") <<
176 AMS_DELTA_EARPIECE
));
178 pins
|= (snd_soc_dapm_get_pin_status(dapm
, "Microphone") <<
179 AMS_DELTA_MICROPHONE
);
181 pins
= ((snd_soc_dapm_get_pin_status(dapm
, "Microphone") <<
182 AMS_DELTA_MICROPHONE
) |
183 (snd_soc_dapm_get_pin_status(dapm
, "Speaker") <<
185 (ams_delta_audio_agc
<< AMS_DELTA_AGC
));
187 for (mode
= 0; mode
< ARRAY_SIZE(ams_delta_audio_mode
); mode
++)
188 if (pins
== ams_delta_audio_mode_pins
[mode
])
191 if (mode
>= ARRAY_SIZE(ams_delta_audio_mode
))
194 ucontrol
->value
.enumerated
.item
[0] = mode
;
199 static const SOC_ENUM_SINGLE_EXT_DECL(ams_delta_audio_enum
,
200 ams_delta_audio_mode
);
202 static const struct snd_kcontrol_new ams_delta_audio_controls
[] = {
203 SOC_ENUM_EXT("Audio Mode", ams_delta_audio_enum
,
204 ams_delta_get_audio_mode
, ams_delta_set_audio_mode
),
208 static struct snd_soc_jack ams_delta_hook_switch
;
209 static struct snd_soc_jack_gpio ams_delta_hook_switch_gpios
[] = {
212 .name
= "hook_switch",
213 .report
= SND_JACK_HEADSET
,
215 .debounce_time
= 150,
219 /* After we are able to control the codec over the modem,
220 * the hook switch can be used for dynamic DAPM reconfiguration. */
221 static struct snd_soc_jack_pin ams_delta_hook_switch_pins
[] = {
225 .mask
= SND_JACK_MICROPHONE
,
229 .mask
= SND_JACK_HEADPHONE
,
234 .mask
= SND_JACK_MICROPHONE
,
239 .mask
= SND_JACK_HEADPHONE
,
246 * Modem line discipline, required for making above controls functional.
247 * Activated from userspace with ldattach, possibly invoked from udev rule.
250 /* To actually apply any modem controlled configuration changes to the codec,
251 * we must connect codec DAI pins to the modem for a moment. Be careful not
252 * to interfere with our digital mute function that shares the same hardware. */
253 static struct timer_list cx81801_timer
;
254 static bool cx81801_cmd_pending
;
255 static bool ams_delta_muted
;
256 static DEFINE_SPINLOCK(ams_delta_lock
);
258 static void cx81801_timeout(unsigned long data
)
262 spin_lock(&ams_delta_lock
);
263 cx81801_cmd_pending
= 0;
264 muted
= ams_delta_muted
;
265 spin_unlock(&ams_delta_lock
);
267 /* Reconnect the codec DAI back from the modem to the CPU DAI
268 * only if digital mute still off */
270 ams_delta_latch2_write(AMS_DELTA_LATCH2_MODEM_CODEC
, 0);
274 * Used for passing a codec structure pointer
275 * from the board initialization code to the tty line discipline.
277 static struct snd_soc_codec
*cx20442_codec
;
279 /* Line discipline .open() */
280 static int cx81801_open(struct tty_struct
*tty
)
288 * Pass the codec structure pointer for use by other ldisc callbacks,
289 * both the card and the codec specific parts.
291 tty
->disc_data
= cx20442_codec
;
293 ret
= v253_ops
.open(tty
);
296 tty
->disc_data
= NULL
;
301 /* Line discipline .close() */
302 static void cx81801_close(struct tty_struct
*tty
)
304 struct snd_soc_codec
*codec
= tty
->disc_data
;
305 struct snd_soc_dapm_context
*dapm
= &codec
->dapm
;
307 del_timer_sync(&cx81801_timer
);
309 /* Prevent the hook switch from further changing the DAPM pins */
310 INIT_LIST_HEAD(&ams_delta_hook_switch
.pins
);
317 /* Revert back to default audio input/output constellation */
318 snd_soc_dapm_mutex_lock(dapm
);
320 snd_soc_dapm_disable_pin_unlocked(dapm
, "Mouthpiece");
321 snd_soc_dapm_enable_pin_unlocked(dapm
, "Earpiece");
322 snd_soc_dapm_enable_pin_unlocked(dapm
, "Microphone");
323 snd_soc_dapm_disable_pin_unlocked(dapm
, "Speaker");
324 snd_soc_dapm_disable_pin_unlocked(dapm
, "AGCIN");
326 snd_soc_dapm_sync_unlocked(dapm
);
328 snd_soc_dapm_mutex_unlock(codec
);
331 /* Line discipline .hangup() */
332 static int cx81801_hangup(struct tty_struct
*tty
)
338 /* Line discipline .receive_buf() */
339 static void cx81801_receive(struct tty_struct
*tty
,
340 const unsigned char *cp
, char *fp
, int count
)
342 struct snd_soc_codec
*codec
= tty
->disc_data
;
343 const unsigned char *c
;
349 if (!codec
->hw_write
) {
350 /* First modem response, complete setup procedure */
352 /* Initialize timer used for config pulse generation */
353 setup_timer(&cx81801_timer
, cx81801_timeout
, 0);
355 v253_ops
.receive_buf(tty
, cp
, fp
, count
);
357 /* Link hook switch to DAPM pins */
358 ret
= snd_soc_jack_add_pins(&ams_delta_hook_switch
,
359 ARRAY_SIZE(ams_delta_hook_switch_pins
),
360 ams_delta_hook_switch_pins
);
363 "Failed to link hook switch to DAPM pins, "
364 "will continue with hook switch unlinked.\n");
369 v253_ops
.receive_buf(tty
, cp
, fp
, count
);
371 for (c
= &cp
[count
- 1]; c
>= cp
; c
--) {
374 /* Complete modem response received, apply config to codec */
376 spin_lock_bh(&ams_delta_lock
);
377 mod_timer(&cx81801_timer
, jiffies
+ msecs_to_jiffies(150));
378 apply
= !ams_delta_muted
&& !cx81801_cmd_pending
;
379 cx81801_cmd_pending
= 1;
380 spin_unlock_bh(&ams_delta_lock
);
382 /* Apply config pulse by connecting the codec to the modem
383 * if not already done */
385 ams_delta_latch2_write(AMS_DELTA_LATCH2_MODEM_CODEC
,
386 AMS_DELTA_LATCH2_MODEM_CODEC
);
391 /* Line discipline .write_wakeup() */
392 static void cx81801_wakeup(struct tty_struct
*tty
)
394 v253_ops
.write_wakeup(tty
);
397 static struct tty_ldisc_ops cx81801_ops
= {
398 .magic
= TTY_LDISC_MAGIC
,
400 .owner
= THIS_MODULE
,
401 .open
= cx81801_open
,
402 .close
= cx81801_close
,
403 .hangup
= cx81801_hangup
,
404 .receive_buf
= cx81801_receive
,
405 .write_wakeup
= cx81801_wakeup
,
410 * Even if not very useful, the sound card can still work without any of the
411 * above functonality activated. You can still control its audio input/output
412 * constellation and speakerphone gain from userspace by issuing AT commands
413 * over the modem port.
416 static int ams_delta_hw_params(struct snd_pcm_substream
*substream
,
417 struct snd_pcm_hw_params
*params
)
419 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
421 /* Set cpu DAI configuration */
422 return snd_soc_dai_set_fmt(rtd
->cpu_dai
,
423 SND_SOC_DAIFMT_DSP_A
|
424 SND_SOC_DAIFMT_NB_NF
|
425 SND_SOC_DAIFMT_CBM_CFM
);
428 static struct snd_soc_ops ams_delta_ops
= {
429 .hw_params
= ams_delta_hw_params
,
433 /* Digital mute implemented using modem/CPU multiplexer.
434 * Shares hardware with codec config pulse generation */
435 static bool ams_delta_muted
= 1;
437 static int ams_delta_digital_mute(struct snd_soc_dai
*dai
, int mute
)
441 if (ams_delta_muted
== mute
)
444 spin_lock_bh(&ams_delta_lock
);
445 ams_delta_muted
= mute
;
446 apply
= !cx81801_cmd_pending
;
447 spin_unlock_bh(&ams_delta_lock
);
450 ams_delta_latch2_write(AMS_DELTA_LATCH2_MODEM_CODEC
,
451 mute
? AMS_DELTA_LATCH2_MODEM_CODEC
: 0);
455 /* Our codec DAI probably doesn't have its own .ops structure */
456 static const struct snd_soc_dai_ops ams_delta_dai_ops
= {
457 .digital_mute
= ams_delta_digital_mute
,
460 /* Will be used if the codec ever has its own digital_mute function */
461 static int ams_delta_startup(struct snd_pcm_substream
*substream
)
463 return ams_delta_digital_mute(NULL
, 0);
466 static void ams_delta_shutdown(struct snd_pcm_substream
*substream
)
468 ams_delta_digital_mute(NULL
, 1);
473 * Card initialization
476 static int ams_delta_cx20442_init(struct snd_soc_pcm_runtime
*rtd
)
478 struct snd_soc_codec
*codec
= rtd
->codec
;
479 struct snd_soc_dapm_context
*dapm
= &codec
->dapm
;
480 struct snd_soc_dai
*codec_dai
= rtd
->codec_dai
;
481 struct snd_soc_card
*card
= rtd
->card
;
483 /* Codec is ready, now add/activate board specific controls */
485 /* Store a pointer to the codec structure for tty ldisc use */
486 cx20442_codec
= codec
;
488 /* Set up digital mute if not provided by the codec */
489 if (!codec_dai
->driver
->ops
) {
490 codec_dai
->driver
->ops
= &ams_delta_dai_ops
;
492 ams_delta_ops
.startup
= ams_delta_startup
;
493 ams_delta_ops
.shutdown
= ams_delta_shutdown
;
496 /* Add hook switch - can be used to control the codec from userspace
497 * even if line discipline fails */
498 ret
= snd_soc_jack_new(rtd
->codec
, "hook_switch",
499 SND_JACK_HEADSET
, &ams_delta_hook_switch
);
502 "Failed to allocate resources for hook switch, "
503 "will continue without one.\n");
505 ret
= snd_soc_jack_add_gpios(&ams_delta_hook_switch
,
506 ARRAY_SIZE(ams_delta_hook_switch_gpios
),
507 ams_delta_hook_switch_gpios
);
510 "Failed to set up hook switch GPIO line, "
511 "will continue with hook switch inactive.\n");
514 /* Register optional line discipline for over the modem control */
515 ret
= tty_register_ldisc(N_V253
, &cx81801_ops
);
518 "Failed to register line discipline, "
519 "will continue without any controls.\n");
523 /* Add board specific DAPM widgets and routes */
524 ret
= snd_soc_dapm_new_controls(dapm
, ams_delta_dapm_widgets
,
525 ARRAY_SIZE(ams_delta_dapm_widgets
));
528 "Failed to register DAPM controls, "
529 "will continue without any.\n");
533 ret
= snd_soc_dapm_add_routes(dapm
, ams_delta_audio_map
,
534 ARRAY_SIZE(ams_delta_audio_map
));
537 "Failed to set up DAPM routes, "
538 "will continue with codec default map.\n");
542 /* Set up initial pin constellation */
543 snd_soc_dapm_disable_pin(dapm
, "Mouthpiece");
544 snd_soc_dapm_enable_pin(dapm
, "Earpiece");
545 snd_soc_dapm_enable_pin(dapm
, "Microphone");
546 snd_soc_dapm_disable_pin(dapm
, "Speaker");
547 snd_soc_dapm_disable_pin(dapm
, "AGCIN");
548 snd_soc_dapm_disable_pin(dapm
, "AGCOUT");
550 /* Add virtual switch */
551 ret
= snd_soc_add_codec_controls(codec
, ams_delta_audio_controls
,
552 ARRAY_SIZE(ams_delta_audio_controls
));
555 "Failed to register audio mode control, "
556 "will continue without it.\n");
561 /* DAI glue - connects codec <--> CPU */
562 static struct snd_soc_dai_link ams_delta_dai_link
= {
564 .stream_name
= "CX20442",
565 .cpu_dai_name
= "omap-mcbsp.1",
566 .codec_dai_name
= "cx20442-voice",
567 .init
= ams_delta_cx20442_init
,
568 .platform_name
= "omap-pcm-audio",
569 .codec_name
= "cx20442-codec",
570 .ops
= &ams_delta_ops
,
573 /* Audio card driver */
574 static struct snd_soc_card ams_delta_audio_card
= {
576 .owner
= THIS_MODULE
,
577 .dai_link
= &ams_delta_dai_link
,
581 /* Module init/exit */
582 static int ams_delta_probe(struct platform_device
*pdev
)
584 struct snd_soc_card
*card
= &ams_delta_audio_card
;
587 card
->dev
= &pdev
->dev
;
589 ret
= snd_soc_register_card(card
);
591 dev_err(&pdev
->dev
, "snd_soc_register_card failed (%d)\n", ret
);
598 static int ams_delta_remove(struct platform_device
*pdev
)
600 struct snd_soc_card
*card
= platform_get_drvdata(pdev
);
602 if (tty_unregister_ldisc(N_V253
) != 0)
604 "failed to unregister V253 line discipline\n");
606 snd_soc_jack_free_gpios(&ams_delta_hook_switch
,
607 ARRAY_SIZE(ams_delta_hook_switch_gpios
),
608 ams_delta_hook_switch_gpios
);
610 snd_soc_unregister_card(card
);
615 #define DRV_NAME "ams-delta-audio"
617 static struct platform_driver ams_delta_driver
= {
620 .owner
= THIS_MODULE
,
622 .probe
= ams_delta_probe
,
623 .remove
= ams_delta_remove
,
626 module_platform_driver(ams_delta_driver
);
628 MODULE_AUTHOR("Janusz Krzysztofik <jkrzyszt@tis.icnet.pl>");
629 MODULE_DESCRIPTION("ALSA SoC driver for Amstrad E3 (Delta) videophone");
630 MODULE_LICENSE("GPL");
631 MODULE_ALIAS("platform:" DRV_NAME
);