Sergey Pastor / 1

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

sama5d3_eth.h File Reference
Data Structures | Functions | Variables

sama5d3_eth.h File Reference

SAMA5D3 Ethernet MAC controller. More...

Go to the source code of this file.

Data Structures

struct  Sama5d3TxBufferDesc
 Transmit buffer descriptor. More...
struct  Sama5d3RxBufferDesc
 Receive buffer descriptor. More...

Functions

error_t sama5d3EthInit (NetInterface *interface)
 SAMA5D3 Ethernet MAC initialization.
void sama5d3EthInitGpio (NetInterface *interface)
 GPIO configuration.
void sama5d3EthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors.
void sama5d3EthTick (NetInterface *interface)
 SAMA5D3 Ethernet MAC timer handler.
void sama5d3EthEnableIrq (NetInterface *interface)
 Enable interrupts.
void sama5d3EthDisableIrq (NetInterface *interface)
 Disable interrupts.
void sama5d3EthIrqHandler (void)
 SAMA5D3 Ethernet MAC interrupt service routine.
void sama5d3EthEventHandler (NetInterface *interface)
 SAMA5D3 Ethernet MAC event handler.
error_t sama5d3EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet.
error_t sama5d3EthReceivePacket (NetInterface *interface)
 Receive a packet.
error_t sama5d3EthSetMulticastFilter (NetInterface *interface)
 Configure multicast MAC address filtering.
error_t sama5d3EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation.
void sama5d3EthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register.
uint16_t sama5d3EthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register.

Variables

const NicDriver sama5d3EthDriver
 SAMA5D3 Ethernet MAC driver.

Detailed Description

SAMA5D3 Ethernet MAC controller.

License

Copyright (C) 2010-2017 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.7.6

Definition in file sama5d3_eth.h.

Function Documentation

void sama5d3EthDisableIrq ( NetInterface *  interface )

Disable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 307 of file sama5d3_eth.c.

void sama5d3EthEnableIrq ( NetInterface *  interface )

Enable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 292 of file sama5d3_eth.c.

void sama5d3EthEventHandler ( NetInterface *  interface )

SAMA5D3 Ethernet MAC event handler.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 377 of file sama5d3_eth.c.

error_t sama5d3EthInit ( NetInterface *  interface )

SAMA5D3 Ethernet MAC initialization.

Parameters:
[in]interfaceUnderlying network interface
Returns:
Error code

Definition at line 117 of file sama5d3_eth.c.

void sama5d3EthInitBufferDesc ( NetInterface *  interface )

Initialize buffer descriptors.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 227 of file sama5d3_eth.c.

void sama5d3EthInitGpio ( NetInterface *  interface )

GPIO configuration.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 200 of file sama5d3_eth.c.

void sama5d3EthIrqHandler ( void   )

SAMA5D3 Ethernet MAC interrupt service routine.

Definition at line 321 of file sama5d3_eth.c.

uint16_t sama5d3EthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

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

Definition at line 714 of file sama5d3_eth.c.

error_t sama5d3EthReceivePacket ( NetInterface *  interface )

Receive a packet.

Parameters:
[in]interfaceUnderlying network interface
Returns:
Error code

Definition at line 476 of file sama5d3_eth.c.

error_t sama5d3EthSendPacket ( 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 411 of file sama5d3_eth.c.

error_t sama5d3EthSetMulticastFilter ( NetInterface *  interface )

Configure multicast MAC address filtering.

Parameters:
[in]interfaceUnderlying network interface
Returns:
Error code

Definition at line 590 of file sama5d3_eth.c.

void sama5d3EthTick ( NetInterface *  interface )

SAMA5D3 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 280 of file sama5d3_eth.c.

error_t sama5d3EthUpdateMacConfig ( NetInterface *  interface )

Adjust MAC configuration parameters for proper operation.

Parameters:
[in]interfaceUnderlying network interface
Returns:
Error code

Definition at line 653 of file sama5d3_eth.c.

void sama5d3EthWritePhyReg ( 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 687 of file sama5d3_eth.c.

Variable Documentation

const NicDriver sama5d3EthDriver

SAMA5D3 Ethernet MAC driver.

Definition at line 90 of file sama5d3_eth.c.

Generated on Tue Jul 12 2022 17:10:22 by  doxygen 1.7.2