Zephyr API Documentation  3.7.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
icmp.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2023 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
16#ifndef ZEPHYR_INCLUDE_NET_ICMP_H_
17#define ZEPHYR_INCLUDE_NET_ICMP_H_
18
19#include <stddef.h>
20
21#include <zephyr/kernel.h>
22#include <zephyr/types.h>
23#include <zephyr/net/net_ip.h>
24#include <zephyr/net/net_if.h>
25#include <zephyr/net/net_pkt.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31#define NET_ICMPV4_ECHO_REQUEST 8
32#define NET_ICMPV4_ECHO_REPLY 0
33#define NET_ICMPV6_ECHO_REQUEST 128
34#define NET_ICMPV6_ECHO_REPLY 129
36struct net_icmp_ctx;
37struct net_icmp_ip_hdr;
39
50typedef int (*net_icmp_handler_t)(struct net_icmp_ctx *ctx,
51 struct net_pkt *pkt,
52 struct net_icmp_ip_hdr *ip_hdr,
53 struct net_icmp_hdr *icmp_hdr,
54 void *user_data);
55
73 struct net_if *iface,
74 struct sockaddr *dst,
75 struct net_icmp_ping_params *params,
76 void *user_data);
77
84
87
89 struct net_if *iface;
90
92 void *user_data;
93
96
99};
100
105 union {
107 struct net_ipv4_hdr *ipv4;
108
110 struct net_ipv6_hdr *ipv6;
111 };
112
115};
116
126
131
136
139
143 const void *data;
144
149 size_t data_size;
150};
151
162int net_icmp_init_ctx(struct net_icmp_ctx *ctx, uint8_t type, uint8_t code,
163 net_icmp_handler_t handler);
164
172
187 struct net_if *iface,
188 struct sockaddr *dst,
189 struct net_icmp_ping_params *params,
190 void *user_data);
191
198
205
208
210 struct net_if *iface;
211};
212
226 struct net_if *iface,
228
237
252 net_icmp_handler_t *resp_handler);
253
254#ifdef __cplusplus
255}
256#endif
257
258#endif /* ZEPHYR_INCLUDE_NET_ICMP_H */
259
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)
Send ICMP echo request message.
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)
Handler function that is called when an Echo-Request is sent to offloaded device.
Definition: icmp.h:72
int net_icmp_register_offload_ping(struct net_icmp_offload *ctx, struct net_if *iface, net_icmp_offload_ping_handler_t ping_handler)
Register a handler function that is called when an Echo-Request is sent to the offloaded device.
int net_icmp_unregister_offload_ping(struct net_icmp_offload *ctx)
Unregister the offload handler.
int net_icmp_cleanup_ctx(struct net_icmp_ctx *ctx)
Cleanup the ICMP context structure.
int net_icmp_get_offload_rsp_handler(struct net_icmp_offload *ctx, net_icmp_handler_t *resp_handler)
Get a ICMP response handler function for an offloaded device.
int net_icmp_init_ctx(struct net_icmp_ctx *ctx, uint8_t type, uint8_t code, net_icmp_handler_t handler)
Initialize the ICMP context structure.
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)
Handler function that is called when ICMP response is received.
Definition: icmp.h:50
unsigned short int sa_family_t
Socket address family type.
Definition: net_ip.h:164
struct _snode sys_snode_t
Single-linked list node structure.
Definition: slist.h:39
Public kernel APIs.
Public API for network interface.
IPv6 and IPv4 definitions.
Network packet buffer descriptor API.
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
ICMP context structure.
Definition: icmp.h:81
void * user_data
Opaque user supplied data.
Definition: icmp.h:92
sys_snode_t node
List node.
Definition: icmp.h:83
struct net_if * iface
Network interface where the ICMP request was sent.
Definition: icmp.h:89
uint8_t code
ICMP code of the response type we are waiting.
Definition: icmp.h:98
net_icmp_handler_t handler
ICMP response handler.
Definition: icmp.h:86
uint8_t type
ICMP type of the response we are waiting.
Definition: icmp.h:95
Struct presents either IPv4 or IPv6 header in ICMP response message.
Definition: icmp.h:104
struct net_ipv4_hdr * ipv4
IPv4 header in response message.
Definition: icmp.h:107
sa_family_t family
Is the header IPv4 or IPv6 one.
Definition: icmp.h:114
struct net_ipv6_hdr * ipv6
IPv6 header in response message.
Definition: icmp.h:110
ICMP offload context structure.
Definition: icmp.h:195
net_icmp_handler_t handler
ICMP response handler.
Definition: icmp.h:204
net_icmp_offload_ping_handler_t ping_handler
ICMP offloaded ping handler.
Definition: icmp.h:207
sys_snode_t node
List node.
Definition: icmp.h:197
struct net_if * iface
Offloaded network interface.
Definition: icmp.h:210
Struct presents parameters that are needed when sending Echo-Request (ping) messages.
Definition: icmp.h:121
uint16_t identifier
An identifier to aid in matching Echo Replies to this Echo Request.
Definition: icmp.h:125
size_t data_size
Size of the Payload Data in bytes.
Definition: icmp.h:149
uint16_t sequence
A sequence number to aid in matching Echo Replies to this Echo Request.
Definition: icmp.h:130
int priority
Network packet priority.
Definition: icmp.h:138
uint8_t tc_tos
Can be either IPv4 Type-of-service field value, or IPv6 Traffic Class field value.
Definition: icmp.h:135
const void * data
Arbitrary payload data that will be included in the Echo Reply verbatim.
Definition: icmp.h:143
Network Interface structure.
Definition: net_if.h:678
Network packet.
Definition: net_pkt.h:67
Generic sockaddr struct.
Definition: net_ip.h:385