RM57 Ethernet MAC driver. More...

#include "hl_hw_reg_access.h"
#include "hl_hw_emac.h"
#include "hl_hw_emac_ctrl.h"
#include "hl_hw_mdio.h"
#include "hl_gio.h"
#include "hl_sys_vim.h"
#include "core/net.h"
#include "drivers/mac/rm57_eth_driver.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL NIC_TRACE_LEVEL

#define	MDIO_INPUT_CLK 75000000

#define	MDIO_OUTPUT_CLK 1000000

Functions
error_t	rm57EthInit (NetInterface *interface)
	RM57 Ethernet MAC initialization. More...

__weak_func void	rm57EthInitGpio (NetInterface *interface)
	GPIO configuration. More...

void	rm57EthInitBufferDesc (NetInterface *interface)
	Initialize buffer descriptor lists. More...

void	rm57EthTick (NetInterface *interface)
	RM57 Ethernet MAC timer handler. More...

void	rm57EthEnableIrq (NetInterface *interface)
	Enable interrupts. More...

void	rm57EthDisableIrq (NetInterface *interface)
	Disable interrupts. More...

void	rm57EthTxIrqHandler (void)
	Ethernet MAC transmit interrupt. More...

void	rm57EthRxIrqHandler (void)
	Ethernet MAC receive interrupt. More...

void	rm57EthEventHandler (NetInterface *interface)
	RM57 Ethernet MAC event handler. More...

error_t	rm57EthSendPacket (NetInterface interface, const NetBuffer buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...

error_t	rm57EthReceivePacket (NetInterface *interface)
	Receive a packet. More...

error_t	rm57EthUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...

error_t	rm57EthUpdateMacConfig (NetInterface *interface)
	Adjust MAC configuration parameters for proper operation. More...

void	rm57EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
	Write PHY register. More...

uint16_t	rm57EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
	Read PHY register. More...

Variables
const NicDriver	rm57EthDriver
	RM57 Ethernet MAC driver. More...

Detailed Description

RM57 Ethernet MAC driver.

License

SPDX-License-Identifier: GPL-2.0-or-later

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 rm57_eth_driver.c.

Macro Definition Documentation

◆ MDIO_INPUT_CLK

#define MDIO_INPUT_CLK 75000000

Definition at line 46 of file rm57_eth_driver.c.

◆ MDIO_OUTPUT_CLK

#define MDIO_OUTPUT_CLK 1000000

Definition at line 48 of file rm57_eth_driver.c.

◆ TRACE_LEVEL

#define TRACE_LEVEL NIC_TRACE_LEVEL

Definition at line 32 of file rm57_eth_driver.c.

Function Documentation

◆ rm57EthDisableIrq()

void rm57EthDisableIrq ( NetInterface * interface )

Disable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 479 of file rm57_eth_driver.c.

◆ rm57EthEnableIrq()

void rm57EthEnableIrq ( NetInterface * interface )

Enable interrupts.

Parameters

[in] interface Underlying network interface

Definition at line 450 of file rm57_eth_driver.c.

◆ rm57EthEventHandler()

void rm57EthEventHandler ( NetInterface * interface )

RM57 Ethernet MAC event handler.

Parameters

[in] interface Underlying network interface

Definition at line 622 of file rm57_eth_driver.c.

◆ rm57EthInit()

error_t rm57EthInit ( NetInterface * interface )

RM57 Ethernet MAC initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 128 of file rm57_eth_driver.c.

◆ rm57EthInitBufferDesc()

void rm57EthInitBufferDesc ( NetInterface * interface )

Initialize buffer descriptor lists.

Parameters

[in] interface Underlying network interface

Definition at line 339 of file rm57_eth_driver.c.

◆ rm57EthInitGpio()

__weak_func void rm57EthInitGpio ( NetInterface * interface )

GPIO configuration.

Parameters

[in] interface Underlying network interface

Definition at line 312 of file rm57_eth_driver.c.

◆ rm57EthReadPhyReg()

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

Read PHY register.

Parameters

[in]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register address (5 bits)

Returns: Register value

Definition at line 971 of file rm57_eth_driver.c.

◆ rm57EthReceivePacket()

error_t rm57EthReceivePacket ( NetInterface * interface )

Receive a packet.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 728 of file rm57_eth_driver.c.

◆ rm57EthRxIrqHandler()

void rm57EthRxIrqHandler ( void )

Ethernet MAC receive interrupt.

Definition at line 583 of file rm57_eth_driver.c.

◆ rm57EthSendPacket()

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

Send a packet.

Parameters

[in]	interface	Underlying network interface
[in]	buffer	Multi-part buffer containing the data to send
[in]	offset	Offset to the first data byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 650 of file rm57_eth_driver.c.

◆ rm57EthTick()

void rm57EthTick ( NetInterface * interface )

RM57 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] interface Underlying network interface

Definition at line 413 of file rm57_eth_driver.c.

◆ rm57EthTxIrqHandler()

void rm57EthTxIrqHandler ( void )

Ethernet MAC transmit interrupt.

Definition at line 514 of file rm57_eth_driver.c.

◆ rm57EthUpdateMacAddrFilter()

error_t rm57EthUpdateMacAddrFilter ( NetInterface * interface )

Configure MAC address filtering.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 826 of file rm57_eth_driver.c.

◆ rm57EthUpdateMacConfig()

error_t rm57EthUpdateMacConfig ( NetInterface * interface )

Adjust MAC configuration parameters for proper operation.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 889 of file rm57_eth_driver.c.

◆ rm57EthWritePhyReg()

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

Write PHY register.

Parameters

[in]	opcode	Access type (2 bits)
[in]	phyAddr	PHY address (5 bits)
[in]	regAddr	Register address (5 bits)
[in]	data	Register value

Definition at line 932 of file rm57_eth_driver.c.

Variable Documentation

◆ rm57EthDriver

const NicDriver rm57EthDriver

Initial value:

=
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   rm57EthInit,
   rm57EthTick,
   rm57EthEnableIrq,
   rm57EthDisableIrq,
   rm57EthEventHandler,
   rm57EthSendPacket,
   rm57EthUpdateMacAddrFilter,
   rm57EthUpdateMacConfig,
   rm57EthWritePhyReg,
   rm57EthReadPhyReg,
   FALSE,
   TRUE,
   TRUE,
   FALSE
}

RM57 Ethernet MAC driver.

Definition at line 101 of file rm57_eth_driver.c.

Macros

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ MDIO_INPUT_CLK

◆ MDIO_OUTPUT_CLK

◆ TRACE_LEVEL

Function Documentation

◆ rm57EthDisableIrq()

◆ rm57EthEnableIrq()

◆ rm57EthEventHandler()

◆ rm57EthInit()

◆ rm57EthInitBufferDesc()

◆ rm57EthInitGpio()

◆ rm57EthReadPhyReg()

◆ rm57EthReceivePacket()

◆ rm57EthRxIrqHandler()

◆ rm57EthSendPacket()

◆ rm57EthTick()

◆ rm57EthTxIrqHandler()

◆ rm57EthUpdateMacAddrFilter()

◆ rm57EthUpdateMacConfig()

◆ rm57EthWritePhyReg()

Variable Documentation

◆ rm57EthDriver