Net ppp

esp-idf-examples/net_pppos_usb/.gitignore

@@ -0,0 +1,16 @@
+nim.cfg
+main/nimcache
+*.out
+.DS_Store
+
+.tool-versions
+*.dSYM/
+/*.png
+nimble.develop
+nimble.paths
+deps
+sdkconfig
+build/
+sdkconfig.old
+.cache/
+managed_components/

esp-idf-examples/net_pppos_usb/AGENTS.md

@@ -0,0 +1,41 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- main/: Nim sources and component config. Entrypoint: main/main.nim. Generated C lives in main/nimcache/.
+- deps/: Vendored Nim dependencies (nesper, unittest2, etc.). Managed by Nimble/Atlas.
+- build/: ESP‑IDF CMake/Ninja outputs and flash args. Not for commits.
+- CMakeLists.txt: Top‑level ESP‑IDF project file.
+- config.nims, nim.cfg: Nim/nesper build configuration and include paths.
+- sdkconfig, sdkconfig.defaults, partitions.csv: ESP‑IDF configuration and partition table.
+
+## Build, Test, and Development Commands
+- nim espBuild: Compile Nim and build the ESP‑IDF project (preferred dev loop).
+- nim espCompile: Compile Nim to C into main/nimcache/ (no ESP‑IDF build).
+- idf.py set-target esp32s3: Ensure target matches config.nims.
+- idf.py -p /dev/ttyUSB0 flash monitor: Flash and open serial monitor (adjust port).
+- idf.py build: Rebuild from generated C when Nim hasn’t changed.
+- Clean: idf.py fullclean && rm -rf main/nimcache
+
+Environment: export IDF_PATH and source "$IDF_PATH/export.sh" before building.
+
+## Coding Style & Naming Conventions
+- Indentation: 2 spaces; keep lines concise.
+- Nim style: camelCase procs, PascalCase types, UPPER_SNAKE constants. Exported symbols end with *.
+- Modules: lower_snake filenames (e.g., ppp_client.nim).
+- Formatting: nimpretty --indent:2 main/*.nim
+- Use nesper APIs where possible; isolate raw ESP‑IDF calls behind small Nim wrappers.
+
+## Testing Guidelines
+- Current repo has no tests. Add Nim tests under tests/ using unittest2 (deps/unittest2).
+- Naming: tests/test_*.nim (e.g., tests/test_ppp.nim).
+- Run: nim c -r tests/test_ppp.nim. Consider a nimble test task for CI later.
+
+## Commit & Pull Request Guidelines
+- Commits: short, imperative summaries (e.g., "ppp: add link setup").
+- PRs: include purpose, build/flash steps, linked issues, and serial logs/screenshots for hardware changes.
+- Scope: keep changes focused; avoid committing build/ outputs or local sdkconfig changes unless intentional.
+
+## Security & Configuration Tips
+- Do not commit credentials or secrets in sdkconfig or sources.
+- Match target to hardware (esp32s3 by default in config.nims); update if using another SoC.
+- Document required pins/peripherals in PRs when relevant.

esp-idf-examples/net_pppos_usb/CMakeLists.txt

@@ -0,0 +1,6 @@
+# The following lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(net_pppos_usb)

esp-idf-examples/net_pppos_usb/README-pppos-dualcdc.md

@@ -0,0 +1,32 @@
+PPPoS over USB CDC (dual CDC)
+
+Overview
+- CDC ACM 0: PPP data channel feeding `esp_netif` (PPPoS)
+- CDC ACM 1: TinyUSB console for ESP logs and stdio
+
+Files
+- `ppp_connect_usb_dualcdc.c`: C example setting up two CDC interfaces, PPP + console.
+- `ppp_connect_usb_dualcdc.nim`: Nim example with equivalent behavior.
+
+Key Config (menuconfig)
+- Component config → TinyUSB → Device
+  - Enable TinyUSB device stack
+  - Enable CDC and set `CDC count` to `2` or more
+  - Adjust CDC RX/TX buffer sizes as needed
+- Component config → LWIP
+  - Enable PPP support (esp-netif PPP)
+
+Usage Notes
+- PPP frames are read from CDC0 and passed to `esp_netif_receive`; TCP/IP replies transmit via CDC0.
+- Console/log output is redirected to CDC1 using `esp_tusb_init_console(TINYUSB_CDC_ACM_1)`.
+- On the host, two serial devices will appear; attach your PPP dialer to the first, and a terminal to the second for logs.
+
+API Entrypoints
+- C: `example_ppp_connect_dualcdc()` / `example_ppp_shutdown_dualcdc()`
+- Nim: `examplePppConnectDualCdc()` / `examplePppShutdownDualCdc()`
+
+References
+- `ppp_connect_usb.c`: single-CDC PPPoS reference (upstream ESP-IDF example)
+- `tests/c_headers/idf-usb/device/tusb_console/main/tusb_console_main.c`: TinyUSB console redirection
+- `tusb_composite_msc_serialdevice.nim`: example TinyUSB CDC usage from Nim
+

esp-idf-examples/net_pppos_usb/README.md

@@ -0,0 +1,53 @@
+USB Networking Modes (PPP and NCM)
+
+Overview
+- PPPoS dual-CDC (default):
+  - CDC0 = PPP data channel for `esp_netif`.
+  - CDC1 = USB console/log output via TinyUSB console.
+  - Files: `ppp_connect_usb_dualcdc.nim`, `ppp_connect_usb_dualcdc.c`.
+
+- NCM-as-Ethernet dual-CDC:
+  - Networking over TinyUSB NCM bound to an Ethernet-like `esp_netif`.
+  - CDC1 = USB console/log output via TinyUSB console.
+  - File: `tusb_ncm_eth_dualcdc.nim`.
+
+Alternate (bridge) example
+- `tusb_ncm.nim`: Bridges USB NCM <-> WiFi STA (packets forward both ways). Not used by `main.nim` by default.
+
+Selecting Mode
+- Default (PPPoS + CDC console): build as-is.
+- NCM-as-Ethernet + CDC console: pass `-d:RUN_NCM` to Nim build (e.g., in your Atlas task or Nim command).
+  - `main.nim` imports and runs `usb/tusb_ncm_eth_dualcdc.runUsbNcmEthWithConsole()` when `RUN_NCM` is defined.
+
+Kconfig Requirements
+- Common:
+  - Enable TinyUSB device stack.
+  - Enable CDC class; set CDC count accordingly (2 for dual console + data).
+- PPP mode:
+  - LWIP → Enable PPP support.
+- NCM-as-Ethernet mode:
+  - TinyUSB → Enable NET (NCM) device class.
+  - DHCP client runs on the device (default ETH netif config). Ensure host provides DHCP or set static IP as needed.
+
+Endpoint-safe defaults
+- PPP mode (default): `sdkconfig.defaults` (or `sdkconfig.defaults.ppp`) sets CDC count = 2 and disables NCM.
+- NCM mode: use `sdkconfig.defaults.ncm` to enable NCM and set CDC count = 1 (console only).
+  - Having both NCM and two CDCs may exceed endpoint limits on some targets.
+
+Host Expectations
+- PPPoS:
+  - Host sees two serial ports. Attach PPP dialer to CDC0; logs on CDC1.
+- NCM-as-Ethernet:
+  - Host enumerates a USB network interface. Device requests IP via DHCP; logs on CDC1.
+
+Useful Tweaks
+- CDC RX/TX buffer size: TinyUSB → CDC → adjust `CONFIG_TINYUSB_CDC_RX_BUFSIZE`/`TX_BUFSIZE`.
+- Console over USB: handled via `esp_tusb_init_console(TINYUSB_CDC_ACM_1)` in the dual-CDC samples.
+
+Entrypoints
+- PPP: `examplePppConnectDualCdc()` / `examplePppShutdownDualCdc()`.
+- NCM ETH: `runUsbNcmEthWithConsole()` / `stopUsbNcmEthWithConsole()`.
+
+Switching modes
+- PPP (default): build normally.
+- NCM: either pass `-d:RUN_NCM` at build time or temporarily copy `sdkconfig.defaults.ncm` to `sdkconfig.defaults` and reconfigure.

esp-idf-examples/net_pppos_usb/config.nims

@@ -0,0 +1,16 @@
+switch("define", "ESP_IDF_VERSION=5.5")
+switch("define", "esp32s3") # or other variants
+switch("define", "nimNetSocketExtras")
+switch("define", "nimIoselectorEventfd")
+# switch("define", "TcpEchoServer")
+# switch("define", "UdpEchoServer")
+switch("define", "FastRpcServer")
+
+switch("define", "McuUtilsLoggingLevel:lvlInfo")
+# switch("define", "RUN_NCM")
+
+patchFile("stdlib", "ioselectors_select", "../../src/nesper/networking/ioselectors_select_patch.nim")
+
+patchFile("stdlib", "cpuinfo", "main/cpuinfo.nim")
+
+include nesper/build_utils/builds

esp-idf-examples/net_pppos_usb/dependencies.lock

@@ -0,0 +1,39 @@
+dependencies:
+  espressif/esp_tinyusb:
+    component_hash: 96d232ced7afe1976119b62f7fbf1944a2a78b36228ff6f7b9318394ac1153cc
+    dependencies:
+    - name: idf
+      require: private
+      version: '>=5.0'
+    - name: espressif/tinyusb
+      registry_url: https://components.espressif.com
+      require: public
+      version: '>=0.14.2'
+    source:
+      registry_url: https://components.espressif.com/
+      type: service
+    version: 1.7.6~1
+  espressif/tinyusb:
+    component_hash: aa65639878f27a44d349044afd9c3fc134a92bd560874fdac1d836019b5c07ca
+    dependencies:
+    - name: idf
+      require: private
+      version: '>=5.0'
+    source:
+      registry_url: https://components.espressif.com
+      type: service
+    targets:
+    - esp32s2
+    - esp32s3
+    - esp32p4
+    version: 0.18.0~4
+  idf:
+    source:
+      type: idf
+    version: 5.5.0
+direct_dependencies:
+- espressif/esp_tinyusb
+- idf
+manifest_hash: 48b4bc7b2d1d1a86ac200b84fcb27696d651413d6f3c9dda6ae42be38b4b1ee3
+target: esp32s3
+version: 2.0.0

esp-idf-examples/net_pppos_usb/main/CMakeLists.txt

@@ -0,0 +1,16 @@
+idf_component_register(SRC_DIRS "./nimcache"
+                     INCLUDE_DIRS ""
+                    )
+
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-unused-label APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-discarded-qualifiers APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-ignored-qualifiers APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-error=unused-label APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-error=parentheses APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-error=implicit-function-declaration APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-error=maybe-uninitialized APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-error=nonnull APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-error=address APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-unused-but-set-variable APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-maybe-uninitialized APPEND)
+idf_build_set_property(C_COMPILE_OPTIONS -Wno-incompatible-pointer-types APPEND)

esp-idf-examples/net_pppos_usb/main/config.nims

@@ -0,0 +1,14 @@
+--nomain
+--compileOnly
+# --define:debug
+--define:NimAppMain
+--nimcache:nimcache
+
+--gc:arc
+--os:freertos
+--cpu:arm
+--define:useMalloc
+--define:noSignalHandler
+# --debugger:native
+--threads:on
+--tls_emulation:off

esp-idf-examples/net_pppos_usb/main/cpuinfo.nim

@@ -0,0 +1,2 @@
+
+proc countProcessors*(): int = 1

esp-idf-examples/net_pppos_usb/main/idf_component.yml

@@ -0,0 +1,17 @@
+## IDF Component Manager Manifest File
+dependencies:
+  ## Required IDF version
+  idf:
+    version: '>=4.1.0'
+  # # Put list of dependencies here
+  # # For components maintained by Espressif:
+  # component: "~1.0.0"
+  # # For 3rd party components:
+  # username/component: ">=1.0.0,<2.0.0"
+  # username2/component2:
+  #   version: "~1.0.0"
+  #   # For transient dependencies `public` flag can be set.
+  #   # `public` flag doesn't have an effect dependencies of the `main` component.
+  #   # All dependencies of `main` are public by default.
+  #   public: true
+  espressif/esp_tinyusb: ^1.7.6~1