1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/cpu/native/include/netdev_tap.h
2022-12-22 17:57:25 +01:00

72 lines
2.1 KiB
C

/*
* 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 drivers_netdev
* @brief Low-level ethernet driver for native tap interfaces
* @{
*
* @file
* @brief Definitions for @ref netdev ethernet driver for host system's
* TAP interfaces
*
* @author Kaspar Schleiser <kaspar@schleiser.de>
*/
#ifndef NETDEV_TAP_H
#define NETDEV_TAP_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <stdbool.h>
#include "net/netdev.h"
#include "net/ethernet/hdr.h"
#include "net/if.h"
/**
* @brief tap interface state
*/
typedef struct netdev_tap {
netdev_t netdev; /**< netdev 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 */
bool promiscuous; /**< Flag for promiscuous mode */
bool wired; /**< Flag for wired mode */
} netdev_tap_t;
/**
* @brief tap interface initialization parameters
*/
typedef struct {
char **tap_name; /**< Name of the host system's tap
interface to bind to. */
bool wired; /**< Interface should behave like a
wired interface. */
} netdev_tap_params_t;
/**
* @brief Setup netdev_tap_t structure.
*
* @param dev the preallocated netdev_tap device handle to setup
* @param params initialization parameters
* @param index Index of @p params in a global parameter struct array.
* If initialized manually, pass a unique identifier instead.
*/
void netdev_tap_setup(netdev_tap_t *dev, const netdev_tap_params_t *params, int index);
#ifdef __cplusplus
}
#endif
/** @} */
#endif /* NETDEV_TAP_H */