APM32F4 Ethernet MAC driver. More...

#include "apm32f4xx.h"
#include "apm32f4xx_rcm.h"
#include "apm32f4xx_syscfg.h"
#include "apm32f4xx_gpio.h"
#include "core/net.h"
#include "drivers/mac/apm32f4xx_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	apm32f4xxEthInit (NetInterface *interface)
	APM32F4 Ethernet MAC initialization. More...

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

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

void	apm32f4xxEthTick (NetInterface *interface)
	APM32F4 Ethernet MAC timer handler. More...

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

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

void	ETH_IRQHandler (void)
	APM32F4 Ethernet MAC interrupt service routine. More...

void	apm32f4xxEthEventHandler (NetInterface *interface)
	APM32F4 Ethernet MAC event handler. More...

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

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

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

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

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

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

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

Variables
const NicDriver	apm32f4xxEthDriver
	APM32F4 Ethernet MAC driver. More...

Detailed Description

APM32F4 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.4

Definition in file apm32f4xx_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file apm32f4xx_eth_driver.c.

Function Documentation

◆ apm32f4xxEthCalcCrc()

uint32_t apm32f4xxEthCalcCrc	(	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 906 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthDisableIrq()

void apm32f4xxEthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 419 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthEnableIrq()

void apm32f4xxEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 391 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthEventHandler()

void apm32f4xxEthEventHandler ( NetInterface * interface )

APM32F4 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 499 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthInit()

error_t apm32f4xxEthInit ( NetInterface * interface )

APM32F4 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 117 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthInitDmaDesc()

void apm32f4xxEthInitDmaDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 297 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthInitGpio()

__weak_func void apm32f4xxEthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 242 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthReadPhyReg()

uint16_t apm32f4xxEthReadPhyReg	(	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 860 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthReceivePacket()

error_t apm32f4xxEthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 583 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthSendPacket()

error_t apm32f4xxEthSendPacket	(	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 524 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthTick()

void apm32f4xxEthTick ( NetInterface * interface )

APM32F4 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 366 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthUpdateMacAddrFilter()

error_t apm32f4xxEthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 653 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthUpdateMacConfig()

error_t apm32f4xxEthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 775 of file apm32f4xx_eth_driver.c.

◆ apm32f4xxEthWritePhyReg()

void apm32f4xxEthWritePhyReg	(	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 818 of file apm32f4xx_eth_driver.c.

◆ ETH_IRQHandler()

void ETH_IRQHandler ( void )

APM32F4 Ethernet MAC interrupt service routine.

Definition at line 446 of file apm32f4xx_eth_driver.c.

Variable Documentation

◆ apm32f4xxEthDriver

const NicDriver apm32f4xxEthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   apm32f4xxEthInit,
   apm32f4xxEthTick,
   apm32f4xxEthEnableIrq,
   apm32f4xxEthDisableIrq,
   apm32f4xxEthEventHandler,
   apm32f4xxEthSendPacket,
   apm32f4xxEthUpdateMacAddrFilter,
   apm32f4xxEthUpdateMacConfig,
   apm32f4xxEthWritePhyReg,
   apm32f4xxEthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

APM32F4 Ethernet MAC driver.

Definition at line 90 of file apm32f4xx_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ apm32f4xxEthCalcCrc()

◆ apm32f4xxEthDisableIrq()

◆ apm32f4xxEthEnableIrq()

◆ apm32f4xxEthEventHandler()

◆ apm32f4xxEthInit()

◆ apm32f4xxEthInitDmaDesc()

◆ apm32f4xxEthInitGpio()

◆ apm32f4xxEthReadPhyReg()

◆ apm32f4xxEthReceivePacket()

◆ apm32f4xxEthSendPacket()

◆ apm32f4xxEthTick()

◆ apm32f4xxEthUpdateMacAddrFilter()

◆ apm32f4xxEthUpdateMacConfig()

◆ apm32f4xxEthWritePhyReg()

◆ ETH_IRQHandler()

Variable Documentation

◆ apm32f4xxEthDriver