Documentation/esp32s3-devkit: Add doc for USB Fastboot

Signed-off-by: wangjianyu3 <[email protected]>
apache · Feb 19, 2025 · 32bc951 · 32bc951
1 parent 321b25f
commit 32bc951
Showing 1 changed file with 83 additions and 0 deletions.
diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst
@@ -857,3 +857,86 @@ To test it, just run the following::
   # Host
   $ sudo mkfs.ext4 /dev/sdx
   $ sudo mount /dev/sdx ./mnt/
+
+fastboot
+--------
+
+The basic Fastboot configuration is based on esp32s3-devkit:usb_device.
+More details about usage of fastboot, please refer to `fastbootd — NuttX latest documentation <https://nuttx.apache.org/docs/latest/applications/system/fastboot/index.html>`_.
+
+You can run the configuration and compilation procedure::
+
+  $ ./tools/configure.sh -l esp32s3-devkit:fastboot
+  $ make flash ESPTOOL_PORT=/dev/ttyACMx -j
+
+To test it, just run the following (**Default is host side**):
+
+1. Install fastboot tool::
+
+    sudo apt install fastboot
+
+2. List devices running fastboot::
+
+    fastboot devices
+
+  Example::
+
+    $ fastboot devices
+    1234    fastboot
+
+3. Display given variable::
+
+    fastboot getvar <NAME>
+
+  Example::
+
+    # Display the "kernel" variable::
+    $ fastboot -s 1234 getvar kernel
+    Kernel: NuttX
+    Finished. Total time: 0.000s
+
+4. Flash given partition::
+
+    fastboot flash PARTITION FILENAME
+
+  Example (Flash test.img to partition ram10)::
+
+    # 1. Generate a test image
+    $ dd if=/dev/random of=test.img bs=1 count=128
+
+    # 2. Create a RAM disk (Device side)
+    nsh> mkrd -m 10 -s 512 640
+    nsh> ls -l /dev/ram10
+     brw-rw-rw-      327680 /dev/ram10
+
+    # 3. Flash test.img to partition ram10
+    $ fastboot flash ram10 ./test.img
+    Sending 'ram10' (0 KB)                             OKAY [  0.001s]
+    Writing 'ram10'                                    OKAY [  0.001s]
+    Finished. Total time: 0.003s
+
+    # 4. Hexdump the test.img and partition ram10, and compare
+
+    ## Host side
+    $ hexdump test.img
+    0000000 b1e8 b297 4ac5 9dfa d170 244e 4f83 0f93
+    0000010 1bf7 0b19 7bde 5543 0520 9719 746d 54fc
+    0000020 369d 72b3 f2e6 f463 c8e9 24c8 c876 e820
+    0000030 384d 07ab 52ca 2b24 dee7 0404 2663 91e4
+    0000040 6752 3611 aece b543 5194 2224 d1d5 8144
+    0000050 ff44 3bc9 5155 b393 1efb 9e88 2de9 3669
+    0000060 d010 2770 9192 2532 ccf5 591f 39ea 2431
+    0000070 2e3f feb0 87ef 9bdf 7dd4 2e79 64de edf6
+    0000080
+
+    ## Device side
+    nsh> hexdump /dev/ram10 count=128
+    /dev/ram10 at 00000000:
+    0000: e8 b1 97 b2 c5 4a fa 9d 70 d1 4e 24 83 4f 93 0f .....J..p.N$.O..
+    0010: f7 1b 19 0b de 7b 43 55 20 05 19 97 6d 74 fc 54 .....{CU ...mt.T
+    0020: 9d 36 b3 72 e6 f2 63 f4 e9 c8 c8 24 76 c8 20 e8 .6.r..c....$v. .
+    0030: 4d 38 ab 07 ca 52 24 2b e7 de 04 04 63 26 e4 91 M8...R$+....c&..
+    0040: 52 67 11 36 ce ae 43 b5 94 51 24 22 d5 d1 44 81 Rg.6..C..Q$"..D.
+    0050: 44 ff c9 3b 55 51 93 b3 fb 1e 88 9e e9 2d 69 36 D..;UQ.......-i6
+    0060: 10 d0 70 27 92 91 32 25 f5 cc 1f 59 ea 39 31 24 ..p'..2%...Y.91$
+    0070: 3f 2e b0 fe ef 87 df 9b d4 7d 79 2e de 64 f6 ed ?........}y..d..