system/fastboot: Add support for fastboot oem shell #3003

JianyuWang0623 · 2025-02-20T03:54:21Z

Summary

Add support for fastboot oem shell to support executing custom commands.

Usage

fastboot oem shell <command>

Impact

system/fastboot

Testing

# Configuration "esp32s3-devkit:fastboot" with `SYSTEM_FASTBOOTD_SHELL` enabled

$ fastboot --version
fastboot version 35.0.2-12147458

$ fastboot oem shell ls /FILE_NOT_EXISTS
FAILED (remote: 'error detected 255 4')
fastboot: error: Command failed

$ fastboot oem shell ps
  PID GROUP PRI POLICY   TYPE    NPX STATE    EVENT     SIGMASK            STACK COMMAND
    0     0   0 FIFO     Kthread   - Ready              0000000000000000 0003056 Idle_Task
    1     0 224 RR       Kthread   - Waiting  Semaphore 0000000000000000 0001976 hpwork 0x3fc8bd50 0x3fc8bd80
    2     2 100 RR       Task      - Waiting  Semaphore 0000000000000000 0004048 nsh_main
    3     3 100 RR       Task      - Ready              0000000000000000 0001992 fastbootd
    4     4 100 RR       Task      - Running            0000000000000000 0001992 popen -c ps
OKAY [  0.010s]
Finished. Total time: 0.010s

JianyuWang0623 · 2025-02-20T03:55:33Z

@Donny9 @yangsong8-ai Could you review this PR please?

system/fastboot/fastboot.c

system/fastboot/Kconfig

system/fastboot/fastboot.c

JianyuWang0623 · 2025-02-21T05:57:05Z

The print format of "INFO" is: "(bootloader) " + InfoMessagePayload + ‘\n’:

$ fastboot oem sh ps
                                                   (bootloader)   PID GROUP PRI POLICY   TYPE    NPX STATE    EVENT     SIG
(bootloader) MASK            STACK COMMAND

(bootloader)     0     0   0 FIFO     Kthread   - Ready              000
(bootloader) 0000000000000 0003056 Idle_Task

(bootloader)     1     0 224 RR       Kthread   - Waiting  Semaphore 000
(bootloader) 0000000000000 0001976 hpwork 0x3fc8bb90 0x3fc8bbc0

(bootloader)     2     2 100 RR       Task      - Waiting  Semaphore 000
(bootloader) 0000000000000 0004048 nsh_main

(bootloader)     3     3 100 RR       Task      - Ready              000
(bootloader) 0000000000000 0001992 fastbootd

(bootloader)     4     4 100 RR       Task      - Running            000
(bootloader) 0000000000000 0001992 popen -c ps

fastboot version 28.0.2-debian doesn`t support "TEXT", the latest version(fastboot version 35.0.2-12147458) supports

28.0.2-debian

$ fastboot --version
fastboot version 28.0.2-debian
Installed as /usr/lib/android-sdk/platform-tools/fastboot

$ fastboot oem sh ps
                                                   FAILED (Device sent unknown status code: TEXT  PID GROUP PRI POLICY   TYPE    NPX STATE    EVENT     SIG)
fastboot: error: Command failed

35.0.2-12147458

  $ ./platform-tools/fastboot oem sh ps
    PID GROUP PRI POLICY   TYPE    NPX STATE    EVENT     SIGMASK            STACK COMMAND
      0     0   0 FIFO     Kthread   - Ready              0000000000000000 0003056 Idle_Task
      1     0 224 RR       Kthread   - Waiting  Semaphore 0000000000000000 0001976 hpwork 0x3fc8bd50 0x3fc8bd80
      2     2 100 RR       Task      - Waiting  Semaphore 0000000000000000 0004048 nsh_main
      3     3 100 RR       Task      - Ready              0000000000000000 0001992 fastbootd
      4     4 100 RR       Task      - Running            0000000000000000 0001992 popen -c ps
  OKAY [  0.010s]
  Finished. Total time: 0.010s

source
2372748: Fastboot: Add new TEXT message to protocol to handle long lines. | https://android-review.googlesource.com/c/platform/system/core/+/2372748

99097cc020 (Raphael Herouart 2022-12-30 11:51:54 +0000 503)         } else if (android::base::StartsWith(input, "TEXT")) {
99097cc020 (Raphael Herouart 2022-12-30 11:51:54 +0000 504)             text_(input.substr(strlen("TEXT")));
99097cc020 (Raphael Herouart 2022-12-30 11:51:54 +0000 505)             // Reset timeout as many more TEXT may come
99097cc020 (Raphael Herouart 2022-12-30 11:51:54 +0000 506)             start = std::chrono::steady_clock::now();
db511207ed (Aaron Wisner     2018-06-26 15:38:35 -0500 507)         } else if (android::base::StartsWith(input, "DATA")) {
... ...
db511207ed (Aaron Wisner     2018-06-26 15:38:35 -0500 517)         } else {
db511207ed (Aaron Wisner     2018-06-26 15:38:35 -0500 518)             error_ = android::base::StringPrintf("Device sent unknown status code: %s", status);
db511207ed (Aaron Wisner     2018-06-26 15:38:35 -0500 519)             return BAD_DEV_RESP;
db511207ed (Aaron Wisner     2018-06-26 15:38:35 -0500 520)         }

Using newer version fastboot tool to support code "TEXT" for original format output.

Selftest # Host side $ ./tools/configure.sh -l esp32s3-devkit:fastboot $ make flash -j ESPTOOL_PORT=/dev/ttyACMx $ fastboot devices 1234 fastboot $ fastboot -s 1234 oem shell ps PID GROUP PRI POLICY TYPE NPX STATE EVENT SIGMASK STACK COMMAND 0 0 0 FIFO Kthread - Ready 0000000000000000 0003056 Idle_Task 1 0 224 RR Kthread - Waiting Semaphore 0000000000000000 0001976 hpwork 0x3fc8bd50 0x3fc8bd80 2 2 100 RR Task - Waiting Semaphore 0000000000000000 0004048 nsh_main 3 3 100 RR Task - Ready 0000000000000000 0001992 fastbootd 4 4 100 RR Task - Running 0000000000000000 0001992 popen -c ps OKAY [ 0.010s] Finished. Total time: 0.010s More details apache/nuttx-apps#3003 Signed-off-by: wangjianyu3 <[email protected]>

xiaoxiang781216

LGTM

cederom

Thank you @JianyuWang0623 :-)

jerpelea

please add commit message
fb4c03f

Add support for producing output according to a format like printf(). Signed-off-by: wangjianyu3 <[email protected]>

To support executing custom commands. Usage fastboot oem shell <command> Tests # Configuration "esp32s3-devkit:fastboot" with `SYSTEM_FASTBOOTD_SHELL` enabled $ fastboot --version fastboot version 35.0.2-12147458 $ fastboot oem shell ls /FILE_NOT_EXISTS FAILED (remote: 'error detected 0xff00 4') fastboot: error: Command failed $ fastboot oem shell ps PID GROUP PRI POLICY TYPE NPX STATE EVENT SIGMASK STACK COMMAND 0 0 0 FIFO Kthread - Ready 0000000000000000 0003056 Idle_Task 1 0 224 RR Kthread - Waiting Semaphore 0000000000000000 0001976 hpwork 0x3fc8bd50 0x3fc8bd80 2 2 100 RR Task - Waiting Semaphore 0000000000000000 0004048 nsh_main 3 3 100 RR Task - Ready 0000000000000000 0001992 fastbootd 4 4 100 RR Task - Running 0000000000000000 0001992 popen -c ps OKAY [ 0.010s] Finished. Total time: 0.010s Signed-off-by: wangjianyu3 <[email protected]>

JianyuWang0623 · 2025-02-24T14:59:51Z

please add commit message fb4c03f

@jerpelea done, thank you.

+Add support for producing output according to a format like printf().

github-actions bot added Area: System Size: S labels Feb 20, 2025

Donny9 reviewed Feb 20, 2025

View reviewed changes

system/fastboot/fastboot.c Outdated Show resolved Hide resolved

system/fastboot/fastboot.c Outdated Show resolved Hide resolved

system/fastboot/Kconfig Outdated Show resolved Hide resolved

xiaoxiang781216 reviewed Feb 20, 2025

View reviewed changes

system/fastboot/fastboot.c Outdated Show resolved Hide resolved

JianyuWang0623 force-pushed the br_wjy_system_fastboot_add_mkrd_250220 branch from a1c4364 to de83ff2 Compare February 20, 2025 08:11

JianyuWang0623 marked this pull request as draft February 20, 2025 16:49

JianyuWang0623 force-pushed the br_wjy_system_fastboot_add_mkrd_250220 branch from de83ff2 to f6b4a49 Compare February 21, 2025 03:22

JianyuWang0623 changed the title ~~system/fastboot: Add support for oem mkrd command~~ system/fastboot: Add support for fastboot oem sh Feb 21, 2025

JianyuWang0623 marked this pull request as ready for review February 21, 2025 03:24

JianyuWang0623 force-pushed the br_wjy_system_fastboot_add_mkrd_250220 branch from f6b4a49 to 0983ecc Compare February 21, 2025 03:31

JianyuWang0623 mentioned this pull request Feb 21, 2025

[FEATURE] Should we extend fastboot oem to support executing custom commands? #2991

Closed

1 task

xiaoxiang781216 reviewed Feb 21, 2025

View reviewed changes

system/fastboot/fastboot.c Outdated Show resolved Hide resolved

xiaoxiang781216 reviewed Feb 21, 2025

View reviewed changes

system/fastboot/fastboot.c Outdated Show resolved Hide resolved

JianyuWang0623 force-pushed the br_wjy_system_fastboot_add_mkrd_250220 branch from 0983ecc to cd5496f Compare February 21, 2025 04:06

JianyuWang0623 marked this pull request as draft February 21, 2025 04:44

JianyuWang0623 force-pushed the br_wjy_system_fastboot_add_mkrd_250220 branch from cd5496f to 76c6600 Compare February 21, 2025 05:56

JianyuWang0623 marked this pull request as ready for review February 21, 2025 05:57

JianyuWang0623 force-pushed the br_wjy_system_fastboot_add_mkrd_250220 branch 5 times, most recently from 265abb1 to 5b4a07f Compare February 21, 2025 23:52

JianyuWang0623 changed the title ~~system/fastboot: Add support for fastboot oem sh~~ system/fastboot: Add support for fastboot oem shell Feb 21, 2025

JianyuWang0623 force-pushed the br_wjy_system_fastboot_add_mkrd_250220 branch from 5b4a07f to 9727fa3 Compare February 23, 2025 13:44

JianyuWang0623 requested review from Donny9 and xiaoxiang781216 February 24, 2025 01:51

JianyuWang0623 mentioned this pull request Feb 24, 2025

esp32s3-devkit/fastboot: Enable fastboot oem shell apache/nuttx#15898

Open

xiaoxiang781216 approved these changes Feb 24, 2025

View reviewed changes

xiaoxiang781216 linked an issue Feb 24, 2025 that may be closed by this pull request

[FEATURE] Should we extend fastboot oem to support executing custom commands? #2991

Closed

1 task

cederom approved these changes Feb 24, 2025

View reviewed changes

jerpelea requested changes Feb 24, 2025

View reviewed changes

JianyuWang0623 added 2 commits February 24, 2025 22:57

system/fastboot: Add format string support for fastboot_fail()

13e2887

Add support for producing output according to a format like printf(). Signed-off-by: wangjianyu3 <[email protected]>

JianyuWang0623 force-pushed the br_wjy_system_fastboot_add_mkrd_250220 branch from 9727fa3 to 0ce5909 Compare February 24, 2025 14:58

JianyuWang0623 requested a review from jerpelea February 24, 2025 15:00

jerpelea approved these changes Feb 24, 2025

View reviewed changes

jerpelea merged commit 536e2cc into apache:master Feb 25, 2025
37 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

system/fastboot: Add support for fastboot oem shell #3003

system/fastboot: Add support for fastboot oem shell #3003

JianyuWang0623 commented Feb 20, 2025 •

edited

Loading

JianyuWang0623 commented Feb 20, 2025

JianyuWang0623 commented Feb 21, 2025 •

edited

Loading

xiaoxiang781216 left a comment

cederom left a comment

jerpelea left a comment

JianyuWang0623 commented Feb 24, 2025

system/fastboot: Add support for fastboot oem shell #3003

system/fastboot: Add support for fastboot oem shell #3003

Conversation

JianyuWang0623 commented Feb 20, 2025 • edited Loading

Summary

Impact

Testing

JianyuWang0623 commented Feb 20, 2025

JianyuWang0623 commented Feb 21, 2025 • edited Loading

xiaoxiang781216 left a comment

Choose a reason for hiding this comment

cederom left a comment

Choose a reason for hiding this comment

jerpelea left a comment

Choose a reason for hiding this comment

JianyuWang0623 commented Feb 24, 2025

JianyuWang0623 commented Feb 20, 2025 •

edited

Loading

JianyuWang0623 commented Feb 21, 2025 •

edited

Loading