WIZnet W5500 Ethernet controller. More...

#include "core/net.h"
#include "drivers/eth/w5500_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	w5500Init (NetInterface *interface)
	W5500 controller initialization. More...

__weak_func void	w5500InitHook (NetInterface *interface)
	W5500 custom configuration. More...

void	w5500Tick (NetInterface *interface)
	W5500 timer handler. More...

void	w5500EnableIrq (NetInterface *interface)
	Enable interrupts. More...

void	w5500DisableIrq (NetInterface *interface)
	Disable interrupts. More...

bool_t	w5500IrqHandler (NetInterface *interface)
	W5500 interrupt service routine. More...

void	w5500EventHandler (NetInterface *interface)
	W5500 event handler. More...

error_t	w5500SendPacket (NetInterface interface, const NetBuffer buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...

error_t	w5500ReceivePacket (NetInterface *interface)
	Receive a packet. More...

error_t	w5500UpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...

void	w5500WriteReg8 (NetInterface *interface, uint8_t control, uint16_t address, uint8_t data)
	Write 8-bit register. More...

uint8_t	w5500ReadReg8 (NetInterface *interface, uint8_t control, uint16_t address)
	Read 8-bit register. More...

void	w5500WriteReg16 (NetInterface *interface, uint8_t control, uint16_t address, uint16_t data)
	Write 16-bit register. More...

uint16_t	w5500ReadReg16 (NetInterface *interface, uint8_t control, uint16_t address)
	Read 16-bit register. More...

void	w5500WriteBuffer (NetInterface interface, uint8_t control, uint16_t address, const uint8_t data, size_t length)
	Write TX buffer. More...

void	w5500ReadBuffer (NetInterface interface, uint8_t control, uint16_t address, uint8_t data, size_t length)
	Read RX buffer. More...

void	w5500DumpReg (NetInterface *interface)
	Dump registers for debugging purpose. More...

Variables
const NicDriver	w5500Driver
	W5500 driver. More...

Detailed Description

WIZnet W5500 Ethernet controller.

License

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

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 w5500_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file w5500_driver.c.

Function Documentation

◆ w5500DisableIrq()

void w5500DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 264 of file w5500_driver.c.

◆ w5500DumpReg()

void w5500DumpReg ( NetInterface * interface )

Dump registers for debugging purpose.

Parameters

[in] interface Underlying network interface

Definition at line 726 of file w5500_driver.c.

◆ w5500EnableIrq()

void w5500EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 249 of file w5500_driver.c.

◆ w5500EventHandler()

void w5500EventHandler ( NetInterface * interface )

W5500 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 342 of file w5500_driver.c.

◆ w5500Init()

error_t w5500Init ( NetInterface * interface )

W5500 controller initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 71 of file w5500_driver.c.

◆ w5500InitHook()

__weak_func void w5500InitHook ( NetInterface * interface )

W5500 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 182 of file w5500_driver.c.

◆ w5500IrqHandler()

bool_t w5500IrqHandler ( NetInterface * interface )

W5500 interrupt service routine.

Parameters

[in] interface Underlying network interface

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

Definition at line 280 of file w5500_driver.c.

◆ w5500ReadBuffer()

void w5500ReadBuffer	(	NetInterface *	interface,
		uint8_t	control,
		uint16_t	address,
		uint8_t *	data,
		size_t	length
	)

Read RX buffer.

Parameters

[in]	interface	Underlying network interface
[in]	control	Control byte
[in]	address	Buffer address
[out]	data	Buffer where to store the incoming data
[in]	length	Number of data to read

Definition at line 694 of file w5500_driver.c.

◆ w5500ReadReg16()

uint16_t w5500ReadReg16	(	NetInterface *	interface,
		uint8_t	control,
		uint16_t	address
	)

Read 16-bit register.

Parameters

[in]	interface	Underlying network interface
[in]	control	Control byte
[in]	address	Register address

Returns: Register value

Definition at line 621 of file w5500_driver.c.

◆ w5500ReadReg8()

uint8_t w5500ReadReg8	(	NetInterface *	interface,
		uint8_t	control,
		uint16_t	address
	)

Read 8-bit register.

Parameters

[in]	interface	Underlying network interface
[in]	control	Control byte
[in]	address	Register address

Returns: Register value

Definition at line 555 of file w5500_driver.c.

◆ w5500ReceivePacket()

error_t w5500ReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 432 of file w5500_driver.c.

◆ w5500SendPacket()

error_t w5500SendPacket	(	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 367 of file w5500_driver.c.

◆ w5500Tick()

void w5500Tick ( NetInterface * interface )

W5500 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 192 of file w5500_driver.c.

◆ w5500UpdateMacAddrFilter()

error_t w5500UpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 510 of file w5500_driver.c.

◆ w5500WriteBuffer()

void w5500WriteBuffer	(	NetInterface *	interface,
		uint8_t	control,
		uint16_t	address,
		const uint8_t *	data,
		size_t	length
	)

Write TX buffer.

Parameters

[in]	interface	Underlying network interface
[in]	control	Control byte
[in]	address	Buffer address
[in]	data	Pointer to the data being written
[in]	length	Number of data to write

Definition at line 658 of file w5500_driver.c.

◆ w5500WriteReg16()

void w5500WriteReg16	(	NetInterface *	interface,
		uint8_t	control,
		uint16_t	address,
		uint16_t	data
	)

Write 16-bit register.

Parameters

[in]	interface	Underlying network interface
[in]	control	Control byte
[in]	address	Register address
[in]	data	Register value

Definition at line 590 of file w5500_driver.c.

◆ w5500WriteReg8()

void w5500WriteReg8	(	NetInterface *	interface,
		uint8_t	control,
		uint16_t	address,
		uint8_t	data
	)

Write 8-bit register.

Parameters

[in]	interface	Underlying network interface
[in]	control	Control byte
[in]	address	Register address
[in]	data	Register value

Definition at line 525 of file w5500_driver.c.

Variable Documentation

◆ w5500Driver

const NicDriver w5500Driver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   w5500Init,
   w5500Tick,
   w5500EnableIrq,
   w5500DisableIrq,
   w5500EventHandler,
   w5500SendPacket,
   w5500UpdateMacAddrFilter,
   NULL,
   NULL,
   NULL,
   TRUE,
   TRUE,
   TRUE,
   TRUE
}

W5500 driver.

Definition at line 44 of file w5500_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ w5500DisableIrq()

◆ w5500DumpReg()

◆ w5500EnableIrq()

◆ w5500EventHandler()

◆ w5500Init()

◆ w5500InitHook()

◆ w5500IrqHandler()

◆ w5500ReadBuffer()

◆ w5500ReadReg16()

◆ w5500ReadReg8()

◆ w5500ReceivePacket()

◆ w5500SendPacket()

◆ w5500Tick()

◆ w5500UpdateMacAddrFilter()

◆ w5500WriteBuffer()

◆ w5500WriteReg16()

◆ w5500WriteReg8()

Variable Documentation

◆ w5500Driver