ksz8565_driver.c File Reference

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

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

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NIC_TRACE_LEVEL

Functions
error_t	ksz8565Init (NetInterface *interface)
	KSZ8565 Ethernet switch initialization. More...
__weak_func void	ksz8565InitHook (NetInterface *interface)
	KSZ8565 custom configuration. More...
__weak_func void	ksz8565Tick (NetInterface *interface)
	KSZ8565 timer handler. More...
void	ksz8565EnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	ksz8565DisableIrq (NetInterface *interface)
	Disable interrupts. More...
__weak_func void	ksz8565EventHandler (NetInterface *interface)
	KSZ8565 event handler. More...
error_t	ksz8565TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
	Add tail tag to Ethernet frame. More...
error_t	ksz8565UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
	Decode tail tag from incoming Ethernet frame. More...
bool_t	ksz8565GetLinkState (NetInterface *interface, uint8_t port)
	Get link state. More...
uint32_t	ksz8565GetLinkSpeed (NetInterface *interface, uint8_t port)
	Get link speed. More...
NicDuplexMode	ksz8565GetDuplexMode (NetInterface *interface, uint8_t port)
	Get duplex mode. More...
void	ksz8565SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
	Set port state. More...
SwitchPortState	ksz8565GetPortState (NetInterface *interface, uint8_t port)
	Get port state. More...
void	ksz8565SetAgingTime (NetInterface *interface, uint32_t agingTime)
	Set aging time for dynamic filtering entries. More...
void	ksz8565EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...
void	ksz8565EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. More...
void	ksz8565EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
	Enable reserved multicast table. More...
error_t	ksz8565AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Add a new entry to the static MAC table. More...
error_t	ksz8565DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Remove an entry from the static MAC table. More...
error_t	ksz8565GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the static MAC table. More...
void	ksz8565FlushStaticFdbTable (NetInterface *interface)
	Flush static MAC table. More...
error_t	ksz8565GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the dynamic MAC table. More...
void	ksz8565FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
	Flush dynamic MAC table. More...
void	ksz8565SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. More...
void	ksz8565WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
	Write PHY register. More...
uint16_t	ksz8565ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
	Read PHY register. More...
void	ksz8565DumpPhyReg (NetInterface *interface, uint8_t port)
	Dump PHY registers for debugging purpose. More...
void	ksz8565WriteMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...
uint16_t	ksz8565ReadMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...
void	ksz8565WriteSwitchReg8 (NetInterface *interface, uint16_t address, uint8_t data)
	Write switch register (8 bits) More...
uint8_t	ksz8565ReadSwitchReg8 (NetInterface *interface, uint16_t address)
	Read switch register (8 bits) More...
void	ksz8565WriteSwitchReg16 (NetInterface *interface, uint16_t address, uint16_t data)
	Write switch register (16 bits) More...
uint16_t	ksz8565ReadSwitchReg16 (NetInterface *interface, uint16_t address)
	Read switch register (16 bits) More...
void	ksz8565WriteSwitchReg32 (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch register (32 bits) More...
uint32_t	ksz8565ReadSwitchReg32 (NetInterface *interface, uint16_t address)
	Read switch register (32 bits) More...

Variables
const SwitchDriver	ksz8565SwitchDriver
	KSZ8565 Ethernet switch driver. More...
const uint16_t	ksz8565IngressTailTag [5]
	Tail tag rules (host to KSZ8565) More...

Detailed Description

KSZ8565 5-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 ksz8565_driver.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz8565_driver.c.

Function Documentation

ksz8565AddStaticFdbEntry()

error_t ksz8565AddStaticFdbEntry	(	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 1003 of file ksz8565_driver.c.

ksz8565DeleteStaticFdbEntry()

error_t ksz8565DeleteStaticFdbEntry	(	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 1125 of file ksz8565_driver.c.

ksz8565DisableIrq()

void ksz8565DisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 340 of file ksz8565_driver.c.

ksz8565DumpPhyReg()

void ksz8565DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1615 of file ksz8565_driver.c.

ksz8565EnableIgmpSnooping()

void ksz8565EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 914 of file ksz8565_driver.c.

ksz8565EnableIrq()

void ksz8565EnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 330 of file ksz8565_driver.c.

ksz8565EnableMldSnooping()

void ksz8565EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 944 of file ksz8565_driver.c.

ksz8565EnableRsvdMcastTable()

void ksz8565EnableRsvdMcastTable	(	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 974 of file ksz8565_driver.c.

ksz8565EventHandler()

__weak_func void ksz8565EventHandler

(

NetInterface *

interface

)

KSZ8565 event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 350 of file ksz8565_driver.c.

ksz8565FlushDynamicFdbTable()

void ksz8565FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1452 of file ksz8565_driver.c.

ksz8565FlushStaticFdbTable()

void ksz8565FlushStaticFdbTable

(

NetInterface *

interface

)

Flush static MAC table.

Parameters

[in]

interface

Underlying network interface

Definition at line 1302 of file ksz8565_driver.c.

ksz8565GetDuplexMode()

NicDuplexMode ksz8565GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns

Duplex mode

Definition at line 710 of file ksz8565_driver.c.

ksz8565GetDynamicFdbEntry()

error_t ksz8565GetDynamicFdbEntry	(	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 1351 of file ksz8565_driver.c.

ksz8565GetLinkSpeed()

uint32_t ksz8565GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns

Link speed

Definition at line 620 of file ksz8565_driver.c.

ksz8565GetLinkState()

bool_t ksz8565GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns

Link state

Definition at line 586 of file ksz8565_driver.c.

ksz8565GetPortState()

SwitchPortState ksz8565GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns

Port state

Definition at line 830 of file ksz8565_driver.c.

ksz8565GetStaticFdbEntry()

error_t ksz8565GetStaticFdbEntry	(	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 1205 of file ksz8565_driver.c.

ksz8565Init()

error_t ksz8565Init

(

NetInterface *

interface

)

KSZ8565 Ethernet switch initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 93 of file ksz8565_driver.c.

ksz8565InitHook()

__weak_func void ksz8565InitHook

(

NetInterface *

interface

)

KSZ8565 custom configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 250 of file ksz8565_driver.c.

ksz8565ReadMmdReg()

uint16_t ksz8565ReadMmdReg	(	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 1669 of file ksz8565_driver.c.

ksz8565ReadPhyReg()

uint16_t ksz8565ReadPhyReg	(	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 1579 of file ksz8565_driver.c.

ksz8565ReadSwitchReg16()

uint16_t ksz8565ReadSwitchReg16	(	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 1829 of file ksz8565_driver.c.

ksz8565ReadSwitchReg32()

uint32_t ksz8565ReadSwitchReg32	(	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 1923 of file ksz8565_driver.c.

ksz8565ReadSwitchReg8()

uint8_t ksz8565ReadSwitchReg8	(	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 1738 of file ksz8565_driver.c.

ksz8565SetAgingTime()

void ksz8565SetAgingTime	(	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 893 of file ksz8565_driver.c.

ksz8565SetPortState()

void ksz8565SetPortState	(	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 774 of file ksz8565_driver.c.

ksz8565SetUnknownMcastFwdPorts()

void ksz8565SetUnknownMcastFwdPorts	(	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 1500 of file ksz8565_driver.c.

ksz8565TagFrame()

error_t ksz8565TagFrame	(	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 475 of file ksz8565_driver.c.

ksz8565Tick()

__weak_func void ksz8565Tick

(

NetInterface *

interface

)

KSZ8565 timer handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 260 of file ksz8565_driver.c.

ksz8565UntagFrame()

error_t ksz8565UntagFrame	(	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 534 of file ksz8565_driver.c.

ksz8565WriteMmdReg()

void ksz8565WriteMmdReg	(	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 1641 of file ksz8565_driver.c.

ksz8565WritePhyReg()

void ksz8565WritePhyReg	(	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 1545 of file ksz8565_driver.c.

ksz8565WriteSwitchReg16()

void ksz8565WriteSwitchReg16	(	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 1785 of file ksz8565_driver.c.

ksz8565WriteSwitchReg32()

void ksz8565WriteSwitchReg32	(	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 1877 of file ksz8565_driver.c.

ksz8565WriteSwitchReg8()

void ksz8565WriteSwitchReg8	(	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 1695 of file ksz8565_driver.c.

Variable Documentation

ksz8565IngressTailTag

const uint16_t ksz8565IngressTailTag[5]

Initial value:

=
{
   HTONS(KSZ8565_TAIL_TAG_NORMAL_ADDR_LOOKUP),
   HTONS(KSZ8565_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8565_TAIL_TAG_DEST_PORT1),
   HTONS(KSZ8565_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8565_TAIL_TAG_DEST_PORT2),
   HTONS(KSZ8565_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8565_TAIL_TAG_DEST_PORT3),
 
}

Tail tag rules (host to KSZ8565)

Definition at line 77 of file ksz8565_driver.c.

ksz8565SwitchDriver

const SwitchDriver ksz8565SwitchDriver

Initial value:

=
{
   ksz8565Init,
   ksz8565Tick,
   ksz8565EnableIrq,
   ksz8565DisableIrq,
   ksz8565EventHandler,
   ksz8565TagFrame,
   ksz8565UntagFrame,
   ksz8565GetLinkState,
   ksz8565GetLinkSpeed,
   ksz8565GetDuplexMode,
   ksz8565SetPortState,
   ksz8565GetPortState,
   ksz8565SetAgingTime,
   ksz8565EnableIgmpSnooping,
   ksz8565EnableMldSnooping,
   ksz8565EnableRsvdMcastTable,
   ksz8565AddStaticFdbEntry,
   ksz8565DeleteStaticFdbEntry,
   ksz8565GetStaticFdbEntry,
   ksz8565FlushStaticFdbTable,
   ksz8565GetDynamicFdbEntry,
   ksz8565FlushDynamicFdbTable,
   ksz8565SetUnknownMcastFwdPorts
}

KSZ8565 Ethernet switch driver.

Definition at line 45 of file ksz8565_driver.c.