fm4_eth_driver.c File Reference

Cypress FM4 Ethernet MAC controller. More...

#include "mcu.h"
#include "core/net.h"
#include "drivers/mac/fm4_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

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

Variables

const NicDriver fm4EthDriver
 FM4 Ethernet MAC driver. More...
 

Detailed Description

Cypress FM4 Ethernet MAC controller.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2019 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.6

Definition in file fm4_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file fm4_eth_driver.c.

Function Documentation

◆ ETHER0_IRQHandler()

void ETHER0_IRQHandler ( void  )

FM4 Ethernet MAC interrupt service routine.

Definition at line 427 of file fm4_eth_driver.c.

◆ fm4EthCalcCrc()

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 800 of file fm4_eth_driver.c.

◆ fm4EthDisableIrq()

void fm4EthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 414 of file fm4_eth_driver.c.

◆ fm4EthEnableIrq()

void fm4EthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 400 of file fm4_eth_driver.c.

◆ fm4EthEventHandler()

void fm4EthEventHandler ( NetInterface interface)

FM4 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 476 of file fm4_eth_driver.c.

◆ fm4EthInit()

error_t fm4EthInit ( NetInterface interface)

FM4 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 114 of file fm4_eth_driver.c.

◆ fm4EthInitDmaDesc()

void fm4EthInitDmaDesc ( NetInterface interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 319 of file fm4_eth_driver.c.

◆ fm4EthReadPhyReg()

uint16_t fm4EthReadPhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

Parameters
[in]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
Returns
Register value

Definition at line 757 of file fm4_eth_driver.c.

◆ fm4EthReceivePacket()

error_t fm4EthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 568 of file fm4_eth_driver.c.

◆ fm4EthSendPacket()

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 511 of file fm4_eth_driver.c.

◆ fm4EthTick()

void fm4EthTick ( NetInterface interface)

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 388 of file fm4_eth_driver.c.

◆ fm4EthUpdateMacAddrFilter()

error_t fm4EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 632 of file fm4_eth_driver.c.

◆ fm4EthUpdateMacConfig()

error_t fm4EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 692 of file fm4_eth_driver.c.

◆ fm4EthWritePhyReg()

void fm4EthWritePhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 
)

Write PHY register.

Parameters
[in]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
[in]dataRegister value

Definition at line 719 of file fm4_eth_driver.c.

Variable Documentation

◆ fm4EthDriver

error_t fm4EthInit(NetInterface *interface)
FM4 Ethernet MAC initialization.
uint16_t fm4EthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
error_t fm4EthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
void fm4EthTick(NetInterface *interface)
FM4 Ethernet MAC timer handler.
error_t fm4EthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
#define TRUE
Definition: os_port.h:50
void fm4EthEnableIrq(NetInterface *interface)
Enable interrupts.
#define FALSE
Definition: os_port.h:46
void fm4EthEventHandler(NetInterface *interface)
FM4 Ethernet MAC event handler.
void fm4EthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
error_t fm4EthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
#define ETH_MTU
Definition: ethernet.h:91
void fm4EthDisableIrq(NetInterface *interface)
Disable interrupts.
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:79