-
Notifications
You must be signed in to change notification settings - Fork 250
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
40 changed files
with
9,006 additions
and
256 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
.vscode/ | ||
build/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
language: c | ||
sudo: required | ||
before_install: | ||
- sudo apt install -y gcc git wget make libncurses-dev flex bison python python-serial | ||
- wget https://dl.espressif.com/dl/xtensa-lx106-elf-linux64-1.22.0-100-ge567ec7-5.2.0.tar.gz | ||
|
||
install: | ||
- tar -xzf ./xtensa-lx106-elf-linux64-1.22.0-100-ge567ec7-5.2.0.tar.gz | ||
- git clone --recursive https://github.com/espressif/ESP8266_RTOS_SDK.git | ||
- python -m pip install --user -r ./ESP8266_RTOS_SDK/requirements.txt | ||
|
||
before_script: | ||
- export IDF_PATH=$PWD/ESP8266_RTOS_SDK | ||
- export PATH="$PATH:$PWD/xtensa-lx106-elf/bin" | ||
|
||
script: | ||
- python ./idf.py fullclean | ||
- python ./idf.py build | ||
|
||
deploy: | ||
provider: releases | ||
api_key: ${GITHUB_TOKEN} | ||
file: | ||
- ./build/esp8266_dap.bin | ||
skip_cleanup: true | ||
on: | ||
tags: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
# The following five 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.5) | ||
#set(COMPONENT_DIRS "${IDF_PATH}/components ${PROJECT_PATH}/components") | ||
|
||
include($ENV{IDF_PATH}/tools/cmake/project.cmake) | ||
project(tcp_server) | ||
project(esp8266_dap) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 windowsair | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,159 @@ | ||
<p align="center"><img src="https://user-images.githubusercontent.com/17078589/73821108-300bda00-482e-11ea-89f6-011a50037a12.png"/></p> | ||
<h1 align="center">Wireless ESP8266 DAP</h1> | ||
|
||
[![Build Status](https://travis-ci.com/windowsair/wireless-esp8266-dap.svg?branch=master)](https://travis-ci.com/windowsair/wireless-esp8266-dap) master | ||
[![Build Status](https://travis-ci.com/windowsair/wireless-esp8266-dap.svg?branch=develop)](https://travis-ci.com/windowsair/wireless-esp8266-dap) develop | ||
|
||
[![](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square)](https://github.com/windowsair/wireless-esp8266-dap/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat-square)](https://github.com/windowsair/wireless-esp8266-dap/pulls) [![%e2%9d%a4](https://img.shields.io/badge/made%20with-%e2%9d%a4-ff69b4.svg?style=flat-square)](https://github.com/windowsair/wireless-esp8266-dap) | ||
|
||
|
||
## Introduce | ||
|
||
Wireless debugging with ***only one ESP8266*** ! | ||
|
||
Realized by USBIP and CMSIS-DAP protocol stack. | ||
|
||
> 👉 5m distance, 100kb size firmware flash test: | ||
<p align="center"><img src="https://user-images.githubusercontent.com/17078589/73829782-808b3380-483e-11ea-8389-1570bc4200af.gif"/></p> | ||
|
||
## Feature | ||
|
||
1. Debug Communication Mode | ||
- [x] SWJ | ||
- [x] JTAG | ||
|
||
2. USB Communication Mode | ||
- [x] USB-HID | ||
- [ ] WCID & WinUSB | ||
|
||
3. Debug Trace | ||
- [ ] UART Serial Wire Output(SWO) | ||
- [ ] SWO Streaming Trace | ||
|
||
4. More.. | ||
- [x] Custom maximum debug clock(more than 10MHz) | ||
- [ ] ... | ||
|
||
|
||
|
||
## Link your board | ||
|
||
1. 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 | ||
|
||
- SWD | ||
|
||
| SWD | | | ||
|----------------|--------| | ||
| SWCLK | GPIO5 | | ||
| SWDIO | GPIO4 | | ||
| LED\_CONNECTED | GPIO2 | | ||
| LED\_RUNNING | GPIO15 | | ||
| TVCC | 3V3 | | ||
| GND | GND | | ||
|
||
- JTAG | ||
|
||
| JTAG | | | ||
|--------------------|---------| | ||
| TCK | GPIO5 | | ||
| TMS | GPIO4 | | ||
| TDI | GPIO13 | | ||
| TDO | GPIO12 | | ||
| nTRST \(optional\) | GPIO0\* | | ||
| nRESET | GPIO14 | | ||
| LED\_CONNECTED | GPIO2 | | ||
| LED\_RUNNING | GPIO15 | | ||
| TVCC | 3V3 | | ||
| GND | GND | | ||
|
||
You can modify these pin definitions in [DAP_config.h](components/DAP/config/DAP_config.h) | ||
|
||
> Tips: Try to avoid using `GPIO0`(working mode switch) and `GPIO16`(RTC) | ||
## Build | ||
|
||
1. Get ESP8266 RTOS Software Development Kit | ||
|
||
See: [ESP8266_RTOS_SDK](https://github.com/espressif/ESP8266_RTOS_SDK "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") | ||
|
||
The following example shows a possible way to build on Windows: | ||
|
||
```bash | ||
# Build | ||
python ./idf.py build | ||
# Flash | ||
python ./idf.py -p /dev/ttyS5 flash | ||
``` | ||
|
||
> We also provided sample firmware quick evaluation. See [Releases](https://github.com/windowsair/wireless-esp8266-dap/releases) | ||
|
||
## Usage | ||
|
||
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 | ||
- Linux: Distributed as part of the kernel | ||
|
||
2. Start esp8266 and connect it to the device to be debugged | ||
|
||
3. Connect it with usbip: | ||
|
||
```bash | ||
.\usbip.exe -D -a <your-esp8266-ip-address> 1-1 | ||
``` | ||
|
||
If all goes well, you should see your device connected. | ||
![image](https://user-images.githubusercontent.com/17078589/73833411-eb3f6d80-4844-11ea-8501-02a008f6119d.png) | ||
|
||
![target](https://user-images.githubusercontent.com/17078589/73830040-eb3c6f00-483e-11ea-85ee-c40b68a836b2.png) | ||
|
||
|
||
|
||
## Develop | ||
|
||
> 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 | ||
|
||
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. | ||
|
||
|
||
Currently using USB-HID for transmission is still slightly slower, If you have any ideas, welcome: | ||
- [New issues](https://github.com/windowsair/wireless-esp8266-dap/issues) | ||
- [New pull](https://github.com/windowsair/wireless-esp8266-dap/pulls) | ||
|
||
|
||
### Issue | ||
|
||
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 | ||
|
||
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 | ||
|
||
|
||
|
||
## License | ||
[MIT LICENSE](LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
set(COMPONENT_ADD_INCLUDEDIRS "config include $ENV{IDF_PATH}/components/esp8266/include/esp8266/ $ENV{IDF_PATH}//components/esp_ringbuf/include/") | ||
set(COMPONENT_SRCS "./source/DAP.c ./source/DAP_vendor.c ./source/JTAG_DP.c ./source/SW_DP.c ./source/SWO.c ./source/uart_modify.c") | ||
|
||
|
||
register_component() |
Oops, something went wrong.