usb serial debug interface & usb serial async msg (#2111)

* add serial_debug * not use OSS * add path print * add string print and vec * clean up * clean up * format * add an async blocking bool * add an async blocking bool - comment * protect the unexpected tx * naming * remove demo code
2025-05-15 13:12:18 -04:00 · 2024-04-18 18:10:34 +08:00 · 2024-04-18 18:10:34 +08:00 · b2da21b88a
commit b2da21b88a
parent bb1b703dc1
6 changed files with 177 additions and 1 deletions
--- a/firmware/application/usb_serial_asyncmsg.hpp
+++ b/firmware/application/usb_serial_asyncmsg.hpp
@ -0,0 +1,154 @@
+/*
+ * Copyright (C) 2015 Jared Boone, ShareBrained Technology, Inc.
+ * Copyright (C) 2017 Furrtek
+ * Copyleft (ɔ) 2024 zxkmm with the GPL license
+ *
+ * This file is part of PortaPack.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef USB_SERIAL_AYNCMSG_HPP
+#define USB_SERIAL_AYNCMSG_HPP
+
+#include <vector>
+#include <string>
+#include <sstream>
+#include <chprintf.h>
+#include "usb_serial_device_to_host.h"
+
+class UsbSerialAsyncmsg {
+   public:
+    template <typename STRINGCOVER>
+    static void asyncmsg(const STRINGCOVER& data);
+
+    template <typename VECTORCOVER>
+    static void asyncmsg(const std::vector<VECTORCOVER>& data);
+};
+
+/*Notes:
+ * - Don't use MayhemHub since it currently not support real time serial output
+ * - If you don't use this class linker will drop it so it won't use any space
+ * - so delete all debug things before you push your code to production
+ * - use this client to filter only PP devices: https://github.com/zxkmm/Pyserial-Demo-portapack
+ * - usage:
+ *        #include "usb_serial_debug_bridge.hpp"
+ *        UsbSerialAsyncmsg::asyncmsg("Hello PP");
+ * */
+
+/// value
+// to_string_bin/ to_string_decimal/ to_string_hex/ to_string_hex_array/ to_string_dec_uint/ to_string_dec_int etc seems usellss so i didn't add them here
+
+template <>
+// usage:     UsbSerialAsyncmsg::asyncmsg(num);
+void UsbSerialAsyncmsg::asyncmsg<int64_t>(const int64_t& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", to_string_dec_int(data).c_str());
+}
+
+template <>
+void UsbSerialAsyncmsg::asyncmsg<int32_t>(const int32_t& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", to_string_dec_int(data).c_str());
+}
+
+template <>
+void UsbSerialAsyncmsg::asyncmsg<int16_t>(const int16_t& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", to_string_dec_int(data).c_str());
+}
+
+template <>
+void UsbSerialAsyncmsg::asyncmsg<int8_t>(const int8_t& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", to_string_dec_int(data).c_str());
+}
+
+template <>
+void UsbSerialAsyncmsg::asyncmsg<uint8_t>(const uint8_t& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", to_string_dec_int(data).c_str());
+}
+
+template <>
+void UsbSerialAsyncmsg::asyncmsg<uint16_t>(const uint16_t& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", to_string_dec_int(data).c_str());
+}
+
+template <>
+void UsbSerialAsyncmsg::asyncmsg<uint32_t>(const uint32_t& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", to_string_dec_int(data).c_str());
+}
+
+template <>
+void UsbSerialAsyncmsg::asyncmsg<uint64_t>(const uint64_t& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", to_string_dec_int(data).c_str());
+}
+
+/// fs things
+
+template <>
+// usage:     UsbSerialAsyncmsg::asyncmsg(path);
+void UsbSerialAsyncmsg::asyncmsg<std::filesystem::path>(const std::filesystem::path& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    std::string path_str = data.string();
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", path_str.c_str());
+}
+
+/// string
+template <>
+// usage:     UsbSerialAsyncmsg::asyncmsg(str);
+void UsbSerialAsyncmsg::asyncmsg<std::string>(const std::string& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    chprintf((BaseSequentialStream*)&SUSBD1, "%s\r\n", data.c_str());
+}
+
+/// vec worker
+// ussgae:    UsbSerialAsyncmsg::asyncmsg(vec);
+template <typename VECTORCOVER>
+void UsbSerialAsyncmsg::asyncmsg(const std::vector<VECTORCOVER>& data) {
+    if (!portapack::async_tx_enabled) {
+        return;
+    }
+    for (const auto& item : data) {
+        asyncmsg(item);
+    }
+}
+
+#endif  // USB_SERIAL_AYNCMSG_HPP