[U-Boot] [U-Boot PATCH V2 8/8] rockusb: add a simple readme

Eddie Cai
2017-04-16T15:48:56Z

add a simple readme to introduce rockusb and tell people how to use it

Signed-off-by: Eddie Cai <eddie.cai.linux@gmail.com>
---
doc/README.rockusb | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
create mode 100644 doc/README.rockusb

diff --git a/doc/README.rockusb b/doc/README.rockusb
new file mode 100644
index 0000000..13893d9
--- /dev/null
+++ b/doc/README.rockusb
@@ -0,0 +1,35 @@
+Rockusb (Rockchip USB protocol)
+=====================================================
+
+Overview
+--------
+
+Rockusb protocol is widely used with Rockchip 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
+is open source, It is maintained by Rockchip.
+
+Usage
+--------
+The Usage of Rockusb command is
+rockusb <USB_controller> [<devtype>] <devnum>
+e.g. rockusb 0 mmc 0
+rockusb 0 usb 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. Then use rkdeveloptool
+sudo rkdeveloptool wl <BeginSec> <File>
+to flash U-Boot image use command
+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
--
2.10.2