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

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	lan9303Init (NetInterface *interface)
	LAN9303 Ethernet switch initialization. More...

__weak_func void	lan9303InitHook (NetInterface *interface)
	LAN9303 custom configuration. 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	lan9303EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...

void	lan9303EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. 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	lan9303SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. 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

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 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]	interface	Underlying network interface
[in]	entry	Pointer to the forwarding database entry

Returns: Error code

Definition at line 953 of file lan9303_driver.c.

◆ lan9303DeleteStaticFdbEntry()

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

◆ lan9303DisableIrq()

void lan9303DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 287 of file lan9303_driver.c.

◆ lan9303DumpPhyReg()

void lan9303DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1487 of file lan9303_driver.c.

◆ lan9303DumpSysReg()

void lan9303DumpSysReg ( NetInterface * interface )

Dump system CSR registers for debugging purpose.

Parameters

[in] interface Underlying network interface

Definition at line 1600 of file lan9303_driver.c.

◆ lan9303EnableIgmpSnooping()

void lan9303EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 867 of file lan9303_driver.c.

◆ lan9303EnableIrq()

void lan9303EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 277 of file lan9303_driver.c.

◆ lan9303EnableMldSnooping()

void lan9303EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 899 of file lan9303_driver.c.

◆ lan9303EnableRsvdMcastTable()

void lan9303EnableRsvdMcastTable	(	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 911 of file lan9303_driver.c.

◆ lan9303EventHandler()

void lan9303EventHandler ( NetInterface * interface )

LAN9303 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 297 of file lan9303_driver.c.

◆ lan9303FlushDynamicFdbTable()

void lan9303FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1358 of file lan9303_driver.c.

◆ lan9303FlushStaticFdbTable()

void lan9303FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1221 of file lan9303_driver.c.

◆ lan9303GetDuplexMode()

NicDuplexMode lan9303GetDuplexMode	(	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 lan9303_driver.c.

◆ lan9303GetDynamicFdbEntry()

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

◆ lan9303GetLinkSpeed()

uint32_t lan9303GetLinkSpeed	(	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 lan9303_driver.c.

◆ lan9303GetLinkState()

bool_t lan9303GetLinkState	(	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 lan9303_driver.c.

◆ lan9303GetPortState()

SwitchPortState lan9303GetPortState	(	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 lan9303_driver.c.

◆ lan9303GetStaticFdbEntry()

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

◆ lan9303Init()

error_t lan9303Init ( NetInterface * interface )

LAN9303 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 78 of file lan9303_driver.c.

◆ lan9303InitHook()

__weak_func void lan9303InitHook ( NetInterface * interface )

LAN9303 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 197 of file lan9303_driver.c.

◆ lan9303ReadPhyReg()

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

◆ lan9303ReadSwitchReg()

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

◆ lan9303ReadSysReg()

uint32_t lan9303ReadSysReg	(	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 1555 of file lan9303_driver.c.

◆ lan9303SetAgingTime()

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

◆ lan9303SetPortState()

void lan9303SetPortState	(	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 lan9303_driver.c.

◆ lan9303SetUnknownMcastFwdPorts()

void lan9303SetUnknownMcastFwdPorts	(	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 1423 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]	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 lan9303_driver.c.

◆ lan9303Tick()

void lan9303Tick ( NetInterface * interface )

LAN9303 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 207 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]	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 lan9303_driver.c.

◆ lan9303WritePhyReg()

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

◆ lan9303WriteSwitchReg()

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

◆ lan9303WriteSysReg()

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

Variable Documentation

◆ lan9303SwitchDriver

const SwitchDriver lan9303SwitchDriver

Initial value:

=
{
   lan9303Init,
   lan9303Tick,
   lan9303EnableIrq,
   lan9303DisableIrq,
   lan9303EventHandler,
   lan9303TagFrame,
   lan9303UntagFrame,
   lan9303GetLinkState,
   lan9303GetLinkSpeed,
   lan9303GetDuplexMode,
   lan9303SetPortState,
   lan9303GetPortState,
   lan9303SetAgingTime,
   lan9303EnableIgmpSnooping,
   lan9303EnableMldSnooping,
   lan9303EnableRsvdMcastTable,
   lan9303AddStaticFdbEntry,
   lan9303DeleteStaticFdbEntry,
   lan9303GetStaticFdbEntry,
   lan9303FlushStaticFdbTable,
   lan9303GetDynamicFdbEntry,
   lan9303FlushDynamicFdbTable,
   lan9303SetUnknownMcastFwdPorts
}

LAN9303 Ethernet switch driver.

Definition at line 44 of file lan9303_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ lan9303AddStaticFdbEntry()

◆ lan9303DeleteStaticFdbEntry()

◆ lan9303DisableIrq()

◆ lan9303DumpPhyReg()

◆ lan9303DumpSysReg()

◆ lan9303EnableIgmpSnooping()

◆ lan9303EnableIrq()

◆ lan9303EnableMldSnooping()

◆ lan9303EnableRsvdMcastTable()

◆ lan9303EventHandler()

◆ lan9303FlushDynamicFdbTable()

◆ lan9303FlushStaticFdbTable()

◆ lan9303GetDuplexMode()

◆ lan9303GetDynamicFdbEntry()

◆ lan9303GetLinkSpeed()

◆ lan9303GetLinkState()

◆ lan9303GetPortState()

◆ lan9303GetStaticFdbEntry()

◆ lan9303Init()

◆ lan9303InitHook()

◆ lan9303ReadPhyReg()

◆ lan9303ReadSwitchReg()

◆ lan9303ReadSysReg()

◆ lan9303SetAgingTime()

◆ lan9303SetPortState()

◆ lan9303SetUnknownMcastFwdPorts()

◆ lan9303TagFrame()

◆ lan9303Tick()

◆ lan9303UntagFrame()

◆ lan9303WritePhyReg()

◆ lan9303WriteSwitchReg()

◆ lan9303WriteSysReg()

Variable Documentation

◆ lan9303SwitchDriver