ksz8895_driver.c File Reference

KSZ8895 5-port Ethernet switch. More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t ksz8895Init (NetInterface *interface)
 KSZ8895 Ethernet switch initialization. More...
 
bool_t ksz8895GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. More...
 
void ksz8895Tick (NetInterface *interface)
 KSZ8895 timer handler. More...
 
void ksz8895EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void ksz8895DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ksz8895EventHandler (NetInterface *interface)
 KSZ8895 event handler. More...
 
error_t ksz8895TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, uint8_t port, uint16_t *type)
 Add tail tag to Ethernet frame. More...
 
error_t ksz8895UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, uint8_t *port)
 Decode tail tag from incoming Ethernet frame. More...
 
void ksz8895WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
 Write PHY register. More...
 
uint16_t ksz8895ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
 Read PHY register. More...
 
void ksz8895DumpPhyReg (NetInterface *interface, uint8_t port)
 Dump PHY registers for debugging purpose. More...
 
void ksz8895WriteSwitchReg (NetInterface *interface, uint8_t address, uint8_t data)
 Write switch register. More...
 
uint8_t ksz8895ReadSwitchReg (NetInterface *interface, uint8_t address)
 Read switch register. More...
 
void ksz8895DumpSwitchReg (NetInterface *interface)
 Dump switch registers for debugging purpose. More...
 

Variables

const PhyDriver ksz8895PhyDriver
 KSZ8895 Ethernet switch driver. More...
 
const uint8_t ksz8895IngressTailTag [5]
 Tail tag rules (host to KSZ8895) More...
 

Detailed Description

KSZ8895 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 ksz8895_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz8895_driver.c.

Function Documentation

◆ ksz8895DisableIrq()

void ksz8895DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 304 of file ksz8895_driver.c.

◆ ksz8895DumpPhyReg()

void ksz8895DumpPhyReg ( NetInterface interface,
uint8_t  port 
)

Dump PHY registers for debugging purpose.

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

Definition at line 589 of file ksz8895_driver.c.

◆ ksz8895DumpSwitchReg()

void ksz8895DumpSwitchReg ( NetInterface interface)

Dump switch registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 708 of file ksz8895_driver.c.

◆ ksz8895EnableIrq()

void ksz8895EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 294 of file ksz8895_driver.c.

◆ ksz8895EventHandler()

void ksz8895EventHandler ( NetInterface interface)

KSZ8895 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 314 of file ksz8895_driver.c.

◆ ksz8895GetLinkState()

bool_t ksz8895GetLinkState ( NetInterface interface,
uint8_t  port 
)

Get link state.

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

Definition at line 178 of file ksz8895_driver.c.

◆ ksz8895Init()

error_t ksz8895Init ( NetInterface interface)

KSZ8895 Ethernet switch initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 77 of file ksz8895_driver.c.

◆ ksz8895ReadPhyReg()

uint16_t ksz8895ReadPhyReg ( 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 575 of file ksz8895_driver.c.

◆ ksz8895ReadSwitchReg()

uint8_t ksz8895ReadSwitchReg ( NetInterface interface,
uint8_t  address 
)

Read switch register.

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

Definition at line 660 of file ksz8895_driver.c.

◆ ksz8895TagFrame()

error_t ksz8895TagFrame ( 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 462 of file ksz8895_driver.c.

◆ ksz8895Tick()

void ksz8895Tick ( NetInterface interface)

KSZ8895 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 212 of file ksz8895_driver.c.

◆ ksz8895UntagFrame()

error_t ksz8895UntagFrame ( 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 514 of file ksz8895_driver.c.

◆ ksz8895WritePhyReg()

void ksz8895WritePhyReg ( 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 559 of file ksz8895_driver.c.

◆ ksz8895WriteSwitchReg()

void ksz8895WriteSwitchReg ( 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 613 of file ksz8895_driver.c.

Variable Documentation

◆ ksz8895IngressTailTag

const uint8_t ksz8895IngressTailTag[5]
Initial value:

Tail tag rules (host to KSZ8895)

Definition at line 61 of file ksz8895_driver.c.

◆ ksz8895PhyDriver

const PhyDriver ksz8895PhyDriver
Initial value:

KSZ8895 Ethernet switch driver.

Definition at line 45 of file ksz8895_driver.c.

void ksz8895Tick(NetInterface *interface)
KSZ8895 timer handler.
void ksz8895EnableIrq(NetInterface *interface)
Enable interrupts.
error_t ksz8895UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, uint8_t *port)
Decode tail tag from incoming Ethernet frame.
#define KSZ8895_TAIL_TAG_ENCODE(port)
void ksz8895DisableIrq(NetInterface *interface)
Disable interrupts.
void ksz8895EventHandler(NetInterface *interface)
KSZ8895 event handler.
error_t ksz8895TagFrame(NetInterface *interface, NetBuffer *buffer, size_t *offset, uint8_t port, uint16_t *type)
Add tail tag to Ethernet frame.
error_t ksz8895Init(NetInterface *interface)
KSZ8895 Ethernet switch initialization.