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

[Lukasz Majewski <lukma@denx.de>]

Hi Eddie,

> 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, 

R/W the info is the differentiator here. What kind of information canwe
read from the device? Do you plan to add this in the future?

Does it allow for reading/writing the RK soc's env variables ? 

>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. 

Ok.

> +
> +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>

Just informative - this could be achieved with UMS command with using
dd.

> +There are plenty of Rockusb command. but wl(write lba) and 
> +rd(reboot) command. 

Reboot is also supported - but there is no unification - though each
gadget (thor, dfu, fastboot)

> These two command can let people flash 
> +image to device. 

IMHO reading images (for backup) would be handy as well.

> +
> +To do
> +-----
> +* Fully support Rockusb protocol

For me it is OK, to have a minimal subset of commands supported - let's
add the very basic support and extend it latter.


Best regards,

Lukasz Majewski

--

DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de