PIC32CK GC01/SG01 Ethernet MAC driver. More...

#include <limits.h>
#include "pic32c.h"
#include "core/net.h"
#include "drivers/mac/pic32ck_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

Functions
error_t	pic32ckEthInit (NetInterface *interface)
	PIC32CK Ethernet MAC initialization. More...

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

void	pic32ckEthInitBufferDesc (NetInterface *interface)
	Initialize buffer descriptors. More...

void	pic32ckEthTick (NetInterface *interface)
	PIC32CK Ethernet MAC timer handler. More...

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

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

void	ETH_Handler (void)
	PIC32CK Ethernet MAC interrupt service routine. More...

void	pic32ckEthEventHandler (NetInterface *interface)
	PIC32CK Ethernet MAC event handler. More...

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

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

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

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

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

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

Variables
const NicDriver	pic32ckEthDriver
	PIC32CK Ethernet MAC driver. More...

Detailed Description

PIC32CK GC01/SG01 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.5.4

Definition in file pic32ck_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file pic32ck_eth_driver.c.

Function Documentation

◆ ETH_Handler()

void ETH_Handler ( void )

PIC32CK Ethernet MAC interrupt service routine.

Definition at line 466 of file pic32ck_eth_driver.c.

◆ pic32ckEthDisableIrq()

void pic32ckEthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 439 of file pic32ck_eth_driver.c.

◆ pic32ckEthEnableIrq()

void pic32ckEthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 411 of file pic32ck_eth_driver.c.

◆ pic32ckEthEventHandler()

void pic32ckEthEventHandler ( NetInterface * interface )

PIC32CK Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 524 of file pic32ck_eth_driver.c.

◆ pic32ckEthInit()

error_t pic32ckEthInit ( NetInterface * interface )

PIC32CK Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 115 of file pic32ck_eth_driver.c.

◆ pic32ckEthInitBufferDesc()

void pic32ckEthInitBufferDesc ( NetInterface * interface )

Initialize buffer descriptors.

Parameters

[in] interface Underlying network interface

Definition at line 333 of file pic32ck_eth_driver.c.

◆ pic32ckEthInitGpio()

__weak_func void pic32ckEthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 253 of file pic32ck_eth_driver.c.

◆ pic32ckEthReadPhyReg()

uint16_t pic32ckEthReadPhyReg	(	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 971 of file pic32ck_eth_driver.c.

◆ pic32ckEthReceivePacket()

error_t pic32ckEthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 631 of file pic32ck_eth_driver.c.

◆ pic32ckEthSendPacket()

error_t pic32ckEthSendPacket	(	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 pic32ck_eth_driver.c.

◆ pic32ckEthTick()

void pic32ckEthTick ( NetInterface * interface )

PIC32CK 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 386 of file pic32ck_eth_driver.c.

◆ pic32ckEthUpdateMacAddrFilter()

error_t pic32ckEthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 763 of file pic32ck_eth_driver.c.

◆ pic32ckEthUpdateMacConfig()

error_t pic32ckEthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 889 of file pic32ck_eth_driver.c.

◆ pic32ckEthWritePhyReg()

void pic32ckEthWritePhyReg	(	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 932 of file pic32ck_eth_driver.c.

Variable Documentation

◆ pic32ckEthDriver

const NicDriver pic32ckEthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   pic32ckEthInit,
   pic32ckEthTick,
   pic32ckEthEnableIrq,
   pic32ckEthDisableIrq,
   pic32ckEthEventHandler,
   pic32ckEthSendPacket,
   pic32ckEthUpdateMacAddrFilter,
   pic32ckEthUpdateMacConfig,
   pic32ckEthWritePhyReg,
   pic32ckEthReadPhyReg,
   TRUE,
   TRUE,
   TRUE,
   FALSE
}

PIC32CK Ethernet MAC driver.

Definition at line 88 of file pic32ck_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ETH_Handler()

◆ pic32ckEthDisableIrq()

◆ pic32ckEthEnableIrq()

◆ pic32ckEthEventHandler()

◆ pic32ckEthInit()

◆ pic32ckEthInitBufferDesc()

◆ pic32ckEthInitGpio()

◆ pic32ckEthReadPhyReg()

◆ pic32ckEthReceivePacket()

◆ pic32ckEthSendPacket()

◆ pic32ckEthTick()

◆ pic32ckEthUpdateMacAddrFilter()

◆ pic32ckEthUpdateMacConfig()

◆ pic32ckEthWritePhyReg()

Variable Documentation

◆ pic32ckEthDriver