Sergey Pastor / 1

Webserver+3d print

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

fm4_eth.h File Reference
Data Structures | Functions | Variables

fm4_eth.h File Reference

Spansion FM4 Ethernet MAC controller. More...

Go to the source code of this file.

Data Structures

struct  Fm4TxDmaDesc
 Enhanced TX DMA descriptor. More...
struct  Fm4RxDmaDesc
 Enhanced RX DMA descriptor. More...

Functions

error_t fm4EthInit (NetInterface *interface)
 Spansion FM4 Ethernet MAC initialization.
void fm4EthInitGpio (NetInterface *interface)
 GPIO configuration.
void fm4EthInitDmaDesc (NetInterface *interface)
 Initialize DMA descriptor lists.
void fm4EthTick (NetInterface *interface)
 Spansion FM4 Ethernet MAC timer handler.
void fm4EthEnableIrq (NetInterface *interface)
 Enable interrupts.
void fm4EthDisableIrq (NetInterface *interface)
 Disable interrupts.
void fm4EthEventHandler (NetInterface *interface)
 Spansion FM4 Ethernet MAC event handler.
error_t fm4EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet.
error_t fm4EthReceivePacket (NetInterface *interface)
 Receive a packet.
error_t fm4EthSetMulticastFilter (NetInterface *interface)
 Configure multicast MAC address filtering.
error_t fm4EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation.
void fm4EthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register.
uint16_t fm4EthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register.
uint32_t fm4EthCalcCrc (const void *data, size_t length)
 CRC calculation.

Variables

const NicDriver fm4EthDriver
 Spansion FM4 Ethernet MAC driver.

Detailed Description

Spansion FM4 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 fm4_eth.h.

Function Documentation

uint32_t fm4EthCalcCrc ( 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 762 of file fm4_eth.c.

void fm4EthDisableIrq ( NetInterface *  interface )

Disable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 410 of file fm4_eth.c.

void fm4EthEnableIrq ( NetInterface *  interface )

Enable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 396 of file fm4_eth.c.

void fm4EthEventHandler ( NetInterface *  interface )

Spansion FM4 Ethernet MAC event handler.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 472 of file fm4_eth.c.

error_t fm4EthInit ( NetInterface *  interface )

Spansion FM4 Ethernet MAC initialization.

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

Definition at line 112 of file fm4_eth.c.

void fm4EthInitDmaDesc ( NetInterface *  interface )

Initialize DMA descriptor lists.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 315 of file fm4_eth.c.

void fm4EthInitGpio ( NetInterface *  interface )

GPIO configuration.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 241 of file fm4_eth.c.

uint16_t fm4EthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

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

Definition at line 736 of file fm4_eth.c.

error_t fm4EthReceivePacket ( NetInterface *  interface )

Receive a packet.

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

Definition at line 564 of file fm4_eth.c.

error_t fm4EthSendPacket ( 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 507 of file fm4_eth.c.

error_t fm4EthSetMulticastFilter ( NetInterface *  interface )

Configure multicast MAC address filtering.

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

Definition at line 628 of file fm4_eth.c.

void fm4EthTick ( NetInterface *  interface )

Spansion FM4 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 384 of file fm4_eth.c.

error_t fm4EthUpdateMacConfig ( NetInterface *  interface )

Adjust MAC configuration parameters for proper operation.

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

Definition at line 684 of file fm4_eth.c.

void fm4EthWritePhyReg ( 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 710 of file fm4_eth.c.

Variable Documentation

const NicDriver fm4EthDriver

Spansion FM4 Ethernet MAC driver.

Definition at line 85 of file fm4_eth.c.

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