Merge pull request #135 from tmobile/tmo-CFSPDK-1162-Provide-Ability-to-Call-Back-at-the-End-of-a-Tone-Sequence

Implement tone player

Author: jtbaumann

samples/tmo_shell/CMakeLists.txt

@@ -32,6 +32,7 @@ target_sources(app PRIVATE src/tmo_bq24250.c)
 target_sources(app PRIVATE src/tmo_battery_ctrl.c)
 target_sources(app PRIVATE src/tmo_sntp.c)
 target_sources(app PRIVATE src/tmo_modem.c)
+target_sources(app PRIVATE src/tmo_tone_player.c)
 target_sources_ifdef(CONFIG_WIFI app PRIVATE src/tmo_wifi.c)
 target_sources_ifdef(CONFIG_BT_SMP app PRIVATE src/tmo_smp.c)
 target_sources_ifdef(CONFIG_BT_PERIPHERAL app PRIVATE src/tmo_ble_demo.c)

samples/tmo_shell/src/tmo_shell.c

@@ -74,6 +74,8 @@ typedef int sec_tag_t;
 #include "tmo_pm_sys.h"
 #endif
 
+#include "tmo_tone_player.h"
+
 const struct device *ext_flash_dev = NULL;
 const struct device *gecko_flash_dev = NULL;
 
@@ -2463,6 +2465,19 @@ static int mountfs()
 	return rc;
 }
 
+int cmd_play_tone_file(const struct shell *shell, size_t argc, char **argv)
+{
+	if (argc == 2) {
+		if (!play_tone_bin(argv[1], NULL)) {
+			shell_fprintf(shell, SHELL_VT100_COLOR_GREEN, "Now playing %s\n", argv[1]);
+		}
+	} else {
+		shell_error(shell, "Usage: tmo buzzer player <filename>");
+		return -EINVAL;
+	}
+	return 0;
+}
+
 int cmd_play_tone(const struct shell *shell, size_t argc, char **argv)
 {
 	if (argc != 3) {
@@ -2548,6 +2563,7 @@ int cmd_tmo_buzzer_vol(const struct shell *shell, int argc, char**argv)
 SHELL_STATIC_SUBCMD_SET_CREATE(tmo_buzzer_sub,
 		SHELL_CMD(jingle, NULL, "Play TMO jingle", tmo_play_jingle),
 		SHELL_CMD(ramp, NULL, "Play ramp tune", tmo_play_ramp),
+		SHELL_CMD(player, NULL, "Play a tone file", cmd_play_tone_file),
 		SHELL_CMD(tone, NULL, "Play a tone for a time", cmd_play_tone),
 		SHELL_CMD(vol, NULL, "Set buzzer volume", cmd_tmo_buzzer_vol),
 		SHELL_SUBCMD_SET_END

samples/tmo_shell/src/tmo_tone_player.c

@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2023 T-Mobile USA, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/kernel.h>
+#include <zephyr/fs/fs.h>
+#include <zephyr/logging/log.h>
+#include <zephyr/sys/byteorder.h>
+#include "tmo_buzzer.h"
+
+LOG_MODULE_REGISTER(tmo_tone_player, LOG_LEVEL_DBG);
+
+struct note_s { 
+    uint16_t freq;
+    uint16_t dur_ms;
+};
+
+static struct note_s next_note;
+static struct fs_file_t tone_bin;
+static bool timer_running;
+static void (*song_finished_callback)(void);
+
+static void set_tone(uint16_t freq)
+{
+    pwm_set_frequency(buzzer, 0, freq);
+}
+
+static void next_note_f(struct k_timer *timer_id)
+{
+    set_tone(next_note.freq);
+
+    if (next_note.dur_ms) {
+        k_timer_start(timer_id, K_MSEC(next_note.dur_ms), K_FOREVER);
+    } else {
+        timer_running = false;
+        if (song_finished_callback)
+            song_finished_callback();
+        song_finished_callback = NULL;
+        return;
+    }
+
+    if (fs_read(&tone_bin, &next_note, sizeof(next_note)) < 4) {
+        fs_close(&tone_bin);
+        memset(&next_note, 0, sizeof(next_note));
+        return;
+    }
+
+    next_note.freq = sys_be16_to_cpu(next_note.freq);
+    next_note.dur_ms = sys_be16_to_cpu(next_note.dur_ms);
+}
+
+K_TIMER_DEFINE(next_tone, next_note_f, NULL);
+
+int play_tone_bin(char* filename, void (*finished_callback)(void))
+{
+    if (timer_running) {
+        k_timer_stop(&next_tone);
+        fs_close(&tone_bin);
+    }
+
+    song_finished_callback = finished_callback;
+
+    fs_file_t_init(&tone_bin);
+
+    if (fs_open(&tone_bin, filename, FS_O_READ)) {
+        LOG_ERR("Failed to open tone file");
+        return -EIO;
+    }
+
+    if (fs_read(&tone_bin, &next_note, sizeof(next_note)) < 4) {
+        LOG_ERR("Failed to read tone file");
+        fs_close(&tone_bin);
+        return -EIO;
+    }
+
+    next_note.freq = sys_be16_to_cpu(next_note.freq);
+    next_note.dur_ms = sys_be16_to_cpu(next_note.dur_ms);
+    timer_running = true;
+    next_note_f(&next_tone);
+
+    return 0;
+}
+
+int play_single_note(uint16_t freq, uint16_t duration, void (*finished_callback)(void))
+{
+    if (timer_running) {
+        return -EBUSY;
+    }
+    fs_close(&tone_bin);
+    next_note.freq = 0;
+    next_note.dur_ms = 0;
+
+    song_finished_callback = finished_callback;
+
+    set_tone(next_note.freq);
+
+    k_timer_start(&next_tone, K_MSEC(duration), K_FOREVER);
+
+    return 0;
+}
+
+int cancel_playback(void)
+{
+    if (timer_running) {
+        set_tone(0);
+        k_timer_stop(&next_tone);
+        fs_close(&tone_bin);
+    } else {
+        return -EALREADY;
+    }
+    return 0;
+}

samples/tmo_shell/src/tmo_tone_player.h

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2023 T-Mobile USA, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef TMO_TONE_PLAYER_H
+#define TMO_TONE_PLAYER_H
+
+/**
+ * @brief Play a tone binary file
+ * 
+ * @param filename Filename of the tone binary
+ * @param finished_callback Callback function for tone sequence finish
+ * @return 0 on sucess, negative error on failure
+ */
+int play_tone_bin(char* filename, void (*finished_callback)(void));
+
+/**
+ * @brief Play a single note
+ * 
+ * @param freq Frequency of the note
+ * @param duration Duration in milliseconds
+ * @param finished_callback Callback function for note finish
+ * @return 0 on sucess, negative error on failure
+ */
+int play_single_note(uint16_t freq, uint16_t duration, void (*finished_callback)(void));
+
+/**
+ * @brief Cancel playback of current tone sequence
+ * 
+ * @return 0 on sucess, negative error on failure
+ */
+int cancel_playback(void);
+
+#endif /* TMO_TONE_PLAYER_H */