lan9353_driver.c File Reference

LAN9353 3-port Ethernet switch driver. More...

#include "core/net.h"
#include "drivers/switch/lan9353_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t lan9353Init (NetInterface *interface)
 LAN9353 Ethernet switch initialization. More...
 
__weak_func void lan9353InitHook (NetInterface *interface)
 LAN9353 custom configuration. More...
 
void lan9353Tick (NetInterface *interface)
 LAN9353 timer handler. More...
 
void lan9353EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void lan9353DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void lan9353EventHandler (NetInterface *interface)
 LAN9353 event handler. More...
 
error_t lan9353TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
 Add special VLAN tag to Ethernet frame. More...
 
error_t lan9353UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
 Decode special VLAN tag from incoming Ethernet frame. More...
 
bool_t lan9353GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. More...
 
uint32_t lan9353GetLinkSpeed (NetInterface *interface, uint8_t port)
 Get link speed. More...
 
NicDuplexMode lan9353GetDuplexMode (NetInterface *interface, uint8_t port)
 Get duplex mode. More...
 
void lan9353SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
 Set port state. More...
 
SwitchPortState lan9353GetPortState (NetInterface *interface, uint8_t port)
 Get port state. More...
 
void lan9353SetAgingTime (NetInterface *interface, uint32_t agingTime)
 Set aging time for dynamic filtering entries. More...
 
void lan9353EnableIgmpSnooping (NetInterface *interface, bool_t enable)
 Enable IGMP snooping. More...
 
void lan9353EnableMldSnooping (NetInterface *interface, bool_t enable)
 Enable MLD snooping. More...
 
void lan9353EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
 Enable reserved multicast table. More...
 
error_t lan9353AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Add a new entry to the static MAC table. More...
 
error_t lan9353DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Remove an entry from the static MAC table. More...
 
error_t lan9353GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the static MAC table. More...
 
void lan9353FlushStaticFdbTable (NetInterface *interface)
 Flush static MAC table. More...
 
error_t lan9353GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the dynamic MAC table. More...
 
void lan9353FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
 Flush dynamic MAC table. More...
 
void lan9353SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
 Set forward ports for unknown multicast packets. More...
 
void lan9353WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
 Write PHY register. More...
 
uint16_t lan9353ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
 Read PHY register. More...
 
void lan9353DumpPhyReg (NetInterface *interface, uint8_t port)
 Dump PHY registers for debugging purpose. More...
 
void lan9353WriteSysReg (NetInterface *interface, uint16_t address, uint32_t data)
 Write system CSR register. More...
 
uint32_t lan9353ReadSysReg (NetInterface *interface, uint16_t address)
 Read system CSR register. More...
 
void lan9353DumpSysReg (NetInterface *interface)
 Dump system CSR registers for debugging purpose. More...
 
void lan9353WriteSwitchReg (NetInterface *interface, uint16_t address, uint32_t data)
 Write switch fabric CSR register. More...
 
uint32_t lan9353ReadSwitchReg (NetInterface *interface, uint16_t address)
 Read switch fabric CSR register. More...
 

Variables

const SwitchDriver lan9353SwitchDriver
 LAN9353 Ethernet switch driver. More...
 

Detailed Description

LAN9353 3-port Ethernet switch 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 lan9353_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file lan9353_driver.c.

Function Documentation

◆ lan9353AddStaticFdbEntry()

error_t lan9353AddStaticFdbEntry ( NetInterface interface,
const SwitchFdbEntry entry 
)

Add a new entry to the static MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]entryPointer to the forwarding database entry
Returns
Error code

Definition at line 984 of file lan9353_driver.c.

◆ lan9353DeleteStaticFdbEntry()

error_t lan9353DeleteStaticFdbEntry ( NetInterface interface,
const SwitchFdbEntry entry 
)

Remove an entry from the static MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]entryForwarding database entry to remove from the table
Returns
Error code

Definition at line 1089 of file lan9353_driver.c.

◆ lan9353DisableIrq()

void lan9353DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 287 of file lan9353_driver.c.

◆ lan9353DumpPhyReg()

void lan9353DumpPhyReg ( NetInterface interface,
uint8_t  port 
)

Dump PHY registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number

Definition at line 1518 of file lan9353_driver.c.

◆ lan9353DumpSysReg()

void lan9353DumpSysReg ( NetInterface interface)

Dump system CSR registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1631 of file lan9353_driver.c.

◆ lan9353EnableIgmpSnooping()

void lan9353EnableIgmpSnooping ( NetInterface interface,
bool_t  enable 
)

Enable IGMP snooping.

Parameters
[in]interfaceUnderlying network interface
[in]enableEnable or disable IGMP snooping

Definition at line 878 of file lan9353_driver.c.

◆ lan9353EnableIrq()

void lan9353EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 277 of file lan9353_driver.c.

◆ lan9353EnableMldSnooping()

void lan9353EnableMldSnooping ( NetInterface interface,
bool_t  enable 
)

Enable MLD snooping.

Parameters
[in]interfaceUnderlying network interface
[in]enableEnable or disable MLD snooping

Definition at line 910 of file lan9353_driver.c.

◆ lan9353EnableRsvdMcastTable()

void lan9353EnableRsvdMcastTable ( NetInterface interface,
bool_t  enable 
)

Enable reserved multicast table.

Parameters
[in]interfaceUnderlying network interface
[in]enableEnable or disable reserved group addresses

Definition at line 942 of file lan9353_driver.c.

◆ lan9353EventHandler()

void lan9353EventHandler ( NetInterface interface)

LAN9353 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 297 of file lan9353_driver.c.

◆ lan9353FlushDynamicFdbTable()

void lan9353FlushDynamicFdbTable ( NetInterface interface,
uint8_t  port 
)

Flush dynamic MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number

Definition at line 1389 of file lan9353_driver.c.

◆ lan9353FlushStaticFdbTable()

void lan9353FlushStaticFdbTable ( NetInterface interface)

Flush static MAC table.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1252 of file lan9353_driver.c.

◆ lan9353GetDuplexMode()

NicDuplexMode lan9353GetDuplexMode ( NetInterface interface,
uint8_t  port 
)

Get duplex mode.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
Returns
Duplex mode

Definition at line 671 of file lan9353_driver.c.

◆ lan9353GetDynamicFdbEntry()

error_t lan9353GetDynamicFdbEntry ( NetInterface interface,
uint_t  index,
SwitchFdbEntry entry 
)

Read an entry from the dynamic MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]indexZero-based index of the entry to read
[out]entryPointer to the forwarding database entry
Returns
Error code

Definition at line 1287 of file lan9353_driver.c.

◆ lan9353GetLinkSpeed()

uint32_t lan9353GetLinkSpeed ( NetInterface interface,
uint8_t  port 
)

Get link speed.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
Returns
Link speed

Definition at line 621 of file lan9353_driver.c.

◆ lan9353GetLinkState()

bool_t lan9353GetLinkState ( NetInterface interface,
uint8_t  port 
)

Get link state.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
Returns
Link state

Definition at line 589 of file lan9353_driver.c.

◆ lan9353GetPortState()

SwitchPortState lan9353GetPortState ( NetInterface interface,
uint8_t  port 
)

Get port state.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
Returns
Port state

Definition at line 791 of file lan9353_driver.c.

◆ lan9353GetStaticFdbEntry()

error_t lan9353GetStaticFdbEntry ( NetInterface interface,
uint_t  index,
SwitchFdbEntry entry 
)

Read an entry from the static MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]indexZero-based index of the entry to read
[out]entryPointer to the forwarding database entry
Returns
Error code

Definition at line 1139 of file lan9353_driver.c.

◆ lan9353Init()

error_t lan9353Init ( NetInterface interface)

LAN9353 Ethernet switch initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 78 of file lan9353_driver.c.

◆ lan9353InitHook()

__weak_func void lan9353InitHook ( NetInterface interface)

LAN9353 custom configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 197 of file lan9353_driver.c.

◆ lan9353ReadPhyReg()

uint16_t lan9353ReadPhyReg ( NetInterface interface,
uint8_t  port,
uint8_t  address 
)

Read PHY register.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
[in]addressPHY register address
Returns
Register value

Definition at line 1492 of file lan9353_driver.c.

◆ lan9353ReadSwitchReg()

uint32_t lan9353ReadSwitchReg ( NetInterface interface,
uint16_t  address 
)

Read switch fabric CSR register.

Parameters
[in]interfaceUnderlying network interface
[in]addressSwitch fabric register address
Returns
Register value

Definition at line 1694 of file lan9353_driver.c.

◆ lan9353ReadSysReg()

uint32_t lan9353ReadSysReg ( NetInterface interface,
uint16_t  address 
)

Read system CSR register.

Parameters
[in]interfaceUnderlying network interface
[in]addressSystem register address
Returns
Register value

Definition at line 1586 of file lan9353_driver.c.

◆ lan9353SetAgingTime()

void lan9353SetAgingTime ( NetInterface interface,
uint32_t  agingTime 
)

Set aging time for dynamic filtering entries.

Parameters
[in]interfaceUnderlying network interface
[in]agingTimeAging time, in seconds

Definition at line 855 of file lan9353_driver.c.

◆ lan9353SetPortState()

void lan9353SetPortState ( NetInterface interface,
uint8_t  port,
SwitchPortState  state 
)

Set port state.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
[in]statePort state

Definition at line 721 of file lan9353_driver.c.

◆ lan9353SetUnknownMcastFwdPorts()

void lan9353SetUnknownMcastFwdPorts ( NetInterface interface,
bool_t  enable,
uint32_t  forwardPorts 
)

Set forward ports for unknown multicast packets.

Parameters
[in]interfaceUnderlying network interface
[in]enableEnable or disable forwarding of unknown multicast packets
[in]forwardPortsPort map

Definition at line 1454 of file lan9353_driver.c.

◆ lan9353TagFrame()

error_t lan9353TagFrame ( NetInterface interface,
NetBuffer buffer,
size_t *  offset,
NetTxAncillary ancillary 
)

Add special VLAN tag to Ethernet frame.

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

Definition at line 443 of file lan9353_driver.c.

◆ lan9353Tick()

void lan9353Tick ( NetInterface interface)

LAN9353 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 207 of file lan9353_driver.c.

◆ lan9353UntagFrame()

error_t lan9353UntagFrame ( NetInterface interface,
uint8_t **  frame,
size_t *  length,
NetRxAncillary ancillary 
)

Decode special VLAN tag from incoming Ethernet frame.

Parameters
[in]interfaceUnderlying network interface
[in,out]framePointer to the received Ethernet frame
[in,out]lengthLength of the frame, in bytes
[in,out]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 521 of file lan9353_driver.c.

◆ lan9353WritePhyReg()

void lan9353WritePhyReg ( NetInterface interface,
uint8_t  port,
uint8_t  address,
uint16_t  data 
)

Write PHY register.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
[in]addressPHY register address
[in]dataRegister value

Definition at line 1469 of file lan9353_driver.c.

◆ lan9353WriteSwitchReg()

void lan9353WriteSwitchReg ( NetInterface interface,
uint16_t  address,
uint32_t  data 
)

Write switch fabric CSR register.

Parameters
[in]interfaceUnderlying network interface
[in]addressSwitch fabric register address
[in]dataRegister value

Definition at line 1655 of file lan9353_driver.c.

◆ lan9353WriteSysReg()

void lan9353WriteSysReg ( NetInterface interface,
uint16_t  address,
uint32_t  data 
)

Write system CSR register.

Parameters
[in]interfaceUnderlying network interface
[in]addressSystem register address
[in]dataRegister value

Definition at line 1542 of file lan9353_driver.c.

Variable Documentation

◆ lan9353SwitchDriver

const SwitchDriver lan9353SwitchDriver
Initial value:
=
{
}
error_t lan9353AddStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Add a new entry to the static MAC table.
SwitchPortState lan9353GetPortState(NetInterface *interface, uint8_t port)
Get port state.
bool_t lan9353GetLinkState(NetInterface *interface, uint8_t port)
Get link state.
void lan9353EnableIrq(NetInterface *interface)
Enable interrupts.
error_t lan9353GetDynamicFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the dynamic MAC table.
void lan9353EnableIgmpSnooping(NetInterface *interface, bool_t enable)
Enable IGMP snooping.
void lan9353EnableRsvdMcastTable(NetInterface *interface, bool_t enable)
Enable reserved multicast table.
void lan9353SetUnknownMcastFwdPorts(NetInterface *interface, bool_t enable, uint32_t forwardPorts)
Set forward ports for unknown multicast packets.
void lan9353EventHandler(NetInterface *interface)
LAN9353 event handler.
error_t lan9353GetStaticFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the static MAC table.
void lan9353FlushDynamicFdbTable(NetInterface *interface, uint8_t port)
Flush dynamic MAC table.
void lan9353EnableMldSnooping(NetInterface *interface, bool_t enable)
Enable MLD snooping.
error_t lan9353UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
Decode special VLAN tag from incoming Ethernet frame.
error_t lan9353TagFrame(NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
Add special VLAN tag to Ethernet frame.
void lan9353FlushStaticFdbTable(NetInterface *interface)
Flush static MAC table.
void lan9353SetPortState(NetInterface *interface, uint8_t port, SwitchPortState state)
Set port state.
uint32_t lan9353GetLinkSpeed(NetInterface *interface, uint8_t port)
Get link speed.
error_t lan9353DeleteStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Remove an entry from the static MAC table.
void lan9353Tick(NetInterface *interface)
LAN9353 timer handler.
NicDuplexMode lan9353GetDuplexMode(NetInterface *interface, uint8_t port)
Get duplex mode.
void lan9353SetAgingTime(NetInterface *interface, uint32_t agingTime)
Set aging time for dynamic filtering entries.
void lan9353DisableIrq(NetInterface *interface)
Disable interrupts.
error_t lan9353Init(NetInterface *interface)
LAN9353 Ethernet switch initialization.

LAN9353 Ethernet switch driver.

Definition at line 44 of file lan9353_driver.c.