add a simple readme to introduce rockusb and tell people how to use it
Signed-off-by: Eddie Cai eddie.cai.linux@gmail.com Reviewed-by: Simon Glass sjg@chromium.org --- Changes in v12: -none
Changes in v11: -add to MAINTAINER
Changes in v10: -none
Changes in v9: -none
Changes in v8: -none
Changes in v7: -none
Changes in v6: -none
Changes in v5: -none
Changes in v4: -add some blank line to make it look better
Changes in v3: -fix checkpatch error --- MAINTAINERS | 1 + doc/README.rockusb | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 doc/README.rockusb
diff --git a/MAINTAINERS b/MAINTAINERS index b231610..9b4b63b 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -493,6 +493,7 @@ M: Eddie Cai eddie.cai.linux@gmail.com S: Maintained F: drivers/usb/gadget/f_rockusb.c F: cmd/rockusb.c +F: doc/README.rockusb
VIDEO M: Anatolij Gustschin agust@denx.de diff --git a/doc/README.rockusb b/doc/README.rockusb new file mode 100644 index 0000000..5405dc4 --- /dev/null +++ b/doc/README.rockusb @@ -0,0 +1,51 @@ +Rockusb (Rockchip USB protocol) +===================================================== + +Overview +-------- + +Rockusb protocol is widely used by Rockchip SoC based devices. It can +read/write info, image to/from devices. This document briefly describes how to +use Rockusb for upgrading firmware (e.g. kernel, u-boot, rootfs, etc.). + +Tools +-------- +There are many tools can support Rockusb protocol. rkdeveloptool +(https://github.com/rockchip-linux/rkdeveloptool) is open source, +It is maintained by Rockchip. People don't want to build from source +can download from here +(https://github.com/rockchip-linux/rkbin/blob/master/tools/rkdeveloptool) + +Usage +-------- +The Usage of Rockusb command is: + +rockusb <USB_controller> <devtype> <dev[:part]> + +e.g. rockusb 0 mmc 0 + +On your U-Boot console, type this command to enter rockusb mode. +On your host PC. use lsusb command. you should see a usb device +using 0x2207 as its USB verdor id. + +for more detail about the rkdeveloptool. please read the usage. + +rkdeveloptool -h + +use rkdeveloptool wl command to write lba. BeginSec is the lba on device +you want to write. + +sudo rkdeveloptool wl <BeginSec> <File> + +to flash U-Boot image use below command. U-Boot binary is made by mkimage. +see doc/README.rockchip for more detail about how to get U-Boot binary. + +sudo rkdeveloptool wl 64 <U-Boot binary> + +There are plenty of Rockusb command. but wl(write lba) and +rd(reboot) command. These two command can let people flash +image to device. + +To do +----- +* Fully support Rockusb protocol