Sergey Pastor / 1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

pic32mz_eth.h File Reference
Data Structures | Functions | Variables

pic32mz_eth.h File Reference

PIC32MZ Ethernet MAC controller. More...

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.
void pic32mzEthInitGpio (NetInterface *interface)
 GPIO configuration.
void pic32mzEthInitBufferDesc (NetInterface *interface)
 Initialize DMA descriptor lists.
void pic32mzEthTick (NetInterface *interface)
 PIC32MZ Ethernet MAC timer handler.
void pic32mzEthEnableIrq (NetInterface *interface)
 Enable interrupts.
void pic32mzEthDisableIrq (NetInterface *interface)
 Disable interrupts.
void pic32mzEthIrqHandler (void)
 PIC32MZ Ethernet MAC interrupt service routine.
void pic32mzEthEventHandler (NetInterface *interface)
 PIC32MZ Ethernet MAC event handler.
error_t pic32mzEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet.
error_t pic32mzEthReceivePacket (NetInterface *interface)
 Receive a packet.
error_t pic32mzEthSetMulticastFilter (NetInterface *interface)
 Configure multicast MAC address filtering.
error_t pic32mzEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation.
void pic32mzEthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register.
uint16_t pic32mzEthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register.
uint32_t pic32mzEthCalcCrc (const void *data, size_t length)
 CRC calculation.

Variables

const NicDriver pic32mzEthDriver
 PIC32MZ Ethernet MAC driver.

Detailed Description

PIC32MZ Ethernet MAC controller.

License

Copyright (C) 2010-2017 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:
1.7.6

Definition in file pic32mz_eth.h.

Function Documentation

uint32_t pic32mzEthCalcCrc ( 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 711 of file pic32mz_eth.c.

void pic32mzEthDisableIrq ( NetInterface *  interface )

Disable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 341 of file pic32mz_eth.c.

void pic32mzEthEnableIrq ( NetInterface *  interface )

Enable interrupts.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 327 of file pic32mz_eth.c.

void pic32mzEthEventHandler ( NetInterface *  interface )

PIC32MZ Ethernet MAC event handler.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 407 of file pic32mz_eth.c.

error_t pic32mzEthInit ( NetInterface *  interface )

PIC32MZ Ethernet MAC initialization.

Parameters:
[in]interfaceUnderlying network interface
Returns:
Error code

Definition at line 92 of file pic32mz_eth.c.

void pic32mzEthInitBufferDesc ( NetInterface *  interface )

Initialize DMA descriptor lists.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 249 of file pic32mz_eth.c.

void pic32mzEthInitGpio ( NetInterface *  interface )

GPIO configuration.

Parameters:
[in]interfaceUnderlying network interface

Definition at line 213 of file pic32mz_eth.c.

void pic32mzEthIrqHandler ( void   )

PIC32MZ Ethernet MAC interrupt service routine.

Definition at line 354 of file pic32mz_eth.c.

uint16_t pic32mzEthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

Parameters:
[in]phyAddrPHY address
[in]regAddrRegister address
Returns:
Register value

Definition at line 681 of file pic32mz_eth.c.

error_t pic32mzEthReceivePacket ( NetInterface *  interface )

Receive a packet.

Parameters:
[in]interfaceUnderlying network interface
Returns:
Error code

Definition at line 493 of file pic32mz_eth.c.

error_t pic32mzEthSendPacket ( NetInterface *  interface,
const NetBuffer *  buffer,
size_t  offset 
)

Send a packet.

Parameters:
[in]interfaceUnderlying network interface
[in]bufferMulti-part buffer containing the data to send
[in]offsetOffset to the first data byte
Returns:
Error code

Definition at line 437 of file pic32mz_eth.c.

error_t pic32mzEthSetMulticastFilter ( NetInterface *  interface )

Configure multicast MAC address filtering.

Parameters:
[in]interfaceUnderlying network interface
Returns:
Error code

Definition at line 561 of file pic32mz_eth.c.

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

Definition at line 315 of file pic32mz_eth.c.

error_t pic32mzEthUpdateMacConfig ( NetInterface *  interface )

Adjust MAC configuration parameters for proper operation.

Parameters:
[in]interfaceUnderlying network interface
Returns:
Error code

Definition at line 614 of file pic32mz_eth.c.

void pic32mzEthWritePhyReg ( uint8_t  phyAddr,
uint8_t  regAddr,
uint16_t  data 
)

Write PHY register.

Parameters:
[in]phyAddrPHY address
[in]regAddrRegister address
[in]dataRegister value

Definition at line 656 of file pic32mz_eth.c.

Variable Documentation

const NicDriver pic32mzEthDriver

PIC32MZ Ethernet MAC driver.

Definition at line 65 of file pic32mz_eth.c.

Generated on Tue Jul 12 2022 17:10:21 by  doxygen 1.7.2