setup env for testing and setting fuses

Author: NanoCodeBug

.gitignore

@@ -6,4 +6,5 @@
 /.vscode
 /build*
 
-arduino-cli*
+arduino-cli*
+bootloader-feather_m0-*

README.md

@@ -1,22 +1,43 @@
 # Build Instructions
 
-Arduino SDK, pin layout of board is identical to a Adafruit Feather M0.
+Arduino SDK, pin layout of board is identical to a Adafruit Feather M0. 
 
 ## Linux Arduino SDK and Dependency Setup
 tools/linux/sdk-setup.sh
 
 tools/linux/build.sh
 
 ## Windows Arduino SDK and Dependency Setup
-win/tools/sdk-setup.ps1
+tools/win/sdk-setup.ps1
 
-win/tools/build.ps1
+tools/win/build.ps1
+
+## Mac Arduino SDK and Dependency Setup
+tools/osx/sdk-setup.ps1
+
+tools/osx/build.ps1
+
+# Bootloader Instructions
+
+1. flash adafruit bootloader https://github.com/adafruit/uf2-samdx1
+2. set boot brotection fuses to 8kb (bootprot fuse value 0x2)
+3. (optional) flash pawos_setup.hex
+4. disable BOD33 fuse via pawos_setup.hex or preffered programmer device
 
 # Flash Instructions
 
-will be identical to arduino sdk for now
+1. connect device via usb
+2. double click reset button to enter bootloader
+3. flash pawos via arduino-cli (tools/<plat>/flash.sh)
+
+# Update Instructions
+1. wake PawPet from sleep
+2. connect via USB
+3. flash pawos via arduino-cli (tools/<plat>/flash.sh)
+
+TODO: update instructions that use UF2 instead, should be possible to use a script to put the device into bootloader mode, and then copy the file over via system file browser, or dynamically detect the device attach via usb id and drive name.
 
-ideally use custom script for handing images to internal flash via msc and new firmware over UF2 format
+TODO: consider a self packaged C# exe or python script?
 
 TODO: look into using openocd for flashing bootloader
 

Untitled-2.md

@@ -0,0 +1,82 @@
+TODO:
+validate clock toggle rate is 30hz and fix counters as needed 
+need phillips screws for the back
+need more heat set inserts
+need more 470/480 ohm 805 resistors
+
+
+
+https://forum.arduino.cc/t/samd21-power-consumption-too-high-in-active-mode/668966/2
+
+
+Generic clock generator 0               8 division factor bits - DIV[7:0]
+Generic clock generator 1               16 division factor bits - DIV[15:0]
+Generic clock generators 2              5 division factor bits - DIV[4:0]
+Generic clock generators 3 - 8          8 division factor bits - DIV[7:0]
+
+rtc will be on anyways for time keeping
+
+add BOD33 disable in bootloader flashing scripts?
+
+condition where NVM RWS being 1 in bootloader will prevent startup below 2.1v
+which is in theory near the end of useful battery life anyways
+
+add ability for poweroff requiring push button reset?
+from system menu and for when battery is low
+- how to do this? disable all clocks?
+
+
+display says it operates down 2.7v
+- max frame frequency of 65hz?
+- claims EXTCOMIN should be below framerate frequency, does not indicate why
+- extcom freq of 54-65hz
+
+3) A still image should be displayed less than two hours, if it is necessary to display still image longer than two 
+hour, display image data must be refreshed in order to avoid sticking image on LCD panel
+
+Memory LCDs do not generate this signal internally. It must be supplied using one of two methods: 
+software, or external clock...
+When the software clock is selected [EXTMODE = L], bit V of the command bit string sets the state of VCOM. 
+See Figure 2. This bit must toggle (by writing to the panel) at least once per second. 
+
+Power Scenario 1 
+1hz write 1hz refresh
+Here all of the pixels will be written to the panel once per second. For the 1.35-inch panel, the quiescent 
+current for the panel is 2.1μA. Each write to the panel (assuming that the entire panel is written), takes 
+360μA; and lasts for about 5.38ms (assuming a 2 MHz SPI clock speed). 
+If averaged over a second, this amounts to an “average” currant draw of approximately 2μa. Therefore, the 
+panel would have an average power draw of 20.5μW (5V operation). Note that a VCOM toggle can be done 
+whenever the panel is written to, including a data write. 
+
+Power Scenario 2 
+30 sec write, 1hz refresh
+Here, we write all the pixels to the panel only every 30 seconds. The current required to write to the panel 
+“averaged” over that time is approximately 0.1μA. If VCOM is toggled once a second (using the Change 
+VCOM command), the additional power draw for this action (assuming that it is done 29 times) is an average 
+of 0.1μA. Therefore the average power draw over the 30-second period becomes 11.5μW. See Figure 10.
+Applying these conditions to the 2.7-inch panel: writing all pixels to the whole panel once a second takes an 
+average of 485μW. Writing all pixels once every 30 seconds (with a 1-second VCOM toggle) takes 135μW.
+
+
+
+
+    uint32_t userWord0 = *((uint32_t *)NVMCTRL_USER);       // Read fuses for user word 0
+    uint32_t userWord1 = *((uint32_t *)(NVMCTRL_USER + 4)); // Read fuses for user word 1
+    NVMCTRL->CTRLB.bit.CACHEDIS = 1;                        // Disable the cache
+    NVMCTRL->ADDR.reg = NVMCTRL_AUX0_ADDRESS / 2;           // Set the address
+    NVMCTRL->CTRLA.reg = NVMCTRL_CTRLA_CMD_EAR |            // Erase the auxiliary user page row
+                         NVMCTRL_CTRLA_CMDEX_KEY;
+    while (!NVMCTRL->INTFLAG.bit.READY)             // Wait for the NVM command to complete
+        NVMCTRL->STATUS.reg |= NVMCTRL_STATUS_MASK; // Clear the error flags
+    NVMCTRL->ADDR.reg = NVMCTRL_AUX0_ADDRESS / 2;   // Set the address
+    NVMCTRL->CTRLA.reg = NVMCTRL_CTRLA_CMD_PBC |    // Clear the page buffer
+                         NVMCTRL_CTRLA_CMDEX_KEY;
+    while (!NVMCTRL->INTFLAG.bit.READY)                            // Wait for the NVM command to complete
+        NVMCTRL->STATUS.reg |= NVMCTRL_STATUS_MASK;                // Clear the error flags
+    *((uint32_t *)NVMCTRL_USER) = userWord0 & ~FUSES_BOD33_EN_Msk; // Disable the BOD33 enable fuse in user word 0
+    *((uint32_t *)(NVMCTRL_USER + 4)) = userWord1;                 // Copy back user word 1 unchanged
+    NVMCTRL->CTRLA.reg = NVMCTRL_CTRLA_CMD_WAP |                   // Write to the user page
+                         NVMCTRL_CTRLA_CMDEX_KEY;
+    while (!NVMCTRL->INTFLAG.bit.READY)             // Wait for the NVM command to complete
+        NVMCTRL->STATUS.reg |= NVMCTRL_STATUS_MASK; // Clear the error flags
+    NVMCTRL->CTRLB.bit.CACHEDIS = 0;                // Enable the cache

pawos.ino

@@ -2,13 +2,13 @@
 #include <Adafruit_TinyUSB.h>
 #include <Arduino.h>
 #include <FatLib/FatFileSystem.h>
-#include <RTCZero.h>
 #include <SPI.h>
 #include <WInterrupts.h>
 #include <wiring_private.h>
 
 #include "src/lib/ArduinoLowPower.h"
 #include "src/lib/PawPet_FlashTransport.h"
+#include "src/lib/RTCZero.h"
 
 #include "src/common.h"
 #include "src/config.h"
@@ -17,6 +17,11 @@
 #include "src/states/gamestate.h"
 
 // #define DEBUG 1
+#define INSTALLER 1
+
+#ifdef INSTALLER
+#include "src/states/pawos_install.h"
+#endif
 
 #ifdef DEBUG
 #include <ZeroRegs.h>
@@ -28,7 +33,6 @@
 static const SPIFlash_Device_t possible_devices[] = {MX25R1635F};
 SPIClass flashSPI(&sercom2, FLASH_MISO, FLASH_SCK, FLASH_MOSI, SPI_PAD_0_SCK_1, SERCOM_RX_PAD_2);
 PawPet_FlashTransport_SPI flashTransport(FLASH_CS, flashSPI);
-Adafruit_SPIFlash flash(&flashTransport);
 
 SPIClass dispSPI(&sercom4, SHARP_MISO, SHARP_SCK, SHARP_MOSI, SPI_PAD_2_SCK_3, SERCOM_RX_PAD_0);
 PetDisplay display(&dispSPI, SHARP_SS, DISP_WIDTH, DISP_HEIGHT);
@@ -57,6 +61,9 @@ uint16_t intBat = 300;
 
 void setup(void)
 {
+    g::g_flash = new Adafruit_SPIFlash(&flashTransport);
+    Adafruit_SPIFlash& flash = *g::g_flash;
+
 #ifdef DEBUG
     Serial.begin(9600);
 
@@ -86,7 +93,37 @@ void setup(void)
     pinMode(PIN_BUTTON_C, INPUT_PULLUP);
 
     pinMode(PIN_BUTTON_P, INPUT_PULLUP);
-    LowPower.attachInterruptWakeup(PIN_BUTTON_P, buttonWakeupCallback, FALLING);
+    // LowPower.attachInterruptWakeup(PIN_BUTTON_P, buttonWakeupCallback, FALLING);
+
+    EExt_Interrupts in = g_APinDescription[PIN_BUTTON_P].ulExtInt;
+    if (in == NOT_AN_INTERRUPT || in == EXTERNAL_INT_NMI)
+        return;
+
+    attachInterrupt(PIN_BUTTON_P, buttonWakeupCallback, FALLING);
+
+    // enable EIC clock
+    GCLK->CLKCTRL.bit.CLKEN = 0; // disable GCLK module
+    while (GCLK->STATUS.bit.SYNCBUSY) {}
+
+    GCLK->CLKCTRL.reg = (uint16_t)(GCLK_CLKCTRL_CLKEN | GCLK_CLKCTRL_GEN_GCLK3 |
+                                   GCLK_CLKCTRL_ID(GCM_EIC)); // EIC clock switched on GCLK3
+    while (GCLK->STATUS.bit.SYNCBUSY) {}
+
+    // GCLK->GENCTRL.reg =
+    //     (GCLK_GENCTRL_GENEN | GCLK_GENCTRL_SRC_OSCULP32K | GCLK_GENCTRL_ID(2) | GCLK_GENCTRL_RUNSTDBY); // source for
+    //     GCLK2 is OSCULP32K
+    // while (GCLK->STATUS.reg & GCLK_STATUS_SYNCBUSY) {}
+
+    // GCLK->GENCTRL.bit.RUNSTDBY = 1; // GCLK2 run standby
+    // while (GCLK->STATUS.reg & GCLK_STATUS_SYNCBUSY) {}
+
+    // Enable wakeup capability on pin in case being used during sleep
+    EIC->WAKEUP.reg |= (1 << in);
+
+    /* Errata: Make sure that the Flash does not power all the way down
+     * when in sleep mode. */
+
+    NVMCTRL->CTRLB.bit.SLEEPPRM = NVMCTRL_CTRLB_SLEEPPRM_DISABLED_Val;
 
     pinMode(PIN_UP, INPUT_PULLUP);
     pinMode(PIN_LEFT, INPUT_PULLUP);
@@ -108,7 +145,7 @@ void setup(void)
     flash.begin(possible_devices);
 
     // Init file system on the flash
-    g::g_fatfs = new FatFileSystem;
+    g::g_fatfs = new FatFileSystem();
     g::g_stats.filesysFound = g::g_fatfs->begin(&flash);
     g::g_stats.flashSize = flash.size();
 
@@ -133,7 +170,11 @@ void setup(void)
 
     buttonWakeup = false;
     nextSleepTime = 40000;
+#ifdef INSTALLER
+    currentState = new InstallMenu();
+#else
     currentState = new MenuState();
+#endif
 
     g::g_rtc.begin();
     g::g_rtc.setHours(0);
@@ -156,13 +197,15 @@ void setup(void)
     delay(500);
     USBDevice.attach();
 #endif
-
-    tone(PIN_BEEPER, NOTE_C4, 250);
+    if (!g::g_stats.filesysFound)
+    {
+        tone(PIN_BEEPER, NOTE_C4, 250);
+    }
 }
 
 uint32_t sleepTicks = 0;
-uint8_t keysPressed = 0;
-uint8_t prevKeysPressed = 0;
+uint8_t keysState = 0;
+uint8_t prevKeysState = 0;
 
 uint32_t currentTimeMs = 0;
 uint32_t frameTimeMs = 0;
@@ -180,11 +223,11 @@ void loop(void)
     Watchdog.reset();
 
     //// UPDATE ////
-    keysPressed |= readButtons();
+    keysState |= readButtons();
 
     currentTimeMs = millis();
 
-    if (keysPressed)
+    if (keysState)
     {
         nextSleepTime = currentTimeMs + 60000;
     }
@@ -195,9 +238,11 @@ void loop(void)
     {
 
         prevFrameMs = currentTimeMs;
-
-        g::g_keyPressed = keysPressed;
-        g::g_keyReleased = ~(prevKeysPressed) & (keysPressed);
+        // held is currenlty just previous update, a function of update loop speed
+        // between 66 and 2000 ms
+        g::g_keyPressed = ~(prevKeysState)&keysState;
+        g::g_keyReleased = prevKeysState & ~(keysState);
+        g::g_keyHeld = prevKeysState & keysState;
 
         uint32_t t1 = millis();
         GameState *nextState = currentState->update();
@@ -235,6 +280,8 @@ void loop(void)
         if (currentState->redraw)
         {
             display.fillDisplayBuffer();
+            display.setCursor(0, 8);
+            display.setTextColor(PET_BLACK);
             currentState->draw(&display);
 
             // TODO, draw overlay should say if it needs an update
@@ -263,8 +310,8 @@ void loop(void)
             droppedFrames++;
         }
 
-        prevKeysPressed = keysPressed;
-        keysPressed = 0;
+        prevKeysState = keysState;
+        keysState = 0;
     }
     else
     {
@@ -332,6 +379,8 @@ void loop(void)
             if (currentState->redraw)
             {
                 display.fillDisplayBuffer();
+                display.setCursor(0, 8);
+                display.setTextColor(PET_BLACK);
                 currentState->draw(&display);
                 drawTimeAndBattery();
                 dirtyFrameBuffer = true;
@@ -472,7 +521,7 @@ int32_t msc_read_cb(uint32_t lba, void *buffer, uint32_t bufsize)
 {
     // Note: SPIFLash Bock API: readBlocks/writeBlocks/syncBlocks
     // already include 4K sector caching internally. We don't need to cache it, yahhhh!!
-    return flash.readBlocks(lba, (uint8_t *)buffer, bufsize / 512) ? bufsize : -1;
+    return g::g_flash->readBlocks(lba, (uint8_t *)buffer, bufsize / 512) ? bufsize : -1;
 }
 
 // Callback invoked when received WRITE10 command.
@@ -483,15 +532,15 @@ int32_t msc_write_cb(uint32_t lba, uint8_t *buffer, uint32_t bufsize)
     // check_uf2_handover(buffer, bufsize, 4, 5, tag);
     // Note: SPIFLash Bock API: readBlocks/writeBlocks/syncBlocks
     // already include 4K sector caching internally. We don't need to cache it, yahhhh!!
-    return flash.writeBlocks(lba, buffer, bufsize / 512) ? bufsize : -1;
+    return g::g_flash->writeBlocks(lba, buffer, bufsize / 512) ? bufsize : -1;
 }
 
 // Callback invoked when WRITE10 command is completed (status received and accepted by host).
 // used to flush any pending cache.
 void msc_flush_cb(void)
 {
     // sync with flash
-    flash.syncBlocks();
+    g::g_flash->syncBlocks();
 
     // clear file system's cache to force refresh
     g::g_fatfs->cacheClear();

src/global.cpp

@@ -6,9 +6,12 @@
 namespace g
 {
 FatFileSystem *g_fatfs;
+Adafruit_SPIFlash* g_flash;
+
 GraphicCache *g_cache;
 uint32_t g_keyReleased;
 uint32_t g_keyPressed;
+uint32_t g_keyHeld;
 stats g_stats;
 RTCZero g_rtc;
 } // namespace g

src/global.h

@@ -1,6 +1,8 @@
 #pragma once
+#include "lib/RTCZero.h"
 #include <Arduino.h>
-#include <RTCZero.h>
+#include <Adafruit_SPIFlash.h>
+
 /**
  * Global objects and constants
  *
@@ -38,7 +40,9 @@ extern FatFileSystem *g_fatfs;
 extern GraphicCache *g_cache;
 extern RTCZero g_rtc;
 extern stats g_stats;
+extern Adafruit_SPIFlash *g_flash;
 
 extern uint32_t g_keyReleased;
 extern uint32_t g_keyPressed;
+extern uint32_t g_keyHeld;
 } // namespace g