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

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	ksz8463Init (NetInterface *interface)
	KSZ8463 Ethernet switch initialization. More...

__weak_func void	ksz8463InitHook (NetInterface *interface)
	KSZ8463 custom configuration. More...

void	ksz8463Tick (NetInterface *interface)
	KSZ8463 timer handler. More...

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

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

void	ksz8463EventHandler (NetInterface *interface)
	KSZ8463 event handler. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Variables
const SwitchDriver	ksz8463SwitchDriver
	KSZ8463 Ethernet switch driver. More...

const uint8_t	ksz8463IngressTailTag [3]
	Tail tag rules (host to KSZ8463) More...

Detailed Description

KSZ8463 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 ksz8463_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file ksz8463_driver.c.

Function Documentation

◆ ksz8463AddStaticFdbEntry()

error_t ksz8463AddStaticFdbEntry	(	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 855 of file ksz8463_driver.c.

◆ ksz8463DeleteStaticFdbEntry()

error_t ksz8463DeleteStaticFdbEntry	(	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 950 of file ksz8463_driver.c.

◆ ksz8463DisableIrq()

void ksz8463DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 273 of file ksz8463_driver.c.

◆ ksz8463DumpPhyReg()

void ksz8463DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1315 of file ksz8463_driver.c.

◆ ksz8463DumpSwitchReg()

void ksz8463DumpSwitchReg ( NetInterface * interface )

Dump switch registers for debugging purpose.

Parameters

[in] interface Underlying network interface

Definition at line 1449 of file ksz8463_driver.c.

◆ ksz8463EnableIgmpSnooping()

void ksz8463EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 802 of file ksz8463_driver.c.

◆ ksz8463EnableIrq()

void ksz8463EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 263 of file ksz8463_driver.c.

◆ ksz8463EnableMldSnooping()

void ksz8463EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 830 of file ksz8463_driver.c.

◆ ksz8463EnableRsvdMcastTable()

void ksz8463EnableRsvdMcastTable	(	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 842 of file ksz8463_driver.c.

◆ ksz8463EventHandler()

void ksz8463EventHandler ( NetInterface * interface )

KSZ8463 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 283 of file ksz8463_driver.c.

◆ ksz8463FlushDynamicFdbTable()

void ksz8463FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1204 of file ksz8463_driver.c.

◆ ksz8463FlushStaticFdbTable()

void ksz8463FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1075 of file ksz8463_driver.c.

◆ ksz8463GetDuplexMode()

NicDuplexMode ksz8463GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns: Duplex mode

Definition at line 617 of file ksz8463_driver.c.

◆ ksz8463GetDynamicFdbEntry()

error_t ksz8463GetDynamicFdbEntry	(	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 1115 of file ksz8463_driver.c.

◆ ksz8463GetLinkSpeed()

uint32_t ksz8463GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns: Link speed

Definition at line 563 of file ksz8463_driver.c.

◆ ksz8463GetLinkState()

bool_t ksz8463GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns: Link state

Definition at line 519 of file ksz8463_driver.c.

◆ ksz8463GetPortState()

SwitchPortState ksz8463GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns: Port state

Definition at line 727 of file ksz8463_driver.c.

◆ ksz8463GetStaticFdbEntry()

error_t ksz8463GetStaticFdbEntry	(	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 1009 of file ksz8463_driver.c.

◆ ksz8463Init()

error_t ksz8463Init ( NetInterface * interface )

KSZ8463 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 91 of file ksz8463_driver.c.

◆ ksz8463InitHook()

__weak_func void ksz8463InitHook ( NetInterface * interface )

KSZ8463 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 183 of file ksz8463_driver.c.

◆ ksz8463ReadPhyReg()

uint16_t ksz8463ReadPhyReg	(	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 1289 of file ksz8463_driver.c.

◆ ksz8463ReadSwitchReg()

uint16_t ksz8463ReadSwitchReg	(	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 1393 of file ksz8463_driver.c.

◆ ksz8463SetAgingTime()

void ksz8463SetAgingTime	(	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 790 of file ksz8463_driver.c.

◆ ksz8463SetPortState()

void ksz8463SetPortState	(	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 671 of file ksz8463_driver.c.

◆ ksz8463SetUnknownMcastFwdPorts()

void ksz8463SetUnknownMcastFwdPorts	(	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 1251 of file ksz8463_driver.c.

◆ ksz8463TagFrame()

error_t ksz8463TagFrame	(	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 ksz8463_driver.c.

◆ ksz8463Tick()

void ksz8463Tick ( NetInterface * interface )

KSZ8463 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 193 of file ksz8463_driver.c.

◆ ksz8463UntagFrame()

error_t ksz8463UntagFrame	(	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 467 of file ksz8463_driver.c.

◆ ksz8463WritePhyReg()

void ksz8463WritePhyReg	(	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 1266 of file ksz8463_driver.c.

◆ ksz8463WriteSwitchReg()

void ksz8463WriteSwitchReg	(	NetInterface *	interface,
		uint16_t	address,
		uint16_t	data
	)

Write switch register.

Parameters

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

Definition at line 1339 of file ksz8463_driver.c.

Variable Documentation

◆ ksz8463IngressTailTag

const uint8_t ksz8463IngressTailTag[3]

Initial value:

=
{
   KSZ8463_TAIL_TAG_NORMAL_ADDR_LOOKUP,
   KSZ8463_TAIL_TAG_DEST_PORT1,
   KSZ8463_TAIL_TAG_DEST_PORT2
}

Tail tag rules (host to KSZ8463)

Definition at line 77 of file ksz8463_driver.c.

◆ ksz8463SwitchDriver

const SwitchDriver ksz8463SwitchDriver

Initial value:

=
{
   ksz8463Init,
   ksz8463Tick,
   ksz8463EnableIrq,
   ksz8463DisableIrq,
   ksz8463EventHandler,
   ksz8463TagFrame,
   ksz8463UntagFrame,
   ksz8463GetLinkState,
   ksz8463GetLinkSpeed,
   ksz8463GetDuplexMode,
   ksz8463SetPortState,
   ksz8463GetPortState,
   ksz8463SetAgingTime,
   ksz8463EnableIgmpSnooping,
   ksz8463EnableMldSnooping,
   ksz8463EnableRsvdMcastTable,
   ksz8463AddStaticFdbEntry,
   ksz8463DeleteStaticFdbEntry,
   ksz8463GetStaticFdbEntry,
   ksz8463FlushStaticFdbTable,
   ksz8463GetDynamicFdbEntry,
   ksz8463FlushDynamicFdbTable,
   ksz8463SetUnknownMcastFwdPorts
}

KSZ8463 Ethernet switch driver.

Definition at line 45 of file ksz8463_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ksz8463AddStaticFdbEntry()

◆ ksz8463DeleteStaticFdbEntry()

◆ ksz8463DisableIrq()

◆ ksz8463DumpPhyReg()

◆ ksz8463DumpSwitchReg()

◆ ksz8463EnableIgmpSnooping()

◆ ksz8463EnableIrq()

◆ ksz8463EnableMldSnooping()

◆ ksz8463EnableRsvdMcastTable()

◆ ksz8463EventHandler()

◆ ksz8463FlushDynamicFdbTable()

◆ ksz8463FlushStaticFdbTable()

◆ ksz8463GetDuplexMode()

◆ ksz8463GetDynamicFdbEntry()

◆ ksz8463GetLinkSpeed()

◆ ksz8463GetLinkState()

◆ ksz8463GetPortState()

◆ ksz8463GetStaticFdbEntry()

◆ ksz8463Init()

◆ ksz8463InitHook()

◆ ksz8463ReadPhyReg()

◆ ksz8463ReadSwitchReg()

◆ ksz8463SetAgingTime()

◆ ksz8463SetPortState()

◆ ksz8463SetUnknownMcastFwdPorts()

◆ ksz8463TagFrame()

◆ ksz8463Tick()

◆ ksz8463UntagFrame()

◆ ksz8463WritePhyReg()

◆ ksz8463WriteSwitchReg()

Variable Documentation

◆ ksz8463IngressTailTag

◆ ksz8463SwitchDriver