[U-Boot] [PATCH V3 3/4] rockchip:usb: add a simple readme for rockusb

[Eddie Cai]

2017-04-30 11:49 GMT+08:00 Simon Glass <sjg at chromium.org>:
> Hi Eddie,
>
> On 28 April 2017 at 18:41, Eddie Cai <eddie.cai.linux at gmail.com> wrote:
>> add a simple readme to introduce rockusb and tell people how to use it
>>
>> Signed-off-by: Eddie Cai <eddie.cai.linux at gmail.com>
>>
>> Changes in v3:
>> -fix checkpatch error
>> ---
>>  doc/README.rockusb | 37 +++++++++++++++++++++++++++++++++++++
>>  1 file changed, 37 insertions(+)
>>  create mode 100644 doc/README.rockusb
>>
>
>> diff --git a/doc/README.rockusb b/doc/README.rockusb
>> new file mode 100644
>> index 0000000..262596e
>> --- /dev/null
>> +++ b/doc/README.rockusb
>> @@ -0,0 +1,37 @@
>> +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
>> +(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
>
> is:
>
> blank line here
OK
>
>> +rockusb <USB_controller> <devtype> <dev[:part]>
>
> blank line
OK
>
>> +e.g. rockusb 0 mmc 0
>
> blanke line
OK
>
>> +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
>
> blank line
OK
>
>> +sudo rkdeveloptool wl  <BeginSec> <File>
>
> What are the parameters for? What do they mean?
I will add it in next version
>
> blank line
OK
>
>> +to flash U-Boot image use command
>
> blank line
>
>> +sudo rkdeveloptool wl  64 <U-Boot binary>
>
> blank line
>
> Which U-Boot file? Please be specific
I will add it in next version
>
>> +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
>> --
>> 1.9.1
>>
>
> Regards,
> Simon