Dynamic shuttle indexes based on chip ROM

Author: psychogenic

.github/workflows/release.yml

@@ -9,6 +9,7 @@ jobs:
     # ubuntu
     env:
       RPOS_UF2FILE: RPI_PICO-20240222-v1.22.2.uf2
+      TT_RUNS_SUPPORTED: "tt03p5 tt04"
     runs-on: ubuntu-latest
     steps:
     # need the repo checked out
@@ -27,6 +28,12 @@ jobs:
         python-version: '3.10'
         cache: 'pip'
     # build it
+    - name: get the os
+      run: |
+           mkdir $GITHUB_WORKSPACE/sdk/src/shuttles
+           for chip in $TT_RUNS_SUPPORTED; do wget -O $GITHUB_WORKSPACE/sdk/src/shuttles/$chip.json "https://index.tinytapeout.com/$chip.json?fields=repo,address,commit,clock_hz"; done
+     run: |
+    # build it
     - run: |
            pip install uf2utils
            touch $GITHUB_WORKSPACE/sdk/src/release_${{  github.ref_name }}

src/shuttle_index.json

@@ -211,7 +211,8 @@ def run_complete(self, success:bool):
             os.unlink(self.FirstBootIniFile)
             self.log_message('Unlinked first_boot ini file')
         except:
-            self.log_error(f'Issue unlinking {self.FirstBootIniFile}?')
+            # can happen (unlinked above)
+            pass
 
         self.log_message(f'First boot run success: {success}')
         if self._first_log is not None:

src/ttboard/boot/first.py

@@ -0,0 +1,67 @@
+'''
+Created on Apr 26, 2024
+
+@author: Pat Deegan
+@copyright: Copyright (C) 2024 Pat Deegan, https://psychogenic.com
+'''
+
+class ChipROM:
+    def __init__(self, project_mux):
+        self.project_mux = project_mux 
+        self._contents = None 
+        self._pins = project_mux.pins
+    
+    
+    def _send_and_rcv(self, send:int):
+        self._pins.input_byte = send 
+        return self._pins.output_byte
+        
+    @property
+    def shuttle(self):
+        return self.contents['shuttle']
+    
+    @property 
+    def repo(self):
+        return self.contents['repo']
+    
+    @property 
+    def commit(self):
+        return self.contents['commit']
+    
+    @property 
+    def contents(self):
+        if self._contents is not None:
+            return self._contents 
+        
+        # select project 0
+        self.project_mux.reset_and_clock_mux(0)
+        
+        self._contents = {
+                'shuttle': 'tt03p5',
+                'repo': '',
+                'commit': ''
+        }
+        
+        magic = self._send_and_rcv(0)
+        if magic != 0x78:
+            
+            return self._contents
+        
+        rom_data = ''
+        for i in range(32, 128):
+            byte = self._send_and_rcv(i)
+            if byte == 0:
+                break
+            rom_data += chr(byte)
+        
+        self._contents = {}
+        for l in rom_data.splitlines():
+            try:
+                k,v = l.split('=')
+                self._contents[k] = v 
+            except:
+                pass 
+        
+        return self._contents
+        
+        

src/ttboard/boot/rom.py

@@ -15,6 +15,7 @@
 @copyright: Copyright (C) 2024 Pat Deegan, https://psychogenic.com
 '''
 import ttboard.util.time as time
+from ttboard.globals import Globals
 from ttboard.mode import RPMode
 from ttboard.pins import Pins
 from ttboard.project_mux import ProjectMux, Design
@@ -102,14 +103,14 @@ def __init__(self,
 
         log.info(f'Demoboard starting up in mode {RPMode.to_string(mode)}')
 
-        self.pins = Pins(mode=mode)
-        self.shuttle = ProjectMux(self.pins)
+        self.pins = Globals.pins(mode=mode)
+        self.shuttle = Globals.project_mux()
 
         # config
         self.apply_configs = apply_user_config
 
         # internal
-        self.shuttle.designEnabledCallback = self.apply_user_config
+        self.shuttle.design_enabled_callback = self.apply_user_config
         self._clock_pwm = None
 
         self.load_default_project() 

src/ttboard/demoboard.py

@@ -0,0 +1,33 @@
+'''
+Created on Apr 26, 2024
+
+@author: Pat Deegan
+@copyright: Copyright (C) 2024 Pat Deegan, https://psychogenic.com
+'''
+from ttboard.mode import RPMode
+from ttboard.pins.pins import Pins 
+from ttboard.project_mux import ProjectMux
+
+class Globals:
+    Pins_Singleton = None 
+    ProjectMux_Singleton = None 
+    
+    @classmethod 
+    def pins(cls, mode=None) -> Pins:
+        if cls.Pins_Singleton is None:
+            if mode is None:
+                mode = RPMode.SAFE
+            cls.Pins_Singleton = Pins(mode=mode)
+            
+        if mode is not None and mode != cls.Pins_Singleton.mode:
+            cls.Pins_Singleton.mode = mode 
+            
+        return cls.Pins_Singleton
+    
+    @classmethod
+    def project_mux(cls) -> ProjectMux:
+        if cls.ProjectMux_Singleton is None:
+            cls.ProjectMux_Singleton = ProjectMux(cls.pins())
+            
+        return cls.ProjectMux_Singleton
+    

src/ttboard/globals.py

@@ -8,6 +8,7 @@
 import json
 import ttboard.util.time as time
 from ttboard.pins import Pins
+from ttboard.boot.rom import ChipROM
 
 import ttboard.logging as logging
 log = logging.getLogger(__name__)
@@ -42,16 +43,19 @@ def __repr__(self):
         return f'<Design {self.project_index}: {self.name}>'
 
 class DesignIndex:
-    def __init__(self, projectMux,  srcJSONFile:str='shuttle_index.json'):
+    def __init__(self, projectMux,  src_JSON_file:str='shuttle_index.json'):
         self._shuttle_index = dict()
         self._project_count = 0
-        with open(srcJSONFile) as fh:
-            index = json.load(fh)
-            for project in index["projects"]:
-                des = Design(projectMux, project["address"], project)
-                self._shuttle_index[des.name] = des
-                setattr(self, des.name, des)
-                self._project_count += 1
+        try:
+            with open(src_JSON_file) as fh:
+                index = json.load(fh)
+                for project in index["projects"]:
+                    des = Design(projectMux, project["address"], project)
+                    self._shuttle_index[des.name] = des
+                    setattr(self, des.name, des)
+                    self._project_count += 1
+        except OSError:
+            log.error(f'Could not open shuttle index {src_JSON_file}')
 
 
     @property
@@ -71,11 +75,12 @@ def get(self, project_name:str) -> Design:
 
 
 class ProjectMux:
-    def __init__(self, pins:Pins):
+    def __init__(self, pins:Pins, shuttle_index_file:str=None):
         self.p = pins 
         self._design_index = None
         self.enabled = None
-        self.designEnabledCallback = None
+        self.design_enabled_callback = None
+        self.shuttle_index_file = shuttle_index_file
 
     def reset(self):
         log.debug('Resetting project mux')
@@ -97,8 +102,8 @@ def enable(self, design:Design):
         log.info(f'Enable design {design.name}')
         self.reset_and_clock_mux(design.count)
         self.enabled = design
-        if self.designEnabledCallback is not None:
-            self.designEnabledCallback(design)
+        if self.design_enabled_callback is not None:
+            self.design_enabled_callback(design)
 
 
     def reset_and_clock_mux(self, count:int):
@@ -118,10 +123,23 @@ def reset_and_clock_mux(self, count:int):
         self.p.cena(1)
         self.p.muxCtrl.mode_project_IO() 
 
+    @property 
+    def pins(self) -> Pins:
+        return self.p
     @property
     def projects(self):
         if self._design_index is None:
-            self._design_index = DesignIndex(self)
+            if self.shuttle_index_file is None:
+                log.debug('No shuttle index file specified, loading rom')
+                rom = ChipROM(self)
+                log.info(f'Chip reported by ROM is {rom.shuttle} commit {rom.commit}')
+                shuttle_file = f'/shuttles/{rom.shuttle}.json'
+                self.shuttle_index_file = shuttle_file
+                
+            
+            log.info(f'Loading shuttle file {self.shuttle_index_file}')
+                
+            self._design_index = DesignIndex(self, src_JSON_file=self.shuttle_index_file)
 
         return self._design_index