KSZ9563 3-port Gigabit Ethernet switch driver. More...

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	ksz9563Init (NetInterface *interface)
	KSZ9563 Ethernet switch initialization. More...

__weak_func void	ksz9563InitHook (NetInterface *interface)
	KSZ9563 custom configuration. More...

void	ksz9563Tick (NetInterface *interface)
	KSZ9563 timer handler. More...

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

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

void	ksz9563EventHandler (NetInterface *interface)
	KSZ9563 event handler. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	ksz9563WriteMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...

uint16_t	ksz9563ReadMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...

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

uint8_t	ksz9563ReadSwitchReg8 (NetInterface *interface, uint16_t address)
	Read switch register (8 bits) More...

void	ksz9563WriteSwitchReg16 (NetInterface *interface, uint16_t address, uint16_t data)
	Write switch register (16 bits) More...

uint16_t	ksz9563ReadSwitchReg16 (NetInterface *interface, uint16_t address)
	Read switch register (16 bits) More...

void	ksz9563WriteSwitchReg32 (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch register (32 bits) More...

uint32_t	ksz9563ReadSwitchReg32 (NetInterface *interface, uint16_t address)
	Read switch register (32 bits) More...

Variables
const SwitchDriver	ksz9563SwitchDriver
	KSZ9563 Ethernet switch driver. More...

const uint8_t	ksz9563IngressTailTag [3]
	Tail tag rules (host to KSZ9563) More...

Detailed Description

KSZ9563 3-port Gigabit 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 ksz9563_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file ksz9563_driver.c.

Function Documentation

◆ ksz9563AddStaticFdbEntry()

error_t ksz9563AddStaticFdbEntry	(	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 990 of file ksz9563_driver.c.

◆ ksz9563DeleteStaticFdbEntry()

error_t ksz9563DeleteStaticFdbEntry	(	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 1112 of file ksz9563_driver.c.

◆ ksz9563DisableIrq()

void ksz9563DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 322 of file ksz9563_driver.c.

◆ ksz9563DumpPhyReg()

void ksz9563DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1595 of file ksz9563_driver.c.

◆ ksz9563EnableIgmpSnooping()

void ksz9563EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 901 of file ksz9563_driver.c.

◆ ksz9563EnableIrq()

void ksz9563EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 312 of file ksz9563_driver.c.

◆ ksz9563EnableMldSnooping()

void ksz9563EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 931 of file ksz9563_driver.c.

◆ ksz9563EnableRsvdMcastTable()

void ksz9563EnableRsvdMcastTable	(	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 961 of file ksz9563_driver.c.

◆ ksz9563EventHandler()

void ksz9563EventHandler ( NetInterface * interface )

KSZ9563 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 332 of file ksz9563_driver.c.

◆ ksz9563FlushDynamicFdbTable()

void ksz9563FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1433 of file ksz9563_driver.c.

◆ ksz9563FlushStaticFdbTable()

void ksz9563FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1289 of file ksz9563_driver.c.

◆ ksz9563GetDuplexMode()

NicDuplexMode ksz9563GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns: Duplex mode

Definition at line 697 of file ksz9563_driver.c.

◆ ksz9563GetDynamicFdbEntry()

error_t ksz9563GetDynamicFdbEntry	(	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 1338 of file ksz9563_driver.c.

◆ ksz9563GetLinkSpeed()

uint32_t ksz9563GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns: Link speed

Definition at line 602 of file ksz9563_driver.c.

◆ ksz9563GetLinkState()

bool_t ksz9563GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns: Link state

Definition at line 568 of file ksz9563_driver.c.

◆ ksz9563GetPortState()

SwitchPortState ksz9563GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns: Port state

Definition at line 817 of file ksz9563_driver.c.

◆ ksz9563GetStaticFdbEntry()

error_t ksz9563GetStaticFdbEntry	(	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 1192 of file ksz9563_driver.c.

◆ ksz9563Init()

error_t ksz9563Init ( NetInterface * interface )

KSZ9563 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 91 of file ksz9563_driver.c.

◆ ksz9563InitHook()

__weak_func void ksz9563InitHook ( NetInterface * interface )

KSZ9563 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 232 of file ksz9563_driver.c.

◆ ksz9563ReadMmdReg()

uint16_t ksz9563ReadMmdReg	(	NetInterface *	interface,
		uint8_t	port,
		uint8_t	devAddr,
		uint16_t	regAddr
	)

Read MMD register.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	devAddr	Device address
[in]	regAddr	Register address

Returns: Register value

Definition at line 1649 of file ksz9563_driver.c.

◆ ksz9563ReadPhyReg()

uint16_t ksz9563ReadPhyReg	(	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 1559 of file ksz9563_driver.c.

◆ ksz9563ReadSwitchReg16()

uint16_t ksz9563ReadSwitchReg16	(	NetInterface *	interface,
		uint16_t	address
	)

Read switch register (16 bits)

Parameters

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

Returns: Register value

Definition at line 1809 of file ksz9563_driver.c.

◆ ksz9563ReadSwitchReg32()

uint32_t ksz9563ReadSwitchReg32	(	NetInterface *	interface,
		uint16_t	address
	)

Read switch register (32 bits)

Parameters

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

Returns: Register value

Definition at line 1903 of file ksz9563_driver.c.

◆ ksz9563ReadSwitchReg8()

uint8_t ksz9563ReadSwitchReg8	(	NetInterface *	interface,
		uint16_t	address
	)

Read switch register (8 bits)

Parameters

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

Returns: Register value

Definition at line 1718 of file ksz9563_driver.c.

◆ ksz9563SetAgingTime()

void ksz9563SetAgingTime	(	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 880 of file ksz9563_driver.c.

◆ ksz9563SetPortState()

void ksz9563SetPortState	(	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 761 of file ksz9563_driver.c.

◆ ksz9563SetUnknownMcastFwdPorts()

void ksz9563SetUnknownMcastFwdPorts	(	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 1480 of file ksz9563_driver.c.

◆ ksz9563TagFrame()

error_t ksz9563TagFrame	(	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 457 of file ksz9563_driver.c.

◆ ksz9563Tick()

void ksz9563Tick ( NetInterface * interface )

KSZ9563 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 242 of file ksz9563_driver.c.

◆ ksz9563UntagFrame()

error_t ksz9563UntagFrame	(	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 516 of file ksz9563_driver.c.

◆ ksz9563WriteMmdReg()

void ksz9563WriteMmdReg	(	NetInterface *	interface,
		uint8_t	port,
		uint8_t	devAddr,
		uint16_t	regAddr,
		uint16_t	data
	)

Write MMD register.

Parameters

[in]	interface	Underlying network interface
[in]	port	Port number
[in]	devAddr	Device address
[in]	regAddr	Register address
[in]	data	Register value

Definition at line 1621 of file ksz9563_driver.c.

◆ ksz9563WritePhyReg()

void ksz9563WritePhyReg	(	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 1525 of file ksz9563_driver.c.

◆ ksz9563WriteSwitchReg16()

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

Write switch register (16 bits)

Parameters

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

Definition at line 1765 of file ksz9563_driver.c.

◆ ksz9563WriteSwitchReg32()

void ksz9563WriteSwitchReg32	(	NetInterface *	interface,
		uint16_t	address,
		uint32_t	data
	)

Write switch register (32 bits)

Parameters

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

Definition at line 1857 of file ksz9563_driver.c.

◆ ksz9563WriteSwitchReg8()

void ksz9563WriteSwitchReg8	(	NetInterface *	interface,
		uint16_t	address,
		uint8_t	data
	)

Write switch register (8 bits)

Parameters

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

Definition at line 1675 of file ksz9563_driver.c.

Variable Documentation

◆ ksz9563IngressTailTag

const uint8_t ksz9563IngressTailTag[3]

Initial value:

=
{
   KSZ9563_TAIL_TAG_NORMAL_ADDR_LOOKUP,
   KSZ9563_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9563_TAIL_TAG_DEST_PORT1,
   KSZ9563_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9563_TAIL_TAG_DEST_PORT2
}

Tail tag rules (host to KSZ9563)

Definition at line 77 of file ksz9563_driver.c.

◆ ksz9563SwitchDriver

const SwitchDriver ksz9563SwitchDriver

Initial value:

=
{
   ksz9563Init,
   ksz9563Tick,
   ksz9563EnableIrq,
   ksz9563DisableIrq,
   ksz9563EventHandler,
   ksz9563TagFrame,
   ksz9563UntagFrame,
   ksz9563GetLinkState,
   ksz9563GetLinkSpeed,
   ksz9563GetDuplexMode,
   ksz9563SetPortState,
   ksz9563GetPortState,
   ksz9563SetAgingTime,
   ksz9563EnableIgmpSnooping,
   ksz9563EnableMldSnooping,
   ksz9563EnableRsvdMcastTable,
   ksz9563AddStaticFdbEntry,
   ksz9563DeleteStaticFdbEntry,
   ksz9563GetStaticFdbEntry,
   ksz9563FlushStaticFdbTable,
   ksz9563GetDynamicFdbEntry,
   ksz9563FlushDynamicFdbTable,
   ksz9563SetUnknownMcastFwdPorts
}

KSZ9563 Ethernet switch driver.

Definition at line 45 of file ksz9563_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ksz9563AddStaticFdbEntry()

◆ ksz9563DeleteStaticFdbEntry()

◆ ksz9563DisableIrq()

◆ ksz9563DumpPhyReg()

◆ ksz9563EnableIgmpSnooping()

◆ ksz9563EnableIrq()

◆ ksz9563EnableMldSnooping()

◆ ksz9563EnableRsvdMcastTable()

◆ ksz9563EventHandler()

◆ ksz9563FlushDynamicFdbTable()

◆ ksz9563FlushStaticFdbTable()

◆ ksz9563GetDuplexMode()

◆ ksz9563GetDynamicFdbEntry()

◆ ksz9563GetLinkSpeed()

◆ ksz9563GetLinkState()

◆ ksz9563GetPortState()

◆ ksz9563GetStaticFdbEntry()

◆ ksz9563Init()

◆ ksz9563InitHook()

◆ ksz9563ReadMmdReg()

◆ ksz9563ReadPhyReg()

◆ ksz9563ReadSwitchReg16()

◆ ksz9563ReadSwitchReg32()

◆ ksz9563ReadSwitchReg8()

◆ ksz9563SetAgingTime()

◆ ksz9563SetPortState()

◆ ksz9563SetUnknownMcastFwdPorts()

◆ ksz9563TagFrame()

◆ ksz9563Tick()

◆ ksz9563UntagFrame()

◆ ksz9563WriteMmdReg()

◆ ksz9563WritePhyReg()

◆ ksz9563WriteSwitchReg16()

◆ ksz9563WriteSwitchReg32()

◆ ksz9563WriteSwitchReg8()

Variable Documentation

◆ ksz9563IngressTailTag

◆ ksz9563SwitchDriver