pcap_driver.h File Reference

PCAP driver. More...

#include "core/nic.h"

Go to the source code of this file.

Macros
#define	PCAP_DRIVER_MAX_PACKET_SIZE   1536
#define	PCAP_DRIVER_QUEUE_SIZE   64
#define	PCAP_DRIVER_TIMEOUT   1

Functions
error_t	pcapDriverInit (NetInterface *interface)
	PCAP driver initialization. More...
void	pcapDriverTick (NetInterface *interface)
	PCAP timer handler. More...
void	pcapDriverEnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	pcapDriverDisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	pcapDriverEventHandler (NetInterface *interface)
	PCAP event handler. More...
error_t	pcapDriverSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	pcapDriverUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...
void	pcapDriverTask (NetInterface *interface)
	PCAP receive task. More...

Variables
const NicDriver	pcapDriver
	PCAP driver. More...

Detailed Description

PCAP 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 pcap_driver.h.

Macro Definition Documentation

PCAP_DRIVER_MAX_PACKET_SIZE

#define PCAP_DRIVER_MAX_PACKET_SIZE   1536

Definition at line 39 of file pcap_driver.h.

PCAP_DRIVER_QUEUE_SIZE

#define PCAP_DRIVER_QUEUE_SIZE   64

Definition at line 46 of file pcap_driver.h.

PCAP_DRIVER_TIMEOUT

#define PCAP_DRIVER_TIMEOUT   1

Definition at line 53 of file pcap_driver.h.

Function Documentation

pcapDriverDisableIrq()

void pcapDriverDisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 363 of file pcap_driver.c.

pcapDriverEnableIrq()

void pcapDriverEnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 352 of file pcap_driver.c.

pcapDriverEventHandler()

void pcapDriverEventHandler

(

NetInterface *

interface

)

PCAP event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 374 of file pcap_driver.c.

pcapDriverInit()

error_t pcapDriverInit

(

NetInterface *

interface

)

PCAP driver initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 109 of file pcap_driver.c.

pcapDriverSendPacket()

error_t pcapDriverSendPacket	(	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 414 of file pcap_driver.c.

pcapDriverTask()

void pcapDriverTask

(

NetInterface *

interface

)

PCAP receive task.

Parameters

[in]

interface

Underlying network interface

Definition at line 476 of file pcap_driver.c.

pcapDriverTick()

void pcapDriverTick

(

NetInterface *

interface

)

PCAP 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 341 of file pcap_driver.c.

pcapDriverUpdateMacAddrFilter()

error_t pcapDriverUpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 464 of file pcap_driver.c.

Variable Documentation

pcapDriver

const NicDriver pcapDriver

extern

PCAP driver.

Definition at line 82 of file pcap_driver.c.