diff mbox series

[PATCHv7,05/15] net/lwip: implement tftp cmd

Message ID 20230822093614.4717-6-maxim.uvarov@linaro.org
State New
Headers show
Series net/lwip: add lwip library for the network stack | expand

Commit Message

Maxim Uvarov Aug. 22, 2023, 9:36 a.m. UTC
U-Boot recently got support for an alternative network stack using LWIP.
Replace tftp command with the LWIP variant while keeping the output and
error messages identical.

Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
---
 include/net/lwip.h             |  14 +++-
 net/lwip/Makefile              |   1 +
 net/lwip/apps/tftp/Makefile    |  16 +++++
 net/lwip/apps/tftp/lwip-tftp.c | 124 +++++++++++++++++++++++++++++++++
 4 files changed, 154 insertions(+), 1 deletion(-)
 create mode 100644 net/lwip/apps/tftp/Makefile
 create mode 100644 net/lwip/apps/tftp/lwip-tftp.c

Comments

Simon Glass Aug. 22, 2023, 6:56 p.m. UTC | #1
Hi Maxim,

On Tue, 22 Aug 2023 at 03:39, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:
>
> U-Boot recently got support for an alternative network stack using LWIP.
> Replace tftp command with the LWIP variant while keeping the output and
> error messages identical.
>
> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
> ---
>  include/net/lwip.h             |  14 +++-
>  net/lwip/Makefile              |   1 +
>  net/lwip/apps/tftp/Makefile    |  16 +++++
>  net/lwip/apps/tftp/lwip-tftp.c | 124 +++++++++++++++++++++++++++++++++
>  4 files changed, 154 insertions(+), 1 deletion(-)
>  create mode 100644 net/lwip/apps/tftp/Makefile
>  create mode 100644 net/lwip/apps/tftp/lwip-tftp.c
>
> diff --git a/include/net/lwip.h b/include/net/lwip.h
> index 240ebba354..14a65470ee 100644
> --- a/include/net/lwip.h
> +++ b/include/net/lwip.h
> @@ -28,4 +28,16 @@ int ulwip_dns(char *name, char *varname);
>   * Returns: 0 if success
>   *         Other value < 0, if error
>  */
> -int ulwip_dhcp(void);
> +
> +/**
> + * ulwip_tftp() - load file with tftp
> + *
> + * Load file with tftp to specific address
> + *
> + * @addr: Address to store downloaded file
> + * @filename: File name on remote tftp server to download
> + *
> + *
> + * Returns:  0 if success, !0 if error
> + */
> +int ulwip_tftp(ulong addr, const char *filename);

Does this load it, or initiate the load? When will this function return?

Please check your return values too. I believe they should all return
errno values, so -ve on error, rather than !0

> diff --git a/net/lwip/Makefile b/net/lwip/Makefile
> index 59323fb325..0337d82cf5 100644
> --- a/net/lwip/Makefile
> +++ b/net/lwip/Makefile
> @@ -67,3 +67,4 @@ obj-$(CONFIG_NET) += port/sys-arch.o
>
>  obj-$(CONFIG_CMD_DHCP) += apps/dhcp/lwip-dhcp.o
>  obj-$(CONFIG_CMD_DNS) += apps/dns/lwip-dns.o
> +obj-$(CONFIG_CMD_TFTPBOOT) += apps/tftp/

We should separate the CMD configs from the functionality, i.e. I
should be able to have CONFIG_TFTPBOOT but not CONFIG_CMD_TFTPBOOT.
For standard boot, we need to be able to boot without CONFIG_CMDLINE
enabled.

This merging of CMD and functionality CONFIG options has historically
been a problem in U-Boot, but it is mostly tidied up now.

> diff --git a/net/lwip/apps/tftp/Makefile b/net/lwip/apps/tftp/Makefile
> new file mode 100644
> index 0000000000..0e50fcad45
> --- /dev/null
> +++ b/net/lwip/apps/tftp/Makefile
> @@ -0,0 +1,16 @@
> +
> +ccflags-y += -I$(srctree)/net/lwip/port/include
> +ccflags-y += -I$(srctree)/net/lwip/lwip-external/src/include -I$(srctree)/net/lwip
> +ccflags-y += -I$(obj)

Should we move this to

> +
> +$(obj)/tftp.o: $(obj)/tftp.c
> +.PHONY: $(obj)/tftp.c
> +$(obj)/tftp.c:
> +       cp $(srctree)/net/lwip/lwip-external/src/apps/tftp/tftp.c $(obj)/tftp.c
> +       cp $(srctree)/net/lwip/lwip-external/src/include/lwip/apps/tftp_client.h $(obj)/tftp_client.h
> +       cp $(srctree)/net/lwip/lwip-external/src/include/lwip/apps/tftp_common.h $(obj)/tftp_common.h
> +       cp $(srctree)/net/lwip/lwip-external/contrib/examples/tftp/tftp_example.h $(obj)/tftp_example.h

What is going on here?

> +
> +obj-$(CONFIG_CMD_TFTPBOOT) += tftp.o
> +obj-$(CONFIG_CMD_TFTPBOOT) += lwip-tftp.o
> +
> diff --git a/net/lwip/apps/tftp/lwip-tftp.c b/net/lwip/apps/tftp/lwip-tftp.c
> new file mode 100644
> index 0000000000..e6e4883de8
> --- /dev/null
> +++ b/net/lwip/apps/tftp/lwip-tftp.c
> @@ -0,0 +1,124 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +/*
> + * (C) Copyright 2023 Linaro Ltd. <maxim.uvarov@linaro.org>
> + */
> +
> +#include <common.h>
> +#include <command.h>
> +#include <console.h>
> +#include <bootstage.h>
> +
> +#include "lwip/apps/tftp_client.h"
> +#include "lwip/apps/tftp_server.h"

Can we add a -I to the top-level Makefile so we can use #include
<ttfp_client.h> ?

> +#include <tftp_example.h>
> +
> +#include <string.h>

Should go up  the top

> +
> +#include <net/ulwip.h>
> +
> +static ulong daddr;
> +static ulong size;

Again please see if you can keep your state together rather than
sprinkling it around static vars.

> +
> +static void *tftp_open(const char *fname, const char *mode, u8_t is_write)
> +{
> +       LWIP_UNUSED_ARG(mode);
> +       return NULL;
> +}
> +
> +static void tftp_close(void *handle)
> +{
> +       log_info("\ndone\n");
> +       log_info("Bytes transferred = %ld (0x%lx hex)\n", size, size);
> +
> +       bootstage_mark_name(BOOTSTAGE_KERNELREAD_STOP, "tftp_done");
> +       env_set_ulong("filesize", size);

Error check...

> +       ulwip_exit(0);
> +}
> +
> +static int tftp_read(void *handle, void *buf, int bytes)
> +{
> +       return 0;
> +}
> +
> +static int tftp_write(void *handle, struct pbuf *p)
> +{
> +       struct pbuf *q;
> +
> +       for (q = p; q != NULL; q = q->next) {
> +               memcpy((void *)daddr, q->payload, q->len);
> +               daddr += q->len;
> +               size += q->len;
> +               log_info("#");
> +       }
> +
> +       return 0;
> +}
> +
> +static void tftp_error(void *handle, int err, const char *msg, int size)
> +{
> +       char message[100];
> +
> +       LWIP_UNUSED_ARG(handle);



> +
> +       memset(message, 0, sizeof(message));
> +       MEMCPY(message, msg, LWIP_MIN(sizeof(message)-1, (size_t)size));

what is MEMCPY() ?

> +
> +       log_info("TFTP error: %d (%s)", err, message);
> +}
> +
> +static const struct tftp_context tftp = {
> +       tftp_open,
> +       tftp_close,
> +       tftp_read,
> +       tftp_write,
> +       tftp_error
> +};
> +
> +int ulwip_tftp(ulong addr, char *fname)
> +{
> +       void *f = (void *)0x1; /* unused fake file handle*/
> +       err_t err;
> +       ip_addr_t srv;
> +       int ret;
> +       char *server_ip;
> +
> +       if (!fname || addr == 0)
> +               return CMD_RET_FAILURE;
> +
> +       size = 0;
> +       daddr = addr;
> +       server_ip = env_get("serverip");
> +       if (!server_ip) {
> +               log_err("error: serverip variable has to be set\n");
> +               return CMD_RET_FAILURE;
> +       }
> +
> +       ret = ipaddr_aton(server_ip, &srv);
> +       if (!ret) {
> +               log_err("error: ipaddr_aton\n");
> +               return CMD_RET_FAILURE;
> +       }
> +
> +       log_info("TFTP from server %s; our IP address is %s\n",
> +                server_ip, env_get("ipaddr"));
> +       log_info("Filename '%s'.\n", fname);
> +       log_info("Load address: 0x%lx\n", daddr);
> +       log_info("Loading:");
> +
> +       bootstage_mark_name(BOOTSTAGE_KERNELREAD_START, "tftp_start");
> +
> +       err = tftp_init_client(&tftp);
> +       if (!(err == ERR_OK || err == ERR_USE))
> +               log_err("tftp_init_client err: %d\n", err);
> +
> +       err = tftp_get(f, &srv, TFTP_PORT, fname, TFTP_MODE_OCTET);
> +       /* might return different errors, like routing problems */
> +       if (err != ERR_OK) {
> +               log_err("tftp_get err=%d\n", err);
> +               return CMD_RET_FAILURE;
> +       }
> +
> +       env_set_hex("fileaddr", addr);
> +       return err;
> +}
> --
> 2.30.2
>

I'm going to stop at this patch...

Regards,
Simon
diff mbox series

Patch

diff --git a/include/net/lwip.h b/include/net/lwip.h
index 240ebba354..14a65470ee 100644
--- a/include/net/lwip.h
+++ b/include/net/lwip.h
@@ -28,4 +28,16 @@  int ulwip_dns(char *name, char *varname);
  * Returns: 0 if success
  *         Other value < 0, if error
 */
-int ulwip_dhcp(void);
+
+/**
+ * ulwip_tftp() - load file with tftp
+ *
+ * Load file with tftp to specific address
+ *
+ * @addr: Address to store downloaded file
+ * @filename: File name on remote tftp server to download
+ *
+ *
+ * Returns:  0 if success, !0 if error
+ */
+int ulwip_tftp(ulong addr, const char *filename);
diff --git a/net/lwip/Makefile b/net/lwip/Makefile
index 59323fb325..0337d82cf5 100644
--- a/net/lwip/Makefile
+++ b/net/lwip/Makefile
@@ -67,3 +67,4 @@  obj-$(CONFIG_NET) += port/sys-arch.o
 
 obj-$(CONFIG_CMD_DHCP) += apps/dhcp/lwip-dhcp.o
 obj-$(CONFIG_CMD_DNS) += apps/dns/lwip-dns.o
+obj-$(CONFIG_CMD_TFTPBOOT) += apps/tftp/
diff --git a/net/lwip/apps/tftp/Makefile b/net/lwip/apps/tftp/Makefile
new file mode 100644
index 0000000000..0e50fcad45
--- /dev/null
+++ b/net/lwip/apps/tftp/Makefile
@@ -0,0 +1,16 @@ 
+
+ccflags-y += -I$(srctree)/net/lwip/port/include
+ccflags-y += -I$(srctree)/net/lwip/lwip-external/src/include -I$(srctree)/net/lwip
+ccflags-y += -I$(obj)
+
+$(obj)/tftp.o: $(obj)/tftp.c
+.PHONY: $(obj)/tftp.c
+$(obj)/tftp.c:
+	cp $(srctree)/net/lwip/lwip-external/src/apps/tftp/tftp.c $(obj)/tftp.c
+	cp $(srctree)/net/lwip/lwip-external/src/include/lwip/apps/tftp_client.h $(obj)/tftp_client.h
+	cp $(srctree)/net/lwip/lwip-external/src/include/lwip/apps/tftp_common.h $(obj)/tftp_common.h
+	cp $(srctree)/net/lwip/lwip-external/contrib/examples/tftp/tftp_example.h $(obj)/tftp_example.h
+
+obj-$(CONFIG_CMD_TFTPBOOT) += tftp.o
+obj-$(CONFIG_CMD_TFTPBOOT) += lwip-tftp.o
+
diff --git a/net/lwip/apps/tftp/lwip-tftp.c b/net/lwip/apps/tftp/lwip-tftp.c
new file mode 100644
index 0000000000..e6e4883de8
--- /dev/null
+++ b/net/lwip/apps/tftp/lwip-tftp.c
@@ -0,0 +1,124 @@ 
+// SPDX-License-Identifier: GPL-2.0
+
+/*
+ * (C) Copyright 2023 Linaro Ltd. <maxim.uvarov@linaro.org>
+ */
+
+#include <common.h>
+#include <command.h>
+#include <console.h>
+#include <bootstage.h>
+
+#include "lwip/apps/tftp_client.h"
+#include "lwip/apps/tftp_server.h"
+#include <tftp_example.h>
+
+#include <string.h>
+
+#include <net/ulwip.h>
+
+static ulong daddr;
+static ulong size;
+
+static void *tftp_open(const char *fname, const char *mode, u8_t is_write)
+{
+	LWIP_UNUSED_ARG(mode);
+	return NULL;
+}
+
+static void tftp_close(void *handle)
+{
+	log_info("\ndone\n");
+	log_info("Bytes transferred = %ld (0x%lx hex)\n", size, size);
+
+	bootstage_mark_name(BOOTSTAGE_KERNELREAD_STOP, "tftp_done");
+	env_set_ulong("filesize", size);
+	ulwip_exit(0);
+}
+
+static int tftp_read(void *handle, void *buf, int bytes)
+{
+	return 0;
+}
+
+static int tftp_write(void *handle, struct pbuf *p)
+{
+	struct pbuf *q;
+
+	for (q = p; q != NULL; q = q->next) {
+		memcpy((void *)daddr, q->payload, q->len);
+		daddr += q->len;
+		size += q->len;
+		log_info("#");
+	}
+
+	return 0;
+}
+
+static void tftp_error(void *handle, int err, const char *msg, int size)
+{
+	char message[100];
+
+	LWIP_UNUSED_ARG(handle);
+
+	memset(message, 0, sizeof(message));
+	MEMCPY(message, msg, LWIP_MIN(sizeof(message)-1, (size_t)size));
+
+	log_info("TFTP error: %d (%s)", err, message);
+}
+
+static const struct tftp_context tftp = {
+	tftp_open,
+	tftp_close,
+	tftp_read,
+	tftp_write,
+	tftp_error
+};
+
+int ulwip_tftp(ulong addr, char *fname)
+{
+	void *f = (void *)0x1; /* unused fake file handle*/
+	err_t err;
+	ip_addr_t srv;
+	int ret;
+	char *server_ip;
+
+	if (!fname || addr == 0)
+		return CMD_RET_FAILURE;
+
+	size = 0;
+	daddr = addr;
+	server_ip = env_get("serverip");
+	if (!server_ip) {
+		log_err("error: serverip variable has to be set\n");
+		return CMD_RET_FAILURE;
+	}
+
+	ret = ipaddr_aton(server_ip, &srv);
+	if (!ret) {
+		log_err("error: ipaddr_aton\n");
+		return CMD_RET_FAILURE;
+	}
+
+	log_info("TFTP from server %s; our IP address is %s\n",
+		 server_ip, env_get("ipaddr"));
+	log_info("Filename '%s'.\n", fname);
+	log_info("Load address: 0x%lx\n", daddr);
+	log_info("Loading:");
+
+	bootstage_mark_name(BOOTSTAGE_KERNELREAD_START, "tftp_start");
+
+	err = tftp_init_client(&tftp);
+	if (!(err == ERR_OK || err == ERR_USE))
+		log_err("tftp_init_client err: %d\n", err);
+
+	err = tftp_get(f, &srv, TFTP_PORT, fname, TFTP_MODE_OCTET);
+	/* might return different errors, like routing problems */
+	if (err != ERR_OK) {
+		log_err("tftp_get err=%d\n", err);
+		return CMD_RET_FAILURE;
+	}
+
+	env_set_hex("fileaddr", addr);
+	return err;
+}