Skip to content

Latest commit

 

History

History
494 lines (291 loc) · 13.9 KB

README.md

File metadata and controls

494 lines (291 loc) · 13.9 KB
Raw

image

Build Status master　 Build Status develop

　PRs Welcome　%e2%9d%a4

中文

Introduce

Wireless debugging with only one ESP Chip !

Realized by USBIP and CMSIS-DAP protocol stack.

👉 5m range, 100kb size firmware(Hex) earse and download test:

For Keil users, we now also support elaphureLink. No need for usbip to start your wireless debugging!

Feature

  1. SoC Compatibility

    • ESP8266/8285
    • ESP32
    • ESP32C3

  2. Debug Communication Mode

    • SWD
    • JTAG

  3. USB Communication Mode

    • USB-HID
    • WCID & WinUSB (Default)

  4. Debug Trace (Uart)

    • Uart TCP Bridge

  5. More..

    • SWD protocol based on SPI acceleration (Up to 40MHz)
    • Support for elaphureLink, fast Keil debug without drivers
    • ...

Link your board

WIFI

The default connected WIFI SSID is DAP or OTA , password 12345678

Support for specifying multiple possible WAP. It can be added here: wifi_configuration.h

You can also specify your IP in the above file (We recommend using the static address binding feature of the router).

WIFI

There is built-in ipv4 only mDNS server. You can access the device using dap.local.

The mDNS in ESP8266 only supports ipv4.

mDNS

Debugger

ESP8266
SWD
SWCLK GPIO14
SWDIO GPIO13
TVCC 3V3
GND GND
JTAG
TCK GPIO14
TMS GPIO13
TDI GPIO4
TDO GPIO16
nTRST (optional) GPIO0*
nRESET GPIO5
TVCC 3V3
GND GND
Other
LED_WIFI_STATUS GPIO15
Tx GPIO2
Rx GPIO3 (U0RXD)

Rx and Tx is used for uart bridge, not enabled by default.

ESP32
SWD
SWCLK GPIO14
SWDIO GPIO13
TVCC 3V3
GND GND
JTAG
TCK GPIO14
TMS GPIO13
TDI GPIO18
TDO GPIO19
nTRST (optional) GPIO25
nRESET GPIO26
TVCC 3V3
GND GND
Other
LED_WIFI_STATUS GPIO27
Tx GPIO23
Rx GPIO22

Rx and Tx is used for uart bridge, not enabled by default.

ESP32C3
SWD
SWCLK GPIO6
SWDIO GPIO7
TVCC 3V3
GND GND
JTAG
TCK GPIO6
TMS GPIO7
TDI GPIO9
TDO GPIO8
nTRST (optional) GPIO4
nRESET GPIO5
TVCC 3V3
GND GND
Other
LED_WIFI_STATUS GPIO10
Tx GPIO19
Rx GPIO18

Rx and Tx is used for uart bridge, not enabled by default.

Hardware Reference

Only a hardware reference for the ESP8266 is currently available.

Here we provide a simple example for reference:

sch

Alternatively, you can connect directly with wires as we gave at the beginning, without additional circuits.

In addition, a complete hardware reference design is available from contributors, see circuit

Build And Flash

You can build locally or use Github Action to build online and then download firmware to flash.

Build with Github Action Online

See: Build with Github Action

General build and Flash

ESP8266

  1. Get ESP8266 RTOS Software Development Kit

    The SDK is already included in the project. Please don't use other versions of the SDK.

  2. Build & Flash

    Build with ESP-IDF build system. More information can be found at the following link: Build System

The following example shows a possible way to build on Windows:

# Build
python ./idf.py build
# Flash
python ./idf.py -p /dev/ttyS5 flash
ESP32/ESP32C3

  1. Get esp-idf

    For now, please use esp-idf v4.4.2 : https://github.com/espressif/esp-idf/releases/tag/v4.4.2

  2. Build & Flash

    Build with ESP-IDF build system. More information can be found at the following link: Build System

The following example shows a possible way to build:

# Set build target
idf.py set-target esp32
# Build
idf.py build
# Flash
idf.py -p /dev/ttyS5 flash

The idf.py in the project root directory is only applicable to the old ESP8266 target. Don't use it in ESP32.

We also provided sample firmware for quick evaluation. See Releases

Usage

  1. Get USBIP project
  • Windows: usbip-win .
  • Linux: Distributed as part of the Linux kernel, but we have not yet tested on Linux platform, and the following instructions are all under Windows platform.

  1. Start ESP chip and connect it to the device to be debugged

  2. Connect it with usbip:

# HID Mode only
# for pre-compiled version on SourceForge
# or usbip old version
.\usbip.exe -D -a <your-esp-device-ip-address>  1-1

# 👉 Recommend
# HID Mode Or WinUSB Mode
# for usbip-win 0.3.0 kmdf ude
.\usbip.exe attach_ude -r <your-esp-device-ip-address> -b 1-1

If all goes well, you should see your device connected.

image

Here, we use MDK for testing:

target

FAQ

Keil is showing a "RDDI-DAP ERROR" or "SWD/JTAG Communication Failure" message.

  1. Check your line connection. Don't forget the 3v3 connection cable.
  2. Check that your network connection is stable.

DAP is slow or often abnormal.

Note that this project is sensitive to the network environment. If you are using a hotspot on your computer, you can try using network analyzer such as wireshark to observe the status of your AP network. During the idle time, the network should stay silent, while in the working state, there should be no too much packet loss.

Some LAN broadcast packets can cause serious impact, including:

  • DropBox LAN Sync
  • Logitech Arx Control
  • ...

For ESP8266, this is not far from UDP FLOOD...😰

It is also affected by the surrounding radio environment, your AP situation (some NICs have terrible AP performance), distance, etc.

Document

Speed Strategy

The maximum rate of esp8266 pure IO is about 2MHz. When you select max clock, we will take the following actions:

  • clock < 2Mhz : Similar to the clock speed you choose.
  • 2MHz <= clock < 10MHz : Use the fastest pure IO speed.
  • clock >= 10MHz : SPI acceleration using 40MHz clock.

Note that the most significant speed constraint of this project is still the TCP connection speed.

For OpenOCD user

This project was originally designed to run on Keil, but now you can also perform firmware flash on OpenOCD.

Note that if you want to use a 40MHz SPI acceleration, you need to specify the speed after the target device is connected, otherwise it will fail with the beginning.

# Run before approaching the flash command
> adapter speed 10000

> halt
> flash write_image [erase] [unlock] filename [offset] [type]

Keil's timing handling is somewhat different from OpenOCD's. For example, OpenOCD lacks the SWD line reset sequence before reading the IDCODE registers.

System OTA

When this project is updated, you can update the firmware over the air.

Visit the following website for OTA operations: online OTA

For most devices, you don't need to care about flash size. However, improper setting of the flash size may cause the OTA to fail. In this case, please change the flash size with idf.py menuconfig, or modify sdkconfig:

# Choose a flash size.
CONFIG_ESPTOOLPY_FLASHSIZE_1MB=y
CONFIG_ESPTOOLPY_FLASHSIZE_2MB=y
CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
CONFIG_ESPTOOLPY_FLASHSIZE_8MB=y
CONFIG_ESPTOOLPY_FLASHSIZE_16MB=y

# Then set a flash size
CONFIG_ESPTOOLPY_FLASHSIZE="2MB"

If flash size is 2MB, the sdkconfig file might look like this:

CONFIG_ESPTOOLPY_FLASHSIZE_2MB=y
CONFIG_ESPTOOLPY_FLASHSIZE="2MB"

For devices with 1MB flash size such as ESP8285, the following changes must be made:

CONFIG_PARTITION_TABLE_FILENAME="partitions_two_ota.1MB.csv"
CONFIG_ESPTOOLPY_FLASHSIZE_1MB=y
CONFIG_ESPTOOLPY_FLASHSIZE="1MB"
CONFIG_ESP8266_BOOT_COPY_APP=y

The flash size of the board can be checked with the esptool.py tool:

esptool.py -p (PORT) flash_id

Uart TCP Bridge

This feature provides a bridge between TCP and Uart:

Send data   ->  TCP  ->  Uart TX -> external devices

Recv data   <-  TCP  <-  Uart Rx <- external devices

uart_tcp_bridge

When the TCP connection is established, bridge will try to resolve the text sent for the first packet. When the text is a valid baud rate, bridge will switch to it. For example, sending the ASCII text 115200 will switch the baud rate to 115200.

For performance reasons, this feature is not enabled by default. You can modify wifi_configuration.h to turn it on.

Develop

Check other branches to know the latest development progress.

Any kind of contribute is welcome, including but not limited to new features, ideas about circuits, documentation.

You can also ask questions to make this project better.

Issue

2020.12.1

TCP transmission speed needs to be further improved.

2020.11.11

Winusb is now available, but it is very slow.

2020.2.4

Due to the limitation of USB-HID (I'm not sure if this is a problem with USBIP or Windows), now each URB packet can only reach 255 bytes (About 1MBps bandwidth), which has not reached the upper limit of ESP8266 transmission bandwidth.

I now have an idea to construct a Man-in-the-middle between the two to forward traffic, thereby increasing the bandwidth of each transmission.

2020.1.31

At present, the adaptation to WCID, WinUSB, etc. has all been completed. However, when transmitting data on the endpoint, we received an error message from USBIP. This is most likely a problem with the USBIP project itself.

Due to the completeness of the USBIP protocol document, we have not yet understood its role in the Bulk transmission process, which may also lead to errors in subsequent processes.

We will continue to try to make it work on USB HID. Once the USBIP problem is solved, we will immediately transfer it to work on WinUSB

Credit

Credits to the following project, people and organizations:

License

MIT LICENSE