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

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	lan9354Init (NetInterface *interface)
	LAN9354 Ethernet switch initialization. More...

__weak_func void	lan9354InitHook (NetInterface *interface)
	LAN9354 custom configuration. More...

void	lan9354Tick (NetInterface *interface)
	LAN9354 timer handler. More...

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

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

void	lan9354EventHandler (NetInterface *interface)
	LAN9354 event handler. More...

error_t	lan9354TagFrame (NetInterface interface, NetBuffer buffer, size_t offset, NetTxAncillary ancillary)
	Add special VLAN tag to Ethernet frame. More...

error_t	lan9354UntagFrame (NetInterface interface, uint8_t frame, size_t length, NetRxAncillary *ancillary)
	Decode special VLAN tag from incoming Ethernet frame. More...

bool_t	lan9354GetLinkState (NetInterface *interface, uint8_t port)
	Get link state. More...

uint32_t	lan9354GetLinkSpeed (NetInterface *interface, uint8_t port)
	Get link speed. More...

NicDuplexMode	lan9354GetDuplexMode (NetInterface *interface, uint8_t port)
	Get duplex mode. More...

void	lan9354SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
	Set port state. More...

SwitchPortState	lan9354GetPortState (NetInterface *interface, uint8_t port)
	Get port state. More...

void	lan9354SetAgingTime (NetInterface *interface, uint32_t agingTime)
	Set aging time for dynamic filtering entries. More...

void	lan9354EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...

void	lan9354EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. More...

void	lan9354EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
	Enable reserved multicast table. More...

error_t	lan9354AddStaticFdbEntry (NetInterface interface, const SwitchFdbEntry entry)
	Add a new entry to the static MAC table. More...

error_t	lan9354DeleteStaticFdbEntry (NetInterface interface, const SwitchFdbEntry entry)
	Remove an entry from the static MAC table. More...

error_t	lan9354GetStaticFdbEntry (NetInterface interface, uint_t index, SwitchFdbEntry entry)
	Read an entry from the static MAC table. More...

void	lan9354FlushStaticFdbTable (NetInterface *interface)
	Flush static MAC table. More...

error_t	lan9354GetDynamicFdbEntry (NetInterface interface, uint_t index, SwitchFdbEntry entry)
	Read an entry from the dynamic MAC table. More...

void	lan9354FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
	Flush dynamic MAC table. More...

void	lan9354SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. More...

void	lan9354WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
	Write PHY register. More...

uint16_t	lan9354ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
	Read PHY register. More...

void	lan9354DumpPhyReg (NetInterface *interface, uint8_t port)
	Dump PHY registers for debugging purpose. More...

void	lan9354WriteSysReg (NetInterface *interface, uint16_t address, uint32_t data)
	Write system CSR register. More...

uint32_t	lan9354ReadSysReg (NetInterface *interface, uint16_t address)
	Read system CSR register. More...

void	lan9354DumpSysReg (NetInterface *interface)
	Dump system CSR registers for debugging purpose. More...

void	lan9354WriteSwitchReg (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch fabric CSR register. More...

uint32_t	lan9354ReadSwitchReg (NetInterface *interface, uint16_t address)
	Read switch fabric CSR register. More...

Variables
const SwitchDriver	lan9354SwitchDriver
	LAN9354 Ethernet switch driver. More...

Detailed Description

LAN9354 3-port Ethernet switch driver.

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

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file lan9354_driver.c.

Function Documentation

◆ lan9354AddStaticFdbEntry()

error_t lan9354AddStaticFdbEntry	(	NetInterface *	interface,
		const SwitchFdbEntry *	entry
	)

Add a new entry to the static MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	entry	Pointer to the forwarding database entry

Returns: Error code

Definition at line 984 of file lan9354_driver.c.

◆ lan9354DeleteStaticFdbEntry()

error_t lan9354DeleteStaticFdbEntry	(	NetInterface *	interface,
		const SwitchFdbEntry *	entry
	)

Remove an entry from the static MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	entry	Forwarding database entry to remove from the table

Returns: Error code

Definition at line 1089 of file lan9354_driver.c.

◆ lan9354DisableIrq()

void lan9354DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 287 of file lan9354_driver.c.

◆ lan9354DumpPhyReg()

void lan9354DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Definition at line 1518 of file lan9354_driver.c.

◆ lan9354DumpSysReg()

void lan9354DumpSysReg ( NetInterface * interface )

Dump system CSR registers for debugging purpose.

Parameters

[in] interface Underlying network interface

Definition at line 1631 of file lan9354_driver.c.

◆ lan9354EnableIgmpSnooping()

void lan9354EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

[in]	interface	Underlying network interface
[in]	enable	Enable or disable IGMP snooping

Definition at line 878 of file lan9354_driver.c.

◆ lan9354EnableIrq()

void lan9354EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 277 of file lan9354_driver.c.

◆ lan9354EnableMldSnooping()

void lan9354EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

[in]	interface	Underlying network interface
[in]	enable	Enable or disable MLD snooping

Definition at line 910 of file lan9354_driver.c.

◆ lan9354EnableRsvdMcastTable()

void lan9354EnableRsvdMcastTable	(	NetInterface *	interface,
		bool_t	enable
	)

Enable reserved multicast table.

Parameters

[in]	interface	Underlying network interface
[in]	enable	Enable or disable reserved group addresses

Definition at line 942 of file lan9354_driver.c.

◆ lan9354EventHandler()

void lan9354EventHandler ( NetInterface * interface )

LAN9354 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 297 of file lan9354_driver.c.

◆ lan9354FlushDynamicFdbTable()

void lan9354FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Definition at line 1389 of file lan9354_driver.c.

◆ lan9354FlushStaticFdbTable()

void lan9354FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1252 of file lan9354_driver.c.

◆ lan9354GetDuplexMode()

NicDuplexMode lan9354GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Returns: Duplex mode

Definition at line 671 of file lan9354_driver.c.

◆ lan9354GetDynamicFdbEntry()

error_t lan9354GetDynamicFdbEntry	(	NetInterface *	interface,
		uint_t	index,
		SwitchFdbEntry *	entry
	)

Read an entry from the dynamic MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	index	Zero-based index of the entry to read
[out]	entry	Pointer to the forwarding database entry

Returns: Error code

Definition at line 1287 of file lan9354_driver.c.

◆ lan9354GetLinkSpeed()

uint32_t lan9354GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Returns: Link speed

Definition at line 621 of file lan9354_driver.c.

◆ lan9354GetLinkState()

bool_t lan9354GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Returns: Link state

Definition at line 589 of file lan9354_driver.c.

◆ lan9354GetPortState()

SwitchPortState lan9354GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number

Returns: Port state

Definition at line 791 of file lan9354_driver.c.

◆ lan9354GetStaticFdbEntry()

error_t lan9354GetStaticFdbEntry	(	NetInterface *	interface,
		uint_t	index,
		SwitchFdbEntry *	entry
	)

Read an entry from the static MAC table.

Parameters

[in]	interface	Underlying network interface
[in]	index	Zero-based index of the entry to read
[out]	entry	Pointer to the forwarding database entry

Returns: Error code

Definition at line 1139 of file lan9354_driver.c.

◆ lan9354Init()

error_t lan9354Init ( NetInterface * interface )

LAN9354 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 78 of file lan9354_driver.c.

◆ lan9354InitHook()

__weak_func void lan9354InitHook ( NetInterface * interface )

LAN9354 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 197 of file lan9354_driver.c.

◆ lan9354ReadPhyReg()

uint16_t lan9354ReadPhyReg	(	NetInterface *	interface,
		uint8_t	port,
		uint8_t	address
	)

Read PHY register.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	address	PHY register address

Returns: Register value

Definition at line 1492 of file lan9354_driver.c.

◆ lan9354ReadSwitchReg()

uint32_t lan9354ReadSwitchReg	(	NetInterface *	interface,
		uint16_t	address
	)

Read switch fabric CSR register.

Parameters

[in]	interface	Underlying network interface
[in]	address	Switch fabric register address

Returns: Register value

Definition at line 1694 of file lan9354_driver.c.

◆ lan9354ReadSysReg()

uint32_t lan9354ReadSysReg	(	NetInterface *	interface,
		uint16_t	address
	)

Read system CSR register.

Parameters

[in]	interface	Underlying network interface
[in]	address	System register address

Returns: Register value

Definition at line 1586 of file lan9354_driver.c.

◆ lan9354SetAgingTime()

void lan9354SetAgingTime	(	NetInterface *	interface,
		uint32_t	agingTime
	)

Set aging time for dynamic filtering entries.

Parameters

[in]	interface	Underlying network interface
[in]	agingTime	Aging time, in seconds

Definition at line 855 of file lan9354_driver.c.

◆ lan9354SetPortState()

void lan9354SetPortState	(	NetInterface *	interface,
		uint8_t	port,
		SwitchPortState	state
	)

Set port state.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	state	Port state

Definition at line 721 of file lan9354_driver.c.

◆ lan9354SetUnknownMcastFwdPorts()

void lan9354SetUnknownMcastFwdPorts	(	NetInterface *	interface,
		bool_t	enable,
		uint32_t	forwardPorts
	)

Set forward ports for unknown multicast packets.

Parameters

[in]	interface	Underlying network interface
[in]	enable	Enable or disable forwarding of unknown multicast packets
[in]	forwardPorts	Port map

Definition at line 1454 of file lan9354_driver.c.

◆ lan9354TagFrame()

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

Add special VLAN tag to Ethernet frame.

Parameters

[in]	interface	Underlying network interface
[in]	buffer	Multi-part buffer containing the payload
[in,out]	offset	Offset to the first payload byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 443 of file lan9354_driver.c.

◆ lan9354Tick()

void lan9354Tick ( NetInterface * interface )

LAN9354 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 207 of file lan9354_driver.c.

◆ lan9354UntagFrame()

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

Decode special VLAN tag from incoming Ethernet frame.

Parameters

[in]	interface	Underlying network interface
[in,out]	frame	Pointer to the received Ethernet frame
[in,out]	length	Length of the frame, in bytes
[in,out]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 521 of file lan9354_driver.c.

◆ lan9354WritePhyReg()

void lan9354WritePhyReg	(	NetInterface *	interface,
		uint8_t	port,
		uint8_t	address,
		uint16_t	data
	)

Write PHY register.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	address	PHY register address
[in]	data	Register value

Definition at line 1469 of file lan9354_driver.c.

◆ lan9354WriteSwitchReg()

void lan9354WriteSwitchReg	(	NetInterface *	interface,
		uint16_t	address,
		uint32_t	data
	)

Write switch fabric CSR register.

Parameters

[in]	interface	Underlying network interface
[in]	address	Switch fabric register address
[in]	data	Register value

Definition at line 1655 of file lan9354_driver.c.

◆ lan9354WriteSysReg()

void lan9354WriteSysReg	(	NetInterface *	interface,
		uint16_t	address,
		uint32_t	data
	)

Write system CSR register.

Parameters

[in]	interface	Underlying network interface
[in]	address	System register address
[in]	data	Register value

Definition at line 1542 of file lan9354_driver.c.

Variable Documentation

◆ lan9354SwitchDriver

const SwitchDriver lan9354SwitchDriver

Initial value:

=
{
   lan9354Init,
   lan9354Tick,
   lan9354EnableIrq,
   lan9354DisableIrq,
   lan9354EventHandler,
   lan9354TagFrame,
   lan9354UntagFrame,
   lan9354GetLinkState,
   lan9354GetLinkSpeed,
   lan9354GetDuplexMode,
   lan9354SetPortState,
   lan9354GetPortState,
   lan9354SetAgingTime,
   lan9354EnableIgmpSnooping,
   lan9354EnableMldSnooping,
   lan9354EnableRsvdMcastTable,
   lan9354AddStaticFdbEntry,
   lan9354DeleteStaticFdbEntry,
   lan9354GetStaticFdbEntry,
   lan9354FlushStaticFdbTable,
   lan9354GetDynamicFdbEntry,
   lan9354FlushDynamicFdbTable,
   lan9354SetUnknownMcastFwdPorts
}

LAN9354 Ethernet switch driver.

Definition at line 44 of file lan9354_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ lan9354AddStaticFdbEntry()

◆ lan9354DeleteStaticFdbEntry()

◆ lan9354DisableIrq()

◆ lan9354DumpPhyReg()

◆ lan9354DumpSysReg()

◆ lan9354EnableIgmpSnooping()

◆ lan9354EnableIrq()

◆ lan9354EnableMldSnooping()

◆ lan9354EnableRsvdMcastTable()

◆ lan9354EventHandler()

◆ lan9354FlushDynamicFdbTable()

◆ lan9354FlushStaticFdbTable()

◆ lan9354GetDuplexMode()

◆ lan9354GetDynamicFdbEntry()

◆ lan9354GetLinkSpeed()

◆ lan9354GetLinkState()

◆ lan9354GetPortState()

◆ lan9354GetStaticFdbEntry()

◆ lan9354Init()

◆ lan9354InitHook()

◆ lan9354ReadPhyReg()

◆ lan9354ReadSwitchReg()

◆ lan9354ReadSysReg()

◆ lan9354SetAgingTime()

◆ lan9354SetPortState()

◆ lan9354SetUnknownMcastFwdPorts()

◆ lan9354TagFrame()

◆ lan9354Tick()

◆ lan9354UntagFrame()

◆ lan9354WritePhyReg()

◆ lan9354WriteSwitchReg()

◆ lan9354WriteSysReg()

Variable Documentation

◆ lan9354SwitchDriver