ksz8563_driver.c File Reference

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

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

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NIC_TRACE_LEVEL

Functions
error_t	ksz8563Init (NetInterface *interface)
	KSZ8563 Ethernet switch initialization. More...
__weak_func void	ksz8563InitHook (NetInterface *interface)
	KSZ8563 custom configuration. More...
__weak_func void	ksz8563Tick (NetInterface *interface)
	KSZ8563 timer handler. More...
void	ksz8563EnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	ksz8563DisableIrq (NetInterface *interface)
	Disable interrupts. More...
__weak_func void	ksz8563EventHandler (NetInterface *interface)
	KSZ8563 event handler. More...
error_t	ksz8563TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
	Add tail tag to Ethernet frame. More...
error_t	ksz8563UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
	Decode tail tag from incoming Ethernet frame. More...
bool_t	ksz8563GetLinkState (NetInterface *interface, uint8_t port)
	Get link state. More...
uint32_t	ksz8563GetLinkSpeed (NetInterface *interface, uint8_t port)
	Get link speed. More...
NicDuplexMode	ksz8563GetDuplexMode (NetInterface *interface, uint8_t port)
	Get duplex mode. More...
void	ksz8563SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
	Set port state. More...
SwitchPortState	ksz8563GetPortState (NetInterface *interface, uint8_t port)
	Get port state. More...
void	ksz8563SetAgingTime (NetInterface *interface, uint32_t agingTime)
	Set aging time for dynamic filtering entries. More...
void	ksz8563EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...
void	ksz8563EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. More...
void	ksz8563EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
	Enable reserved multicast table. More...
error_t	ksz8563AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Add a new entry to the static MAC table. More...
error_t	ksz8563DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Remove an entry from the static MAC table. More...
error_t	ksz8563GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the static MAC table. More...
void	ksz8563FlushStaticFdbTable (NetInterface *interface)
	Flush static MAC table. More...
error_t	ksz8563GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the dynamic MAC table. More...
void	ksz8563FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
	Flush dynamic MAC table. More...
void	ksz8563SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. More...
void	ksz8563WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
	Write PHY register. More...
uint16_t	ksz8563ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
	Read PHY register. More...
void	ksz8563DumpPhyReg (NetInterface *interface, uint8_t port)
	Dump PHY registers for debugging purpose. More...
void	ksz8563WriteMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...
uint16_t	ksz8563ReadMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...
void	ksz8563WriteSwitchReg8 (NetInterface *interface, uint16_t address, uint8_t data)
	Write switch register (8 bits) More...
uint8_t	ksz8563ReadSwitchReg8 (NetInterface *interface, uint16_t address)
	Read switch register (8 bits) More...
void	ksz8563WriteSwitchReg16 (NetInterface *interface, uint16_t address, uint16_t data)
	Write switch register (16 bits) More...
uint16_t	ksz8563ReadSwitchReg16 (NetInterface *interface, uint16_t address)
	Read switch register (16 bits) More...
void	ksz8563WriteSwitchReg32 (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch register (32 bits) More...
uint32_t	ksz8563ReadSwitchReg32 (NetInterface *interface, uint16_t address)
	Read switch register (32 bits) More...

Variables
const SwitchDriver	ksz8563SwitchDriver
	KSZ8563 Ethernet switch driver. More...
const uint8_t	ksz8563IngressTailTag [3]
	Tail tag rules (host to KSZ8563) More...

Detailed Description

KSZ8563 3-port Ethernet switch driver.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.

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 ksz8563_driver.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz8563_driver.c.

Function Documentation

ksz8563AddStaticFdbEntry()

error_t ksz8563AddStaticFdbEntry	(	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 984 of file ksz8563_driver.c.

ksz8563DeleteStaticFdbEntry()

error_t ksz8563DeleteStaticFdbEntry	(	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 1106 of file ksz8563_driver.c.

ksz8563DisableIrq()

void ksz8563DisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 321 of file ksz8563_driver.c.

ksz8563DumpPhyReg()

void ksz8563DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1589 of file ksz8563_driver.c.

ksz8563EnableIgmpSnooping()

void ksz8563EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 895 of file ksz8563_driver.c.

ksz8563EnableIrq()

void ksz8563EnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 311 of file ksz8563_driver.c.

ksz8563EnableMldSnooping()

void ksz8563EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 925 of file ksz8563_driver.c.

ksz8563EnableRsvdMcastTable()

void ksz8563EnableRsvdMcastTable	(	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 955 of file ksz8563_driver.c.

ksz8563EventHandler()

__weak_func void ksz8563EventHandler

(

NetInterface *

interface

)

KSZ8563 event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 331 of file ksz8563_driver.c.

ksz8563FlushDynamicFdbTable()

void ksz8563FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1427 of file ksz8563_driver.c.

ksz8563FlushStaticFdbTable()

void ksz8563FlushStaticFdbTable

(

NetInterface *

interface

)

Flush static MAC table.

Parameters

[in]

interface

Underlying network interface

Definition at line 1283 of file ksz8563_driver.c.

ksz8563GetDuplexMode()

NicDuplexMode ksz8563GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns

Duplex mode

Definition at line 691 of file ksz8563_driver.c.

ksz8563GetDynamicFdbEntry()

error_t ksz8563GetDynamicFdbEntry	(	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 1332 of file ksz8563_driver.c.

ksz8563GetLinkSpeed()

uint32_t ksz8563GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns

Link speed

Definition at line 601 of file ksz8563_driver.c.

ksz8563GetLinkState()

bool_t ksz8563GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns

Link state

Definition at line 567 of file ksz8563_driver.c.

ksz8563GetPortState()

SwitchPortState ksz8563GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns

Port state

Definition at line 811 of file ksz8563_driver.c.

ksz8563GetStaticFdbEntry()

error_t ksz8563GetStaticFdbEntry	(	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 1186 of file ksz8563_driver.c.

ksz8563Init()

error_t ksz8563Init

(

NetInterface *

interface

)

KSZ8563 Ethernet switch initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 91 of file ksz8563_driver.c.

ksz8563InitHook()

__weak_func void ksz8563InitHook

(

NetInterface *

interface

)

KSZ8563 custom configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 231 of file ksz8563_driver.c.

ksz8563ReadMmdReg()

uint16_t ksz8563ReadMmdReg	(	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 1643 of file ksz8563_driver.c.

ksz8563ReadPhyReg()

uint16_t ksz8563ReadPhyReg	(	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 1553 of file ksz8563_driver.c.

ksz8563ReadSwitchReg16()

uint16_t ksz8563ReadSwitchReg16	(	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 1803 of file ksz8563_driver.c.

ksz8563ReadSwitchReg32()

uint32_t ksz8563ReadSwitchReg32	(	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 1897 of file ksz8563_driver.c.

ksz8563ReadSwitchReg8()

uint8_t ksz8563ReadSwitchReg8	(	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 1712 of file ksz8563_driver.c.

ksz8563SetAgingTime()

void ksz8563SetAgingTime	(	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 874 of file ksz8563_driver.c.

ksz8563SetPortState()

void ksz8563SetPortState	(	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 755 of file ksz8563_driver.c.

ksz8563SetUnknownMcastFwdPorts()

void ksz8563SetUnknownMcastFwdPorts	(	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 1474 of file ksz8563_driver.c.

ksz8563TagFrame()

error_t ksz8563TagFrame	(	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 456 of file ksz8563_driver.c.

ksz8563Tick()

__weak_func void ksz8563Tick

(

NetInterface *

interface

)

KSZ8563 timer handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 241 of file ksz8563_driver.c.

ksz8563UntagFrame()

error_t ksz8563UntagFrame	(	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 515 of file ksz8563_driver.c.

ksz8563WriteMmdReg()

void ksz8563WriteMmdReg	(	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 1615 of file ksz8563_driver.c.

ksz8563WritePhyReg()

void ksz8563WritePhyReg	(	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 1519 of file ksz8563_driver.c.

ksz8563WriteSwitchReg16()

void ksz8563WriteSwitchReg16	(	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 1759 of file ksz8563_driver.c.

ksz8563WriteSwitchReg32()

void ksz8563WriteSwitchReg32	(	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 1851 of file ksz8563_driver.c.

ksz8563WriteSwitchReg8()

void ksz8563WriteSwitchReg8	(	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 1669 of file ksz8563_driver.c.

Variable Documentation

ksz8563IngressTailTag

const uint8_t ksz8563IngressTailTag[3]

Initial value:

=
{
   KSZ8563_TAIL_TAG_NORMAL_ADDR_LOOKUP,
   KSZ8563_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8563_TAIL_TAG_DEST_PORT1,
   KSZ8563_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8563_TAIL_TAG_DEST_PORT2
}

Tail tag rules (host to KSZ8563)

Definition at line 77 of file ksz8563_driver.c.

ksz8563SwitchDriver

const SwitchDriver ksz8563SwitchDriver

Initial value:

=
{
   ksz8563Init,
   ksz8563Tick,
   ksz8563EnableIrq,
   ksz8563DisableIrq,
   ksz8563EventHandler,
   ksz8563TagFrame,
   ksz8563UntagFrame,
   ksz8563GetLinkState,
   ksz8563GetLinkSpeed,
   ksz8563GetDuplexMode,
   ksz8563SetPortState,
   ksz8563GetPortState,
   ksz8563SetAgingTime,
   ksz8563EnableIgmpSnooping,
   ksz8563EnableMldSnooping,
   ksz8563EnableRsvdMcastTable,
   ksz8563AddStaticFdbEntry,
   ksz8563DeleteStaticFdbEntry,
   ksz8563GetStaticFdbEntry,
   ksz8563FlushStaticFdbTable,
   ksz8563GetDynamicFdbEntry,
   ksz8563FlushDynamicFdbTable,
   ksz8563SetUnknownMcastFwdPorts
}

KSZ8563 Ethernet switch driver.

Definition at line 45 of file ksz8563_driver.c.