lan9303_driver.c File Reference

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

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t lan9303Init (NetInterface *interface)
 LAN9303 Ethernet switch initialization. More...
 
void lan9303Tick (NetInterface *interface)
 LAN9303 timer handler. More...
 
void lan9303EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void lan9303DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void lan9303EventHandler (NetInterface *interface)
 LAN9303 event handler. More...
 
error_t lan9303TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
 Add special VLAN tag to Ethernet frame. More...
 
error_t lan9303UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
 Decode special VLAN tag from incoming Ethernet frame. More...
 
bool_t lan9303GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. More...
 
uint32_t lan9303GetLinkSpeed (NetInterface *interface, uint8_t port)
 Get link speed. More...
 
NicDuplexMode lan9303GetDuplexMode (NetInterface *interface, uint8_t port)
 Get duplex mode. More...
 
void lan9303SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
 Set port state. More...
 
SwitchPortState lan9303GetPortState (NetInterface *interface, uint8_t port)
 Get port state. More...
 
void lan9303SetAgingTime (NetInterface *interface, uint32_t agingTime)
 Set aging time for dynamic filtering entries. More...
 
void lan9303EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
 Enable reserved multicast table. More...
 
error_t lan9303AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Add a new entry to the static MAC table. More...
 
error_t lan9303DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Remove an entry from the static MAC table. More...
 
error_t lan9303GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the static MAC table. More...
 
void lan9303FlushStaticFdbTable (NetInterface *interface)
 Flush static MAC table. More...
 
error_t lan9303GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the dynamic MAC table. More...
 
void lan9303FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
 Flush dynamic MAC table. More...
 
void lan9303WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
 Write PHY register. More...
 
uint16_t lan9303ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
 Read PHY register. More...
 
void lan9303DumpPhyReg (NetInterface *interface, uint8_t port)
 Dump PHY registers for debugging purpose. More...
 
void lan9303WriteSysReg (NetInterface *interface, uint16_t address, uint32_t data)
 Write system CSR register. More...
 
uint32_t lan9303ReadSysReg (NetInterface *interface, uint16_t address)
 Read system CSR register. More...
 
void lan9303DumpSysReg (NetInterface *interface)
 Dump system CSR registers for debugging purpose. More...
 
void lan9303WriteSwitchReg (NetInterface *interface, uint16_t address, uint32_t data)
 Write switch fabric CSR register. More...
 
uint32_t lan9303ReadSwitchReg (NetInterface *interface, uint16_t address)
 Read switch fabric CSR register. More...
 

Variables

const SwitchDriver lan9303SwitchDriver
 LAN9303 Ethernet switch driver. More...
 

Detailed Description

LAN9303 3-port Ethernet switch driver.

License

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

Copyright (C) 2010-2020 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
1.9.8

Definition in file lan9303_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file lan9303_driver.c.

Function Documentation

◆ lan9303AddStaticFdbEntry()

error_t lan9303AddStaticFdbEntry ( 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 894 of file lan9303_driver.c.

◆ lan9303DeleteStaticFdbEntry()

error_t lan9303DeleteStaticFdbEntry ( 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 999 of file lan9303_driver.c.

◆ lan9303DisableIrq()

void lan9303DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 271 of file lan9303_driver.c.

◆ lan9303DumpPhyReg()

void lan9303DumpPhyReg ( NetInterface interface,
uint8_t  port 
)

Dump PHY registers for debugging purpose.

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

Definition at line 1406 of file lan9303_driver.c.

◆ lan9303DumpSysReg()

void lan9303DumpSysReg ( NetInterface interface)

Dump system CSR registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1519 of file lan9303_driver.c.

◆ lan9303EnableIrq()

void lan9303EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 261 of file lan9303_driver.c.

◆ lan9303EnableRsvdMcastTable()

void lan9303EnableRsvdMcastTable ( NetInterface interface,
bool_t  enable 
)

Enable reserved multicast table.

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

Definition at line 852 of file lan9303_driver.c.

◆ lan9303EventHandler()

void lan9303EventHandler ( NetInterface interface)

LAN9303 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 281 of file lan9303_driver.c.

◆ lan9303FlushDynamicFdbTable()

void lan9303FlushDynamicFdbTable ( NetInterface interface,
uint8_t  port 
)

Flush dynamic MAC table.

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

Definition at line 1291 of file lan9303_driver.c.

◆ lan9303FlushStaticFdbTable()

void lan9303FlushStaticFdbTable ( NetInterface interface)

Flush static MAC table.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1158 of file lan9303_driver.c.

◆ lan9303GetDuplexMode()

NicDuplexMode lan9303GetDuplexMode ( NetInterface interface,
uint8_t  port 
)

Get duplex mode.

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

Definition at line 655 of file lan9303_driver.c.

◆ lan9303GetDynamicFdbEntry()

error_t lan9303GetDynamicFdbEntry ( 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 1193 of file lan9303_driver.c.

◆ lan9303GetLinkSpeed()

uint32_t lan9303GetLinkSpeed ( NetInterface interface,
uint8_t  port 
)

Get link speed.

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

Definition at line 605 of file lan9303_driver.c.

◆ lan9303GetLinkState()

bool_t lan9303GetLinkState ( NetInterface interface,
uint8_t  port 
)

Get link state.

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

Definition at line 573 of file lan9303_driver.c.

◆ lan9303GetPortState()

SwitchPortState lan9303GetPortState ( NetInterface interface,
uint8_t  port 
)

Get port state.

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

Definition at line 776 of file lan9303_driver.c.

◆ lan9303GetStaticFdbEntry()

error_t lan9303GetStaticFdbEntry ( 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 1049 of file lan9303_driver.c.

◆ lan9303Init()

error_t lan9303Init ( NetInterface interface)

LAN9303 Ethernet switch initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 75 of file lan9303_driver.c.

◆ lan9303ReadPhyReg()

uint16_t lan9303ReadPhyReg ( 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 1380 of file lan9303_driver.c.

◆ lan9303ReadSwitchReg()

uint32_t lan9303ReadSwitchReg ( 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 1580 of file lan9303_driver.c.

◆ lan9303ReadSysReg()

uint32_t lan9303ReadSysReg ( NetInterface interface,
uint16_t  address 
)

Read system CSR register.

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

Definition at line 1474 of file lan9303_driver.c.

◆ lan9303SetAgingTime()

void lan9303SetAgingTime ( 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 840 of file lan9303_driver.c.

◆ lan9303SetPortState()

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

Set port state.

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

Definition at line 706 of file lan9303_driver.c.

◆ lan9303TagFrame()

error_t lan9303TagFrame ( 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 427 of file lan9303_driver.c.

◆ lan9303Tick()

void lan9303Tick ( NetInterface interface)

LAN9303 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 191 of file lan9303_driver.c.

◆ lan9303UntagFrame()

error_t lan9303UntagFrame ( 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 505 of file lan9303_driver.c.

◆ lan9303WritePhyReg()

void lan9303WritePhyReg ( 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 1357 of file lan9303_driver.c.

◆ lan9303WriteSwitchReg()

void lan9303WriteSwitchReg ( 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 1543 of file lan9303_driver.c.

◆ lan9303WriteSysReg()

void lan9303WriteSysReg ( 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 1430 of file lan9303_driver.c.

Variable Documentation

◆ lan9303SwitchDriver

void lan9303Tick(NetInterface *interface)
LAN9303 timer handler.
void lan9303EventHandler(NetInterface *interface)
LAN9303 event handler.
SwitchPortState lan9303GetPortState(NetInterface *interface, uint8_t port)
Get port state.
error_t lan9303AddStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Add a new entry to the static MAC table.
error_t lan9303Init(NetInterface *interface)
LAN9303 Ethernet switch initialization.
void lan9303SetPortState(NetInterface *interface, uint8_t port, SwitchPortState state)
Set port state.
bool_t lan9303GetLinkState(NetInterface *interface, uint8_t port)
Get link state.
void lan9303DisableIrq(NetInterface *interface)
Disable interrupts.
error_t lan9303UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
Decode special VLAN tag from incoming Ethernet frame.
error_t lan9303GetDynamicFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the dynamic MAC table.
uint32_t lan9303GetLinkSpeed(NetInterface *interface, uint8_t port)
Get link speed.
error_t lan9303GetStaticFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the static MAC table.
error_t lan9303DeleteStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Remove an entry from the static MAC table.
void lan9303FlushStaticFdbTable(NetInterface *interface)
Flush static MAC table.
void lan9303EnableIrq(NetInterface *interface)
Enable interrupts.
NicDuplexMode lan9303GetDuplexMode(NetInterface *interface, uint8_t port)
Get duplex mode.
void lan9303FlushDynamicFdbTable(NetInterface *interface, uint8_t port)
Flush dynamic MAC table.
void lan9303EnableRsvdMcastTable(NetInterface *interface, bool_t enable)
Enable reserved multicast table.
error_t lan9303TagFrame(NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
Add special VLAN tag to Ethernet frame.
void lan9303SetAgingTime(NetInterface *interface, uint32_t agingTime)
Set aging time for dynamic filtering entries.