nc.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdbool.h>
#include <stdint.h>
 
#include "compiler_hints.h"
#include "net/eui64.h"
#include "net/gnrc/netif/hdr.h"
#include "net/gnrc/ipv6/nib/conf.h"
#include "net/ipv6/addr.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define GNRC_IPV6_NIB_NC_INFO_NUD_STATE_MASK            (0x0007)

#define GNRC_IPV6_NIB_NC_INFO_NUD_STATE_UNMANAGED       (0x0000)

#define GNRC_IPV6_NIB_NC_INFO_NUD_STATE_UNREACHABLE     (0x0001)

#define GNRC_IPV6_NIB_NC_INFO_NUD_STATE_INCOMPLETE      (0x0002)

#define GNRC_IPV6_NIB_NC_INFO_NUD_STATE_STALE           (0x0003)

#define GNRC_IPV6_NIB_NC_INFO_NUD_STATE_DELAY           (0x0004)

#define GNRC_IPV6_NIB_NC_INFO_NUD_STATE_PROBE           (0x0005)

#define GNRC_IPV6_NIB_NC_INFO_NUD_STATE_REACHABLE       (0x0006)

#define GNRC_IPV6_NIB_NC_INFO_IS_ROUTER                 (0x0008)

#define GNRC_IPV6_NIB_NC_INFO_IFACE_MASK                (0x01f0)

#define GNRC_IPV6_NIB_NC_INFO_IFACE_POS                 (4)

#define GNRC_IPV6_NIB_NC_INFO_AR_STATE_MASK             (0x0600)

#define GNRC_IPV6_NIB_NC_INFO_AR_STATE_POS              (9)

#define GNRC_IPV6_NIB_NC_INFO_AR_STATE_GC               (0x0000)

#define GNRC_IPV6_NIB_NC_INFO_AR_STATE_TENTATIVE        (0x0200)

#define GNRC_IPV6_NIB_NC_INFO_AR_STATE_REGISTERED       (0x0400)

#define GNRC_IPV6_NIB_NC_INFO_AR_STATE_MANUAL           (0x0600)

typedef struct {
    ipv6_addr_t ipv6;       
    uint8_t l2addr[CONFIG_GNRC_IPV6_NIB_L2ADDR_MAX_LEN];
    uint16_t info;
    uint8_t l2addr_len;     
} gnrc_ipv6_nib_nc_t;

static inline unsigned gnrc_ipv6_nib_nc_get_nud_state(const gnrc_ipv6_nib_nc_t *entry)
{
    return (entry->info & GNRC_IPV6_NIB_NC_INFO_NUD_STATE_MASK);
}

static inline bool gnrc_ipv6_nib_nc_is_router(const gnrc_ipv6_nib_nc_t *entry)
{
    return (entry->info & GNRC_IPV6_NIB_NC_INFO_IS_ROUTER);
}

static inline unsigned gnrc_ipv6_nib_nc_get_iface(const gnrc_ipv6_nib_nc_t *entry)
{
    return (entry->info & GNRC_IPV6_NIB_NC_INFO_IFACE_MASK) >>
           GNRC_IPV6_NIB_NC_INFO_IFACE_POS;
}

static inline unsigned gnrc_ipv6_nib_nc_get_ar_state(const gnrc_ipv6_nib_nc_t *entry)
{
    return (entry->info & GNRC_IPV6_NIB_NC_INFO_AR_STATE_MASK);
}

ACCESS(read_only, 3, 4)
int gnrc_ipv6_nib_nc_set(const ipv6_addr_t *ipv6, unsigned iface,
                         const uint8_t *l2addr, size_t l2addr_len);
 
#if IS_ACTIVE(CONFIG_GNRC_IPV6_NIB_6LN) || defined(DOXYGEN)
ACCESS(read_only, 2, 3)
int gnrc_ipv6_nib_nc_set_6ln(unsigned iface, const uint8_t *l2addr,
                             size_t l2addr_len);
#else /* CONFIG_GNRC_IPV6_NIB_6LN */
static inline int gnrc_ipv6_nib_nc_set_6ln(unsigned iface, const uint8_t *l2addr,
                                           size_t l2addr_len)
{
    (void)iface;
    (void)l2addr;
    (void)l2addr_len;
 
    return -ENOTSUP;
}
#endif /* CONFIG_GNRC_IPV6_NIB_6LN */

void gnrc_ipv6_nib_nc_del(const ipv6_addr_t *ipv6, unsigned iface);
 
#if IS_ACTIVE(CONFIG_GNRC_IPV6_NIB_ARSM)  || defined(DOXYGEN)
ACCESS(read_only, 2, 3)
bool gnrc_ipv6_nib_nc_del_l2(unsigned iface, const uint8_t *l2addr, size_t l2addr_len);
#endif /* CONFIG_GNRC_IPV6_NIB_ARSM */

void gnrc_ipv6_nib_nc_mark_reachable(const ipv6_addr_t *ipv6);

bool gnrc_ipv6_nib_nc_iter(unsigned iface, void **state,
                           gnrc_ipv6_nib_nc_t *nce);

void gnrc_ipv6_nib_nc_print(gnrc_ipv6_nib_nc_t *nce);
 
#ifdef __cplusplus
}
#endif