PIC32MZ Ethernet MAC driver. More...

#include <p32xxxx.h>
#include <sys/kmem.h>
#include "core/net.h"
#include "drivers/mac/pic32mz_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	pic32mzEthInit (NetInterface *interface)
	PIC32MZ Ethernet MAC initialization. More...

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

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

void	pic32mzEthTick (NetInterface *interface)
	PIC32MZ Ethernet MAC timer handler. More...

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

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

void	pic32mzEthIrqHandler (void)
	PIC32MZ Ethernet MAC interrupt service routine. More...

void	pic32mzEthEventHandler (NetInterface *interface)
	PIC32MZ Ethernet MAC event handler. More...

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

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

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

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

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

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

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

Variables
const NicDriver	pic32mzEthDriver
	PIC32MZ Ethernet MAC driver. More...

Detailed Description

PIC32MZ 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 pic32mz_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file pic32mz_eth_driver.c.

Function Documentation

◆ pic32mzEthCalcCrc()

uint32_t pic32mzEthCalcCrc	(	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 903 of file pic32mz_eth_driver.c.

◆ pic32mzEthDisableIrq()

void pic32mzEthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 477 of file pic32mz_eth_driver.c.

◆ pic32mzEthEnableIrq()

void pic32mzEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 449 of file pic32mz_eth_driver.c.

◆ pic32mzEthEventHandler()

void pic32mzEthEventHandler ( NetInterface * interface )

PIC32MZ Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 557 of file pic32mz_eth_driver.c.

◆ pic32mzEthInit()

error_t pic32mzEthInit ( NetInterface * interface )

PIC32MZ Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 94 of file pic32mz_eth_driver.c.

◆ pic32mzEthInitBufferDesc()

void pic32mzEthInitBufferDesc ( NetInterface * interface )

Initialize DMA descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 358 of file pic32mz_eth_driver.c.

◆ pic32mzEthInitGpio()

__weak_func void pic32mzEthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 230 of file pic32mz_eth_driver.c.

◆ pic32mzEthIrqHandler()

void pic32mzEthIrqHandler ( void )

PIC32MZ Ethernet MAC interrupt service routine.

Definition at line 504 of file pic32mz_eth_driver.c.

◆ pic32mzEthReadPhyReg()

uint16_t pic32mzEthReadPhyReg	(	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 855 of file pic32mz_eth_driver.c.

◆ pic32mzEthReceivePacket()

error_t pic32mzEthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 647 of file pic32mz_eth_driver.c.

◆ pic32mzEthSendPacket()

error_t pic32mzEthSendPacket	(	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 589 of file pic32mz_eth_driver.c.

◆ pic32mzEthTick()

void pic32mzEthTick ( NetInterface * interface )

PIC32MZ 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 424 of file pic32mz_eth_driver.c.

◆ pic32mzEthUpdateMacAddrFilter()

error_t pic32mzEthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 720 of file pic32mz_eth_driver.c.

◆ pic32mzEthUpdateMacConfig()

error_t pic32mzEthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 773 of file pic32mz_eth_driver.c.

◆ pic32mzEthWritePhyReg()

void pic32mzEthWritePhyReg	(	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 816 of file pic32mz_eth_driver.c.

Variable Documentation

◆ pic32mzEthDriver

const NicDriver pic32mzEthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   pic32mzEthInit,
   pic32mzEthTick,
   pic32mzEthEnableIrq,
   pic32mzEthDisableIrq,
   pic32mzEthEventHandler,
   pic32mzEthSendPacket,
   pic32mzEthUpdateMacAddrFilter,
   pic32mzEthUpdateMacConfig,
   pic32mzEthWritePhyReg,
   pic32mzEthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

PIC32MZ Ethernet MAC driver.

Definition at line 67 of file pic32mz_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ pic32mzEthCalcCrc()

◆ pic32mzEthDisableIrq()

◆ pic32mzEthEnableIrq()

◆ pic32mzEthEventHandler()

◆ pic32mzEthInit()

◆ pic32mzEthInitBufferDesc()

◆ pic32mzEthInitGpio()

◆ pic32mzEthIrqHandler()

◆ pic32mzEthReadPhyReg()

◆ pic32mzEthReceivePacket()

◆ pic32mzEthSendPacket()

◆ pic32mzEthTick()

◆ pic32mzEthUpdateMacAddrFilter()

◆ pic32mzEthUpdateMacConfig()

◆ pic32mzEthWritePhyReg()

Variable Documentation

◆ pic32mzEthDriver