Macros | Functions | Variables
pic32cx_eth_driver.c File Reference

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

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t pic32cxEthInit (NetInterface *interface)
 PIC32CX Ethernet MAC initialization. More...
 
__weak_func 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 GMAC_Handler (void)
 PIC32CX Ethernet MAC interrupt service routine. 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.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file pic32cx_eth_driver.c.

Function Documentation

◆ GMAC_Handler()

void GMAC_Handler ( void  )

PIC32CX Ethernet MAC interrupt service routine.

Definition at line 443 of file pic32cx_eth_driver.c.

◆ pic32cxEthDisableIrq()

void pic32cxEthDisableIrq ( NetInterface *  interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 416 of file pic32cx_eth_driver.c.

◆ pic32cxEthEnableIrq()

void pic32cxEthEnableIrq ( NetInterface *  interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 388 of file pic32cx_eth_driver.c.

◆ pic32cxEthEventHandler()

void pic32cxEthEventHandler ( NetInterface *  interface)

PIC32CX Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 499 of file pic32cx_eth_driver.c.

◆ pic32cxEthInit()

error_t pic32cxEthInit ( NetInterface *  interface)

PIC32CX Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying 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]interfaceUnderlying network interface

Definition at line 310 of file pic32cx_eth_driver.c.

◆ pic32cxEthInitGpio()

__weak_func void pic32cxEthInitGpio ( NetInterface *  interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying 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]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister 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]interfaceUnderlying 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]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 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]interfaceUnderlying network interface

Definition at line 363 of file pic32cx_eth_driver.c.

◆ pic32cxEthUpdateMacAddrFilter()

error_t pic32cxEthUpdateMacAddrFilter ( NetInterface *  interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying 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]interfaceUnderlying 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]opcodeAccess type (2 bits)
[in]phyAddrPHY address (5 bits)
[in]regAddrRegister address (5 bits)
[in]dataRegister value

Definition at line 907 of file pic32cx_eth_driver.c.

Variable Documentation

◆ pic32cxEthDriver

const NicDriver pic32cxEthDriver
Initial value:
=
{
NIC_TYPE_ETHERNET,
ETH_MTU,
pic32cxEthInit,
pic32cxEthTick,
pic32cxEthEnableIrq,
pic32cxEthDisableIrq,
pic32cxEthEventHandler,
pic32cxEthSendPacket,
pic32cxEthUpdateMacAddrFilter,
pic32cxEthUpdateMacConfig,
pic32cxEthWritePhyReg,
pic32cxEthReadPhyReg,
TRUE,
TRUE,
TRUE,
FALSE
}
ETH_MTU
#define ETH_MTU
Definition: ethernet.h:116
NIC_TYPE_ETHERNET
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83
TRUE
#define TRUE
Definition: os_port.h:50
FALSE
#define FALSE
Definition: os_port.h:46
pic32cxEthUpdateMacAddrFilter
error_t pic32cxEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
Definition: pic32cx_eth_driver.c:738
pic32cxEthTick
void pic32cxEthTick(NetInterface *interface)
PIC32CX Ethernet MAC timer handler.
Definition: pic32cx_eth_driver.c:363
pic32cxEthUpdateMacConfig
error_t pic32cxEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
Definition: pic32cx_eth_driver.c:864
pic32cxEthEventHandler
void pic32cxEthEventHandler(NetInterface *interface)
PIC32CX Ethernet MAC event handler.
Definition: pic32cx_eth_driver.c:499
pic32cxEthDisableIrq
void pic32cxEthDisableIrq(NetInterface *interface)
Disable interrupts.
Definition: pic32cx_eth_driver.c:416
pic32cxEthReadPhyReg
uint16_t pic32cxEthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
Definition: pic32cx_eth_driver.c:946
pic32cxEthInit
error_t pic32cxEthInit(NetInterface *interface)
PIC32CX Ethernet MAC initialization.
Definition: pic32cx_eth_driver.c:115
pic32cxEthEnableIrq
void pic32cxEthEnableIrq(NetInterface *interface)
Enable interrupts.
Definition: pic32cx_eth_driver.c:388
pic32cxEthWritePhyReg
void pic32cxEthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
Definition: pic32cx_eth_driver.c:907
pic32cxEthSendPacket
error_t pic32cxEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
Definition: pic32cx_eth_driver.c:536

PIC32CX Ethernet MAC driver.

Definition at line 88 of file pic32cx_eth_driver.c.