Patch 1.3.0 (#9)

* Adding button to completely erase a chip

* Expanding README.md

Author: ifilot

firmware/README.md

@@ -60,5 +60,6 @@ of commands are given below.
   a CRC16 XMODEM checksum (2 bytes).
 * `ESSTXXXX`: Erases a block of data (writing `0xFF`) at hex position `XXXX000`.
   Returns number of wait cycles as 16 bit signed integer.
+* `ERASEALL`: Completely wipes the chip, writing `0xFF` to all bytes.
 * `TESTTEST`: Simple test routine. Reads the first 32 bytes on the chip. Returns
   32 bytes of data.

firmware/constants.h

@@ -44,6 +44,6 @@ GPIO19 - LOAD for A16-A19
 #define DELAY_READ 5
 #define DELAY_WRITE 5
 #define DELAY_ADDR 4
-#define BOARD_ID "PICOSST39-v1.1.0"
+#define BOARD_ID "PICOSST39-v1.3.0"
 
 #endif

firmware/main.c

@@ -108,6 +108,12 @@ void parse_instructions() {
         read_chip_id();
         return;
     /*
+    * Completely erase the chip
+    */
+    } else if(check_command(instruction, "ERASEALL", 0, 8)) {
+        erase_chip();
+        return;
+    /*
     * Read data from P2000 SLOT1 cartridge, requiring adapter board
     */        
     } else if(check_command(instruction, "RP2KCR", 0, 6)) {

firmware/routines.c

@@ -304,6 +304,30 @@ void write_block(uint32_t block_id) {
     putchar_raw(checksum);
 }
 
+/**
+ * @brief      Erase the complete chip
+ */
+void erase_chip() {
+    gpio_put(LED_WR, true);
+    
+    // chip-erase sequence
+    write_byte(0x5555, 0xAA);
+    write_byte(0x2AAA, 0x55);
+    write_byte(0x5555, 0x80);
+    write_byte(0x5555, 0xAA);
+    write_byte(0x2AAA, 0x55);
+    write_byte(0x5555, 0x10);
+
+    // get number of iterations in pollbyte routine
+    uint16_t cnts = pollbyte(0x0000);
+    
+    gpio_put(LED_WR, false);
+
+    // return result
+    putchar_raw(cnts >> 8);
+    putchar_raw(cnts & 0xFF);
+}
+
 /*
  * @brief Erase sector (4kb)
  */

firmware/routines.h

@@ -72,6 +72,11 @@ uint16_t pollbyte(uint32_t addr);
 */
 void write_block(uint32_t block_id);
 
+/**
+ * @brief      Erase the complete chip
+ */
+void erase_chip();
+
 /**
  * Erase sector (4kb)
 */

gui/src/config.h

@@ -22,7 +22,7 @@
 #define _CONFIG_H
 
 #define PROGRAM_NAME "PICO SST39sf0x0 Programmer"
-#define PROGRAM_VERSION "1.2.0"
+#define PROGRAM_VERSION "1.3.0"
 
 #define UNUSED(x) (void)(x)
 

gui/src/mainwindow.cpp

@@ -269,6 +269,7 @@ void MainWindow::build_operations_menu(QVBoxLayout* target_layout) {
 
     // add individual buttons here
     this->button_identify_chip = new QPushButton("Identify chip");
+    this->button_erase_chip = new QPushButton("Erase chip");
     this->button_read_rom = new QPushButton("Read ROM");
     this->button_read_cartridge = new QPushButton("Read P2000T Cartridge");
     this->button_flash_rom = new QPushButton("Write ROM");
@@ -279,8 +280,10 @@ void MainWindow::build_operations_menu(QVBoxLayout* target_layout) {
     layout->addWidget(this->button_read_cartridge);
     layout->addWidget(this->button_flash_rom);
     layout->addWidget(this->button_flash_bank);
+    layout->addWidget(this->button_erase_chip);
 
     this->button_identify_chip->setEnabled(false);
+    this->button_erase_chip->setEnabled(false);
     this->button_read_cartridge->setEnabled(false);
     this->button_read_rom->setEnabled(false);
     this->button_flash_rom->setEnabled(false);
@@ -291,6 +294,7 @@ void MainWindow::build_operations_menu(QVBoxLayout* target_layout) {
     connect(this->button_flash_rom, SIGNAL(released()), this, SLOT(flash_rom()));
     connect(this->button_identify_chip, SIGNAL(released()), this, SLOT(read_chip_id()));
     connect(this->button_flash_bank, SIGNAL(released()), this, SLOT(flash_bank()));
+    connect(this->button_erase_chip, SIGNAL(released()), this, SLOT(erase_chip()));
 
     target_layout->addWidget(container);
     this->progress_bar_load = new QProgressBar();
@@ -697,6 +701,7 @@ void MainWindow::read_chip_id() {
         this->button_read_rom->setEnabled(true);
         this->button_flash_rom->setEnabled(true);
         this->button_flash_bank->setEnabled(true);
+        this->button_erase_chip->setEnabled(true);
     } catch (const std::exception& e) {
         QMessageBox msg_box;
         msg_box.setIcon(QMessageBox::Warning);
@@ -909,6 +914,23 @@ void MainWindow::flash_bank() {
     //this->disable_all_buttons();
 }
 
+/**
+ * @brief Put rom on flash cartridge
+ */
+void MainWindow::erase_chip() {
+    QMessageBox::StandardButton reply;
+    reply = QMessageBox::question(this, "Wipe chip?", "Are you sure you want to completely wipe the chip?", QMessageBox::Yes|QMessageBox::No);
+    if (reply != QMessageBox::Yes) {
+        return;
+    }
+
+    this->serial_interface->open_port();
+    this->serial_interface->erase_chip();
+    this->serial_interface->close_port();
+
+    QMessageBox::information(this, "Chip erased.", "Done erasing the chip. All bytes are set of 0xFF.");
+}
+
 /**
  * @brief Slot to indicate that a sector is about to be written
  */

gui/src/mainwindow.h

@@ -77,6 +77,7 @@ class MainWindow : public QMainWindow
     // buttons
     QLabel* label_chip_type;
     QPushButton* button_identify_chip;
+    QPushButton* button_erase_chip;
     QPushButton* button_read_rom;
     QPushButton* button_read_cartridge;
     QPushButton* button_flash_rom;
@@ -245,6 +246,11 @@ private slots:
      */
     void flash_bank();
 
+    /**
+     * @brief Erase the chip
+     */
+    void erase_chip();
+
     /**
      * @brief Slot to indicate that a page is about to be written
      */

gui/src/serial_interface.cpp

@@ -265,6 +265,19 @@ uint16_t SerialInterface::get_chip_id() {
 
 }
 
+/**
+ * @brief Completely erase the chip
+ */
+void SerialInterface::erase_chip() {
+    try {
+        std::string command = "ERASEALL";
+        auto response = this->send_command_capture_response(command, 2);
+    }  catch (std::exception& e) {
+        std::cerr << "Caught error: " << e.what() << std::endl;
+        throw e;
+    }
+}
+
 /********************************************************
  *  PRIVATE ROUTINES
  ********************************************************/

gui/src/serial_interface.h

@@ -141,6 +141,11 @@ class SerialInterface {
      */
     uint16_t get_chip_id();
 
+    /**
+     * @brief Completely erase the chip
+     */
+    void erase_chip();
+
 private:
 
     /**

scripts/erase-test.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+
+import unittest
+import serial
+import serial.tools.list_ports
+import numpy as np
+
+def read_rom(filename):
+    f = open(filename, 'rb')
+    data = bytearray(f.read())      
+    f.close()
+    return data
+
+#
+# Test board functionality
+#
+class TestBoard(unittest.TestCase):
+
+    def setUp(self):
+        # autofind any available boards
+        ports = serial.tools.list_ports.comports()
+        portfound = None
+        for port in ports:
+            if port.pid == 0x0A and port.vid == 0x2E8A:
+                portfound = port.device
+                break
+
+        # specify the COM port below
+        if portfound:
+            self.ser = serial.Serial(portfound, 
+                                     19200, 
+                                     bytesize=serial.EIGHTBITS,
+                                     parity=serial.PARITY_NONE,
+                                     stopbits=serial.STOPBITS_ONE,
+                                     timeout=None)  # open serial port
+                       
+            while(not self.ser.isOpen()):
+                self.ser.open()
+        else:
+            raise Exception('Cannot find suitable port connection')
+
+    def teardDown(self):
+        while(not self.ser.isClosed()):
+            self.ser.close()
+
+    def test_board_id(self):
+        """
+        Test reading board id
+        """
+        self.ser.write(b'READINFO')
+        rsp = self.ser.read(8)
+        rsp = self.ser.read(16)
+        print(rsp)
+        self.assertEqual(rsp[0:4], b'PICO')
+        
+    def test_device_id(self):
+        """
+        Test reading board id
+        """
+        self.ser.write(b'DEVIDSST')
+        rsp = self.ser.read(8)
+        rsp = self.ser.read(2)
+        #print(' '.join('0x%02X' % d for d in rsp))
+        self.assertEqual(rsp, bytearray([0xBF,0xB7]))
+    
+    def test_erase(self):
+        """
+        Test erasing of sector on board
+        """
+        self.ser.write(b'ERASEALL')
+        rsp = self.ser.read(8)
+        rsp = self.ser.read(2) # read pollbyte count
+        print(' '.join('0x%02X' % d for d in rsp))
+
+if __name__ == '__main__':
+    unittest.main()