pic32cx_eth_driver.h File Reference

PIC32CX SG41/SG60/SG61 Ethernet MAC driver. More...

Go to the source code of this file.

Data Structures
struct	Pic32cxTxBufferDesc
	Transmit buffer descriptor. More...
struct	Pic32cxRxBufferDesc
	Receive buffer descriptor. More...

Macros
#define	PIC32CX_ETH_TX_BUFFER_COUNT   3
#define	PIC32CX_ETH_TX_BUFFER_SIZE   1536
#define	PIC32CX_ETH_RX_BUFFER_COUNT   72
#define	PIC32CX_ETH_RX_BUFFER_SIZE   128
#define	PIC32CX_ETH_IRQ_PRIORITY_GROUPING   4
#define	PIC32CX_ETH_IRQ_GROUP_PRIORITY   6
#define	PIC32CX_ETH_IRQ_SUB_PRIORITY   0
#define	GMAC_TX_USED   0x80000000
#define	GMAC_TX_WRAP   0x40000000
#define	GMAC_TX_RLE_ERROR   0x20000000
#define	GMAC_TX_UNDERRUN_ERROR   0x10000000
#define	GMAC_TX_AHB_ERROR   0x08000000
#define	GMAC_TX_LATE_COL_ERROR   0x04000000
#define	GMAC_TX_CHECKSUM_ERROR   0x00700000
#define	GMAC_TX_NO_CRC   0x00010000
#define	GMAC_TX_LAST   0x00008000
#define	GMAC_TX_LENGTH   0x00003FFF
#define	GMAC_RX_ADDRESS   0xFFFFFFFC
#define	GMAC_RX_WRAP   0x00000002
#define	GMAC_RX_OWNERSHIP   0x00000001
#define	GMAC_RX_BROADCAST   0x80000000
#define	GMAC_RX_MULTICAST_HASH   0x40000000
#define	GMAC_RX_UNICAST_HASH   0x20000000
#define	GMAC_RX_SAR   0x08000000
#define	GMAC_RX_SAR_MASK   0x06000000
#define	GMAC_RX_TYPE_ID   0x01000000
#define	GMAC_RX_SNAP   0x01000000
#define	GMAC_RX_TYPE_ID_MASK   0x00C00000
#define	GMAC_RX_CHECKSUM_VALID   0x00C00000
#define	GMAC_RX_VLAN_TAG   0x00200000
#define	GMAC_RX_PRIORITY_TAG   0x00100000
#define	GMAC_RX_VLAN_PRIORITY   0x000E0000
#define	GMAC_RX_CFI   0x00010000
#define	GMAC_RX_EOF   0x00008000
#define	GMAC_RX_SOF   0x00004000
#define	GMAC_RX_LENGTH_MSB   0x00002000
#define	GMAC_RX_BAD_FCS   0x00002000
#define	GMAC_RX_LENGTH   0x00001FFF

Functions
error_t	pic32cxEthInit (NetInterface *interface)
	PIC32CX Ethernet MAC initialization. More...
void	pic32cxEthInitGpio (NetInterface *interface)
	GPIO configuration. More...
void	pic32cxEthInitBufferDesc (NetInterface *interface)
	Initialize buffer descriptors. More...
void	pic32cxEthTick (NetInterface *interface)
	PIC32CX Ethernet MAC timer handler. More...
void	pic32cxEthEnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	pic32cxEthDisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	pic32cxEthEventHandler (NetInterface *interface)
	PIC32CX Ethernet MAC event handler. More...
error_t	pic32cxEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	pic32cxEthReceivePacket (NetInterface *interface)
	Receive a packet. More...
error_t	pic32cxEthUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...
error_t	pic32cxEthUpdateMacConfig (NetInterface *interface)
	Adjust MAC configuration parameters for proper operation. More...
void	pic32cxEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
	Write PHY register. More...
uint16_t	pic32cxEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
	Read PHY register. More...

Variables
const NicDriver	pic32cxEthDriver
	PIC32CX Ethernet MAC driver. More...

Detailed Description

PIC32CX SG41/SG60/SG61 Ethernet MAC driver.

License

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

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

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 pic32cx_eth_driver.h.

Macro Definition Documentation

GMAC_RX_ADDRESS

#define GMAC_RX_ADDRESS   0xFFFFFFFC

Definition at line 96 of file pic32cx_eth_driver.h.

GMAC_RX_BAD_FCS

#define GMAC_RX_BAD_FCS   0x00002000

Definition at line 115 of file pic32cx_eth_driver.h.

GMAC_RX_BROADCAST

#define GMAC_RX_BROADCAST   0x80000000

Definition at line 99 of file pic32cx_eth_driver.h.

GMAC_RX_CFI

#define GMAC_RX_CFI   0x00010000

Definition at line 111 of file pic32cx_eth_driver.h.

GMAC_RX_CHECKSUM_VALID

#define GMAC_RX_CHECKSUM_VALID   0x00C00000

Definition at line 107 of file pic32cx_eth_driver.h.

GMAC_RX_EOF

#define GMAC_RX_EOF   0x00008000

Definition at line 112 of file pic32cx_eth_driver.h.

GMAC_RX_LENGTH

#define GMAC_RX_LENGTH   0x00001FFF

Definition at line 116 of file pic32cx_eth_driver.h.

GMAC_RX_LENGTH_MSB

#define GMAC_RX_LENGTH_MSB   0x00002000

Definition at line 114 of file pic32cx_eth_driver.h.

GMAC_RX_MULTICAST_HASH

#define GMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 100 of file pic32cx_eth_driver.h.

GMAC_RX_OWNERSHIP

#define GMAC_RX_OWNERSHIP   0x00000001

Definition at line 98 of file pic32cx_eth_driver.h.

GMAC_RX_PRIORITY_TAG

#define GMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 109 of file pic32cx_eth_driver.h.

GMAC_RX_SAR

#define GMAC_RX_SAR   0x08000000

Definition at line 102 of file pic32cx_eth_driver.h.

GMAC_RX_SAR_MASK

#define GMAC_RX_SAR_MASK   0x06000000

Definition at line 103 of file pic32cx_eth_driver.h.

GMAC_RX_SNAP

#define GMAC_RX_SNAP   0x01000000

Definition at line 105 of file pic32cx_eth_driver.h.

GMAC_RX_SOF

#define GMAC_RX_SOF   0x00004000

Definition at line 113 of file pic32cx_eth_driver.h.

GMAC_RX_TYPE_ID

#define GMAC_RX_TYPE_ID   0x01000000

Definition at line 104 of file pic32cx_eth_driver.h.

GMAC_RX_TYPE_ID_MASK

#define GMAC_RX_TYPE_ID_MASK   0x00C00000

Definition at line 106 of file pic32cx_eth_driver.h.

GMAC_RX_UNICAST_HASH

#define GMAC_RX_UNICAST_HASH   0x20000000

Definition at line 101 of file pic32cx_eth_driver.h.

GMAC_RX_VLAN_PRIORITY

#define GMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 110 of file pic32cx_eth_driver.h.

GMAC_RX_VLAN_TAG

#define GMAC_RX_VLAN_TAG   0x00200000

Definition at line 108 of file pic32cx_eth_driver.h.

GMAC_RX_WRAP

#define GMAC_RX_WRAP   0x00000002

Definition at line 97 of file pic32cx_eth_driver.h.

GMAC_TX_AHB_ERROR

#define GMAC_TX_AHB_ERROR   0x08000000

Definition at line 88 of file pic32cx_eth_driver.h.

GMAC_TX_CHECKSUM_ERROR

#define GMAC_TX_CHECKSUM_ERROR   0x00700000

Definition at line 90 of file pic32cx_eth_driver.h.

GMAC_TX_LAST

#define GMAC_TX_LAST   0x00008000

Definition at line 92 of file pic32cx_eth_driver.h.

GMAC_TX_LATE_COL_ERROR

#define GMAC_TX_LATE_COL_ERROR   0x04000000

Definition at line 89 of file pic32cx_eth_driver.h.

GMAC_TX_LENGTH

#define GMAC_TX_LENGTH   0x00003FFF

Definition at line 93 of file pic32cx_eth_driver.h.

GMAC_TX_NO_CRC

#define GMAC_TX_NO_CRC   0x00010000

Definition at line 91 of file pic32cx_eth_driver.h.

GMAC_TX_RLE_ERROR

#define GMAC_TX_RLE_ERROR   0x20000000

Definition at line 86 of file pic32cx_eth_driver.h.

GMAC_TX_UNDERRUN_ERROR

#define GMAC_TX_UNDERRUN_ERROR   0x10000000

Definition at line 87 of file pic32cx_eth_driver.h.

GMAC_TX_USED

#define GMAC_TX_USED   0x80000000

Definition at line 84 of file pic32cx_eth_driver.h.

GMAC_TX_WRAP

#define GMAC_TX_WRAP   0x40000000

Definition at line 85 of file pic32cx_eth_driver.h.

PIC32CX_ETH_IRQ_GROUP_PRIORITY

#define PIC32CX_ETH_IRQ_GROUP_PRIORITY   6

Definition at line 71 of file pic32cx_eth_driver.h.

PIC32CX_ETH_IRQ_PRIORITY_GROUPING

#define PIC32CX_ETH_IRQ_PRIORITY_GROUPING   4

Definition at line 64 of file pic32cx_eth_driver.h.

PIC32CX_ETH_IRQ_SUB_PRIORITY

#define PIC32CX_ETH_IRQ_SUB_PRIORITY   0

Definition at line 78 of file pic32cx_eth_driver.h.

PIC32CX_ETH_RX_BUFFER_COUNT

#define PIC32CX_ETH_RX_BUFFER_COUNT   72

Definition at line 50 of file pic32cx_eth_driver.h.

PIC32CX_ETH_RX_BUFFER_SIZE

#define PIC32CX_ETH_RX_BUFFER_SIZE   128

Definition at line 57 of file pic32cx_eth_driver.h.

PIC32CX_ETH_TX_BUFFER_COUNT

#define PIC32CX_ETH_TX_BUFFER_COUNT   3

Definition at line 36 of file pic32cx_eth_driver.h.

PIC32CX_ETH_TX_BUFFER_SIZE

#define PIC32CX_ETH_TX_BUFFER_SIZE   1536

Definition at line 43 of file pic32cx_eth_driver.h.

Function Documentation

pic32cxEthDisableIrq()

void pic32cxEthDisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 416 of file pic32cx_eth_driver.c.

pic32cxEthEnableIrq()

void pic32cxEthEnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 388 of file pic32cx_eth_driver.c.

pic32cxEthEventHandler()

void pic32cxEthEventHandler

(

NetInterface *

interface

)

PIC32CX Ethernet MAC event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 499 of file pic32cx_eth_driver.c.

pic32cxEthInit()

error_t pic32cxEthInit

(

NetInterface *

interface

)

PIC32CX Ethernet MAC initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 115 of file pic32cx_eth_driver.c.

pic32cxEthInitBufferDesc()

void pic32cxEthInitBufferDesc

(

NetInterface *

interface

)

Initialize buffer descriptors.

Parameters

[in]

interface

Underlying network interface

Definition at line 310 of file pic32cx_eth_driver.c.

pic32cxEthInitGpio()

void pic32cxEthInitGpio

(

NetInterface *

interface

)

GPIO configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 227 of file pic32cx_eth_driver.c.

pic32cxEthReadPhyReg()

uint16_t pic32cxEthReadPhyReg	(	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 946 of file pic32cx_eth_driver.c.

pic32cxEthReceivePacket()

error_t pic32cxEthReceivePacket

(

NetInterface *

interface

)

Receive a packet.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 606 of file pic32cx_eth_driver.c.

pic32cxEthSendPacket()

error_t pic32cxEthSendPacket	(	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 536 of file pic32cx_eth_driver.c.

pic32cxEthTick()

void pic32cxEthTick

(

NetInterface *

interface

)

PIC32CX 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 363 of file pic32cx_eth_driver.c.

pic32cxEthUpdateMacAddrFilter()

error_t pic32cxEthUpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 738 of file pic32cx_eth_driver.c.

pic32cxEthUpdateMacConfig()

error_t pic32cxEthUpdateMacConfig

(

NetInterface *

interface

)

Adjust MAC configuration parameters for proper operation.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 864 of file pic32cx_eth_driver.c.

pic32cxEthWritePhyReg()

void pic32cxEthWritePhyReg	(	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 907 of file pic32cx_eth_driver.c.

Variable Documentation

pic32cxEthDriver

const NicDriver pic32cxEthDriver

extern

PIC32CX Ethernet MAC driver.

Definition at line 88 of file pic32cx_eth_driver.c.