Sergey Pastor / 1

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

sam3x_eth.h File Reference

sam3x_eth.h File Reference

SAM3X Ethernet MAC controller. More...

Go to the source code of this file.

Data Structures

struct  Sam3xTxBufferDesc
 Transmit buffer descriptor. More...
struct  Sam3xRxBufferDesc
 Receive buffer descriptor. More...

Functions

error_t sam3xEthInit (NetInterface *interface)
 SAM3X Ethernet MAC initialization.
void sam3xEthInitGpio (NetInterface *interface)
 GPIO configuration.
void sam3xEthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors.
void sam3xEthTick (NetInterface *interface)
 SAM3X Ethernet MAC timer handler.
void sam3xEthEnableIrq (NetInterface *interface)
 Enable interrupts.
void sam3xEthDisableIrq (NetInterface *interface)
 Disable interrupts.
void sam3xEthEventHandler (NetInterface *interface)
 SAM3X Ethernet MAC event handler.
error_t sam3xEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet.
error_t sam3xEthReceivePacket (NetInterface *interface)
 Receive a packet.
error_t sam3xEthSetMulticastFilter (NetInterface *interface)
 Configure multicast MAC address filtering.
error_t sam3xEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation.
void sam3xEthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register.
uint16_t sam3xEthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register.

Variables

const NicDriver sam3xEthDriver
 SAM3X Ethernet MAC driver.

Detailed Description

SAM3X 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 sam3x_eth.h.


Function Documentation

void sam3xEthDisableIrq ( NetInterface *  interface )

Disable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 301 of file sam3x_eth.c.

void sam3xEthEnableIrq ( NetInterface *  interface )

Enable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 287 of file sam3x_eth.c.

void sam3xEthEventHandler ( NetInterface *  interface )

SAM3X Ethernet MAC event handler.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 367 of file sam3x_eth.c.

error_t sam3xEthInit ( NetInterface *  interface )

SAM3X Ethernet MAC initialization.

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

Definition at line 113 of file sam3x_eth.c.

void sam3xEthInitBufferDesc ( NetInterface *  interface )

Initialize buffer descriptors.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 222 of file sam3x_eth.c.

void sam3xEthInitGpio ( NetInterface *  interface )

GPIO configuration.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 196 of file sam3x_eth.c.

uint16_t sam3xEthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

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

Definition at line 704 of file sam3x_eth.c.

error_t sam3xEthReceivePacket ( NetInterface *  interface )

Receive a packet.

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

Definition at line 466 of file sam3x_eth.c.

error_t sam3xEthSendPacket ( 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 401 of file sam3x_eth.c.

error_t sam3xEthSetMulticastFilter ( NetInterface *  interface )

Configure multicast MAC address filtering.

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

Definition at line 580 of file sam3x_eth.c.

void sam3xEthTick ( NetInterface *  interface )

SAM3X 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 275 of file sam3x_eth.c.

error_t sam3xEthUpdateMacConfig ( NetInterface *  interface )

Adjust MAC configuration parameters for proper operation.

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

Definition at line 643 of file sam3x_eth.c.

void sam3xEthWritePhyReg ( 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 677 of file sam3x_eth.c.


Variable Documentation

SAM3X Ethernet MAC driver.

Definition at line 86 of file sam3x_eth.c.