ksz8864_driver.c File Reference

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

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t ksz8864Init (NetInterface *interface)
 KSZ8864 Ethernet switch initialization. More...
 
void ksz8864Tick (NetInterface *interface)
 KSZ8864 timer handler. More...
 
void ksz8864EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void ksz8864DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ksz8864EventHandler (NetInterface *interface)
 KSZ8864 event handler. More...
 
error_t ksz8864TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
 Add tail tag to Ethernet frame. More...
 
error_t ksz8864UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
 Decode tail tag from incoming Ethernet frame. More...
 
bool_t ksz8864GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. More...
 
uint32_t ksz8864GetLinkSpeed (NetInterface *interface, uint8_t port)
 Get link speed. More...
 
NicDuplexMode ksz8864GetDuplexMode (NetInterface *interface, uint8_t port)
 Get duplex mode. More...
 
void ksz8864SetPortState (NetInterface *interface, uint8_t port, SwitchPortState state)
 Set port state. More...
 
SwitchPortState ksz8864GetPortState (NetInterface *interface, uint8_t port)
 Get port state. More...
 
void ksz8864SetAgingTime (NetInterface *interface, uint32_t agingTime)
 Set aging time for dynamic filtering entries. More...
 
void ksz8864EnableRsvdMcastTable (NetInterface *interface, bool_t enable)
 Enable reserved multicast table. More...
 
error_t ksz8864AddStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Add a new entry to the static MAC table. More...
 
error_t ksz8864DeleteStaticFdbEntry (NetInterface *interface, const SwitchFdbEntry *entry)
 Remove an entry from the static MAC table. More...
 
error_t ksz8864GetStaticFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the static MAC table. More...
 
void ksz8864FlushStaticFdbTable (NetInterface *interface)
 Flush static MAC table. More...
 
error_t ksz8864GetDynamicFdbEntry (NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
 Read an entry from the dynamic MAC table. More...
 
void ksz8864FlushDynamicFdbTable (NetInterface *interface, uint8_t port)
 Flush dynamic MAC table. More...
 
void ksz8864WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
 Write PHY register. More...
 
uint16_t ksz8864ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
 Read PHY register. More...
 
void ksz8864DumpPhyReg (NetInterface *interface, uint8_t port)
 Dump PHY registers for debugging purpose. More...
 
void ksz8864WriteSwitchReg (NetInterface *interface, uint8_t address, uint8_t data)
 Write switch register. More...
 
uint8_t ksz8864ReadSwitchReg (NetInterface *interface, uint8_t address)
 Read switch register. More...
 
void ksz8864DumpSwitchReg (NetInterface *interface)
 Dump switch registers for debugging purpose. More...
 

Variables

const SwitchDriver ksz8864SwitchDriver
 KSZ8864 Ethernet switch driver. More...
 
const uint8_t ksz8864IngressTailTag [4]
 Tail tag rules (host to KSZ8864) More...
 

Detailed Description

KSZ8864 4-port Ethernet switch driver.

License

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

Copyright (C) 2010-2020 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
1.9.8

Definition in file ksz8864_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz8864_driver.c.

Function Documentation

◆ ksz8864AddStaticFdbEntry()

error_t ksz8864AddStaticFdbEntry ( 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 815 of file ksz8864_driver.c.

◆ ksz8864DeleteStaticFdbEntry()

error_t ksz8864DeleteStaticFdbEntry ( 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 918 of file ksz8864_driver.c.

◆ ksz8864DisableIrq()

void ksz8864DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 267 of file ksz8864_driver.c.

◆ ksz8864DumpPhyReg()

void ksz8864DumpPhyReg ( NetInterface interface,
uint8_t  port 
)

Dump PHY registers for debugging purpose.

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

Definition at line 1270 of file ksz8864_driver.c.

◆ ksz8864DumpSwitchReg()

void ksz8864DumpSwitchReg ( NetInterface interface)

Dump switch registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1405 of file ksz8864_driver.c.

◆ ksz8864EnableIrq()

void ksz8864EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 257 of file ksz8864_driver.c.

◆ ksz8864EnableRsvdMcastTable()

void ksz8864EnableRsvdMcastTable ( NetInterface interface,
bool_t  enable 
)

Enable reserved multicast table.

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

Definition at line 773 of file ksz8864_driver.c.

◆ ksz8864EventHandler()

void ksz8864EventHandler ( NetInterface interface)

KSZ8864 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 277 of file ksz8864_driver.c.

◆ ksz8864FlushDynamicFdbTable()

void ksz8864FlushDynamicFdbTable ( NetInterface interface,
uint8_t  port 
)

Flush dynamic MAC table.

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

Definition at line 1173 of file ksz8864_driver.c.

◆ ksz8864FlushStaticFdbTable()

void ksz8864FlushStaticFdbTable ( NetInterface interface)

Flush static MAC table.

Parameters
[in]interfaceUnderlying network interface

Definition at line 1049 of file ksz8864_driver.c.

◆ ksz8864GetDuplexMode()

NicDuplexMode ksz8864GetDuplexMode ( NetInterface interface,
uint8_t  port 
)

Get duplex mode.

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

Definition at line 597 of file ksz8864_driver.c.

◆ ksz8864GetDynamicFdbEntry()

error_t ksz8864GetDynamicFdbEntry ( 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 1089 of file ksz8864_driver.c.

◆ ksz8864GetLinkSpeed()

uint32_t ksz8864GetLinkSpeed ( NetInterface interface,
uint8_t  port 
)

Get link speed.

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

Definition at line 553 of file ksz8864_driver.c.

◆ ksz8864GetLinkState()

bool_t ksz8864GetLinkState ( NetInterface interface,
uint8_t  port 
)

Get link state.

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

Definition at line 516 of file ksz8864_driver.c.

◆ ksz8864GetPortState()

SwitchPortState ksz8864GetPortState ( NetInterface interface,
uint8_t  port 
)

Get port state.

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

Definition at line 698 of file ksz8864_driver.c.

◆ ksz8864GetStaticFdbEntry()

error_t ksz8864GetStaticFdbEntry ( 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 987 of file ksz8864_driver.c.

◆ ksz8864Init()

error_t ksz8864Init ( NetInterface interface)

KSZ8864 Ethernet switch initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 89 of file ksz8864_driver.c.

◆ ksz8864ReadPhyReg()

uint16_t ksz8864ReadPhyReg ( 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 1244 of file ksz8864_driver.c.

◆ ksz8864ReadSwitchReg()

uint8_t ksz8864ReadSwitchReg ( NetInterface interface,
uint8_t  address 
)

Read switch register.

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

Definition at line 1349 of file ksz8864_driver.c.

◆ ksz8864SetAgingTime()

void ksz8864SetAgingTime ( 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 761 of file ksz8864_driver.c.

◆ ksz8864SetPortState()

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

Set port state.

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

Definition at line 642 of file ksz8864_driver.c.

◆ ksz8864TagFrame()

error_t ksz8864TagFrame ( 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 418 of file ksz8864_driver.c.

◆ ksz8864Tick()

void ksz8864Tick ( NetInterface interface)

KSZ8864 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 187 of file ksz8864_driver.c.

◆ ksz8864UntagFrame()

error_t ksz8864UntagFrame ( 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 473 of file ksz8864_driver.c.

◆ ksz8864WritePhyReg()

void ksz8864WritePhyReg ( 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 1221 of file ksz8864_driver.c.

◆ ksz8864WriteSwitchReg()

void ksz8864WriteSwitchReg ( 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 1294 of file ksz8864_driver.c.

Variable Documentation

◆ ksz8864IngressTailTag

◆ ksz8864SwitchDriver

void ksz8864EnableIrq(NetInterface *interface)
Enable interrupts.
void ksz8864SetAgingTime(NetInterface *interface, uint32_t agingTime)
Set aging time for dynamic filtering entries.
error_t ksz8864Init(NetInterface *interface)
KSZ8864 Ethernet switch initialization.
uint32_t ksz8864GetLinkSpeed(NetInterface *interface, uint8_t port)
Get link speed.
void ksz8864SetPortState(NetInterface *interface, uint8_t port, SwitchPortState state)
Set port state.
#define KSZ8864_TAIL_TAG_DEST_PORT1
void ksz8864Tick(NetInterface *interface)
KSZ8864 timer handler.
error_t ksz8864AddStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Add a new entry to the static MAC table.
error_t ksz8864GetDynamicFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the dynamic MAC table.
bool_t ksz8864GetLinkState(NetInterface *interface, uint8_t port)
Get link state.
void ksz8864EnableRsvdMcastTable(NetInterface *interface, bool_t enable)
Enable reserved multicast table.
#define KSZ8864_TAIL_TAG_PORT_SEL
error_t ksz8864UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, NetRxAncillary *ancillary)
Decode tail tag from incoming Ethernet frame.
error_t ksz8864DeleteStaticFdbEntry(NetInterface *interface, const SwitchFdbEntry *entry)
Remove an entry from the static MAC table.
void ksz8864DisableIrq(NetInterface *interface)
Disable interrupts.
#define KSZ8864_TAIL_TAG_NORMAL_ADDR_LOOKUP
NicDuplexMode ksz8864GetDuplexMode(NetInterface *interface, uint8_t port)
Get duplex mode.
#define KSZ8864_TAIL_TAG_DEST_PORT2
#define KSZ8864_TAIL_TAG_DEST_PORT3
void ksz8864FlushStaticFdbTable(NetInterface *interface)
Flush static MAC table.
void ksz8864EventHandler(NetInterface *interface)
KSZ8864 event handler.
SwitchPortState ksz8864GetPortState(NetInterface *interface, uint8_t port)
Get port state.
error_t ksz8864TagFrame(NetInterface *interface, NetBuffer *buffer, size_t *offset, NetTxAncillary *ancillary)
Add tail tag to Ethernet frame.
error_t ksz8864GetStaticFdbEntry(NetInterface *interface, uint_t index, SwitchFdbEntry *entry)
Read an entry from the static MAC table.
void ksz8864FlushDynamicFdbTable(NetInterface *interface, uint8_t port)
Flush dynamic MAC table.