Skip to content

Documentation/applications/system/fastboot: add multi-transport info #19996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
acassis merged 1 commit into from
Aug 28, 2026
Merged

Documentation/applications/system/fastboot: add multi-transport info #19996

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions Documentation/applications/system/fastboot/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,19 @@ Prepare

- Check fastboot tool(Host): :code:`fastboot --version`
- Download fastboot tool and install(Host): `platform-tools <https://developer.android.com/tools/releases/platform-tools>`__
- Enable the fastbootd application(Device): :code:`CONFIG_USBFASTBOOT=y` and :code:`CONFIG_SYSTEM_FASTBOOTD=y`
- Enable the fastbootd application(Device): :code:`CONFIG_SYSTEM_FASTBOOTD=y`
- Enable at least one transport: USB (:code:`CONFIG_SYSTEM_FASTBOOTD_USB=y`), TCP (:code:`CONFIG_SYSTEM_FASTBOOTD_TCP=y`), or Serial (:code:`CONFIG_SYSTEM_FASTBOOTD_SERIAL=y`)
- Start fastbootd(Device): :code:`fastbootd &`

Transports
==========================

The fastboot daemon supports multiple transport backends concurrently. Each transport can be individually enabled via Kconfig.

- **USB**: Native USB fastboot protocol. Requires :code:`CONFIG_USBFASTBOOT=y`. Host: :code:`fastboot -s <SN> <command>` or just :code:`fastboot <command>`
- **TCP**: Fastboot TCP v1 protocol on port 5554. Requires :code:`CONFIG_NET_TCP=y`. Host: :code:`fastboot -s tcp:<device-ip>[:port] <command>`
- **Serial**: UART transport using TCP v1 wire framing. Use ``socat`` on the host to bridge the serial port to a TCP socket. Host: :code:`fastboot -s tcp:<host>:<socat-port> <command>`

Commands
==========================
- :code:`fastboot reboot [FLAG]`: Reboot the device, more details for :code:`[FLAG]`: `g_resetflag <https://github.com/apache/nuttx-apps/blob/master/nshlib/nsh_syscmds.c#L114>`__ and `boardioc_softreset_subreason_e <https://github.com/apache/nuttx/blob/master/include/sys/boardctl.h#L458>`__
Expand All @@ -31,6 +41,7 @@ Examples
- Exit fastboot mode: :code:`fastboot reboot`
- Flash app.bin to partition /dev/app: :code:`fastboot flash app ./app.bin`
- Erase partition /dev/userdata: :code:`fastboot erase userdata`
- Dump partition /dev/app: :code:`fastboot filedump /dev/app` and then :code:`fastboot get_staged ./dump_app.bin`
- Dump partition /dev/app: :code:`fastboot oem filedump /dev/app` and then :code:`fastboot get_staged ./dump_app.bin`
- Dump memory from 0x44000000 to 0x440b6c00: :code:`fastboot oem memdump 0x44000000 0xb6c00` and then :code:`fastboot get_staged ./mem_44000000_440b6c00.bin`
- Create RAM disk "/dev/ram10" of size 320KB: :code:`fastboot oem shell "mkrd -m 10 -s 512 640"`
- Serial transport via socat: :code:`sudo socat -t 0 PTY,link=/dev/ttyFB,raw,echo=0 TCP-LISTEN:5556,reuseaddr,fork,nodelay &` then :code:`fastboot -s tcp:127.0.0.1:5556 getvar version`