net_linkaddr.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_NET_NET_LINKADDR_H_
#define ZEPHYR_INCLUDE_NET_NET_LINKADDR_H_
 
#include <zephyr/types.h>
#include <stdbool.h>
#include <errno.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#if CONFIG_NET_LINK_ADDR_CUSTOM_LENGTH > 0
#define NET_LINK_ADDR_MAX_LENGTH CONFIG_NET_LINK_ADDR_CUSTOM_LENGTH
 
#if defined(CONFIG_NET_L2_PHY_IEEE802154) || defined(CONFIG_NET_L2_PPP)
BUILD_ASSERT(CONFIG_NET_LINK_ADDR_CUSTOM_LENGTH >= 8,
             "CONFIG_NET_LINK_ADDR_CUSTOM_LENGTH too low, required at least 8");
#endif
 
#if defined(CONFIG_NET_L2_ETHERNET)
BUILD_ASSERT(CONFIG_NET_LINK_ADDR_CUSTOM_LENGTH >= 6,
             "CONFIG_NET_LINK_ADDR_CUSTOM_LENGTH too low, required at least 6");
#endif
 
#elif defined(CONFIG_NET_L2_PHY_IEEE802154) || defined(CONFIG_NET_L2_PPP)
#define NET_LINK_ADDR_MAX_LENGTH 8
#else
#define NET_LINK_ADDR_MAX_LENGTH 6
#endif

enum net_link_type {
        NET_LINK_UNKNOWN = 0,
        NET_LINK_IEEE802154,
        NET_LINK_BLUETOOTH,
        NET_LINK_ETHERNET,
        NET_LINK_DUMMY,
        NET_LINK_CANBUS_RAW,
} __packed;

struct net_linkaddr {
        uint8_t type;

        uint8_t len;

        uint8_t addr[NET_LINK_ADDR_MAX_LENGTH]; /* in big endian */
};

static inline bool net_linkaddr_cmp(struct net_linkaddr *lladdr1,
                                    struct net_linkaddr *lladdr2)
{
        if (!lladdr1 || !lladdr2) {
                return false;
        }
 
        if (lladdr1->len != lladdr2->len) {
                return false;
        }
 
        return !memcmp(lladdr1->addr, lladdr2->addr, lladdr1->len);
}

static inline int net_linkaddr_set(struct net_linkaddr *lladdr,
                                   const uint8_t *new_addr,
                                   uint8_t new_len)
{
        if (lladdr == NULL || new_addr == NULL) {
                return -EINVAL;
        }
 
        if (new_len > NET_LINK_ADDR_MAX_LENGTH) {
                return -EMSGSIZE;
        }
 
        lladdr->len = new_len;
        memcpy(lladdr->addr, new_addr, new_len);
 
        return 0;
}

static inline int net_linkaddr_copy(struct net_linkaddr *dst,
                                    const struct net_linkaddr *src)
{
        if (dst == NULL || src == NULL) {
                return -EINVAL;
        }
 
        if (src->len > NET_LINK_ADDR_MAX_LENGTH) {
                return -EMSGSIZE;
        }
 
        dst->type = src->type;
        dst->len = src->len;
        memcpy(dst->addr, src->addr, src->len);
 
        return 0;
}

static inline int net_linkaddr_create(struct net_linkaddr *lladdr,
                                      const uint8_t *addr, uint8_t len,
                                      enum net_link_type type)
{
        if (lladdr == NULL) {
                return -EINVAL;
        }
 
        if (len > NET_LINK_ADDR_MAX_LENGTH) {
                return -EMSGSIZE;
        }
 
        if (addr == NULL) {
                memset(lladdr->addr, 0, NET_LINK_ADDR_MAX_LENGTH);
        } else {
                memcpy(lladdr->addr, addr, len);
        }
 
        lladdr->type = type;
        lladdr->len = len;
 
        return 0;
}

static inline int net_linkaddr_clear(struct net_linkaddr *lladdr)
{
        return net_linkaddr_create(lladdr, NULL, 0, NET_LINK_UNKNOWN);
}

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_NET_LINKADDR_H_ */