ksz8563_driver.c File Reference

KSZ8563 Ethernet switch. More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t ksz8563Init (NetInterface *interface)
 KSZ8563 Ethernet switch initialization. More...
 
bool_t ksz8563GetLinkState (NetInterface *interface, uint8_t port)
 Get link state. More...
 
void ksz8563Tick (NetInterface *interface)
 KSZ8563 timer handler. More...
 
void ksz8563EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void ksz8563DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void ksz8563EventHandler (NetInterface *interface)
 KSZ8563 event handler. More...
 
error_t ksz8563TagFrame (NetInterface *interface, NetBuffer *buffer, size_t *offset, uint8_t port, uint16_t *type)
 Add tail tag to Ethernet frame. More...
 
error_t ksz8563UntagFrame (NetInterface *interface, uint8_t **frame, size_t *length, uint8_t *port)
 Decode tail tag from incoming Ethernet frame. More...
 
void ksz8563WritePhyReg (NetInterface *interface, uint8_t port, uint8_t address, uint16_t data)
 Write PHY register. More...
 
uint16_t ksz8563ReadPhyReg (NetInterface *interface, uint8_t port, uint8_t address)
 Read PHY register. More...
 
void ksz8563DumpPhyReg (NetInterface *interface, uint8_t port)
 Dump PHY registers for debugging purpose. More...
 
void ksz8563WriteSwitchReg (NetInterface *interface, uint16_t address, uint8_t data)
 Write switch register. More...
 
uint8_t ksz8563ReadSwitchReg (NetInterface *interface, uint16_t address)
 Read switch register. More...
 
void ksz8563DumpSwitchReg (NetInterface *interface)
 Dump switch registers for debugging purpose. More...
 

Variables

const PhyDriver ksz8563PhyDriver
 KSZ8563 Ethernet switch driver. More...
 
const uint8_t ksz8563IngressTailTag [3]
 Tail tag rules (host to KSZ8563) More...
 

Detailed Description

KSZ8563 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.2

Definition in file ksz8563_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file ksz8563_driver.c.

Function Documentation

◆ ksz8563DisableIrq()

void ksz8563DisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 313 of file ksz8563_driver.c.

◆ ksz8563DumpPhyReg()

void ksz8563DumpPhyReg ( NetInterface interface,
uint8_t  port 
)

Dump PHY registers for debugging purpose.

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

Definition at line 660 of file ksz8563_driver.c.

◆ ksz8563DumpSwitchReg()

void ksz8563DumpSwitchReg ( NetInterface interface)

Dump switch registers for debugging purpose.

Parameters
[in]interfaceUnderlying network interface

Definition at line 772 of file ksz8563_driver.c.

◆ ksz8563EnableIrq()

void ksz8563EnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 303 of file ksz8563_driver.c.

◆ ksz8563EventHandler()

void ksz8563EventHandler ( NetInterface interface)

KSZ8563 event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 323 of file ksz8563_driver.c.

◆ ksz8563GetLinkState()

bool_t ksz8563GetLinkState ( NetInterface interface,
uint8_t  port 
)

Get link state.

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

Definition at line 184 of file ksz8563_driver.c.

◆ ksz8563Init()

error_t ksz8563Init ( NetInterface interface)

KSZ8563 Ethernet switch initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 75 of file ksz8563_driver.c.

◆ ksz8563ReadPhyReg()

uint16_t ksz8563ReadPhyReg ( 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 613 of file ksz8563_driver.c.

◆ ksz8563ReadSwitchReg()

uint8_t ksz8563ReadSwitchReg ( NetInterface interface,
uint16_t  address 
)

Read switch register.

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

Definition at line 727 of file ksz8563_driver.c.

◆ ksz8563TagFrame()

error_t ksz8563TagFrame ( 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 471 of file ksz8563_driver.c.

◆ ksz8563Tick()

void ksz8563Tick ( NetInterface interface)

KSZ8563 timer handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 222 of file ksz8563_driver.c.

◆ ksz8563UntagFrame()

error_t ksz8563UntagFrame ( 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 523 of file ksz8563_driver.c.

◆ ksz8563WritePhyReg()

void ksz8563WritePhyReg ( 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 568 of file ksz8563_driver.c.

◆ ksz8563WriteSwitchReg()

void ksz8563WriteSwitchReg ( NetInterface interface,
uint16_t  address,
uint8_t  data 
)

Write switch register.

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

Definition at line 684 of file ksz8563_driver.c.

Variable Documentation

◆ ksz8563IngressTailTag

const uint8_t ksz8563IngressTailTag[3]
Initial value:
=
{
0,
}
#define KSZ8563_TAIL_TAG_ENCODE(port)

Tail tag rules (host to KSZ8563)

Definition at line 61 of file ksz8563_driver.c.

◆ ksz8563PhyDriver

const PhyDriver ksz8563PhyDriver
Initial value:
=
{
}
void ksz8563Tick(NetInterface *interface)
KSZ8563 timer handler.
void ksz8563EnableIrq(NetInterface *interface)
Enable interrupts.
error_t ksz8563Init(NetInterface *interface)
KSZ8563 Ethernet switch initialization.
error_t ksz8563TagFrame(NetInterface *interface, NetBuffer *buffer, size_t *offset, uint8_t port, uint16_t *type)
Add tail tag to Ethernet frame.
void ksz8563DisableIrq(NetInterface *interface)
Disable interrupts.
error_t ksz8563UntagFrame(NetInterface *interface, uint8_t **frame, size_t *length, uint8_t *port)
Decode tail tag from incoming Ethernet frame.
void ksz8563EventHandler(NetInterface *interface)
KSZ8563 event handler.

KSZ8563 Ethernet switch driver.

Definition at line 45 of file ksz8563_driver.c.