ksz9896_driver.c File Reference

KSZ9896 6-port Gigabit Ethernet switch driver. More...

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

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NIC_TRACE_LEVEL

Functions
error_t	ksz9896Init (NetInterface *interface)
	KSZ9896 Ethernet switch initialization. More...
__weak_func void	ksz9896InitHook (NetInterface *interface)
	KSZ9896 custom configuration. More...
__weak_func void	ksz9896Tick (NetInterface *interface)
	KSZ9896 timer handler. More...
void	ksz9896EnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	ksz9896DisableIrq (NetInterface *interface)
	Disable interrupts. More...
__weak_func void	ksz9896EventHandler (NetInterface *interface)
	KSZ9896 event handler. More...
error_t	ksz9896TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
	Add tail tag to Ethernet frame. More...
error_t	ksz9896UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
	Decode tail tag from incoming Ethernet frame. More...
bool_t	ksz9896GetLinkState (NetInterface *interface, uint8_t port)
	Get link state. More...
uint32_t	ksz9896GetLinkSpeed (NetInterface *interface, uint8_t port)
	Get link speed. More...
NicDuplexMode	ksz9896GetDuplexMode (NetInterface *interface, uint8_t port)
	Get duplex mode. More...
void	ksz9896SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
	Set port state. More...
SwitchPortState	ksz9896GetPortState (NetInterface *interface, uint8_t port)
	Get port state. More...
void	ksz9896SetAgingTime (NetInterface *interface, uint32_t agingTime)
	Set aging time for dynamic filtering entries. More...
void	ksz9896EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...
void	ksz9896EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. More...
void	ksz9896EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
	Enable reserved multicast table. More...
error_t	ksz9896AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Add a new entry to the static MAC table. More...
error_t	ksz9896DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
	Remove an entry from the static MAC table. More...
error_t	ksz9896GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the static MAC table. More...
void	ksz9896FlushStaticFdbTable (NetInterface *interface)
	Flush static MAC table. More...
error_t	ksz9896GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
	Read an entry from the dynamic MAC table. More...
void	ksz9896FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
	Flush dynamic MAC table. More...
void	ksz9896SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. More...
void	ksz9896WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
	Write PHY register. More...
uint16_t	ksz9896ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
	Read PHY register. More...
void	ksz9896DumpPhyReg (NetInterface *interface, uint8_t port)
	Dump PHY registers for debugging purpose. More...
void	ksz9896WriteMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...
uint16_t	ksz9896ReadMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...
void	ksz9896WriteSwitchReg8 (NetInterface *interface, uint16_t address, uint8_t data)
	Write switch register (8 bits) More...
uint8_t	ksz9896ReadSwitchReg8 (NetInterface *interface, uint16_t address)
	Read switch register (8 bits) More...
void	ksz9896WriteSwitchReg16 (NetInterface *interface, uint16_t address, uint16_t data)
	Write switch register (16 bits) More...
uint16_t	ksz9896ReadSwitchReg16 (NetInterface *interface, uint16_t address)
	Read switch register (16 bits) More...
void	ksz9896WriteSwitchReg32 (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch register (32 bits) More...
uint32_t	ksz9896ReadSwitchReg32 (NetInterface *interface, uint16_t address)
	Read switch register (32 bits) More...

Variables
const SwitchDriver	ksz9896SwitchDriver
	KSZ9896 Ethernet switch driver. More...
const uint16_t	ksz9896IngressTailTag [6]
	Tail tag rules (host to KSZ9896) More...

Detailed Description

KSZ9896 6-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 ksz9896_driver.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz9896_driver.c.

Function Documentation

ksz9896AddStaticFdbEntry()

error_t ksz9896AddStaticFdbEntry	(	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 ksz9896_driver.c.

ksz9896DeleteStaticFdbEntry()

error_t ksz9896DeleteStaticFdbEntry	(	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 ksz9896_driver.c.

ksz9896DisableIrq()

void ksz9896DisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 338 of file ksz9896_driver.c.

ksz9896DumpPhyReg()

void ksz9896DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1620 of file ksz9896_driver.c.

ksz9896EnableIgmpSnooping()

void ksz9896EnableIgmpSnooping	(	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 ksz9896_driver.c.

ksz9896EnableIrq()

void ksz9896EnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 328 of file ksz9896_driver.c.

ksz9896EnableMldSnooping()

void ksz9896EnableMldSnooping	(	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 ksz9896_driver.c.

ksz9896EnableRsvdMcastTable()

void ksz9896EnableRsvdMcastTable	(	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 ksz9896_driver.c.

ksz9896EventHandler()

__weak_func void ksz9896EventHandler

(

NetInterface *

interface

)

KSZ9896 event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 348 of file ksz9896_driver.c.

ksz9896FlushDynamicFdbTable()

void ksz9896FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1458 of file ksz9896_driver.c.

ksz9896FlushStaticFdbTable()

void ksz9896FlushStaticFdbTable

(

NetInterface *

interface

)

Flush static MAC table.

Parameters

[in]

interface

Underlying network interface

Definition at line 1305 of file ksz9896_driver.c.

ksz9896GetDuplexMode()

NicDuplexMode ksz9896GetDuplexMode	(	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 ksz9896_driver.c.

ksz9896GetDynamicFdbEntry()

error_t ksz9896GetDynamicFdbEntry	(	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 ksz9896_driver.c.

ksz9896GetLinkSpeed()

uint32_t ksz9896GetLinkSpeed	(	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 ksz9896_driver.c.

ksz9896GetLinkState()

bool_t ksz9896GetLinkState	(	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 ksz9896_driver.c.

ksz9896GetPortState()

SwitchPortState ksz9896GetPortState	(	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 ksz9896_driver.c.

ksz9896GetStaticFdbEntry()

error_t ksz9896GetStaticFdbEntry	(	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 ksz9896_driver.c.

ksz9896Init()

error_t ksz9896Init

(

NetInterface *

interface

)

KSZ9896 Ethernet switch initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 94 of file ksz9896_driver.c.

ksz9896InitHook()

__weak_func void ksz9896InitHook

(

NetInterface *

interface

)

KSZ9896 custom configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 248 of file ksz9896_driver.c.

ksz9896ReadMmdReg()

uint16_t ksz9896ReadMmdReg	(	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 1674 of file ksz9896_driver.c.

ksz9896ReadPhyReg()

uint16_t ksz9896ReadPhyReg	(	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 1584 of file ksz9896_driver.c.

ksz9896ReadSwitchReg16()

uint16_t ksz9896ReadSwitchReg16	(	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 1834 of file ksz9896_driver.c.

ksz9896ReadSwitchReg32()

uint32_t ksz9896ReadSwitchReg32	(	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 1928 of file ksz9896_driver.c.

ksz9896ReadSwitchReg8()

uint8_t ksz9896ReadSwitchReg8	(	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 1743 of file ksz9896_driver.c.

ksz9896SetAgingTime()

void ksz9896SetAgingTime	(	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 ksz9896_driver.c.

ksz9896SetPortState()

void ksz9896SetPortState	(	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 ksz9896_driver.c.

ksz9896SetUnknownMcastFwdPorts()

void ksz9896SetUnknownMcastFwdPorts	(	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 1505 of file ksz9896_driver.c.

ksz9896TagFrame()

error_t ksz9896TagFrame	(	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 ksz9896_driver.c.

ksz9896Tick()

__weak_func void ksz9896Tick

(

NetInterface *

interface

)

KSZ9896 timer handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 258 of file ksz9896_driver.c.

ksz9896UntagFrame()

error_t ksz9896UntagFrame	(	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 ksz9896_driver.c.

ksz9896WriteMmdReg()

void ksz9896WriteMmdReg	(	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 1646 of file ksz9896_driver.c.

ksz9896WritePhyReg()

void ksz9896WritePhyReg	(	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 1550 of file ksz9896_driver.c.

ksz9896WriteSwitchReg16()

void ksz9896WriteSwitchReg16	(	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 1790 of file ksz9896_driver.c.

ksz9896WriteSwitchReg32()

void ksz9896WriteSwitchReg32	(	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 1882 of file ksz9896_driver.c.

ksz9896WriteSwitchReg8()

void ksz9896WriteSwitchReg8	(	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 1700 of file ksz9896_driver.c.

Variable Documentation

ksz9896IngressTailTag

const uint16_t ksz9896IngressTailTag[6]

Initial value:

=
{
   HTONS(KSZ9896_TAIL_TAG_NORMAL_ADDR_LOOKUP),
   HTONS(KSZ9896_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9896_TAIL_TAG_DEST_PORT1),
   HTONS(KSZ9896_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9896_TAIL_TAG_DEST_PORT2),
   HTONS(KSZ9896_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9896_TAIL_TAG_DEST_PORT3),
   HTONS(KSZ9896_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9896_TAIL_TAG_DEST_PORT4),
 
}

Tail tag rules (host to KSZ9896)

Definition at line 77 of file ksz9896_driver.c.

ksz9896SwitchDriver

const SwitchDriver ksz9896SwitchDriver

Initial value:

=
{
   ksz9896Init,
   ksz9896Tick,
   ksz9896EnableIrq,
   ksz9896DisableIrq,
   ksz9896EventHandler,
   ksz9896TagFrame,
   ksz9896UntagFrame,
   ksz9896GetLinkState,
   ksz9896GetLinkSpeed,
   ksz9896GetDuplexMode,
   ksz9896SetPortState,
   ksz9896GetPortState,
   ksz9896SetAgingTime,
   ksz9896EnableIgmpSnooping,
   ksz9896EnableMldSnooping,
   ksz9896EnableRsvdMcastTable,
   ksz9896AddStaticFdbEntry,
   ksz9896DeleteStaticFdbEntry,
   ksz9896GetStaticFdbEntry,
   ksz9896FlushStaticFdbTable,
   ksz9896GetDynamicFdbEntry,
   ksz9896FlushDynamicFdbTable,
   ksz9896SetUnknownMcastFwdPorts
}

KSZ9896 Ethernet switch driver.

Definition at line 45 of file ksz9896_driver.c.