updating workflow

Author: snhobbs

.github/workflows/pyinstaller-package.yml

@@ -13,21 +13,32 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-24.04, ubuntu-22.04]
+        os: [ubuntu-22.04]#, ubuntu-24.04]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup Virtual Environment
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+      cache: 'pip'
+
+    - name: Check Python Version
       run: |
-        python -m venv venv
-        source venv/bin/activate
-    - name: Install dependencies
+        python --version
+        which python
+
+    - name: Install
       run: |
         python -m pip install --upgrade pip
         python -m pip install pyserial
-    - name: Install
-      run: |
+        python -m pip install pyinstaller
         python -m pip install .
+
+    - name: Verify Installations
+      run: |
+        python -m pip show isp_programmer
+        python -m pip show pyserial
+
     - name: Make executable
       uses: sayyid5416/pyinstaller@v1
       with:

src/isp_programmer/ISPConnection.py

@@ -17,11 +17,7 @@
 _log = logging.getLogger("isp_programmer")
 
 kTimeout = 1
-
-
 BAUDRATES = (9600, 19200, 38400, 57600, 115200, 230400, 460800)
-
-
 NXPReturnCodes = {
     "CMD_SUCCESS": 0x0,
     "INVALID_COMMAND": 0x1,
@@ -83,7 +79,8 @@ def _raise_return_code_error(code: int, call_name: str) -> None:
 
 @dataclass
 class Settings:
-    safe_write: bool = True # Check to see if sector is already equal to RAM, if so skip
+    # Check to see if sector is already equal to RAM, if so skip
+    safe_write: bool = True
     flash_write_sleep: float = 0.01
     ram_write_sleep: float = 0.01
     return_code_sleep: float = 0.05
@@ -101,7 +98,7 @@ class ISPConnection:
 
     kNewLine = "\r\n"
     StatusRespLength = len(kNewLine) + 1
-    kWordSize = 4  #  32 bit device
+    kWordSize = 4
     # Parity = None
     # DataBits = 8
     # StopBits = 1
@@ -212,7 +209,8 @@ def _get_return_code(self, command_string: str) -> int:
             if resp.strip() == command_string.strip():
                 _log.debug("Command was echoed, Discarding line: %s", resp)
                 resp = self._read_line()
-            # if self.echo_on:  # discard echo
+            # discard echo
+            # if self.echo_on:
             #    _log.debug("ECHO ON, Discarding line: %s", resp)
             #    resp = self._read_line()
         except TimeoutError:
@@ -262,7 +260,7 @@ def SetEcho(self, on: bool = True):
         """
         ISP echos host when enabled
         """
-        command = f"A {on : d}"
+        command = f"A {on:d}"
         response_code = self._write_command(command)
         _raise_return_code_error(response_code, "Set Echo")
         self.echo_on = on
@@ -281,14 +279,18 @@ def WriteToRam(self, start: int, data: bytes):
         # when transfer is complete the handler sends OK<CR><LF>
         response_code = self._write_command(f"W {start} {len(data)}")
         _raise_return_code_error(response_code, function_name)
-        self._write(data)  # Stream data after confirmation
+
+        # Stream data after confirmation
+        self._write(data)
         # Ignore response, it's not reliable
 
     def ReadMemory(self, start: int, num_bytes: int):
         """
         Send command with newline, receive response code\r\n<data>
         """
-        assert num_bytes % self.kWordSize == 0  #  On a word boundary
+
+        #  On a word boundary
+        assert num_bytes % self.kWordSize == 0
         function = "ReadMemory"
         command = f"R {start} {num_bytes}"
 
@@ -334,9 +336,9 @@ def Go(self, address: int, thumb_mode: bool = False):
         if thumb_mode:
             mode = "T"
         response_code = self._write_command(f"G {address} {mode}")
-        if (
-            response_code != self.ReturnCodes["NoStatusResponse"]
-        ):  #  Don't expect a response code from this
+
+        #  Don't expect a response code from this
+        if response_code != self.ReturnCodes["NoStatusResponse"]:
             _raise_return_code_error(response_code, "Go")
 
     def EraseSector(self, start: int, end: int):
@@ -467,7 +469,8 @@ def SetCrystalFrequency(self, frequency_khz: int):
         verified = False
         for _ in range(3):
             try:
-                frame_in = self._read_line()  # Should be OK\r\n
+                frame_in = self._read_line()
+                # Should be OK\r\n
                 if self.SyncVerifiedString in frame_in:
                     verified = True
                     break
@@ -520,7 +523,7 @@ def SyncConnection(self):
         # self._flush()
         _log.debug(f"Echoing sync string, {repr(self.SyncStringBytes)}")
         time.sleep(0.1)
-        self._write(self.SyncStringBytes)  # echo SyncString
+        self._write(self.SyncStringBytes)
         self.write_newline()
         self.write_newline()
         # > Synchronized\n
@@ -569,7 +572,7 @@ class ChipDescription:
     Wraps a chip description line and exposes it as a class
     """
 
-    kWordSize = 4  #  32 bit
+    kWordSize = 4
     kPageSizeBytes = 64
     SectorSizePages = 16
     CRCLocation = 0x000002FC
@@ -589,14 +592,13 @@ def __init__(self, descriptor: dict[str, typing.Any]):
         self.RAMBufferSize = int(descriptor.pop("RAMBufferSize"))
         self.SectorCount: int = int(descriptor.pop("SectorCount"))
         self.RAMStartWrite: int = int(descriptor.pop("RAMStartWrite"))
-        self.CrystalFrequency = 12000  # khz == 30MHz
-        self.kCheckSumLocation = 7  # 0x0000001c
+        self.CrystalFrequency = 12000
+        # 0x0000001c
+        self.kCheckSumLocation = 7
 
         assert self.RAMRange[0] > 0
         assert self.RAMRange[1] > self.RAMRange[0]
-
         assert self.FlashRange[1] > self.FlashRange[0]
-
         assert self.SectorCount > 0
 
     @property
@@ -638,9 +640,7 @@ def RamRangeLegal(self, address, length):
 
 # Script tools
 
-assert (
-    tools.calc_crc(bytes([0xFF] * 1024)) == 3090874356
-)  #  Check the software crc algorithm
+assert tools.calc_crc(bytes([0xFF] * 1024)) == 3090874356
 
 
 def RemoveBootableCheckSum(vector_table_loc: int, image: bytes) -> bytes:
@@ -667,7 +667,8 @@ def GetCheckSumedVectorTable(vector_table_loc: int, orig_image: bytes) -> bytes:
 
     # calculate the checksum over the interrupt vectors
     intvecs_list = list(intvecs[:vector_table_size])
-    intvecs_list[vector_table_loc] = 0  # clear csum value
+    # clear csum value
+    intvecs_list[vector_table_loc] = 0
     csum = tools.CalculateCheckSum(intvecs_list)
     intvecs_list[vector_table_loc] = csum
     vector_table_bytes = b""
@@ -678,7 +679,6 @@ def GetCheckSumedVectorTable(vector_table_loc: int, orig_image: bytes) -> bytes:
 
 def MakeBootable(vector_table_loc: int, orig_image: bytes) -> bytes:
     vector_table_bytes = GetCheckSumedVectorTable(vector_table_loc, orig_image)
-
     image = vector_table_bytes + orig_image[len(vector_table_bytes) :]
     return image
 
@@ -791,7 +791,8 @@ def WriteFlashSector(
 def WriteSector(isp: ISPConnection, chip: ChipDescription, sector: int, data: bytes):
     assert len(data) > 0
 
-    if len(data) != chip.sector_bytes:  #  Fill data buffer to match write size
+    #  Fill data buffer to match write size
+    if len(data) != chip.sector_bytes:
         data += bytes([0xFF] * (chip.sector_bytes - len(data)))
     WriteFlashSector(isp, chip, sector, data)
 
@@ -820,10 +821,9 @@ def WriteBinaryToFlash(
     isp.Unlock()
     for sector in reversed(range(start_sector, start_sector + sector_count)):
         _log.info(f"\nWriting Sector {sector} / {sector_count}")
-        data_chunk = image[
-            (sector - start_sector) * chip.sector_bytes : (sector - start_sector + 1)
-            * chip.sector_bytes
-        ]
+        start = (sector - start_sector) * chip.sector_bytes
+        end = (sector - start_sector + 1) * chip.sector_bytes
+        data_chunk = image[start:end]
         WriteSector(isp, chip, sector, data_chunk)
         time.sleep(isp.settings.flash_write_sleep)