sam9263_eth_driver.h File Reference

AT91SAM9263 Ethernet MAC controller. More...

Go to the source code of this file.

Data Structures

struct  Sam9263TxBufferDesc
 Transmit buffer descriptor. More...
 
struct  Sam9263RxBufferDesc
 Receive buffer descriptor. More...
 

Macros

#define SAM9263_ETH_TX_BUFFER_COUNT   3
 
#define SAM9263_ETH_TX_BUFFER_SIZE   1536
 
#define SAM9263_ETH_RX_BUFFER_COUNT   72
 
#define SAM9263_ETH_RX_BUFFER_SIZE   128
 
#define AT91C_BASE_EMAC   AT91C_BASE_MACB
 
#define AT91C_EMAC_RMII_MASK_C   AT91C_PC25_ERXDV
 
#define AT91C_EMAC_RMII_MASK_E
 
#define AT91C_EMAC_SOF_01   (1 << 30)
 
#define AT91C_EMAC_RW_01   (1 << 28)
 
#define AT91C_EMAC_RW_10   (2 << 28)
 
#define AT91C_EMAC_CODE_10   (2 << 16)
 
#define AT91C_EMAC_TX_USED   0x80000000
 
#define AT91C_EMAC_TX_WRAP   0x40000000
 
#define AT91C_EMAC_TX_ERROR   0x20000000
 
#define AT91C_EMAC_TX_UNDERRUN   0x10000000
 
#define AT91C_EMAC_TX_EXHAUSTED   0x08000000
 
#define AT91C_EMAC_TX_NO_CRC   0x00010000
 
#define AT91C_EMAC_TX_LAST   0x00008000
 
#define AT91C_EMAC_TX_LENGTH   0x000007FF
 
#define AT91C_EMAC_RX_ADDRESS   0xFFFFFFFC
 
#define AT91C_EMAC_RX_WRAP   0x00000002
 
#define AT91C_EMAC_RX_OWNERSHIP   0x00000001
 
#define AT91C_EMAC_RX_BROADCAST   0x80000000
 
#define AT91C_EMAC_RX_MULTICAST_HASH   0x40000000
 
#define AT91C_EMAC_RX_UNICAST_HASH   0x20000000
 
#define AT91C_EMAC_RX_EXT_ADDR   0x10000000
 
#define AT91C_EMAC_RX_SAR1   0x04000000
 
#define AT91C_EMAC_RX_SAR2   0x02000000
 
#define AT91C_EMAC_RX_SAR3   0x01000000
 
#define AT91C_EMAC_RX_SAR4   0x00800000
 
#define AT91C_EMAC_RX_TYPE_ID   0x00400000
 
#define AT91C_EMAC_RX_VLAN_TAG   0x00200000
 
#define AT91C_EMAC_RX_PRIORITY_TAG   0x00100000
 
#define AT91C_EMAC_RX_VLAN_PRIORITY   0x000E0000
 
#define AT91C_EMAC_RX_CFI   0x00010000
 
#define AT91C_EMAC_RX_EOF   0x00008000
 
#define AT91C_EMAC_RX_SOF   0x00004000
 
#define AT91C_EMAC_RX_OFFSET   0x00003000
 
#define AT91C_EMAC_RX_LENGTH   0x00000FFF
 

Functions

error_t sam9263EthInit (NetInterface *interface)
 SAM9263 Ethernet MAC initialization. More...
 
void sam9263EthInitGpio (NetInterface *interface)
 
void sam9263EthInitBufferDesc (NetInterface *interface)
 Initialize buffer descriptors. More...
 
void sam9263EthTick (NetInterface *interface)
 SAM9263 Ethernet MAC timer handler. More...
 
void sam9263EthEnableIrq (NetInterface *interface)
 Enable interrupts. More...
 
void sam9263EthDisableIrq (NetInterface *interface)
 Disable interrupts. More...
 
void sam9263EthIrqHandler (void)
 SAM9263 Ethernet MAC interrupt service routine. More...
 
void sam9263EthEventHandler (NetInterface *interface)
 SAM9263 Ethernet MAC event handler. More...
 
error_t sam9263EthSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset)
 Send a packet. More...
 
error_t sam9263EthReceivePacket (NetInterface *interface)
 Receive a packet. More...
 
error_t sam9263EthUpdateMacAddrFilter (NetInterface *interface)
 Configure MAC address filtering. More...
 
error_t sam9263EthUpdateMacConfig (NetInterface *interface)
 Adjust MAC configuration parameters for proper operation. More...
 
void sam9263EthWritePhyReg (uint8_t phyAddr, uint8_t regAddr, uint16_t data)
 Write PHY register. More...
 
uint16_t sam9263EthReadPhyReg (uint8_t phyAddr, uint8_t regAddr)
 Read PHY register. More...
 
void emacIrqWrapper (void)
 

Variables

const NicDriver sam9263EthDriver
 SAM9263 Ethernet MAC driver. More...
 

Detailed Description

AT91SAM9263 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 sam9263_eth_driver.h.

Macro Definition Documentation

◆ AT91C_BASE_EMAC

#define AT91C_BASE_EMAC   AT91C_BASE_MACB

Definition at line 61 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_CODE_10

#define AT91C_EMAC_CODE_10   (2 << 16)

Definition at line 74 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RMII_MASK_C

#define AT91C_EMAC_RMII_MASK_C   AT91C_PC25_ERXDV

Definition at line 64 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RMII_MASK_E

#define AT91C_EMAC_RMII_MASK_E
Value:
(AT91C_PE30_EMDIO | \
AT91C_PE29_EMDC | AT91C_PE28_ETXEN | AT91C_PE27_ERXER | AT91C_PE26_ERX1 | \
AT91C_PE25_ERX0 | AT91C_PE24_ETX1 | AT91C_PE23_ETX0 | AT91C_PE21_ETXCK)

Definition at line 66 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RW_01

#define AT91C_EMAC_RW_01   (1 << 28)

Definition at line 72 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RW_10

#define AT91C_EMAC_RW_10   (2 << 28)

Definition at line 73 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_ADDRESS

#define AT91C_EMAC_RX_ADDRESS   0xFFFFFFFC

Definition at line 87 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_BROADCAST

#define AT91C_EMAC_RX_BROADCAST   0x80000000

Definition at line 90 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_CFI

#define AT91C_EMAC_RX_CFI   0x00010000

Definition at line 102 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_EOF

#define AT91C_EMAC_RX_EOF   0x00008000

Definition at line 103 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_EXT_ADDR

#define AT91C_EMAC_RX_EXT_ADDR   0x10000000

Definition at line 93 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_LENGTH

#define AT91C_EMAC_RX_LENGTH   0x00000FFF

Definition at line 106 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_MULTICAST_HASH

#define AT91C_EMAC_RX_MULTICAST_HASH   0x40000000

Definition at line 91 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_OFFSET

#define AT91C_EMAC_RX_OFFSET   0x00003000

Definition at line 105 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_OWNERSHIP

#define AT91C_EMAC_RX_OWNERSHIP   0x00000001

Definition at line 89 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_PRIORITY_TAG

#define AT91C_EMAC_RX_PRIORITY_TAG   0x00100000

Definition at line 100 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_SAR1

#define AT91C_EMAC_RX_SAR1   0x04000000

Definition at line 94 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_SAR2

#define AT91C_EMAC_RX_SAR2   0x02000000

Definition at line 95 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_SAR3

#define AT91C_EMAC_RX_SAR3   0x01000000

Definition at line 96 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_SAR4

#define AT91C_EMAC_RX_SAR4   0x00800000

Definition at line 97 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_SOF

#define AT91C_EMAC_RX_SOF   0x00004000

Definition at line 104 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_TYPE_ID

#define AT91C_EMAC_RX_TYPE_ID   0x00400000

Definition at line 98 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_UNICAST_HASH

#define AT91C_EMAC_RX_UNICAST_HASH   0x20000000

Definition at line 92 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_VLAN_PRIORITY

#define AT91C_EMAC_RX_VLAN_PRIORITY   0x000E0000

Definition at line 101 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_VLAN_TAG

#define AT91C_EMAC_RX_VLAN_TAG   0x00200000

Definition at line 99 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_RX_WRAP

#define AT91C_EMAC_RX_WRAP   0x00000002

Definition at line 88 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_SOF_01

#define AT91C_EMAC_SOF_01   (1 << 30)

Definition at line 71 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_TX_ERROR

#define AT91C_EMAC_TX_ERROR   0x20000000

Definition at line 79 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_TX_EXHAUSTED

#define AT91C_EMAC_TX_EXHAUSTED   0x08000000

Definition at line 81 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_TX_LAST

#define AT91C_EMAC_TX_LAST   0x00008000

Definition at line 83 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_TX_LENGTH

#define AT91C_EMAC_TX_LENGTH   0x000007FF

Definition at line 84 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_TX_NO_CRC

#define AT91C_EMAC_TX_NO_CRC   0x00010000

Definition at line 82 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_TX_UNDERRUN

#define AT91C_EMAC_TX_UNDERRUN   0x10000000

Definition at line 80 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_TX_USED

#define AT91C_EMAC_TX_USED   0x80000000

Definition at line 77 of file sam9263_eth_driver.h.

◆ AT91C_EMAC_TX_WRAP

#define AT91C_EMAC_TX_WRAP   0x40000000

Definition at line 78 of file sam9263_eth_driver.h.

◆ SAM9263_ETH_RX_BUFFER_COUNT

#define SAM9263_ETH_RX_BUFFER_COUNT   72

Definition at line 48 of file sam9263_eth_driver.h.

◆ SAM9263_ETH_RX_BUFFER_SIZE

#define SAM9263_ETH_RX_BUFFER_SIZE   128

Definition at line 55 of file sam9263_eth_driver.h.

◆ SAM9263_ETH_TX_BUFFER_COUNT

#define SAM9263_ETH_TX_BUFFER_COUNT   3

Definition at line 34 of file sam9263_eth_driver.h.

◆ SAM9263_ETH_TX_BUFFER_SIZE

#define SAM9263_ETH_TX_BUFFER_SIZE   1536

Definition at line 41 of file sam9263_eth_driver.h.

Function Documentation

◆ emacIrqWrapper()

void emacIrqWrapper ( void  )

◆ sam9263EthDisableIrq()

void sam9263EthDisableIrq ( NetInterface interface)

Disable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 305 of file sam9263_eth_driver.c.

◆ sam9263EthEnableIrq()

void sam9263EthEnableIrq ( NetInterface interface)

Enable interrupts.

Parameters
[in]interfaceUnderlying network interface

Definition at line 291 of file sam9263_eth_driver.c.

◆ sam9263EthEventHandler()

void sam9263EthEventHandler ( NetInterface interface)

SAM9263 Ethernet MAC event handler.

Parameters
[in]interfaceUnderlying network interface

Definition at line 374 of file sam9263_eth_driver.c.

◆ sam9263EthInit()

error_t sam9263EthInit ( NetInterface interface)

SAM9263 Ethernet MAC initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 113 of file sam9263_eth_driver.c.

◆ sam9263EthInitBufferDesc()

void sam9263EthInitBufferDesc ( NetInterface interface)

Initialize buffer descriptors.

Parameters
[in]interfaceUnderlying network interface

Definition at line 226 of file sam9263_eth_driver.c.

◆ sam9263EthInitGpio()

void sam9263EthInitGpio ( NetInterface interface)

◆ sam9263EthIrqHandler()

void sam9263EthIrqHandler ( void  )

SAM9263 Ethernet MAC interrupt service routine.

Definition at line 318 of file sam9263_eth_driver.c.

◆ sam9263EthReadPhyReg()

uint16_t sam9263EthReadPhyReg ( uint8_t  phyAddr,
uint8_t  regAddr 
)

Read PHY register.

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

Definition at line 711 of file sam9263_eth_driver.c.

◆ sam9263EthReceivePacket()

error_t sam9263EthReceivePacket ( NetInterface interface)

Receive a packet.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 473 of file sam9263_eth_driver.c.

◆ sam9263EthSendPacket()

error_t sam9263EthSendPacket ( 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 408 of file sam9263_eth_driver.c.

◆ sam9263EthTick()

void sam9263EthTick ( NetInterface interface)

SAM9263 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 279 of file sam9263_eth_driver.c.

◆ sam9263EthUpdateMacAddrFilter()

error_t sam9263EthUpdateMacAddrFilter ( NetInterface interface)

Configure MAC address filtering.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 587 of file sam9263_eth_driver.c.

◆ sam9263EthUpdateMacConfig()

error_t sam9263EthUpdateMacConfig ( NetInterface interface)

Adjust MAC configuration parameters for proper operation.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 650 of file sam9263_eth_driver.c.

◆ sam9263EthWritePhyReg()

void sam9263EthWritePhyReg ( 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 684 of file sam9263_eth_driver.c.

Variable Documentation

◆ sam9263EthDriver

const NicDriver sam9263EthDriver

SAM9263 Ethernet MAC driver.

Definition at line 86 of file sam9263_eth_driver.c.