[ln882h] Add Lightning LN882H support (#52)

* ln882h support: first version

* removed ln882x sdk python scirpts from cli & cleanup

* ln882x : added generation of partcfg json file & ota file

* removed test files, oops

* ln882x: cleanup flash tools because not implemented

* ln882x: fix check ota size

* [ln882x] update firmware binaries generation with sparate partition images

* [ln882h] changed ln882x->ln882h; first flash tools release

* [ln882h] reformat

* [ln882h] reformat

* [ln822h] add ramcode binary

* Reformat Python files

---------

Co-authored-by: Kuba Szczodrzyński <[email protected]>

Author: lamauny

README.md

@@ -1,6 +1,6 @@
 # ltchiptool
 
-Universal, easy-to-use GUI flashing/dumping tool for BK7231, RTL8710B and RTL8720C. Also contains some CLI utilities for binary firmware manipulation.
+Universal, easy-to-use GUI flashing/dumping tool for BK7231, LN882H, RTL8710B and RTL8720C. Also contains some CLI utilities for binary firmware manipulation.
 
 <div align="center">
 

ltchiptool/commands/soc.py

@@ -9,6 +9,7 @@
     "rtltool": "ltchiptool/soc/ambz/util/rtltool.py",
     "ambztool": "ltchiptool/soc/ambz/util/ambztool.py",
     "ambz2tool": "ltchiptool/soc/ambz2/util/ambz2tool.py",
+    "ln882htool": "ltchiptool/soc/ln882h/util/ln882htool.py",
 }
 
 

ltchiptool/soc/amb/system.py

@@ -6,7 +6,7 @@
 from datastruct import DataStruct
 from datastruct.fields import adapter, alignto, bitfield, field
 
-FF_16 = b"\xFF" * 16
+FF_16 = b"\xff" * 16
 
 
 class FlashSpeed(IntEnum):

ltchiptool/soc/ambz/binary.py

@@ -24,14 +24,14 @@ def check_xip_binary(
 ) -> Optional[Tuple[int, int, bytes]]:
     if data[0:8] != header:
         return None
-    if data[16:32] != b"\xFF" * 16:
+    if data[16:32] != b"\xff" * 16:
         return None
     length, start = unpack("<II", data[8:16])
     return start, length, data[32:]
 
 
 def check_bootloader_binary(data: bytes) -> Optional[Tuple[int, int, bytes]]:
-    return check_xip_binary(data, header=b"\x99\x99\x96\x96\x3F\xCC\x66\xFC")
+    return check_xip_binary(data, header=b"\x99\x99\x96\x96\x3f\xcc\x66\xfc")
 
 
 class AmebaZBinary(SocInterface, ABC):

ltchiptool/soc/ambz/flash.py

@@ -105,7 +105,7 @@ def flash_sw_reset(self) -> None:
         port.baudrate = 115200
         sleep(0.1)
         # try software reset by writing the family ID, preceded by 55AA
-        magic_word = b"\x55\xAA" + self.family.id.to_bytes(length=4, byteorder="big")
+        magic_word = b"\x55\xaa" + self.family.id.to_bytes(length=4, byteorder="big")
         port.write(magic_word)
         sleep(0.5)
         port.baudrate = prev_baudrate
@@ -178,7 +178,7 @@ def flash_get_chip_info(self) -> List[Tuple[str, str]]:
         syscfg2 = letoint(data[256 + 512 + 16 + 8 : 256 + 512 + 16 + 8 + 4])
 
         system_data = data[256 + 512 + 16 + 16 : 256 + 512 + 16 + 16 + 128].ljust(
-            4096, b"\xFF"
+            4096, b"\xff"
         )
         system = SystemData.unpack(system_data)
 

ltchiptool/soc/ambz/util/ambzcode.py

@@ -204,7 +204,7 @@ def read_efuse_otp(offset: int = 0) -> bytes:
         return (
             b"\x02\x48\x01\x4b"
             b"\x98\x47\x03\xe0"
-            b"\x21\x3C\x00\x00"  # EFUSE_OTP_Read32B()
+            b"\x21\x3c\x00\x00"  # EFUSE_OTP_Read32B()
         ) + inttole32(AMBZ_DATA_ADDRESS + offset)
 
     @staticmethod

ltchiptool/soc/ambz/util/ambztool.py

@@ -108,7 +108,7 @@ def read(self, io: IO[bytes], n: int) -> bytes:
         # increment saved address
         self.address += n
         # add padding to force sending N+4 packet size
-        data = data.ljust(n + 4, b"\xFF")
+        data = data.ljust(n + 4, b"\xff")
         return data
 
 

ltchiptool/soc/ambz/util/rtltool.py

@@ -29,7 +29,7 @@
 CMD_XMD = b"\x07"  # Go xmodem mode (write RAM/Flash mode)
 CMD_EFS = b"\x17"  # Erase Flash Sectors
 CMD_RBF = b"\x19"  # Read Block Flash
-CMD_ABRT = b"\x1B"  # End xmodem mode (write RAM/Flash mode)
+CMD_ABRT = b"\x1b"  # End xmodem mode (write RAM/Flash mode)
 CMD_GFS = b"\x21"  # FLASH Get Status
 CMD_SFS = b"\x26"  # FLASH Set Status
 
@@ -283,7 +283,7 @@ def send_xmodem(self, stream, offset, size, retry=3):
                 if not data:  # end of stream
                     print("send: at EOF")
                     return False
-                data = data.ljust(packet_size, b"\xFF")
+                data = data.ljust(packet_size, b"\xff")
                 pkt = (
                     struct.pack("<BBBI", ord(cmd), sequence, 0xFF - sequence, offset)
                     + data

ltchiptool/soc/ambz2/binary.py

@@ -134,7 +134,7 @@ def elf2bin(self, input: str, ota_idx: int) -> List[FirmwareBinary]:
         nmap_ota1 = self.board.toolchain.nm(input)
 
         # build the partition table
-        ptable = PartitionTable(user_data=b"\xFF" * 256)
+        ptable = PartitionTable(user_data=b"\xff" * 256)
         for region, type in config.ptable.items():
             offset, length, _ = self.board.region(region)
             hash_key = config.keys.hash_keys[region]
@@ -205,11 +205,11 @@ def elf2bin(self, input: str, ota_idx: int) -> List[FirmwareBinary]:
         with output.write() as f:
             f.write(data)
         with out_ptab.write() as f:
-            ptab = data[ptab_offset:ptab_end].rstrip(b"\xFF")
+            ptab = data[ptab_offset:ptab_end].rstrip(b"\xff")
             ptab = pad_data(ptab, 0x20, 0xFF)
             f.write(ptab)
         with out_boot.write() as f:
-            boot = data[boot_offset:boot_end].rstrip(b"\xFF")
+            boot = data[boot_offset:boot_end].rstrip(b"\xff")
             boot = pad_data(boot, 0x20, 0xFF)
             f.write(boot)
         with out_ota1.write() as f:
@@ -230,15 +230,15 @@ def detect_file_type(
             return Detection.make("Realtek AmebaZ2 Flash Image", offset=0)
 
         if (
-            data[0x40:0x44] != b"\xFF\xFF\xFF\xFF"
+            data[0x40:0x44] != b"\xff\xff\xff\xff"
             and data[0x48] == ImageType.BOOT.value
         ):
             return Detection.make("Realtek AmebaZ2 Bootloader", offset=0x4000)
 
         if (
-            data[0xE0:0xE8].strip(b"\xFF")
+            data[0xE0:0xE8].strip(b"\xff")
             and data[0xE8] == ImageType.FWHS_S.value
-            and data[0x1A0:0x1A8].strip(b"\xFF")
+            and data[0x1A0:0x1A8].strip(b"\xff")
             and data[0x1A8] == SectionType.SRAM.value
         ):
             return Detection.make("Realtek AmebaZ2 Firmware", offset=None)

ltchiptool/soc/ambz2/util/models/images.py

@@ -27,7 +27,7 @@
 from .partitions import Bootloader, Firmware, PartitionTable
 from .utils import FF_32
 
-FLASH_CALIBRATION = b"\x99\x99\x96\x96\x3F\xCC\x66\xFC\xC0\x33\xCC\x03\xE5\xDC\x31\x62"
+FLASH_CALIBRATION = b"\x99\x99\x96\x96\x3f\xcc\x66\xfc\xc0\x33\xcc\x03\xe5\xdc\x31\x62"
 
 
 @dataclass