snagrecover: Add rockchip support

Add support for booting a rockchip bin file, made with boot_merger.
It can be:
- a file containing the rockchip miniloader, but in this case,
  it's not useful, as rockusb is not implemented
- a file containing uboot tpl and spl. In this case, if u-boot
  is configured for SPL DFU, the snagrecover configuration file
  may specify an u-boot FIT image to load into the first DFU slot.
  This will allow booting u-boot proper and then to fastboot/ums/dfu/...
  to flash.

Signed-off-by: Arnaud Patard <[email protected]>

Author: apatard

src/snagrecover/50-snagboot.rules

@@ -76,3 +76,14 @@ SUBSYSTEM=="usb", ATTRS{idVendor}=="0451", ATTRS{idProduct}=="d022", MODE="0660"
 
 #Xilinx rules
 SUBSYSTEM=="usb", ATTRS{idVendor}=="03fd", ATTRS{idProduct}=="0050", MODE="0660", TAG+="uaccess"
+
+#Rockchip systems
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="301a", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="310c", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="320b", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="320a", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="320c", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="330a", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="330c", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="350a", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="350b", MODE="0660", TAG+="uaccess"

src/snagrecover/config.py

@@ -51,6 +51,17 @@
 		"imx8mm": "1fc9:0134",
 		"imx8mq": "1fc9:012b",
 		"imx53" : "15a2:004e",
+	},
+	"rockchip": {
+		"rk3036": "2207:310a",
+		"rk3128": "2207:310c",
+		"rk3229": "2207:320b",
+		"rk3288": "2207:320a",
+		"rk3328": "2207:320c",
+		"rk3368": "2207:330a",
+		"rk3399": "2207:330c",
+		"rk3566": "2207:350a",
+		"rk3588": "2207:350b"
 	}
 }
 
@@ -79,6 +90,8 @@ def init_config(args: list):
 		if args.usb_path is None:
 			if soc_family == "imx":
 				usb_ids = default_usb_ids["imx"][soc_model]
+			elif soc_family == "rockchip":
+				usb_ids = default_usb_ids["rockchip"][soc_model]
 			else:
 				usb_ids = default_usb_ids[soc_family]
 

src/snagrecover/firmware/firmware.py

@@ -122,6 +122,11 @@ def run_firmware(port, fw_name: str, subfw_name: str = ""):
 	elif soc_family == "zynqmp":
 		from snagrecover.firmware.zynqmp_fw import zynqmp_run
 		zynqmp_run(port, fw_name, fw_blob, subfw_name)
+	elif soc_family == "rockchip":
+		from snagrecover.firmware.rk_fw import rockchip_run, NEWIDB_LIST
+		if recovery_config["soc_model"] in NEWIDB_LIST and fw_name.startswith("code47"):
+			raise Exception("Only files generated with boot_merger are supported for this SoC")
+		rockchip_run(port, fw_name, fw_blob)
 	else:
 		raise Exception(f"Unsupported SoC family {soc_family}")
 	logger.info(f"Done installing firmware {fw_name}")

src/snagrecover/firmware/rk_fw.py

@@ -19,6 +19,9 @@
 logger = logging.getLogger("snagrecover")
 from snagrecover.protocols import rockchip
 
+# List generated with a grep on rkbin repository
+NEWIDB_LIST = [ "rk3506", "rk3506b", "rk3528", "rk3562", "rk3566", "rk3568", "rk3576", "rk3583", "rk3588", "rv1103b", "rv1106" ]
+
 BOOTTAG = b"BOOT"
 LDRTAG = b"LDR "
 TAG_LIST = [ BOOTTAG, LDRTAG ]

src/snagrecover/recoveries/rockchip.py

@@ -0,0 +1,67 @@
+import usb
+import logging
+logger = logging.getLogger("snagrecover")
+from snagrecover.firmware.firmware import run_firmware
+from snagrecover.utils import get_usb
+from snagrecover.config import recovery_config
+from snagrecover.protocols import dfu
+import sys
+import time
+
+def main():
+	usb_addr = recovery_config["usb_path"]
+	dev = get_usb(usb_addr)
+
+	logger.debug(f"Rockchip usb dev {usb_addr}")
+
+	# Blob made with boot_merger
+	if "xpl" in recovery_config["firmware"]:
+		try:
+			run_firmware(dev, "xpl")
+			usb.util.dispose_resources(dev)
+		except Exception as e:
+			logger.error(f"Failed to run firmware: {e}")
+			sys.exit(-1)
+	# u-boot binaries.
+	elif "code471" in recovery_config["firmware"] and "code472" in recovery_config["firmware"]:
+		try:
+			run_firmware(dev, "code471")
+			usb.util.dispose_resources(dev)
+		except Exception as e:
+			logger.error(f"Failed to run code471 firmware: {e}")
+			sys.exit(-1)
+		if "delay" in recovery_config["firmware"]["code471"]:
+			delay = recovery_config["firmware"]["code471"]["delay"]
+			logger.info(f"Sleeping {delay}ms")
+			time.sleep(delay / 1000)
+		try:
+			run_firmware(dev, "code472")
+			usb.util.dispose_resources(dev)
+		except Exception as e:
+			logger.error(f"Failed to run code472 firmware: {e}")
+			sys.exit(-1)
+		if "delay" in recovery_config["firmware"]["code472"]:
+			delay = recovery_config["firmware"]["code472"]["delay"]
+			logger.info(f"Sleeping {delay}ms")
+			time.sleep(delay / 1000)
+	else:
+		logger.error("Missing code471/code472 binary configuration")
+		sys.exit(-1)
+
+
+	if "u-boot-fit" in recovery_config["firmware"]:
+		dev = get_usb(usb_addr)
+		id = dfu.search_partid(dev, "u-boot.itb")
+		if id is None:
+			logger.error("Missing u-boot.itb DFU partition")
+		dfu_cmd = dfu.DFU(dev, stm32=False)
+		dfu_cmd.get_status()
+		with open(recovery_config["firmware"]["u-boot-fit"]["path"], "rb") as fd:
+			blob = fd.read()
+			try:
+				dfu_cmd.download_and_run(blob, id, 0, len(blob))
+				dfu_cmd.get_status()
+				dfu_cmd.detach(id)
+			except Exception as e:
+				logger.error(f"Failed to load u-boot.itb: {e}")
+				sys.exit(-1)

src/snagrecover/supported_socs.yaml

@@ -55,6 +55,8 @@ tested:
         family: stm32mp
   zynqmp:
         family: zynqmp
+  rk3399:
+        family: rockchip
 untested:
   a10:
         family: sunxi
@@ -142,4 +144,19 @@ untested:
         family: sunxi
   v853:
         family: sunxi
-
+  rk3036:
+        family: rockchip
+  rk3128:
+        family: rockchip
+  rk3229:
+        family: rockchip
+  rk3288:
+        family: rockchip
+  rk3328:
+        family: rockchip
+  rk3368:
+        family: rockchip
+  rk3566:
+        family: rockchip
+  rk3588:
+        family: rockchip

src/snagrecover/templates/rockchip-merger.yaml

@@ -0,0 +1,6 @@
+xpl:
+  # u-boot TPL+SPL in SPL DFU mode
+  path: rk3399_uboot.bin
+u-boot-fit:
+  # proper u-boot
+  path: u-boot.itb

src/snagrecover/templates/rockchip-tpl-spl.yaml

@@ -0,0 +1,9 @@
+# Doesn't work on all rockchip SoCs
+code471:
+  path: u-boot-tpl-dtb.bin
+  delay: 1
+code472:
+  path: u-boot-spl-dtb.bin
+  delay: 1
+u-boot-fit:
+  path: u-boot.itb

src/snagrecover/utils.py

@@ -186,6 +186,9 @@ def get_recovery(soc_family: str):
 	elif soc_family == "zynqmp":
 		from snagrecover.recoveries.zynqmp import main as zynqmp_recovery
 		return zynqmp_recovery
+	elif soc_family == "rockchip":
+		from snagrecover.recoveries.rockchip import main as rockchip_recovery
+		return rockchip_recovery
 	else:
 		cli_error(f"unsupported board family {soc_family}")