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

#include "core/net.h"
#include "core/ethernet_misc.h"
#include "drivers/switch/ksz8873_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	ksz8873Init (NetInterface *interface)
	KSZ8873 Ethernet switch initialization. More...

__weak_func void	ksz8873InitHook (NetInterface *interface)
	KSZ8873 custom configuration. More...

void	ksz8873Tick (NetInterface *interface)
	KSZ8873 timer handler. More...

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

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

void	ksz8873EventHandler (NetInterface *interface)
	KSZ8873 event handler. More...

error_t	ksz8873TagFrame (NetInterface interface, NetBuffer buffer, size_t offset, NetTxAncillary ancillary)
	Add tail tag to Ethernet frame. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	ksz8873WriteSwitchReg (NetInterface *interface, uint8_t address, uint8_t data)
	Write switch register. More...

uint8_t	ksz8873ReadSwitchReg (NetInterface *interface, uint8_t address)
	Read switch register. More...

void	ksz8873DumpSwitchReg (NetInterface *interface)
	Dump switch registers for debugging purpose. More...

Variables
const SwitchDriver	ksz8873SwitchDriver
	KSZ8873 Ethernet switch driver. More...

const uint8_t	ksz8873IngressTailTag [3]
	Tail tag rules (host to KSZ8873) More...

Detailed Description

KSZ8873 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.4

Definition in file ksz8873_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file ksz8873_driver.c.

Function Documentation

◆ ksz8873AddStaticFdbEntry()

error_t ksz8873AddStaticFdbEntry	(	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 842 of file ksz8873_driver.c.

◆ ksz8873DeleteStaticFdbEntry()

error_t ksz8873DeleteStaticFdbEntry	(	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 941 of file ksz8873_driver.c.

◆ ksz8873DisableIrq()

void ksz8873DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 273 of file ksz8873_driver.c.

◆ ksz8873DumpPhyReg()

void ksz8873DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1302 of file ksz8873_driver.c.

◆ ksz8873DumpSwitchReg()

void ksz8873DumpSwitchReg ( NetInterface * interface )

Dump switch registers for debugging purpose.

Parameters

[in] interface Underlying network interface

Definition at line 1437 of file ksz8873_driver.c.

◆ ksz8873EnableIgmpSnooping()

void ksz8873EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 789 of file ksz8873_driver.c.

◆ ksz8873EnableIrq()

void ksz8873EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 263 of file ksz8873_driver.c.

◆ ksz8873EnableMldSnooping()

void ksz8873EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 817 of file ksz8873_driver.c.

◆ ksz8873EnableRsvdMcastTable()

void ksz8873EnableRsvdMcastTable	(	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 829 of file ksz8873_driver.c.

◆ ksz8873EventHandler()

void ksz8873EventHandler ( NetInterface * interface )

KSZ8873 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 283 of file ksz8873_driver.c.

◆ ksz8873FlushDynamicFdbTable()

void ksz8873FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1191 of file ksz8873_driver.c.

◆ ksz8873FlushStaticFdbTable()

void ksz8873FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1067 of file ksz8873_driver.c.

◆ ksz8873GetDuplexMode()

NicDuplexMode ksz8873GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns: Duplex mode

Definition at line 604 of file ksz8873_driver.c.

◆ ksz8873GetDynamicFdbEntry()

error_t ksz8873GetDynamicFdbEntry	(	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 1107 of file ksz8873_driver.c.

◆ ksz8873GetLinkSpeed()

uint32_t ksz8873GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns: Link speed

Definition at line 550 of file ksz8873_driver.c.

◆ ksz8873GetLinkState()

bool_t ksz8873GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns: Link state

Definition at line 506 of file ksz8873_driver.c.

◆ ksz8873GetPortState()

SwitchPortState ksz8873GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns: Port state

Definition at line 714 of file ksz8873_driver.c.

◆ ksz8873GetStaticFdbEntry()

error_t ksz8873GetStaticFdbEntry	(	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 1005 of file ksz8873_driver.c.

◆ ksz8873Init()

error_t ksz8873Init ( NetInterface * interface )

KSZ8873 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 91 of file ksz8873_driver.c.

◆ ksz8873InitHook()

__weak_func void ksz8873InitHook ( NetInterface * interface )

KSZ8873 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 183 of file ksz8873_driver.c.

◆ ksz8873ReadPhyReg()

uint16_t ksz8873ReadPhyReg	(	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 1276 of file ksz8873_driver.c.

◆ ksz8873ReadSwitchReg()

uint8_t ksz8873ReadSwitchReg	(	NetInterface *	interface,
		uint8_t	address
	)

Read switch register.

Parameters

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

Returns: Register value

Definition at line 1381 of file ksz8873_driver.c.

◆ ksz8873SetAgingTime()

void ksz8873SetAgingTime	(	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 777 of file ksz8873_driver.c.

◆ ksz8873SetPortState()

void ksz8873SetPortState	(	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 658 of file ksz8873_driver.c.

◆ ksz8873SetUnknownMcastFwdPorts()

void ksz8873SetUnknownMcastFwdPorts	(	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 1238 of file ksz8873_driver.c.

◆ ksz8873TagFrame()

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

Add tail 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 408 of file ksz8873_driver.c.

◆ ksz8873Tick()

void ksz8873Tick ( NetInterface * interface )

KSZ8873 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 193 of file ksz8873_driver.c.

◆ ksz8873UntagFrame()

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

Decode tail 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 463 of file ksz8873_driver.c.

◆ ksz8873WritePhyReg()

void ksz8873WritePhyReg	(	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 1253 of file ksz8873_driver.c.

◆ ksz8873WriteSwitchReg()

void ksz8873WriteSwitchReg	(	NetInterface *	interface,
		uint8_t	address,
		uint8_t	data
	)

Write switch register.

Parameters

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

Definition at line 1326 of file ksz8873_driver.c.

Variable Documentation

◆ ksz8873IngressTailTag

const uint8_t ksz8873IngressTailTag[3]

Initial value:

=
{
   KSZ8873_TAIL_TAG_NORMAL_ADDR_LOOKUP,
   KSZ8873_TAIL_TAG_DEST_PORT1,
   KSZ8873_TAIL_TAG_DEST_PORT2
}

Tail tag rules (host to KSZ8873)

Definition at line 77 of file ksz8873_driver.c.

◆ ksz8873SwitchDriver

const SwitchDriver ksz8873SwitchDriver

Initial value:

KSZ8873 Ethernet switch driver.

Definition at line 45 of file ksz8873_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ksz8873AddStaticFdbEntry()

◆ ksz8873DeleteStaticFdbEntry()

◆ ksz8873DisableIrq()

◆ ksz8873DumpPhyReg()

◆ ksz8873DumpSwitchReg()

◆ ksz8873EnableIgmpSnooping()

◆ ksz8873EnableIrq()

◆ ksz8873EnableMldSnooping()

◆ ksz8873EnableRsvdMcastTable()

◆ ksz8873EventHandler()

◆ ksz8873FlushDynamicFdbTable()

◆ ksz8873FlushStaticFdbTable()

◆ ksz8873GetDuplexMode()

◆ ksz8873GetDynamicFdbEntry()

◆ ksz8873GetLinkSpeed()

◆ ksz8873GetLinkState()

◆ ksz8873GetPortState()

◆ ksz8873GetStaticFdbEntry()

◆ ksz8873Init()

◆ ksz8873InitHook()

◆ ksz8873ReadPhyReg()

◆ ksz8873ReadSwitchReg()

◆ ksz8873SetAgingTime()

◆ ksz8873SetPortState()

◆ ksz8873SetUnknownMcastFwdPorts()

◆ ksz8873TagFrame()

◆ ksz8873Tick()

◆ ksz8873UntagFrame()

◆ ksz8873WritePhyReg()

◆ ksz8873WriteSwitchReg()

Variable Documentation

◆ ksz8873IngressTailTag

◆ ksz8873SwitchDriver