I2cshell (#2348)

I2C shell implementation.

firmware/application/CMakeLists.txt

@@ -117,6 +117,7 @@ set(CSRC
 	usb_serial_descriptor.c
 	usb_serial_endpoints.c
 	usb_serial_device_to_host.c
+	i2c_device_to_host.c
 	${HACKRF_PATH}/firmware/common/usb.c
 	${HACKRF_PATH}/firmware/common/usb_queue.c
 	${HACKRF_PATH}/firmware/hackrf_usb/usb_device.c

firmware/application/apps/ui_external_module_view.cpp

@@ -80,7 +80,7 @@ void ExternalModuleView::on_tick_second() {
             continue;
         }
 
-        std::string btnText = (std::string) "App " + std::to_string(device_info->application_count) + ": " + (const char*)appInfo->app_name;
+        std::string btnText = (std::string) "App " + std::to_string(i + 1) + ": " + (const char*)appInfo->app_name;
 
         switch (appInfo->menu_location) {
             case app_location_t::UTILITIES:

firmware/application/i2c_device_to_host.c

@@ -0,0 +1,110 @@
+/*
+ * Copyright (C) 2023 Bernd Herzog
+ * Copyright (C) 2024 HTotoo
+ *
+ * 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.
+ */
+
+#include "i2c_device_to_host.h"
+#include "i2cdevmanager_c_api.h"
+#include <string.h>
+
+I2CShellDriver I2CD1;
+
+// pp to i2c data tx
+static void onotifyi2c(GenericQueue* qp) {
+    I2CShellDriver* sdp = chQGetLink(qp);
+    uint8_t buff[I2CSHELL_BUFFERS_SIZE];
+    int n = chOQGetFullI(&sdp->oqueue);
+    if (n > I2CSHELL_BUFFERS_SIZE) n = I2CSHELL_BUFFERS_SIZE;  // don't overflow
+    if (n > 0) {
+        for (int i = 0; i < n; i++) {
+            buff[i] = chOQGetI(&sdp->oqueue);
+        }
+        int ret;
+        chSysUnlock();
+        do {
+            ret = oNofityI2cFromShell(&buff[0], n);  // i2c_write
+            if (ret == -1)
+                chThdSleepMilliseconds(1);
+        } while (ret == -1);
+        chSysLock();
+    }
+}
+
+static size_t write(void* ip, const uint8_t* bp, size_t n) {
+    return chOQWriteTimeout(&((I2CShellDriver*)ip)->oqueue, bp,
+                            n, TIME_INFINITE);
+}
+
+static size_t read(void* ip, uint8_t* bp, size_t n) {
+    return chIQReadTimeout(&((I2CShellDriver*)ip)->iqueue, bp,
+                           n, TIME_INFINITE);
+}
+
+static msg_t put(void* ip, uint8_t b) {
+    return chOQPutTimeout(&((I2CShellDriver*)ip)->oqueue, b, TIME_INFINITE);
+}
+
+static msg_t get(void* ip) {
+    return chIQGetTimeout(&((I2CShellDriver*)ip)->iqueue, TIME_INFINITE);
+}
+
+static msg_t putt(void* ip, uint8_t b, systime_t timeout) {
+    return chOQPutTimeout(&((I2CShellDriver*)ip)->oqueue, b, timeout);
+}
+
+static msg_t gett(void* ip, systime_t timeout) {
+    return chIQGetTimeout(&((I2CShellDriver*)ip)->iqueue, timeout);
+}
+
+static size_t writet(void* ip, const uint8_t* bp, size_t n, systime_t time) {
+    return chOQWriteTimeout(&((I2CShellDriver*)ip)->oqueue, bp, n, time);
+}
+
+static size_t readt(void* ip, uint8_t* bp, size_t n, systime_t time) {
+    return chIQReadTimeout(&((I2CShellDriver*)ip)->iqueue, bp, n, time);
+}
+
+static const struct I2CShellDriverVMT vmt = {
+    write, read, put, get,
+    putt, gett, writet, readt};
+
+void init_i2c_shell_driver(I2CShellDriver* sdp) {
+    sdp->vmt = &vmt;
+    chIQInit(&sdp->iqueue, sdp->ib, I2CSHELL_BUFFERS_SIZE, NULL, sdp);
+    chOQInit(&sdp->oqueue, sdp->ob, I2CSHELL_BUFFERS_SIZE, onotifyi2c, sdp);
+}
+
+// i2c->pp data rx
+void complete_i2chost_to_device_transfer(uint8_t* data, size_t length) {
+    chSysLock();
+    for (unsigned int i = 0; i < length; i++) {
+        msg_t ret;
+        do {
+            ret = chIQPutI(&I2CD1.iqueue, data[i]);
+            if (ret == Q_FULL) {
+                chSysUnlock();
+                chThdSleepMilliseconds(1);  // wait for shell thread when buffer is full
+                chSysLock();
+            }
+
+        } while (ret == Q_FULL);
+    }
+    chSysUnlock();
+}

firmware/application/i2c_device_to_host.h

@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2023 Bernd Herzog
+ * Copyright (C) 2024 HTotoo
+ *
+ * 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 __I2C_DEVICE_TO_HOST_H
+#define __I2C_DEVICE_TO_HOST_H
+
+#include "ch.h"
+#include "hal.h"
+
+#ifndef I2CSHELL_BUFFERS_SIZE
+#define I2CSHELL_BUFFERS_SIZE 64
+#endif
+
+struct I2CShellDriverVMT {
+    _base_asynchronous_channel_methods
+};
+
+struct I2CShellDriver {
+    /** @brief Virtual Methods Table.*/
+    const struct I2CShellDriverVMT* vmt;
+    InputQueue iqueue;                 /* Output queue.*/
+    OutputQueue oqueue;                /* Input circular buffer.*/
+    uint8_t ib[I2CSHELL_BUFFERS_SIZE]; /* Output circular buffer.*/
+    uint8_t ob[I2CSHELL_BUFFERS_SIZE];
+};
+
+typedef struct I2CShellDriver I2CShellDriver;
+
+extern I2CShellDriver I2CD1;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+void init_i2c_shell_driver(I2CShellDriver* sdp);
+#ifdef __cplusplus
+}
+#endif
+
+#endif

firmware/application/main.cpp

@@ -139,6 +139,7 @@ Continuous (Fox-oring)
 #include "sd_card.hpp"
 
 #include <string.h>
+#include "i2cdevmanager.hpp"
 
 #include "rffc507x.hpp" /* c/m, avoiding initial short ON Ant_DC_Bias pulse, from cold reset  */
 rffc507x::RFFC507x first_if;
@@ -159,6 +160,7 @@ static void event_loop() {
             event_dispatcher.set_display_sleep(true);
         }};
     portapack::setEventDispatcherToUSBSerial(&event_dispatcher);
+    i2cdev::I2CDevManager::setEventDispatcher(&event_dispatcher);
     system_view.get_navigation_view()->handle_autostart();
     event_dispatcher.run();
 }

firmware/application/usb_serial_shell.cpp

@@ -38,6 +38,7 @@
 #include "performance_counter.hpp"
 
 #include "usb_serial_device_to_host.h"
+#include "i2c_device_to_host.h"
 #include "chprintf.h"
 #include "chqueues.h"
 #include "ui_external_items_menu_loader.hpp"
@@ -59,6 +60,7 @@
 #define palOutputPad(port, pad) (LPC_GPIO->DIR[(port)] |= 1 << (pad))
 
 static EventDispatcher* _eventDispatcherInstance = NULL;
+static bool shell_i2c_created = false;
 static EventDispatcher* getEventDispatcherInstance() {
     return _eventDispatcherInstance;
 }
@@ -1222,7 +1224,19 @@ static const ShellConfig shell_cfg1 = {
     (BaseSequentialStream*)&SUSBD1,
     commands};
 
+static const ShellConfig shell_cfg2 = {
+    (BaseSequentialStream*)&I2CD1,
+    commands};
+
 void create_shell(EventDispatcher* evtd) {
     _eventDispatcherInstance = evtd;
     shellCreate(&shell_cfg1, SHELL_WA_SIZE, NORMALPRIO + 10);
 }
+
+extern "C" void create_shell_i2c(EventDispatcher* evtd) {
+    if (shell_i2c_created) return;
+    shell_i2c_created = true;
+    init_i2c_shell_driver(&I2CD1);
+    _eventDispatcherInstance = evtd;
+    shellCreate(&shell_cfg2, SHELL_WA_SIZE, NORMALPRIO + 10);
+}

firmware/application/usb_serial_shell.hpp

@@ -31,4 +31,12 @@ class EventDispatcher;
 
 void create_shell(EventDispatcher* evtd);
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+void create_shell_i2c(EventDispatcher* evtd);
+#ifdef __cplusplus
+}
+#endif
+
 #endif