/*
 * 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.
 */

/**
 * @defgroup
 * @ingroup
 * @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   Injects a received IPv4 packet into the stack
 *
 * @param[in] src       The source address of the IPv4 packet
 * @param[in] dst       The destination address of the IPv4 packet
 * @param[in] proto     The protocol field of the IPv4 packet
 * @param[in] data      The payload of the IPv4 packet
 * @param[in] data_len  The payload length of the IPv4 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
 */
bool _inject_4packet(uint32_t src, uint32_t dst, uint8_t proto, void *data,
                     size_t data_len, uint16_t netif);

/**
 * @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
 */
bool _inject_6packet(const ipv6_addr_t *src, const ipv6_addr_t *dst,
                     uint8_t proto, void *data, size_t data_len,
                     uint16_t netif);

/**
 * @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 IPv4 packet was sent by the networking component
 *
 * @param[in] src               Expected source address of the IPv4 packet
 * @param[in] dst               Expected destination address of the IPv4 packet
 * @param[in] proto             Expected next header field of the IPv4 packet
 * @param[in] data              Expected payload of the IPv4 packet
 * @param[in] data_len          Expected payload length of the IPv4 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_4packet(uint32_t src, uint32_t dst, uint8_t proto,
                    void *data, size_t data_len, uint16_t netif);

/**
 * @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_6packet(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 */
/** @} */
