ksz8863_driver.c File Reference

KSZ8863 3-port Ethernet switch. 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...
 
bool_t ksz8863GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. 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, uint8_t port, uint16_t *type)
 Add tail tag to Ethernet frame. More...
 
error_t ksz8863UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, uint8_t *port)
 Decode tail tag from incoming Ethernet frame. 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 PhyDriver ksz8863PhyDriver
 KSZ8863 Ethernet switch driver. More...
 
const uint8_t ksz8863IngressTailTag [3]
 Tail tag rules (host to KSZ8863) More...
 

Detailed Description

KSZ8863 3-port Ethernet switch.

License

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

Copyright (C) 2010-2019 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.6

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

◆ ksz8863DisableIrq()

void ksz8863DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 327 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 607 of file ksz8863_driver.c.

◆ ksz8863DumpSwitchReg()

void ksz8863DumpSwitchReg ( NetInterface interface)

Dump switch registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 726 of file ksz8863_driver.c.

◆ ksz8863EnableIrq()

void ksz8863EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 317 of file ksz8863_driver.c.

◆ ksz8863EventHandler()

void ksz8863EventHandler ( NetInterface interface)

KSZ8863 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 337 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 174 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 75 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 593 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 678 of file ksz8863_driver.c.

◆ ksz8863TagFrame()

error_t ksz8863TagFrame ( NetInterface interface,
NetBuffer buffer,
size_t *  offset,
uint8_t  port,
uint16_t *  type 
)

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]portSwitch port identifier
[in,out]typeEthernet type
Returns
Error code

Definition at line 480 of file ksz8863_driver.c.

◆ ksz8863Tick()

void ksz8863Tick ( NetInterface interface)

KSZ8863 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 222 of file ksz8863_driver.c.

◆ ksz8863UntagFrame()

error_t ksz8863UntagFrame ( NetInterface interface,
uint8_t **  frame,
size_t *  length,
uint8_t *  port 
)

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
[out]portSwitch port identifier
Returns
Error code

Definition at line 532 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 577 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 631 of file ksz8863_driver.c.

Variable Documentation

◆ ksz8863IngressTailTag

const uint8_t ksz8863IngressTailTag[3]
Initial value:

Tail tag rules (host to KSZ8863)

Definition at line 61 of file ksz8863_driver.c.

◆ ksz8863PhyDriver

const PhyDriver ksz8863PhyDriver
Initial value:

KSZ8863 Ethernet switch driver.

Definition at line 45 of file ksz8863_driver.c.

error_t ksz8863UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, uint8_t *port)
Decode tail tag from incoming Ethernet frame.
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, uint8_t port, uint16_t *type)
Add tail tag to Ethernet frame.
#define KSZ8863_TAIL_TAG_ENCODE(port)
void ksz8863DisableIrq(NetInterface *interface)
Disable interrupts.
void ksz8863EventHandler(NetInterface *interface)
KSZ8863 event handler.