net: removed deprecated non-gnrc netapi
This commit is contained in:
Hauke Petersen
parent
8960be109d
commit
bce198ebf8
|
|
@ -140,9 +140,6 @@ endif
|
|||
ifneq (,$(filter ng_slip,$(USEMODULE)))
|
||||
DIRS += net/link_layer/ng_slip
|
||||
endif
|
||||
ifneq (,$(filter netapi,$(USEMODULE)))
|
||||
DIRS += net/crosslayer/netapi
|
||||
endif
|
||||
ifneq (,$(filter trickle,$(USEMODULE)))
|
||||
DIRS += trickle
|
||||
endif
|
||||
|
|
|
|||
|
|
@ -13,9 +13,6 @@ endif
|
|||
ifneq (,$(filter udp,$(USEMODULE)))
|
||||
USEMODULE_INCLUDES += $(RIOTBASE)/sys/net/include
|
||||
endif
|
||||
ifneq (,$(filter netapi,$(USEMODULE)))
|
||||
USEMODULE_INCLUDES += $(RIOTBASE)/sys/net/include
|
||||
endif
|
||||
ifneq (,$(filter net_help,$(USEMODULE)))
|
||||
USEMODULE_INCLUDES += $(RIOTBASE)/sys/net/include
|
||||
USEMODULE_INCLUDES += $(RIOTBASE)/drivers/cc110x
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
include $(RIOTBASE)/Makefile.base
|
||||
|
|
@ -1,147 +0,0 @@
|
|||
/*
|
||||
* Copyright (C) 2014 Freie Universität Berlin
|
||||
*
|
||||
* This file is subject to the terms and conditions of the GNU Lesser
|
||||
* General Public License v2.1. See the file LICENSE in the top level
|
||||
* directory for more details.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @{
|
||||
* @file
|
||||
* @brief You do not necessarily need this file (leave `netapi` out of
|
||||
* `USEMODULE`, the netapi.h file will still be available for
|
||||
* inclusion). It supplies you however with some helper functions
|
||||
* for the thread communication.
|
||||
*/
|
||||
|
||||
#include <errno.h>
|
||||
|
||||
#include "kernel.h"
|
||||
#include "msg.h"
|
||||
|
||||
#include "netapi.h"
|
||||
|
||||
#define ENABLE_DEBUG (0)
|
||||
#include "debug.h"
|
||||
|
||||
int netapi_send_command(kernel_pid_t pid, netapi_cmd_t *cmd)
|
||||
{
|
||||
msg_t msg_cmd, msg_ack;
|
||||
netapi_ack_t ack;
|
||||
int ack_result;
|
||||
|
||||
DEBUG("send command to %" PRIkernel_pid ", cmd = %p, cmd->type = %d\n",
|
||||
pid, (void *)cmd, (void *)(cmd->type));
|
||||
|
||||
msg_cmd.type = NETAPI_MSG_TYPE;
|
||||
msg_cmd.content.ptr = (char *)cmd;
|
||||
|
||||
msg_ack.content.ptr = NULL; /* silence valgrind */
|
||||
|
||||
cmd->ack = &ack;
|
||||
|
||||
msg_send_receive(&msg_cmd, &msg_ack, pid);
|
||||
|
||||
if (msg_ack.content.ptr != (char *)(&ack) ||
|
||||
msg_ack.type != NETAPI_MSG_TYPE ||
|
||||
ack.type != NETAPI_CMD_ACK ||
|
||||
ack.orig != cmd->type) {
|
||||
DEBUG("msg_ack.content.ptr = %p and &ack = %p must be equal.\n",
|
||||
msg_ack.content.ptr, &ack);
|
||||
|
||||
return -ENOMSG;
|
||||
}
|
||||
|
||||
ack_result = ack.result;
|
||||
|
||||
return ack_result;
|
||||
}
|
||||
|
||||
int netapi_send_packet(kernel_pid_t pid, netdev_hlist_t *upper_layer_hdrs,
|
||||
void *addr, size_t addr_len, void *data, size_t data_len)
|
||||
{
|
||||
netapi_snd_pkt_t pkt;
|
||||
|
||||
pkt.type = NETAPI_CMD_SND;
|
||||
|
||||
pkt.ulh = upper_layer_hdrs;
|
||||
pkt.dest = addr;
|
||||
pkt.dest_len = addr_len;
|
||||
pkt.data = data;
|
||||
pkt.data_len = data_len;
|
||||
|
||||
return netapi_send_command(pid, (netapi_cmd_t *)(&pkt));
|
||||
}
|
||||
|
||||
static unsigned int _get_set_option(kernel_pid_t pid, netapi_cmd_type_t type,
|
||||
netapi_conf_type_t param, void *data,
|
||||
size_t data_len)
|
||||
{
|
||||
netapi_conf_t conf;
|
||||
|
||||
conf.type = type;
|
||||
conf.param = param;
|
||||
conf.data = data;
|
||||
conf.data_len = data_len;
|
||||
|
||||
return netapi_send_command(pid, (netapi_cmd_t *)(&conf));
|
||||
}
|
||||
|
||||
int netapi_get_option(kernel_pid_t pid, netapi_conf_type_t param,
|
||||
void *data, size_t data_len)
|
||||
{
|
||||
return _get_set_option(pid, NETAPI_CMD_GET, param, data, data_len);
|
||||
}
|
||||
|
||||
int netapi_set_option(kernel_pid_t pid, netapi_conf_type_t param,
|
||||
void *data, size_t data_len)
|
||||
{
|
||||
return _get_set_option(pid, NETAPI_CMD_SET, param, data, data_len);
|
||||
}
|
||||
|
||||
static int _netapi_register_cmd(kernel_pid_t pid, netapi_cmd_type_t cmd,
|
||||
kernel_pid_t reg_pid, netapi_reg_demux_ctx_t demux_ctx)
|
||||
{
|
||||
netapi_reg_t reg;
|
||||
|
||||
reg.type = cmd;
|
||||
reg.reg_pid = reg_pid;
|
||||
reg.demux_ctx = demux_ctx;
|
||||
|
||||
return netapi_send_command(pid, (netapi_cmd_t *)(®));
|
||||
}
|
||||
|
||||
int netapi_register(kernel_pid_t pid, kernel_pid_t reg_pid,
|
||||
netapi_reg_demux_ctx_t demux_ctx)
|
||||
{
|
||||
return _netapi_register_cmd(pid, NETAPI_CMD_REG, reg_pid, demux_ctx);
|
||||
}
|
||||
|
||||
int netapi_unregister(kernel_pid_t pid, kernel_pid_t reg_pid)
|
||||
{
|
||||
return _netapi_register_cmd(pid, NETAPI_CMD_UNREG, reg_pid, 0);
|
||||
}
|
||||
|
||||
#ifdef MODULE_NETDEV_DUMMY
|
||||
int netapi_fire_receive_event(kernel_pid_t pid, void *src, size_t src_len,
|
||||
void *dest, size_t dest_len, void *data,
|
||||
size_t data_len)
|
||||
{
|
||||
netapi_rcv_pkt_t pkt;
|
||||
|
||||
pkt.type = NETAPI_CMD_FIRE_RCV;
|
||||
|
||||
pkt.src = src;
|
||||
pkt.src_len = src_len;
|
||||
pkt.dest = dest;
|
||||
pkt.dest_len = dest_len;
|
||||
pkt.data = data;
|
||||
pkt.data_len = data_len;
|
||||
|
||||
return netapi_send_command(pid, (netapi_cmd_t *)(&pkt));
|
||||
}
|
||||
#endif
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
|
@ -1,547 +0,0 @@
|
|||
/*
|
||||
* Copyright (C) 2014 Freie Universität Berlin
|
||||
*
|
||||
* This file is subject to the terms and conditions of the GNU Lesser
|
||||
* General Public License v2.1. See the file LICENSE in the top level
|
||||
* directory for more details.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup netapi Basic network interface
|
||||
* @ingroup net
|
||||
* @brief Basic general interface to communicate with a network protocol.
|
||||
* @details The idea of this module is that every network layer provides
|
||||
* a basic set of commands to communicate with its lower and
|
||||
* upper layer and the system. In this model every layer has some
|
||||
* sort of control thread with which the other layers and the system
|
||||
* communicates (illustrated as cohesive boxes below).
|
||||
*
|
||||
* +-----+ +-----+ +-----+
|
||||
* | App | | App | | App |
|
||||
* +-----+ +-----+ +-----+
|
||||
* ^ ^ ^
|
||||
* netapi netapi netapi // alternatively the normal socket API
|
||||
* v v v
|
||||
* +--------------------------+
|
||||
* | Socket | Socket | Socket |
|
||||
* | Transport layer |
|
||||
* +--------------------------+
|
||||
* ^
|
||||
* netapi
|
||||
* v
|
||||
* +--------------------------+
|
||||
* | Network layer |
|
||||
* +--------------------------+
|
||||
* ^ ^ ^
|
||||
* netapi netapi netapi
|
||||
* v v v
|
||||
* +-------+ +-------+ +-------+
|
||||
* | MAC | | MAC | | MAC |
|
||||
* +-------+ +-------+ +-------+
|
||||
* | Radio | | Radio | | Radio |
|
||||
* +-------+ +-------+ +-------+
|
||||
*
|
||||
* @{
|
||||
*
|
||||
* @file
|
||||
* @brief Basic general interface to communicate with a network layer.
|
||||
*
|
||||
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
|
||||
*/
|
||||
|
||||
#ifndef __NETAPI_H_
|
||||
#define __NETAPI_H_
|
||||
|
||||
#include <stdlib.h>
|
||||
|
||||
#include "kernel.h"
|
||||
#include "netdev/base.h"
|
||||
#include "thread.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Definition for value of successful result for @ref NETAPI_CMD_ACK.
|
||||
*/
|
||||
#define NETAPI_STATUS_OK (0)
|
||||
|
||||
/**
|
||||
* @brief Definition of type value for msg_t type field.
|
||||
*/
|
||||
#define NETAPI_MSG_TYPE (0x0200)
|
||||
|
||||
/**
|
||||
* @brief Basic communication types with a network layer.
|
||||
* @details This list may be expanded by a some layer (using values
|
||||
* > `SND_PKT + 4`), but no guarantee can be given, that other layers
|
||||
* interpret it exactly as the former. The values are chosen to be
|
||||
* as compatible as possible with the legacy tranceiver module.
|
||||
*/
|
||||
typedef enum {
|
||||
NETAPI_CMD_RCV, /**< Packet was received from lower layer. */
|
||||
NETAPI_CMD_SND, /**< Packet was send from upper layer or is send from
|
||||
* this layer to lower layer. */
|
||||
NETAPI_CMD_GET, /**< Get an option of this layer. */
|
||||
NETAPI_CMD_SET, /**< Set an option of this layer. */
|
||||
/**
|
||||
* @brief Registers an upper layer control thread to this layer for
|
||||
* receiving.
|
||||
*
|
||||
* @details If there is no space left in the control threads registry,
|
||||
* the result of the acknowledgement must be errno -ENOBUFS.
|
||||
*/
|
||||
NETAPI_CMD_REG,
|
||||
/**
|
||||
* @brief Unregisteres a previously receiving upper layer control thread
|
||||
* to this layer.
|
||||
*
|
||||
* @details Control thread does not need to notify, if the thread in
|
||||
* question was previously known. Unknown PIDs are just ignored.
|
||||
*/
|
||||
NETAPI_CMD_UNREG,
|
||||
NETAPI_CMD_ACK, /**< Acknowledges to a previous command. */
|
||||
|
||||
#ifdef MODULE_NETDEV_DUMMY /* commands for testing */
|
||||
/**
|
||||
* @brief Fires a receive event in the control thread via
|
||||
* unittest_netdev_dummy_fire_rcv_event, iff it handles a
|
||||
* netdev_dummy testing device.
|
||||
*
|
||||
* @details Use this command with the netapi_rcv_pkt_t command type.
|
||||
*/
|
||||
NETAPI_CMD_FIRE_RCV,
|
||||
#endif
|
||||
} netapi_cmd_type_t;
|
||||
|
||||
/**
|
||||
* @brief Basic configuration types for a network layer.
|
||||
* @details Developers of new network protocols are adviced to choose new more
|
||||
* specific names for this values in the specific layer (e. g.
|
||||
* NETAPI_CONF_ADDRESS may be called something port-related in
|
||||
* the Transport layer).
|
||||
* Layer specific options might also be defined.
|
||||
* The values are chosen to be as compatible as possible with the
|
||||
* legacy tranceiver module.
|
||||
* Every protocol must supply the format of the types for this options
|
||||
* but interpret them **always optimisticly**.
|
||||
*
|
||||
* A protocol should at least always answer with an acknowledgement of
|
||||
* result @ref netapi NETAPI_STATUS_OK if the operation was
|
||||
* successfull or with errno -ENOTSUP if the operation is not
|
||||
* supported.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* @brief Set or get the protocol for the layer as of type netdev_proto_t.
|
||||
*/
|
||||
NETAPI_CONF_PROTO = NETDEV_OPT_PROTO,
|
||||
|
||||
/**
|
||||
* @brief Set or get a carrier for the layer (e. g. channel in radios or
|
||||
* L3 protocol for transport layer) as unsigned value.
|
||||
*/
|
||||
NETAPI_CONF_CARRIER = NETDEV_OPT_CHANNEL,
|
||||
|
||||
/**
|
||||
* @brief Set or get a address for the layer (e. g. address in network
|
||||
* or link layer, port in transport layer, ...) as unsigned value
|
||||
* or array of unsigned values.
|
||||
*/
|
||||
NETAPI_CONF_ADDRESS = NETDEV_OPT_ADDRESS,
|
||||
|
||||
/**
|
||||
* @brief Set or get a sub-nets for the layer (e. g. sub-net in IPv4,
|
||||
* prefixes in IPv6, PAN id in IEEE 802.15.4).
|
||||
*/
|
||||
NETAPI_CONF_SUBNETS = NETDEV_OPT_NID,
|
||||
|
||||
/**
|
||||
* @brief Set or get the maximum packet size for the layer.
|
||||
*/
|
||||
NETAPI_CONF_MAX_PACKET_SIZE = NETDEV_OPT_MAX_PACKET_SIZE,
|
||||
|
||||
/**
|
||||
* @brief Set or get default address length.
|
||||
*/
|
||||
NETAPI_CONF_SRC_LEN = NETDEV_OPT_SRC_LEN,
|
||||
|
||||
/** @brief Get (for setting always use NETAPI_CMD_REG and NETAPI_CMD_UNREG)
|
||||
* all PIDs of currently registered threads as array of
|
||||
* @ref kernel_pid_t.
|
||||
*/
|
||||
NETAPI_CONF_REGISTRY = NETDEV_OPT_LAST,
|
||||
} netapi_conf_type_t;
|
||||
|
||||
/**
|
||||
* @brief Basic message definition.
|
||||
*/
|
||||
typedef struct {
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
netapi_cmd_type_t type; /**< Type of the command. */
|
||||
} netapi_msg_t;
|
||||
|
||||
/**
|
||||
* @brief Message definition for acknowledgements.
|
||||
* @extends netapi_msg_t
|
||||
*/
|
||||
typedef struct {
|
||||
netapi_cmd_type_t type; /**< Type of the message. Must be NETAPI_CMD_ACK. */
|
||||
|
||||
netapi_cmd_type_t orig; /**< Originating command type of this acknowledgement.
|
||||
* Must not be NETAPI_CMD_ACK. */
|
||||
/**
|
||||
* @brief Result code of the originating command.
|
||||
* @details Valid values are NETAPI_STATUS_OK or a fitting negative
|
||||
* <a href="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html">
|
||||
* errno</a> value in case of error. If an operation is not supported
|
||||
* the control thread **must** answer with result of errno -ENOTSUP.
|
||||
* Furthermore, in case of NETAPI_CMD_SND, NETAPI_CMD_RCV, or
|
||||
* NETAPI_CMD_GET, this value needs to be the actual length of
|
||||
* the data send or received respectively.
|
||||
*/
|
||||
int result;
|
||||
} netapi_ack_t;
|
||||
|
||||
/**
|
||||
* @brief Basic command definition.
|
||||
* @extends netapi_msg_t
|
||||
*/
|
||||
typedef struct {
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
netapi_cmd_type_t type; /**< Type of the command. Must not be NETAPI_CMD_ACK. */
|
||||
netapi_ack_t *ack; /**< Pointer to where the acknowledgement to this
|
||||
message is stored. Must not be NULL. */
|
||||
} netapi_cmd_t;
|
||||
|
||||
/**
|
||||
* @brief Command definition for receiving packets.
|
||||
* @extends netapi_cmd_t
|
||||
*/
|
||||
typedef struct {
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
netapi_cmd_type_t type; /**< Type of the command. Must be NETAPI_CMD_RCV. */
|
||||
netapi_ack_t *ack; /**< Pointer to where the acknowledgement to this
|
||||
message is stored. Must not be NULL. */
|
||||
void *src; /**< Source address for this message. */
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
size_t src_len; /**< Length of netapi_rcv_pkt_t::src. */
|
||||
void *dest; /**< Destination address for this message. */
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
size_t dest_len; /**< Length of netapi_rcv_pkt_t::dest. */
|
||||
void *data; /**< Data of the packet. */
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
size_t data_len; /**< Buffer length of netapi_rcv_pkt_t::data
|
||||
* (set to maximum available space when sending
|
||||
* to control thread, the control thread
|
||||
* **must** check this). */
|
||||
} netapi_rcv_pkt_t;
|
||||
|
||||
/**
|
||||
* @brief Command definition for sending packets.
|
||||
* @extends netapi_cmd_t
|
||||
*
|
||||
* @details The netapi_snd_pkt_t::ulh will be prepended
|
||||
* to the data stream on the lowest level (usually
|
||||
* by the driver, but adaption layers as 6LoWPAN might
|
||||
* also prepend headers).
|
||||
*/
|
||||
typedef struct {
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
netapi_cmd_type_t type; /**< Type of the command. Must be NETAPI_CMD_SND. */
|
||||
netapi_ack_t *ack; /**< Pointer to where the acknowledgement to this
|
||||
* message is stored. Must not be NULL. */
|
||||
netdev_hlist_t *ulh; /**< Headers of upper layers; lowest first, highest last.
|
||||
* May be NULL if none exist. */
|
||||
void *dest; /**< Destination address for this message. */
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
size_t dest_len; /**< Length of netapi_snd_pkt_t::dest. */
|
||||
/**
|
||||
* @brief Data of the packet (without upper layer headers).
|
||||
*
|
||||
* @see netapi_snd_pkt_t::upper_layer_hdrs
|
||||
*/
|
||||
void *data;
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
size_t data_len; /**< Length of netapi_snd_pkt_t::data. */
|
||||
} netapi_snd_pkt_t;
|
||||
|
||||
/**
|
||||
* @brief Command definition for getting and setting packets.
|
||||
* @extends netapi_cmd_t
|
||||
*/
|
||||
typedef struct {
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
netapi_cmd_type_t type; /**< Type of the command. Must be either
|
||||
* NETAPI_CMD_GET or NETAPI_CMD_SET. */
|
||||
netapi_ack_t *ack; /**< Pointer to where the acknowledgement to this
|
||||
* message is stored. Must not be NULL. */
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
netapi_conf_type_t param; /**< Parameter type. */
|
||||
|
||||
/**
|
||||
* @brief Data of the parameter.
|
||||
* @details In case of NETAPI_CMD_GET the data will be written here
|
||||
* by the addressed layer, in case of NETAPI_CMD_SET the data
|
||||
* want to set must be written here (if not specified otherwise).
|
||||
*/
|
||||
void *data;
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
size_t data_len; /**< Length of netapi_conf_t::data. */
|
||||
} netapi_conf_t;
|
||||
|
||||
/**
|
||||
* @brief Type for demultiplexing context of registration command.
|
||||
* @note Introduce own type for easy upscaling in the future
|
||||
*/
|
||||
typedef uint16_t netapi_reg_demux_ctx_t;
|
||||
|
||||
/**
|
||||
* @brief Command definition for upper layer registration.
|
||||
* @extends netapi_cmd_t
|
||||
*/
|
||||
typedef struct {
|
||||
/* cppcheck-suppress unusedStructMember because interface is not used yet */
|
||||
netapi_cmd_type_t type; /**< Type of the command. Must be NETAPI_CMD_REG or
|
||||
* NETAPI_CMD_UNREG. */
|
||||
netapi_ack_t *ack; /**< Pointer to where the acknowledgement to this
|
||||
* message is stored. Must not be NULL. */
|
||||
kernel_pid_t reg_pid; /**< The PID of the upper layer thread you want
|
||||
* to (un)register. If the PID is duplicate /
|
||||
* was not known it is silently ignored. */
|
||||
/**
|
||||
* @brief Protocol specific context information for demultiplex (e.g. next
|
||||
* header value in IP, port in UDP/TCP, etc).
|
||||
*
|
||||
* @details For NETAPI_CMD_UNREG this field is always ignored. Some protocols
|
||||
* might also ignore it silently on NETAPI_CMD_REG.
|
||||
*/
|
||||
netapi_reg_demux_ctx_t demux_ctx;
|
||||
} netapi_reg_t;
|
||||
|
||||
|
||||
#ifdef MODULE_TRANSCEIVER
|
||||
/**
|
||||
* @brief PID for a netapi layer, when used with the transceiver module.
|
||||
*
|
||||
* @details This variable is only needed, iff this definitions are used with
|
||||
* the transceiver module in legacy applications. Needs to be set
|
||||
* externaly (e. g. the layer, that uses netapi). Guard it against
|
||||
* other layers using netapi with the transceiver with
|
||||
* the macro `HAS_NETAPI_PID`, the transceiver module will check
|
||||
* if it is there and only than allow adapter capabilities. Since
|
||||
* only one netapi layer can be used with this hack, it is
|
||||
* advised to let only layers below network layer use this.
|
||||
*/
|
||||
extern kernel_pid_t netapi_pid;
|
||||
#endif /* MODULE_TRANSCEIVER */
|
||||
|
||||
#ifdef MODULE_NETAPI /* Only include if module netapi is compiled */
|
||||
/**
|
||||
* @brief Sends a command to a protocol's control thread.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] cmd The command you like to send.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
int netapi_send_command(kernel_pid_t pid, netapi_cmd_t *cmd);
|
||||
|
||||
/**
|
||||
* @brief Sends data over a protocol layer identified by *pid* with upper layer
|
||||
* information attached.
|
||||
*
|
||||
* @note Wraps IPC call of NETAPI_CMD_SND.
|
||||
*
|
||||
* @details The upper layer information will be prepended
|
||||
* on the lowest possible level.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] upper_layer_hdrs Headers of upper layer protocols, lowest layer
|
||||
* first, highest layer last.
|
||||
* @param[in] addr The address you want the data send to. If the control
|
||||
* thread knows for some reason where to send the data
|
||||
* (e.g. a connected TCP socket), *addr* may be NULL.
|
||||
* @param[in] addr_len Length of *addr*. If the control thread knows for some
|
||||
* reason where to send the data (e.g. a connected TCP
|
||||
* socket), *addr_len* may be 0.
|
||||
* @param[in] data The data you want to send over the protocol layer
|
||||
* controled by *pid* (without upper layer protocol
|
||||
* information).
|
||||
* @param[in] data_len Length of *data_len*.
|
||||
*
|
||||
* @see netapi_snd_pkt_t
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
int netapi_send_packet(kernel_pid_t pid, netdev_hlist_t *upper_layer_hdrs,
|
||||
void *addr, size_t addr_len, void *data,
|
||||
size_t data_len);
|
||||
|
||||
/**
|
||||
* @brief Sends data over a protocol layer identified by *pid*.
|
||||
*
|
||||
* @note Wraps IPC call of NETAPI_CMD_SND with `netapi_snd_pkt_t::ulh == NULL`.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] addr The address you want the data send to. If the control
|
||||
* thread knows for some reason where to send the data
|
||||
* (e.g. a connected TCP socket), *addr* may be NULL.
|
||||
* @param[in] addr_len Length of *addr*. If the control thread knows for some
|
||||
* reason where to send the data (e.g. a connected TCP
|
||||
* socket), *addr_len* may be 0.
|
||||
* @param[in] data The data you want to send over the protocol layer
|
||||
* controled by *pid*.
|
||||
* @param[in] data_len Length of *data_len*.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
static inline int netapi_send_payload(kernel_pid_t pid, void *addr,
|
||||
size_t addr_len, void *data,
|
||||
size_t data_len)
|
||||
{
|
||||
return netapi_send_packet(pid, NULL, addr, addr_len, data, data_len);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Get an option of a protocol layer identified by *pid*.
|
||||
*
|
||||
* @note Wraps IPC call of NETAPI_CMD_GET.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] data Buffer you want to store *param*'s' data in.
|
||||
* @param[in] data_len Length of *data*, must be initialized with
|
||||
* the original length of *data*.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
int netapi_get_option(kernel_pid_t pid, netapi_conf_type_t param,
|
||||
void *data, size_t data_len);
|
||||
|
||||
/**
|
||||
* @brief Set an option of a protocol layer identified by *pid*.
|
||||
*
|
||||
* @note Wraps IPC call of NETAPI_CMD_SET.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] data Buffer with the data you want to set *param* to.
|
||||
* @param[in] data_len Length of *data*.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
int netapi_set_option(kernel_pid_t pid, netapi_conf_type_t param,
|
||||
void *data, size_t data_len);
|
||||
|
||||
/**
|
||||
* @brief Register an upper layer control thread for reception to a protocol
|
||||
* layer identified by *pid*.
|
||||
*
|
||||
* @note Wraps IPC call of NETAPI_CMD_REG.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] reg_pid The PID of the upper layer protocol's control thread.
|
||||
* @param[in] demux_ctx Protocol specific demuxing context.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
int netapi_register(kernel_pid_t pid, kernel_pid_t reg_pid,
|
||||
netapi_reg_demux_ctx_t demux_ctx);
|
||||
|
||||
/**
|
||||
* @brief Registers the current thread as upper layer control thread for
|
||||
* reception to a protocol layer identified by *pid*.
|
||||
*
|
||||
* @note Wraps IPC call of NETAPI_CMD_REG with
|
||||
* `netapi_reg_t::reg_pid == thread_getpid()`.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] demux_ctx Protocol specific demuxing context.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
static inline int netapi_register_current_thread(kernel_pid_t pid,
|
||||
netapi_reg_demux_ctx_t demux_ctx)
|
||||
{
|
||||
return netapi_register(pid, thread_getpid(), demux_ctx);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Unregister an upper layer control thread for reception to a protocol
|
||||
* layer identified by *pid*.
|
||||
*
|
||||
* @note Wraps IPC call of NETAPI_CMD_UNREG.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] reg_pid The PID of the upper layer protocol's control thread.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
int netapi_unregister(kernel_pid_t pid, kernel_pid_t reg_pid);
|
||||
|
||||
/**
|
||||
* @brief Unregisters the current thread as upper layer control thread for
|
||||
* reception to a protocol layer identified by *pid*.
|
||||
*
|
||||
* @note Wraps IPC call of NETAPI_CMD_UNREG with
|
||||
* `netapi_reg_t::reg_pid == thread_getpid()`.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
static inline int netapi_unregister_current_thread(kernel_pid_t pid)
|
||||
{
|
||||
return netapi_unregister(pid, thread_getpid());
|
||||
}
|
||||
|
||||
#ifdef MODULE_NETDEV_DUMMY
|
||||
/**
|
||||
* @brief Fire receive event in the control thread via
|
||||
* @ref unittest_netdev_dummy_fire_rcv_event, iff it handles a
|
||||
* netdev_dummy testing device.
|
||||
*
|
||||
* @param[in] pid The PID of the protocol's control thread.
|
||||
* @param[in] src Source address of the received packet.
|
||||
* @param[in] src_len Length of *src*.
|
||||
* @param[in] dest Destination address of the received packet.
|
||||
* @param[in] dest_len Length of *dest*.
|
||||
* @param[in] data Content of the received packet.
|
||||
* @param[in] data_len Length of *data*.
|
||||
*
|
||||
* @return result of the acknowledgement.
|
||||
* @return -ENOMSG if wrong acknowledgement was received or was no
|
||||
* acknowledgement at all.
|
||||
*/
|
||||
int netapi_fire_receive_event(kernel_pid_t pid, void *src, size_t src_len,
|
||||
void *dest, size_t dest_len, void *data,
|
||||
size_t data_len);
|
||||
#endif /* MODULE_NETDEV_DUMMY */
|
||||
#endif /* MODULE_NETAPI */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* __NETAPI_H_ */
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
Loading…
Reference in New Issue