ksz8794_driver.c File Reference

KSZ8794 4-port Ethernet switch driver. More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t ksz8794Init (NetInterface *interface)
 KSZ8794 Ethernet switch initialization. More...
 
__weak_func void ksz8794InitHook (NetInterface *interface)
 KSZ8794 custom configuration. More...
 
void ksz8794Tick (NetInterface *interface)
 KSZ8794 timer handler. More...
 
void ksz8794EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void ksz8794DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ksz8794EventHandler (NetInterface *interface)
 KSZ8794 event handler. More...
 
error_t ksz8794TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
 Add tail tag to Ethernet frame. More...
 
error_t ksz8794UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
 Decode tail tag from incoming Ethernet frame. More...
 
bool_t ksz8794GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. More...
 
uint32_t ksz8794GetLinkSpeed (NetInterface *interface, uint8_t port)
 Get link speed. More...
 
NicDuplexMode ksz8794GetDuplexMode (NetInterface *interface, uint8_t port)
 Get duplex mode. More...
 
void ksz8794SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
 Set port state. More...
 
SwitchPortState ksz8794GetPortState (NetInterface *interface, uint8_t port)
 Get port state. More...
 
void ksz8794SetAgingTime (NetInterface *interface, uint32_t agingTime)
 Set aging time for dynamic filtering entries. More...
 
void ksz8794EnableIgmpSnooping (NetInterface *interface, bool_t enable)
 Enable IGMP snooping. More...
 
void ksz8794EnableMldSnooping (NetInterface *interface, bool_t enable)
 Enable MLD snooping. More...
 
void ksz8794EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
 Enable reserved multicast table. More...
 
error_t ksz8794AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Add a new entry to the static MAC table. More...
 
error_t ksz8794DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Remove an entry from the static MAC table. More...
 
error_t ksz8794GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the static MAC table. More...
 
void ksz8794FlushStaticFdbTable (NetInterface *interface)
 Flush static MAC table. More...
 
error_t ksz8794GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the dynamic MAC table. More...
 
void ksz8794FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
 Flush dynamic MAC table. More...
 
void ksz8794SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
 Set forward ports for unknown multicast packets. More...
 
void ksz8794WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
 Write PHY register. More...
 
uint16_t ksz8794ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
 Read PHY register. More...
 
void ksz8794DumpPhyReg (NetInterface *interface, uint8_t port)
 Dump PHY registers for debugging purpose. More...
 
void ksz8794WriteSwitchReg (NetInterface *interface, uint16_t address, uint8_t data)
 Write switch register. More...
 
uint8_t ksz8794ReadSwitchReg (NetInterface *interface, uint16_t address)
 Read switch register. More...
 
void ksz8794DumpSwitchReg (NetInterface *interface)
 Dump switch registers for debugging purpose. More...
 

Variables

const SwitchDriver ksz8794SwitchDriver
 KSZ8794 Ethernet switch driver. More...
 
const uint8_t ksz8794IngressTailTag [4]
 Tail tag rules (host to KSZ8794) More...
 

Detailed Description

KSZ8794 4-port Ethernet switch driver.

License

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

Copyright (C) 2010-2024 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.4.0

Definition in file ksz8794_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz8794_driver.c.

Function Documentation

◆ ksz8794AddStaticFdbEntry()

error_t ksz8794AddStaticFdbEntry ( NetInterface interface,
const SwitchFdbEntry entry 
)

Add a new entry to the static MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]entryPointer to the forwarding database entry
Returns
Error code

Definition at line 965 of file ksz8794_driver.c.

◆ ksz8794DeleteStaticFdbEntry()

error_t ksz8794DeleteStaticFdbEntry ( NetInterface interface,
const SwitchFdbEntry entry 
)

Remove an entry from the static MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]entryForwarding database entry to remove from the table
Returns
Error code

Definition at line 1067 of file ksz8794_driver.c.

◆ ksz8794DisableIrq()

void ksz8794DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 299 of file ksz8794_driver.c.

◆ ksz8794DumpPhyReg()

void ksz8794DumpPhyReg ( NetInterface interface,
uint8_t  port 
)

Dump PHY registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number

Definition at line 1481 of file ksz8794_driver.c.

◆ ksz8794DumpSwitchReg()

void ksz8794DumpSwitchReg ( NetInterface interface)

Dump switch registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1589 of file ksz8794_driver.c.

◆ ksz8794EnableIgmpSnooping()

void ksz8794EnableIgmpSnooping ( NetInterface interface,
bool_t  enable 
)

Enable IGMP snooping.

Parameters
[in]interfaceUnderlying network interface
[in]enableEnable or disable IGMP snooping

Definition at line 867 of file ksz8794_driver.c.

◆ ksz8794EnableIrq()

void ksz8794EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 289 of file ksz8794_driver.c.

◆ ksz8794EnableMldSnooping()

void ksz8794EnableMldSnooping ( NetInterface interface,
bool_t  enable 
)

Enable MLD snooping.

Parameters
[in]interfaceUnderlying network interface
[in]enableEnable or disable MLD snooping

Definition at line 895 of file ksz8794_driver.c.

◆ ksz8794EnableRsvdMcastTable()

void ksz8794EnableRsvdMcastTable ( NetInterface interface,
bool_t  enable 
)

Enable reserved multicast table.

Parameters
[in]interfaceUnderlying network interface
[in]enableEnable or disable reserved group addresses

Definition at line 923 of file ksz8794_driver.c.

◆ ksz8794EventHandler()

void ksz8794EventHandler ( NetInterface interface)

KSZ8794 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 309 of file ksz8794_driver.c.

◆ ksz8794FlushDynamicFdbTable()

void ksz8794FlushDynamicFdbTable ( NetInterface interface,
uint8_t  port 
)

Flush dynamic MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number

Definition at line 1330 of file ksz8794_driver.c.

◆ ksz8794FlushStaticFdbTable()

void ksz8794FlushStaticFdbTable ( NetInterface interface)

Flush static MAC table.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1198 of file ksz8794_driver.c.

◆ ksz8794GetDuplexMode()

NicDuplexMode ksz8794GetDuplexMode ( NetInterface interface,
uint8_t  port 
)

Get duplex mode.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
Returns
Duplex mode

Definition at line 672 of file ksz8794_driver.c.

◆ ksz8794GetDynamicFdbEntry()

error_t ksz8794GetDynamicFdbEntry ( NetInterface interface,
uint_t  index,
SwitchFdbEntry entry 
)

Read an entry from the dynamic MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]indexZero-based index of the entry to read
[out]entryPointer to the forwarding database entry
Returns
Error code

Definition at line 1246 of file ksz8794_driver.c.

◆ ksz8794GetLinkSpeed()

uint32_t ksz8794GetLinkSpeed ( NetInterface interface,
uint8_t  port 
)

Get link speed.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
Returns
Link speed

Definition at line 589 of file ksz8794_driver.c.

◆ ksz8794GetLinkState()

bool_t ksz8794GetLinkState ( NetInterface interface,
uint8_t  port 
)

Get link state.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
Returns
Link state

Definition at line 545 of file ksz8794_driver.c.

◆ ksz8794GetPortState()

SwitchPortState ksz8794GetPortState ( NetInterface interface,
uint8_t  port 
)

Get port state.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
Returns
Port state

Definition at line 792 of file ksz8794_driver.c.

◆ ksz8794GetStaticFdbEntry()

error_t ksz8794GetStaticFdbEntry ( NetInterface interface,
uint_t  index,
SwitchFdbEntry entry 
)

Read an entry from the static MAC table.

Parameters
[in]interfaceUnderlying network interface
[in]indexZero-based index of the entry to read
[out]entryPointer to the forwarding database entry
Returns
Error code

Definition at line 1136 of file ksz8794_driver.c.

◆ ksz8794Init()

error_t ksz8794Init ( NetInterface interface)

KSZ8794 Ethernet switch initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 92 of file ksz8794_driver.c.

◆ ksz8794InitHook()

__weak_func void ksz8794InitHook ( NetInterface interface)

KSZ8794 custom configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 209 of file ksz8794_driver.c.

◆ ksz8794ReadPhyReg()

uint16_t ksz8794ReadPhyReg ( NetInterface interface,
uint8_t  port,
uint8_t  address 
)

Read PHY register.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
[in]addressPHY register address
Returns
Register value

Definition at line 1455 of file ksz8794_driver.c.

◆ ksz8794ReadSwitchReg()

uint8_t ksz8794ReadSwitchReg ( NetInterface interface,
uint16_t  address 
)

Read switch register.

Parameters
[in]interfaceUnderlying network interface
[in]addressSwitch register address
Returns
Register value

Definition at line 1546 of file ksz8794_driver.c.

◆ ksz8794SetAgingTime()

void ksz8794SetAgingTime ( NetInterface interface,
uint32_t  agingTime 
)

Set aging time for dynamic filtering entries.

Parameters
[in]interfaceUnderlying network interface
[in]agingTimeAging time, in seconds

Definition at line 855 of file ksz8794_driver.c.

◆ ksz8794SetPortState()

void ksz8794SetPortState ( NetInterface interface,
uint8_t  port,
SwitchPortState  state 
)

Set port state.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
[in]statePort state

Definition at line 736 of file ksz8794_driver.c.

◆ ksz8794SetUnknownMcastFwdPorts()

void ksz8794SetUnknownMcastFwdPorts ( NetInterface interface,
bool_t  enable,
uint32_t  forwardPorts 
)

Set forward ports for unknown multicast packets.

Parameters
[in]interfaceUnderlying network interface
[in]enableEnable or disable forwarding of unknown multicast packets
[in]forwardPortsPort map

Definition at line 1387 of file ksz8794_driver.c.

◆ ksz8794TagFrame()

error_t ksz8794TagFrame ( NetInterface interface,
NetBuffer buffer,
size_t *  offset,
NetTxAncillary ancillary 
)

Add tail tag to Ethernet frame.

Parameters
[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the payload
[in,out]offsetOffset to the first payload byte
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 434 of file ksz8794_driver.c.

◆ ksz8794Tick()

void ksz8794Tick ( NetInterface interface)

KSZ8794 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 219 of file ksz8794_driver.c.

◆ ksz8794UntagFrame()

error_t ksz8794UntagFrame ( NetInterface interface,
uint8_t **  frame,
size_t *  length,
NetRxAncillary ancillary 
)

Decode tail tag from incoming Ethernet frame.

Parameters
[in]interfaceUnderlying network interface
[in,out]framePointer to the received Ethernet frame
[in,out]lengthLength of the frame, in bytes
[in,out]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 493 of file ksz8794_driver.c.

◆ ksz8794WritePhyReg()

void ksz8794WritePhyReg ( NetInterface interface,
uint8_t  port,
uint8_t  address,
uint16_t  data 
)

Write PHY register.

Parameters
[in]interfaceUnderlying network interface
[in]portPort number
[in]addressPHY register address
[in]dataRegister value

Definition at line 1432 of file ksz8794_driver.c.

◆ ksz8794WriteSwitchReg()

void ksz8794WriteSwitchReg ( NetInterface interface,
uint16_t  address,
uint8_t  data 
)

Write switch register.

Parameters
[in]interfaceUnderlying network interface
[in]addressSwitch register address
[in]dataRegister value

Definition at line 1505 of file ksz8794_driver.c.

Variable Documentation

◆ ksz8794IngressTailTag

const uint8_t ksz8794IngressTailTag[4]
Initial value:

Tail tag rules (host to KSZ8794)

Definition at line 77 of file ksz8794_driver.c.

◆ ksz8794SwitchDriver

const SwitchDriver ksz8794SwitchDriver
Initial value:
=
{
}
void ksz8794DisableIrq(NetInterface *interface)
Disable interrupts.
uint32_t ksz8794GetLinkSpeed(NetInterface *interface, uint8_t port)
Get link speed.
void ksz8794EnableRsvdMcastTable(NetInterface *interface, bool_t enable)
Enable reserved multicast table.
error_t ksz8794DeleteStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Remove an entry from the static MAC table.
error_t ksz8794UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
Decode tail tag from incoming Ethernet frame.
error_t ksz8794GetDynamicFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the dynamic MAC table.
error_t ksz8794GetStaticFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the static MAC table.
void ksz8794EnableIrq(NetInterface *interface)
Enable interrupts.
void ksz8794EnableMldSnooping(NetInterface *interface, bool_t enable)
Enable MLD snooping.
error_t ksz8794AddStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Add a new entry to the static MAC table.
SwitchPortState ksz8794GetPortState(NetInterface *interface, uint8_t port)
Get port state.
void ksz8794FlushStaticFdbTable(NetInterface *interface)
Flush static MAC table.
bool_t ksz8794GetLinkState(NetInterface *interface, uint8_t port)
Get link state.
NicDuplexMode ksz8794GetDuplexMode(NetInterface *interface, uint8_t port)
Get duplex mode.
void ksz8794SetAgingTime(NetInterface *interface, uint32_t agingTime)
Set aging time for dynamic filtering entries.
void ksz8794SetPortState(NetInterface *interface, uint8_t port, SwitchPortState state)
Set port state.
error_t ksz8794Init(NetInterface *interface)
KSZ8794 Ethernet switch initialization.
void ksz8794FlushDynamicFdbTable(NetInterface *interface, uint8_t port)
Flush dynamic MAC table.
void ksz8794EventHandler(NetInterface *interface)
KSZ8794 event handler.
void ksz8794Tick(NetInterface *interface)
KSZ8794 timer handler.
void ksz8794EnableIgmpSnooping(NetInterface *interface, bool_t enable)
Enable IGMP snooping.
error_t ksz8794TagFrame(NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
Add tail tag to Ethernet frame.
void ksz8794SetUnknownMcastFwdPorts(NetInterface *interface, bool_t enable, uint32_t forwardPorts)
Set forward ports for unknown multicast packets.

KSZ8794 Ethernet switch driver.

Definition at line 45 of file ksz8794_driver.c.