#!/usr/bin/env python3 import datetime import logging import os import re import struct from flipper.app import App from flipper.utils.programmer_openocd import OpenOCDProgrammer, OpenOCDProgrammerResult OTP_MAGIC = 0xBABE OTP_VERSION = 0x02 OTP_RESERVED = 0x00 OTP_COLORS = { "unknown": 0x00, "black": 0x01, "white": 0x02, "transparent": 0x03, } OTP_REGIONS = { "unknown": 0x00, "eu_ru": 0x01, "us_ca_au": 0x02, "jp": 0x03, "world": 0x04, } OTP_DISPLAYS = { "unknown": 0x00, "erc": 0x01, "mgg": 0x02, } class OTPException(Exception): def __init__(self, message: str, result: OpenOCDProgrammerResult): self.message = message self.result = result def get_exit_code(self) -> int: return int(self.result.value) class Main(App): def init(self): # SubParsers self.subparsers = self.parser.add_subparsers(help="sub-command help") # Generate All self.parser_generate_all = self.subparsers.add_parser( "generate", help="Generate OTP binary" ) self._addFirstArgs(self.parser_generate_all) self._addSecondArgs(self.parser_generate_all) self.parser_generate_all.add_argument("file", help="Output file") self.parser_generate_all.set_defaults(func=self.generate_all) # Flash First self.parser_flash_first = self.subparsers.add_parser( "flash_first", help="Flash first block of OTP to device" ) self._addArgsOpenOCD(self.parser_flash_first) self._addFirstArgs(self.parser_flash_first) self.parser_flash_first.set_defaults(func=self.flash_first) # Flash Second self.parser_flash_second = self.subparsers.add_parser( "flash_second", help="Flash second block of OTP to device" ) self._addArgsOpenOCD(self.parser_flash_second) self._addSecondArgs(self.parser_flash_second) self.parser_flash_second.set_defaults(func=self.flash_second) # Flash All self.parser_flash_all = self.subparsers.add_parser( "flash_all", help="Flash OTP to device" ) self._addArgsOpenOCD(self.parser_flash_all) self._addFirstArgs(self.parser_flash_all) self._addSecondArgs(self.parser_flash_all) self.parser_flash_all.set_defaults(func=self.flash_all) # logging self.logger = logging.getLogger() self.timestamp = datetime.datetime.now().timestamp() def _addArgsOpenOCD(self, parser): parser.add_argument( "--port-base", type=int, help="OpenOCD port base", default=3333 ) parser.add_argument( "--interface", type=str, help="OpenOCD interface", default="interface/cmsis-dap.cfg", ) parser.add_argument( "--serial", type=str, help="OpenOCD interface serial number" ) def _addFirstArgs(self, parser): parser.add_argument("--version", type=int, help="Version", required=True) parser.add_argument("--firmware", type=int, help="Firmware", required=True) parser.add_argument("--body", type=int, help="Body", required=True) parser.add_argument("--connect", type=int, help="Connect", required=True) parser.add_argument("--display", type=str, help="Display", required=True) def _addSecondArgs(self, parser): parser.add_argument("--color", type=str, help="Color", required=True) parser.add_argument("--region", type=str, help="Region", required=True) parser.add_argument("--name", type=str, help="Name", required=True) def _processFirstArgs(self): if self.args.display not in OTP_DISPLAYS: self.parser.error(f"Invalid display. Use one of {OTP_DISPLAYS.keys()}") self.args.display = OTP_DISPLAYS[self.args.display] def _processSecondArgs(self): if self.args.color not in OTP_COLORS: self.parser.error(f"Invalid color. Use one of {OTP_COLORS.keys()}") self.args.color = OTP_COLORS[self.args.color] if self.args.region not in OTP_REGIONS: self.parser.error(f"Invalid region. Use one of {OTP_REGIONS.keys()}") self.args.region = OTP_REGIONS[self.args.region] if len(self.args.name) > 8: self.parser.error("Name is too long. Max 8 symbols.") if re.match(r"^[a-zA-Z0-9.]+$", self.args.name) is None: self.parser.error( "Name contains incorrect symbols. Only a-zA-Z0-9 allowed." ) def _packFirst(self): return struct.pack( "<" "HBBL" "BBBBBBH", OTP_MAGIC, OTP_VERSION, OTP_RESERVED, int(self.timestamp), self.args.version, self.args.firmware, self.args.body, self.args.connect, self.args.display, OTP_RESERVED, OTP_RESERVED, ) def _packSecond(self): return struct.pack( "<" "BBHL" "8s", self.args.color, self.args.region, OTP_RESERVED, OTP_RESERVED, self.args.name.encode("ascii"), ) def generate_all(self): self.logger.info("Generating OTP") self._processFirstArgs() self._processSecondArgs() with open(f"{self.args.file}_first.bin", "wb") as file: file.write(self._packFirst()) with open(f"{self.args.file}_second.bin", "wb") as file: file.write(self._packSecond()) self.logger.info( f"Generated files: {self.args.file}_first.bin and {self.args.file}_second.bin" ) return 0 def flash_first(self): self.logger.info("Flashing first block of OTP") self._processFirstArgs() filename = f"otp_unknown_first_{self.timestamp}.bin" try: self.logger.info("Packing binary data") with open(filename, "wb") as file: file.write(self._packFirst()) self.logger.info("Flashing OTP") openocd = OpenOCDProgrammer( self.args.interface, self.args.port_base, self.args.serial, ) programmer_result = openocd.otp_write(0x1FFF7000, filename) if programmer_result != OpenOCDProgrammerResult.Success: raise OTPException("Failed to flash OTP", programmer_result) self.logger.info("Flashed Successfully") except OTPException as e: self.logger.exception(e) return e.get_exit_code() finally: os.remove(filename) return 0 def flash_second(self): self.logger.info("Flashing second block of OTP") self._processSecondArgs() filename = f"otp_{self.args.name}_second_{self.timestamp}.bin" try: self.logger.info("Packing binary data") with open(filename, "wb") as file: file.write(self._packSecond()) self.logger.info("Flashing OTP") openocd = OpenOCDProgrammer( self.args.interface, self.args.port_base, self.args.serial, ) programmer_result = openocd.otp_write(0x1FFF7010, filename) if programmer_result != OpenOCDProgrammerResult.Success: raise OTPException("Failed to flash OTP", programmer_result) self.logger.info("Flashed Successfully") except OTPException as e: self.logger.exception(e) return e.get_exit_code() finally: os.remove(filename) return 0 def flash_all(self): self.logger.info("Flashing OTP") self._processFirstArgs() self._processSecondArgs() filename = f"otp_{self.args.name}_whole_{self.timestamp}.bin" try: self.logger.info("Packing binary data") with open(filename, "wb") as file: file.write(self._packFirst()) file.write(self._packSecond()) self.logger.info("Flashing OTP") openocd = OpenOCDProgrammer( self.args.interface, self.args.port_base, self.args.serial, ) programmer_result = openocd.otp_write(0x1FFF7000, filename) if programmer_result != OpenOCDProgrammerResult.Success: raise OTPException("Failed to flash OTP", programmer_result) self.logger.info("Flashed Successfully") except OTPException as e: self.logger.exception(e) return e.get_exit_code() finally: os.remove(filename) return 0 if __name__ == "__main__": Main()()