framework swiss army knife debugger

Firmware used for debugging framework laptops using
a hardware debug adapter.
This uses the Teensy series of dev boards
to create a multifunction debugger that supports

DAP for SWD/JTAG - supported by pyocd, etc.

flashrom SPI programmer.

command uart that can toggle and control any teensy pin
* Command uart can be used to trigger i2c transactions
with the i2c peripheral.
* Can be used to monitor pin toggles on any pin.
* Can be used to measure analog voltage on analog pins.
* Can be interfaced with a INA260 /voltage/current/power monitor.

up to 3 separate hw uart bridges to bridge a hardware serial
port to a virtual com port, allowing simultanious logging from
multiple uarts.

The firmware allows shared use of functions such as swd debugging
and monitoring a serial port using a virtual com port at the same time.

Signed-off-by: Kieran Levin <ktl@frame.work>

Author: kiram9

.gitignore

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}

README.md

@@ -0,0 +1,207 @@
+=== Multi purpose debugger - target controller 
+
+Supports 
+CMSIS-DAP 
+Multiple serial terminals 
+GPIO read/write/port register control. 
+
+
+right now the backend uses raw hid reports for debug communication, terminal.py will open an interactive terminal to the device. 
+
+= How to flash to the teensy board: 
+pio run -e teensy41 --target upload
+pio run -e teensy31 --target upload
+pio run -e teensy36 --target upload
+
+
+= Modifications required to teensy 3.1 codebase:
+
+* For this to work you need to modify the teensy source code to set the RAWHID iInterface field to 2 to use the product string
+around line 1136 in ~/.platformio/packages/framework-arduinoteensy/cores/teensy3/usb_desc.c
+--------------------------------------
+#ifdef RAWHID_INTERFACE
+        // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
+        9,                                      // bLength
+        4,                                      // bDescriptorType
+        RAWHID_INTERFACE,                       // bInterfaceNumber
+        0,                                      // bAlternateSetting
+        2,                                      // bNumEndpoints
+        0x03,                                   // bInterfaceClass (0x03 = HID)
+        0x00,                                   // bInterfaceSubClass
+        0x00,                                   // bInterfaceProtocol
+        2,                                      // iInterface   <-------------------Modify this!
+
+
+usb_desc.h 
+--------------------------------------
+Add the following to the usb definitions section after USB_EVERYTHING
+#elif defined(USB_RAWHID_TRIPLESERIAL)
+ #define VENDOR_ID		0x16C0
+  #define PRODUCT_ID		0x048C
+  #define RAWHID_USAGE_PAGE     0xFFAB  // recommended: 0xFF00 to 0xFFFF
+  #define RAWHID_USAGE          0x0200  // recommended: 0x0100 to 0xFFFF
+  #define MANUFACTURER_NAME	{'T','e','e','n','s','y','d','u','i','n','o'}
+  #define MANUFACTURER_NAME_LEN	11
+  #define PRODUCT_NAME		{'C','M','S','I','S','-','D','A','P'}
+  #define PRODUCT_NAME_LEN	9
+  #define EP0_SIZE		64
+  #define NUM_ENDPOINTS		12
+  #define NUM_USB_BUFFERS	32
+  #define NUM_INTERFACE		7
+
+  #define CDC_IAD_DESCRIPTOR	1	// Serial
+  #define CDC_STATUS_INTERFACE	0
+  #define CDC_DATA_INTERFACE	1
+  #define CDC_ACM_ENDPOINT	2
+  #define CDC_RX_ENDPOINT	3
+  #define CDC_TX_ENDPOINT	4
+  #define CDC_ACM_SIZE		16
+  #define CDC_RX_SIZE		64
+  #define CDC_TX_SIZE		64
+
+  #define CDC2_STATUS_INTERFACE	2	// SerialUSB1
+  #define CDC2_DATA_INTERFACE	3
+  #define CDC2_ACM_ENDPOINT	5
+  #define CDC2_RX_ENDPOINT	6
+  #define CDC2_TX_ENDPOINT	7
+  #define CDC2_ACM_SIZE		16
+  #define CDC2_RX_SIZE		64
+  #define CDC2_TX_SIZE		64
+
+  #define CDC3_STATUS_INTERFACE	4	// SerialUSB2
+  #define CDC3_DATA_INTERFACE	5
+  #define CDC3_ACM_ENDPOINT	8
+  #define CDC3_RX_ENDPOINT	9
+  #define CDC3_TX_ENDPOINT	10
+  #define CDC3_ACM_SIZE		16
+  #define CDC3_RX_SIZE		64
+  #define CDC3_TX_SIZE		64
+
+  #define RAWHID_INTERFACE      6	// RawHID
+  #define RAWHID_TX_ENDPOINT    11
+  #define RAWHID_TX_SIZE        64
+  #define RAWHID_TX_INTERVAL    1
+  #define RAWHID_RX_ENDPOINT    12
+  #define RAWHID_RX_SIZE        64
+  #define RAWHID_RX_INTERVAL    1
+
+  #define ENDPOINT2_CONFIG	ENDPOINT_TRANSMIT_ONLY
+  #define ENDPOINT3_CONFIG	ENDPOINT_RECEIVE_ONLY
+  #define ENDPOINT4_CONFIG	ENDPOINT_TRANSMIT_ONLY
+
+  #define ENDPOINT5_CONFIG	ENDPOINT_TRANSMIT_ONLY
+  #define ENDPOINT6_CONFIG	ENDPOINT_RECEIVE_ONLY
+  #define ENDPOINT7_CONFIG	ENDPOINT_TRANSMIT_ONLY
+
+  #define ENDPOINT8_CONFIG	ENDPOINT_TRANSMIT_ONLY
+  #define ENDPOINT9_CONFIG	ENDPOINT_RECEIVE_ONLY
+  #define ENDPOINT10_CONFIG	ENDPOINT_TRANSMIT_ONLY
+
+  #define ENDPOINT11_CONFIG	ENDPOINT_TRANSMIT_ONLY
+  #define ENDPOINT12_CONFIG	ENDPOINT_RECEIVE_ONLY
+
+
+
+yeld.cpp 
+--------------------------------------
+need to add USB_RAWHID_TRIPLESERIAL wherever USB_TRIPLE_SERIAL is. 
+defined(USB_TRIPLE_SERIAL) || defined(USB_RAWHID_TRIPLESERIAL)
+
+
+usb_inst.cpp
+---------------------------------------
+Add defined(USB_RAWHID_TRIPLESERIAL) to 
+defined(USB_SERIAL) || defined(USB_DUAL_SERIAL) ||....
+
+./platforms/teensy/builder/frameworks/arduino.py
+---------------------------------------
+Add USB_RAWHID_TRIPLESERIAL
+
+to the section 
+BUILTIN_USB_FLAGS = (
+
+
+
+= Modifications required for teensy 4.1
+* For this to work you need to modify the teensy source code to set the RAWHID iInterface field to 2 to use the product string
+--------------------------------------
+Around line 1191 in ~/.platformio/packages/framework-arduinoteensy/cores/teensy4/usb_desc.c
+#ifdef RAWHID_INTERFACE
+        // configuration for 480 Mbit/sec speed
+        // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
+        9,                                      // bLength
+        4,                                      // bDescriptorType
+        RAWHID_INTERFACE,                       // bInterfaceNumber
+        0,                                      // bAlternateSetting
+        2,                                      // bNumEndpoints
+        0x03,                                   // bInterfaceClass (0x03 = HID)
+        0x00,                                   // bInterfaceSubClass
+        0x00,                                   // bInterfaceProtocol
+        2,                                      // iInterface
+
+--------------------------------------
+usb_desc.h 
+
+#elif defined(USB_RAWHID_TRIPLESERIAL)
+  #define VENDOR_ID             0x16C0
+  #define PRODUCT_ID            0x048C
+  #define RAWHID_USAGE_PAGE     0xFFAB  // recommended: 0xFF00 to 0xFFFF
+  #define RAWHID_USAGE          0x0200  // recommended: 0x0100 to 0xFFFF
+  #define MANUFACTURER_NAME     {'T','e','e','n','s','y','d','u','i','n','o'}
+  #define MANUFACTURER_NAME_LEN 11
+  #define PRODUCT_NAME          {'T','r','i','p','l','e',' ','S','e','r','i','a','l'}
+  #define PRODUCT_NAME_LEN      13
+  #define EP0_SIZE              64
+  #define NUM_ENDPOINTS         9
+  #define NUM_INTERFACE         7
+
+  #define CDC_IAD_DESCRIPTOR    1       // Serial
+  #define CDC_STATUS_INTERFACE  0
+  #define CDC_DATA_INTERFACE    1
+  #define CDC_ACM_ENDPOINT      2
+  #define CDC_RX_ENDPOINT       3
+  #define CDC_TX_ENDPOINT       3
+  #define CDC_ACM_SIZE          16
+  #define CDC_RX_SIZE_480       512
+  #define CDC_TX_SIZE_480       512
+  #define CDC_RX_SIZE_12        64
+  #define CDC_TX_SIZE_12        64
+  #define SEREMU_TX_SIZE        64
+
+  #define CDC2_STATUS_INTERFACE 2       // SerialUSB1
+  #define CDC2_DATA_INTERFACE   3
+  #define CDC2_ACM_ENDPOINT     4
+  #define CDC2_RX_ENDPOINT      5
+  #define CDC2_TX_ENDPOINT      5
+
+  #define CDC3_STATUS_INTERFACE 4       // SerialUSB2
+  #define CDC3_DATA_INTERFACE   5
+  #define CDC3_ACM_ENDPOINT     6
+  #define CDC3_RX_ENDPOINT      7
+  #define CDC3_TX_ENDPOINT      7
+
+  #define RAWHID_INTERFACE      6       // RawHID
+  #define RAWHID_TX_ENDPOINT    8
+  #define RAWHID_TX_SIZE        64
+  #define RAWHID_TX_INTERVAL    1        // TODO: is this ok for 480 Mbit speed
+  #define RAWHID_RX_ENDPOINT    9
+  #define RAWHID_RX_SIZE        64
+  #define RAWHID_RX_INTERVAL    1        // TODO: is this ok for 480 Mbit speed
+
+  #define ENDPOINT2_CONFIG      ENDPOINT_RECEIVE_UNUSED + ENDPOINT_TRANSMIT_INTERRUPT
+  #define ENDPOINT3_CONFIG      ENDPOINT_RECEIVE_BULK + ENDPOINT_TRANSMIT_BULK
+  #define ENDPOINT4_CONFIG      ENDPOINT_RECEIVE_UNUSED + ENDPOINT_TRANSMIT_INTERRUPT
+  #define ENDPOINT5_CONFIG      ENDPOINT_RECEIVE_BULK + ENDPOINT_TRANSMIT_BULK
+  #define ENDPOINT6_CONFIG      ENDPOINT_RECEIVE_UNUSED + ENDPOINT_TRANSMIT_INTERRUPT
+  #define ENDPOINT7_CONFIG      ENDPOINT_RECEIVE_BULK + ENDPOINT_TRANSMIT_BULK
+/* for raw hid */
+  #define ENDPOINT8_CONFIG      ENDPOINT_RECEIVE_UNUSED + ENDPOINT_TRANSMIT_INTERRUPT
+  #define ENDPOINT9_CONFIG      ENDPOINT_RECEIVE_INTERRUPT + ENDPOINT_TRANSMIT_UNUSED
+
+---------------------------------------
+./platforms/teensy/builder/frameworks/arduino.py
+---------------------------------------
+Add USB_RAWHID_TRIPLESERIAL
+
+to the section 
+BUILTIN_USB_FLAGS = (

include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

lib/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html