ksz8864_driver.c File Reference

KSZ8864 5-port Ethernet switch. 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...
 
bool_t ksz8864GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. 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, uint8_t port, uint16_t *type)
 Add tail tag to Ethernet frame. More...
 
error_t ksz8864UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, uint8_t *port)
 Decode tail tag from incoming Ethernet frame. 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 PhyDriver ksz8864PhyDriver
 KSZ8864 Ethernet switch driver. More...
 
const uint8_t ksz8864IngressTailTag [4]
 Tail tag rules (host to KSZ8864) More...
 

Detailed Description

KSZ8864 5-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 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

◆ ksz8864DisableIrq()

void ksz8864DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 318 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 628 of file ksz8864_driver.c.

◆ ksz8864DumpSwitchReg()

void ksz8864DumpSwitchReg ( NetInterface interface)

Dump switch registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 747 of file ksz8864_driver.c.

◆ ksz8864EnableIrq()

void ksz8864EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 308 of file ksz8864_driver.c.

◆ ksz8864EventHandler()

void ksz8864EventHandler ( NetInterface interface)

KSZ8864 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 328 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 177 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 76 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 614 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 699 of file ksz8864_driver.c.

◆ ksz8864TagFrame()

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

◆ ksz8864Tick()

void ksz8864Tick ( NetInterface interface)

KSZ8864 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 216 of file ksz8864_driver.c.

◆ ksz8864UntagFrame()

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

Variable Documentation

◆ ksz8864IngressTailTag

const uint8_t ksz8864IngressTailTag[4]
Initial value:

Tail tag rules (host to KSZ8864)

Definition at line 61 of file ksz8864_driver.c.

◆ ksz8864PhyDriver

const PhyDriver ksz8864PhyDriver
Initial value:

KSZ8864 Ethernet switch driver.

Definition at line 45 of file ksz8864_driver.c.

void ksz8864EnableIrq(NetInterface *interface)
Enable interrupts.
error_t ksz8864TagFrame(NetInterface *interface, NetBuffer *buffer, size_t *offset, uint8_t port, uint16_t *type)
Add tail tag to Ethernet frame.
error_t ksz8864Init(NetInterface *interface)
KSZ8864 Ethernet switch initialization.
void ksz8864Tick(NetInterface *interface)
KSZ8864 timer handler.
error_t ksz8864UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, uint8_t *port)
Decode tail tag from incoming Ethernet frame.
void ksz8864DisableIrq(NetInterface *interface)
Disable interrupts.
#define KSZ8864_TAIL_TAG_ENCODE(port)
void ksz8864EventHandler(NetInterface *interface)
KSZ8864 event handler.