1acc4505aa9a9b4c47df6e6f9188eba6b837d717
[releases.git] / ams-delta.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * ams-delta.c  --  SoC audio for Amstrad E3 (Delta) videophone
4  *
5  * Copyright (C) 2009 Janusz Krzysztofik <jkrzyszt@tis.icnet.pl>
6  *
7  * Initially based on sound/soc/omap/osk5912.x
8  * Copyright (C) 2008 Mistral Solutions
9  */
10
11 #include <linux/gpio/consumer.h>
12 #include <linux/spinlock.h>
13 #include <linux/tty.h>
14 #include <linux/module.h>
15
16 #include <sound/soc.h>
17 #include <sound/jack.h>
18
19 #include <asm/mach-types.h>
20
21 #include <linux/platform_data/asoc-ti-mcbsp.h>
22
23 #include "omap-mcbsp.h"
24 #include "../codecs/cx20442.h"
25
26 static struct gpio_desc *handset_mute;
27 static struct gpio_desc *handsfree_mute;
28
29 static int ams_delta_event_handset(struct snd_soc_dapm_widget *w,
30                                    struct snd_kcontrol *k, int event)
31 {
32         gpiod_set_value_cansleep(handset_mute, !SND_SOC_DAPM_EVENT_ON(event));
33         return 0;
34 }
35
36 static int ams_delta_event_handsfree(struct snd_soc_dapm_widget *w,
37                                      struct snd_kcontrol *k, int event)
38 {
39         gpiod_set_value_cansleep(handsfree_mute, !SND_SOC_DAPM_EVENT_ON(event));
40         return 0;
41 }
42
43 /* Board specific DAPM widgets */
44 static const struct snd_soc_dapm_widget ams_delta_dapm_widgets[] = {
45         /* Handset */
46         SND_SOC_DAPM_MIC("Mouthpiece", NULL),
47         SND_SOC_DAPM_HP("Earpiece", ams_delta_event_handset),
48         /* Handsfree/Speakerphone */
49         SND_SOC_DAPM_MIC("Microphone", NULL),
50         SND_SOC_DAPM_SPK("Speaker", ams_delta_event_handsfree),
51 };
52
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"},
57
58         {"MIC", NULL, "Microphone"},
59         {"Speaker", NULL, "SPKOUT"},
60 };
61
62 /*
63  * Controls, functional after the modem line discipline is activated.
64  */
65
66 /* Virtual switch: audio input/output constellations */
67 static const char *ams_delta_audio_mode[] =
68         {"Mixed", "Handset", "Handsfree", "Speakerphone"};
69
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
76
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))
84
85 static const unsigned short ams_delta_audio_mode_pins[] = {
86         AMS_DELTA_MIXED,
87         AMS_DELTA_HANDSET,
88         AMS_DELTA_HANDSFREE,
89         AMS_DELTA_SPEAKERPHONE,
90 };
91
92 static unsigned short ams_delta_audio_agc;
93
94 /*
95  * Used for passing a codec structure pointer
96  * from the board initialization code to the tty line discipline.
97  */
98 static struct snd_soc_component *cx20442_codec;
99
100 static int ams_delta_set_audio_mode(struct snd_kcontrol *kcontrol,
101                                         struct snd_ctl_elem_value *ucontrol)
102 {
103         struct snd_soc_card *card = snd_kcontrol_chip(kcontrol);
104         struct snd_soc_dapm_context *dapm = &card->dapm;
105         struct soc_enum *control = (struct soc_enum *)kcontrol->private_value;
106         unsigned short pins;
107         int pin, changed = 0;
108
109         /* Refuse any mode changes if we are not able to control the codec. */
110         if (!cx20442_codec->card->pop_time)
111                 return -EUNATCH;
112
113         if (ucontrol->value.enumerated.item[0] >= control->items)
114                 return -EINVAL;
115
116         snd_soc_dapm_mutex_lock(dapm);
117
118         /* Translate selection to bitmap */
119         pins = ams_delta_audio_mode_pins[ucontrol->value.enumerated.item[0]];
120
121         /* Setup pins after corresponding bits if changed */
122         pin = !!(pins & (1 << AMS_DELTA_MOUTHPIECE));
123
124         if (pin != snd_soc_dapm_get_pin_status(dapm, "Mouthpiece")) {
125                 changed = 1;
126                 if (pin)
127                         snd_soc_dapm_enable_pin_unlocked(dapm, "Mouthpiece");
128                 else
129                         snd_soc_dapm_disable_pin_unlocked(dapm, "Mouthpiece");
130         }
131         pin = !!(pins & (1 << AMS_DELTA_EARPIECE));
132         if (pin != snd_soc_dapm_get_pin_status(dapm, "Earpiece")) {
133                 changed = 1;
134                 if (pin)
135                         snd_soc_dapm_enable_pin_unlocked(dapm, "Earpiece");
136                 else
137                         snd_soc_dapm_disable_pin_unlocked(dapm, "Earpiece");
138         }
139         pin = !!(pins & (1 << AMS_DELTA_MICROPHONE));
140         if (pin != snd_soc_dapm_get_pin_status(dapm, "Microphone")) {
141                 changed = 1;
142                 if (pin)
143                         snd_soc_dapm_enable_pin_unlocked(dapm, "Microphone");
144                 else
145                         snd_soc_dapm_disable_pin_unlocked(dapm, "Microphone");
146         }
147         pin = !!(pins & (1 << AMS_DELTA_SPEAKER));
148         if (pin != snd_soc_dapm_get_pin_status(dapm, "Speaker")) {
149                 changed = 1;
150                 if (pin)
151                         snd_soc_dapm_enable_pin_unlocked(dapm, "Speaker");
152                 else
153                         snd_soc_dapm_disable_pin_unlocked(dapm, "Speaker");
154         }
155         pin = !!(pins & (1 << AMS_DELTA_AGC));
156         if (pin != ams_delta_audio_agc) {
157                 ams_delta_audio_agc = pin;
158                 changed = 1;
159                 if (pin)
160                         snd_soc_dapm_enable_pin_unlocked(dapm, "AGCIN");
161                 else
162                         snd_soc_dapm_disable_pin_unlocked(dapm, "AGCIN");
163         }
164
165         if (changed)
166                 snd_soc_dapm_sync_unlocked(dapm);
167
168         snd_soc_dapm_mutex_unlock(dapm);
169
170         return changed;
171 }
172
173 static int ams_delta_get_audio_mode(struct snd_kcontrol *kcontrol,
174                                         struct snd_ctl_elem_value *ucontrol)
175 {
176         struct snd_soc_card *card = snd_kcontrol_chip(kcontrol);
177         struct snd_soc_dapm_context *dapm = &card->dapm;
178         unsigned short pins, mode;
179
180         pins = ((snd_soc_dapm_get_pin_status(dapm, "Mouthpiece") <<
181                                                         AMS_DELTA_MOUTHPIECE) |
182                         (snd_soc_dapm_get_pin_status(dapm, "Earpiece") <<
183                                                         AMS_DELTA_EARPIECE));
184         if (pins)
185                 pins |= (snd_soc_dapm_get_pin_status(dapm, "Microphone") <<
186                                                         AMS_DELTA_MICROPHONE);
187         else
188                 pins = ((snd_soc_dapm_get_pin_status(dapm, "Microphone") <<
189                                                         AMS_DELTA_MICROPHONE) |
190                         (snd_soc_dapm_get_pin_status(dapm, "Speaker") <<
191                                                         AMS_DELTA_SPEAKER) |
192                         (ams_delta_audio_agc << AMS_DELTA_AGC));
193
194         for (mode = 0; mode < ARRAY_SIZE(ams_delta_audio_mode); mode++)
195                 if (pins == ams_delta_audio_mode_pins[mode])
196                         break;
197
198         if (mode >= ARRAY_SIZE(ams_delta_audio_mode))
199                 return -EINVAL;
200
201         ucontrol->value.enumerated.item[0] = mode;
202
203         return 0;
204 }
205
206 static SOC_ENUM_SINGLE_EXT_DECL(ams_delta_audio_enum,
207                                       ams_delta_audio_mode);
208
209 static const struct snd_kcontrol_new ams_delta_audio_controls[] = {
210         SOC_ENUM_EXT("Audio Mode", ams_delta_audio_enum,
211                         ams_delta_get_audio_mode, ams_delta_set_audio_mode),
212 };
213
214 /* Hook switch */
215 static struct snd_soc_jack ams_delta_hook_switch;
216 static struct snd_soc_jack_gpio ams_delta_hook_switch_gpios[] = {
217         {
218                 .name = "hook_switch",
219                 .report = SND_JACK_HEADSET,
220                 .invert = 1,
221                 .debounce_time = 150,
222         }
223 };
224
225 /* After we are able to control the codec over the modem,
226  * the hook switch can be used for dynamic DAPM reconfiguration. */
227 static struct snd_soc_jack_pin ams_delta_hook_switch_pins[] = {
228         /* Handset */
229         {
230                 .pin = "Mouthpiece",
231                 .mask = SND_JACK_MICROPHONE,
232         },
233         {
234                 .pin = "Earpiece",
235                 .mask = SND_JACK_HEADPHONE,
236         },
237         /* Handsfree */
238         {
239                 .pin = "Microphone",
240                 .mask = SND_JACK_MICROPHONE,
241                 .invert = 1,
242         },
243         {
244                 .pin = "Speaker",
245                 .mask = SND_JACK_HEADPHONE,
246                 .invert = 1,
247         },
248 };
249
250
251 /*
252  * Modem line discipline, required for making above controls functional.
253  * Activated from userspace with ldattach, possibly invoked from udev rule.
254  */
255
256 /* To actually apply any modem controlled configuration changes to the codec,
257  * we must connect codec DAI pins to the modem for a moment.  Be careful not
258  * to interfere with our digital mute function that shares the same hardware. */
259 static struct timer_list cx81801_timer;
260 static bool cx81801_cmd_pending;
261 static bool ams_delta_muted;
262 static DEFINE_SPINLOCK(ams_delta_lock);
263 static struct gpio_desc *gpiod_modem_codec;
264
265 static void cx81801_timeout(struct timer_list *unused)
266 {
267         int muted;
268
269         spin_lock(&ams_delta_lock);
270         cx81801_cmd_pending = 0;
271         muted = ams_delta_muted;
272         spin_unlock(&ams_delta_lock);
273
274         /* Reconnect the codec DAI back from the modem to the CPU DAI
275          * only if digital mute still off */
276         if (!muted)
277                 gpiod_set_value(gpiod_modem_codec, 0);
278 }
279
280 /* Line discipline .open() */
281 static int cx81801_open(struct tty_struct *tty)
282 {
283         int ret;
284
285         if (!cx20442_codec)
286                 return -ENODEV;
287
288         /*
289          * Pass the codec structure pointer for use by other ldisc callbacks,
290          * both the card and the codec specific parts.
291          */
292         tty->disc_data = cx20442_codec;
293
294         ret = v253_ops.open(tty);
295
296         if (ret < 0)
297                 tty->disc_data = NULL;
298
299         return ret;
300 }
301
302 /* Line discipline .close() */
303 static void cx81801_close(struct tty_struct *tty)
304 {
305         struct snd_soc_component *component = tty->disc_data;
306         struct snd_soc_dapm_context *dapm;
307
308         del_timer_sync(&cx81801_timer);
309
310         /* Prevent the hook switch from further changing the DAPM pins */
311         INIT_LIST_HEAD(&ams_delta_hook_switch.pins);
312
313         if (!component)
314                 return;
315
316         v253_ops.close(tty);
317
318         dapm = &component->card->dapm;
319
320         /* Revert back to default audio input/output constellation */
321         snd_soc_dapm_mutex_lock(dapm);
322
323         snd_soc_dapm_disable_pin_unlocked(dapm, "Mouthpiece");
324         snd_soc_dapm_enable_pin_unlocked(dapm, "Earpiece");
325         snd_soc_dapm_enable_pin_unlocked(dapm, "Microphone");
326         snd_soc_dapm_disable_pin_unlocked(dapm, "Speaker");
327         snd_soc_dapm_disable_pin_unlocked(dapm, "AGCIN");
328
329         snd_soc_dapm_sync_unlocked(dapm);
330
331         snd_soc_dapm_mutex_unlock(dapm);
332 }
333
334 /* Line discipline .hangup() */
335 static void cx81801_hangup(struct tty_struct *tty)
336 {
337         cx81801_close(tty);
338 }
339
340 /* Line discipline .receive_buf() */
341 static void cx81801_receive(struct tty_struct *tty, const unsigned char *cp,
342                 const char *fp, int count)
343 {
344         struct snd_soc_component *component = tty->disc_data;
345         const unsigned char *c;
346         int apply, ret;
347
348         if (!component)
349                 return;
350
351         if (!component->card->pop_time) {
352                 /* First modem response, complete setup procedure */
353
354                 /* Initialize timer used for config pulse generation */
355                 timer_setup(&cx81801_timer, cx81801_timeout, 0);
356
357                 v253_ops.receive_buf(tty, cp, fp, count);
358
359                 /* Link hook switch to DAPM pins */
360                 ret = snd_soc_jack_add_pins(&ams_delta_hook_switch,
361                                         ARRAY_SIZE(ams_delta_hook_switch_pins),
362                                         ams_delta_hook_switch_pins);
363                 if (ret)
364                         dev_warn(component->dev,
365                                 "Failed to link hook switch to DAPM pins, "
366                                 "will continue with hook switch unlinked.\n");
367
368                 return;
369         }
370
371         v253_ops.receive_buf(tty, cp, fp, count);
372
373         for (c = &cp[count - 1]; c >= cp; c--) {
374                 if (*c != '\r')
375                         continue;
376                 /* Complete modem response received, apply config to codec */
377
378                 spin_lock_bh(&ams_delta_lock);
379                 mod_timer(&cx81801_timer, jiffies + msecs_to_jiffies(150));
380                 apply = !ams_delta_muted && !cx81801_cmd_pending;
381                 cx81801_cmd_pending = 1;
382                 spin_unlock_bh(&ams_delta_lock);
383
384                 /* Apply config pulse by connecting the codec to the modem
385                  * if not already done */
386                 if (apply)
387                         gpiod_set_value(gpiod_modem_codec, 1);
388                 break;
389         }
390 }
391
392 /* Line discipline .write_wakeup() */
393 static void cx81801_wakeup(struct tty_struct *tty)
394 {
395         v253_ops.write_wakeup(tty);
396 }
397
398 static struct tty_ldisc_ops cx81801_ops = {
399         .name = "cx81801",
400         .num = N_V253,
401         .owner = THIS_MODULE,
402         .open = cx81801_open,
403         .close = cx81801_close,
404         .hangup = cx81801_hangup,
405         .receive_buf = cx81801_receive,
406         .write_wakeup = cx81801_wakeup,
407 };
408
409
410 /*
411  * Even if not very useful, the sound card can still work without any of the
412  * above functionality activated.  You can still control its audio input/output
413  * constellation and speakerphone gain from userspace by issuing AT commands
414  * over the modem port.
415  */
416
417 static struct snd_soc_ops ams_delta_ops;
418
419
420 /* Digital mute implemented using modem/CPU multiplexer.
421  * Shares hardware with codec config pulse generation */
422 static bool ams_delta_muted = 1;
423
424 static int ams_delta_mute(struct snd_soc_dai *dai, int mute, int direction)
425 {
426         int apply;
427
428         if (ams_delta_muted == mute)
429                 return 0;
430
431         spin_lock_bh(&ams_delta_lock);
432         ams_delta_muted = mute;
433         apply = !cx81801_cmd_pending;
434         spin_unlock_bh(&ams_delta_lock);
435
436         if (apply)
437                 gpiod_set_value(gpiod_modem_codec, !!mute);
438         return 0;
439 }
440
441 /* Our codec DAI probably doesn't have its own .ops structure */
442 static const struct snd_soc_dai_ops ams_delta_dai_ops = {
443         .mute_stream = ams_delta_mute,
444         .no_capture_mute = 1,
445 };
446
447 /* Will be used if the codec ever has its own digital_mute function */
448 static int ams_delta_startup(struct snd_pcm_substream *substream)
449 {
450         return ams_delta_mute(NULL, 0, substream->stream);
451 }
452
453 static void ams_delta_shutdown(struct snd_pcm_substream *substream)
454 {
455         ams_delta_mute(NULL, 1, substream->stream);
456 }
457
458
459 /*
460  * Card initialization
461  */
462
463 static int ams_delta_cx20442_init(struct snd_soc_pcm_runtime *rtd)
464 {
465         struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
466         struct snd_soc_card *card = rtd->card;
467         struct snd_soc_dapm_context *dapm = &card->dapm;
468         int ret;
469         /* Codec is ready, now add/activate board specific controls */
470
471         /* Store a pointer to the codec structure for tty ldisc use */
472         cx20442_codec = asoc_rtd_to_codec(rtd, 0)->component;
473
474         /* Add hook switch - can be used to control the codec from userspace
475          * even if line discipline fails */
476         ret = snd_soc_card_jack_new_pins(card, "hook_switch", SND_JACK_HEADSET,
477                                          &ams_delta_hook_switch, NULL, 0);
478         if (ret)
479                 dev_warn(card->dev,
480                                 "Failed to allocate resources for hook switch, "
481                                 "will continue without one.\n");
482         else {
483                 ret = snd_soc_jack_add_gpiods(card->dev, &ams_delta_hook_switch,
484                                         ARRAY_SIZE(ams_delta_hook_switch_gpios),
485                                         ams_delta_hook_switch_gpios);
486                 if (ret)
487                         dev_warn(card->dev,
488                                 "Failed to set up hook switch GPIO line, "
489                                 "will continue with hook switch inactive.\n");
490         }
491
492         gpiod_modem_codec = devm_gpiod_get(card->dev, "modem_codec",
493                                            GPIOD_OUT_HIGH);
494         if (IS_ERR(gpiod_modem_codec)) {
495                 dev_warn(card->dev, "Failed to obtain modem_codec GPIO\n");
496                 return 0;
497         }
498
499         /* Set up digital mute if not provided by the codec */
500         if (!codec_dai->driver->ops) {
501                 codec_dai->driver->ops = &ams_delta_dai_ops;
502         } else {
503                 ams_delta_ops.startup = ams_delta_startup;
504                 ams_delta_ops.shutdown = ams_delta_shutdown;
505         }
506
507         /* Register optional line discipline for over the modem control */
508         ret = tty_register_ldisc(&cx81801_ops);
509         if (ret) {
510                 dev_warn(card->dev,
511                                 "Failed to register line discipline, "
512                                 "will continue without any controls.\n");
513                 return 0;
514         }
515
516         /* Set up initial pin constellation */
517         snd_soc_dapm_disable_pin(dapm, "Mouthpiece");
518         snd_soc_dapm_disable_pin(dapm, "Speaker");
519         snd_soc_dapm_disable_pin(dapm, "AGCIN");
520         snd_soc_dapm_disable_pin(dapm, "AGCOUT");
521
522         return 0;
523 }
524
525 /* DAI glue - connects codec <--> CPU */
526 SND_SOC_DAILINK_DEFS(cx20442,
527         DAILINK_COMP_ARRAY(COMP_CPU("omap-mcbsp.1")),
528         DAILINK_COMP_ARRAY(COMP_CODEC("cx20442-codec", "cx20442-voice")),
529         DAILINK_COMP_ARRAY(COMP_PLATFORM("omap-mcbsp.1")));
530
531 static struct snd_soc_dai_link ams_delta_dai_link = {
532         .name = "CX20442",
533         .stream_name = "CX20442",
534         .init = ams_delta_cx20442_init,
535         .ops = &ams_delta_ops,
536         .dai_fmt = SND_SOC_DAIFMT_DSP_A | SND_SOC_DAIFMT_NB_NF |
537                    SND_SOC_DAIFMT_CBM_CFM,
538         SND_SOC_DAILINK_REG(cx20442),
539 };
540
541 /* Audio card driver */
542 static struct snd_soc_card ams_delta_audio_card = {
543         .name = "AMS_DELTA",
544         .owner = THIS_MODULE,
545         .dai_link = &ams_delta_dai_link,
546         .num_links = 1,
547
548         .controls = ams_delta_audio_controls,
549         .num_controls = ARRAY_SIZE(ams_delta_audio_controls),
550         .dapm_widgets = ams_delta_dapm_widgets,
551         .num_dapm_widgets = ARRAY_SIZE(ams_delta_dapm_widgets),
552         .dapm_routes = ams_delta_audio_map,
553         .num_dapm_routes = ARRAY_SIZE(ams_delta_audio_map),
554 };
555
556 /* Module init/exit */
557 static int ams_delta_probe(struct platform_device *pdev)
558 {
559         struct snd_soc_card *card = &ams_delta_audio_card;
560         int ret;
561
562         card->dev = &pdev->dev;
563
564         handset_mute = devm_gpiod_get(card->dev, "handset_mute",
565                                       GPIOD_OUT_HIGH);
566         if (IS_ERR(handset_mute))
567                 return PTR_ERR(handset_mute);
568
569         handsfree_mute = devm_gpiod_get(card->dev, "handsfree_mute",
570                                         GPIOD_OUT_HIGH);
571         if (IS_ERR(handsfree_mute))
572                 return PTR_ERR(handsfree_mute);
573
574         ret = snd_soc_register_card(card);
575         if (ret) {
576                 dev_err(&pdev->dev, "snd_soc_register_card failed (%d)\n", ret);
577                 card->dev = NULL;
578                 return ret;
579         }
580         return 0;
581 }
582
583 static int ams_delta_remove(struct platform_device *pdev)
584 {
585         struct snd_soc_card *card = platform_get_drvdata(pdev);
586
587         tty_unregister_ldisc(&cx81801_ops);
588
589         snd_soc_unregister_card(card);
590         card->dev = NULL;
591         return 0;
592 }
593
594 #define DRV_NAME "ams-delta-audio"
595
596 static struct platform_driver ams_delta_driver = {
597         .driver = {
598                 .name = DRV_NAME,
599         },
600         .probe = ams_delta_probe,
601         .remove = ams_delta_remove,
602 };
603
604 module_platform_driver(ams_delta_driver);
605
606 MODULE_AUTHOR("Janusz Krzysztofik <jkrzyszt@tis.icnet.pl>");
607 MODULE_DESCRIPTION("ALSA SoC driver for Amstrad E3 (Delta) videophone");
608 MODULE_LICENSE("GPL");
609 MODULE_ALIAS("platform:" DRV_NAME);