xref: /openbmc/u-boot/doc/README.rockusb (revision 1c977772a68d62bd23ae48fe46d2dcddf89c01c0)
1*1c977772SEddie CaiRockusb (Rockchip USB protocol)
2*1c977772SEddie Cai=====================================================
3*1c977772SEddie Cai
4*1c977772SEddie CaiOverview
5*1c977772SEddie Cai--------
6*1c977772SEddie Cai
7*1c977772SEddie CaiRockusb protocol is widely used by Rockchip SoC based devices. It can
8*1c977772SEddie Cairead/write info, image to/from devices. This document briefly describes how to
9*1c977772SEddie Caiuse Rockusb for upgrading firmware (e.g. kernel, u-boot, rootfs, etc.).
10*1c977772SEddie Cai
11*1c977772SEddie CaiTools
12*1c977772SEddie Cai--------
13*1c977772SEddie CaiThere are many tools can support Rockusb protocol. rkdeveloptool
14*1c977772SEddie Cai(https://github.com/rockchip-linux/rkdeveloptool) is open source,
15*1c977772SEddie CaiIt is maintained by Rockchip. People don't want to build from source
16*1c977772SEddie Caican download from here
17*1c977772SEddie Cai(https://github.com/rockchip-linux/rkbin/blob/master/tools/rkdeveloptool)
18*1c977772SEddie Cai
19*1c977772SEddie CaiUsage
20*1c977772SEddie Cai--------
21*1c977772SEddie CaiThe Usage of Rockusb command is:
22*1c977772SEddie Cai
23*1c977772SEddie Cairockusb <USB_controller> <devtype> <dev[:part]>
24*1c977772SEddie Cai
25*1c977772SEddie Caie.g. rockusb 0 mmc 0
26*1c977772SEddie Cai
27*1c977772SEddie CaiOn your U-Boot console, type this command to enter rockusb mode.
28*1c977772SEddie CaiOn your host PC. use lsusb command. you should see a usb device
29*1c977772SEddie Caiusing 0x2207 as its USB verdor id.
30*1c977772SEddie Cai
31*1c977772SEddie Caifor more detail about the rkdeveloptool. please read the usage.
32*1c977772SEddie Cai
33*1c977772SEddie Cairkdeveloptool -h
34*1c977772SEddie Cai
35*1c977772SEddie Caiuse rkdeveloptool wl command to write lba. BeginSec is the lba on device
36*1c977772SEddie Caiyou want to write.
37*1c977772SEddie Cai
38*1c977772SEddie Caisudo rkdeveloptool wl  <BeginSec> <File>
39*1c977772SEddie Cai
40*1c977772SEddie Caito flash U-Boot image use below command. U-Boot binary is made by mkimage.
41*1c977772SEddie Caisee doc/README.rockchip for more detail about how to get U-Boot binary.
42*1c977772SEddie Cai
43*1c977772SEddie Caisudo rkdeveloptool wl  64 <U-Boot binary>
44*1c977772SEddie Cai
45*1c977772SEddie CaiThere are plenty of Rockusb command. but wl(write lba) and
46*1c977772SEddie Caird(reboot) command. These two command can let people flash
47*1c977772SEddie Caiimage to device.
48*1c977772SEddie Cai
49*1c977772SEddie CaiTo do
50*1c977772SEddie Cai-----
51*1c977772SEddie Cai* Fully support Rockusb protocol
52