/*
 * Copyright (C) 2015 Kaspar Schleiser <kaspar@schleiser.de>
 *
 * 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     netdev2
 * @brief       Low-level ethernet driver for native tap interfaces
 * @{
 *
 * @file
 * @brief       Definitions for @ref netdev2 ethernet driver for host system's
 *              TAP interfaces
 *
 * @author      Kaspar Schleiser <kaspar@schleiser.de>
 */
#ifndef NETDEV2_TAP_H
#define NETDEV2_TAP_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include "net/netdev2.h"

#include "net/ethernet/hdr.h"

#ifdef __MACH__
#include "net/if_var.h"
#else
#include "net/if.h"
#endif

/**
 * @brief tap interface state
 */
typedef struct netdev2_tap {
    netdev2_t netdev;                   /**< netdev2 internal member */
    char tap_name[IFNAMSIZ];            /**< host dev file name */
    int tap_fd;                         /**< host file descriptor for the TAP */
    uint8_t addr[ETHERNET_ADDR_LEN];    /**< The MAC address of the TAP */
    uint8_t promiscous;                 /**< Flag for promiscous mode */
} netdev2_tap_t;

/**
 * @brief tap interface initialization parameters
 */
typedef struct {
    char **tap_name;                    /**< Name of the host system's tap
                                             inteface to bind to. */
} netdev2_tap_params_t;

/**
 * @brief global device struct. driver only supports one tap device as of now.
 */
extern netdev2_tap_t netdev2_tap;

/**
 * @brief Setup netdev2_tap_t structure.
 *
 * @param dev       the preallocated netdev2_tap device handle to setup
 * @param params    initialization parameters
 */
void netdev2_tap_setup(netdev2_tap_t *dev, const netdev2_tap_params_t *params);

/**
 * @brief Cleanup tap resources
 *
 * @param dev  the netdev2_tap device handle to cleanup
 */
void netdev2_tap_cleanup(netdev2_tap_t *dev);

#ifdef __cplusplus
}
#endif
/** @} */
#endif /* NETDEV2_TAP_H */