Cypress FM3 Ethernet MAC driver (ETHER1 instance) More...

#include "mb9bd10t.h"
#include "core/net.h"
#include "drivers/mac/fm3_eth2_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	fm3Eth2Init (NetInterface *interface)
	FM3 Ethernet MAC initialization. More...

__weak_func void	fm3Eth2InitGpio (NetInterface *interface)
	GPIO configuration. More...

void	fm3Eth2InitDmaDesc (NetInterface *interface)
	Initialize DMA descriptor lists. More...

void	fm3Eth2Tick (NetInterface *interface)
	FM3 Ethernet MAC timer handler. More...

void	fm3Eth2EnableIrq (NetInterface *interface)
	Enable interrupts. More...

void	fm3Eth2DisableIrq (NetInterface *interface)
	Disable interrupts. More...

void	ETHER1_CAN1_IRQHandler (void)
	FM3 Ethernet MAC interrupt service routine. More...

void	fm3Eth2EventHandler (NetInterface *interface)
	FM3 Ethernet MAC event handler. More...

error_t	fm3Eth2SendPacket (NetInterface interface, const NetBuffer buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...

error_t	fm3Eth2ReceivePacket (NetInterface *interface)
	Receive a packet. More...

error_t	fm3Eth2UpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...

error_t	fm3Eth2UpdateMacConfig (NetInterface *interface)
	Adjust MAC configuration parameters for proper operation. More...

void	fm3Eth2WritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
	Write PHY register. More...

uint16_t	fm3Eth2ReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
	Read PHY register. More...

uint32_t	fm3Eth2CalcCrc (const void *data, size_t length)
	CRC calculation. More...

Variables
const NicDriver	fm3Eth2Driver
	FM3 Ethernet MAC driver (ETHER1 instance) More...

Detailed Description

Cypress FM3 Ethernet MAC driver (ETHER1 instance)

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 fm3_eth2_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file fm3_eth2_driver.c.

Function Documentation

◆ ETHER1_CAN1_IRQHandler()

void ETHER1_CAN1_IRQHandler ( void )

FM3 Ethernet MAC interrupt service routine.

Definition at line 462 of file fm3_eth2_driver.c.

◆ fm3Eth2CalcCrc()

uint32_t fm3Eth2CalcCrc	(	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 853 of file fm3_eth2_driver.c.

◆ fm3Eth2DisableIrq()

void fm3Eth2DisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 435 of file fm3_eth2_driver.c.

◆ fm3Eth2EnableIrq()

void fm3Eth2EnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 407 of file fm3_eth2_driver.c.

◆ fm3Eth2EventHandler()

void fm3Eth2EventHandler ( NetInterface * interface )

FM3 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 515 of file fm3_eth2_driver.c.

◆ fm3Eth2Init()

error_t fm3Eth2Init ( NetInterface * interface )

FM3 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 114 of file fm3_eth2_driver.c.

◆ fm3Eth2InitDmaDesc()

void fm3Eth2InitDmaDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 313 of file fm3_eth2_driver.c.

◆ fm3Eth2InitGpio()

__weak_func void fm3Eth2InitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 261 of file fm3_eth2_driver.c.

◆ fm3Eth2ReadPhyReg()

uint16_t fm3Eth2ReadPhyReg	(	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 810 of file fm3_eth2_driver.c.

◆ fm3Eth2ReceivePacket()

error_t fm3Eth2ReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 599 of file fm3_eth2_driver.c.

◆ fm3Eth2SendPacket()

error_t fm3Eth2SendPacket	(	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 540 of file fm3_eth2_driver.c.

◆ fm3Eth2Tick()

void fm3Eth2Tick ( NetInterface * interface )

FM3 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 382 of file fm3_eth2_driver.c.

◆ fm3Eth2UpdateMacAddrFilter()

error_t fm3Eth2UpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 669 of file fm3_eth2_driver.c.

◆ fm3Eth2UpdateMacConfig()

error_t fm3Eth2UpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 729 of file fm3_eth2_driver.c.

◆ fm3Eth2WritePhyReg()

void fm3Eth2WritePhyReg	(	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 772 of file fm3_eth2_driver.c.

Variable Documentation

◆ fm3Eth2Driver

const NicDriver fm3Eth2Driver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   fm3Eth2Init,
   fm3Eth2Tick,
   fm3Eth2EnableIrq,
   fm3Eth2DisableIrq,
   fm3Eth2EventHandler,
   fm3Eth2SendPacket,
   fm3Eth2UpdateMacAddrFilter,
   fm3Eth2UpdateMacConfig,
   fm3Eth2WritePhyReg,
   fm3Eth2ReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

FM3 Ethernet MAC driver (ETHER1 instance)

Definition at line 87 of file fm3_eth2_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ETHER1_CAN1_IRQHandler()

◆ fm3Eth2CalcCrc()

◆ fm3Eth2DisableIrq()

◆ fm3Eth2EnableIrq()

◆ fm3Eth2EventHandler()

◆ fm3Eth2Init()

◆ fm3Eth2InitDmaDesc()

◆ fm3Eth2InitGpio()

◆ fm3Eth2ReadPhyReg()

◆ fm3Eth2ReceivePacket()

◆ fm3Eth2SendPacket()

◆ fm3Eth2Tick()

◆ fm3Eth2UpdateMacAddrFilter()

◆ fm3Eth2UpdateMacConfig()

◆ fm3Eth2WritePhyReg()

Variable Documentation

◆ fm3Eth2Driver