KSZ8864 4-port Ethernet switch driver. More...

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	ksz8864Init (NetInterface *interface)
	KSZ8864 Ethernet switch initialization. More...

__weak_func void	ksz8864InitHook (NetInterface *interface)
	KSZ8864 custom configuration. More...

void	ksz8864Tick (NetInterface *interface)
	KSZ8864 timer handler. More...

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

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

void	ksz8864EventHandler (NetInterface *interface)
	KSZ8864 event handler. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Variables
const SwitchDriver	ksz8864SwitchDriver
	KSZ8864 Ethernet switch driver. More...

const uint8_t	ksz8864IngressTailTag [4]
	Tail tag rules (host to KSZ8864) More...

Detailed Description

KSZ8864 4-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 ksz8864_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file ksz8864_driver.c.

Function Documentation

◆ ksz8864AddStaticFdbEntry()

error_t ksz8864AddStaticFdbEntry	(	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 888 of file ksz8864_driver.c.

◆ ksz8864DeleteStaticFdbEntry()

error_t ksz8864DeleteStaticFdbEntry	(	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 991 of file ksz8864_driver.c.

◆ ksz8864DisableIrq()

void ksz8864DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 283 of file ksz8864_driver.c.

◆ ksz8864DumpPhyReg()

void ksz8864DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1387 of file ksz8864_driver.c.

◆ ksz8864DumpSwitchReg()

void ksz8864DumpSwitchReg ( NetInterface * interface )

Dump switch registers for debugging purpose.

Parameters

[in] interface Underlying network interface

Definition at line 1522 of file ksz8864_driver.c.

◆ ksz8864EnableIgmpSnooping()

void ksz8864EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 806 of file ksz8864_driver.c.

◆ ksz8864EnableIrq()

void ksz8864EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 273 of file ksz8864_driver.c.

◆ ksz8864EnableMldSnooping()

void ksz8864EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 834 of file ksz8864_driver.c.

◆ ksz8864EnableRsvdMcastTable()

void ksz8864EnableRsvdMcastTable	(	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 846 of file ksz8864_driver.c.

◆ ksz8864EventHandler()

void ksz8864EventHandler ( NetInterface * interface )

KSZ8864 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 293 of file ksz8864_driver.c.

◆ ksz8864FlushDynamicFdbTable()

void ksz8864FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1246 of file ksz8864_driver.c.

◆ ksz8864FlushStaticFdbTable()

void ksz8864FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1122 of file ksz8864_driver.c.

◆ ksz8864GetDuplexMode()

NicDuplexMode ksz8864GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns: Duplex mode

Definition at line 616 of file ksz8864_driver.c.

◆ ksz8864GetDynamicFdbEntry()

error_t ksz8864GetDynamicFdbEntry	(	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 1162 of file ksz8864_driver.c.

◆ ksz8864GetLinkSpeed()

uint32_t ksz8864GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns: Link speed

Definition at line 557 of file ksz8864_driver.c.

◆ ksz8864GetLinkState()

bool_t ksz8864GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns: Link state

Definition at line 520 of file ksz8864_driver.c.

◆ ksz8864GetPortState()

SwitchPortState ksz8864GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns: Port state

Definition at line 731 of file ksz8864_driver.c.

◆ ksz8864GetStaticFdbEntry()

error_t ksz8864GetStaticFdbEntry	(	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 1060 of file ksz8864_driver.c.

◆ ksz8864Init()

error_t ksz8864Init ( NetInterface * interface )

KSZ8864 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 92 of file ksz8864_driver.c.

◆ ksz8864InitHook()

__weak_func void ksz8864InitHook ( NetInterface * interface )

KSZ8864 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 193 of file ksz8864_driver.c.

◆ ksz8864ReadPhyReg()

uint16_t ksz8864ReadPhyReg	(	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 1361 of file ksz8864_driver.c.

◆ ksz8864ReadSwitchReg()

uint8_t ksz8864ReadSwitchReg	(	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 1466 of file ksz8864_driver.c.

◆ ksz8864SetAgingTime()

void ksz8864SetAgingTime	(	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 794 of file ksz8864_driver.c.

◆ ksz8864SetPortState()

void ksz8864SetPortState	(	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 675 of file ksz8864_driver.c.

◆ ksz8864SetUnknownMcastFwdPorts()

void ksz8864SetUnknownMcastFwdPorts	(	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 1293 of file ksz8864_driver.c.

◆ ksz8864TagFrame()

error_t ksz8864TagFrame	(	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 422 of file ksz8864_driver.c.

◆ ksz8864Tick()

void ksz8864Tick ( NetInterface * interface )

KSZ8864 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 203 of file ksz8864_driver.c.

◆ ksz8864UntagFrame()

error_t ksz8864UntagFrame	(	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 477 of file ksz8864_driver.c.

◆ ksz8864WritePhyReg()

void ksz8864WritePhyReg	(	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 1338 of file ksz8864_driver.c.

◆ ksz8864WriteSwitchReg()

void ksz8864WriteSwitchReg	(	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 1411 of file ksz8864_driver.c.

Variable Documentation

◆ ksz8864IngressTailTag

const uint8_t ksz8864IngressTailTag[4]

Initial value:

=
{
   KSZ8864_TAIL_TAG_NORMAL_ADDR_LOOKUP,
   KSZ8864_TAIL_TAG_PORT_SEL | KSZ8864_TAIL_TAG_DEST_PORT1,
   KSZ8864_TAIL_TAG_PORT_SEL | KSZ8864_TAIL_TAG_DEST_PORT2,
   KSZ8864_TAIL_TAG_PORT_SEL | KSZ8864_TAIL_TAG_DEST_PORT3
}

Tail tag rules (host to KSZ8864)

Definition at line 77 of file ksz8864_driver.c.

◆ ksz8864SwitchDriver

const SwitchDriver ksz8864SwitchDriver

Initial value:

=
{
   ksz8864Init,
   ksz8864Tick,
   ksz8864EnableIrq,
   ksz8864DisableIrq,
   ksz8864EventHandler,
   ksz8864TagFrame,
   ksz8864UntagFrame,
   ksz8864GetLinkState,
   ksz8864GetLinkSpeed,
   ksz8864GetDuplexMode,
   ksz8864SetPortState,
   ksz8864GetPortState,
   ksz8864SetAgingTime,
   ksz8864EnableIgmpSnooping,
   ksz8864EnableMldSnooping,
   ksz8864EnableRsvdMcastTable,
   ksz8864AddStaticFdbEntry,
   ksz8864DeleteStaticFdbEntry,
   ksz8864GetStaticFdbEntry,
   ksz8864FlushStaticFdbTable,
   ksz8864GetDynamicFdbEntry,
   ksz8864FlushDynamicFdbTable,
   ksz8864SetUnknownMcastFwdPorts
}

KSZ8864 Ethernet switch driver.

Definition at line 45 of file ksz8864_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ksz8864AddStaticFdbEntry()

◆ ksz8864DeleteStaticFdbEntry()

◆ ksz8864DisableIrq()

◆ ksz8864DumpPhyReg()

◆ ksz8864DumpSwitchReg()

◆ ksz8864EnableIgmpSnooping()

◆ ksz8864EnableIrq()

◆ ksz8864EnableMldSnooping()

◆ ksz8864EnableRsvdMcastTable()

◆ ksz8864EventHandler()

◆ ksz8864FlushDynamicFdbTable()

◆ ksz8864FlushStaticFdbTable()

◆ ksz8864GetDuplexMode()

◆ ksz8864GetDynamicFdbEntry()

◆ ksz8864GetLinkSpeed()

◆ ksz8864GetLinkState()

◆ ksz8864GetPortState()

◆ ksz8864GetStaticFdbEntry()

◆ ksz8864Init()

◆ ksz8864InitHook()

◆ ksz8864ReadPhyReg()

◆ ksz8864ReadSwitchReg()

◆ ksz8864SetAgingTime()

◆ ksz8864SetPortState()

◆ ksz8864SetUnknownMcastFwdPorts()

◆ ksz8864TagFrame()

◆ ksz8864Tick()

◆ ksz8864UntagFrame()

◆ ksz8864WritePhyReg()

◆ ksz8864WriteSwitchReg()

Variable Documentation

◆ ksz8864IngressTailTag

◆ ksz8864SwitchDriver