pic32mx_eth_driver.c File Reference

PIC32MX Ethernet MAC driver. More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t pic32mxEthInit (NetInterface *interface)
 PIC32MX Ethernet MAC initialization. More...
 
__weak_func void pic32mxEthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void pic32mxEthInitBufferDesc (NetInterface *interface)
 Initialize DMA descriptor lists. More...
 
void pic32mxEthTick (NetInterface *interface)
 PIC32MX Ethernet MAC timer handler. More...
 
void pic32mxEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void pic32mxEthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void pic32mxEthIrqHandler (void)
 PIC32MX Ethernet MAC interrupt service routine. More...
 
void pic32mxEthEventHandler (NetInterface *interface)
 PIC32MX Ethernet MAC event handler. More...
 
error_t pic32mxEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t pic32mxEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t pic32mxEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t pic32mxEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void pic32mxEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t pic32mxEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
uint32_t pic32mxEthCalcCrc (const void *data, size_t length)
 CRC calculation. More...
 

Variables

const NicDriver pic32mxEthDriver
 PIC32MX Ethernet MAC driver. More...
 

Detailed Description

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

Definition in file pic32mx_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file pic32mx_eth_driver.c.

Function Documentation

◆ pic32mxEthCalcCrc()

uint32_t pic32mxEthCalcCrc ( const void *  data,
size_t  length 
)

CRC calculation.

Parameters
[in]dataPointer to the data over which to calculate the CRC
[in]lengthNumber of bytes to process
Returns
Resulting CRC value

Definition at line 780 of file pic32mx_eth_driver.c.

◆ pic32mxEthDisableIrq()

void pic32mxEthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 359 of file pic32mx_eth_driver.c.

◆ pic32mxEthEnableIrq()

void pic32mxEthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 331 of file pic32mx_eth_driver.c.

◆ pic32mxEthEventHandler()

void pic32mxEthEventHandler ( NetInterface interface)

PIC32MX Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 439 of file pic32mx_eth_driver.c.

◆ pic32mxEthInit()

error_t pic32mxEthInit ( NetInterface interface)

PIC32MX Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 94 of file pic32mx_eth_driver.c.

◆ pic32mxEthInitBufferDesc()

void pic32mxEthInitBufferDesc ( NetInterface interface)

Initialize DMA descriptor lists.

Parameters
[in]interfaceUnderlying network interface

Definition at line 240 of file pic32mx_eth_driver.c.

◆ pic32mxEthInitGpio()

__weak_func void pic32mxEthInitGpio ( NetInterface interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 230 of file pic32mx_eth_driver.c.

◆ pic32mxEthIrqHandler()

void pic32mxEthIrqHandler ( void  )

PIC32MX Ethernet MAC interrupt service routine.

Definition at line 386 of file pic32mx_eth_driver.c.

◆ pic32mxEthReadPhyReg()

uint16_t pic32mxEthReadPhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

Parameters
[in]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
Returns
Register value

Definition at line 734 of file pic32mx_eth_driver.c.

◆ pic32mxEthReceivePacket()

error_t pic32mxEthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 529 of file pic32mx_eth_driver.c.

◆ pic32mxEthSendPacket()

error_t pic32mxEthSendPacket ( NetInterface interface,
const NetBuffer buffer,
size_t  offset,
NetTxAncillary ancillary 
)

Send a packet.

Parameters
[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 471 of file pic32mx_eth_driver.c.

◆ pic32mxEthTick()

void pic32mxEthTick ( NetInterface interface)

PIC32MX 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]interfaceUnderlying network interface

Definition at line 306 of file pic32mx_eth_driver.c.

◆ pic32mxEthUpdateMacAddrFilter()

error_t pic32mxEthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 602 of file pic32mx_eth_driver.c.

◆ pic32mxEthUpdateMacConfig()

error_t pic32mxEthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 655 of file pic32mx_eth_driver.c.

◆ pic32mxEthWritePhyReg()

void pic32mxEthWritePhyReg ( uint8_t  opcode,
uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 
)

Write PHY register.

Parameters
[in]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
[in]dataRegister value

Definition at line 698 of file pic32mx_eth_driver.c.

Variable Documentation

◆ pic32mxEthDriver

error_t pic32mxEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
#define TRUE
Definition: os_port.h:50
error_t pic32mxEthInit(NetInterface *interface)
PIC32MX Ethernet MAC initialization.
error_t pic32mxEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
void pic32mxEthTick(NetInterface *interface)
PIC32MX Ethernet MAC timer handler.
uint16_t pic32mxEthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
#define FALSE
Definition: os_port.h:46
void pic32mxEthEventHandler(NetInterface *interface)
PIC32MX Ethernet MAC event handler.
#define ETH_MTU
Definition: ethernet.h:116
void pic32mxEthEnableIrq(NetInterface *interface)
Enable interrupts.
error_t pic32mxEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
void pic32mxEthDisableIrq(NetInterface *interface)
Disable interrupts.
void pic32mxEthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83