mrf24wg_driver.h File Reference

MRF24WG Wi-Fi controller. More...

#include "core/nic.h"

Go to the source code of this file.

Data Structures
struct	Mrf24wgBuffer
	TX buffer. More...

Macros
#define	MRF24WG_TX_BUFFER_SIZE   1536
#define	MRF24WG_RX_BUFFER_SIZE   1536

Functions
error_t	mrf24wgInit (NetInterface *interface)
	MRF24WG initialization. More...
void	mrf24wgTick (NetInterface *interface)
	MRF24WG timer handler. More...
void	mrf24wgEnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	mrf24wgDisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	mrf24wgEventHandler (NetInterface *interface)
	MRF24WG event handler. More...
error_t	mrf24wgSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	mrf24wgUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...
void	mrf24wgAppWifiEvent (uint8_t msgType, void *msg)
void	mrf24wgAppEthEvent (uint8_t msgType, void *msg, void *ctrlBuf)

Variables
const NicDriver	mrf24wgDriver
	MRF24WG driver. More...

Detailed Description

MRF24WG Wi-Fi controller.

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.4

Definition in file mrf24wg_driver.h.

Macro Definition Documentation

MRF24WG_RX_BUFFER_SIZE

#define MRF24WG_RX_BUFFER_SIZE   1536

Definition at line 46 of file mrf24wg_driver.h.

MRF24WG_TX_BUFFER_SIZE

#define MRF24WG_TX_BUFFER_SIZE   1536

Definition at line 39 of file mrf24wg_driver.h.

Function Documentation

mrf24wgAppEthEvent()

void mrf24wgAppEthEvent	(	uint8_t	msgType,
		void *	msg,
		void *	ctrlBuf
	)

mrf24wgAppWifiEvent()

void mrf24wgAppWifiEvent	(	uint8_t	msgType,
		void *	msg
	)

mrf24wgDisableIrq()

void mrf24wgDisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 134 of file mrf24wg_driver.c.

mrf24wgEnableIrq()

void mrf24wgEnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 124 of file mrf24wg_driver.c.

mrf24wgEventHandler()

void mrf24wgEventHandler

(

NetInterface *

interface

)

MRF24WG event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 144 of file mrf24wg_driver.c.

mrf24wgInit()

error_t mrf24wgInit

(

NetInterface *

interface

)

MRF24WG initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 83 of file mrf24wg_driver.c.

mrf24wgSendPacket()

error_t mrf24wgSendPacket	(	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 159 of file mrf24wg_driver.c.

mrf24wgTick()

void mrf24wgTick

(

NetInterface *

interface

)

MRF24WG 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 114 of file mrf24wg_driver.c.

mrf24wgUpdateMacAddrFilter()

error_t mrf24wgUpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 233 of file mrf24wg_driver.c.

Variable Documentation

mrf24wgDriver

const NicDriver mrf24wgDriver

extern

MRF24WG driver.

Definition at line 56 of file mrf24wg_driver.c.