netapi.h

Go to the documentation of this file.

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

 
#include "compiler_hints.h"
#include "net/gnrc/netapi/notify.h"
#include "net/gnrc/nettype.h"
#include "net/gnrc/pkt.h"
#include "net/netopt.h"
#include "thread.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define GNRC_NETAPI_MSG_TYPE_RCV        (0x0201)

#define GNRC_NETAPI_MSG_TYPE_SND        (0x0202)

#define GNRC_NETAPI_MSG_TYPE_SET        (0x0203)

#define GNRC_NETAPI_MSG_TYPE_GET        (0x0204)

#define GNRC_NETAPI_MSG_TYPE_ACK        (0x0205)

#define GNRC_NETAPI_MSG_TYPE_NOTIFY     (0x0207)

typedef struct {
    netopt_t opt;               
    uint16_t context;           
    void *data;                 
    uint16_t data_len;          
} gnrc_netapi_opt_t;

int _gnrc_netapi_send_recv(kernel_pid_t pid, gnrc_pktsnip_t *pkt, uint16_t type);

int _gnrc_netapi_get_set(kernel_pid_t pid, netopt_t opt, uint16_t context,
                         void *data, size_t data_len, uint16_t type);

static inline int gnrc_netapi_send(kernel_pid_t pid, gnrc_pktsnip_t *pkt)
{
    return _gnrc_netapi_send_recv(pid, pkt, GNRC_NETAPI_MSG_TYPE_SND);
}

int gnrc_netapi_dispatch(gnrc_nettype_t type, uint32_t demux_ctx, uint16_t cmd,
                         gnrc_pktsnip_t *pkt);

static inline int gnrc_netapi_dispatch_send(gnrc_nettype_t type, uint32_t demux_ctx,
                                            gnrc_pktsnip_t *pkt)
{
    return gnrc_netapi_dispatch(type, demux_ctx, GNRC_NETAPI_MSG_TYPE_SND, pkt);
}

ACCESS(read_write, 4, 5)
int gnrc_netapi_notify(gnrc_nettype_t type, uint32_t demux_ctx, netapi_notify_t event,
                       void *data, size_t data_len);

static inline int gnrc_netapi_receive(kernel_pid_t pid, gnrc_pktsnip_t *pkt)
{
    return _gnrc_netapi_send_recv(pid, pkt, GNRC_NETAPI_MSG_TYPE_RCV);
}

static inline int gnrc_netapi_dispatch_receive(gnrc_nettype_t type, uint32_t demux_ctx,
                                               gnrc_pktsnip_t *pkt)
{
    return gnrc_netapi_dispatch(type, demux_ctx, GNRC_NETAPI_MSG_TYPE_RCV, pkt);
}

ACCESS(write_only, 4, 5)
static inline int gnrc_netapi_get(kernel_pid_t pid, netopt_t opt,
                                  uint16_t context, void *data, size_t max_len)
{
    return _gnrc_netapi_get_set(pid, opt, context, data, max_len,
                                GNRC_NETAPI_MSG_TYPE_GET);
}

ACCESS(read_only, 4, 5)
static inline int gnrc_netapi_set(kernel_pid_t pid, netopt_t opt,
                                  uint16_t context, const void *data,
                                  size_t data_len)
{
    /* disregard const pointer. This *should* be safe and any modification
     * to `data` should be considered a bug */
    return _gnrc_netapi_get_set(pid, opt, context, (void *)data, data_len,
                                GNRC_NETAPI_MSG_TYPE_SET);
}
 
#ifdef __cplusplus
}
#endif