Macros | Functions | Variables
sc835_eth_driver.c File Reference

ADSP-SC835 Ethernet MAC driver. More...

#include <sys/platform.h>
#include <services/int/adi_int.h>
#include "core/net.h"
#include "drivers/mac/sc835_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t sc835EthInit (NetInterface *interface)
 ADSP-SC835 Ethernet MAC initialization. More...
 
__weak_func void sc835EthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
__weak_func void sc835EthResetPhy (NetInterface *interface)
 Reset PHY transceiver. More...
 
void sc835EthInitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void sc835EthTick (NetInterface *interface)
 ADSP-SC835 Ethernet MAC timer handler. More...
 
void sc835EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void sc835EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void sc835EthIrqHandler (uint32_t id, void *param)
 ADSP-SC835 Ethernet MAC interrupt service routine. More...
 
void sc835EthEventHandler (NetInterface *interface)
 ADSP-SC835 Ethernet MAC event handler. More...
 
error_t sc835EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t sc835EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t sc835EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t sc835EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void sc835EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t sc835EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t sc835EthCalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver sc835EthDriver
 ADSP-SC835 Ethernet MAC driver. More...
 

Detailed Description

ADSP-SC835 Ethernet MAC driver.

License

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

Copyright (C) 2010-2026 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
2.6.0

Definition in file sc835_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file sc835_eth_driver.c.

Function Documentation

◆ sc835EthCalcCrc()

uint32_t sc835EthCalcCrc ( const void *  data,
size_t  length 
)

CRC calculation.

Parameters
[in]dataPointer to the data over which to calculate the CRC
[in]lengthNumber of bytes to process
Returns
Resulting CRC value

Definition at line 986 of file sc835_eth_driver.c.

◆ sc835EthDisableIrq()

void sc835EthDisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 433 of file sc835_eth_driver.c.

◆ sc835EthEnableIrq()

void sc835EthEnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 405 of file sc835_eth_driver.c.

◆ sc835EthEventHandler()

void sc835EthEventHandler ( NetInterface *  interface)

ADSP-SC835 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 515 of file sc835_eth_driver.c.

◆ sc835EthInit()

error_t sc835EthInit ( NetInterface *  interface)

ADSP-SC835 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 119 of file sc835_eth_driver.c.

◆ sc835EthInitDmaDesc()

void sc835EthInitDmaDesc ( NetInterface *  interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 323 of file sc835_eth_driver.c.

◆ sc835EthInitGpio()

__weak_func void sc835EthInitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 253 of file sc835_eth_driver.c.

◆ sc835EthIrqHandler()

void sc835EthIrqHandler ( uint32_t  id,
void *  param 
)

ADSP-SC835 Ethernet MAC interrupt service routine.

Parameters
idInterrupt identifier
paramUnused parameter

Definition at line 462 of file sc835_eth_driver.c.

◆ sc835EthReadPhyReg()

uint16_t sc835EthReadPhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

Parameters
[in]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
Returns
Register value

Definition at line 937 of file sc835_eth_driver.c.

◆ sc835EthReceivePacket()

error_t sc835EthReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 604 of file sc835_eth_driver.c.

◆ sc835EthResetPhy()

__weak_func void sc835EthResetPhy ( NetInterface *  interface)

Reset PHY transceiver.

Parameters
[in]interfaceUnderlying network interface

Definition at line 313 of file sc835_eth_driver.c.

◆ sc835EthSendPacket()

error_t sc835EthSendPacket ( NetInterface *  interface,
const NetBuffer *  buffer,
size_t  offset,
NetTxAncillary *  ancillary 
)

Send a packet.

Parameters
[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 540 of file sc835_eth_driver.c.

◆ sc835EthTick()

void sc835EthTick ( NetInterface *  interface)

ADSP-SC835 Ethernet MAC timer handler.

This routine is periodically called by the TCP/IP stack to handle periodic operations such as polling the link state

Parameters
[in]interfaceUnderlying network interface

Definition at line 380 of file sc835_eth_driver.c.

◆ sc835EthUpdateMacAddrFilter()

error_t sc835EthUpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 681 of file sc835_eth_driver.c.

◆ sc835EthUpdateMacConfig()

error_t sc835EthUpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 843 of file sc835_eth_driver.c.

◆ sc835EthWritePhyReg()

void sc835EthWritePhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 
)

Write PHY register.

Parameters
[in]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
[in]dataRegister value

Definition at line 895 of file sc835_eth_driver.c.

Variable Documentation

◆ sc835EthDriver

const NicDriver sc835EthDriver
Initial value:
=
{
NIC_TYPE_ETHERNET,
ETH_MTU,
sc835EthInit,
sc835EthTick,
sc835EthEnableIrq,
sc835EthDisableIrq,
sc835EthEventHandler,
sc835EthSendPacket,
sc835EthUpdateMacAddrFilter,
sc835EthUpdateMacConfig,
sc835EthWritePhyReg,
sc835EthReadPhyReg,
TRUE,
TRUE,
TRUE,
FALSE
}

ADSP-SC835 Ethernet MAC driver.

Definition at line 92 of file sc835_eth_driver.c.

sc835EthInit
error_t sc835EthInit(NetInterface *interface)
ADSP-SC835 Ethernet MAC initialization.
Definition: sc835_eth_driver.c:119
sc835EthSendPacket
error_t sc835EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: sc835_eth_driver.c:540
TRUE
#define TRUE
Definition: os_port.h:50
sc835EthTick
void sc835EthTick(NetInterface *interface)
ADSP-SC835 Ethernet MAC timer handler.
Definition: sc835_eth_driver.c:380
sc835EthEnableIrq
void sc835EthEnableIrq(NetInterface *interface)
Enable interrupts.
Definition: sc835_eth_driver.c:405
sc835EthReadPhyReg
uint16_t sc835EthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: sc835_eth_driver.c:937
FALSE
#define FALSE
Definition: os_port.h:46
sc835EthWritePhyReg
void sc835EthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: sc835_eth_driver.c:895
sc835EthDisableIrq
void sc835EthDisableIrq(NetInterface *interface)
Disable interrupts.
Definition: sc835_eth_driver.c:433
sc835EthEventHandler
void sc835EthEventHandler(NetInterface *interface)
ADSP-SC835 Ethernet MAC event handler.
Definition: sc835_eth_driver.c:515
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
sc835EthUpdateMacAddrFilter
error_t sc835EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: sc835_eth_driver.c:681
sc835EthUpdateMacConfig
error_t sc835EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: sc835_eth_driver.c:843
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83