winc3400_driver.h File Reference

WINC3400 Wi-Fi controller. More...

#include "core/nic.h"

Go to the source code of this file.

Macros
#define	WINC3400_TX_BUFFER_SIZE   1600
#define	WINC3400_RX_BUFFER_SIZE   1600

Functions
error_t	winc3400Init (NetInterface *interface)
	WINC3400 initialization. More...
void	winc3400Tick (NetInterface *interface)
	WINC3400 timer handler. More...
void	winc3400EnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	winc3400DisableIrq (NetInterface *interface)
	Disable interrupts. More...
bool_t	winc3400IrqHandler (void)
	WINC3400 interrupt service routine. More...
void	winc3400EventHandler (NetInterface *interface)
	WINC3400 event handler. More...
error_t	winc3400SendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	winc3400UpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...
void	winc3400AppWifiEvent (uint8_t msgType, void *msg)
	Callback function that handles Wi-Fi events. More...
void	winc3400AppEthEvent (uint8_t msgType, void *msg, void *ctrlBuf)
	Callback function that handles events in bypass mode. More...

Variables
const NicDriver	winc3400Driver
	WINC3400 driver. More...

Detailed Description

WINC3400 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 winc3400_driver.h.

Macro Definition Documentation

WINC3400_RX_BUFFER_SIZE

#define WINC3400_RX_BUFFER_SIZE   1600

Definition at line 46 of file winc3400_driver.h.

WINC3400_TX_BUFFER_SIZE

#define WINC3400_TX_BUFFER_SIZE   1600

Definition at line 39 of file winc3400_driver.h.

Function Documentation

winc3400AppEthEvent()

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

Callback function that handles events in bypass mode.

Parameters

[in]	msgType	Type of notification
[in]	msg	Pointer to the buffer containing the notification parameters
[in]	ctrlBuf	Pointer to the control buffer

Definition at line 399 of file winc3400_driver.c.

winc3400AppWifiEvent()

void winc3400AppWifiEvent	(	uint8_t	msgType,
		void *	msg
	)

Callback function that handles Wi-Fi events.

Parameters

[in]	msgType	Type of notification
[in]	msg	Pointer to the buffer containing the notification parameters

Definition at line 349 of file winc3400_driver.c.

winc3400DisableIrq()

void winc3400DisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 202 of file winc3400_driver.c.

winc3400EnableIrq()

void winc3400EnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 192 of file winc3400_driver.c.

winc3400EventHandler()

void winc3400EventHandler

(

NetInterface *

interface

)

WINC3400 event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 234 of file winc3400_driver.c.

winc3400Init()

error_t winc3400Init

(

NetInterface *

interface

)

WINC3400 initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 81 of file winc3400_driver.c.

winc3400IrqHandler()

bool_t winc3400IrqHandler

(

void

)

WINC3400 interrupt service routine.

Returns

TRUE if a higher priority task must be woken. Else FALSE is returned

Definition at line 212 of file winc3400_driver.c.

winc3400SendPacket()

error_t winc3400SendPacket	(	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 251 of file winc3400_driver.c.

winc3400Tick()

void winc3400Tick

(

NetInterface *

interface

)

WINC3400 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 182 of file winc3400_driver.c.

winc3400UpdateMacAddrFilter()

error_t winc3400UpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 305 of file winc3400_driver.c.

Variable Documentation

winc3400Driver

const NicDriver winc3400Driver

extern

WINC3400 driver.

Definition at line 54 of file winc3400_driver.c.