1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/tests/net/gnrc_sock_ip/stack.h

119 lines
3.6 KiB
C

/*
* Copyright (C) 2016 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.
*/
/**
* @ingroup tests
* @brief
* @{
*
* @file
* @brief
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
* @}
*/
#ifndef STACK_H
#define STACK_H
#include <stdbool.h>
#include <stdint.h>
#include "net/ipv6/addr.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Initializes networking for tests
*/
void _net_init(void);
/**
* @brief Does what ever preparations are needed to check the packets sent
*/
void _prepare_send_checks(void);
/**
* @brief Structure containing auxiliary data to inject
*/
typedef struct {
uint64_t timestamp; /**< Timestamp of reception */
int16_t rssi; /**< Fake RSSI value */
} inject_aux_t;
/**
* @brief Injects a received IPv6 packet into the stack
*
* @param[in] src The source address of the IPv6 packet
* @param[in] dst The destination address of the IPv6 packet
* @param[in] proto The next header field of the IPv6 packet
* @param[in] data The payload of the IPv6 packet
* @param[in] data_len The payload length of the IPv6 packet
* @param[in] netif The interface the packet came over
* @param[in] aux Auxiliary data to inject
*
* @return true, if packet was successfully injected
* @return false, if an error occurred during injection
*/
bool _inject_packet_aux(const ipv6_addr_t *src, const ipv6_addr_t *dst,
uint8_t proto, void *data, size_t data_len,
uint16_t netif, const inject_aux_t *aux);
/**
* @brief Injects a received IPv6 packet into the stack
*
* @param[in] src The source address of the IPv6 packet
* @param[in] dst The destination address of the IPv6 packet
* @param[in] proto The next header field of the IPv6 packet
* @param[in] data The payload of the IPv6 packet
* @param[in] data_len The payload length of the IPv6 packet
* @param[in] netif The interface the packet came over
*
* @return true, if packet was successfully injected
* @return false, if an error occurred during injection
*/
static inline bool _inject_packet(const ipv6_addr_t *src,
const ipv6_addr_t *dst,
uint8_t proto, void *data, size_t data_len,
uint16_t netif)
{
return _inject_packet_aux(src, dst, proto, data, data_len, netif, NULL);
}
/**
* @brief Checks networking state (e.g. packet buffer state)
*
* @return true, if networking component is still in valid state
* @return false, if networking component is in an invalid state
*/
bool _check_net(void);
/**
* @brief Checks if a IPv6 packet was sent by the networking component
*
* @param[in] src Expected source address of the IPv6 packet
* @param[in] dst Expected destination address of the IPv6 packet
* @param[in] proto Expected next header field of the IPv6 packet
* @param[in] data Expected payload of the IPv6 packet
* @param[in] data_len Expected payload length of the IPv6 packet
* @param[in] netif Expected interface the packet is supposed to
* be send over
*
* @return true, if all parameters match as expected
* @return false, if not.
*/
bool _check_packet(const ipv6_addr_t *src, const ipv6_addr_t *dst,
uint8_t proto, void *data, size_t data_len, uint16_t netif);
#ifdef __cplusplus
}
#endif
#endif /* STACK_H */