net_l2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_NET_L2_H_
#define ZEPHYR_INCLUDE_NET_NET_L2_H_
 
#include <zephyr/device.h>
#include <zephyr/net_buf.h>
#include <zephyr/net/net_ip.h>
#include <zephyr/net/capture.h>
#include <zephyr/sys/iterable_sections.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct net_if;
 
enum net_l2_flags {
        NET_L2_MULTICAST                        = BIT(0),
 
        NET_L2_MULTICAST_SKIP_JOIN_SOLICIT_NODE = BIT(1),
 
        NET_L2_PROMISC_MODE                     = BIT(2),
 
        NET_L2_POINT_TO_POINT                   = BIT(3),
} __packed;
 
struct net_l2 {
        enum net_verdict (*recv)(struct net_if *iface, struct net_pkt *pkt);
 
        int (*send)(struct net_if *iface, struct net_pkt *pkt);
 
        int (*enable)(struct net_if *iface, bool state);
 
        enum net_l2_flags (*get_flags)(struct net_if *iface);
 
        int (*alloc)(struct net_if *iface, struct net_pkt *pkt,
                     size_t size, enum net_ip_protocol proto,
                     k_timeout_t timeout);
};
 
#define NET_L2_GET_NAME(_name) _net_l2_##_name
#define NET_L2_DECLARE_PUBLIC(_name)                                    \
        extern const struct net_l2 NET_L2_GET_NAME(_name)
#define NET_L2_GET_CTX_TYPE(_name) _name##_CTX_TYPE
 
#define VIRTUAL_L2              VIRTUAL
NET_L2_DECLARE_PUBLIC(VIRTUAL_L2);
 
#define DUMMY_L2                DUMMY
#define DUMMY_L2_CTX_TYPE       void*
NET_L2_DECLARE_PUBLIC(DUMMY_L2);
 
#define OFFLOADED_NETDEV_L2 OFFLOADED_NETDEV
NET_L2_DECLARE_PUBLIC(OFFLOADED_NETDEV_L2);
 
#define ETHERNET_L2             ETHERNET
NET_L2_DECLARE_PUBLIC(ETHERNET_L2);
 
#define PPP_L2                  PPP
NET_L2_DECLARE_PUBLIC(PPP_L2);
 
#define IEEE802154_L2           IEEE802154
NET_L2_DECLARE_PUBLIC(IEEE802154_L2);
 
#define OPENTHREAD_L2           OPENTHREAD
NET_L2_DECLARE_PUBLIC(OPENTHREAD_L2);
 
#define CANBUS_RAW_L2           CANBUS_RAW
#define CANBUS_RAW_L2_CTX_TYPE  void*
NET_L2_DECLARE_PUBLIC(CANBUS_RAW_L2);
 
#ifdef CONFIG_NET_L2_CUSTOM_IEEE802154
#ifndef CUSTOM_IEEE802154_L2
#define CUSTOM_IEEE802154_L2    CUSTOM_IEEE802154
#endif
#define CUSTOM_IEEE802154_L2_CTX_TYPE   void*
NET_L2_DECLARE_PUBLIC(CUSTOM_IEEE802154_L2);
#endif /* CONFIG_NET_L2_CUSTOM_IEEE802154 */
 
#define NET_L2_INIT(_name, _recv_fn, _send_fn, _enable_fn, _get_flags_fn, ...) \
        const STRUCT_SECTION_ITERABLE(net_l2,                           \
                                      NET_L2_GET_NAME(_name)) = {       \
                .recv = (_recv_fn),                                     \
                .send = (_send_fn),                                     \
                .enable = (_enable_fn),                                 \
                .get_flags = (_get_flags_fn),                           \
                .alloc = COND_CODE_0(NUM_VA_ARGS_LESS_1(LIST_DROP_EMPTY(__VA_ARGS__, _)), \
                                     (NULL),                            \
                                     (GET_ARG_N(1, __VA_ARGS__))),      \
        }
 
#define NET_L2_GET_DATA(name, sfx) _net_l2_data_##name##sfx
 
#define NET_L2_DATA_INIT(name, sfx, ctx_type)                           \
        static ctx_type NET_L2_GET_DATA(name, sfx) __used;
 
typedef int (*net_l2_send_t)(const struct device *dev, struct net_pkt *pkt);
 
static inline int net_l2_send(net_l2_send_t send_fn,
                              const struct device *dev,
                              struct net_if *iface,
                              struct net_pkt *pkt)
{
        net_capture_pkt(iface, pkt);
 
        return send_fn(dev, pkt);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_NET_L2_H_ */