loopback_driver.h File Reference

Loopback interface driver. More...

#include "core/nic.h"

Go to the source code of this file.

Data Structures
struct	LoopbackDriverQueueEntry
	Loopback interface queue entry. More...

Macros
#define	LOOPBACK_DRIVER_QUEUE_SIZE   6

Functions
error_t	loopbackDriverInit (NetInterface *interface)
	Loopback interface initialization. More...
void	loopbackDriverTick (NetInterface *interface)
	Loopback interface timer handler. More...
void	loopbackDriverEnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	loopbackDriverDisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	loopbackDriverEventHandler (NetInterface *interface)
	Loopback interface event handler. More...
error_t	loopbackDriverSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	loopbackDriverReceivePacket (NetInterface *interface)
	Receive a packet. More...
error_t	loopbackDriverUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...

Variables
const NicDriver	loopbackDriver
	Loopback interface driver. More...

Detailed Description

Loopback interface driver.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.0

Definition in file loopback_driver.h.

Macro Definition Documentation

LOOPBACK_DRIVER_QUEUE_SIZE

#define LOOPBACK_DRIVER_QUEUE_SIZE   6

Definition at line 39 of file loopback_driver.h.

Function Documentation

loopbackDriverDisableIrq()

void loopbackDriverDisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 131 of file loopback_driver.c.

loopbackDriverEnableIrq()

void loopbackDriverEnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 120 of file loopback_driver.c.

loopbackDriverEventHandler()

void loopbackDriverEventHandler

(

NetInterface *

interface

)

Loopback interface event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 142 of file loopback_driver.c.

loopbackDriverInit()

error_t loopbackDriverInit

(

NetInterface *

interface

)

Loopback interface initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 78 of file loopback_driver.c.

loopbackDriverReceivePacket()

error_t loopbackDriverReceivePacket

(

NetInterface *

interface

)

Receive a packet.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 237 of file loopback_driver.c.

loopbackDriverSendPacket()

error_t loopbackDriverSendPacket	(	NetInterface *	interface,
		const NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Send a packet.

Parameters

[in]	interface	Underlying network interface
[in]	buffer	Multi-part buffer containing the data to send
[in]	offset	Offset to the first data byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns

Error code

Definition at line 177 of file loopback_driver.c.

loopbackDriverTick()

void loopbackDriverTick

(

NetInterface *

interface

)

Loopback interface timer handler.

This routine is periodically called by the TCP/IP stack to handle periodic operations such as polling the link state

Parameters

[in]

interface

Underlying network interface

Definition at line 109 of file loopback_driver.c.

loopbackDriverUpdateMacAddrFilter()

error_t loopbackDriverUpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 281 of file loopback_driver.c.

Variable Documentation

loopbackDriver

const NicDriver loopbackDriver

extern

Loopback interface driver.

Definition at line 51 of file loopback_driver.c.