Cypress FM4 Ethernet MAC driver. More...

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

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	fm4EthInit (NetInterface *interface)
	FM4 Ethernet MAC initialization. More...

__weak_func void	fm4EthInitGpio (NetInterface *interface)
	GPIO configuration. 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, NetTxAncillary *ancillary)
	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 driver.

License

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

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: 2.4.0

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

◆ fm4EthCalcCrc()

uint32_t fm4EthCalcCrc	(	const void *	data,
		size_t	length
	)

CRC calculation.

Parameters

[in]	data	Pointer to the data over which to calculate the CRC
[in]	length	Number of bytes to process

Returns: Resulting CRC value

Definition at line 874 of file fm4_eth_driver.c.

◆ fm4EthDisableIrq()

void fm4EthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 456 of file fm4_eth_driver.c.

◆ fm4EthEnableIrq()

void fm4EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 428 of file fm4_eth_driver.c.

◆ fm4EthEventHandler()

void fm4EthEventHandler ( NetInterface * interface )

FM4 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 536 of file fm4_eth_driver.c.

◆ fm4EthInit()

error_t fm4EthInit ( NetInterface * interface )

FM4 Ethernet MAC initialization.

Parameters

[in] interface Underlying 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] interface Underlying network interface

Definition at line 334 of file fm4_eth_driver.c.

◆ fm4EthInitGpio()

__weak_func void fm4EthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 261 of file fm4_eth_driver.c.

◆ fm4EthReadPhyReg()

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

Read PHY register.

Parameters

[in]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register address (5 bits)

Returns: Register value

Definition at line 831 of file fm4_eth_driver.c.

◆ fm4EthReceivePacket()

error_t fm4EthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 620 of file fm4_eth_driver.c.

◆ fm4EthSendPacket()

error_t fm4EthSendPacket	(	NetInterface *	interface,
		const NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Send a packet.

Parameters

[in]	interface	Underlying network interface
[in]	buffer	Multi-part buffer containing the data to send
[in]	offset	Offset to the first data byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 561 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] interface Underlying network interface

Definition at line 403 of file fm4_eth_driver.c.

◆ fm4EthUpdateMacAddrFilter()

error_t fm4EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 690 of file fm4_eth_driver.c.

◆ fm4EthUpdateMacConfig()

error_t fm4EthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 750 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]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register address (5 bits)
[in]	data	Register value

Definition at line 793 of file fm4_eth_driver.c.

Variable Documentation

◆ fm4EthDriver

const NicDriver fm4EthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   fm4EthInit,
   fm4EthTick,
   fm4EthEnableIrq,
   fm4EthDisableIrq,
   fm4EthEventHandler,
   fm4EthSendPacket,
   fm4EthUpdateMacAddrFilter,
   fm4EthUpdateMacConfig,
   fm4EthWritePhyReg,
   fm4EthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

FM4 Ethernet MAC driver.

Definition at line 87 of file fm4_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ETHER0_IRQHandler()

◆ fm4EthCalcCrc()

◆ fm4EthDisableIrq()

◆ fm4EthEnableIrq()

◆ fm4EthEventHandler()

◆ fm4EthInit()

◆ fm4EthInitDmaDesc()

◆ fm4EthInitGpio()

◆ fm4EthReadPhyReg()

◆ fm4EthReceivePacket()

◆ fm4EthSendPacket()

◆ fm4EthTick()

◆ fm4EthUpdateMacAddrFilter()

◆ fm4EthUpdateMacConfig()

◆ fm4EthWritePhyReg()

Variable Documentation

◆ fm4EthDriver