Merge tag 'u-boot-amlogic-20201105' of https://gitlab.denx.de/u-boot/custodians/u...
[platform/kernel/u-boot.git] / doc / README.rockusb
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 Current set of rkdeveloptool commands supported:
46 - rci: Read Chip Info
47 - rfi: Read Flash Id
48 - rd : Reset Device
49 - td : Test Device Ready
50 - rl : Read blocks using LBA
51 - wl : Write blocks using LBA
52 - wlx: Write partition
53
54 To do
55 -----
56 * Fully support Rockusb protocol