netreg.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <inttypes.h>
 
#include "sched.h"
#include "net/gnrc/nettype.h"
#include "net/gnrc/pkt.h"
 
#ifdef MODULE_GNRC_NETAPI_MBOX
#include "mbox.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(MODULE_GNRC_NETAPI_CALLBACKS) || \
    defined(DOXYGEN)
typedef enum {
    GNRC_NETREG_TYPE_DEFAULT = 0,
#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(DOXYGEN)
    GNRC_NETREG_TYPE_MBOX,
#endif
#if defined(MODULE_GNRC_NETAPI_CALLBACKS) || defined(DOXYGEN)
    GNRC_NETREG_TYPE_CB,
#endif
} gnrc_netreg_type_t;
#endif

#define GNRC_NETREG_DEMUX_CTX_ALL   (0xffff0000)

#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(MODULE_GNRC_NETAPI_CALLBACKS)
#define GNRC_NETREG_ENTRY_INIT_PID(demux_ctx, pid)  { NULL, demux_ctx, \
                                                      GNRC_NETREG_TYPE_DEFAULT, \
                                                      { pid } }
#else
#define GNRC_NETREG_ENTRY_INIT_PID(demux_ctx, pid)  { NULL, demux_ctx, { pid } }
#endif
 
#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(DOXYGEN)
#define GNRC_NETREG_ENTRY_INIT_MBOX(demux_ctx, _mbox) { NULL, demux_ctx, \
                                                       GNRC_NETREG_TYPE_MBOX, \
                                                       { .mbox = _mbox } }
#endif
 
#if defined(MODULE_GNRC_NETAPI_CALLBACKS) || defined(DOXYGEN)
#define GNRC_NETREG_ENTRY_INIT_CB(demux_ctx, _cbd)   { NULL, demux_ctx, \
                                                      GNRC_NETREG_TYPE_CB, \
                                                      { .cbd = _cbd } }


typedef void (*gnrc_netreg_entry_cb_t)(uint16_t cmd, gnrc_pktsnip_t *pkt,
                                       void *ctx);

typedef struct {
    gnrc_netreg_entry_cb_t cb;  
    void *ctx;                  
} gnrc_netreg_entry_cbd_t;
#endif

typedef struct gnrc_netreg_entry {
    struct gnrc_netreg_entry *next;

    uint32_t demux_ctx;
#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(MODULE_GNRC_NETAPI_CALLBACKS) || \
    defined(DOXYGEN)
    gnrc_netreg_type_t type;
#endif
    union {
        kernel_pid_t pid;       
#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(DOXYGEN)
        mbox_t *mbox;
#endif
 
#if defined(MODULE_GNRC_NETAPI_CALLBACKS) || defined(DOXYGEN)
        gnrc_netreg_entry_cbd_t *cbd;
#endif
    } target;                   
} gnrc_netreg_entry_t;


void gnrc_netreg_acquire_shared(void);
void gnrc_netreg_release_shared(void);


void gnrc_netreg_init(void);

static inline void gnrc_netreg_entry_init_pid(gnrc_netreg_entry_t *entry,
                                              uint32_t demux_ctx,
                                              kernel_pid_t pid)
{
    entry->next = NULL;
    entry->demux_ctx = demux_ctx;
#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(MODULE_GNRC_NETAPI_CALLBACKS)
    entry->type = GNRC_NETREG_TYPE_DEFAULT;
#endif
    entry->target.pid = pid;
}
 
#if defined(MODULE_GNRC_NETAPI_MBOX) || defined(DOXYGEN)
static inline void gnrc_netreg_entry_init_mbox(gnrc_netreg_entry_t *entry,
                                               uint32_t demux_ctx,
                                               mbox_t *mbox)
{
    entry->next = NULL;
    entry->demux_ctx = demux_ctx;
    entry->type = GNRC_NETREG_TYPE_MBOX;
    entry->target.mbox = mbox;
}
#endif
 
#if defined(MODULE_GNRC_NETAPI_CALLBACKS) || defined(DOXYGEN)
static inline void gnrc_netreg_entry_init_cb(gnrc_netreg_entry_t *entry,
                                             uint32_t demux_ctx,
                                             gnrc_netreg_entry_cbd_t *cbd)
{
    entry->next = NULL;
    entry->demux_ctx = demux_ctx;
    entry->type = GNRC_NETREG_TYPE_CB;
    entry->target.cbd = cbd;
}
#endif

int gnrc_netreg_register(gnrc_nettype_t type, gnrc_netreg_entry_t *entry);

void gnrc_netreg_unregister(gnrc_nettype_t type, gnrc_netreg_entry_t *entry);

gnrc_netreg_entry_t *gnrc_netreg_lookup(gnrc_nettype_t type, uint32_t demux_ctx);

int gnrc_netreg_num(gnrc_nettype_t type, uint32_t demux_ctx);

gnrc_netreg_entry_t *gnrc_netreg_getnext(gnrc_netreg_entry_t *entry);

 
int gnrc_netreg_calc_csum(gnrc_pktsnip_t *hdr, gnrc_pktsnip_t *pseudo_hdr);
 
#ifdef __cplusplus
}
#endif