KSZ9893 3-port Gigabit Ethernet switch driver. More...

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	ksz9893Init (NetInterface *interface)
	KSZ9893 Ethernet switch initialization. More...

__weak_func void	ksz9893InitHook (NetInterface *interface)
	KSZ9893 custom configuration. More...

void	ksz9893Tick (NetInterface *interface)
	KSZ9893 timer handler. More...

void	ksz9893EnableIrq (NetInterface *interface)
	Enable interrupts. More...

void	ksz9893DisableIrq (NetInterface *interface)
	Disable interrupts. More...

void	ksz9893EventHandler (NetInterface *interface)
	KSZ9893 event handler. More...

error_t	ksz9893TagFrame (NetInterface interface, NetBuffer buffer, size_t offset, NetTxAncillary ancillary)
	Add tail tag to Ethernet frame. More...

error_t	ksz9893UntagFrame (NetInterface interface, uint8_t frame, size_t length, NetRxAncillary *ancillary)
	Decode tail tag from incoming Ethernet frame. More...

bool_t	ksz9893GetLinkState (NetInterface *interface, uint8_t port)
	Get link state. More...

uint32_t	ksz9893GetLinkSpeed (NetInterface *interface, uint8_t port)
	Get link speed. More...

NicDuplexMode	ksz9893GetDuplexMode (NetInterface *interface, uint8_t port)
	Get duplex mode. More...

void	ksz9893SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
	Set port state. More...

SwitchPortState	ksz9893GetPortState (NetInterface *interface, uint8_t port)
	Get port state. More...

void	ksz9893SetAgingTime (NetInterface *interface, uint32_t agingTime)
	Set aging time for dynamic filtering entries. More...

void	ksz9893EnableIgmpSnooping (NetInterface *interface, bool_t enable)
	Enable IGMP snooping. More...

void	ksz9893EnableMldSnooping (NetInterface *interface, bool_t enable)
	Enable MLD snooping. More...

void	ksz9893EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
	Enable reserved multicast table. More...

error_t	ksz9893AddStaticFdbEntry (NetInterface interface, const SwitchFdbEntry entry)
	Add a new entry to the static MAC table. More...

error_t	ksz9893DeleteStaticFdbEntry (NetInterface interface, const SwitchFdbEntry entry)
	Remove an entry from the static MAC table. More...

error_t	ksz9893GetStaticFdbEntry (NetInterface interface, uint_t index, SwitchFdbEntry entry)
	Read an entry from the static MAC table. More...

void	ksz9893FlushStaticFdbTable (NetInterface *interface)
	Flush static MAC table. More...

error_t	ksz9893GetDynamicFdbEntry (NetInterface interface, uint_t index, SwitchFdbEntry entry)
	Read an entry from the dynamic MAC table. More...

void	ksz9893FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
	Flush dynamic MAC table. More...

void	ksz9893SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
	Set forward ports for unknown multicast packets. More...

void	ksz9893WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
	Write PHY register. More...

uint16_t	ksz9893ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
	Read PHY register. More...

void	ksz9893DumpPhyReg (NetInterface *interface, uint8_t port)
	Dump PHY registers for debugging purpose. More...

void	ksz9893WriteMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr, uint16_t data)
	Write MMD register. More...

uint16_t	ksz9893ReadMmdReg (NetInterface *interface, uint8_t port, uint8_t devAddr, uint16_t regAddr)
	Read MMD register. More...

void	ksz9893WriteSwitchReg8 (NetInterface *interface, uint16_t address, uint8_t data)
	Write switch register (8 bits) More...

uint8_t	ksz9893ReadSwitchReg8 (NetInterface *interface, uint16_t address)
	Read switch register (8 bits) More...

void	ksz9893WriteSwitchReg16 (NetInterface *interface, uint16_t address, uint16_t data)
	Write switch register (16 bits) More...

uint16_t	ksz9893ReadSwitchReg16 (NetInterface *interface, uint16_t address)
	Read switch register (16 bits) More...

void	ksz9893WriteSwitchReg32 (NetInterface *interface, uint16_t address, uint32_t data)
	Write switch register (32 bits) More...

uint32_t	ksz9893ReadSwitchReg32 (NetInterface *interface, uint16_t address)
	Read switch register (32 bits) More...

Variables
const SwitchDriver	ksz9893SwitchDriver
	KSZ9893 Ethernet switch driver. More...

const uint8_t	ksz9893IngressTailTag [3]
	Tail tag rules (host to KSZ9893) More...

Detailed Description

KSZ9893 3-port Gigabit Ethernet switch driver.

License

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

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.4.0

Definition in file ksz9893_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file ksz9893_driver.c.

Function Documentation

◆ ksz9893AddStaticFdbEntry()

error_t ksz9893AddStaticFdbEntry	(	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 990 of file ksz9893_driver.c.

◆ ksz9893DeleteStaticFdbEntry()

error_t ksz9893DeleteStaticFdbEntry	(	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 1112 of file ksz9893_driver.c.

◆ ksz9893DisableIrq()

void ksz9893DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 322 of file ksz9893_driver.c.

◆ ksz9893DumpPhyReg()

void ksz9893DumpPhyReg	(	NetInterface *	interface,
		uint8_t	port
	)

Dump PHY registers for debugging purpose.

Parameters

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

Definition at line 1595 of file ksz9893_driver.c.

◆ ksz9893EnableIgmpSnooping()

void ksz9893EnableIgmpSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable IGMP snooping.

Parameters

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

Definition at line 901 of file ksz9893_driver.c.

◆ ksz9893EnableIrq()

void ksz9893EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 312 of file ksz9893_driver.c.

◆ ksz9893EnableMldSnooping()

void ksz9893EnableMldSnooping	(	NetInterface *	interface,
		bool_t	enable
	)

Enable MLD snooping.

Parameters

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

Definition at line 931 of file ksz9893_driver.c.

◆ ksz9893EnableRsvdMcastTable()

void ksz9893EnableRsvdMcastTable	(	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 961 of file ksz9893_driver.c.

◆ ksz9893EventHandler()

void ksz9893EventHandler ( NetInterface * interface )

KSZ9893 event handler.

Parameters

[in] interface Underlying network interface

Definition at line 332 of file ksz9893_driver.c.

◆ ksz9893FlushDynamicFdbTable()

void ksz9893FlushDynamicFdbTable	(	NetInterface *	interface,
		uint8_t	port
	)

Flush dynamic MAC table.

Parameters

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

Definition at line 1433 of file ksz9893_driver.c.

◆ ksz9893FlushStaticFdbTable()

void ksz9893FlushStaticFdbTable ( NetInterface * interface )

Flush static MAC table.

Parameters

[in] interface Underlying network interface

Definition at line 1289 of file ksz9893_driver.c.

◆ ksz9893GetDuplexMode()

NicDuplexMode ksz9893GetDuplexMode	(	NetInterface *	interface,
		uint8_t	port
	)

Get duplex mode.

Parameters

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

Returns: Duplex mode

Definition at line 697 of file ksz9893_driver.c.

◆ ksz9893GetDynamicFdbEntry()

error_t ksz9893GetDynamicFdbEntry	(	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 1338 of file ksz9893_driver.c.

◆ ksz9893GetLinkSpeed()

uint32_t ksz9893GetLinkSpeed	(	NetInterface *	interface,
		uint8_t	port
	)

Get link speed.

Parameters

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

Returns: Link speed

Definition at line 602 of file ksz9893_driver.c.

◆ ksz9893GetLinkState()

bool_t ksz9893GetLinkState	(	NetInterface *	interface,
		uint8_t	port
	)

Get link state.

Parameters

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

Returns: Link state

Definition at line 568 of file ksz9893_driver.c.

◆ ksz9893GetPortState()

SwitchPortState ksz9893GetPortState	(	NetInterface *	interface,
		uint8_t	port
	)

Get port state.

Parameters

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

Returns: Port state

Definition at line 817 of file ksz9893_driver.c.

◆ ksz9893GetStaticFdbEntry()

error_t ksz9893GetStaticFdbEntry	(	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 1192 of file ksz9893_driver.c.

◆ ksz9893Init()

error_t ksz9893Init ( NetInterface * interface )

KSZ9893 Ethernet switch initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 91 of file ksz9893_driver.c.

◆ ksz9893InitHook()

__weak_func void ksz9893InitHook ( NetInterface * interface )

KSZ9893 custom configuration.

Parameters

[in] interface Underlying network interface

Definition at line 232 of file ksz9893_driver.c.

◆ ksz9893ReadMmdReg()

uint16_t ksz9893ReadMmdReg	(	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 1649 of file ksz9893_driver.c.

◆ ksz9893ReadPhyReg()

uint16_t ksz9893ReadPhyReg	(	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 1559 of file ksz9893_driver.c.

◆ ksz9893ReadSwitchReg16()

uint16_t ksz9893ReadSwitchReg16	(	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 1809 of file ksz9893_driver.c.

◆ ksz9893ReadSwitchReg32()

uint32_t ksz9893ReadSwitchReg32	(	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 1903 of file ksz9893_driver.c.

◆ ksz9893ReadSwitchReg8()

uint8_t ksz9893ReadSwitchReg8	(	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 1718 of file ksz9893_driver.c.

◆ ksz9893SetAgingTime()

void ksz9893SetAgingTime	(	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 880 of file ksz9893_driver.c.

◆ ksz9893SetPortState()

void ksz9893SetPortState	(	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 761 of file ksz9893_driver.c.

◆ ksz9893SetUnknownMcastFwdPorts()

void ksz9893SetUnknownMcastFwdPorts	(	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 1480 of file ksz9893_driver.c.

◆ ksz9893TagFrame()

error_t ksz9893TagFrame	(	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 457 of file ksz9893_driver.c.

◆ ksz9893Tick()

void ksz9893Tick ( NetInterface * interface )

KSZ9893 timer handler.

Parameters

[in] interface Underlying network interface

Definition at line 242 of file ksz9893_driver.c.

◆ ksz9893UntagFrame()

error_t ksz9893UntagFrame	(	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 516 of file ksz9893_driver.c.

◆ ksz9893WriteMmdReg()

void ksz9893WriteMmdReg	(	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 1621 of file ksz9893_driver.c.

◆ ksz9893WritePhyReg()

void ksz9893WritePhyReg	(	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 1525 of file ksz9893_driver.c.

◆ ksz9893WriteSwitchReg16()

void ksz9893WriteSwitchReg16	(	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 1765 of file ksz9893_driver.c.

◆ ksz9893WriteSwitchReg32()

void ksz9893WriteSwitchReg32	(	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 1857 of file ksz9893_driver.c.

◆ ksz9893WriteSwitchReg8()

void ksz9893WriteSwitchReg8	(	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 1675 of file ksz9893_driver.c.

Variable Documentation

◆ ksz9893IngressTailTag

const uint8_t ksz9893IngressTailTag[3]

Initial value:

=
{
   KSZ9893_TAIL_TAG_NORMAL_ADDR_LOOKUP,
   KSZ9893_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9893_TAIL_TAG_DEST_PORT1,
   KSZ9893_TAIL_TAG_PORT_BLOCKING_OVERRIDE | KSZ9893_TAIL_TAG_DEST_PORT2
}

Tail tag rules (host to KSZ9893)

Definition at line 77 of file ksz9893_driver.c.

◆ ksz9893SwitchDriver

const SwitchDriver ksz9893SwitchDriver

Initial value:

=
{
   ksz9893Init,
   ksz9893Tick,
   ksz9893EnableIrq,
   ksz9893DisableIrq,
   ksz9893EventHandler,
   ksz9893TagFrame,
   ksz9893UntagFrame,
   ksz9893GetLinkState,
   ksz9893GetLinkSpeed,
   ksz9893GetDuplexMode,
   ksz9893SetPortState,
   ksz9893GetPortState,
   ksz9893SetAgingTime,
   ksz9893EnableIgmpSnooping,
   ksz9893EnableMldSnooping,
   ksz9893EnableRsvdMcastTable,
   ksz9893AddStaticFdbEntry,
   ksz9893DeleteStaticFdbEntry,
   ksz9893GetStaticFdbEntry,
   ksz9893FlushStaticFdbTable,
   ksz9893GetDynamicFdbEntry,
   ksz9893FlushDynamicFdbTable,
   ksz9893SetUnknownMcastFwdPorts
}

KSZ9893 Ethernet switch driver.

Definition at line 45 of file ksz9893_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ksz9893AddStaticFdbEntry()

◆ ksz9893DeleteStaticFdbEntry()

◆ ksz9893DisableIrq()

◆ ksz9893DumpPhyReg()

◆ ksz9893EnableIgmpSnooping()

◆ ksz9893EnableIrq()

◆ ksz9893EnableMldSnooping()

◆ ksz9893EnableRsvdMcastTable()

◆ ksz9893EventHandler()

◆ ksz9893FlushDynamicFdbTable()

◆ ksz9893FlushStaticFdbTable()

◆ ksz9893GetDuplexMode()

◆ ksz9893GetDynamicFdbEntry()

◆ ksz9893GetLinkSpeed()

◆ ksz9893GetLinkState()

◆ ksz9893GetPortState()

◆ ksz9893GetStaticFdbEntry()

◆ ksz9893Init()

◆ ksz9893InitHook()

◆ ksz9893ReadMmdReg()

◆ ksz9893ReadPhyReg()

◆ ksz9893ReadSwitchReg16()

◆ ksz9893ReadSwitchReg32()

◆ ksz9893ReadSwitchReg8()

◆ ksz9893SetAgingTime()

◆ ksz9893SetPortState()

◆ ksz9893SetUnknownMcastFwdPorts()

◆ ksz9893TagFrame()

◆ ksz9893Tick()

◆ ksz9893UntagFrame()

◆ ksz9893WriteMmdReg()

◆ ksz9893WritePhyReg()

◆ ksz9893WriteSwitchReg16()

◆ ksz9893WriteSwitchReg32()

◆ ksz9893WriteSwitchReg8()

Variable Documentation

◆ ksz9893IngressTailTag

◆ ksz9893SwitchDriver