Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
net_l2.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_NET_NET_L2_H_
13#define ZEPHYR_INCLUDE_NET_NET_L2_H_
14
15#include <zephyr/device.h>
16#include <zephyr/net_buf.h>
17#include <zephyr/net/capture.h>
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
33struct net_if;
34
51
57struct net_l2 {
62 enum net_verdict (*recv)(struct net_if *iface, struct net_pkt *pkt);
63
70 int (*send)(struct net_if *iface, struct net_pkt *pkt);
71
76 int (*enable)(struct net_if *iface, bool state);
77
81 enum net_l2_flags (*get_flags)(struct net_if *iface);
82};
83
85#define NET_L2_GET_NAME(_name) _net_l2_##_name
86#define NET_L2_DECLARE_PUBLIC(_name) \
87 extern const struct net_l2 NET_L2_GET_NAME(_name)
88#define NET_L2_GET_CTX_TYPE(_name) _name##_CTX_TYPE
89
90#define VIRTUAL_L2 VIRTUAL
91NET_L2_DECLARE_PUBLIC(VIRTUAL_L2);
92
93#define DUMMY_L2 DUMMY
94#define DUMMY_L2_CTX_TYPE void*
95NET_L2_DECLARE_PUBLIC(DUMMY_L2);
96
97#define OFFLOADED_NETDEV_L2 OFFLOADED_NETDEV
98NET_L2_DECLARE_PUBLIC(OFFLOADED_NETDEV_L2);
99
100#define ETHERNET_L2 ETHERNET
101NET_L2_DECLARE_PUBLIC(ETHERNET_L2);
102
103#define PPP_L2 PPP
104NET_L2_DECLARE_PUBLIC(PPP_L2);
105
106#define IEEE802154_L2 IEEE802154
107NET_L2_DECLARE_PUBLIC(IEEE802154_L2);
108
109#define OPENTHREAD_L2 OPENTHREAD
110NET_L2_DECLARE_PUBLIC(OPENTHREAD_L2);
111
112#define CANBUS_RAW_L2 CANBUS_RAW
113#define CANBUS_RAW_L2_CTX_TYPE void*
114NET_L2_DECLARE_PUBLIC(CANBUS_RAW_L2);
115
116#ifdef CONFIG_NET_L2_CUSTOM_IEEE802154
117#ifndef CUSTOM_IEEE802154_L2
118#define CUSTOM_IEEE802154_L2 CUSTOM_IEEE802154
119#endif
120#define CUSTOM_IEEE802154_L2_CTX_TYPE void*
121NET_L2_DECLARE_PUBLIC(CUSTOM_IEEE802154_L2);
122#endif /* CONFIG_NET_L2_CUSTOM_IEEE802154 */
123
124#define NET_L2_INIT(_name, _recv_fn, _send_fn, _enable_fn, _get_flags_fn) \
125 const STRUCT_SECTION_ITERABLE(net_l2, \
126 NET_L2_GET_NAME(_name)) = { \
127 .recv = (_recv_fn), \
128 .send = (_send_fn), \
129 .enable = (_enable_fn), \
130 .get_flags = (_get_flags_fn), \
131 }
132
133#define NET_L2_GET_DATA(name, sfx) _net_l2_data_##name##sfx
134
135#define NET_L2_DATA_INIT(name, sfx, ctx_type) \
136 static ctx_type NET_L2_GET_DATA(name, sfx) __used;
137
138typedef int (*net_l2_send_t)(const struct device *dev, struct net_pkt *pkt);
139
140static inline int net_l2_send(net_l2_send_t send_fn,
141 const struct device *dev,
142 struct net_if *iface,
143 struct net_pkt *pkt)
144{
145 net_capture_pkt(iface, pkt);
146
147 return send_fn(dev, pkt);
148}
149
156#ifdef __cplusplus
157}
158#endif
159
160#endif /* ZEPHYR_INCLUDE_NET_NET_L2_H_ */
Network packet capture definitions.
net_verdict
Net Verdict.
Definition net_core.h:102
net_l2_flags
L2 flags.
Definition net_l2.h:36
@ NET_L2_POINT_TO_POINT
Is this L2 point-to-point with tunneling so no need to have IP address etc to network interface.
Definition net_l2.h:49
@ NET_L2_MULTICAST_SKIP_JOIN_SOLICIT_NODE
Do not join solicited node multicast group.
Definition net_l2.h:41
@ NET_L2_PROMISC_MODE
Is promiscuous mode supported.
Definition net_l2.h:44
@ NET_L2_MULTICAST
IP multicast supported.
Definition net_l2.h:38
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
Buffer management.
state
Definition parser_state.h:29
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
Network Interface structure.
Definition net_if.h:690
Network L2 structure.
Definition net_l2.h:57
int(* send)(struct net_if *iface, struct net_pkt *pkt)
This function is used by net core to push a packet to lower layer (interface's L2),...
Definition net_l2.h:70
enum net_verdict(* recv)(struct net_if *iface, struct net_pkt *pkt)
This function is used by net core to get iface's L2 layer parsing what's relevant to itself.
Definition net_l2.h:62
enum net_l2_flags(* get_flags)(struct net_if *iface)
Return L2 flags for the network interface.
Definition net_l2.h:81
int(* enable)(struct net_if *iface, bool state)
This function is used to enable/disable traffic over a network interface.
Definition net_l2.h:76
Network packet.
Definition net_pkt.h:91
struct net_if * iface
Network interface.
Definition net_pkt.h:114