Macros | Functions | Variables
sc589_eth2_driver.c File Reference

ADSP-SC589 Ethernet MAC driver (EMAC1 instance) More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t sc589Eth2Init (NetInterface *interface)
 ADSP-SC589 Ethernet MAC initialization. More...
 
__weak_func void sc589Eth2InitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void sc589Eth2InitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void sc589Eth2Tick (NetInterface *interface)
 ADSP-SC589 Ethernet MAC timer handler. More...
 
void sc589Eth2EnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void sc589Eth2DisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void sc589Eth2IrqHandler (uint32_t id, void *param)
 ADSP-SC589 Ethernet MAC interrupt service routine. More...
 
void sc589Eth2EventHandler (NetInterface *interface)
 ADSP-SC589 Ethernet MAC event handler. More...
 
error_t sc589Eth2SendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t sc589Eth2ReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t sc589Eth2UpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t sc589Eth2UpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void sc589Eth2WritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t sc589Eth2ReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t sc589Eth2CalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver sc589Eth2Driver
 ADSP-SC589 Ethernet MAC driver (EMAC1 instance) More...
 

Detailed Description

ADSP-SC589 Ethernet MAC driver (EMAC1 instance)

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 sc589_eth2_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file sc589_eth2_driver.c.

Function Documentation

◆ sc589Eth2CalcCrc()

uint32_t sc589Eth2CalcCrc ( 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 879 of file sc589_eth2_driver.c.

◆ sc589Eth2DisableIrq()

void sc589Eth2DisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 391 of file sc589_eth2_driver.c.

◆ sc589Eth2EnableIrq()

void sc589Eth2EnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 363 of file sc589_eth2_driver.c.

◆ sc589Eth2EventHandler()

void sc589Eth2EventHandler ( NetInterface *  interface)

ADSP-SC589 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 473 of file sc589_eth2_driver.c.

◆ sc589Eth2Init()

error_t sc589Eth2Init ( NetInterface *  interface)

ADSP-SC589 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 119 of file sc589_eth2_driver.c.

◆ sc589Eth2InitDmaDesc()

void sc589Eth2InitDmaDesc ( NetInterface *  interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 269 of file sc589_eth2_driver.c.

◆ sc589Eth2InitGpio()

__weak_func void sc589Eth2InitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 223 of file sc589_eth2_driver.c.

◆ sc589Eth2IrqHandler()

void sc589Eth2IrqHandler ( uint32_t  id,
void *  param 
)

ADSP-SC589 Ethernet MAC interrupt service routine.

Parameters
idInterrupt identifier
paramUnused parameter

Definition at line 420 of file sc589_eth2_driver.c.

◆ sc589Eth2ReadPhyReg()

uint16_t sc589Eth2ReadPhyReg ( 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 833 of file sc589_eth2_driver.c.

◆ sc589Eth2ReceivePacket()

error_t sc589Eth2ReceivePacket ( NetInterface *  interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 562 of file sc589_eth2_driver.c.

◆ sc589Eth2SendPacket()

error_t sc589Eth2SendPacket ( 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 498 of file sc589_eth2_driver.c.

◆ sc589Eth2Tick()

void sc589Eth2Tick ( NetInterface *  interface)

ADSP-SC589 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 338 of file sc589_eth2_driver.c.

◆ sc589Eth2UpdateMacAddrFilter()

error_t sc589Eth2UpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 634 of file sc589_eth2_driver.c.

◆ sc589Eth2UpdateMacConfig()

error_t sc589Eth2UpdateMacConfig ( NetInterface *  interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 748 of file sc589_eth2_driver.c.

◆ sc589Eth2WritePhyReg()

void sc589Eth2WritePhyReg ( 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 791 of file sc589_eth2_driver.c.

Variable Documentation

◆ sc589Eth2Driver

const NicDriver sc589Eth2Driver
Initial value:
=
{
NIC_TYPE_ETHERNET,
ETH_MTU,
sc589Eth2Init,
sc589Eth2Tick,
sc589Eth2EnableIrq,
sc589Eth2DisableIrq,
sc589Eth2EventHandler,
sc589Eth2SendPacket,
sc589Eth2UpdateMacAddrFilter,
sc589Eth2UpdateMacConfig,
sc589Eth2WritePhyReg,
sc589Eth2ReadPhyReg,
TRUE,
TRUE,
TRUE,
FALSE
}

ADSP-SC589 Ethernet MAC driver (EMAC1 instance)

Definition at line 92 of file sc589_eth2_driver.c.

sc589Eth2SendPacket
error_t sc589Eth2SendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: sc589_eth2_driver.c:498
sc589Eth2UpdateMacConfig
error_t sc589Eth2UpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: sc589_eth2_driver.c:748
TRUE
#define TRUE
Definition: os_port.h:50
sc589Eth2UpdateMacAddrFilter
error_t sc589Eth2UpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: sc589_eth2_driver.c:634
FALSE
#define FALSE
Definition: os_port.h:46
sc589Eth2ReadPhyReg
uint16_t sc589Eth2ReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: sc589_eth2_driver.c:833
sc589Eth2EventHandler
void sc589Eth2EventHandler(NetInterface *interface)
ADSP-SC589 Ethernet MAC event handler.
Definition: sc589_eth2_driver.c:473
sc589Eth2Init
error_t sc589Eth2Init(NetInterface *interface)
ADSP-SC589 Ethernet MAC initialization.
Definition: sc589_eth2_driver.c:119
sc589Eth2Tick
void sc589Eth2Tick(NetInterface *interface)
ADSP-SC589 Ethernet MAC timer handler.
Definition: sc589_eth2_driver.c:338
sc589Eth2EnableIrq
void sc589Eth2EnableIrq(NetInterface *interface)
Enable interrupts.
Definition: sc589_eth2_driver.c:363
sc589Eth2DisableIrq
void sc589Eth2DisableIrq(NetInterface *interface)
Disable interrupts.
Definition: sc589_eth2_driver.c:391
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
sc589Eth2WritePhyReg
void sc589Eth2WritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: sc589_eth2_driver.c:791
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83