Add initial code for debugging feature

boards/esp-wrover-kit.json

@@ -21,6 +21,9 @@
     "ethernet",
     "can"
   ],
+  "debug": {
+    "openocd_board": "esp32-wrover.cfg"
+  },
   "frameworks": [
     "arduino",
     "espidf"
@@ -32,7 +35,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://espressif.com/en/products/hardware/esp-wrover-kit/overview",
   "vendor": "Espressif"

boards/esp32-evb.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://www.olimex.com/Products/IoT/ESP32-EVB/open-source-hardware",
   "vendor": "OLIMEX"

boards/esp32-gateway.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://www.olimex.com/Products/IoT/ESP32-GATEWAY/open-source-hardware",
   "vendor": "OLIMEX"

boards/esp320.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "http://www.sweetpeas.se/controller-modules/10-esp210.html",
   "vendor": "Electronic SweetPeas"

boards/esp32dev.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://en.wikipedia.org/wiki/ESP32",
   "vendor": "Espressif"

boards/esp32doit-devkit-v1.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "http://www.doit.am/",
   "vendor": "DOIT"

boards/esp32thing.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://www.sparkfun.com/products/13907",
   "vendor": "SparkFun Electronics"

boards/esp32vn-iot-uno.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://esp32.vn/",
   "vendor": "ESP32vn"

boards/espea32.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "https://blog.aprbrother.com/product/espea",
   "vendor": "April Brother"

boards/espectro32.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 2000000,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://shop.makestro.com/product/espectro32",
   "vendor": "DycodeX"

boards/espino32.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "http://thaieasyelec.com/products/development-boards/espino-wifi-development-board-detail.html",
   "vendor": "ThaiEasyElec"

boards/featheresp32.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://www.adafruit.com/product/3405",
   "vendor": "Adafruit"

boards/firebeetle32.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://dfrobotblog.wordpress.com",
   "vendor": "DFRobot"

boards/heltec_wifi_kit_32.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "http://www.heltec.cn",
   "vendor": "Heltec Automation"

boards/heltec_wifi_lora_32.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "http://www.heltec.cn",
   "vendor": "Heltec Automation"

boards/hornbill32dev.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://hackaday.io/project/18997-hornbill",
   "vendor": "Hornbill"

boards/hornbill32minima.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://hackaday.io/project/18997-hornbill",
   "vendor": "Hornbill"

boards/intorobot.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "http://docs.intorobot.com/zh/hardware/fig/hardware/",
   "vendor": "IntoRobot"

boards/lolin32.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://wemos.cc",
   "vendor": "WEMOS"

boards/m5stack-core-esp32.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "http://www.m5stack.com",
   "vendor": "M5Stack"

boards/mhetesp32devkit.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "http://forum.mhetlive.com",
   "vendor": "MH-ET Live"

boards/mhetesp32minikit.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "http://forum.mhetlive.com",
   "vendor": "MH-ET Live"

boards/microduino-core-esp32.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 2000000,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "https://microduinoinc.com",
   "vendor": "Microduino"

boards/nano32.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf",
     "simba",
@@ -28,7 +28,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "http://iot-bits.com/nano32-esp32-development-board",
   "vendor": "MakerAsia"

boards/nina_w10.json

@@ -16,7 +16,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -27,7 +27,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "https://www.u-blox.com/en/product/nina-w10-series",
   "vendor": "u-blox"

boards/node32s.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "http://www.ayarafun.com",
   "vendor": "Aiyarafun"

boards/nodemcu-32s.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "http://www.nodemcu.com/",
   "vendor": "NodeMCU"

boards/onehorse32dev.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "https://www.tindie.com/products/onehorse/esp32-development-board/",
   "vendor": "Onehorse"

boards/pocket_32.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "http://dong-sen.com",
   "vendor": "Dongsen Technology"

boards/quantum.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "http://wiki.jackslab.org/Noduino",
   "vendor": "Noduino"

boards/wemosbat.json

@@ -15,7 +15,10 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +29,13 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool",
+      "olimex-arm-usb-tiny-h",
+      "olimex-arm-usb-ocd-h"
+    ]
   },
   "url": "https://www.wemos.cc",
   "vendor": "WEMOS"

boards/widora-air.json

@@ -15,7 +15,7 @@
     "ethernet",
     "can"
   ],
-  "frameworks": [
+  "frameworks":  [
     "arduino",
     "espidf"
   ],
@@ -26,7 +26,11 @@
     "maximum_size": 1310720,
     "require_upload_port": true,
     "speed": 115200,
-    "wait_for_upload_port": true
+    "wait_for_upload_port": true,
+    "protocol": "esptool",
+    "protocols": [
+      "esptool"
+    ]
   },
   "url": "http://widora.io",
   "vendor": "Widora"

platform.json

@@ -70,6 +70,11 @@
       "type": "uploader",
       "optional": true,
       "version": "~1.1.0"
+    },
+    "tool-openocd-esp32": {
+      "type": "uploader",
+      "optional": true,
+      "version": "~0.1.0"
     }
   }
 }

platform.py

@@ -22,3 +22,44 @@ class Espressif32Platform(PlatformBase):
             self.packages['toolchain-xtensa32']['version'] = "~2.50200.0"
         return PlatformBase.configure_default_packages(
             self, variables, targets)
+
+    def get_boards(self, id_=None):
+        result = PlatformBase.get_boards(self, id_)
+        if not result:
+            return result
+        if id_:
+            return self._add_default_debug_tools(result)
+        else:
+            for key, value in result.items():
+                result[key] = self._add_default_debug_tools(result[key])
+        return result
+
+    def _add_default_debug_tools(self, board):
+        debug = board.manifest.get("debug", {})
+
+        upload_protocols = board.manifest.get("upload", {}).get(
+            "protocols", [])
+        if "tools" not in debug:
+            debug['tools'] = {}
+
+        # Only FTDI based debug probes
+        for link in ("olimex-arm-usb-tiny-h", "olimex-arm-usb-ocd-h"):
+            if link not in upload_protocols or link in debug['tools']:
+                continue
+
+            server_args = [
+                "-s", "$PACKAGE_DIR/share/openocd/scripts",
+                "-f", "share/openocd/scripts/interface/ftdi/%s.cfg" % link,
+                "-f", "share/openocd/scripts/board/%s" % debug.get("openocd_board")
+            ]
+
+            debug['tools'][link] = {
+                "server": {
+                    "package": "tool-openocd-esp32",
+                    "executable": "bin/openocd",
+                    "arguments": server_args
+                }
+            }
+
+        board.manifest['debug'] = debug
+        return board