ksz8863_driver.c File Reference

KSZ8863 3-port Ethernet switch driver. More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t ksz8863Init (NetInterface *interface)
 KSZ8863 Ethernet switch initialization. More...
 
__weak_func void ksz8863InitHook (NetInterface *interface)
 KSZ8863 custom configuration. More...
 
void ksz8863Tick (NetInterface *interface)
 KSZ8863 timer handler. More...
 
void ksz8863EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void ksz8863DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ksz8863EventHandler (NetInterface *interface)
 KSZ8863 event handler. More...
 
error_t ksz8863TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
 Add tail tag to Ethernet frame. More...
 
error_t ksz8863UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
 Decode tail tag from incoming Ethernet frame. More...
 
bool_t ksz8863GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. More...
 
uint32_t ksz8863GetLinkSpeed (NetInterface *interface, uint8_t port)
 Get link speed. More...
 
NicDuplexMode ksz8863GetDuplexMode (NetInterface *interface, uint8_t port)
 Get duplex mode. More...
 
void ksz8863SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
 Set port state. More...
 
SwitchPortState ksz8863GetPortState (NetInterface *interface, uint8_t port)
 Get port state. More...
 
void ksz8863SetAgingTime (NetInterface *interface, uint32_t agingTime)
 Set aging time for dynamic filtering entries. More...
 
void ksz8863EnableIgmpSnooping (NetInterface *interface, bool_t enable)
 Enable IGMP snooping. More...
 
void ksz8863EnableMldSnooping (NetInterface *interface, bool_t enable)
 Enable MLD snooping. More...
 
void ksz8863EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
 Enable reserved multicast table. More...
 
error_t ksz8863AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Add a new entry to the static MAC table. More...
 
error_t ksz8863DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Remove an entry from the static MAC table. More...
 
error_t ksz8863GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the static MAC table. More...
 
void ksz8863FlushStaticFdbTable (NetInterface *interface)
 Flush static MAC table. More...
 
error_t ksz8863GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the dynamic MAC table. More...
 
void ksz8863FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
 Flush dynamic MAC table. More...
 
void ksz8863SetUnknownMcastFwdPorts (NetInterface *interface, bool_t enable, uint32_t forwardPorts)
 Set forward ports for unknown multicast packets. More...
 
void ksz8863WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
 Write PHY register. More...
 
uint16_t ksz8863ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
 Read PHY register. More...
 
void ksz8863DumpPhyReg (NetInterface *interface, uint8_t port)
 Dump PHY registers for debugging purpose. More...
 
void ksz8863WriteSwitchReg (NetInterface *interface, uint8_t address, uint8_t data)
 Write switch register. More...
 
uint8_t ksz8863ReadSwitchReg (NetInterface *interface, uint8_t address)
 Read switch register. More...
 
void ksz8863DumpSwitchReg (NetInterface *interface)
 Dump switch registers for debugging purpose. More...
 

Variables

const SwitchDriver ksz8863SwitchDriver
 KSZ8863 Ethernet switch driver. More...
 
const uint8_t ksz8863IngressTailTag [3]
 Tail tag rules (host to KSZ8863) More...
 

Detailed Description

KSZ8863 3-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 ksz8863_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz8863_driver.c.

Function Documentation

◆ ksz8863AddStaticFdbEntry()

error_t ksz8863AddStaticFdbEntry ( 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 842 of file ksz8863_driver.c.

◆ ksz8863DeleteStaticFdbEntry()

error_t ksz8863DeleteStaticFdbEntry ( 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 941 of file ksz8863_driver.c.

◆ ksz8863DisableIrq()

void ksz8863DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 273 of file ksz8863_driver.c.

◆ ksz8863DumpPhyReg()

void ksz8863DumpPhyReg ( NetInterface interface,
uint8_t  port 
)

Dump PHY registers for debugging purpose.

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

Definition at line 1302 of file ksz8863_driver.c.

◆ ksz8863DumpSwitchReg()

void ksz8863DumpSwitchReg ( NetInterface interface)

Dump switch registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1437 of file ksz8863_driver.c.

◆ ksz8863EnableIgmpSnooping()

void ksz8863EnableIgmpSnooping ( NetInterface interface,
bool_t  enable 
)

Enable IGMP snooping.

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

Definition at line 789 of file ksz8863_driver.c.

◆ ksz8863EnableIrq()

void ksz8863EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 263 of file ksz8863_driver.c.

◆ ksz8863EnableMldSnooping()

void ksz8863EnableMldSnooping ( NetInterface interface,
bool_t  enable 
)

Enable MLD snooping.

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

Definition at line 817 of file ksz8863_driver.c.

◆ ksz8863EnableRsvdMcastTable()

void ksz8863EnableRsvdMcastTable ( NetInterface interface,
bool_t  enable 
)

Enable reserved multicast table.

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

Definition at line 829 of file ksz8863_driver.c.

◆ ksz8863EventHandler()

void ksz8863EventHandler ( NetInterface interface)

KSZ8863 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 283 of file ksz8863_driver.c.

◆ ksz8863FlushDynamicFdbTable()

void ksz8863FlushDynamicFdbTable ( NetInterface interface,
uint8_t  port 
)

Flush dynamic MAC table.

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

Definition at line 1191 of file ksz8863_driver.c.

◆ ksz8863FlushStaticFdbTable()

void ksz8863FlushStaticFdbTable ( NetInterface interface)

Flush static MAC table.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1067 of file ksz8863_driver.c.

◆ ksz8863GetDuplexMode()

NicDuplexMode ksz8863GetDuplexMode ( NetInterface interface,
uint8_t  port 
)

Get duplex mode.

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

Definition at line 604 of file ksz8863_driver.c.

◆ ksz8863GetDynamicFdbEntry()

error_t ksz8863GetDynamicFdbEntry ( 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 1107 of file ksz8863_driver.c.

◆ ksz8863GetLinkSpeed()

uint32_t ksz8863GetLinkSpeed ( NetInterface interface,
uint8_t  port 
)

Get link speed.

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

Definition at line 550 of file ksz8863_driver.c.

◆ ksz8863GetLinkState()

bool_t ksz8863GetLinkState ( NetInterface interface,
uint8_t  port 
)

Get link state.

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

Definition at line 506 of file ksz8863_driver.c.

◆ ksz8863GetPortState()

SwitchPortState ksz8863GetPortState ( NetInterface interface,
uint8_t  port 
)

Get port state.

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

Definition at line 714 of file ksz8863_driver.c.

◆ ksz8863GetStaticFdbEntry()

error_t ksz8863GetStaticFdbEntry ( 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 1005 of file ksz8863_driver.c.

◆ ksz8863Init()

error_t ksz8863Init ( NetInterface interface)

KSZ8863 Ethernet switch initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 91 of file ksz8863_driver.c.

◆ ksz8863InitHook()

__weak_func void ksz8863InitHook ( NetInterface interface)

KSZ8863 custom configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 183 of file ksz8863_driver.c.

◆ ksz8863ReadPhyReg()

uint16_t ksz8863ReadPhyReg ( 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 1276 of file ksz8863_driver.c.

◆ ksz8863ReadSwitchReg()

uint8_t ksz8863ReadSwitchReg ( NetInterface interface,
uint8_t  address 
)

Read switch register.

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

Definition at line 1381 of file ksz8863_driver.c.

◆ ksz8863SetAgingTime()

void ksz8863SetAgingTime ( 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 777 of file ksz8863_driver.c.

◆ ksz8863SetPortState()

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

Set port state.

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

Definition at line 658 of file ksz8863_driver.c.

◆ ksz8863SetUnknownMcastFwdPorts()

void ksz8863SetUnknownMcastFwdPorts ( 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 1238 of file ksz8863_driver.c.

◆ ksz8863TagFrame()

error_t ksz8863TagFrame ( 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 408 of file ksz8863_driver.c.

◆ ksz8863Tick()

void ksz8863Tick ( NetInterface interface)

KSZ8863 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 193 of file ksz8863_driver.c.

◆ ksz8863UntagFrame()

error_t ksz8863UntagFrame ( 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 463 of file ksz8863_driver.c.

◆ ksz8863WritePhyReg()

void ksz8863WritePhyReg ( 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 1253 of file ksz8863_driver.c.

◆ ksz8863WriteSwitchReg()

void ksz8863WriteSwitchReg ( NetInterface interface,
uint8_t  address,
uint8_t  data 
)

Write switch register.

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

Definition at line 1326 of file ksz8863_driver.c.

Variable Documentation

◆ ksz8863IngressTailTag

const uint8_t ksz8863IngressTailTag[3]
Initial value:
=
{
}
#define KSZ8863_TAIL_TAG_DEST_PORT2
#define KSZ8863_TAIL_TAG_DEST_PORT1
#define KSZ8863_TAIL_TAG_NORMAL_ADDR_LOOKUP

Tail tag rules (host to KSZ8863)

Definition at line 77 of file ksz8863_driver.c.

◆ ksz8863SwitchDriver

const SwitchDriver ksz8863SwitchDriver
Initial value:
=
{
}
void ksz8863DisableIrq(NetInterface *interface)
Disable interrupts.
error_t ksz8863UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
Decode tail tag from incoming Ethernet frame.
void ksz8863FlushStaticFdbTable(NetInterface *interface)
Flush static MAC table.
uint32_t ksz8863GetLinkSpeed(NetInterface *interface, uint8_t port)
Get link speed.
void ksz8863SetAgingTime(NetInterface *interface, uint32_t agingTime)
Set aging time for dynamic filtering entries.
error_t ksz8863GetStaticFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the static MAC table.
void ksz8863SetPortState(NetInterface *interface, uint8_t port, SwitchPortState state)
Set port state.
void ksz8863EventHandler(NetInterface *interface)
KSZ8863 event handler.
void ksz8863EnableRsvdMcastTable(NetInterface *interface, bool_t enable)
Enable reserved multicast table.
error_t ksz8863DeleteStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Remove an entry from the static MAC table.
void ksz8863EnableIgmpSnooping(NetInterface *interface, bool_t enable)
Enable IGMP snooping.
NicDuplexMode ksz8863GetDuplexMode(NetInterface *interface, uint8_t port)
Get duplex mode.
void ksz8863FlushDynamicFdbTable(NetInterface *interface, uint8_t port)
Flush dynamic MAC table.
error_t ksz8863AddStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Add a new entry to the static MAC table.
void ksz8863EnableMldSnooping(NetInterface *interface, bool_t enable)
Enable MLD snooping.
void ksz8863EnableIrq(NetInterface *interface)
Enable interrupts.
void ksz8863Tick(NetInterface *interface)
KSZ8863 timer handler.
error_t ksz8863Init(NetInterface *interface)
KSZ8863 Ethernet switch initialization.
error_t ksz8863TagFrame(NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
Add tail tag to Ethernet frame.
void ksz8863SetUnknownMcastFwdPorts(NetInterface *interface, bool_t enable, uint32_t forwardPorts)
Set forward ports for unknown multicast packets.
error_t ksz8863GetDynamicFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the dynamic MAC table.
bool_t ksz8863GetLinkState(NetInterface *interface, uint8_t port)
Get link state.
SwitchPortState ksz8863GetPortState(NetInterface *interface, uint8_t port)
Get port state.

KSZ8863 Ethernet switch driver.

Definition at line 45 of file ksz8863_driver.c.