loopback_driver.h
Go to the documentation of this file.
1 /**
2  * @file loopback_driver.h
3  * @brief Loopback interface 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.4
29  **/
30 
31 #ifndef _LOOPBACK_DRIVER_H
32 #define _LOOPBACK_DRIVER_H
33 
34 //Dependencies
35 #include "core/nic.h"
36 
37 //Queue size
38 #ifndef LOOPBACK_DRIVER_QUEUE_SIZE
39  #define LOOPBACK_DRIVER_QUEUE_SIZE 6
40 #elif (LOOPBACK_DRIVER_QUEUE_SIZE < 1)
41  #error LOOPBACK_DRIVER_QUEUE_SIZE parameter is not valid
42 #endif
43 
44 
45 /**
46  * @brief Loopback interface queue entry
47  **/
48 
49 typedef struct
50 {
51  size_t length;
52  uint8_t data[ETH_MTU];
54 
55 
56 //Loopback interface driver
57 extern const NicDriver loopbackDriver;
58 
59 //Loopback interface related functions
61 
62 void loopbackDriverTick(NetInterface *interface);
63 
64 void loopbackDriverEnableIrq(NetInterface *interface);
65 void loopbackDriverDisableIrq(NetInterface *interface);
67 
69  const NetBuffer *buffer, size_t offset);
70 
72 
74 
75 #endif
size_t length
error_t loopbackDriverUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
const NicDriver loopbackDriver
Loopback interface driver.
void loopbackDriverEnableIrq(NetInterface *interface)
Enable interrupts.
void loopbackDriverDisableIrq(NetInterface *interface)
Disable interrupts.
void loopbackDriverEventHandler(NetInterface *interface)
Loopback interface event handler.
Loopback interface queue entry.
error_t loopbackDriverReceivePacket(NetInterface *interface)
Receive a packet.
void loopbackDriverTick(NetInterface *interface)
Loopback interface timer handler.
NIC driver.
Definition: nic.h:179
error_t loopbackDriverInit(NetInterface *interface)
Loopback interface initialization.
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:88
#define ETH_MTU
Definition: ethernet.h:91
error_t loopbackDriverSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
error_t
Error codes.
Definition: error.h:42
uint8_t data[]
Definition: dtls_misc.h:169
#define NetInterface
Definition: net.h:36
Network interface controller abstraction layer.