sam4e_eth_driver.c File Reference

SAM4E Ethernet MAC driver. More...

#include <limits.h>
#include "sam4e.h"
#include "core/net.h"
#include "drivers/mac/sam4e_eth_driver.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   NIC_TRACE_LEVEL
 

Functions

error_t sam4eEthInit (NetInterface *interface)
 SAM4E Ethernet MAC initialization. More...
 
__weak_func void sam4eEthInitGpio (NetInterface *interface)
 GPIO configuration. More...
 
void sam4eEthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
 
void sam4eEthTick (NetInterface *interface)
 SAM4E Ethernet MAC timer handler. More...
 
void sam4eEthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void sam4eEthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void GMAC_Handler (void)
 SAM4E Ethernet MAC interrupt service routine. More...
 
void sam4eEthEventHandler (NetInterface *interface)
 SAM4E Ethernet MAC event handler. More...
 
error_t sam4eEthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a packet. More...
 
error_t sam4eEthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t sam4eEthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t sam4eEthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void sam4eEthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t sam4eEthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 

Variables

const NicDriver sam4eEthDriver
 SAM4E Ethernet MAC driver. More...
 

Detailed Description

SAM4E 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 sam4e_eth_driver.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   NIC_TRACE_LEVEL

Definition at line 32 of file sam4e_eth_driver.c.

Function Documentation

◆ GMAC_Handler()

void GMAC_Handler ( void  )

SAM4E Ethernet MAC interrupt service routine.

Definition at line 387 of file sam4e_eth_driver.c.

◆ sam4eEthDisableIrq()

void sam4eEthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 360 of file sam4e_eth_driver.c.

◆ sam4eEthEnableIrq()

void sam4eEthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 332 of file sam4e_eth_driver.c.

◆ sam4eEthEventHandler()

void sam4eEthEventHandler ( NetInterface interface)

SAM4E Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 441 of file sam4e_eth_driver.c.

◆ sam4eEthInit()

error_t sam4eEthInit ( NetInterface interface)

SAM4E Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 115 of file sam4e_eth_driver.c.

◆ sam4eEthInitBufferDesc()

void sam4eEthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

Parameters
[in]interfaceUnderlying network interface

Definition at line 254 of file sam4e_eth_driver.c.

◆ sam4eEthInitGpio()

__weak_func void sam4eEthInitGpio ( NetInterface interface)

GPIO configuration.

Parameters
[in]interfaceUnderlying network interface

Definition at line 226 of file sam4e_eth_driver.c.

◆ sam4eEthReadPhyReg()

uint16_t sam4eEthReadPhyReg ( 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 884 of file sam4e_eth_driver.c.

◆ sam4eEthReceivePacket()

error_t sam4eEthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 544 of file sam4e_eth_driver.c.

◆ sam4eEthSendPacket()

error_t sam4eEthSendPacket ( 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 477 of file sam4e_eth_driver.c.

◆ sam4eEthTick()

void sam4eEthTick ( NetInterface interface)

SAM4E 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 307 of file sam4e_eth_driver.c.

◆ sam4eEthUpdateMacAddrFilter()

error_t sam4eEthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 676 of file sam4e_eth_driver.c.

◆ sam4eEthUpdateMacConfig()

error_t sam4eEthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 802 of file sam4e_eth_driver.c.

◆ sam4eEthWritePhyReg()

void sam4eEthWritePhyReg ( 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 845 of file sam4e_eth_driver.c.

Variable Documentation

◆ sam4eEthDriver

const NicDriver sam4eEthDriver
Initial value:
=
{
}
#define ETH_MTU
Definition: ethernet.h:116
@ NIC_TYPE_ETHERNET
Ethernet interface.
Definition: nic.h:83
#define TRUE
Definition: os_port.h:50
#define FALSE
Definition: os_port.h:46
void sam4eEthEventHandler(NetInterface *interface)
SAM4E Ethernet MAC event handler.
void sam4eEthTick(NetInterface *interface)
SAM4E Ethernet MAC timer handler.
error_t sam4eEthUpdateMacConfig(NetInterface *interface)
Adjust MAC configuration parameters for proper operation.
uint16_t sam4eEthReadPhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
Read PHY register.
void sam4eEthWritePhyReg(uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
Write PHY register.
void sam4eEthEnableIrq(NetInterface *interface)
Enable interrupts.
error_t sam4eEthInit(NetInterface *interface)
SAM4E Ethernet MAC initialization.
error_t sam4eEthSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
error_t sam4eEthUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
void sam4eEthDisableIrq(NetInterface *interface)
Disable interrupts.

SAM4E Ethernet MAC driver.

Definition at line 88 of file sam4e_eth_driver.c.