doc: Update readme doc
This commit is contained in:
windowsair
parent
5ec9d7aee7
commit
586f78cb14
51
README.md
51
README.md
|
|
@ -20,34 +20,35 @@ Realized by USBIP and CMSIS-DAP protocol stack.
|
|||
## Feature
|
||||
|
||||
1. Debug Communication Mode
|
||||
- [x] SWJ
|
||||
- [x] SWD
|
||||
- [x] JTAG
|
||||
|
||||
2. USB Communication Mode
|
||||
- [x] USB-HID
|
||||
- [ ] WCID & WinUSB
|
||||
- [x] USB-HID (Default)
|
||||
- [x] WCID & WinUSB (Experimental)
|
||||
|
||||
3. Debug Trace
|
||||
- [ ] UART Serial Wire Output(SWO)
|
||||
- [ ] SWO Streaming Trace
|
||||
|
||||
4. More..
|
||||
- [x] Custom maximum debug clock(more than 10MHz)
|
||||
- [x] Custom maximum debug clock ~~(more than 10MHz)~~ (experimental)
|
||||
- [ ] ...
|
||||
|
||||
|
||||
|
||||
## Link your board
|
||||
|
||||
1. WIFI
|
||||
### WIFI
|
||||
|
||||
The default connected WIFI SSID is `DAP` , password `12345678`
|
||||
|
||||
You can change `WIFI_SSID` and ` WIFI_PASS` in [wifi_configuration.h](main/wifi_configuration.h)
|
||||
|
||||
2. Debugger
|
||||
### Debugger
|
||||
|
||||
|
||||
|
||||
- SWD
|
||||
|
||||
| SWD | |
|
||||
|----------------|--------|
|
||||
|
|
@ -58,7 +59,9 @@ You can change `WIFI_SSID` and ` WIFI_PASS` in [wifi_configuration.h](main/wifi_
|
|||
| TVCC | 3V3 |
|
||||
| GND | GND |
|
||||
|
||||
- JTAG
|
||||
|
||||
--------------
|
||||
|
||||
|
||||
| JTAG | |
|
||||
|--------------------|---------|
|
||||
|
|
@ -81,12 +84,13 @@ You can modify these pin definitions in [DAP_config.h](components/DAP/config/DAP
|
|||
|
||||
1. Get ESP8266 RTOS Software Development Kit
|
||||
|
||||
See: [ESP8266_RTOS_SDK](https://github.com/espressif/ESP8266_RTOS_SDK "ESP8266_RTOS_SDK")
|
||||
For now, use the 3.3-rc1 version of the SDK (this is a known issue)
|
||||
See: [ESP8266_RTOS_SDK](https://github.com/espressif/ESP8266_RTOS_SDK/releases/tag/v3.3-rc1 "ESP8266_RTOS_SDK")
|
||||
|
||||
2. Build & Flash
|
||||
|
||||
Build with ESP-IDF build system.
|
||||
More information can be found at the following link: [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html "Build System")
|
||||
Build with ESP-IDF build system.
|
||||
More information can be found at the following link: [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html "Build System")
|
||||
|
||||
The following example shows a possible way to build on Windows:
|
||||
|
||||
|
|
@ -104,7 +108,8 @@ python ./idf.py -p /dev/ttyS5 flash
|
|||
|
||||
1. Get USBIP project
|
||||
|
||||
- Windows: [usbip-windows](https://github.com/george-hopkins/usbip-windows "usbip-windows") . Or you can find it already built here: https://github.com/barbalion/usbip-win-client
|
||||
- Windows: [usbip-win](https://github.com/cezanne/usbip-win) .
|
||||
> The pre-compiled version on SourceForge is also available, for HID mode only, but it may be faster.
|
||||
- Linux: Distributed as part of the kernel
|
||||
|
||||
2. Start esp8266 and connect it to the device to be debugged
|
||||
|
|
@ -112,12 +117,24 @@ python ./idf.py -p /dev/ttyS5 flash
|
|||
3. Connect it with usbip:
|
||||
|
||||
```bash
|
||||
# HID Mode
|
||||
# for pre-compiled version on SourceForge
|
||||
# or usbip old version
|
||||
.\usbip.exe -D -a <your-esp8266-ip-address> 1-1
|
||||
|
||||
# HID Mode Or WinUSB Mode
|
||||
# for usbip-win 0.3.0 kmdf ude
|
||||
.\usbip.exe attach-ude -r <your-esp8266-ip-address> -b 1-1
|
||||
|
||||
```
|
||||
|
||||
If all goes well, you should see your device connected.
|
||||
|
||||
|
||||
|
||||
|
||||
Then test it under MDK:
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -127,6 +144,7 @@ If all goes well, you should see your device connected.
|
|||
> Credits to:
|
||||
> - https://github.com/thevoidnn/esp8266-wifi-cmsis-dap for adapter firmware based on CMSIS-DAP v1.0
|
||||
> - https://github.com/ARM-software/CMSIS_5 for CMSIS
|
||||
> - https://github.com/cezanne/usbip-win for usbip windows
|
||||
|
||||
|
||||
In this repo you can find the complete implementation of the USB protocol stack including USB-HID, WCID, WinUSB. Although WinUSB-based mode currently does not work on USBIP :disappointed_relieved: . They are very easy and can help you quickly build your own DAP on other hardware platforms.
|
||||
|
|
@ -139,13 +157,18 @@ Currently using USB-HID for transmission is still slightly slower, If you have a
|
|||
|
||||
### Issue
|
||||
|
||||
2-4
|
||||
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.
|
||||
|
||||
1-31
|
||||
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.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue