KSZ8895 5-port Ethernet switch driver. More...

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	ksz8895Init (NetInterface *interface)
	KSZ8895 Ethernet switch initialization. More...

__weak_func void	ksz8895InitHook (NetInterface *interface)
	KSZ8895 custom configuration. More...

__weak_func void	ksz8895Tick (NetInterface *interface)
	KSZ8895 timer handler. More...

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

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

__weak_func void	ksz8895EventHandler (NetInterface *interface)
	KSZ8895 event handler. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

error_t	ksz8895WriteVlanEntry (NetInterface interface, const SwitchVlanEntry entry)
	Write VLAN entry. More...

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

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

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

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

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

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

Variables
const SwitchDriver	ksz8895SwitchDriver
	KSZ8895 Ethernet switch driver. More...

const uint8_t	ksz8895IngressTailTag [5]
	Tail tag rules (host to KSZ8895) More...

Detailed Description

KSZ8895 5-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.5.4

Definition in file ksz8895_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file ksz8895_driver.c.

Function Documentation

◆ ksz8895AddStaticFdbEntry()

error_t ksz8895AddStaticFdbEntry	(	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 870 of file ksz8895_driver.c.

◆ ksz8895DeleteStaticFdbEntry()

error_t ksz8895DeleteStaticFdbEntry	(	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 972 of file ksz8895_driver.c.

◆ ksz8895DisableIrq()

void ksz8895DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 284 of file ksz8895_driver.c.

◆ ksz8895DumpPhyReg()

void ksz8895DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1471 of file ksz8895_driver.c.

◆ ksz8895DumpSwitchReg()

void ksz8895DumpSwitchReg ( NetInterface * interface )

Dump switch registers for debugging purpose.

Parameters

[in] interface Underlying network interface

Definition at line 1606 of file ksz8895_driver.c.

◆ ksz8895EnableIgmpSnooping()

void ksz8895EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 788 of file ksz8895_driver.c.

◆ ksz8895EnableIrq()

void ksz8895EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 274 of file ksz8895_driver.c.

◆ ksz8895EnableMldSnooping()

void ksz8895EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 816 of file ksz8895_driver.c.

◆ ksz8895EnableRsvdMcastTable()

void ksz8895EnableRsvdMcastTable	(	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 828 of file ksz8895_driver.c.

◆ ksz8895EventHandler()

__weak_func void ksz8895EventHandler ( NetInterface * interface )

KSZ8895 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 294 of file ksz8895_driver.c.

◆ ksz8895FlushDynamicFdbTable()

void ksz8895FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1271 of file ksz8895_driver.c.

◆ ksz8895FlushStaticFdbTable()

void ksz8895FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1103 of file ksz8895_driver.c.

◆ ksz8895GetDuplexMode()

NicDuplexMode ksz8895GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns: Duplex mode

Definition at line 603 of file ksz8895_driver.c.

◆ ksz8895GetDynamicFdbEntry()

error_t ksz8895GetDynamicFdbEntry	(	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 1187 of file ksz8895_driver.c.

◆ ksz8895GetLinkSpeed()

uint32_t ksz8895GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns: Link speed

Definition at line 549 of file ksz8895_driver.c.

◆ ksz8895GetLinkState()

bool_t ksz8895GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns: Link state

Definition at line 517 of file ksz8895_driver.c.

◆ ksz8895GetPortState()

SwitchPortState ksz8895GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns: Port state

Definition at line 713 of file ksz8895_driver.c.

◆ ksz8895GetStaticFdbEntry()

error_t ksz8895GetStaticFdbEntry	(	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 1041 of file ksz8895_driver.c.

◆ ksz8895Init()

error_t ksz8895Init ( NetInterface * interface )

KSZ8895 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 93 of file ksz8895_driver.c.

◆ ksz8895InitHook()

__weak_func void ksz8895InitHook ( NetInterface * interface )

KSZ8895 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 194 of file ksz8895_driver.c.

◆ ksz8895ReadPhyReg()

uint16_t ksz8895ReadPhyReg	(	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 1445 of file ksz8895_driver.c.

◆ ksz8895ReadSwitchReg()

uint8_t ksz8895ReadSwitchReg	(	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 1550 of file ksz8895_driver.c.

◆ ksz8895SetAgingTime()

void ksz8895SetAgingTime	(	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 776 of file ksz8895_driver.c.

◆ ksz8895SetPortState()

void ksz8895SetPortState	(	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 657 of file ksz8895_driver.c.

◆ ksz8895SetUnknownMcastFwdPorts()

void ksz8895SetUnknownMcastFwdPorts	(	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 1142 of file ksz8895_driver.c.

◆ ksz8895TagFrame()

error_t ksz8895TagFrame	(	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 419 of file ksz8895_driver.c.

◆ ksz8895Tick()

__weak_func void ksz8895Tick ( NetInterface * interface )

KSZ8895 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 204 of file ksz8895_driver.c.

◆ ksz8895UntagFrame()

error_t ksz8895UntagFrame	(	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 474 of file ksz8895_driver.c.

◆ ksz8895WritePhyReg()

void ksz8895WritePhyReg	(	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 1422 of file ksz8895_driver.c.

◆ ksz8895WriteSwitchReg()

void ksz8895WriteSwitchReg	(	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 1495 of file ksz8895_driver.c.

◆ ksz8895WriteVlanEntry()

error_t ksz8895WriteVlanEntry	(	NetInterface *	interface,
		const SwitchVlanEntry *	entry
	)

Write VLAN entry.

Parameters

[in]	interface	Underlying network interface
[in]	entry	VLAN entry

Returns: Error code

Definition at line 1318 of file ksz8895_driver.c.

Variable Documentation

◆ ksz8895IngressTailTag

const uint8_t ksz8895IngressTailTag[5]

Initial value:

=
{
   KSZ8895_TAIL_TAG_NORMAL_ADDR_LOOKUP,
   KSZ8895_TAIL_TAG_PORT_SEL | KSZ8895_TAIL_TAG_DEST_PORT1,
   KSZ8895_TAIL_TAG_PORT_SEL | KSZ8895_TAIL_TAG_DEST_PORT2,
   KSZ8895_TAIL_TAG_PORT_SEL | KSZ8895_TAIL_TAG_DEST_PORT3,
   KSZ8895_TAIL_TAG_PORT_SEL | KSZ8895_TAIL_TAG_DEST_PORT4
}

Tail tag rules (host to KSZ8895)

Definition at line 77 of file ksz8895_driver.c.

◆ ksz8895SwitchDriver

const SwitchDriver ksz8895SwitchDriver

Initial value:

KSZ8895 Ethernet switch driver.

Definition at line 45 of file ksz8895_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ksz8895AddStaticFdbEntry()

◆ ksz8895DeleteStaticFdbEntry()

◆ ksz8895DisableIrq()

◆ ksz8895DumpPhyReg()

◆ ksz8895DumpSwitchReg()

◆ ksz8895EnableIgmpSnooping()

◆ ksz8895EnableIrq()

◆ ksz8895EnableMldSnooping()

◆ ksz8895EnableRsvdMcastTable()

◆ ksz8895EventHandler()

◆ ksz8895FlushDynamicFdbTable()

◆ ksz8895FlushStaticFdbTable()

◆ ksz8895GetDuplexMode()

◆ ksz8895GetDynamicFdbEntry()

◆ ksz8895GetLinkSpeed()

◆ ksz8895GetLinkState()

◆ ksz8895GetPortState()

◆ ksz8895GetStaticFdbEntry()

◆ ksz8895Init()

◆ ksz8895InitHook()

◆ ksz8895ReadPhyReg()

◆ ksz8895ReadSwitchReg()

◆ ksz8895SetAgingTime()

◆ ksz8895SetPortState()

◆ ksz8895SetUnknownMcastFwdPorts()

◆ ksz8895TagFrame()

◆ ksz8895Tick()

◆ ksz8895UntagFrame()

◆ ksz8895WritePhyReg()

◆ ksz8895WriteSwitchReg()

◆ ksz8895WriteVlanEntry()

Variable Documentation

◆ ksz8895IngressTailTag

◆ ksz8895SwitchDriver