FF.CFG: New option notify-volume= for notifying on insert/eject via speaker.

Refs #716

Author: keirf

examples/FF.CFG

@@ -273,6 +273,14 @@ nav-scroll-pause = 300
 # Values: 0 <= N <= 20
 step-volume = 10
 
+# Speaker volume for insert, eject, and slot-number notifications.
+# Slot number is indicated by a sequence of beeps when an image is mounted
+# iff "slotnr" is specified. The slot number is then notified by a sequence of
+# long beeps (each counting +5), followed by a sequence of short beeps
+# (each counting +1).
+# Values: N[,slotnr] (0 <= N <= 15)
+notify-volume = 0
+
 # Report the specified version number to host software
 # Values: <quoted-string> ("" means report real version)
 # eg. da-report-version = "v3.0.0.0"

inc/config.h

@@ -167,6 +167,9 @@ struct packed ff_cfg {
     uint8_t max_cyl;
     uint16_t osd_display_order;
     uint8_t osd_columns;
+#define NOTIFY_volume_mask 15
+#define NOTIFY_slotnr      (1<<4)
+    uint8_t notify_volume;
 };
 
 extern struct ff_cfg ff_cfg;

inc/util.h

@@ -120,6 +120,8 @@ extern uint8_t display_type;
 /* Speaker. */
 void speaker_init(void);
 void speaker_pulse(void);
+void speaker_notify_insert(unsigned int slotnr);
+void speaker_notify_eject(void);
 
 /* Display: 3-digit 7-segment display */
 void led_7seg_init(void);

scripts/mk_config.py

@@ -46,6 +46,15 @@ def main(argv):
                     else:
                         opts += ['DISPLAY_' + x]
                 val = '|'.join(opts)
+            elif opt == "notify-volume":
+                opts = []
+                for x in val.split(","):
+                    vol = re.match("([0-9]+)", x)
+                    if vol:
+                        opts.append(vol.group(1))
+                    else:
+                        opts.append('NOTIFY_' + x)
+                val = '|'.join(opts)
             elif opt == "display-order" or opt == "osd-display-order":
                 if val == "default":
                     val = "DORD_" + val

src/gotek/speaker.c

@@ -59,6 +59,88 @@ void speaker_pulse(void)
     timer_set(&pulse.timer, now + volume*volume*(TIME_MHZ/3));
 }
 
+static void speaker_hz(unsigned int hz, unsigned int ms)
+{
+    unsigned int vol = (ff_cfg.notify_volume & NOTIFY_volume_mask) + 1;
+    unsigned int period = STK_MHZ * 1000000 / hz;
+    unsigned int period_on = period * vol * vol / (2*400);
+    unsigned int nr = hz * ms / 1000;
+    while (nr--) {
+        gpio_write_pin(gpio_spk, pin_spk, TRUE);
+        delay_ticks(period_on);
+        gpio_write_pin(gpio_spk, pin_spk, FALSE);
+        delay_ticks(period - period_on);
+    }
+}
+
+static void speaker_lock(void)
+{
+    uint32_t oldpri;
+    oldpri = IRQ_save(TIMER_IRQ_PRI);
+    timer_cancel(&pulse.timer);
+    pulse.state = STATE_masked;
+    IRQ_restore(oldpri);
+}
+
+static void speaker_unlock(void)
+{
+    pulse.state = STATE_idle;
+}
+
+static void speaker_notify_slot(unsigned int nr)
+{
+    while (nr >= 5) {
+        speaker_hz(1500, 100);
+        nr -= 5;
+        if (nr != 0)
+            delay_ms(120);
+    }
+
+    while (nr != 0) {
+        speaker_hz(1500, 40);
+        nr -= 1;
+        if (nr != 0)
+            delay_ms(120);
+    }
+}
+
+void speaker_notify_insert(unsigned int slotnr)
+{
+    if ((ff_cfg.notify_volume & NOTIFY_volume_mask) == 0)
+        return;
+
+    speaker_lock();
+
+    speaker_hz(880, 40); /* a5 */
+    delay_ms(20);
+    speaker_hz(784, 40); /* g5 */
+    delay_ms(20);
+    speaker_hz(1046, 60); /* c6 */
+
+    if (ff_cfg.notify_volume & NOTIFY_slotnr) {
+        delay_ms(300);
+        speaker_notify_slot(slotnr);
+    }
+
+    speaker_unlock();
+}
+
+void speaker_notify_eject(void)
+{
+    if ((ff_cfg.notify_volume & NOTIFY_volume_mask) == 0)
+        return;
+
+    speaker_lock();
+
+    speaker_hz(932, 40); /* a#5 */
+    delay_ms(20);
+    speaker_hz(831, 40); /* g#5 */
+    delay_ms(20);
+    speaker_hz(659, 60); /* e5 */
+
+    speaker_unlock();
+}
+
 /*
  * Local variables:
  * mode: C

src/main.c

@@ -1280,6 +1280,25 @@ static void read_ff_cfg(void)
             break;
         }
 
+        case FFCFG_notify_volume: {
+            char *p, *q;
+            ff_cfg.notify_volume = 0;
+            for (p = opts.arg; *p != '\0'; p = q) {
+                for (q = p; *q && *q != ','; q++)
+                    continue;
+                if (*q == ',')
+                    *q++ = '\0';
+                if (!strcmp(p, "slotnr")) {
+                    ff_cfg.notify_volume |= NOTIFY_slotnr;
+                } else {
+                    ff_cfg.notify_volume &= ~NOTIFY_volume_mask;
+                    ff_cfg.notify_volume |= strtol(p, NULL, 10)
+                        & NOTIFY_volume_mask;
+                }
+            }
+            break;
+        }
+
         case FFCFG_da_report_version:
             memset(ff_cfg.da_report_version, 0,
                    sizeof(ff_cfg.da_report_version));
@@ -2689,8 +2708,10 @@ static int floppy_main(void *unused)
             b = B_SELECT;
         } else {
             floppy_arena_teardown();
+            speaker_notify_insert(cfg.slot_nr);
             fres = F_call_cancellable(run_floppy, &b);
             floppy_cancel();
+            speaker_notify_eject();
             assert_volume_connected();
             if ((b != 0) && (display_type == DT_LCD_OLED)) {
                 /* Immediate visual indication of button press. */