Add MQTT device through RNDIS example

.github/workflows/test.yml

@@ -557,26 +557,26 @@ jobs:
       - if: ${{ env.GO == 1 }}
         run: make -C examples/${{ matrix.example.path }} build
 
-#  mqtt_dashboard_examples:
-#    runs-on: ubuntu-latest
-#    strategy:
-#      fail-fast: false
-#      matrix:
-#        example:
-#          - path: 
-#    name: ${{ matrix.example.path }}
-#    env:
-#      GO: 0
-#    steps:
-#      - uses: actions/checkout@v3
-#        with: { fetch-depth: 2 }
-#      - run: |
-#          if ./test/match_changed_files.sh '^src|examples/mqtt-dashboard/device|^examples/${{ matrix.example.path }}'; then
-#            echo GO=1 >> $GITHUB_ENV
-#            sudo apt -y update && sudo apt -y install gcc-arm-none-eabi
-#          fi
-#      - if: ${{ env.GO == 1 }}
-#        run: make -C examples/${{ matrix.example.path }} build
+  mqtt_dashboard_examples:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        example:
+          - path: rp2040/pico-rndis-device
+    name: ${{ matrix.example.path }}
+    env:
+      GO: 0
+    steps:
+      - uses: actions/checkout@v3
+        with: { fetch-depth: 2 }
+      - run: |
+          if ./test/match_changed_files.sh '^src|examples/mqtt-dashboard/device|^examples/${{ matrix.example.path }}'; then
+            echo GO=1 >> $GITHUB_ENV
+            sudo apt -y update && sudo apt -y install gcc-arm-none-eabi
+          fi
+      - if: ${{ env.GO == 1 }}
+        run: make -C examples/${{ matrix.example.path }} build
       
   dual_examples:
     runs-on: ubuntu-latest

examples/rp2040/pico-rndis-device/CMakeLists.txt

@@ -0,0 +1,28 @@
+cmake_minimum_required(VERSION 3.13)
+include(pico-sdk/pico_sdk_init.cmake)
+
+project(firmware)
+pico_sdk_init()
+
+add_executable(firmware
+  main.c
+  usb_descriptors.c
+  mongoose.c
+  net.c
+  pico-sdk/lib/tinyusb/lib/networking/rndis_reports.c)
+
+target_include_directories(firmware PUBLIC
+  .
+  pico-sdk/lib/tinyusb/lib/networking)
+
+target_link_libraries(firmware pico_stdlib hardware_spi tinyusb_device)
+pico_add_extra_outputs(firmware)     # create map/bin/hex file etc.
+
+pico_enable_stdio_usb(firmware 0)    # Route stdio
+pico_enable_stdio_uart(firmware 1)   # to the UART
+
+# Mongoose build flags
+add_definitions(-DMG_ENABLE_TCPIP=1)
+add_definitions(-DMG_ENABLE_FILE=0)
+
+# Example build options

examples/rp2040/pico-rndis-device/Makefile

@@ -0,0 +1,20 @@
+RM = rm -rf
+MKBUILD = test -d build || mkdir build
+ifeq ($(OS),Windows_NT)
+  RM = cmd /C del /Q /F /S
+  MKBUILD = if not exist build mkdir build
+endif
+
+all example:
+	true
+
+build: pico-sdk
+	$(MKBUILD)
+	cd build && cmake -G "Unix Makefiles" .. && make
+
+pico-sdk:
+	git clone --depth 1 -b 1.4.0 https://github.com/raspberrypi/pico-sdk $@
+	cd $@ && git submodule update --init
+
+clean:
+	$(RM) pico-sdk build

examples/rp2040/pico-rndis-device/README.md

@@ -0,0 +1,30 @@
+# Remote MQTT Device on an RP2040
+
+Your headless Raspberry Pi Pico-based hardware can also be a remote gadget when you connect it to your computer via USB
+
+For the USB specifics, see this related tutorial at https://mongoose.ws/tutorials/rp2040/pico-rndis-dashboard/
+
+See this tutorial to control your device: https://mongoose.ws/tutorials/mqtt-dashboard/
+
+For this to work, you need your computer to act as a router (gateway) and NAT for your device.
+
+## Linux setup
+
+Enable "masquerading"; the quick and simple options are:
+
+``` bash
+sudo iptables --flush
+sudo iptables --table nat --flush
+sudo iptables --delete-chain
+sudo iptables --table nat --delete-chain
+
+# Do masquerading
+sudo iptables -t nat -A POSTROUTING -o yourifc -j MASQUERADE
+# enable routing
+sudo echo 1 > /proc/sys/net/ipv4/ip_forward
+```
+
+Where `yourifc` is the interface that is connected to your network
+
+## MacOS setup
+

examples/rp2040/pico-rndis-device/hal.h

@@ -0,0 +1,11 @@
+// Copyright (c) 2023 Cesanta Software Limited
+// All rights reserved
+
+#define LED PICO_DEFAULT_LED_PIN
+
+static inline int gpio_read(uint16_t pin) {
+  return gpio_get_out_level(pin);
+}
+static inline void gpio_write(uint16_t pin, bool val) {
+  gpio_put(pin, val);
+}

examples/rp2040/pico-rndis-device/main.c

@@ -0,0 +1,89 @@
+// Copyright (c) 2022 Cesanta Software Limited
+// All rights reserved
+
+#include "mongoose.h"
+#include "net.h"
+#include "pico/stdlib.h"
+#include "tusb.h"
+
+bool hal_gpio_read(int pin) {
+  return (pin >= 0 && pin <= 29) ? gpio_get_out_level((uint) pin) : false;
+}
+
+void hal_gpio_write(int pin, bool val) {
+  if (pin >= 0 && pin <= 29) gpio_put((uint) pin, val);
+}
+
+int hal_led_pin(void) {
+  return PICO_DEFAULT_LED_PIN;
+}
+
+static struct mg_tcpip_if *s_ifp;
+
+const uint8_t tud_network_mac_address[6] = {2, 2, 0x84, 0x6A, 0x96, 0};
+
+bool tud_network_recv_cb(const uint8_t *buf, uint16_t len) {
+  mg_tcpip_qwrite((void *) buf, len, s_ifp);
+  // MG_INFO(("RECV %hu", len));
+  // mg_hexdump(buf, len);
+  tud_network_recv_renew();
+  return true;
+}
+
+void tud_network_init_cb(void) {
+}
+
+uint16_t tud_network_xmit_cb(uint8_t *dst, void *ref, uint16_t arg) {
+  // MG_INFO(("SEND %hu", arg));
+  memcpy(dst, ref, arg);
+  return arg;
+}
+
+static size_t usb_tx(const void *buf, size_t len, struct mg_tcpip_if *ifp) {
+  if (!tud_ready()) return 0;
+  while (!tud_network_can_xmit(len)) tud_task();
+  tud_network_xmit((void *) buf, len);
+  (void) ifp;
+  return len;
+}
+
+static bool usb_up(struct mg_tcpip_if *ifp) {
+  (void) ifp;
+  return tud_inited() && tud_ready() && tud_connected();
+}
+
+static void fn(struct mg_connection *c, int ev, void *ev_data, void *fn_dta) {
+  if (ev == MG_EV_HTTP_MSG) return mg_http_reply(c, 200, "", "ok\n");
+}
+
+int main(void) {
+  gpio_init(PICO_DEFAULT_LED_PIN);
+  gpio_set_dir(PICO_DEFAULT_LED_PIN, GPIO_OUT);
+  stdio_init_all();
+
+  struct mg_mgr mgr;  // Initialise Mongoose event manager
+  mg_mgr_init(&mgr);  // and attach it to the interface
+
+  struct mg_tcpip_driver driver = {.tx = usb_tx, .up = usb_up};
+  struct mg_tcpip_if mif = {.mac = {2, 0, 1, 2, 3, 0x77},
+                            .ip = mg_htonl(MG_U32(192, 168, 3, 1)),
+                            .mask = mg_htonl(MG_U32(255, 255, 255, 0)),
+                            .enable_dhcp_server = true,
+                            .enable_get_gateway = true,
+                            .driver = &driver,
+                            .recv_queue.size = 4096};
+  s_ifp = &mif;
+  mg_tcpip_init(&mgr, &mif);
+  tusb_init();
+
+  MG_INFO(("Initialising application..."));
+  web_init(&mgr);
+
+  MG_INFO(("Starting event loop"));
+  for (;;) {
+    mg_mgr_poll(&mgr, 0);
+    tud_task();
+  }
+
+  return 0;
+}

examples/rp2040/pico-rndis-device/mongoose.c

@@ -0,0 +1 @@
+../../../mongoose.c

examples/rp2040/pico-rndis-device/mongoose.h

@@ -0,0 +1 @@
+../../../mongoose.h

examples/rp2040/pico-rndis-device/net.c

@@ -0,0 +1 @@
+../../mqtt-dashboard/device/net.c

examples/rp2040/pico-rndis-device/net.h

@@ -0,0 +1 @@
+../../mqtt-dashboard/device/net.h

examples/rp2040/pico-rndis-device/netif/ethernet.h

@@ -0,0 +1,2 @@
+#pragma once
+#define SIZEOF_ETH_HDR 14

examples/rp2040/pico-rndis-device/tusb_config.h

@@ -0,0 +1,9 @@
+#pragma once
+
+// Windows only supports RNDIS
+// Mac only supports CDC-ECM
+// Linux supports either RNDIS, CDC-ECM or CDC-NCM
+#define CFG_TUD_ECM_RNDIS         1
+#define BOARD_DEVICE_RHPORT_NUM   0
+#define BOARD_DEVICE_RHPORT_SPEED OPT_MODE_FULL_SPEED
+#define CFG_TUSB_RHPORT0_MODE     (OPT_MODE_DEVICE | BOARD_DEVICE_RHPORT_SPEED)

examples/rp2040/pico-rndis-device/usb_descriptors.c

@@ -0,0 +1,248 @@
+/* 
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach (tinyusb.org)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+#include "tusb.h"
+
+/* A combination of interfaces must have a unique product id, since PC will save device driver after the first plug.
+ * Same VID/PID with different interface e.g MSC (first), then CDC (later) will possibly cause system error on PC.
+ *
+ * Auto ProductID layout's Bitmap:
+ *   [MSB]       NET | VENDOR | MIDI | HID | MSC | CDC          [LSB]
+ */
+#define _PID_MAP(itf, n)  ( (CFG_TUD_##itf) << (n) )
+#define USB_PID           (0x4000 | _PID_MAP(CDC, 0) | _PID_MAP(MSC, 1) | _PID_MAP(HID, 2) | \
+                           _PID_MAP(MIDI, 3) | _PID_MAP(VENDOR, 4) | _PID_MAP(ECM_RNDIS, 5) | _PID_MAP(NCM, 5) )
+
+// String Descriptor Index
+enum
+{
+  STRID_LANGID = 0,
+  STRID_MANUFACTURER,
+  STRID_PRODUCT,
+  STRID_SERIAL,
+  STRID_INTERFACE,
+  STRID_MAC
+};
+
+enum
+{
+  ITF_NUM_CDC = 0,
+  ITF_NUM_CDC_DATA,
+  ITF_NUM_TOTAL
+};
+
+enum
+{
+#if CFG_TUD_ECM_RNDIS
+  CONFIG_ID_RNDIS = 0,
+  CONFIG_ID_ECM   = 1,
+#else
+  CONFIG_ID_NCM   = 0,
+#endif
+  CONFIG_ID_COUNT
+};
+
+//--------------------------------------------------------------------+
+// Device Descriptors
+//--------------------------------------------------------------------+
+tusb_desc_device_t const desc_device =
+{
+    .bLength            = sizeof(tusb_desc_device_t),
+    .bDescriptorType    = TUSB_DESC_DEVICE,
+    .bcdUSB             = 0x0200,
+
+    // Use Interface Association Descriptor (IAD) device class
+    .bDeviceClass       = TUSB_CLASS_MISC,
+    .bDeviceSubClass    = MISC_SUBCLASS_COMMON,
+    .bDeviceProtocol    = MISC_PROTOCOL_IAD,
+    
+    .bMaxPacketSize0    = CFG_TUD_ENDPOINT0_SIZE,
+
+    .idVendor           = 0xCafe,
+    .idProduct          = USB_PID,
+    .bcdDevice          = 0x0101,
+
+    .iManufacturer      = STRID_MANUFACTURER,
+    .iProduct           = STRID_PRODUCT,
+    .iSerialNumber      = STRID_SERIAL,
+
+    .bNumConfigurations = CONFIG_ID_COUNT // multiple configurations
+};
+
+// Invoked when received GET DEVICE DESCRIPTOR
+// Application return pointer to descriptor
+uint8_t const * tud_descriptor_device_cb(void)
+{
+  return (uint8_t const *) &desc_device;
+}
+
+//--------------------------------------------------------------------+
+// Configuration Descriptor
+//--------------------------------------------------------------------+
+#define MAIN_CONFIG_TOTAL_LEN    (TUD_CONFIG_DESC_LEN + TUD_RNDIS_DESC_LEN)
+#define ALT_CONFIG_TOTAL_LEN     (TUD_CONFIG_DESC_LEN + TUD_CDC_ECM_DESC_LEN)
+#define NCM_CONFIG_TOTAL_LEN     (TUD_CONFIG_DESC_LEN + TUD_CDC_NCM_DESC_LEN)
+
+#if CFG_TUSB_MCU == OPT_MCU_LPC175X_6X || CFG_TUSB_MCU == OPT_MCU_LPC177X_8X || CFG_TUSB_MCU == OPT_MCU_LPC40XX
+  // LPC 17xx and 40xx endpoint type (bulk/interrupt/iso) are fixed by its number
+  // 0 control, 1 In, 2 Bulk, 3 Iso, 4 In etc ...
+  #define EPNUM_NET_NOTIF   0x81
+  #define EPNUM_NET_OUT     0x02
+  #define EPNUM_NET_IN      0x82
+
+#elif CFG_TUSB_MCU == OPT_MCU_SAMG  || CFG_TUSB_MCU ==  OPT_MCU_SAMX7X
+  // SAMG & SAME70 don't support a same endpoint number with different direction IN and OUT
+  //    e.g EP1 OUT & EP1 IN cannot exist together
+  #define EPNUM_NET_NOTIF   0x81
+  #define EPNUM_NET_OUT     0x02
+  #define EPNUM_NET_IN      0x83
+
+#else
+  #define EPNUM_NET_NOTIF   0x81
+  #define EPNUM_NET_OUT     0x02
+  #define EPNUM_NET_IN      0x82
+#endif
+
+#if CFG_TUD_ECM_RNDIS
+
+static uint8_t const rndis_configuration[] =
+{
+  // Config number (index+1), interface count, string index, total length, attribute, power in mA
+  TUD_CONFIG_DESCRIPTOR(CONFIG_ID_RNDIS+1, ITF_NUM_TOTAL, 0, MAIN_CONFIG_TOTAL_LEN, 0, 100),
+
+  // Interface number, string index, EP notification address and size, EP data address (out, in) and size.
+  TUD_RNDIS_DESCRIPTOR(ITF_NUM_CDC, STRID_INTERFACE, EPNUM_NET_NOTIF, 8, EPNUM_NET_OUT, EPNUM_NET_IN, CFG_TUD_NET_ENDPOINT_SIZE),
+};
+
+static uint8_t const ecm_configuration[] =
+{
+  // Config number (index+1), interface count, string index, total length, attribute, power in mA
+  TUD_CONFIG_DESCRIPTOR(CONFIG_ID_ECM+1, ITF_NUM_TOTAL, 0, ALT_CONFIG_TOTAL_LEN, 0, 100),
+
+  // Interface number, description string index, MAC address string index, EP notification address and size, EP data address (out, in), and size, max segment size.
+  TUD_CDC_ECM_DESCRIPTOR(ITF_NUM_CDC, STRID_INTERFACE, STRID_MAC, EPNUM_NET_NOTIF, 64, EPNUM_NET_OUT, EPNUM_NET_IN, CFG_TUD_NET_ENDPOINT_SIZE, CFG_TUD_NET_MTU),
+};
+
+#else
+
+static uint8_t const ncm_configuration[] =
+{
+  // Config number (index+1), interface count, string index, total length, attribute, power in mA
+  TUD_CONFIG_DESCRIPTOR(CONFIG_ID_NCM+1, ITF_NUM_TOTAL, 0, NCM_CONFIG_TOTAL_LEN, 0, 100),
+
+  // Interface number, description string index, MAC address string index, EP notification address and size, EP data address (out, in), and size, max segment size.
+  TUD_CDC_NCM_DESCRIPTOR(ITF_NUM_CDC, STRID_INTERFACE, STRID_MAC, EPNUM_NET_NOTIF, 64, EPNUM_NET_OUT, EPNUM_NET_IN, CFG_TUD_NET_ENDPOINT_SIZE, CFG_TUD_NET_MTU),
+};
+
+#endif
+
+// Configuration array: RNDIS and CDC-ECM
+// - Windows only works with RNDIS
+// - MacOS only works with CDC-ECM
+// - Linux will work on both
+static uint8_t const * const configuration_arr[2] =
+{
+#if CFG_TUD_ECM_RNDIS
+  [CONFIG_ID_RNDIS] = rndis_configuration,
+  [CONFIG_ID_ECM  ] = ecm_configuration
+#else
+  [CONFIG_ID_NCM  ] = ncm_configuration
+#endif
+};
+
+// Invoked when received GET CONFIGURATION DESCRIPTOR
+// Application return pointer to descriptor
+// Descriptor contents must exist long enough for transfer to complete
+uint8_t const * tud_descriptor_configuration_cb(uint8_t index)
+{
+  return (index < CONFIG_ID_COUNT) ? configuration_arr[index] : NULL;
+}
+
+//--------------------------------------------------------------------+
+// String Descriptors
+//--------------------------------------------------------------------+
+
+// array of pointer to string descriptors
+static char const* string_desc_arr [] =
+{
+  [STRID_LANGID]       = (const char[]) { 0x09, 0x04 }, // supported language is English (0x0409)
+  [STRID_MANUFACTURER] = "TinyUSB",                     // Manufacturer
+  [STRID_PRODUCT]      = "TinyUSB Device",              // Product
+  [STRID_SERIAL]       = "123456",                      // Serial
+  [STRID_INTERFACE]    = "TinyUSB Network Interface"    // Interface Description
+
+  // STRID_MAC index is handled separately
+};
+
+static uint16_t _desc_str[32];
+
+// Invoked when received GET STRING DESCRIPTOR request
+// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
+uint16_t const* tud_descriptor_string_cb(uint8_t index, uint16_t langid)
+{
+  (void) langid;
+
+  unsigned int chr_count = 0;
+
+  if (STRID_LANGID == index)
+  {
+    memcpy(&_desc_str[1], string_desc_arr[STRID_LANGID], 2);
+    chr_count = 1;
+  }
+  else if (STRID_MAC == index)
+  {
+    // Convert MAC address into UTF-16
+
+    for (unsigned i=0; i<sizeof(tud_network_mac_address); i++)
+    {
+      _desc_str[1+chr_count++] = "0123456789ABCDEF"[(tud_network_mac_address[i] >> 4) & 0xf];
+      _desc_str[1+chr_count++] = "0123456789ABCDEF"[(tud_network_mac_address[i] >> 0) & 0xf];
+    }
+  }
+  else
+  {
+    // Note: the 0xEE index string is a Microsoft OS 1.0 Descriptors.
+    // https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/microsoft-defined-usb-descriptors
+
+    if ( !(index < sizeof(string_desc_arr)/sizeof(string_desc_arr[0])) ) return NULL;
+
+    const char* str = string_desc_arr[index];
+
+    // Cap at max char
+    chr_count = (uint8_t) strlen(str);
+    if ( chr_count > (TU_ARRAY_SIZE(_desc_str) - 1)) chr_count = TU_ARRAY_SIZE(_desc_str) - 1;
+
+    // Convert ASCII string into UTF-16
+    for (unsigned int i=0; i<chr_count; i++)
+    {
+      _desc_str[1+i] = str[i];
+    }
+  }
+
+  // first byte is length (including header), second byte is string type
+  _desc_str[0] = (uint16_t) ((TUSB_DESC_STRING << 8 ) | (2*chr_count + 2));
+
+  return _desc_str;
+}

mongoose.c

@@ -4920,7 +4920,10 @@ static void rx_dhcp_server(struct mg_tcpip_if *ifp, struct pkt *pkt) {
     memcpy(&res.options, opts, sizeof(opts));
     res.magic = pkt->dhcp->magic;
     res.xid = pkt->dhcp->xid;
-    // memcpy(ifp->gwmac, pkt->eth->src, sizeof(ifp->gwmac));
+    if (ifp->enable_get_gateway) {
+      ifp->gw = res.yiaddr;
+      memcpy(ifp->gwmac, pkt->eth->src, sizeof(ifp->gwmac));
+    }
     tx_udp(ifp, pkt->eth->src, ifp->ip, mg_htons(67),
            op == 1 ? ~0U : res.yiaddr, mg_htons(68), &res, sizeof(res));
   }

mongoose.h

@@ -1873,6 +1873,7 @@ struct mg_tcpip_if {
   struct mg_str tx;                // Output (TX) buffer
   bool enable_dhcp_client;         // Enable DCHP client
   bool enable_dhcp_server;         // Enable DCHP server
+  bool enable_get_gateway;         // DCHP server sets client as gateway
   bool enable_crc32_check;         // Do a CRC check on RX frames and strip it
   bool enable_mac_check;           // Do a MAC check on RX frames
   struct mg_tcpip_driver *driver;  // Low level driver

src/net_builtin.c

@@ -450,7 +450,10 @@ static void rx_dhcp_server(struct mg_tcpip_if *ifp, struct pkt *pkt) {
     memcpy(&res.options, opts, sizeof(opts));
     res.magic = pkt->dhcp->magic;
     res.xid = pkt->dhcp->xid;
-    // memcpy(ifp->gwmac, pkt->eth->src, sizeof(ifp->gwmac));
+    if (ifp->enable_get_gateway) {
+      ifp->gw = res.yiaddr;
+      memcpy(ifp->gwmac, pkt->eth->src, sizeof(ifp->gwmac));
+    }
     tx_udp(ifp, pkt->eth->src, ifp->ip, mg_htons(67),
            op == 1 ? ~0U : res.yiaddr, mg_htons(68), &res, sizeof(res));
   }

src/net_builtin.h

@@ -21,6 +21,7 @@ struct mg_tcpip_if {
   struct mg_str tx;                // Output (TX) buffer
   bool enable_dhcp_client;         // Enable DCHP client
   bool enable_dhcp_server;         // Enable DCHP server
+  bool enable_get_gateway;         // DCHP server sets client as gateway
   bool enable_crc32_check;         // Do a CRC check on RX frames and strip it
   bool enable_mac_check;           // Do a MAC check on RX frames
   struct mg_tcpip_driver *driver;  // Low level driver