Sergey Pastor / 1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

sam4e_eth.h File Reference
Data Structures | Functions | Variables

sam4e_eth.h File Reference

SAM4E Ethernet MAC controller. More...

Go to the source code of this file.

Data Structures

struct  Sam4eTxBufferDesc
 Transmit buffer descriptor. More...
struct  Sam4eRxBufferDesc
 Receive buffer descriptor. More...

Functions

error_t sam4eEthInit (NetInterface *interface)
 SAM4E Ethernet MAC initialization.
void sam4eEthInitGpio (NetInterface *interface)
 GPIO configuration.
void sam4eEthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors.
void sam4eEthTick (NetInterface *interface)
 SAM4E Ethernet MAC timer handler.
void sam4eEthEnableIrq (NetInterface *interface)
 Enable interrupts.
void sam4eEthDisableIrq (NetInterface *interface)
 Disable interrupts.
void sam4eEthEventHandler (NetInterface *interface)
 SAM4E Ethernet MAC event handler.
error_t sam4eEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet.
error_t sam4eEthReceivePacket (NetInterface *interface)
 Receive a packet.
error_t sam4eEthSetMulticastFilter (NetInterface *interface)
 Configure multicast MAC address filtering.
error_t sam4eEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation.
void sam4eEthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register.
uint16_t sam4eEthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register.

Variables

const NicDriver sam4eEthDriver
 SAM4E Ethernet MAC driver.

Detailed Description

SAM4E 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 sam4e_eth.h.

Function Documentation

void sam4eEthDisableIrq ( NetInterface *  interface )

Disable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 302 of file sam4e_eth.c.

void sam4eEthEnableIrq ( NetInterface *  interface )

Enable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 288 of file sam4e_eth.c.

void sam4eEthEventHandler ( NetInterface *  interface )

SAM4E Ethernet MAC event handler.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 368 of file sam4e_eth.c.

error_t sam4eEthInit ( NetInterface *  interface )

SAM4E Ethernet MAC initialization.

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

Definition at line 113 of file sam4e_eth.c.

void sam4eEthInitBufferDesc ( NetInterface *  interface )

Initialize buffer descriptors.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 223 of file sam4e_eth.c.

void sam4eEthInitGpio ( NetInterface *  interface )

GPIO configuration.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 196 of file sam4e_eth.c.

uint16_t sam4eEthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

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

Definition at line 705 of file sam4e_eth.c.

error_t sam4eEthReceivePacket ( NetInterface *  interface )

Receive a packet.

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

Definition at line 467 of file sam4e_eth.c.

error_t sam4eEthSendPacket ( 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 402 of file sam4e_eth.c.

error_t sam4eEthSetMulticastFilter ( NetInterface *  interface )

Configure multicast MAC address filtering.

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

Definition at line 581 of file sam4e_eth.c.

void sam4eEthTick ( NetInterface *  interface )

SAM4E 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 276 of file sam4e_eth.c.

error_t sam4eEthUpdateMacConfig ( NetInterface *  interface )

Adjust MAC configuration parameters for proper operation.

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

Definition at line 644 of file sam4e_eth.c.

void sam4eEthWritePhyReg ( 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 678 of file sam4e_eth.c.

Variable Documentation

const NicDriver sam4eEthDriver

SAM4E Ethernet MAC driver.

Definition at line 86 of file sam4e_eth.c.

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