Implement fastboot multiresponce
Subsystems (3)
v4 cover Implement fastboot multiresponce
Currently u-boot fastboot can only send one message back to host, so if there is a need to print more than one line messages must be kept sending until all the required data is obtained. This behavior can be adjusted using multiresponce ability (getting multiple lines of response) proposed in this patch set.
Implementation of multiresponce leads to ability to dump content of console buffer which, with use of "oem run", allows to entirely avoid need in UART.
---
Changes from v3:
- adjust membuff_readline behavior with overflow
Changes from v2:
- fix missing function calls if CONFIG_CONSOLE_RECORD is not enabled
Changes from v1:
- changed variables to static
- fixed multiresponce for udp
- documented use of "MORE"
- converted #if to if (...)
---
Ion Agorria (5):
fastboot: multiresponse support
fastboot: implement "getvar all"
common: console: introduce overflow and isempty calls
lib: membuff: fix readline not returning line in case of overflow
fastboot: add oem console command support
common/console.c | 15 ++++-- doc/android/fastboot-protocol.rst | 3 ++ doc/android/fastboot.rst | 1 + drivers/fastboot/Kconfig | 7 +++ drivers/fastboot/fb_command.c | 52 +++++++++++++++++++++ drivers/fastboot/fb_getvar.c | 77 +++++++++++++++++++++++++------ drivers/usb/gadget/f_fastboot.c | 29 ++++++++++++ include/console.h | 26 +++++++++++ include/fastboot-internal.h | 7 +++ include/fastboot.h | 19 ++++++++ lib/membuff.c | 10 ---- net/fastboot_udp.c | 29 +++++++++--- test/ut.c | 9 ++-- 13 files changed, 247 insertions(+), 37 deletions(-)
Signature · 1 line
2.40.1
PATCH v4 1/5 fastboot: multiresponse support
From: Ion Agorria <[email protected]>
Currently u-boot fastboot can only send one message back to host, so if there is a need to print more than one line messages must be kept sending until all the required data is obtained. This behavior can be adjusted using multiresponce ability (getting multiple lines of response) proposed in this patch.
--- drivers/fastboot/fb_command.c | 10 ++++++++++ drivers/usb/gadget/f_fastboot.c | 29 +++++++++++++++++++++++++++++ include/fastboot.h | 18 ++++++++++++++++++ net/fastboot_udp.c | 29 +++++++++++++++++++++++------ 4 files changed, 80 insertions(+), 6 deletions(-)
drivers/fastboot/fb_command.c +10 -0
@@ -5,6 +5,7 @@#include <common.h> #include <command.h> +#include <console.h> #include <env.h> #include <fastboot.h> #include <fastboot-internal.h>
@@ -152,6 +153,15 @@ int fastboot_handle_command(char *cmd_string, char *response)return -1 ; } +void fastboot_multiresponse (int cmd,char *response) +{ +switch (cmd) { +default : +fastboot_fail ("Unknown multiresponse command" , response); +break ; + } +} +/** * okay() - Send bare OKAY response *
drivers/usb/gadget/f_fastboot.c +29 -0
@@ -497,6 +497,25 @@ static void do_bootm_on_complete(struct usb_ep *ep, struct usb_request *req)do_exit_on_complete (ep, req); } +static int multiresponse_cmd =-1 ; +static void multiresponse_on_complete (struct usb_ep *ep,struct usb_request *req) +{ +char response[FASTBOOT_RESPONSE_LEN ] = {0 }; + +if (multiresponse_cmd ==-1 ) +return ; + +/* Call handler to obtain next response */ +fastboot_multiresponse (multiresponse_cmd, response); +fastboot_tx_write_str (response); + +/* If response is final OKAY/FAIL response disconnect this handler and unset cmd */ +if (!strncmp ("OKAY" , response,4 ) || !strncmp ("FAIL" , response,4 )) { + multiresponse_cmd =-1 ; + fastboot_func->in_req->complete = fastboot_complete; + } +} +static void do_acmd_complete (struct usb_ep *ep,struct usb_request *req) {/* When usb dequeue complete will be called
@@ -524,6 +543,16 @@ static void rx_handler_command(struct usb_ep *ep, struct usb_request *req)fastboot_fail ("buffer overflow" , response); } +if (!strncmp (FASTBOOT_MULTIRESPONSE_START , response,4 )) { + multiresponse_cmd = cmd; +fastboot_multiresponse (multiresponse_cmd, response); + +/* Only add complete callback if first is not a final OKAY/FAIL response */ +if (strncmp ("OKAY" , response,4 ) &&strncmp ("FAIL" , response,4 )) { + fastboot_func->in_req->complete = multiresponse_on_complete; + } + } +if (!strncmp ("DATA" , response,4 )) { req->complete = rx_handler_dl_image; req->length =rx_bytes_expected (ep);
include/fastboot.h +18 -0
@@ -14,6 +14,16 @@#define FASTBOOT_VERSION "0.4" +/* +* Signals u-boot fastboot code to send multiple responses by +* calling response generating function repeatedly until a OKAY/FAIL +* is generated as final response. +* +* This status code is only used internally to signal, must NOT +* be sent to host. +*/ +#define FASTBOOT_MULTIRESPONSE_START ("MORE") +/* The 64 defined bytes plus \0 */ #define FASTBOOT_COMMAND_LEN (64 + 1)#define FASTBOOT_RESPONSE_LEN (64 + 1)
@@ -172,5 +182,13 @@ void fastboot_data_download(const void *fastboot_data,*/ void fastboot_data_complete (char *response); +/** +* fastboot_handle_multiresponse() - Called for each response to send +* +* @cmd: Command id that requested multiresponse +* @response: Pointer to fastboot response buffer +*/ +void fastboot_multiresponse (int cmd,char *response); +void fastboot_acmd_complete (void );#endif /* _FASTBOOT_H_ */
net/fastboot_udp.c +23 -6
@@ -42,16 +42,15 @@ static int fastboot_remote_port;static int fastboot_our_port;/** -* fastboot_udp_send_info() - Send an INFO packet during long commands. +* fastboot_udp_send_response() - Send an response into UDP * -* @msg: String describing the reason for waiting +* @response: Response to send */ -static void fastboot_udp_send_info (const char *msg) +static void fastboot_udp_send_response (const char *response) {uchar *packet;uchar *packet_base;int len =0 ; -char response[FASTBOOT_RESPONSE_LEN ] = {0 };struct fastboot_header response_header = { .id =FASTBOOT_FASTBOOT ,
@@ -66,7 +65,6 @@ static void fastboot_udp_send_info(const char *msg)memcpy (packet, &response_header,sizeof (response_header)); packet +=sizeof (response_header);/* Write response */ -fastboot_response ("INFO" , response,"%s" , msg);memcpy (packet, response,strlen (response)); packet +=strlen (response);
@@ -91,6 +89,7 @@ static void fastboot_udp_send_info(const char *msg)static void fastboot_timed_send_info (const char *msg) {static ulong start; +char response[FASTBOOT_RESPONSE_LEN ] = {0 };/* Initialize timer */ if (start ==0 )
@@ -99,7 +98,8 @@ static void fastboot_timed_send_info(const char *msg)/* Send INFO packet to host every 30 seconds */ if (time >=30000 ) { start =get_timer (0 ); -fastboot_udp_send_info (msg); +fastboot_response ("INFO" , response,"%s" , msg); +fastboot_udp_send_response (response); } }
@@ -180,6 +180,23 @@ static void fastboot_send(struct fastboot_header header, char *fastboot_data, }else { cmd =fastboot_handle_command (command, response); pending_command = false; + +if (!strncmp (FASTBOOT_MULTIRESPONSE_START , response,4 )) { +while (1 ) { +/* Call handler to obtain next response */ +fastboot_multiresponse (cmd, response); + +/* +* Send more responses or break to send +* final OKAY/FAIL response +*/ +if (strncmp ("OKAY" , response,4 ) && +strncmp ("FAIL" , response,4 )) +fastboot_udp_send_response (response); +else +break ; + } + } }/* * Sent some INFO packets, need to update sequence number in
Signature · 1 line
2.40.1
PATCH v4 2/5 fastboot: implement "getvar all"
In reply to Svyatoslav RyhelFrom: Ion Agorria <[email protected]>
This commit implements "fastboot getvar all" listing by iterating the existing dispatchers that don't require parameters (as we pass NULL), uses fastboot multiresponse.
--- doc/android/fastboot-protocol.rst | 3 ++ drivers/fastboot/fb_command.c | 3 ++ drivers/fastboot/fb_getvar.c | 77 +++++++++++++++++++++++++------ include/fastboot-internal.h | 7 +++ 4 files changed, 77 insertions(+), 13 deletions(-)
doc/android/fastboot-protocol.rst +3 -0
@@ -173,6 +173,9 @@ The various currently defined names are:: bootloader requiring a signature before it will install or boot images. + all Provides all info from commands above as + they were called one by one + Names starting with a lowercase character are reserved by this specification. OEM-specific names should not start with lowercase characters.
drivers/fastboot/fb_command.c +3 -0
@@ -156,6 +156,9 @@ int fastboot_handle_command(char *cmd_string, char *response)void fastboot_multiresponse (int cmd,char *response) {switch (cmd) { +case FASTBOOT_COMMAND_GETVAR : +fastboot_getvar_all (response); +break ;default :fastboot_fail ("Unknown multiresponse command" , response);break ;
drivers/fastboot/fb_getvar.c +64 -13
129 lines not on this page · raw message
include/fastboot-internal.h +7 -0
@@ -18,6 +18,13 @@ extern u32 fastboot_buf_size;*/ extern void (*fastboot_progress_callback)(const char *msg); +/** +* fastboot_getvar_all() - Writes current variable being listed from "all" to response. +* +* @response: Pointer to fastboot response buffer +*/ +void fastboot_getvar_all (char *response); +/** * fastboot_getvar() - Writes variable indicated by cmd_parameter to response. *
Signature · 1 line
2.40.1
PATCH v4 3/5 common: console: introduce overflow and isempty calls
In reply to Svyatoslav RyhelFrom: Ion Agorria <[email protected]>
Separate record overflow logic and add console_record_isempty as available calls don't serve to know output has been read fully with readline's.
--- common/console.c | 15 ++++++++++++--- include/console.h | 26 ++++++++++++++++++++++++++ test/ut.c | 9 ++++----- 3 files changed, 42 insertions(+), 8 deletions(-)
common/console.c +12 -3
@@ -818,6 +818,8 @@ int console_record_init(void) ret =membuff_new ((struct membuff *)&gd->console_in,CONFIG_CONSOLE_RECORD_IN_SIZE ); + gd->flags |=GD_FLG_RECORD ; +return ret; }
@@ -836,11 +838,13 @@ int console_record_reset_enable(void)return 0 ; } -int console_record_readline (char *str,int maxlen) +bool console_record_overflow (void ) { -if (gd->flags &GD_FLG_RECORD_OVF ) -return -ENOSPC ; +return gd->flags &GD_FLG_RECORD_OVF ? true : false; +} +int console_record_readline (char *str,int maxlen) +{return membuff_readline ((struct membuff *)&gd->console_out, str, maxlen,'\0' ); }
@@ -850,6 +854,11 @@ int console_record_avail(void)return membuff_avail ((struct membuff *)&gd->console_out); } +bool console_record_isempty (void ) +{ +return membuff_isempty ((struct membuff *)&gd->console_out); +} +int console_in_puts (const char *str) {return membuff_put ((struct membuff *)&gd->console_in, str,strlen (str));
include/console.h +26 -0
@@ -64,6 +64,13 @@ void console_record_reset(void);*/ int console_record_reset_enable (void ); +/** +* console_record_overflow() - returns state of buffers overflow +* +* Return: true if the console buffer was overflowed +*/ +bool console_record_overflow (void ); +/** * console_record_readline() - Read a line from the console output *
@@ -84,6 +91,13 @@ int console_record_readline(char *str, int maxlen);*/ int console_record_avail (void ); +/** +* console_record_isempty() - Returns if console output is empty +* +* Return: true if empty +*/ +bool console_record_isempty (void ); +/** * console_in_puts() - Write a string to the console input buffer *
@@ -113,6 +127,12 @@ static inline int console_record_reset_enable(void)return -ENOSYS ; } +static inline bool console_record_overflow (void ) +{ +/* No overflow */ +return false; +} +static inline int console_record_readline (char *str,int maxlen) {/* Nothing to read */
@@ -131,6 +151,12 @@ static inline int console_in_puts(const char *str) return 0; } +static inline bool console_record_isempty (void ) +{ +/* Always empty */ +return true; +} +#endif /* !CONFIG_CONSOLE_RECORD */ /**
test/ut.c +4 -5
@@ -53,15 +53,14 @@ long ut_check_delta(ulong last)static int readline_check (struct unit_test_state *uts) { -int ret; - - ret =console_record_readline (uts->actual_str,sizeof (uts->actual_str)); -if (ret == -ENOSPC ) { +if (console_record_overflow ()) {ut_fail (uts, __FILE__, __LINE__, __func__,"Console record buffer too small - increase CONFIG_CONSOLE_RECORD_OUT_SIZE" ); -return ret; +return -ENOSPC ; } +console_record_readline (uts->actual_str,sizeof (uts->actual_str)); +return 0 ; }
Signature · 1 line
2.40.1
PATCH v4 4/5 lib: membuff: fix readline not returning line in case of overflow
In reply to Svyatoslav RyhelFrom: Ion Agorria <[email protected]>
If a line overflows readline's maxlen it won't advance the membuffer and will return 0 as read amount which isn't even documented. Fix by removing this behavior alltogether.
--- lib/membuff.c | 10 ---------- 1 file changed, 10 deletions(-)
lib/membuff.c +0 -10
@@ -292,15 +292,12 @@ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch) {int len;/* number of bytes read (!= string length) */ char *s, *end; -bool ok = false; -char *orig = str; end = mb->head >= mb->tail ? mb->head : mb->end;for (len =0 , s = mb->tail; s < end && len < maxlen -1 ; str++) { *str = *s++; len++;if (*str =='\n' || *str < minch) { - ok = true;break ; }if (s == end && mb->tail > mb->head) {
@@ -309,13 +306,6 @@ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch) } } -/* couldn't get the whole string */ -if (!ok) { -if (maxlen) - *orig ='\0' ; -return 0 ; - } -/* terminate the string, update the membuff and return success */ *str ='\0' ; mb->tail = s == mb->end ? mb->start : s;
Signature · 1 line
2.40.1
Re: [PATCH v4 4/5] lib: membuff: fix readline not returning line in case of overflow
Hello Simon!
This is the latest iteration of commit, one you have checked is already outdated.
Sorry for misunderstanding.
Best regards,
Svyatoslav R.
чт, 23 лист. 2023 р. о 13:02 Svyatoslav Ryhel <[email protected]> пише:
Quoted 51 lines
From: Ion Agorria <[email protected]>
If a line overflows readline's maxlen it won't advance the membuffer and will return 0 as read amount which isn't even documented. Fix by removing this behavior alltogether.
Signed-off-by Ion Agorria <[email protected]>Signed-off-by Svyatoslav Ryhel <[email protected]>Reviewed-by Mattijs Korpershoek <[email protected]>--- lib/membuff.c | 10 ---------- 1 file changed, 10 deletions(-)lib/membuff.c +0
-11@@ -292,15 +292,12 @@ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch) {int len;/* number of bytes read (!= string length) */ char *s, *end; -bool ok = false; -char *orig = str; end = mb->head >= mb->tail ? mb->head : mb->end;for (len =0 , s = mb->tail; s < end && len < maxlen -1 ; str++) { *str = *s++; len++;if (*str =='\n' || *str < minch) { - ok = true;break ; }if (s == end && mb->tail > mb->head) {@@ -309,13 +306,6 @@ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch) } } -/* couldn't get the whole string */ -if (!ok) { -if (maxlen) - *orig ='\0' ; -return 0 ; - } -/* terminate the string, update the membuff and return success */ *str ='\0' ; mb->tail = s == mb->end ? mb->start : s; --2.40.1
Re: [PATCH v4 4/5] lib: membuff: fix readline not returning line in case of overflow
In reply to Svyatoslav RyhelHi Svyatoslav,
Quoted 6 lines · Svyatoslav Ryhel
From: Ion Agorria <[email protected]>
If a line overflows readline's maxlen it won't advance the membuffer and will return 0 as read amount which isn't even documented. Fix by removing this behavior alltogether.
spelling
But then how does one know the whole line has been read?
I don't think this is a good idea. We need to return some sort of error condition.
I suggest either:
1. Add a new function which reads a line up to maxlen and discards anything after that
2. returning -1 in the case that the line was too long, then having the caller call a new membuff_skipline() function to skip it (which supports any length)
Quoted 45 lines
Signed-off-by Ion Agorria <[email protected]>Signed-off-by Svyatoslav Ryhel <[email protected]>Reviewed-by Mattijs Korpershoek <[email protected]>--- lib/membuff.c | 10 ---------- 1 file changed, 10 deletions(-)lib/membuff.c +0
-11@@ -292,15 +292,12 @@ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch) {int len;/* number of bytes read (!= string length) */ char *s, *end; -bool ok = false; -char *orig = str; end = mb->head >= mb->tail ? mb->head : mb->end;for (len =0 , s = mb->tail; s < end && len < maxlen -1 ; str++) { *str = *s++; len++;if (*str =='\n' || *str < minch) { - ok = true;break ; }if (s == end && mb->tail > mb->head) {@@ -309,13 +306,6 @@ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch) } } -/* couldn't get the whole string */ -if (!ok) { -if (maxlen) - *orig ='\0' ; -return 0 ; - } -/* terminate the string, update the membuff and return success */ *str ='\0' ; mb->tail = s == mb->end ? mb->start : s; --2.40.1
PATCH v4 5/5 fastboot: add oem console command support
In reply to Svyatoslav RyhelFrom: Ion Agorria <[email protected]>
"oem console" serves to read console record buffer.
--- doc/android/fastboot.rst | 1 + drivers/fastboot/Kconfig | 7 +++++++ drivers/fastboot/fb_command.c | 39 +++++++++++++++++++++++++++++++++++ include/fastboot.h | 1 + 4 files changed, 48 insertions(+)
doc/android/fastboot.rst +1 -0
@@ -29,6 +29,7 @@ The following OEM commands are supported (if enabled): with <arg> = boot_ack boot_partition - ``oem bootbus`` - this executes ``mmc bootbus %x %s`` to configure eMMC - ``oem run`` - this executes an arbitrary U-Boot command +- ``oem console`` - this dumps U-Boot console record buffer Support for both eMMC and NAND devices is included.
drivers/fastboot/Kconfig +7 -0
@@ -241,6 +241,13 @@ config FASTBOOT_OEM_RUN this feature if you are using verified boot, as it will allow an attacker to bypass any restrictions you have in place. +config FASTBOOT_CMD_OEM_CONSOLE + bool "Enable the 'oem console' command" + depends on CONSOLE_RECORD + help + Add support for the "oem console" command to input and read console + record buffer. + endif # FASTBOOT endmenu
drivers/fastboot/fb_command.c +39 -0
@@ -41,6 +41,7 @@ static void reboot_recovery(char *, char *);static void oem_format (char *,char *);static void oem_partconf (char *,char *);static void oem_bootbus (char *,char *); +static void oem_console (char *,char *);static void run_ucmd (char *,char *);static void run_acmd (char *,char *);
@@ -108,6 +109,10 @@ static const struct { .command = "oem run", .dispatch =CONFIG_IS_ENABLED (FASTBOOT_OEM_RUN , (run_ucmd), (NULL )) }, + [FASTBOOT_COMMAND_OEM_CONSOLE] = { + .command = "oem console", + .dispatch =CONFIG_IS_ENABLED (FASTBOOT_CMD_OEM_CONSOLE , (oem_console), (NULL )) + }, [FASTBOOT_COMMAND_UCMD] = { .command ="UCmd" , .dispatch = CONFIG_IS_ENABLED(FASTBOOT_UUU_SUPPORT, (run_ucmd), (NULL))
@@ -159,6 +164,23 @@ void fastboot_multiresponse(int cmd, char *response)case FASTBOOT_COMMAND_GETVAR :fastboot_getvar_all (response);break ; +case FASTBOOT_COMMAND_OEM_CONSOLE : +if (CONFIG_IS_ENABLED (FASTBOOT_CMD_OEM_CONSOLE )) { +char buf[FASTBOOT_RESPONSE_LEN ] = {0 }; + +if (console_record_isempty ()) { +console_record_reset (); +fastboot_okay (NULL , response); + }else { +int ret =console_record_readline (buf,sizeof (buf) -5 ); + +if (ret <0 ) +fastboot_fail ("Error reading console" , response); +else +fastboot_response ("INFO" , response,"%s" , buf); + } +break ; + }default :fastboot_fail ("Unknown multiresponse command" , response);break ;
@@ -503,3 +525,20 @@ static void __maybe_unused oem_bootbus(char *cmd_parameter, char *response)else fastboot_okay (NULL , response); } + +/** +* oem_console() - Execute the OEM console command +* +* @cmd_parameter: Pointer to command parameter +* @response: Pointer to fastboot response buffer +*/ +static void __maybe_unused oem_console (char *cmd_parameter,char *response) +{ +if (cmd_parameter) +console_in_puts (cmd_parameter); + +if (console_record_isempty ()) +fastboot_fail ("Empty console" , response); +else +fastboot_response (FASTBOOT_MULTIRESPONSE_START , response,NULL ); +}
include/fastboot.h +1 -0
@@ -47,6 +47,7 @@ enum {FASTBOOT_COMMAND_OEM_PARTCONF ,FASTBOOT_COMMAND_OEM_BOOTBUS ,FASTBOOT_COMMAND_OEM_RUN , +FASTBOOT_COMMAND_OEM_CONSOLE ,FASTBOOT_COMMAND_ACMD ,FASTBOOT_COMMAND_UCMD ,FASTBOOT_COMMAND_COUNT
Signature · 1 line
2.40.1