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

docs/fw_binaries.md

@@ -289,3 +289,142 @@ extract the FSBL and PMUFW from the complete boot image.
 configuration:
  * path
 
+## For Rockchip devices
+
+Current implementation of support for the Rockchip SoCs, RAMboot and
+SPL DFU are supported.
+
+As there's no implementation for Rockchip USB protocol support, it is
+possible to push the DDR init files and SPL files from Rockchip but the next
+step will fail.
+
+Mainline u-boot does not support boot from RAM and boot from SPL DFU,
+it has to be patched.
+
+The patches have been sent to the u-boot mailing list by their authors
+and not yet merged. The patches can all be found inside this
+[merge request](https://gitlab.collabora.com/hardware-enablement/rockchip-3588/u-boot/-/merge_requests/7).
+
+### Using binary generated by Rockchip's ``boot_merger``
+
+[example](../src/snagrecover/templates/rockchip-merger.yaml)
+
+Snagboot can upload the ``CODE471_OPTION`` and ``CODE472_OPTION`` of a binary
+generated with the ``boot_merger`` tool and configuration files from
+[Rockchip rkbin](https://github.com/radxa/rkbin/tree/develop-v2024.03/).
+
+In case of u-boot, this would mean to upload the TPL, SPL and then use SPL DFU
+to boot u-boot proper (see later section for SPL DFU).
+
+An example configuration for rk3399 would be:
+```
+[CHIP_NAME]
+NAME=RK330C
+[VERSION]
+MAJOR=1
+MINOR=123
+[CODE471_OPTION]
+NUM=1
+Path1=tpl/u-boot-tpl-dtb.bin
+Sleep=1
+[CODE472_OPTION]
+NUM=1
+Path1=spl/u-boot-spl-dtb.bin
+Sleep=3000
+[LOADER_OPTION]
+NUM=2
+LOADER1=FlashData
+LOADER2=FlashBoot
+FlashData=spl/u-boot-spl-dtb.bin
+FlashBoot=u-boot.itb
+[OUTPUT]
+PATH=rk3399_uboot.bin
+[FLAG]
+471_RC4_OFF=false
+```
+
+The ``tpl/u-boot-tpl-dtb.bin``, ``spl/u-boot-spl-dtb.bin``, ``u-boot.itb``
+files are generated during u-boot's build. Please note has the ``LOADER_OPTION``
+is not handled by snagboot.
+
+The configuration parameters are:
+
+**xpl:** Binary blob generated with bootmerger. For instance, here, ``rk3399_uboot.bin``.
+ * path: path to the blob
+
+**u-boot-fit:** U-boot FIT image.
+ * path: Path to the FIT image. Typically, ``u-boot.itb``
+
+
+### Boot from Ram
+
+[example](../src/snagrecover/templates/rockchip-ramboot.yaml)
+
+When building u-boot with the previously mentioned patches, u-boot will generate two files:
+
+- ``u-boot-rockchip-usb471.bin``
+- ``u-boot-rockchip-usb472.bin``
+
+These are the files needed to boot from RAM.
+
+The configuration parameters are:
+
+**code471:** File to use for maskrom code 0x471.
+
+configuration:
+ * path: Path to the ``u-boot-rockchip-usb471.bin`` file
+ * delay: Optional delay in milliseconds before loading next binary
+
+**code472:** File to use for maskrom code 0x472.
+
+configuration:
+ * path: Path to the ``u-boot-rockchip-usb472.bin`` file
+
+
+### Boot from SPL DFU
+
+[example](../src/snagrecover/templates/rockchip-spl-dfu.yaml)
+
+To enable u-boot with SPL DFU support in the u-boot configuration, ensure that the
+following options are enabled:
+
+```
+CONFIG_SPL_DM_USB_GADGET=y
+CONFIG_SPL_USB_GADGET=y
+CONFIG_SPL_DFU=y
+```
+
+On some systems, rebooting the system won't reset the memory content. This means that
+booting over DFU after having done a boot from RAM will result in u-boot loading the
+u-boot version from the boot from RAM boot and won't try to load u-boot over DFU.
+
+To solve this, disable boot from RAM with:
+
+```
+# CONFIG_SPL_RAM_DEVICE is not set
+```
+
+The (SPL) USB gadget driver needs to be enabled too.
+
+At the end of the build, the following files will be needed:
+
+- ``mkimage-in-simple-bin.mkimage-u-boot-tpl`` or ``mkimage-in-simple-bin.mkimage-rockchip-tpl``
+- ``mkimage-in-simple-bin.mkimage-u-boot-spl``
+- ``u-boot.itb``
+
+The configuration parameters are:
+
+**code471:** File to use for maskrom code 0x471.
+
+configuration:
+ * path: Path to the TPL file. For instance, ``mkimage-in-simple-bin.mkimage-rockchip-tpl``.
+ * delay: Optional delay in milliseconds before loading next binary
+
+**code472:** File to use for maskrom code 0x472.
+
+configuration:
+ * path: Path to the  SPL. For instance, ``mkimage-in-simple-bin.mkimage-u-boot-spl``.
+ * delay: Optional delay in milliseconds before loading next binary
+
+**u-boot-fit:** U-boot FIT image.
+ * path: Path to the FIT image. Typically, ``u-boot.itb``

src/snagrecover/50-snagboot.rules

@@ -76,3 +76,21 @@ 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}=="2207", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="110a", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="110b", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="300a", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="301a", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="310b", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="310c", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="320a", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="320b", 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}=="330d", MODE="0660", TAG+="uaccess"
+SUBSYSTEM=="usb", ATTRS{idVendor}=="2207", ATTRS{idProduct}=="330e", 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

@@ -52,6 +52,23 @@
 		"imx8mm": "1fc9:0134",
 		"imx8mq": "1fc9:012b",
 		"imx53" : "15a2:004e",
+	},
+	"rockchip": {
+		"rv1108": "2207:110a",
+		"rv1126": "2207:110b",
+		"rk3066": "2207:300a",
+		"rk3036": "2207:301a",
+		"rk3188": "2207:310b",
+		"rk3128": "2207:310c",
+		"rk3288": "2207:320a",
+		"rk322x": "2207:320b",
+		"rk3328": "2207:320c",
+		"rk3368": "2207:330a",
+		"rk3399": "2207:330c",
+		"px30": "2207:330d",
+		"rk3308": "2207:330e",
+		"rk3568": "2207:350a",
+		"rk3588": "2207:350b"
 	}
 }
 
@@ -80,6 +97,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

@@ -146,6 +146,9 @@ 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
+		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/recoveries/rockchip.py

@@ -0,0 +1,54 @@
+import usb
+import logging
+logger = logging.getLogger("snagrecover")
+from snagrecover.firmware.firmware import run_firmware
+from snagrecover.utils import get_usb
+from snagrecover.utils import cli_error
+from snagrecover.config import recovery_config
+import time
+
+
+def main():
+	usb_addr = recovery_config["usb_path"]
+	dev = get_usb(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:
+			cli_error(f"Failed to run firmware: {e}")
+
+	# 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:
+			cli_error(f"Failed to run code471 firmware: {e}")
+		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:
+			cli_error(f"Failed to run code472 firmware: {e}")
+		if "delay" in recovery_config["firmware"]["code472"]:
+			delay = recovery_config["firmware"]["code472"]["delay"]
+			logger.info(f"Sleeping {delay}ms")
+			time.sleep(delay / 1000)
+	else:
+		cli_error(("Missing xpl or "
+                    "code471 (*_ddr_*.bin' or 'mkimage-in-simple-bin.mkimage-u-boot-tpl') / "
+                    "code472 ('*_usbplug_*.bin' or 'mkimage-in-simple-bin.mkimage-u-boot-spl')"
+                    "binary configuration."))
+
+	if "u-boot-fit" in recovery_config["firmware"]:
+		try:
+			dev = get_usb(usb_addr)
+			run_firmware(dev, "u-boot-fit")
+		except Exception as e:
+			cli_error(f"Failed to load u-boot.itb: {e}")

src/snagrecover/supported_socs.yaml

@@ -57,6 +57,10 @@ tested:
         family: stm32mp
   zynqmp:
         family: zynqmp
+  rk3399:
+        family: rockchip
+  rk3588:
+        family: rockchip
 untested:
   a10:
         family: sunxi
@@ -144,4 +148,29 @@ untested:
         family: sunxi
   v853:
         family: sunxi
-
+  rv1108:
+        family: rockchip
+  rv1126:
+        family: rockchip
+  rk3066:
+        family: rockchip
+  rk3036:
+        family: rockchip
+  rk3188:
+        family: rockchip
+  rk3128:
+        family: rockchip
+  rk3288:
+        family: rockchip
+  rk322x:
+        family: rockchip
+  rk3328:
+        family: rockchip
+  rk3368:
+        family: rockchip
+  px30:
+        family: rockchip
+  rk3308:
+        family: rockchip
+  rk3568:
+        family: rockchip

src/snagrecover/templates/rockchip-merger.yaml

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

src/snagrecover/templates/rockchip-ramboot.yaml

@@ -0,0 +1,5 @@
+code471:
+  path: u-boot-rockchip-usb471.bin
+  delay: 1
+code472:
+  path: u-boot-rockchip-usb472.bin

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

@@ -0,0 +1,8 @@
+code471:
+  path: mkimage-in-simple-bin.mkimage-u-boot-tpl
+  delay: 1
+code472:
+  path: mkimage-in-simple-bin.mkimage-u-boot-spl
+  delay: 10000
+u-boot-fit:
+  path: u-boot.itb

src/snagrecover/utils.py

@@ -191,6 +191,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}")