Commit 1c977772a68d62bd23ae48fe46d2dcddf89c01c0

Authored by Eddie Cai
Committed by Marek Vasut
1 parent 453c95e01a

rockchip:usb: add a simple readme for rockusb

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>

Showing 2 changed files with 52 additions and 0 deletions Side-by-side Diff

... ... @@ -493,6 +493,7 @@
493 493 S: Maintained
494 494 F: drivers/usb/gadget/f_rockusb.c
495 495 F: cmd/rockusb.c
  496 +F: doc/README.rockusb
496 497  
497 498 VIDEO
498 499 M: Anatolij Gustschin <agust@denx.de>
  1 +Rockusb (Rockchip USB protocol)
  2 +=====================================================
  3 +
  4 +Overview
  5 +--------
  6 +
  7 +Rockusb protocol is widely used by Rockchip SoC based devices. It can
  8 +read/write info, image to/from devices. This document briefly describes how to
  9 +use Rockusb for upgrading firmware (e.g. kernel, u-boot, rootfs, etc.).
  10 +
  11 +Tools
  12 +--------
  13 +There are many tools can support Rockusb protocol. rkdeveloptool
  14 +(https://github.com/rockchip-linux/rkdeveloptool) is open source,
  15 +It is maintained by Rockchip. People don't want to build from source
  16 +can download from here
  17 +(https://github.com/rockchip-linux/rkbin/blob/master/tools/rkdeveloptool)
  18 +
  19 +Usage
  20 +--------
  21 +The Usage of Rockusb command is:
  22 +
  23 +rockusb <USB_controller> <devtype> <dev[:part]>
  24 +
  25 +e.g. rockusb 0 mmc 0
  26 +
  27 +On your U-Boot console, type this command to enter rockusb mode.
  28 +On your host PC. use lsusb command. you should see a usb device
  29 +using 0x2207 as its USB verdor id.
  30 +
  31 +for more detail about the rkdeveloptool. please read the usage.
  32 +
  33 +rkdeveloptool -h
  34 +
  35 +use rkdeveloptool wl command to write lba. BeginSec is the lba on device
  36 +you want to write.
  37 +
  38 +sudo rkdeveloptool wl <BeginSec> <File>
  39 +
  40 +to flash U-Boot image use below command. U-Boot binary is made by mkimage.
  41 +see doc/README.rockchip for more detail about how to get U-Boot binary.
  42 +
  43 +sudo rkdeveloptool wl 64 <U-Boot binary>
  44 +
  45 +There are plenty of Rockusb command. but wl(write lba) and
  46 +rd(reboot) command. These two command can let people flash
  47 +image to device.
  48 +
  49 +To do
  50 +-----
  51 +* Fully support Rockusb protocol