ksz8567_driver.c File Reference

KSZ8567 7-port Ethernet switch driver. More...

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

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NIC_TRACE_LEVEL

Functions
error_t	ksz8567Init (NetInterface *interface)
	KSZ8567 Ethernet switch initialization. More...
__weak_func void	ksz8567InitHook (NetInterface *interface)
	KSZ8567 custom configuration. More...
__weak_func void	ksz8567Tick (NetInterface *interface)
	KSZ8567 timer handler. More...
void	ksz8567EnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	ksz8567DisableIrq (NetInterface *interface)
	Disable interrupts. More...
__weak_func void	ksz8567EventHandler (NetInterface *interface)
	KSZ8567 event handler. More...
error_t	ksz8567TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
	Add tail tag to Ethernet frame. More...
error_t	ksz8567UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
	Decode tail tag from incoming Ethernet frame. More...
bool_t	ksz8567GetLinkState (NetInterface *interface, uint8_t port)
	Get link state. More...
uint32_t	ksz8567GetLinkSpeed (NetInterface *interface, uint8_t port)
	Get link speed. More...
NicDuplexMode	ksz8567GetDuplexMode (NetInterface *interface, uint8_t port)
	Get duplex mode. More...
void	ksz8567SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
	Set port state. More...
SwitchPortState	ksz8567GetPortState (NetInterface *interface, uint8_t port)
	Get port state. More...
void	ksz8567SetAgingTime (NetInterface *interface, uint32_t agingTime)
	Set aging time for dynamic filtering entries. More...
void	ksz8567EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...
void	ksz8567EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. More...
void	ksz8567EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
	Enable reserved multicast table. More...
error_t	ksz8567AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Add a new entry to the static MAC table. More...
error_t	ksz8567DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Remove an entry from the static MAC table. More...
error_t	ksz8567GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the static MAC table. More...
void	ksz8567FlushStaticFdbTable (NetInterface *interface)
	Flush static MAC table. More...
error_t	ksz8567GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the dynamic MAC table. More...
void	ksz8567FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
	Flush dynamic MAC table. More...
void	ksz8567SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. More...
void	ksz8567WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
	Write PHY register. More...
uint16_t	ksz8567ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
	Read PHY register. More...
void	ksz8567DumpPhyReg (NetInterface *interface, uint8_t port)
	Dump PHY registers for debugging purpose. More...
void	ksz8567WriteMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...
uint16_t	ksz8567ReadMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...
void	ksz8567WriteSwitchReg8 (NetInterface *interface, uint16_t address, uint8_t data)
	Write switch register (8 bits) More...
uint8_t	ksz8567ReadSwitchReg8 (NetInterface *interface, uint16_t address)
	Read switch register (8 bits) More...
void	ksz8567WriteSwitchReg16 (NetInterface *interface, uint16_t address, uint16_t data)
	Write switch register (16 bits) More...
uint16_t	ksz8567ReadSwitchReg16 (NetInterface *interface, uint16_t address)
	Read switch register (16 bits) More...
void	ksz8567WriteSwitchReg32 (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch register (32 bits) More...
uint32_t	ksz8567ReadSwitchReg32 (NetInterface *interface, uint16_t address)
	Read switch register (32 bits) More...

Variables
const SwitchDriver	ksz8567SwitchDriver
	KSZ8567 Ethernet switch driver. More...
const uint16_t	ksz8567IngressTailTag [6]
	Tail tag rules (host to KSZ8567) More...

Detailed Description

KSZ8567 7-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 ksz8567_driver.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz8567_driver.c.

Function Documentation

ksz8567AddStaticFdbEntry()

error_t ksz8567AddStaticFdbEntry	(	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 1004 of file ksz8567_driver.c.

ksz8567DeleteStaticFdbEntry()

error_t ksz8567DeleteStaticFdbEntry	(	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 1126 of file ksz8567_driver.c.

ksz8567DisableIrq()

void ksz8567DisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 341 of file ksz8567_driver.c.

ksz8567DumpPhyReg()

void ksz8567DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1621 of file ksz8567_driver.c.

ksz8567EnableIgmpSnooping()

void ksz8567EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 915 of file ksz8567_driver.c.

ksz8567EnableIrq()

void ksz8567EnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 331 of file ksz8567_driver.c.

ksz8567EnableMldSnooping()

void ksz8567EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 945 of file ksz8567_driver.c.

ksz8567EnableRsvdMcastTable()

void ksz8567EnableRsvdMcastTable	(	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 975 of file ksz8567_driver.c.

ksz8567EventHandler()

__weak_func void ksz8567EventHandler

(

NetInterface *

interface

)

KSZ8567 event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 351 of file ksz8567_driver.c.

ksz8567FlushDynamicFdbTable()

void ksz8567FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1459 of file ksz8567_driver.c.

ksz8567FlushStaticFdbTable()

void ksz8567FlushStaticFdbTable

(

NetInterface *

interface

)

Flush static MAC table.

Parameters

[in]

interface

Underlying network interface

Definition at line 1303 of file ksz8567_driver.c.

ksz8567GetDuplexMode()

NicDuplexMode ksz8567GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns

Duplex mode

Definition at line 711 of file ksz8567_driver.c.

ksz8567GetDynamicFdbEntry()

error_t ksz8567GetDynamicFdbEntry	(	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 1352 of file ksz8567_driver.c.

ksz8567GetLinkSpeed()

uint32_t ksz8567GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns

Link speed

Definition at line 621 of file ksz8567_driver.c.

ksz8567GetLinkState()

bool_t ksz8567GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns

Link state

Definition at line 587 of file ksz8567_driver.c.

ksz8567GetPortState()

SwitchPortState ksz8567GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns

Port state

Definition at line 831 of file ksz8567_driver.c.

ksz8567GetStaticFdbEntry()

error_t ksz8567GetStaticFdbEntry	(	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 1206 of file ksz8567_driver.c.

ksz8567Init()

error_t ksz8567Init

(

NetInterface *

interface

)

KSZ8567 Ethernet switch initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 94 of file ksz8567_driver.c.

ksz8567InitHook()

__weak_func void ksz8567InitHook

(

NetInterface *

interface

)

KSZ8567 custom configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 251 of file ksz8567_driver.c.

ksz8567ReadMmdReg()

uint16_t ksz8567ReadMmdReg	(	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 1675 of file ksz8567_driver.c.

ksz8567ReadPhyReg()

uint16_t ksz8567ReadPhyReg	(	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 1585 of file ksz8567_driver.c.

ksz8567ReadSwitchReg16()

uint16_t ksz8567ReadSwitchReg16	(	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 1835 of file ksz8567_driver.c.

ksz8567ReadSwitchReg32()

uint32_t ksz8567ReadSwitchReg32	(	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 1929 of file ksz8567_driver.c.

ksz8567ReadSwitchReg8()

uint8_t ksz8567ReadSwitchReg8	(	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 1744 of file ksz8567_driver.c.

ksz8567SetAgingTime()

void ksz8567SetAgingTime	(	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 894 of file ksz8567_driver.c.

ksz8567SetPortState()

void ksz8567SetPortState	(	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 775 of file ksz8567_driver.c.

ksz8567SetUnknownMcastFwdPorts()

void ksz8567SetUnknownMcastFwdPorts	(	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 1506 of file ksz8567_driver.c.

ksz8567TagFrame()

error_t ksz8567TagFrame	(	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 476 of file ksz8567_driver.c.

ksz8567Tick()

__weak_func void ksz8567Tick

(

NetInterface *

interface

)

KSZ8567 timer handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 261 of file ksz8567_driver.c.

ksz8567UntagFrame()

error_t ksz8567UntagFrame	(	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 535 of file ksz8567_driver.c.

ksz8567WriteMmdReg()

void ksz8567WriteMmdReg	(	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 1647 of file ksz8567_driver.c.

ksz8567WritePhyReg()

void ksz8567WritePhyReg	(	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 1551 of file ksz8567_driver.c.

ksz8567WriteSwitchReg16()

void ksz8567WriteSwitchReg16	(	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 1791 of file ksz8567_driver.c.

ksz8567WriteSwitchReg32()

void ksz8567WriteSwitchReg32	(	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 1883 of file ksz8567_driver.c.

ksz8567WriteSwitchReg8()

void ksz8567WriteSwitchReg8	(	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 1701 of file ksz8567_driver.c.

Variable Documentation

ksz8567IngressTailTag

const uint16_t ksz8567IngressTailTag[6]

Initial value:

=
{
   HTONS(KSZ8567_TAIL_TAG_NORMAL_ADDR_LOOKUP),
   HTONS(KSZ8567_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8567_TAIL_TAG_DEST_PORT1),
   HTONS(KSZ8567_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8567_TAIL_TAG_DEST_PORT2),
   HTONS(KSZ8567_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8567_TAIL_TAG_DEST_PORT3),
   HTONS(KSZ8567_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ8567_TAIL_TAG_DEST_PORT4),
 
}

Tail tag rules (host to KSZ8567)

Definition at line 77 of file ksz8567_driver.c.

ksz8567SwitchDriver

const SwitchDriver ksz8567SwitchDriver

Initial value:

=
{
   ksz8567Init,
   ksz8567Tick,
   ksz8567EnableIrq,
   ksz8567DisableIrq,
   ksz8567EventHandler,
   ksz8567TagFrame,
   ksz8567UntagFrame,
   ksz8567GetLinkState,
   ksz8567GetLinkSpeed,
   ksz8567GetDuplexMode,
   ksz8567SetPortState,
   ksz8567GetPortState,
   ksz8567SetAgingTime,
   ksz8567EnableIgmpSnooping,
   ksz8567EnableMldSnooping,
   ksz8567EnableRsvdMcastTable,
   ksz8567AddStaticFdbEntry,
   ksz8567DeleteStaticFdbEntry,
   ksz8567GetStaticFdbEntry,
   ksz8567FlushStaticFdbTable,
   ksz8567GetDynamicFdbEntry,
   ksz8567FlushDynamicFdbTable,
   ksz8567SetUnknownMcastFwdPorts
}

KSZ8567 Ethernet switch driver.

Definition at line 45 of file ksz8567_driver.c.