f28m35x_eth_driver.h File Reference

F28M35x Ethernet MAC controller. More...

#include "core/nic.h"

Go to the source code of this file.

Macros

#define F28M35X_ETH_IRQ_PRIORITY_GROUPING   3
 
#define F28M35X_ETH_IRQ_PRIORITY   192
 
#define MAC_RIS_R   HWREG(ETH_BASE + MAC_O_RIS)
 
#define MAC_IACK_R   HWREG(ETH_BASE + MAC_O_IACK)
 
#define MAC_IM_R   HWREG(ETH_BASE + MAC_O_IM)
 
#define MAC_RCTL_R   HWREG(ETH_BASE + MAC_O_RCTL)
 
#define MAC_TCTL_R   HWREG(ETH_BASE + MAC_O_TCTL)
 
#define MAC_DATA_R   HWREG(ETH_BASE + MAC_O_DATA)
 
#define MAC_IA0_R   HWREG(ETH_BASE + MAC_O_IA0)
 
#define MAC_IA1_R   HWREG(ETH_BASE + MAC_O_IA1)
 
#define MAC_THR_R   HWREG(ETH_BASE + MAC_O_THR)
 
#define MAC_MCTL_R   HWREG(ETH_BASE + MAC_O_MCTL)
 
#define MAC_MDV_R   HWREG(ETH_BASE + MAC_O_MDV)
 
#define MAC_MAR_R   HWREG(ETH_BASE + 0x28)
 
#define MAC_MTXD_R   HWREG(ETH_BASE + MAC_O_MTXD)
 
#define MAC_MRXD_R   HWREG(ETH_BASE + MAC_O_MRXD)
 
#define MAC_NP_R   HWREG(ETH_BASE + MAC_O_NP)
 
#define MAC_TR_R   HWREG(ETH_BASE + MAC_O_TR)
 
#define MAC_TS_R   HWREG(ETH_BASE + MAC_O_TS)
 

Functions

error_t f28m35xEthInit (NetInterface *interface)
 F28M35x Ethernet MAC controller initialization. More...
 
void f28m35xEthInitGpio (NetInterface *interface)
 
void f28m35xEthTick (NetInterface *interface)
 F28M35x Ethernet MAC timer handler. More...
 
void f28m35xEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void f28m35xEthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void f28m35xEthIrqHandler (void)
 F28M35x Ethernet MAC interrupt service routine. More...
 
void f28m35xEthEventHandler (NetInterface *interface)
 F28M35x Ethernet MAC event handler. More...
 
error_t f28m35xEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet. More...
 
error_t f28m35xEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t f28m35xEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t f28m35xEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void f28m35xEthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t f28m35xEthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 

Variables

const NicDriver f28m35xEthDriver
 F28M35x Ethernet MAC driver. More...
 

Detailed Description

F28M35x Ethernet MAC controller.

License

Copyright (C) 2010-2018 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.9.0

Definition in file f28m35x_eth_driver.h.

Macro Definition Documentation

◆ F28M35X_ETH_IRQ_PRIORITY

#define F28M35X_ETH_IRQ_PRIORITY   192

Definition at line 44 of file f28m35x_eth_driver.h.

◆ F28M35X_ETH_IRQ_PRIORITY_GROUPING

#define F28M35X_ETH_IRQ_PRIORITY_GROUPING   3

Definition at line 37 of file f28m35x_eth_driver.h.

◆ MAC_DATA_R

#define MAC_DATA_R   HWREG(ETH_BASE + MAC_O_DATA)

Definition at line 55 of file f28m35x_eth_driver.h.

◆ MAC_IA0_R

#define MAC_IA0_R   HWREG(ETH_BASE + MAC_O_IA0)

Definition at line 56 of file f28m35x_eth_driver.h.

◆ MAC_IA1_R

#define MAC_IA1_R   HWREG(ETH_BASE + MAC_O_IA1)

Definition at line 57 of file f28m35x_eth_driver.h.

◆ MAC_IACK_R

#define MAC_IACK_R   HWREG(ETH_BASE + MAC_O_IACK)

Definition at line 51 of file f28m35x_eth_driver.h.

◆ MAC_IM_R

#define MAC_IM_R   HWREG(ETH_BASE + MAC_O_IM)

Definition at line 52 of file f28m35x_eth_driver.h.

◆ MAC_MAR_R

#define MAC_MAR_R   HWREG(ETH_BASE + 0x28)

Definition at line 61 of file f28m35x_eth_driver.h.

◆ MAC_MCTL_R

#define MAC_MCTL_R   HWREG(ETH_BASE + MAC_O_MCTL)

Definition at line 59 of file f28m35x_eth_driver.h.

◆ MAC_MDV_R

#define MAC_MDV_R   HWREG(ETH_BASE + MAC_O_MDV)

Definition at line 60 of file f28m35x_eth_driver.h.

◆ MAC_MRXD_R

#define MAC_MRXD_R   HWREG(ETH_BASE + MAC_O_MRXD)

Definition at line 63 of file f28m35x_eth_driver.h.

◆ MAC_MTXD_R

#define MAC_MTXD_R   HWREG(ETH_BASE + MAC_O_MTXD)

Definition at line 62 of file f28m35x_eth_driver.h.

◆ MAC_NP_R

#define MAC_NP_R   HWREG(ETH_BASE + MAC_O_NP)

Definition at line 64 of file f28m35x_eth_driver.h.

◆ MAC_RCTL_R

#define MAC_RCTL_R   HWREG(ETH_BASE + MAC_O_RCTL)

Definition at line 53 of file f28m35x_eth_driver.h.

◆ MAC_RIS_R

#define MAC_RIS_R   HWREG(ETH_BASE + MAC_O_RIS)

Definition at line 50 of file f28m35x_eth_driver.h.

◆ MAC_TCTL_R

#define MAC_TCTL_R   HWREG(ETH_BASE + MAC_O_TCTL)

Definition at line 54 of file f28m35x_eth_driver.h.

◆ MAC_THR_R

#define MAC_THR_R   HWREG(ETH_BASE + MAC_O_THR)

Definition at line 58 of file f28m35x_eth_driver.h.

◆ MAC_TR_R

#define MAC_TR_R   HWREG(ETH_BASE + MAC_O_TR)

Definition at line 65 of file f28m35x_eth_driver.h.

◆ MAC_TS_R

#define MAC_TS_R   HWREG(ETH_BASE + MAC_O_TS)

Definition at line 66 of file f28m35x_eth_driver.h.

Function Documentation

◆ f28m35xEthDisableIrq()

void f28m35xEthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 338 of file f28m35x_eth_driver.c.

◆ f28m35xEthEnableIrq()

void f28m35xEthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 318 of file f28m35x_eth_driver.c.

◆ f28m35xEthEventHandler()

void f28m35xEthEventHandler ( NetInterface interface)

F28M35x Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 407 of file f28m35x_eth_driver.c.

◆ f28m35xEthInit()

error_t f28m35xEthInit ( NetInterface interface)

F28M35x Ethernet MAC controller initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 99 of file f28m35x_eth_driver.c.

◆ f28m35xEthInitGpio()

void f28m35xEthInitGpio ( NetInterface interface)

◆ f28m35xEthIrqHandler()

void f28m35xEthIrqHandler ( void  )

F28M35x Ethernet MAC interrupt service routine.

Definition at line 357 of file f28m35x_eth_driver.c.

◆ f28m35xEthReadPhyReg()

uint16_t f28m35xEthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

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

Definition at line 660 of file f28m35x_eth_driver.c.

◆ f28m35xEthReceivePacket()

error_t f28m35xEthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 489 of file f28m35x_eth_driver.c.

◆ f28m35xEthSendPacket()

error_t f28m35xEthSendPacket ( 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 436 of file f28m35x_eth_driver.c.

◆ f28m35xEthTick()

void f28m35xEthTick ( NetInterface interface)

F28M35x 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 f28m35x_eth_driver.c.

◆ f28m35xEthUpdateMacAddrFilter()

error_t f28m35xEthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 580 of file f28m35x_eth_driver.c.

◆ f28m35xEthUpdateMacConfig()

error_t f28m35xEthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 619 of file f28m35x_eth_driver.c.

◆ f28m35xEthWritePhyReg()

void f28m35xEthWritePhyReg ( 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 639 of file f28m35x_eth_driver.c.

Variable Documentation

◆ f28m35xEthDriver

const NicDriver f28m35xEthDriver

F28M35x Ethernet MAC driver.

Definition at line 72 of file f28m35x_eth_driver.c.