Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
virtual.h
Go to the documentation of this file.
1
5/*
6 * Copyright (c) 2021 Intel Corporation
7 *
8 * SPDX-License-Identifier: Apache-2.0
9 */
10
11#ifndef ZEPHYR_INCLUDE_NET_VIRTUAL_H_
12#define ZEPHYR_INCLUDE_NET_VIRTUAL_H_
13
14#include <zephyr/kernel.h>
15#include <zephyr/types.h>
16#include <stdbool.h>
17#include <zephyr/sys/atomic.h>
18
19#include <zephyr/net/net_ip.h>
20#include <zephyr/net/net_pkt.h>
21
22#include <zephyr/sys/util.h>
23#include <zephyr/net/net_if.h>
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
40
43
45 /* Marker for capabilities - must be at the end of the enum.
46 * It is here because the capability list cannot be empty.
47 */
48 VIRTUAL_INTERFACE_NUM_CAPS
50};
51
54enum virtual_interface_config_type {
55 VIRTUAL_INTERFACE_CONFIG_TYPE_PEER_ADDRESS,
56 VIRTUAL_INTERFACE_CONFIG_TYPE_MTU,
57 VIRTUAL_INTERFACE_CONFIG_TYPE_LINK_TYPE,
58};
59
60struct virtual_interface_link_types {
61 int count;
62 uint16_t type[COND_CODE_1(CONFIG_NET_CAPTURE_COOKED_MODE,
63 (CONFIG_NET_CAPTURE_COOKED_MODE_MAX_LINK_TYPES),
64 (1))];
65};
66
67struct virtual_interface_config {
68 sa_family_t family;
69 union {
70 struct in_addr peer4addr;
71 struct in6_addr peer6addr;
72 int mtu;
73 struct virtual_interface_link_types link_types;
74 };
75};
76
77#if defined(CONFIG_NET_L2_VIRTUAL)
78#define VIRTUAL_MAX_NAME_LEN CONFIG_NET_L2_VIRTUAL_MAX_NAME_LEN
79#else
80#define VIRTUAL_MAX_NAME_LEN 0
81#endif
90 struct net_if_api iface_api;
91
93 enum virtual_interface_caps (*get_capabilities)(struct net_if *iface);
94
96 int (*start)(const struct device *dev);
97
99 int (*stop)(const struct device *dev);
100
102 int (*send)(struct net_if *iface, struct net_pkt *pkt);
103
110 enum net_verdict (*recv)(struct net_if *iface, struct net_pkt *pkt);
111
113 int (*attach)(struct net_if *virtual_iface, struct net_if *iface);
114
116 int (*set_config)(struct net_if *iface,
117 enum virtual_interface_config_type type,
118 const struct virtual_interface_config *config);
119
121 int (*get_config)(struct net_if *iface,
122 enum virtual_interface_config_type type,
123 struct virtual_interface_config *config);
124};
125
126/* Make sure that the network interface API is properly setup inside
127 * Virtual API struct (it is the first one).
128 */
129BUILD_ASSERT(offsetof(struct virtual_interface_api, iface_api) == 0);
130
135 /* Keep track of contexts */
136 sys_snode_t node;
137
138 /* My virtual network interface */
139 struct net_if *virtual_iface;
147 struct net_if *iface;
148
153
156
159
161 char name[VIRTUAL_MAX_NAME_LEN];
162};
163
173int net_virtual_interface_attach(struct net_if *virtual_iface,
174 struct net_if *iface);
175
185struct net_if *net_virtual_get_iface(struct net_if *iface);
186
196char *net_virtual_get_name(struct net_if *iface, char *buf, size_t len);
197
204void net_virtual_set_name(struct net_if *iface, const char *name);
205
215 enum net_l2_flags flags);
216
226enum net_verdict net_virtual_input(struct net_if *input_iface,
227 struct net_addr *remote_addr,
228 struct net_pkt *pkt);
229
238#if defined(CONFIG_NET_L2_VIRTUAL)
239void net_virtual_init(struct net_if *iface);
240#else
241static inline void net_virtual_init(struct net_if *iface)
242{
243 ARG_UNUSED(iface);
244}
245#endif
246
253#if defined(CONFIG_NET_L2_VIRTUAL)
254void net_virtual_disable(struct net_if *iface);
255#else
256static inline void net_virtual_disable(struct net_if *iface)
257{
258 ARG_UNUSED(iface);
259}
260#endif
261
268#if defined(CONFIG_NET_L2_VIRTUAL)
269void net_virtual_enable(struct net_if *iface);
270#else
271static inline void net_virtual_enable(struct net_if *iface)
272{
273 ARG_UNUSED(iface);
274}
275#endif
276
277#define VIRTUAL_L2_CTX_TYPE struct virtual_interface_context
278
286static inline enum virtual_interface_caps
287net_virtual_get_iface_capabilities(struct net_if *iface)
288{
289 const struct virtual_interface_api *virt =
291
292 if (!virt->get_capabilities) {
293 return (enum virtual_interface_caps)0;
294 }
295
296 return virt->get_capabilities(iface);
297}
298
299#define Z_NET_VIRTUAL_INTERFACE_INIT(node_id, dev_id, name, init_fn, \
300 pm, data, config, prio, api, mtu) \
301 Z_NET_DEVICE_INIT(node_id, dev_id, name, init_fn, pm, data, \
302 config, prio, api, VIRTUAL_L2, \
303 NET_L2_GET_CTX_TYPE(VIRTUAL_L2), mtu)
304
305#define Z_NET_VIRTUAL_INTERFACE_INIT_INSTANCE(node_id, dev_id, name, \
306 inst, init_fn, pm, data, \
307 config, prio, api, mtu) \
308 Z_NET_DEVICE_INIT_INSTANCE(node_id, dev_id, name, inst, \
309 init_fn, pm, data, \
310 config, prio, api, VIRTUAL_L2, \
311 NET_L2_GET_CTX_TYPE(VIRTUAL_L2), mtu)
335#define NET_VIRTUAL_INTERFACE_INIT(dev_id, name, init_fn, pm, data, \
336 config, prio, api, mtu) \
337 Z_NET_VIRTUAL_INTERFACE_INIT(DT_INVALID_NODE, dev_id, name, \
338 init_fn, pm, data, config, prio, \
339 api, mtu)
340
363#define NET_VIRTUAL_INTERFACE_INIT_INSTANCE(dev_id, name, inst, \
364 init_fn, pm, data, \
365 config, prio, api, mtu) \
366 Z_NET_VIRTUAL_INTERFACE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, \
367 name, inst, \
368 init_fn, pm, data, config, \
369 prio, api, mtu)
370
375#ifdef __cplusplus
376}
377#endif
378
379#endif /* ZEPHYR_INCLUDE_NET_VIRTUAL_H_ */
unsigned short int sa_family_t
Socket address family type.
Definition: net_ip.h:164
net_verdict
Net Verdict.
Definition: net_core.h:100
static const struct device * net_if_get_device(struct net_if *iface)
Get an network interface's device.
Definition: net_if.h:941
net_l2_flags
L2 flags.
Definition: net_l2.h:34
struct _snode sys_snode_t
Single-linked list node structure.
Definition: slist.h:39
#define COND_CODE_1(_flag, _if_1_code, _else_code)
Insert code depending on whether _flag expands to 1 or not.
Definition: util_macro.h:179
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition: util_macro.h:44
void net_virtual_set_name(struct net_if *iface, const char *name)
Set the name of the virtual network interface L2.
enum net_l2_flags net_virtual_set_flags(struct net_if *iface, enum net_l2_flags flags)
Set the L2 flags of the virtual network interface.
int net_virtual_interface_attach(struct net_if *virtual_iface, struct net_if *iface)
Attach virtual network interface to the given network interface.
enum net_verdict net_virtual_input(struct net_if *input_iface, struct net_addr *remote_addr, struct net_pkt *pkt)
Feed the IP pkt to stack if tunneling is enabled.
virtual_interface_caps
Virtual interface capabilities.
Definition: virtual.h:37
char * net_virtual_get_name(struct net_if *iface, char *buf, size_t len)
Return the name of the virtual network interface L2.
struct net_if * net_virtual_get_iface(struct net_if *iface)
Return network interface related to this virtual network interface.
@ VIRTUAL_INTERFACE_IPIP
IPIP tunnel.
Definition: virtual.h:39
@ VIRTUAL_INTERFACE_VLAN
Virtual LAN interface (VLAN)
Definition: virtual.h:42
Public kernel APIs.
Public API for network interface.
IPv6 and IPv4 definitions.
Network packet buffer descriptor API.
flags
Definition: parser.h:96
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition: device.h:403
const void * api
Address of the API structure exposed by the device instance.
Definition: device.h:409
IPv6 address struct.
Definition: net_ip.h:139
IPv4 address struct.
Definition: net_ip.h:151
Network Interface structure.
Definition: net_if.h:678
Hardware link address structure.
Definition: net_linkaddr.h:88
Network packet.
Definition: net_pkt.h:67
Virtual L2 API operations.
Definition: virtual.h:85
int(* stop)(const struct device *dev)
Stop the device.
Definition: virtual.h:99
int(* get_config)(struct net_if *iface, enum virtual_interface_config_type type, struct virtual_interface_config *config)
Get specific L2 configuration.
Definition: virtual.h:121
int(* set_config)(struct net_if *iface, enum virtual_interface_config_type type, const struct virtual_interface_config *config)
Set specific L2 configuration.
Definition: virtual.h:116
enum net_verdict(* recv)(struct net_if *iface, struct net_pkt *pkt)
Receive a network packet.
Definition: virtual.h:110
int(* send)(struct net_if *iface, struct net_pkt *pkt)
Send a network packet.
Definition: virtual.h:102
int(* attach)(struct net_if *virtual_iface, struct net_if *iface)
Pass the attachment information to virtual interface.
Definition: virtual.h:113
enum virtual_interface_caps(* get_capabilities)(struct net_if *iface)
Get the virtual interface capabilities.
Definition: virtual.h:93
struct net_if_api iface_api
The net_if_api must be placed in first position in this struct so that we are compatible with network...
Definition: virtual.h:90
int(* start)(const struct device *dev)
Start the device.
Definition: virtual.h:96
Virtual L2 context that is needed to binding to the real network interface.
Definition: virtual.h:133
enum net_l2_flags virtual_l2_flags
This tells what L2 features does virtual support.
Definition: virtual.h:152
struct net_if * iface
Other network interface this virtual network interface is attached to.
Definition: virtual.h:147
char name[VIRTUAL_MAX_NAME_LEN]
User friendly name of this L2 layer.
Definition: virtual.h:161
bool is_init
Is this context already initialized.
Definition: virtual.h:155
struct net_linkaddr_storage lladdr
Link address for this network interface.
Definition: virtual.h:158
Misc utilities.