PIC32MZ Ethernet MAC driver. More...
#include "core/nic.h"Go to the source code of this file.
Data Structures | |
| struct | Pic32mzTxBufferDesc |
| TX buffer descriptor. More... | |
| struct | Pic32mzRxBufferDesc |
| RX buffer descriptor. More... | |
Functions | |
| error_t | pic32mzEthInit (NetInterface *interface) |
| PIC32MZ Ethernet MAC initialization. More... | |
| 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
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.
- Version
- 2.4.0
Definition in file pic32mz_eth_driver.h.
Macro Definition Documentation
◆ _EMAC1MCFG_CLKSEL_DIV10
| #define _EMAC1MCFG_CLKSEL_DIV10 (4 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 83 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV14
| #define _EMAC1MCFG_CLKSEL_DIV14 (5 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 84 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV20
| #define _EMAC1MCFG_CLKSEL_DIV20 (6 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 85 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV28
| #define _EMAC1MCFG_CLKSEL_DIV28 (7 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 86 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV4
| #define _EMAC1MCFG_CLKSEL_DIV4 (0 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 80 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV40
| #define _EMAC1MCFG_CLKSEL_DIV40 (8 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 87 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV48
| #define _EMAC1MCFG_CLKSEL_DIV48 (9 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 88 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV50
| #define _EMAC1MCFG_CLKSEL_DIV50 (10 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 89 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV6
| #define _EMAC1MCFG_CLKSEL_DIV6 (2 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 81 of file pic32mz_eth_driver.h.
◆ _EMAC1MCFG_CLKSEL_DIV8
| #define _EMAC1MCFG_CLKSEL_DIV8 (3 << _EMAC1MCFG_CLKSEL_POSITION) |
Definition at line 82 of file pic32mz_eth_driver.h.
◆ ETH_RX_CTRL_BYTE_COUNT
| #define ETH_RX_CTRL_BYTE_COUNT 0x07FF0000 |
Definition at line 120 of file pic32mz_eth_driver.h.
◆ ETH_RX_CTRL_EOP
| #define ETH_RX_CTRL_EOP 0x40000000 |
Definition at line 119 of file pic32mz_eth_driver.h.
◆ ETH_RX_CTRL_EOWN
| #define ETH_RX_CTRL_EOWN 0x00000080 |
Definition at line 122 of file pic32mz_eth_driver.h.
◆ ETH_RX_CTRL_NPV
| #define ETH_RX_CTRL_NPV 0x00000100 |
Definition at line 121 of file pic32mz_eth_driver.h.
◆ ETH_RX_CTRL_SOP
| #define ETH_RX_CTRL_SOP 0x80000000 |
Definition at line 118 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_BROADCAST_MATCH
| #define ETH_RX_STATUS1_BROADCAST_MATCH 0x40000000 |
Definition at line 124 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_HASH_TABLE_MATCH
| #define ETH_RX_STATUS1_HASH_TABLE_MATCH 0x04000000 |
Definition at line 128 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_MAGIC_PACKET_MATCH
| #define ETH_RX_STATUS1_MAGIC_PACKET_MATCH 0x08000000 |
Definition at line 127 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_MULTICAST_MATCH
| #define ETH_RX_STATUS1_MULTICAST_MATCH 0x80000000 |
Definition at line 123 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_NOT_MATCH
| #define ETH_RX_STATUS1_NOT_MATCH 0x02000000 |
Definition at line 129 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_PACKET_CHECKSUM
| #define ETH_RX_STATUS1_PACKET_CHECKSUM 0x0000FFFF |
Definition at line 131 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_PATTERN_MATCH
| #define ETH_RX_STATUS1_PATTERN_MATCH 0x10000000 |
Definition at line 126 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_RUNT_PACKET
| #define ETH_RX_STATUS1_RUNT_PACKET 0x01000000 |
Definition at line 130 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS1_UNICAST_MATCH
| #define ETH_RX_STATUS1_UNICAST_MATCH 0x20000000 |
Definition at line 125 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_BROADCAST
| #define ETH_RX_STATUS2_BROADCAST 0x02000000 |
Definition at line 137 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_BYTE_COUNT
| #define ETH_RX_STATUS2_BYTE_COUNT 0x0000FFFF |
Definition at line 147 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_CARRIER_EVENT
| #define ETH_RX_STATUS2_CARRIER_EVENT 0x00040000 |
Definition at line 144 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_CODE_VIOLATION
| #define ETH_RX_STATUS2_CODE_VIOLATION 0x00080000 |
Definition at line 143 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_CONTROL
| #define ETH_RX_STATUS2_CONTROL 0x08000000 |
Definition at line 135 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_CRC_ERROR
| #define ETH_RX_STATUS2_CRC_ERROR 0x00100000 |
Definition at line 142 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_DRIBBLE_NIBBLE
| #define ETH_RX_STATUS2_DRIBBLE_NIBBLE 0x04000000 |
Definition at line 136 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_LEN_CHECK_ERROR
| #define ETH_RX_STATUS2_LEN_CHECK_ERROR 0x00200000 |
Definition at line 141 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_LEN_OUT_OF_RANGE
| #define ETH_RX_STATUS2_LEN_OUT_OF_RANGE 0x00400000 |
Definition at line 140 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_LONG_EVENT
| #define ETH_RX_STATUS2_LONG_EVENT 0x00010000 |
Definition at line 146 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_MULTICAST
| #define ETH_RX_STATUS2_MULTICAST 0x01000000 |
Definition at line 138 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_OK
| #define ETH_RX_STATUS2_OK 0x00800000 |
Definition at line 139 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_PAUSE
| #define ETH_RX_STATUS2_PAUSE 0x10000000 |
Definition at line 134 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_RXDV_EVENT
| #define ETH_RX_STATUS2_RXDV_EVENT 0x00020000 |
Definition at line 145 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_UNKNOWN_OP_CODE
| #define ETH_RX_STATUS2_UNKNOWN_OP_CODE 0x20000000 |
Definition at line 133 of file pic32mz_eth_driver.h.
◆ ETH_RX_STATUS2_VLAN
| #define ETH_RX_STATUS2_VLAN 0x40000000 |
Definition at line 132 of file pic32mz_eth_driver.h.
◆ ETH_TX_CTRL_BYTE_COUNT
| #define ETH_TX_CTRL_BYTE_COUNT 0x07FF0000 |
Definition at line 94 of file pic32mz_eth_driver.h.
◆ ETH_TX_CTRL_EOP
| #define ETH_TX_CTRL_EOP 0x40000000 |
Definition at line 93 of file pic32mz_eth_driver.h.
◆ ETH_TX_CTRL_EOWN
| #define ETH_TX_CTRL_EOWN 0x00000080 |
Definition at line 96 of file pic32mz_eth_driver.h.
◆ ETH_TX_CTRL_NPV
| #define ETH_TX_CTRL_NPV 0x00000100 |
Definition at line 95 of file pic32mz_eth_driver.h.
◆ ETH_TX_CTRL_SOP
| #define ETH_TX_CTRL_SOP 0x80000000 |
Definition at line 92 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS1_BACKPRESSURE
| #define ETH_TX_STATUS1_BACKPRESSURE 0x00040000 |
Definition at line 98 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS1_CONTROL
| #define ETH_TX_STATUS1_CONTROL 0x00010000 |
Definition at line 100 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS1_PAUSE
| #define ETH_TX_STATUS1_PAUSE 0x00020000 |
Definition at line 99 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS1_TOTAL_BYTES
| #define ETH_TX_STATUS1_TOTAL_BYTES 0x0000FFFF |
Definition at line 101 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS1_VLAN
| #define ETH_TX_STATUS1_VLAN 0x00080000 |
Definition at line 97 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_BROADCAST
| #define ETH_TX_STATUS2_BROADCAST 0x02000000 |
Definition at line 108 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_BYTE_COUNT
| #define ETH_TX_STATUS2_BYTE_COUNT 0x0000FFFF |
Definition at line 115 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_COL_COUNT
| #define ETH_TX_STATUS2_COL_COUNT 0x000F0000 |
Definition at line 114 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_CRC_ERROR
| #define ETH_TX_STATUS2_CRC_ERROR 0x00100000 |
Definition at line 113 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_DONE
| #define ETH_TX_STATUS2_DONE 0x00800000 |
Definition at line 110 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_EXCESSIVE_DEFER
| #define ETH_TX_STATUS2_EXCESSIVE_DEFER 0x08000000 |
Definition at line 106 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_GIANT
| #define ETH_TX_STATUS2_GIANT 0x40000000 |
Definition at line 103 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_LATE_COL
| #define ETH_TX_STATUS2_LATE_COL 0x20000000 |
Definition at line 104 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_LEN_CHECK_ERROR
| #define ETH_TX_STATUS2_LEN_CHECK_ERROR 0x00200000 |
Definition at line 112 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_LEN_OUT_OF_RANGE
| #define ETH_TX_STATUS2_LEN_OUT_OF_RANGE 0x00400000 |
Definition at line 111 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_MAX_COL
| #define ETH_TX_STATUS2_MAX_COL 0x10000000 |
Definition at line 105 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_MULTICAST
| #define ETH_TX_STATUS2_MULTICAST 0x01000000 |
Definition at line 109 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_PACKET_DEFER
| #define ETH_TX_STATUS2_PACKET_DEFER 0x04000000 |
Definition at line 107 of file pic32mz_eth_driver.h.
◆ ETH_TX_STATUS2_UNDERRUN
| #define ETH_TX_STATUS2_UNDERRUN 0x80000000 |
Definition at line 102 of file pic32mz_eth_driver.h.
◆ PIC32MZ_ETH_IRQ_PRIORITY
| #define PIC32MZ_ETH_IRQ_PRIORITY 2 |
Definition at line 67 of file pic32mz_eth_driver.h.
◆ PIC32MZ_ETH_IRQ_SUB_PRIORITY
| #define PIC32MZ_ETH_IRQ_SUB_PRIORITY 0 |
Definition at line 74 of file pic32mz_eth_driver.h.
◆ PIC32MZ_ETH_RX_BUFFER_COUNT
| #define PIC32MZ_ETH_RX_BUFFER_COUNT 6 |
Definition at line 53 of file pic32mz_eth_driver.h.
◆ PIC32MZ_ETH_RX_BUFFER_SIZE
| #define PIC32MZ_ETH_RX_BUFFER_SIZE 1536 |
Definition at line 60 of file pic32mz_eth_driver.h.
◆ PIC32MZ_ETH_TX_BUFFER_COUNT
| #define PIC32MZ_ETH_TX_BUFFER_COUNT 3 |
Definition at line 39 of file pic32mz_eth_driver.h.
◆ PIC32MZ_ETH_TX_BUFFER_SIZE
| #define PIC32MZ_ETH_TX_BUFFER_SIZE 1536 |
Definition at line 46 of file pic32mz_eth_driver.h.
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()
| 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
|
extern |
PIC32MZ Ethernet MAC driver.
Definition at line 67 of file pic32mz_eth_driver.c.