Version 1.4.0 (#12)

* Initial commit TinyUSB interface

* Improving speed of read and write routines

* Adding switch for P2K edition

* Initial commit Settings object

* Adding settings widget

* Refactoring hexviewer

* Removing events

* Templated installer

* Tackling issue #10

* Fixing templated deployment

* Adding OSHW image

* Set colors via settings menu

* Implementing color themes

* Storing last file paths

* Adding more color schemes

* Setting custom font

* Setting MD5sum as uppercase

* Adding another color scheme

* Tuning firmware and GUI

* Fixing bug in read sector

* Fixing bug in dialog selection

* Upgrading actions to Qt 6.7.0

* Upgrading to Qt6 in CMakeLists.txt

* Adding qtserialport module

* Expanding libraries

* Adding missing file

* Adding serialport module

* Adding OpenSSLv3

* Adding more ROMS and fixing function in SettingsWidget class

* Tuning font size

Author: ifilot

.github/workflows/build.yml

@@ -46,9 +46,11 @@ jobs:
     - name: Install Qt
       uses: jurplel/install-qt-action@v3
       with:
-        version: '5.15.2'
+        version: '6.7.0'
         target: 'desktop'
         arch: 'win64_msvc2019_64'
+        tools: 'tools_opensslv3_x64'
+        modules: 'qtserialport'
         cache: true
     - name: Configure CMake
       run: cmake -B ${{github.workspace}}/build -S ${{github.workspace}}/gui -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
@@ -59,26 +61,53 @@ jobs:
       with:
         name: ${{env.EXEC}}
         path: ${{github.workspace}}/build/Release/${{env.EXEC}}
-        
+  
+  # create packaging metadata
+  prepare-installer-windows:
+    runs-on: ubuntu-latest
+    needs: build-gui-windows
+    permissions: write-all
+    steps:
+    - uses: actions/checkout@v3
+    - name: install dependencies
+      run: sudo apt-get update && sudo apt-get install -y python3 python3-jinja2
+    - name: run packaging script
+      run: python3 gui/packaging/package.py
+    - name: Upload packaging scripts
+      uses: actions/upload-artifact@v3
+      with:
+        name: package-metadata
+        path: |
+          ${{github.workspace}}/gui/packaging/config/config.xml
+          ${{github.workspace}}/gui/packaging/packages/com.vendor.product/meta/installscript.qs
+          ${{github.workspace}}/gui/packaging/packages/com.vendor.product/meta/package.xml
+
+  # create Windows installer
   create-installer-windows:
     runs-on: windows-latest
-    needs: build-gui-windows
+    needs: prepare-installer-windows
     permissions: write-all
     steps:
     - uses: actions/checkout@v3
     - name: Install Qt
       uses: jurplel/install-qt-action@v3
       with:
-        version: '5.15.2'
+        version: '6.7.0'
         target: 'desktop'
         arch: 'win64_msvc2019_64'
-        tools: 'tools_ifw'
+        modules: 'qtserialport'
+        tools: 'tools_ifw tools_opensslv3_x64'
         cache: true
     - name: Download artifact
       uses: actions/download-artifact@v3
       with:
         name: ${{env.EXEC}}
         path: gui/packaging/packages/com.vendor.product/data/
+    - name: Download installer metadata
+      uses: actions/download-artifact@v3
+      with:
+        name: package-metadata
+        path: ${{github.workspace}}/gui/packaging
     - name: Get dependencies
       run: windeployqt.exe gui\packaging\packages\com.vendor.product\data\${{env.EXEC}} --release --force
     - name: Copy assets
@@ -92,6 +121,7 @@ jobs:
         name: ${{env.PROGNAME}}-installer-win64.exe
         path: gui/packaging/${{env.PROGNAME}}-installer-win64.exe
 
+  # deploy Windows installer
   deploy-installer-windows:
     runs-on: ubuntu-latest
     needs: [create-installer-windows, create-release]

README.md

@@ -5,6 +5,9 @@
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-blue.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
 
+
+[![OSHW](img/certification-mark-NL000020-wide.svg)](https://certification.oshwa.org/nl000020.html)
+
 ## Purpose
 
 This open hardware project aims users to produce a low-cost flasher for the
@@ -53,4 +56,4 @@ Download the latest version of the binaries via the links below.
 ## License
 
 * All software is shared under the [GPL v3 license](https://www.gnu.org/licenses/gpl-3.0).
-* All hardware (e.g. KiCAD files and .stl files) are shared under the [CC-BY-SA 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/).
+* All hardware (e.g. KiCAD files and .stl files) are shared under the [CC-BY-SA 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/).

firmware/cmds.c

@@ -49,10 +49,8 @@ uint16_t get_uint16(const char* instruction, uint8_t offset) {
  * Return command back over serial
  */
 void echo_command(const char* inst, uint8_t size) {
-    for(unsigned int i=0; i<size; i++) {
-        putchar_raw(inst[i]);
-    }
-    stdio_flush();
+    tud_cdc_write(inst, size);
+    tud_cdc_write_flush();
 }
 
 /*

firmware/cmds.h

@@ -26,6 +26,7 @@
 #include <string.h>
 #include <pico/stdlib.h>
 #include <pico/stdio.h>
+#include <tusb.h>
 
 uint8_t get_uint8(const char* instruction, uint8_t offset);
 uint16_t get_uint16(const char* instruction, uint8_t offset);

firmware/constants.h

@@ -41,9 +41,17 @@ GPIO19 - LOAD for A16-A19
 #define LED_RD 26
 #define LED_WR 27
 
-#define DELAY_READ 5
-#define DELAY_WRITE 5
-#define DELAY_ADDR 4
-#define BOARD_ID "PICOSST39-v1.3.0"
+#define DELAY_READ 3
+#define DELAY_READ_VERIFY 1
+#define DELAY_WRITE 1
+#define DELAY_ADDR 1
+#define BOARD_ID "PICOSST39-v1.4.0"
+
+#define BLOCK_SIZE  0x100
+#define SECTOR_SIZE 0x1000
+#define BANK_SIZE   0x4000
+
+#define NOP __asm volatile ("nop\n");
+#define NOP50 __asm volatile ("nop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\nnop\n");
 
 #endif

firmware/main.c

@@ -23,13 +23,15 @@
 #include <stdlib.h>
 #include <string.h>
 #include <pico/stdlib.h>
+#include <tusb.h>
 
 #include "routines.h"
 #include "cmds.h"
 
 // command storage
 char instruction[9];    // stores single 8-byte instruction
 uint8_t inptr = 0;      // instruction pointer
+uint8_t buf[64];        // usb buffer
 
 // forward declarations
 void parse_instructions();
@@ -38,8 +40,12 @@ void parse_instructions();
  * Initialization routine that sets default pin configuration
  **/
 void init() {
+    // initialize standard I/O
     stdio_init_all();
 
+    // initialize TinyUSB stack
+    tusb_init();
+
     // initialize GPIO0-GPIO19 + 26,27
     gpio_init_mask(0x00CFFFFFF);
 
@@ -68,18 +74,25 @@ int main() {
     init();
 
     while(true) {
-        char c = getchar_timeout_us(100);
-        
-        // only capture alphanumerical data
-        if((c >= 48 && c <= 57) || (c >= 65 && c <=90)) {
-            instruction[inptr] = c;
-            inptr++;
-        }
+
+        if (tud_cdc_connected()) {
+            if (tud_cdc_available()) {
+                char c = tud_cdc_read_char();
 
-        if(inptr == 8) {
-            parse_instructions();
-            inptr = 0;
+                // only capture alphanumerical data
+                if((c >= 48 && c <= 57) || (c >= 65 && c <=90)) {
+                    instruction[inptr] = c;
+                    inptr++;
+                }
+                
+                if(inptr == 8) {
+                    parse_instructions();
+                    inptr = 0;
+                }
+            }
         }
+
+        tud_task();
     }
 }
 

firmware/ops.c

@@ -30,48 +30,19 @@ void set_address(uint32_t addr) {
     uint32_t addrh = (addr >> 8) & 0xFF;
     uint32_t addru = (addr >> 16) & 0xFF;
 
-    gpio_put_masked(0xFF00, addrl << 8);
-    gpio_put(ALS, true);
-    sleep_us(DELAY_ADDR);
-    gpio_put(ALS, false);
-
-    gpio_put_masked(0xFF00, addrh << 8);
-    gpio_put(AHS, true);
-    sleep_us(DELAY_ADDR);
-    gpio_put(AHS, false);
-
-    gpio_put_masked(0x0700, addru << 8);
-    gpio_put(AUS, true);
-    sleep_us(DELAY_ADDR);
-    gpio_put(AUS, false);
+    set_address_upper(addru);
+    set_address_high(addrh);
+    set_address_low(addrl);
 
     gpio_put(ROE, false); // enable address output
 }
 
 /**
- * Set upper bits in address register
- **/
-void set_address_high(uint32_t addr) {
-    set_address(addr & 0xFFFFFF00);
-}
-
-/**
- * Set lower 8 bits in address register
- **/
-void set_address_low(uint32_t addr) {
-    uint32_t addrl = addr & 0xFF;
-
-    gpio_put_masked(0xFF00, addrl << 8);
-    gpio_put(ALS, true);
-    sleep_us(DELAY_ADDR);
-    gpio_put(ALS, false);
-
-    gpio_put(ROE, false); // enable address output
-}
-
-/**
- * Read single byte from address
- **/
+ * @brief Read a single byte from address
+ * 
+ * @param addr full 19-bit address
+ * @return uint8_t value at address
+ */
 uint8_t read_byte(uint32_t addr) {
     // set pins 0-7 to input
     gpio_set_dir_in_masked(0x000000FF);
@@ -91,24 +62,52 @@ uint8_t read_byte(uint32_t addr) {
 }
 
 /**
- * Write byte at address
- **/
+ * @brief Write a byte at address
+ * 
+ * @param addr full 19-bit address
+ * @param val  8-bit value to write
+ */
 void write_byte(uint32_t addr, uint8_t val) {
     // set pins 0-7 to output
     gpio_set_dir_out_masked(0x000000FF);
 
+    // set address on pins
     set_address(addr);
 
+    gpio_put_masked(0xFF, val);
     gpio_put(CE, false);
     gpio_put(PGM, false);
 
-    // sleep_us(DELAY_TIME);
-    gpio_put_masked(0xFF, val);
     sleep_us(DELAY_WRITE);
 
     gpio_put(PGM, true);
     gpio_put(CE, true);
 
     // set pins 0-7 to input
     gpio_set_dir_in_masked(0x000000FF);
+}
+
+/**
+ * @brief Write byte at address while ignoring any upper bytes
+ * 
+ * @param addr 16-bit combination of lower and higher address bits
+ * @param val  8-bit value to write
+ * 
+ * Assumes that:
+ *  - Pins are already set for output
+ *  - Chip is already active (CE)
+ **/
+void write_byte_ignore_upper_fast(uint16_t addr, uint8_t val) {
+    // set address on pins
+    uint32_t addrl = addr & 0xFF;
+    uint32_t addrh = (addr >> 8) & 0xFF;
+
+    set_address_high(addrh);
+    set_address_low(addrl);
+    gpio_put_masked(0xFF, val);
+
+    // toggle write
+    gpio_put(PGM, false);
+    sleep_us(DELAY_WRITE);
+    gpio_put(PGM, true);
 }