w5200_driver.c File Reference

WIZnet W5200 Ethernet controller. More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t w5200Init (NetInterface *interface)
 W5200 controller initialization. More...
 
__weak_func void w5200InitHook (NetInterface *interface)
 W5200 custom configuration. More...
 
void w5200Tick (NetInterface *interface)
 W5200 timer handler. More...
 
void w5200EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void w5200DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
bool_t w5200IrqHandler (NetInterface *interface)
 W5200 interrupt service routine. More...
 
void w5200EventHandler (NetInterface *interface)
 W5200 event handler. More...
 
error_t w5200SendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t w5200ReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t w5200UpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
void w5200WriteReg8 (NetInterface *interface, uint16_t address, uint8_t data)
 Write 8-bit register. More...
 
uint8_t w5200ReadReg8 (NetInterface *interface, uint16_t address)
 Read 8-bit register. More...
 
void w5200WriteReg16 (NetInterface *interface, uint16_t address, uint16_t data)
 Write 16-bit register. More...
 
uint16_t w5200ReadReg16 (NetInterface *interface, uint16_t address)
 Read 16-bit register. More...
 
void w5200WriteData (NetInterface *interface, const uint8_t *data, size_t length)
 Write data. More...
 
void w5200ReadData (NetInterface *interface, uint8_t *data, size_t length)
 Read data. More...
 
void w5200WriteBuffer (NetInterface *interface, uint16_t address, const uint8_t *data, size_t length)
 Write TX buffer. More...
 
void w5200ReadBuffer (NetInterface *interface, uint16_t address, uint8_t *data, size_t length)
 Read RX buffer. More...
 
void w5200DumpReg (NetInterface *interface)
 Dump registers for debugging purpose. More...
 

Variables

const NicDriver w5200Driver
 W5200 driver. More...
 

Detailed Description

WIZnet W5200 Ethernet 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 w5200_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file w5200_driver.c.

Function Documentation

◆ w5200DisableIrq()

void w5200DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 240 of file w5200_driver.c.

◆ w5200DumpReg()

void w5200DumpReg ( NetInterface interface)

Dump registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 755 of file w5200_driver.c.

◆ w5200EnableIrq()

void w5200EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 225 of file w5200_driver.c.

◆ w5200EventHandler()

void w5200EventHandler ( NetInterface interface)

W5200 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 317 of file w5200_driver.c.

◆ w5200Init()

error_t w5200Init ( NetInterface interface)

W5200 controller initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 71 of file w5200_driver.c.

◆ w5200InitHook()

__weak_func void w5200InitHook ( NetInterface interface)

W5200 custom configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 178 of file w5200_driver.c.

◆ w5200IrqHandler()

bool_t w5200IrqHandler ( NetInterface interface)

W5200 interrupt service routine.

Parameters
[in]interfaceUnderlying network interface
Returns
TRUE if a higher priority task must be woken. Else FALSE is returned

Definition at line 256 of file w5200_driver.c.

◆ w5200ReadBuffer()

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

Read RX buffer.

Parameters
[in]interfaceUnderlying network interface
[in]addressBuffer address
[out]dataBuffer where to store the incoming data
[in]lengthNumber of data to read

Definition at line 723 of file w5200_driver.c.

◆ w5200ReadData()

void w5200ReadData ( NetInterface interface,
uint8_t *  data,
size_t  length 
)

Read data.

Parameters
[in]interfaceUnderlying network interface
[out]dataBuffer where to store the incoming data
[in]lengthNumber of data to read

Definition at line 641 of file w5200_driver.c.

◆ w5200ReadReg16()

uint16_t w5200ReadReg16 ( NetInterface interface,
uint16_t  address 
)

Read 16-bit register.

Parameters
[in]interfaceUnderlying network interface
[in]addressRegister address
Returns
Register value

Definition at line 560 of file w5200_driver.c.

◆ w5200ReadReg8()

uint8_t w5200ReadReg8 ( NetInterface interface,
uint16_t  address 
)

Read 8-bit register.

Parameters
[in]interfaceUnderlying network interface
[in]addressRegister address
Returns
Register value

Definition at line 498 of file w5200_driver.c.

◆ w5200ReceivePacket()

error_t w5200ReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 395 of file w5200_driver.c.

◆ w5200SendPacket()

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

Send a packet.

Parameters
[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 342 of file w5200_driver.c.

◆ w5200Tick()

void w5200Tick ( NetInterface interface)

W5200 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 188 of file w5200_driver.c.

◆ w5200UpdateMacAddrFilter()

error_t w5200UpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 456 of file w5200_driver.c.

◆ w5200WriteBuffer()

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

Write TX buffer.

Parameters
[in]interfaceUnderlying network interface
[in]addressBuffer address
[in]dataPointer to the data being written
[in]lengthNumber of data to write

Definition at line 688 of file w5200_driver.c.

◆ w5200WriteData()

void w5200WriteData ( NetInterface interface,
const uint8_t *  data,
size_t  length 
)

Write data.

Parameters
[in]interfaceUnderlying network interface
[in]dataPointer to the data being written
[in]lengthNumber of data to write

Definition at line 594 of file w5200_driver.c.

◆ w5200WriteReg16()

void w5200WriteReg16 ( NetInterface interface,
uint16_t  address,
uint16_t  data 
)

Write 16-bit register.

Parameters
[in]interfaceUnderlying network interface
[in]addressRegister address
[in]dataRegister value

Definition at line 531 of file w5200_driver.c.

◆ w5200WriteReg8()

void w5200WriteReg8 ( NetInterface interface,
uint16_t  address,
uint8_t  data 
)

Write 8-bit register.

Parameters
[in]interfaceUnderlying network interface
[in]addressRegister address
[in]dataRegister value

Definition at line 470 of file w5200_driver.c.

Variable Documentation

◆ w5200Driver

const NicDriver w5200Driver
Initial value:

W5200 driver.

Definition at line 44 of file w5200_driver.c.

#define TRUE
Definition: os_port.h:50
error_t w5200Init(NetInterface *interface)
W5200 controller initialization.
Definition: w5200_driver.c:71
void w5200DisableIrq(NetInterface *interface)
Disable interrupts.
Definition: w5200_driver.c:240
void w5200Tick(NetInterface *interface)
W5200 timer handler.
Definition: w5200_driver.c:188
error_t w5200SendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: w5200_driver.c:342
#define ETH_MTU
Definition: ethernet.h:116
void w5200EnableIrq(NetInterface *interface)
Enable interrupts.
Definition: w5200_driver.c:225
error_t w5200UpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: w5200_driver.c:456
void w5200EventHandler(NetInterface *interface)
W5200 event handler.
Definition: w5200_driver.c:317
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83