ethernet_bridge.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2021 BayLibre SAS
 * Copyright (c) 2024 Nordic Semiconductor
 * SPDX-FileCopyrightText: Copyright 2025 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_ETHERNET_BRIDGE_H_
#define ZEPHYR_INCLUDE_NET_ETHERNET_BRIDGE_H_
 
#include <zephyr/sys/slist.h>
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/net/ethernet.h>
 
#ifdef __cplusplus
extern "C" {
#endif


 
#if defined(CONFIG_NET_ETHERNET_BRIDGE)
#define NET_ETHERNET_BRIDGE_ETH_INTERFACE_COUNT CONFIG_NET_ETHERNET_BRIDGE_ETH_INTERFACE_COUNT
#else
#define NET_ETHERNET_BRIDGE_ETH_INTERFACE_COUNT 1
#endif
 
struct eth_bridge_iface_context {
        /* Lock to protect access to interface array below */
        struct k_mutex lock;
 
        /* The actual bridge virtual interface  */
        struct net_if *iface;
 
        /* What Ethernet interfaces are bridged together */
        struct net_if *eth_iface[NET_ETHERNET_BRIDGE_ETH_INTERFACE_COUNT];
 
        /* How many interfaces are bridged atm */
        size_t count;
 
        /* Bridge instance id */
        int id;
 
        /* Has user configured the bridge */
        bool is_setup : 1;
 
        /* Is the interface enabled or not */
        bool status : 1;
};


int eth_bridge_iface_add(struct net_if *br, struct net_if *iface);

int eth_bridge_iface_remove(struct net_if *br, struct net_if *iface);

int eth_bridge_get_index(struct net_if *br);

struct net_if *eth_bridge_get_by_index(int index);

typedef void (*eth_bridge_cb_t)(struct eth_bridge_iface_context *br, void *user_data);

void net_eth_bridge_foreach(eth_bridge_cb_t cb, void *user_data);

static inline bool net_eth_iface_is_bridged(struct ethernet_context *ctx)
{
#if defined(CONFIG_NET_ETHERNET_BRIDGE)
        struct eth_bridge_iface_context *br_ctx;
        const struct device *br_dev;
 
        NET_ASSERT(ctx != NULL);
 
        if (ctx->bridge == NULL) {
                return false;
        }
 
        br_dev = net_if_get_device(ctx->bridge);
 
        br_ctx = (struct eth_bridge_iface_context *)br_dev->data;
        if (br_ctx->is_setup) {
                return true;
        }
#endif
        return false;
}

static inline struct net_if *net_eth_get_bridge(struct ethernet_context *ctx)
{
#if defined(CONFIG_NET_ETHERNET_BRIDGE)
        NET_ASSERT(ctx != NULL);
 
        return ctx->bridge;
#else
        return NULL;
#endif
}

enum net_verdict eth_bridge_input_process(struct net_if *iface, struct net_pkt *pkt,
                                          struct net_if **dst_iface);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_ETHERNET_BRIDGE_H_ */