ksz9897_driver.c File Reference

KSZ9897 7-port Gigabit Ethernet switch driver. More...

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

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NIC_TRACE_LEVEL

Functions
error_t	ksz9897Init (NetInterface *interface)
	KSZ9897 Ethernet switch initialization. More...
__weak_func void	ksz9897InitHook (NetInterface *interface)
	KSZ9897 custom configuration. More...
__weak_func void	ksz9897Tick (NetInterface *interface)
	KSZ9897 timer handler. More...
void	ksz9897EnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	ksz9897DisableIrq (NetInterface *interface)
	Disable interrupts. More...
__weak_func void	ksz9897EventHandler (NetInterface *interface)
	KSZ9897 event handler. More...
error_t	ksz9897TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
	Add tail tag to Ethernet frame. More...
error_t	ksz9897UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
	Decode tail tag from incoming Ethernet frame. More...
bool_t	ksz9897GetLinkState (NetInterface *interface, uint8_t port)
	Get link state. More...
uint32_t	ksz9897GetLinkSpeed (NetInterface *interface, uint8_t port)
	Get link speed. More...
NicDuplexMode	ksz9897GetDuplexMode (NetInterface *interface, uint8_t port)
	Get duplex mode. More...
void	ksz9897SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
	Set port state. More...
SwitchPortState	ksz9897GetPortState (NetInterface *interface, uint8_t port)
	Get port state. More...
void	ksz9897SetAgingTime (NetInterface *interface, uint32_t agingTime)
	Set aging time for dynamic filtering entries. More...
void	ksz9897EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...
void	ksz9897EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. More...
void	ksz9897EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
	Enable reserved multicast table. More...
error_t	ksz9897AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Add a new entry to the static MAC table. More...
error_t	ksz9897DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Remove an entry from the static MAC table. More...
error_t	ksz9897GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the static MAC table. More...
void	ksz9897FlushStaticFdbTable (NetInterface *interface)
	Flush static MAC table. More...
error_t	ksz9897GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the dynamic MAC table. More...
void	ksz9897FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
	Flush dynamic MAC table. More...
void	ksz9897SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. More...
void	ksz9897WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
	Write PHY register. More...
uint16_t	ksz9897ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
	Read PHY register. More...
void	ksz9897DumpPhyReg (NetInterface *interface, uint8_t port)
	Dump PHY registers for debugging purpose. More...
void	ksz9897WriteMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...
uint16_t	ksz9897ReadMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...
void	ksz9897WriteSwitchReg8 (NetInterface *interface, uint16_t address, uint8_t data)
	Write switch register (8 bits) More...
uint8_t	ksz9897ReadSwitchReg8 (NetInterface *interface, uint16_t address)
	Read switch register (8 bits) More...
void	ksz9897WriteSwitchReg16 (NetInterface *interface, uint16_t address, uint16_t data)
	Write switch register (16 bits) More...
uint16_t	ksz9897ReadSwitchReg16 (NetInterface *interface, uint16_t address)
	Read switch register (16 bits) More...
void	ksz9897WriteSwitchReg32 (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch register (32 bits) More...
uint32_t	ksz9897ReadSwitchReg32 (NetInterface *interface, uint16_t address)
	Read switch register (32 bits) More...

Variables
const SwitchDriver	ksz9897SwitchDriver
	KSZ9897 Ethernet switch driver. More...
const uint16_t	ksz9897IngressTailTag [6]
	Tail tag rules (host to KSZ9897) More...

Detailed Description

KSZ9897 7-port Gigabit 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 ksz9897_driver.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz9897_driver.c.

Function Documentation

ksz9897AddStaticFdbEntry()

error_t ksz9897AddStaticFdbEntry	(	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 1006 of file ksz9897_driver.c.

ksz9897DeleteStaticFdbEntry()

error_t ksz9897DeleteStaticFdbEntry	(	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 1128 of file ksz9897_driver.c.

ksz9897DisableIrq()

void ksz9897DisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 338 of file ksz9897_driver.c.

ksz9897DumpPhyReg()

void ksz9897DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1623 of file ksz9897_driver.c.

ksz9897EnableIgmpSnooping()

void ksz9897EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 917 of file ksz9897_driver.c.

ksz9897EnableIrq()

void ksz9897EnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 328 of file ksz9897_driver.c.

ksz9897EnableMldSnooping()

void ksz9897EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 947 of file ksz9897_driver.c.

ksz9897EnableRsvdMcastTable()

void ksz9897EnableRsvdMcastTable	(	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 977 of file ksz9897_driver.c.

ksz9897EventHandler()

__weak_func void ksz9897EventHandler

(

NetInterface *

interface

)

KSZ9897 event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 348 of file ksz9897_driver.c.

ksz9897FlushDynamicFdbTable()

void ksz9897FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1461 of file ksz9897_driver.c.

ksz9897FlushStaticFdbTable()

void ksz9897FlushStaticFdbTable

(

NetInterface *

interface

)

Flush static MAC table.

Parameters

[in]

interface

Underlying network interface

Definition at line 1305 of file ksz9897_driver.c.

ksz9897GetDuplexMode()

NicDuplexMode ksz9897GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns

Duplex mode

Definition at line 713 of file ksz9897_driver.c.

ksz9897GetDynamicFdbEntry()

error_t ksz9897GetDynamicFdbEntry	(	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 1354 of file ksz9897_driver.c.

ksz9897GetLinkSpeed()

uint32_t ksz9897GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns

Link speed

Definition at line 618 of file ksz9897_driver.c.

ksz9897GetLinkState()

bool_t ksz9897GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns

Link state

Definition at line 584 of file ksz9897_driver.c.

ksz9897GetPortState()

SwitchPortState ksz9897GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns

Port state

Definition at line 833 of file ksz9897_driver.c.

ksz9897GetStaticFdbEntry()

error_t ksz9897GetStaticFdbEntry	(	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 1208 of file ksz9897_driver.c.

ksz9897Init()

error_t ksz9897Init

(

NetInterface *

interface

)

KSZ9897 Ethernet switch initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 94 of file ksz9897_driver.c.

ksz9897InitHook()

__weak_func void ksz9897InitHook

(

NetInterface *

interface

)

KSZ9897 custom configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 248 of file ksz9897_driver.c.

ksz9897ReadMmdReg()

uint16_t ksz9897ReadMmdReg	(	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 1677 of file ksz9897_driver.c.

ksz9897ReadPhyReg()

uint16_t ksz9897ReadPhyReg	(	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 1587 of file ksz9897_driver.c.

ksz9897ReadSwitchReg16()

uint16_t ksz9897ReadSwitchReg16	(	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 1837 of file ksz9897_driver.c.

ksz9897ReadSwitchReg32()

uint32_t ksz9897ReadSwitchReg32	(	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 1931 of file ksz9897_driver.c.

ksz9897ReadSwitchReg8()

uint8_t ksz9897ReadSwitchReg8	(	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 1746 of file ksz9897_driver.c.

ksz9897SetAgingTime()

void ksz9897SetAgingTime	(	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 896 of file ksz9897_driver.c.

ksz9897SetPortState()

void ksz9897SetPortState	(	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 777 of file ksz9897_driver.c.

ksz9897SetUnknownMcastFwdPorts()

void ksz9897SetUnknownMcastFwdPorts	(	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 1508 of file ksz9897_driver.c.

ksz9897TagFrame()

error_t ksz9897TagFrame	(	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 473 of file ksz9897_driver.c.

ksz9897Tick()

__weak_func void ksz9897Tick

(

NetInterface *

interface

)

KSZ9897 timer handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 258 of file ksz9897_driver.c.

ksz9897UntagFrame()

error_t ksz9897UntagFrame	(	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 532 of file ksz9897_driver.c.

ksz9897WriteMmdReg()

void ksz9897WriteMmdReg	(	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 1649 of file ksz9897_driver.c.

ksz9897WritePhyReg()

void ksz9897WritePhyReg	(	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 1553 of file ksz9897_driver.c.

ksz9897WriteSwitchReg16()

void ksz9897WriteSwitchReg16	(	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 1793 of file ksz9897_driver.c.

ksz9897WriteSwitchReg32()

void ksz9897WriteSwitchReg32	(	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 1885 of file ksz9897_driver.c.

ksz9897WriteSwitchReg8()

void ksz9897WriteSwitchReg8	(	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 1703 of file ksz9897_driver.c.

Variable Documentation

ksz9897IngressTailTag

const uint16_t ksz9897IngressTailTag[6]

Initial value:

=
{
   HTONS(KSZ9897_TAIL_TAG_NORMAL_ADDR_LOOKUP),
   HTONS(KSZ9897_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9897_TAIL_TAG_DEST_PORT1),
   HTONS(KSZ9897_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9897_TAIL_TAG_DEST_PORT2),
   HTONS(KSZ9897_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9897_TAIL_TAG_DEST_PORT3),
   HTONS(KSZ9897_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9897_TAIL_TAG_DEST_PORT4),
 
}

Tail tag rules (host to KSZ9897)

Definition at line 77 of file ksz9897_driver.c.

ksz9897SwitchDriver

const SwitchDriver ksz9897SwitchDriver

Initial value:

=
{
   ksz9897Init,
   ksz9897Tick,
   ksz9897EnableIrq,
   ksz9897DisableIrq,
   ksz9897EventHandler,
   ksz9897TagFrame,
   ksz9897UntagFrame,
   ksz9897GetLinkState,
   ksz9897GetLinkSpeed,
   ksz9897GetDuplexMode,
   ksz9897SetPortState,
   ksz9897GetPortState,
   ksz9897SetAgingTime,
   ksz9897EnableIgmpSnooping,
   ksz9897EnableMldSnooping,
   ksz9897EnableRsvdMcastTable,
   ksz9897AddStaticFdbEntry,
   ksz9897DeleteStaticFdbEntry,
   ksz9897GetStaticFdbEntry,
   ksz9897FlushStaticFdbTable,
   ksz9897GetDynamicFdbEntry,
   ksz9897FlushDynamicFdbTable,
   ksz9897SetUnknownMcastFwdPorts
}

KSZ9897 Ethernet switch driver.

Definition at line 45 of file ksz9897_driver.c.