[v13,12/21] net: lwip: add ping command

Add support for the the ping command with NET_LWIP. The implementation
is derived from lwIP's contrib/apps/ping/ping.c.

Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org>
---
 cmd/Kconfig        |  11 +--
 cmd/net-lwip.c     |   8 ++
 include/net-lwip.h |   1 +
 net/lwip/Makefile  |   1 +
 net/lwip/ping.c    | 177 +++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 193 insertions(+), 5 deletions(-)
 create mode 100644 net/lwip/ping.c

On Wed, 16 Oct 2024 at 13:05, Jerome Forissier
<jerome.forissier@linaro.org> wrote:
>
> Add support for the the ping command with NET_LWIP. The implementation
> is derived from lwIP's contrib/apps/ping/ping.c.
>
> Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org>
> ---
>  cmd/Kconfig        |  11 +--
>  cmd/net-lwip.c     |   8 ++
>  include/net-lwip.h |   1 +
>  net/lwip/Makefile  |   1 +
>  net/lwip/ping.c    | 177 +++++++++++++++++++++++++++++++++++++++++++++
>  5 files changed, 193 insertions(+), 5 deletions(-)
>  create mode 100644 net/lwip/ping.c
>
> diff --git a/cmd/Kconfig b/cmd/Kconfig
> index 7173f3da0b0..b7d1dd028a1 100644
> --- a/cmd/Kconfig
> +++ b/cmd/Kconfig
> @@ -2009,11 +2009,6 @@ config CMD_WGET
>           wget is a simple command to download kernel, or other files,
>           from a http server over TCP.
>
> -config CMD_PING
> -       bool "ping"
> -       help
> -         Send ICMP ECHO_REQUEST to network host
> -
>  config CMD_PING6
>         bool "ping6"
>         depends on IPV6
> @@ -2107,6 +2102,12 @@ config CMD_MDIO
>           The MDIO interface is orthogonal to the MII interface and extends
>           it by adding access to more registers through indirect addressing.
>
> +config CMD_PING
> +       bool "ping"
> +       select PROT_RAW_LWIP if NET_LWIP
> +       help
> +         Send ICMP ECHO_REQUEST to network host
> +
>  config CMD_TFTPBOOT
>         bool "tftp"
>         select PROT_UDP_LWIP if NET_LWIP
> diff --git a/cmd/net-lwip.c b/cmd/net-lwip.c
> index 80f0872bb8f..feed719beef 100644
> --- a/cmd/net-lwip.c
> +++ b/cmd/net-lwip.c
> @@ -12,6 +12,14 @@ U_BOOT_CMD(
>  );
>  #endif
>
> +#if defined(CONFIG_CMD_PING)
> +U_BOOT_CMD(
> +       ping,   2,      1,      do_ping,
> +       "send ICMP ECHO_REQUEST to network host",
> +       "pingAddress"
> +);
> +#endif
> +
>  #if defined(CONFIG_CMD_TFTPBOOT)
>  U_BOOT_CMD(
>         tftpboot,       3,      0,      do_tftpb,
> diff --git a/include/net-lwip.h b/include/net-lwip.h
> index 37744b0e2cd..9aa371e962c 100644
> --- a/include/net-lwip.h
> +++ b/include/net-lwip.h
> @@ -17,5 +17,6 @@ struct netif *net_lwip_get_netif(void);
>  int net_lwip_rx(struct udevice *udev, struct netif *netif);
>
>  int do_dhcp(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
> +int do_ping(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
>
>  #endif /* __NET_LWIP_H__ */
> diff --git a/net/lwip/Makefile b/net/lwip/Makefile
> index 4e92a101ddb..b5af37a9b18 100644
> --- a/net/lwip/Makefile
> +++ b/net/lwip/Makefile
> @@ -2,4 +2,5 @@ ccflags-y += -I$(srctree)/lib/lwip/lwip/src/include -I$(srctree)/lib/lwip/u-boot
>
>  obj-$(CONFIG_$(SPL_)DM_ETH) += net-lwip.o
>  obj-$(CONFIG_CMD_DHCP) += dhcp.o
> +obj-$(CONFIG_CMD_PING) += ping.o
>  obj-$(CONFIG_CMD_TFTPBOOT) += tftp.o
> diff --git a/net/lwip/ping.c b/net/lwip/ping.c
> new file mode 100644
> index 00000000000..8dafa25959f
> --- /dev/null
> +++ b/net/lwip/ping.c
> @@ -0,0 +1,177 @@
> +// SPDX-License-Identifier: GPL-2.0+
> +/* Copyright (C) 2024 Linaro Ltd. */
> +
> +#include <command.h>
> +#include <console.h>
> +#include <dm/device.h>
> +#include <linux/delay.h>
> +#include <linux/errno.h>
> +#include <lwip/icmp.h>
> +#include <lwip/inet_chksum.h>
> +#include <lwip/raw.h>
> +#include <lwip/timeouts.h>
> +#include <net.h>
> +#include <time.h>
> +
> +#define PING_DELAY_MS 1000
> +#define PING_COUNT 5
> +/* Ping identifier - must fit on a u16_t */
> +#define PING_ID 0xAFAF
> +
> +struct ping_ctx {
> +       ip_addr_t target;
> +       struct raw_pcb *pcb;
> +       struct icmp_echo_hdr *iecho;
> +       uint16_t seq_num;
> +       bool alive;
> +};
> +
> +static u8_t ping_recv(void *arg, struct raw_pcb *pcb, struct pbuf *p,
> +                     const ip_addr_t *addr)
> +{
> +       struct ping_ctx *ctx = arg;
> +       struct icmp_echo_hdr *iecho = ctx->iecho;
> +
> +       if (addr->addr != ctx->target.addr)
> +               return 0;
> +
> +       if ((p->tot_len >= (IP_HLEN + sizeof(struct icmp_echo_hdr))) &&
> +           pbuf_remove_header(p, IP_HLEN) == 0) {
> +               iecho = (struct icmp_echo_hdr *)p->payload;
> +
> +               if ((iecho->id == PING_ID) &&
> +                   (iecho->seqno == lwip_htons(ctx->seq_num))) {
> +                       ctx->alive = true;
> +                       printf("host %s is alive\n", ipaddr_ntoa(addr));
> +                       pbuf_free(p);
> +                       return 1; /* eat the packet */
> +               }
> +               /* not eaten, restore original packet */
> +               pbuf_add_header(p, IP_HLEN);
> +       }
> +
> +       return 0; /* don't eat the packet */
> +}
> +
> +static int ping_raw_init(struct ping_ctx *ctx)
> +{
> +       ctx->pcb = raw_new(IP_PROTO_ICMP);
> +       if (!ctx->pcb)
> +               return -ENOMEM;
> +
> +       raw_recv(ctx->pcb, ping_recv, ctx);
> +       raw_bind(ctx->pcb, IP_ADDR_ANY);
> +
> +       return 0;
> +}
> +
> +static void ping_raw_stop(struct ping_ctx *ctx)
> +{
> +       if (ctx->pcb)
> +               raw_remove(ctx->pcb);
> +}
> +
> +static void ping_prepare_echo(struct ping_ctx *ctx)
> +{
> +       struct icmp_echo_hdr *iecho = ctx->iecho;
> +
> +       ICMPH_TYPE_SET(iecho, ICMP_ECHO);
> +       ICMPH_CODE_SET(iecho, 0);
> +       iecho->chksum = 0;
> +       iecho->id = PING_ID;
> +       iecho->seqno = lwip_htons(ctx->seq_num);
> +
> +       iecho->chksum = inet_chksum(iecho, sizeof(*iecho));
> +}
> +
> +static void ping_send_icmp(struct ping_ctx *ctx)
> +{
> +       struct pbuf *p;
> +       size_t ping_size = sizeof(struct icmp_echo_hdr);
> +
> +       p = pbuf_alloc(PBUF_IP, (u16_t)ping_size, PBUF_RAM);
> +       if (!p)
> +               return;
> +
> +       if ((p->len == p->tot_len) && !p->next) {
> +               ctx->iecho = (struct icmp_echo_hdr *)p->payload;
> +               ping_prepare_echo(ctx);
> +               raw_sendto(ctx->pcb, p, &ctx->target);
> +       }
> +
> +       pbuf_free(p);
> +}
> +
> +static void ping_send(void *arg)
> +{
> +       struct ping_ctx *ctx = arg;
> +
> +       ctx->seq_num++;
> +       if (ctx->seq_num <= PING_COUNT) {
> +               ping_send_icmp(ctx);
> +               sys_timeout(PING_DELAY_MS, ping_send, ctx);
> +       }
> +}
> +
> +static int ping_loop(struct udevice *udev, const ip_addr_t* addr)
> +{
> +       struct ping_ctx ctx = {};
> +       struct netif *netif;
> +       int ret;
> +
> +       netif = net_lwip_new_netif(udev);
> +       if (!netif)
> +               return CMD_RET_FAILURE;
> +
> +       printf("Using %s device\n", udev->name);
> +
> +       ret = ping_raw_init(&ctx);
> +       if (ret < 0) {
> +               net_lwip_remove_netif(netif);
> +               return ret;
> +       }
> +
> +       ctx.target = *addr;
> +
> +       ping_send(&ctx);
> +
> +       do {
> +               sys_check_timeouts();
> +               net_lwip_rx(udev, netif);
> +               if (ctx.alive)
> +                       break;
> +               if (ctrlc()) {
> +                       printf("\nAbort\n");
> +                       break;
> +               }
> +       } while (ctx.seq_num <= PING_COUNT);
> +
> +       sys_untimeout(ping_send, &ctx);
> +       ping_raw_stop(&ctx);
> +
> +       net_lwip_remove_netif(netif);
> +
> +       if (ctx.alive)
> +               return 0;
> +
> +       printf("ping failed; host %s is not alive\n", ipaddr_ntoa(addr));
> +       return -1;
> +}
> +
> +int do_ping(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
> +{
> +       ip_addr_t addr;
> +
> +       if (argc < 2)
> +               return CMD_RET_USAGE;
> +
> +       if (!ipaddr_aton(argv[1], &addr))
> +               return CMD_RET_USAGE;
> +
> +       eth_set_current();
> +
> +       if (ping_loop(eth_get_dev(), &addr) < 0)
> +               return CMD_RET_FAILURE;
> +
> +       return CMD_RET_SUCCESS;
> +}
> --
> 2.40.1
>

Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>