icmp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_ICMP_H_
#define ZEPHYR_INCLUDE_NET_ICMP_H_
 
#include <stddef.h>
 
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/net/net_ip.h>
#include <zephyr/net/net_if.h>
#include <zephyr/net/net_pkt.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NET_ICMPV4_ECHO_REQUEST 8
#define NET_ICMPV4_ECHO_REPLY   0
#define NET_ICMPV6_ECHO_REQUEST 128
#define NET_ICMPV6_ECHO_REPLY   129
 
struct net_icmp_ctx;
struct net_icmp_ip_hdr;
struct net_icmp_ping_params;
 
typedef int (*net_icmp_handler_t)(struct net_icmp_ctx *ctx,
                                  struct net_pkt *pkt,
                                  struct net_icmp_ip_hdr *ip_hdr,
                                  struct net_icmp_hdr *icmp_hdr,
                                  void *user_data);
 
typedef int (*net_icmp_offload_ping_handler_t)(struct net_icmp_ctx *ctx,
                                               struct net_if *iface,
                                               struct sockaddr *dst,
                                               struct net_icmp_ping_params *params,
                                               void *user_data);
 
struct net_icmp_ctx {
        sys_snode_t node;
 
        net_icmp_handler_t handler;
 
        struct net_if *iface;
 
        void *user_data;
 
        uint8_t type;
 
        uint8_t code;
};
 
struct net_icmp_ip_hdr {
        union {
                struct net_ipv4_hdr *ipv4;
 
                struct net_ipv6_hdr *ipv6;
        };
 
        sa_family_t family;
};
 
struct net_icmp_ping_params {
        uint16_t identifier;
 
        uint16_t sequence;
 
        uint8_t tc_tos;
 
        int priority;
 
        /* Arbitrary payload data that will be included in the Echo Reply
         * verbatim. May be NULL.
         */
        const void *data;
 
        size_t data_size;
};
 
int net_icmp_init_ctx(struct net_icmp_ctx *ctx, uint8_t type, uint8_t code,
                      net_icmp_handler_t handler);
 
int net_icmp_cleanup_ctx(struct net_icmp_ctx *ctx);
 
int net_icmp_send_echo_request(struct net_icmp_ctx *ctx,
                               struct net_if *iface,
                               struct sockaddr *dst,
                               struct net_icmp_ping_params *params,
                               void *user_data);
 
struct net_icmp_offload {
        sys_snode_t node;
 
        net_icmp_handler_t handler;
 
        net_icmp_offload_ping_handler_t ping_handler;
 
        struct net_if *iface;
};
 
int net_icmp_register_offload_ping(struct net_icmp_offload *ctx,
                                   struct net_if *iface,
                                   net_icmp_offload_ping_handler_t ping_handler);
 
int net_icmp_unregister_offload_ping(struct net_icmp_offload *ctx);
 
int net_icmp_get_offload_rsp_handler(struct net_icmp_offload *ctx,
                                     net_icmp_handler_t *resp_handler);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_ICMP_H */