Skip to contentSkip to conversation

net: support being a TCP server to unblock TCP fastboot

PATCH In review Dmitrii Merkurev 3 participants 5 messages Apr 13, 2023 – May 6, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/3 net: support being a TCP server to unblock TCP fastboot

Make following changes to unblock TCP fastboot support:

1. Implement being a TCP server support
2. Introduce dedicated TCP traffic handler (get rid of UDP signature)
3. Ensure seq_num and ack_num are respected in net_send_tcp_packet function (make sure existing wget_cmd code is reflected with the fix)

Cc Ying-Chun Liu (PaulLiu) <[email protected]>
Cc Simon Glass <[email protected]>

Сс: Joe Hershberger <[email protected]>
Сс: Ramon Fried <[email protected]>

---
 include/net/tcp.h |  16 +++++--
 net/tcp.c         | 115 +++++++++++++++++++++++-----------------------
 net/wget.c        |  43 ++++++++---------
 3 files changed, 90 insertions(+), 84 deletions(-)
include/net/tcp.h +11 -5
index 322551694f..c29d4ce24a 100644
@@ -259,6 +259,7 @@ union tcp_build_pkt {
  * enum tcp_state - TCP State machine states for connection
  * @TCP_CLOSED: Need to send SYN to connect
  * @TCP_SYN_SENT: Trying to connect, waiting for SYN ACK
+ * @TCP_SYN_RECEIVED: Initial SYN received, waiting for ACK
  * @TCP_ESTABLISHED: both server & client have a connection
  * @TCP_CLOSE_WAIT: Rec FIN, passed to app for FIN, ACK rsp
  * @TCP_CLOSING: Rec FIN, sent FIN, ACK waiting for ACK
@@ -268,6 +269,7 @@ union tcp_build_pkt {
 enum tcp_state {
 	TCP_CLOSED,
 	TCP_SYN_SENT,
+	TCP_SYN_RECEIVED,
 	TCP_ESTABLISHED,
 	TCP_CLOSE_WAIT,
 	TCP_CLOSING,
@@ -283,14 +285,18 @@ int tcp_set_tcp_header(uchar *pkt, int dport, int sport, int payload_len,
 /**
  * rxhand_tcp() - An incoming packet handler.
  * @pkt: pointer to the application packet
- * @dport: destination UDP port
+ * @dport: destination TCP port
  * @sip: source IP address
- * @sport: source UDP port
+ * @sport: source TCP port
+ * @tcp_seq_num: TCP sequential number
+ * @tcp_ack_num: TCP acknowledgment number
+ * @action: TCP action (SYN, ACK, FIN, etc)
  * @len: packet length
  */
-typedef void rxhand_tcp(uchar *pkt, unsigned int dport,
-			struct in_addr sip, unsigned int sport,
-			unsigned int len);
+typedef void rxhand_tcp(uchar *pkt, u16 dport,
+			struct in_addr sip, u16 sport,
+			u32 tcp_seq_num, u32 tcp_ack_num,
+			u8 action, unsigned int len);
 void tcp_set_tcp_handler(rxhand_tcp *f);
 
 void rxhand_tcp_f(union tcp_build_pkt *b, unsigned int len);
net/tcp.c +57 -58

248 lines not on this page · raw message

net/wget.c +22 -21

97 lines not on this page · raw message

Signature · 1 line
2.40.0.634.g4ca3ef3211-goog
#1 lore raw

PATCH v2 2/3 net: add fastboot TCP support

Known limitations are
1. fastboot reboot doesn't work (answering OK but not rebooting)
2. flashing isn't supported (TCP transport only limitation)

The command syntax is
fastboot tcp

Cc Ying-Chun Liu (PaulLiu) <[email protected]>
Cc Simon Glass <[email protected]>

Сс: Joe Hershberger <[email protected]>
Сс: Ramon Fried <[email protected]>

---
 MAINTAINERS                        |   6 +-
 cmd/fastboot.c                     |  25 ++++-
 drivers/fastboot/Kconfig           |  14 +++
 drivers/fastboot/fb_common.c       |   1 -
 include/net.h                      |   3 +-
 include/net/fastboot.h             |  21 -----
 include/net/fastboot_tcp.h         |  14 +++
 include/net/fastboot_udp.h         |  14 +++
 net/Makefile                       |   3 +-
 net/fastboot_tcp.c                 | 143 +++++++++++++++++++++++++++++
 net/{fastboot.c => fastboot_udp.c} |   4 +-
 net/net.c                          |  17 +++-
 12 files changed, 230 insertions(+), 35 deletions(-)
 delete mode 100644 include/net/fastboot.h
 create mode 100644 include/net/fastboot_tcp.h
 create mode 100644 include/net/fastboot_udp.h
 create mode 100644 net/fastboot_tcp.c
 rename net/{fastboot.c => fastboot_udp.c} (99%)
MAINTAINERS +4 -2
index 4c17c6cb9f..e28d1f7ae0 100644
@@ -987,10 +987,12 @@ F:	cmd/fastboot.c
 F:	doc/android/fastboot*.rst
 F:	include/fastboot.h
 F:	include/fastboot-internal.h
-F:	include/net/fastboot.h
+F:	include/net/fastboot_tcp.h
+F:	include/net/fastboot_udp.h
 F:	drivers/fastboot/
 F:	drivers/usb/gadget/f_fastboot.c
-F:	net/fastboot.c
+F:	net/fastboot_tcp.c
+F:	net/fastboot_udp.c
 F:	test/dm/fastboot.c
 
 FPGA
cmd/fastboot.c +23 -2
index 97dc02ce74..3d5ff951eb 100644
@@ -26,7 +26,7 @@ static int do_fastboot_udp(int argc, char *const argv[],
 		return CMD_RET_FAILURE;
 	}
 
-	err = net_loop(FASTBOOT);
+	err = net_loop(FASTBOOT_UDP);
 
 	if (err < 0) {
 		printf("fastboot udp error: %d\n", err);
@@ -36,6 +36,26 @@ static int do_fastboot_udp(int argc, char *const argv[],
 	return CMD_RET_SUCCESS;
 }
 
+static int do_fastboot_tcp(int argc, char *const argv[],
+			   uintptr_t buf_addr, size_t buf_size)
+{
+	int err;
+
+	if (!IS_ENABLED(CONFIG_TCP_FUNCTION_FASTBOOT)) {
+		pr_err("Fastboot TCP not enabled\n");
+		return CMD_RET_FAILURE;
+	}
+
+	err = net_loop(FASTBOOT_TCP);
+
+	if (err < 0) {
+		printf("fastboot tcp error: %d\n", err);
+		return CMD_RET_FAILURE;
+	}
+
+	return CMD_RET_SUCCESS;
+}
+
 static int do_fastboot_usb(int argc, char *const argv[],
 			   uintptr_t buf_addr, size_t buf_size)
 {
@@ -141,7 +161,8 @@ NXTARG:
 
 	if (!strcmp(argv[1], "udp"))
 		return do_fastboot_udp(argc, argv, buf_addr, buf_size);
-
+	if (!strcmp(argv[1], "tcp"))
+		return do_fastboot_tcp(argc, argv, buf_addr, buf_size);
 	if (!strcmp(argv[1], "usb")) {
 		argv++;
 		argc--;
drivers/fastboot/Kconfig +14 -0
index eefa34779c..a3df9aa3d0 100644
@@ -4,6 +4,13 @@ config FASTBOOT
 	bool
 	imply ANDROID_BOOT_IMAGE
 	imply CMD_FASTBOOT
+	help
+	  Fastboot is a protocol used in Android devices for
+	  communicating between the device and a computer during
+	  the bootloader stage. It allows the user to flash the
+	  device firmware and unlock the bootloader.
+	  More information about the protocol and usecases:
+	  https://android.googlesource.com/platform/system/core/+/refs/heads/master/fastboot/
 
 config USB_FUNCTION_FASTBOOT
 	bool "Enable USB fastboot gadget"
@@ -28,6 +35,13 @@ config UDP_FUNCTION_FASTBOOT_PORT
 	help
 	  The fastboot protocol requires a UDP port number.
 
+config TCP_FUNCTION_FASTBOOT
+	depends on NET
+	select FASTBOOT
+	bool "Enable fastboot protocol over TCP"
+	help
+	  This enables the fastboot protocol over TCP.
+
 if FASTBOOT
 
 config FASTBOOT_BUF_ADDR
drivers/fastboot/fb_common.c +0 -1
index 57b6182c46..dde3cda78f 100644
@@ -15,7 +15,6 @@
 #include <command.h>
 #include <env.h>
 #include <fastboot.h>
-#include <net/fastboot.h>
 
 /**
  * fastboot_buf_addr - base address of the fastboot download buffer
include/net.h +2 -1
index 399af5e064..63daab3731 100644
@@ -505,7 +505,8 @@ extern int		net_restart_wrap;	/* Tried all network devices */
 
 enum proto_t {
 	BOOTP, RARP, ARP, TFTPGET, DHCP, PING, PING6, DNS, NFS, CDP, NETCONS,
-	SNTP, TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT, WOL, UDP, NCSI, WGET
+	SNTP, TFTPSRV, TFTPPUT, LINKLOCAL, FASTBOOT_UDP, FASTBOOT_TCP, WOL,
+	UDP, NCSI, WGET
 };
 
 extern char	net_boot_file_name[1024];/* Boot File name */
include/net/fastboot.h deleted +0 -21
deleted file mode 100644
index 68602095d2..0000000000
@@ -1,21 +0,0 @@
-/* SPDX-License-Identifier: BSD-2-Clause
- *
- * Copyright (C) 2016 The Android Open Source Project
- */
-
-#ifndef __NET_FASTBOOT_H__
-#define __NET_FASTBOOT_H__
-
-/**********************************************************************/
-/*
- *	Global functions and variables.
- */
-
-/**
- * Wait for incoming fastboot comands.
- */
-void fastboot_start_server(void);
-
-/**********************************************************************/
-
-#endif /* __NET_FASTBOOT_H__ */
include/net/fastboot_tcp.h new file +14 -0
new file mode 100644
index 0000000000..6cf29d52e9
@@ -0,0 +1,14 @@
+/* SPDX-License-Identifier: BSD-2-Clause
+ *
+ * Copyright (C) 2023 The Android Open Source Project
+ */
+
+#ifndef __NET_FASTBOOT_TCP_H__
+#define __NET_FASTBOOT_TCP_H__
+
+/**
+ * Wait for incoming tcp fastboot comands.
+ */
+void fastboot_tcp_start_server(void);
+
+#endif /* __NET_FASTBOOT_TCP_H__ */
include/net/fastboot_udp.h new file +14 -0
new file mode 100644
index 0000000000..d4382c0a0e
@@ -0,0 +1,14 @@
+/* SPDX-License-Identifier: BSD-2-Clause
+ *
+ * Copyright (C) 2016 The Android Open Source Project
+ */
+
+#ifndef __NET_FASTBOOT_H__
+#define __NET_FASTBOOT_H__
+
+/**
+ * Wait for incoming UDP fastboot comands.
+ */
+void fastboot_udp_start_server(void);
+
+#endif /* __NET_FASTBOOT_H__ */
net/Makefile +2 -1
index bea000b206..67fc77257d 100644
@@ -26,7 +26,8 @@ obj-$(CONFIG_CMD_PCAP) += pcap.o
 obj-$(CONFIG_CMD_RARP) += rarp.o
 obj-$(CONFIG_CMD_SNTP) += sntp.o
 obj-$(CONFIG_CMD_TFTPBOOT) += tftp.o
-obj-$(CONFIG_UDP_FUNCTION_FASTBOOT)  += fastboot.o
+obj-$(CONFIG_UDP_FUNCTION_FASTBOOT)  += fastboot_udp.o
+obj-$(CONFIG_TCP_FUNCTION_FASTBOOT)  += fastboot_tcp.o
 obj-$(CONFIG_CMD_WOL)  += wol.o
 obj-$(CONFIG_PROT_UDP) += udp.o
 obj-$(CONFIG_PROT_TCP) += tcp.o
net/fastboot_tcp.c new file +143 -0

143 lines not on this page · raw message

net/fastboot_udp.c renamed from net/fastboot.c +2 -2
similarity index 99%
rename from net/fastboot.c
rename to net/fastboot_udp.c
index e9569d88d2..27e779d8e0 100644
@@ -7,7 +7,7 @@
 #include <command.h>
 #include <fastboot.h>
 #include <net.h>
-#include <net/fastboot.h>
+#include <net/fastboot_udp.h>
 
 enum {
 	FASTBOOT_ERROR = 0,
@@ -300,7 +300,7 @@ static void fastboot_handler(uchar *packet, unsigned int dport,
 	}
 }
 
-void fastboot_start_server(void)
+void fastboot_udp_start_server(void)
 {
 	printf("Using %s device\n", eth_get_name());
 	printf("Listening for fastboot command on %pI4\n", &net_ip);
net/net.c +12 -5
index c9a749f6cc..41c3cac26e 100644
@@ -93,7 +93,8 @@
 #include <net.h>
 #include <net6.h>
 #include <ndisc.h>
-#include <net/fastboot.h>
+#include <net/fastboot_udp.h>
+#include <net/fastboot_tcp.h>
 #include <net/tftp.h>
 #include <net/ncsi.h>
 #if defined(CONFIG_CMD_PCAP)
@@ -498,9 +499,14 @@ restart:
 			tftp_start_server();
 			break;
 #endif
-#ifdef CONFIG_UDP_FUNCTION_FASTBOOT
-		case FASTBOOT:
-			fastboot_start_server();
+#if defined(CONFIG_UDP_FUNCTION_FASTBOOT)
+		case FASTBOOT_UDP:
+			fastboot_udp_start_server();
+			break;
+#endif
+#if defined(CONFIG_TCP_FUNCTION_FASTBOOT)
+		case FASTBOOT_TCP:
+			fastboot_tcp_start_server();
 			break;
 #endif
 #if defined(CONFIG_CMD_DHCP)
@@ -1491,7 +1497,8 @@ common:
 		/* Fall through */
 
 	case NETCONS:
-	case FASTBOOT:
+	case FASTBOOT_UDP:
+	case FASTBOOT_TCP:
 	case TFTPSRV:
 		if (IS_ENABLED(CONFIG_IPV6) && use_ip6) {
 			if (!memcmp(&net_link_local_ip6, &net_null_addr_ip6,
Signature · 1 line
2.40.0.634.g4ca3ef3211-goog
#2 lore raw

PATCH v2 3/3 net: share fastboot boot handle logic between transports

In reply to Dmitrii Merkurev

Introduce reboot, boot and continue commands support to TCP fastboot by moving existing UDP logic into the common module.

Cc Ying-Chun Liu (PaulLiu) <[email protected]>
Cc Simon Glass <[email protected]>

Сс: Joe Hershberger <[email protected]> Сс: Ramon Fried <[email protected]>

---
 drivers/fastboot/fb_common.c | 32 ++++++++++++++++++++++++++++++++
 include/fastboot.h           |  9 +++++++++
 net/fastboot_tcp.c           |  5 ++++-
 net/fastboot_udp.c           | 29 +----------------------------
 4 files changed, 46 insertions(+), 29 deletions(-)
drivers/fastboot/fb_common.c +32 -0
index dde3cda78f..621146bc6b 100644
@@ -15,6 +15,7 @@
 #include <command.h>
 #include <env.h>
 #include <fastboot.h>
+#include <net.h>
 
 /**
  * fastboot_buf_addr - base address of the fastboot download buffer
@@ -155,6 +156,37 @@ void fastboot_boot(void)
 	}
 }
 
+/**
+ * fastboot_handle_boot() - Shared implementation of system reaction to
+ * fastboot commands
+ *
+ * Making desceisions about device boot state (stay in fastboot, reboot
+ * to bootloader, reboot to OS, etc).
+ */
+void fastboot_handle_boot(int command, bool success)
+{
+	if (!success)
+		return;
+
+	switch (command) {
+	case FASTBOOT_COMMAND_BOOT:
+		fastboot_boot();
+		net_set_state(NETLOOP_SUCCESS);
+		break;
+
+	case FASTBOOT_COMMAND_CONTINUE:
+		net_set_state(NETLOOP_SUCCESS);
+		break;
+
+	case FASTBOOT_COMMAND_REBOOT:
+	case FASTBOOT_COMMAND_REBOOT_BOOTLOADER:
+	case FASTBOOT_COMMAND_REBOOT_FASTBOOTD:
+	case FASTBOOT_COMMAND_REBOOT_RECOVERY:
+		do_reset(NULL, 0, 0, NULL);
+		break;
+	}
+}
+
 /**
  * fastboot_set_progress_callback() - set progress callback
  *
include/fastboot.h +9 -0
index 07f4c8fa71..296451f89d 100644
@@ -123,6 +123,15 @@ void fastboot_init(void *buf_addr, u32 buf_size);
  */
 void fastboot_boot(void);
 
+/**
+ * fastboot_handle_boot() - Shared implementation of system reaction to
+ * fastboot commands
+ *
+ * Making desceisions about device boot state (stay in fastboot, reboot
+ * to bootloader, reboot to OS, etc).
+ */
+void fastboot_handle_boot(int command, bool success);
+
 /**
  * fastboot_handle_command() - Handle fastboot command
  *
net/fastboot_tcp.c +4 -1
index b5613b6aa2..2eb52ea256 100644
@@ -73,6 +73,7 @@ static void fastboot_tcp_handler_ipv4(uchar *pkt, u16 dport,
 				      u32 tcp_seq_num, u32 tcp_ack_num,
 				      u8 action, unsigned int len)
 {
+	int fastboot_command_id;
 	u64 command_size;
 	u8 tcp_fin = action & TCP_FIN;
 	u8 tcp_push = action & TCP_PUSH;
@@ -115,8 +116,10 @@ static void fastboot_tcp_handler_ipv4(uchar *pkt, u16 dport,
 				break;
 			}
 			strlcpy(command, pkt, len + 1);
-			fastboot_handle_command(command, response);
+			fastboot_command_id = fastboot_handle_command(command, response);
 			fastboot_tcp_send_message(response, strlen(response));
+			fastboot_handle_boot(fastboot_command_id,
+					     strncmp("OKAY", response, 4) == 0);
 		}
 		break;
 	case FASTBOOT_DISCONNECTING:
net/fastboot_udp.c +1 -28
index 27e779d8e0..389a5b45f5 100644
@@ -209,39 +209,12 @@ static void fastboot_send(struct fastboot_header header, char *fastboot_data,
 	net_send_udp_packet(net_server_ethaddr, fastboot_remote_ip,
 			    fastboot_remote_port, fastboot_our_port, len);
 
-	/* Continue boot process after sending response */
-	if (!strncmp("OKAY", response, 4)) {
-		switch (cmd) {
-		case FASTBOOT_COMMAND_BOOT:
-			boot_downloaded_image();
-			break;
-
-		case FASTBOOT_COMMAND_CONTINUE:
-			net_set_state(NETLOOP_SUCCESS);
-			break;
-
-		case FASTBOOT_COMMAND_REBOOT:
-		case FASTBOOT_COMMAND_REBOOT_BOOTLOADER:
-		case FASTBOOT_COMMAND_REBOOT_FASTBOOTD:
-		case FASTBOOT_COMMAND_REBOOT_RECOVERY:
-			do_reset(NULL, 0, 0, NULL);
-			break;
-		}
-	}
+	fastboot_handle_boot(cmd, strncmp("OKAY", response, 4) == 0);
 
 	if (!strncmp("OKAY", response, 4) || !strncmp("FAIL", response, 4))
 		cmd = -1;
 }
 
-/**
- * boot_downloaded_image() - Boots into downloaded image.
- */
-static void boot_downloaded_image(void)
-{
-	fastboot_boot();
-	net_set_state(NETLOOP_SUCCESS);
-}
-
 /**
  * fastboot_handler() - Incoming UDP packet handler.
  *
Signature · 1 line
2.40.0.634.g4ca3ef3211-goog
Reviewed-by on v2 3/3
#3 lore raw

Re: [PATCH v2 3/3] net: share fastboot boot handle logic between transports

Quoted 9 lines · Dmitrii Merkurev

Introduce reboot, boot and continue commands support to TCP fastboot by moving existing UDP logic into the common module.

Cc Ying-Chun Liu (PaulLiu) <[email protected]>
Cc Simon Glass <[email protected]>

Сс: Joe Hershberger <[email protected]> Сс: Ramon Fried <[email protected]>

Quoted 9 lines
---
 drivers/fastboot/fb_common.c | 32 ++++++++++++++++++++++++++++++++
 include/fastboot.h           |  9 +++++++++
 net/fastboot_tcp.c           |  5 ++++-
 net/fastboot_udp.c           | 29 +----------------------------
 4 files changed, 46 insertions(+), 29 deletions(-)
#4 lore raw
In reply to Dmitrii Merkurev
Quoted 7 lines · Dmitrii Merkurev

Make following changes to unblock TCP fastboot support:

1. Implement being a TCP server support
2. Introduce dedicated TCP traffic handler (get rid of UDP signature)
3. Ensure seq_num and ack_num are respected in net_send_tcp_packet function (make sure existing wget_cmd code is reflected with the fix)

Quoted 8 lines
Cc Ying-Chun Liu (PaulLiu) <[email protected]>
Cc Simon Glass <[email protected]>

Сс: Joe Hershberger <[email protected]>
Сс: Ramon Fried <[email protected]>

For the series, applied to u-boot/master, thanks!

Signature · 1 line
Tom