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

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	ksz8795Init (NetInterface *interface)
	KSZ8795 Ethernet switch initialization. More...

__weak_func void	ksz8795InitHook (NetInterface *interface)
	KSZ8795 custom configuration. More...

void	ksz8795Tick (NetInterface *interface)
	KSZ8795 timer handler. More...

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

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

void	ksz8795EventHandler (NetInterface *interface)
	KSZ8795 event handler. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Variables
const SwitchDriver	ksz8795SwitchDriver
	KSZ8795 Ethernet switch driver. More...

const uint8_t	ksz8795IngressTailTag [5]
	Tail tag rules (host to KSZ8795) More...

Detailed Description

KSZ8795 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.4.0

Definition in file ksz8795_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file ksz8795_driver.c.

Function Documentation

◆ ksz8795AddStaticFdbEntry()

error_t ksz8795AddStaticFdbEntry	(	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 967 of file ksz8795_driver.c.

◆ ksz8795DeleteStaticFdbEntry()

error_t ksz8795DeleteStaticFdbEntry	(	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 1069 of file ksz8795_driver.c.

◆ ksz8795DisableIrq()

void ksz8795DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 300 of file ksz8795_driver.c.

◆ ksz8795DumpPhyReg()

void ksz8795DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1465 of file ksz8795_driver.c.

◆ ksz8795DumpSwitchReg()

void ksz8795DumpSwitchReg ( NetInterface * interface )

Dump switch registers for debugging purpose.

Parameters

[in] interface Underlying network interface

Definition at line 1573 of file ksz8795_driver.c.

◆ ksz8795EnableIgmpSnooping()

void ksz8795EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 869 of file ksz8795_driver.c.

◆ ksz8795EnableIrq()

void ksz8795EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 290 of file ksz8795_driver.c.

◆ ksz8795EnableMldSnooping()

void ksz8795EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 897 of file ksz8795_driver.c.

◆ ksz8795EnableRsvdMcastTable()

void ksz8795EnableRsvdMcastTable	(	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 925 of file ksz8795_driver.c.

◆ ksz8795EventHandler()

void ksz8795EventHandler ( NetInterface * interface )

KSZ8795 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 310 of file ksz8795_driver.c.

◆ ksz8795FlushDynamicFdbTable()

void ksz8795FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1324 of file ksz8795_driver.c.

◆ ksz8795FlushStaticFdbTable()

void ksz8795FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1200 of file ksz8795_driver.c.

◆ ksz8795GetDuplexMode()

NicDuplexMode ksz8795GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns: Duplex mode

Definition at line 674 of file ksz8795_driver.c.

◆ ksz8795GetDynamicFdbEntry()

error_t ksz8795GetDynamicFdbEntry	(	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 1240 of file ksz8795_driver.c.

◆ ksz8795GetLinkSpeed()

uint32_t ksz8795GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns: Link speed

Definition at line 590 of file ksz8795_driver.c.

◆ ksz8795GetLinkState()

bool_t ksz8795GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns: Link state

Definition at line 546 of file ksz8795_driver.c.

◆ ksz8795GetPortState()

SwitchPortState ksz8795GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns: Port state

Definition at line 794 of file ksz8795_driver.c.

◆ ksz8795GetStaticFdbEntry()

error_t ksz8795GetStaticFdbEntry	(	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 1138 of file ksz8795_driver.c.

◆ ksz8795Init()

error_t ksz8795Init ( NetInterface * interface )

KSZ8795 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 93 of file ksz8795_driver.c.

◆ ksz8795InitHook()

__weak_func void ksz8795InitHook ( NetInterface * interface )

KSZ8795 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 210 of file ksz8795_driver.c.

◆ ksz8795ReadPhyReg()

uint16_t ksz8795ReadPhyReg	(	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 1439 of file ksz8795_driver.c.

◆ ksz8795ReadSwitchReg()

uint8_t ksz8795ReadSwitchReg	(	NetInterface *	interface,
		uint16_t	address
	)

Read switch register.

Parameters

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

Returns: Register value

Definition at line 1530 of file ksz8795_driver.c.

◆ ksz8795SetAgingTime()

void ksz8795SetAgingTime	(	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 857 of file ksz8795_driver.c.

◆ ksz8795SetPortState()

void ksz8795SetPortState	(	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 738 of file ksz8795_driver.c.

◆ ksz8795SetUnknownMcastFwdPorts()

void ksz8795SetUnknownMcastFwdPorts	(	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 1371 of file ksz8795_driver.c.

◆ ksz8795TagFrame()

error_t ksz8795TagFrame	(	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 435 of file ksz8795_driver.c.

◆ ksz8795Tick()

void ksz8795Tick ( NetInterface * interface )

KSZ8795 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 220 of file ksz8795_driver.c.

◆ ksz8795UntagFrame()

error_t ksz8795UntagFrame	(	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 494 of file ksz8795_driver.c.

◆ ksz8795WritePhyReg()

void ksz8795WritePhyReg	(	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 1416 of file ksz8795_driver.c.

◆ ksz8795WriteSwitchReg()

void ksz8795WriteSwitchReg	(	NetInterface *	interface,
		uint16_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 1489 of file ksz8795_driver.c.

Variable Documentation

◆ ksz8795IngressTailTag

const uint8_t ksz8795IngressTailTag[5]

Initial value:

=
{
   KSZ8795_TAIL_TAG_NORMAL_ADDR_LOOKUP,
   KSZ8795_TAIL_TAG_PORT_SEL | KSZ8795_TAIL_TAG_DEST_PORT1,
   KSZ8795_TAIL_TAG_PORT_SEL | KSZ8795_TAIL_TAG_DEST_PORT2,
   KSZ8795_TAIL_TAG_PORT_SEL | KSZ8795_TAIL_TAG_DEST_PORT3,
   KSZ8795_TAIL_TAG_PORT_SEL | KSZ8795_TAIL_TAG_DEST_PORT4
}

Tail tag rules (host to KSZ8795)

Definition at line 77 of file ksz8795_driver.c.

◆ ksz8795SwitchDriver

const SwitchDriver ksz8795SwitchDriver

Initial value:

=
{
   ksz8795Init,
   ksz8795Tick,
   ksz8795EnableIrq,
   ksz8795DisableIrq,
   ksz8795EventHandler,
   ksz8795TagFrame,
   ksz8795UntagFrame,
   ksz8795GetLinkState,
   ksz8795GetLinkSpeed,
   ksz8795GetDuplexMode,
   ksz8795SetPortState,
   ksz8795GetPortState,
   ksz8795SetAgingTime,
   ksz8795EnableIgmpSnooping,
   ksz8795EnableMldSnooping,
   ksz8795EnableRsvdMcastTable,
   ksz8795AddStaticFdbEntry,
   ksz8795DeleteStaticFdbEntry,
   ksz8795GetStaticFdbEntry,
   ksz8795FlushStaticFdbTable,
   ksz8795GetDynamicFdbEntry,
   ksz8795FlushDynamicFdbTable,
   ksz8795SetUnknownMcastFwdPorts
}

KSZ8795 Ethernet switch driver.

Definition at line 45 of file ksz8795_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ksz8795AddStaticFdbEntry()

◆ ksz8795DeleteStaticFdbEntry()

◆ ksz8795DisableIrq()

◆ ksz8795DumpPhyReg()

◆ ksz8795DumpSwitchReg()

◆ ksz8795EnableIgmpSnooping()

◆ ksz8795EnableIrq()

◆ ksz8795EnableMldSnooping()

◆ ksz8795EnableRsvdMcastTable()

◆ ksz8795EventHandler()

◆ ksz8795FlushDynamicFdbTable()

◆ ksz8795FlushStaticFdbTable()

◆ ksz8795GetDuplexMode()

◆ ksz8795GetDynamicFdbEntry()

◆ ksz8795GetLinkSpeed()

◆ ksz8795GetLinkState()

◆ ksz8795GetPortState()

◆ ksz8795GetStaticFdbEntry()

◆ ksz8795Init()

◆ ksz8795InitHook()

◆ ksz8795ReadPhyReg()

◆ ksz8795ReadSwitchReg()

◆ ksz8795SetAgingTime()

◆ ksz8795SetPortState()

◆ ksz8795SetUnknownMcastFwdPorts()

◆ ksz8795TagFrame()

◆ ksz8795Tick()

◆ ksz8795UntagFrame()

◆ ksz8795WritePhyReg()

◆ ksz8795WriteSwitchReg()

Variable Documentation

◆ ksz8795IngressTailTag

◆ ksz8795SwitchDriver