pcap_driver.h
Go to the documentation of this file.
1 /**
2  * @file pcap_driver.h
3  * @brief PCAP driver
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.6
29  **/
30 
31 #ifndef _PCAP_DRIVER_H
32 #define _PCAP_DRIVER_H
33 
34 //Dependencies
35 #include "core/nic.h"
36 
37 //Maximum packet size
38 #ifndef PCAP_DRIVER_MAX_PACKET_SIZE
39  #define PCAP_DRIVER_MAX_PACKET_SIZE 1536
40 #elif (PCAP_DRIVER_MAX_PACKET_SIZE < 1)
41  #error PCAP_DRIVER_MAX_PACKET_SIZE parameter is not valid
42 #endif
43 
44 //Maximum number of packets in the receive queue
45 #ifndef PCAP_DRIVER_QUEUE_SIZE
46  #define PCAP_DRIVER_QUEUE_SIZE 64
47 #elif (PCAP_DRIVER_QUEUE_SIZE < 1)
48  #error PCAP_DRIVER_QUEUE_SIZE parameter is not valid
49 #endif
50 
51 //Receive timeout in milliseconds
52 #ifndef PCAP_DRIVER_TIMEOUT
53  #define PCAP_DRIVER_TIMEOUT 1
54 #elif (PCAP_DRIVER_TIMEOUT < 1)
55  #error PCAP_DRIVER_TIMEOUT parameter is not valid
56 #endif
57 
58 //C++ guard
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62 
63 //PCAP driver
64 extern const NicDriver pcapDriver;
65 
66 //PCAP related functions
68 
69 void pcapDriverTick(NetInterface *interface);
70 
71 void pcapDriverEnableIrq(NetInterface *interface);
72 void pcapDriverDisableIrq(NetInterface *interface);
73 
74 void pcapDriverEventHandler(NetInterface *interface);
75 
77  const NetBuffer *buffer, size_t offset);
78 
80 
81 void pcapDriverTask(NetInterface *interface);
82 
83 //C++ guard
84 #ifdef __cplusplus
85 }
86 #endif
87 
88 #endif
void pcapDriverTask(NetInterface *interface)
PCAP receive task.
Definition: pcap_driver.c:447
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:88
void pcapDriverTick(NetInterface *interface)
PCAP timer handler.
Definition: pcap_driver.c:322
void pcapDriverEnableIrq(NetInterface *interface)
Enable interrupts.
Definition: pcap_driver.c:333
const NicDriver pcapDriver
PCAP driver.
Definition: pcap_driver.c:82
error_t
Error codes.
Definition: error.h:42
error_t pcapDriverInit(NetInterface *interface)
PCAP driver initialization.
Definition: pcap_driver.c:109
#define NetInterface
Definition: net.h:36
error_t pcapDriverSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
Definition: pcap_driver.c:389
Network interface controller abstraction layer.
void pcapDriverEventHandler(NetInterface *interface)
PCAP event handler.
Definition: pcap_driver.c:355
NIC driver.
Definition: nic.h:179
error_t pcapDriverUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: pcap_driver.c:435
void pcapDriverDisableIrq(NetInterface *interface)
Disable interrupts.
Definition: pcap_driver.c:344