m487_eth_driver.h File Reference

Nuvoton M487 Ethernet MAC driver. More...

#include "core/nic.h"

Go to the source code of this file.

Data Structures
struct	M487TxDmaDesc
	TX DMA descriptor. More...
struct	M487RxDmaDesc
	RX DMA descriptor. More...

Macros
#define	M487_ETH_TX_BUFFER_COUNT   2
#define	M487_ETH_TX_BUFFER_SIZE   1536
#define	M487_ETH_RX_BUFFER_COUNT   4
#define	M487_ETH_RX_BUFFER_SIZE   1536
#define	M487_ETH_IRQ_PRIORITY_GROUPING   3
#define	M487_ETH_IRQ_GROUP_PRIORITY   12
#define	M487_ETH_IRQ_SUB_PRIORITY   0
#define	EMAC_TXDES0_OWNER   0x80000000
#define	EMAC_TXDES0_TTSEN   0x00000008
#define	EMAC_TXDES0_INTEN   0x00000004
#define	EMAC_TXDES0_CRCAPP   0x00000002
#define	EMAC_TXDES0_PADEN   0x00000001
#define	EMAC_TXDES1_TXBSA   0xFFFFFFFF
#define	EMAC_TXDES2_COLCNT   0xF0000000
#define	EMAC_TXDES2_TTSAS   0x08000000
#define	EMAC_TXDES2_SQE   0x04000000
#define	EMAC_TXDES2_TXPAUSED   0x02000000
#define	EMAC_TXDES2_TXHALT   0x01000000
#define	EMAC_TXDES2_LCIF   0x00800000
#define	EMAC_TXDES2_TXABTIF   0x00400000
#define	EMAC_TXDES2_NCSIF   0x00200000
#define	EMAC_TXDES2_EXDEFIF   0x00100000
#define	EMAC_TXDES2_TXCPIF   0x00080000
#define	EMAC_TXDES2_DEF   0x00020000
#define	EMAC_TXDES2_TXIF   0x00010000
#define	EMAC_TXDES2_TBC   0x0000FFFF
#define	EMAC_TXDES2_NTXDSA   0xFFFFFFFF
#define	EMAC_RXDES0_OWNER   0x80000000
#define	EMAC_RXDES0_RTSAS   0x00800000
#define	EMAC_RXDES0_RPIF   0x00400000
#define	EMAC_RXDES0_ALIEIF   0x00200000
#define	EMAC_RXDES0_RXGDIF   0x00100000
#define	EMAC_RXDES0_LPIF   0x00080000
#define	EMAC_RXDES0_CRCEIF   0x00020000
#define	EMAC_RXDES0_RXIF   0x00010000
#define	EMAC_RXDES0_RBC   0x0000FFFF
#define	EMAC_RXDES1_RXBSA   0xFFFFFFFF
#define	EMAC_RXDES3_NRXDSA   0xFFFFFFFF

Functions
error_t	m487EthInit (NetInterface *interface)
	M487 Ethernet MAC initialization. More...
void	m487EthInitGpio (NetInterface *interface)
	GPIO configuration. More...
void	m487EthInitDmaDesc (NetInterface *interface)
	Initialize DMA descriptor lists. More...
void	m487EthTick (NetInterface *interface)
	M487 Ethernet MAC timer handler. More...
void	m487EthEnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	m487EthDisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	m487EthEventHandler (NetInterface *interface)
	M487 Ethernet MAC event handler. More...
error_t	m487EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	m487EthReceivePacket (NetInterface *interface)
	Receive a packet. More...
error_t	m487EthUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...
error_t	m487EthUpdateMacConfig (NetInterface *interface)
	Adjust MAC configuration parameters for proper operation. More...
void	m487EthWritePhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr, uint16_t data)
	Write PHY register. More...
uint16_t	m487EthReadPhyReg (uint8_t opcode, uint8_t phyAddr, uint8_t regAddr)
	Read PHY register. More...

Variables
const NicDriver	m487EthDriver
	M487 Ethernet MAC driver. More...

Detailed Description

Nuvoton M487 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 m487_eth_driver.h.

Macro Definition Documentation

EMAC_RXDES0_ALIEIF

#define EMAC_RXDES0_ALIEIF   0x00200000

Definition at line 112 of file m487_eth_driver.h.

EMAC_RXDES0_CRCEIF

#define EMAC_RXDES0_CRCEIF   0x00020000

Definition at line 115 of file m487_eth_driver.h.

EMAC_RXDES0_LPIF

#define EMAC_RXDES0_LPIF   0x00080000

Definition at line 114 of file m487_eth_driver.h.

EMAC_RXDES0_OWNER

#define EMAC_RXDES0_OWNER   0x80000000

Definition at line 109 of file m487_eth_driver.h.

EMAC_RXDES0_RBC

#define EMAC_RXDES0_RBC   0x0000FFFF

Definition at line 117 of file m487_eth_driver.h.

EMAC_RXDES0_RPIF

#define EMAC_RXDES0_RPIF   0x00400000

Definition at line 111 of file m487_eth_driver.h.

EMAC_RXDES0_RTSAS

#define EMAC_RXDES0_RTSAS   0x00800000

Definition at line 110 of file m487_eth_driver.h.

EMAC_RXDES0_RXGDIF

#define EMAC_RXDES0_RXGDIF   0x00100000

Definition at line 113 of file m487_eth_driver.h.

EMAC_RXDES0_RXIF

#define EMAC_RXDES0_RXIF   0x00010000

Definition at line 116 of file m487_eth_driver.h.

EMAC_RXDES1_RXBSA

#define EMAC_RXDES1_RXBSA   0xFFFFFFFF

Definition at line 118 of file m487_eth_driver.h.

EMAC_RXDES3_NRXDSA

#define EMAC_RXDES3_NRXDSA   0xFFFFFFFF

Definition at line 119 of file m487_eth_driver.h.

EMAC_TXDES0_CRCAPP

#define EMAC_TXDES0_CRCAPP   0x00000002

Definition at line 90 of file m487_eth_driver.h.

EMAC_TXDES0_INTEN

#define EMAC_TXDES0_INTEN   0x00000004

Definition at line 89 of file m487_eth_driver.h.

EMAC_TXDES0_OWNER

#define EMAC_TXDES0_OWNER   0x80000000

Definition at line 87 of file m487_eth_driver.h.

EMAC_TXDES0_PADEN

#define EMAC_TXDES0_PADEN   0x00000001

Definition at line 91 of file m487_eth_driver.h.

EMAC_TXDES0_TTSEN

#define EMAC_TXDES0_TTSEN   0x00000008

Definition at line 88 of file m487_eth_driver.h.

EMAC_TXDES1_TXBSA

#define EMAC_TXDES1_TXBSA   0xFFFFFFFF

Definition at line 92 of file m487_eth_driver.h.

EMAC_TXDES2_COLCNT

#define EMAC_TXDES2_COLCNT   0xF0000000

Definition at line 93 of file m487_eth_driver.h.

EMAC_TXDES2_DEF

#define EMAC_TXDES2_DEF   0x00020000

Definition at line 103 of file m487_eth_driver.h.

EMAC_TXDES2_EXDEFIF

#define EMAC_TXDES2_EXDEFIF   0x00100000

Definition at line 101 of file m487_eth_driver.h.

EMAC_TXDES2_LCIF

#define EMAC_TXDES2_LCIF   0x00800000

Definition at line 98 of file m487_eth_driver.h.

EMAC_TXDES2_NCSIF

#define EMAC_TXDES2_NCSIF   0x00200000

Definition at line 100 of file m487_eth_driver.h.

EMAC_TXDES2_NTXDSA

#define EMAC_TXDES2_NTXDSA   0xFFFFFFFF

Definition at line 106 of file m487_eth_driver.h.

EMAC_TXDES2_SQE

#define EMAC_TXDES2_SQE   0x04000000

Definition at line 95 of file m487_eth_driver.h.

EMAC_TXDES2_TBC

#define EMAC_TXDES2_TBC   0x0000FFFF

Definition at line 105 of file m487_eth_driver.h.

EMAC_TXDES2_TTSAS

#define EMAC_TXDES2_TTSAS   0x08000000

Definition at line 94 of file m487_eth_driver.h.

EMAC_TXDES2_TXABTIF

#define EMAC_TXDES2_TXABTIF   0x00400000

Definition at line 99 of file m487_eth_driver.h.

EMAC_TXDES2_TXCPIF

#define EMAC_TXDES2_TXCPIF   0x00080000

Definition at line 102 of file m487_eth_driver.h.

EMAC_TXDES2_TXHALT

#define EMAC_TXDES2_TXHALT   0x01000000

Definition at line 97 of file m487_eth_driver.h.

EMAC_TXDES2_TXIF

#define EMAC_TXDES2_TXIF   0x00010000

Definition at line 104 of file m487_eth_driver.h.

EMAC_TXDES2_TXPAUSED

#define EMAC_TXDES2_TXPAUSED   0x02000000

Definition at line 96 of file m487_eth_driver.h.

M487_ETH_IRQ_GROUP_PRIORITY

#define M487_ETH_IRQ_GROUP_PRIORITY   12

Definition at line 74 of file m487_eth_driver.h.

M487_ETH_IRQ_PRIORITY_GROUPING

#define M487_ETH_IRQ_PRIORITY_GROUPING   3

Definition at line 67 of file m487_eth_driver.h.

M487_ETH_IRQ_SUB_PRIORITY

#define M487_ETH_IRQ_SUB_PRIORITY   0

Definition at line 81 of file m487_eth_driver.h.

M487_ETH_RX_BUFFER_COUNT

#define M487_ETH_RX_BUFFER_COUNT   4

Definition at line 53 of file m487_eth_driver.h.

M487_ETH_RX_BUFFER_SIZE

#define M487_ETH_RX_BUFFER_SIZE   1536

Definition at line 60 of file m487_eth_driver.h.

M487_ETH_TX_BUFFER_COUNT

#define M487_ETH_TX_BUFFER_COUNT   2

Definition at line 39 of file m487_eth_driver.h.

M487_ETH_TX_BUFFER_SIZE

#define M487_ETH_TX_BUFFER_SIZE   1536

Definition at line 46 of file m487_eth_driver.h.

Function Documentation

m487EthDisableIrq()

void m487EthDisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 376 of file m487_eth_driver.c.

m487EthEnableIrq()

void m487EthEnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 347 of file m487_eth_driver.c.

m487EthEventHandler()

void m487EthEventHandler

(

NetInterface *

interface

)

M487 Ethernet MAC event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 469 of file m487_eth_driver.c.

m487EthInit()

error_t m487EthInit

(

NetInterface *

interface

)

M487 Ethernet MAC initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 114 of file m487_eth_driver.c.

m487EthInitDmaDesc()

void m487EthInitDmaDesc

(

NetInterface *

interface

)

Initialize DMA descriptor lists.

Parameters

[in]

interface

Underlying network interface

Definition at line 266 of file m487_eth_driver.c.

m487EthInitGpio()

void m487EthInitGpio

(

NetInterface *

interface

)

GPIO configuration.

Parameters

[in]

interface

Underlying network interface

Definition at line 214 of file m487_eth_driver.c.

m487EthReadPhyReg()

uint16_t m487EthReadPhyReg	(	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 766 of file m487_eth_driver.c.

m487EthReceivePacket()

error_t m487EthReceivePacket

(

NetInterface *

interface

)

Receive a packet.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 565 of file m487_eth_driver.c.

m487EthSendPacket()

error_t m487EthSendPacket	(	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 494 of file m487_eth_driver.c.

m487EthTick()

void m487EthTick

(

NetInterface *

interface

)

M487 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 322 of file m487_eth_driver.c.

m487EthUpdateMacAddrFilter()

error_t m487EthUpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 637 of file m487_eth_driver.c.

m487EthUpdateMacConfig()

error_t m487EthUpdateMacConfig

(

NetInterface *

interface

)

Adjust MAC configuration parameters for proper operation.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 683 of file m487_eth_driver.c.

m487EthWritePhyReg()

void m487EthWritePhyReg	(	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 726 of file m487_eth_driver.c.

Variable Documentation

m487EthDriver

const NicDriver m487EthDriver

extern

M487 Ethernet MAC driver.

Definition at line 87 of file m487_eth_driver.c.