aps3_eth_driver.c File Reference

Cortus APS3 Ethernet MAC controller. More...

#include <machine/sfradr.h>
#include <machine/sfradr_eth.h>
#include <machine/ethernet.h>
#include <machine/ic.h>
#include "core/net.h"
#include "drivers/mac/aps3_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 
#define txBuffer   ((uint8_t *) SFRADR_ETH_TX_MEM_BOTTOM_AD)
 
#define rxBuffer   ((uint8_t *) SFRADR_ETH_RX_MEM_BOTTOM_AD)
 
#define txDmaDesc
 
#define rxDmaDesc
 

Functions

error_t aps3EthInit (NetInterface *interface)
 Cortus APS3 Ethernet MAC initialization. More...
 
void aps3EthInitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void aps3EthTick (NetInterface *interface)
 Cortus APS3 Ethernet MAC timer handler. More...
 
void aps3EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void aps3EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void aps3EthTxIrqHandler (void)
 Ethernet MAC transmit interrupt service routine. More...
 
void aps3EthRxIrqHandler (void)
 Ethernet MAC receive interrupt service routine. More...
 
void aps3EthEventHandler (NetInterface *interface)
 Cortus APS3 Ethernet MAC event handler. More...
 
error_t aps3EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet. More...
 
error_t aps3EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t aps3EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t aps3EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void aps3EthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t aps3EthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t aps3EthCalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver aps3EthDriver
 Cortus APS3 Ethernet MAC driver. More...
 

Detailed Description

Cortus APS3 Ethernet MAC controller.

License

Copyright (C) 2010-2018 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.0

Definition in file aps3_eth_driver.c.

Macro Definition Documentation

◆ rxBuffer

#define rxBuffer   ((uint8_t *) SFRADR_ETH_RX_MEM_BOTTOM_AD)

Definition at line 45 of file aps3_eth_driver.c.

◆ rxDmaDesc

#define rxDmaDesc
Value:
((Aps3RxDmaDesc *) (SFRADR_ETH_RX_MEM_BOTTOM_AD + \
#define APS3_ETH_RX_BUFFER_COUNT
RX DMA descriptor.
#define APS3_ETH_RX_BUFFER_SIZE

Definition at line 52 of file aps3_eth_driver.c.

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 30 of file aps3_eth_driver.c.

◆ txBuffer

#define txBuffer   ((uint8_t *) SFRADR_ETH_TX_MEM_BOTTOM_AD)

Definition at line 43 of file aps3_eth_driver.c.

◆ txDmaDesc

#define txDmaDesc
Value:
((Aps3TxDmaDesc *) (SFRADR_ETH_TX_MEM_BOTTOM_AD + \
#define APS3_ETH_TX_BUFFER_SIZE
TX DMA descriptor.
#define APS3_ETH_TX_BUFFER_COUNT

Definition at line 48 of file aps3_eth_driver.c.

Function Documentation

◆ aps3EthCalcCrc()

uint32_t aps3EthCalcCrc ( 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 624 of file aps3_eth_driver.c.

◆ aps3EthDisableIrq()

void aps3EthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 262 of file aps3_eth_driver.c.

◆ aps3EthEnableIrq()

void aps3EthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 246 of file aps3_eth_driver.c.

◆ aps3EthEventHandler()

void aps3EthEventHandler ( NetInterface interface)

Cortus APS3 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 338 of file aps3_eth_driver.c.

◆ aps3EthInit()

error_t aps3EthInit ( NetInterface interface)

Cortus APS3 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 90 of file aps3_eth_driver.c.

◆ aps3EthInitDmaDesc()

void aps3EthInitDmaDesc ( NetInterface interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 187 of file aps3_eth_driver.c.

◆ aps3EthReadPhyReg()

uint16_t aps3EthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

Parameters
[in]phyAddrPHY address
[in]regAddrRegister address
Returns
Register value

Definition at line 597 of file aps3_eth_driver.c.

◆ aps3EthReceivePacket()

error_t aps3EthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 429 of file aps3_eth_driver.c.

◆ aps3EthRxIrqHandler()

void aps3EthRxIrqHandler ( void  )

Ethernet MAC receive interrupt service routine.

Definition at line 310 of file aps3_eth_driver.c.

◆ aps3EthSendPacket()

error_t aps3EthSendPacket ( NetInterface interface,
const NetBuffer buffer,
size_t  offset 
)

Send a packet.

Parameters
[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
Returns
Error code

Definition at line 368 of file aps3_eth_driver.c.

◆ aps3EthTick()

void aps3EthTick ( NetInterface interface)

Cortus APS3 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 234 of file aps3_eth_driver.c.

◆ aps3EthTxIrqHandler()

void aps3EthTxIrqHandler ( void  )

Ethernet MAC transmit interrupt service routine.

Definition at line 277 of file aps3_eth_driver.c.

◆ aps3EthUpdateMacAddrFilter()

error_t aps3EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 482 of file aps3_eth_driver.c.

◆ aps3EthUpdateMacConfig()

error_t aps3EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 543 of file aps3_eth_driver.c.

◆ aps3EthWritePhyReg()

void aps3EthWritePhyReg ( uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 
)

Write PHY register.

Parameters
[in]phyAddrPHY address
[in]regAddrRegister address
[in]dataRegister value

Definition at line 571 of file aps3_eth_driver.c.

Variable Documentation

◆ aps3EthDriver

const NicDriver aps3EthDriver
Initial value:
=
{
}
void aps3EthTick(NetInterface *interface)
Cortus APS3 Ethernet MAC timer handler.
error_t aps3EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
#define TRUE
Definition: os_port.h:48
void aps3EthDisableIrq(NetInterface *interface)
Disable interrupts.
void aps3EthEventHandler(NetInterface *interface)
Cortus APS3 Ethernet MAC event handler.
error_t aps3EthInit(NetInterface *interface)
Cortus APS3 Ethernet MAC initialization.
#define ETH_MTU
Definition: ethernet.h:82
Ethernet interface.
Definition: nic.h:69
void aps3EthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
void aps3EthEnableIrq(NetInterface *interface)
Enable interrupts.
uint16_t aps3EthReadPhyReg(uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
error_t aps3EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
#define FALSE
Definition: os_port.h:44
error_t aps3EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.

Cortus APS3 Ethernet MAC driver.

Definition at line 63 of file aps3_eth_driver.c.