doc/tm4c129__eth__driver_8h_source.html

/**

 * @file tm4c129_eth_driver.h

 * @brief Tiva TM4C129 Ethernet controller

 *

 * @section 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.4

 **/


#ifndef _TM4C129_ETH_DRIVER_H

#define _TM4C129_ETH_DRIVER_H


//Dependencies

#include "core/nic.h"


//Number of TX buffers

#ifndef TM4C129_ETH_TX_BUFFER_COUNT

   #define TM4C129_ETH_TX_BUFFER_COUNT 3

#elif (TM4C129_ETH_TX_BUFFER_COUNT < 1)

   #error TM4C129_ETH_TX_BUFFER_COUNT parameter is not valid

#endif


//TX buffer size

#ifndef TM4C129_ETH_TX_BUFFER_SIZE

   #define TM4C129_ETH_TX_BUFFER_SIZE 1536

#elif (TM4C129_ETH_TX_BUFFER_SIZE != 1536)

   #error TM4C129_ETH_TX_BUFFER_SIZE parameter is not valid

#endif


//Number of RX buffers

#ifndef TM4C129_ETH_RX_BUFFER_COUNT

   #define TM4C129_ETH_RX_BUFFER_COUNT 6

#elif (TM4C129_ETH_RX_BUFFER_COUNT < 1)

   #error TM4C129_ETH_RX_BUFFER_COUNT parameter is not valid

#endif


//RX buffer size

#ifndef TM4C129_ETH_RX_BUFFER_SIZE

   #define TM4C129_ETH_RX_BUFFER_SIZE 1536

#elif (TM4C129_ETH_RX_BUFFER_SIZE != 1536)

   #error TM4C129_ETH_RX_BUFFER_SIZE parameter is not valid

#endif


//Interrupt priority grouping

#ifndef TM4C129_ETH_IRQ_PRIORITY_GROUPING

   #define TM4C129_ETH_IRQ_PRIORITY_GROUPING 3

#elif (TM4C129_ETH_IRQ_PRIORITY_GROUPING < 0)

   #error TM4C129_ETH_IRQ_PRIORITY_GROUPING parameter is not valid

#endif


//Ethernet interrupt priority

#ifndef TM4C129_ETH_IRQ_PRIORITY

   #define TM4C129_ETH_IRQ_PRIORITY 192

#elif (TM4C129_ETH_IRQ_PRIORITY < 0)

   #error TM4C129_ETH_IRQ_PRIORITY parameter is not valid

#endif


//TM4C129 Flash registers

#ifndef FLASH_CONF_R

   #define FLASH_CONF_R HWREG(FLASH_CONF)

#endif


//TM4C129 Ethernet MAC registers

#ifndef EMAC0_CFG_R

   #define EMAC0_CFG_R          HWREG(EMAC0_BASE + EMAC_O_CFG)

   #define EMAC0_FRAMEFLTR_R    HWREG(EMAC0_BASE + EMAC_O_FRAMEFLTR)

   #define EMAC0_HASHTBLH_R     HWREG(EMAC0_BASE + EMAC_O_HASHTBLH)

   #define EMAC0_HASHTBLL_R     HWREG(EMAC0_BASE + EMAC_O_HASHTBLL)

   #define EMAC0_MIIADDR_R      HWREG(EMAC0_BASE + EMAC_O_MIIADDR)

   #define EMAC0_MIIDATA_R      HWREG(EMAC0_BASE + EMAC_O_MIIDATA)

   #define EMAC0_FLOWCTL_R      HWREG(EMAC0_BASE + EMAC_O_FLOWCTL)

   #define EMAC0_VLANTG_R       HWREG(EMAC0_BASE + EMAC_O_VLANTG)

   #define EMAC0_STATUS_R       HWREG(EMAC0_BASE + EMAC_O_STATUS)

   #define EMAC0_RWUFF_R        HWREG(EMAC0_BASE + EMAC_O_RWUFF)

   #define EMAC0_PMTCTLSTAT_R   HWREG(EMAC0_BASE + EMAC_O_PMTCTLSTAT)

   #define EMAC0_RIS_R          HWREG(EMAC0_BASE + EMAC_O_RIS)

   #define EMAC0_IM_R           HWREG(EMAC0_BASE + EMAC_O_IM)

   #define EMAC0_ADDR0H_R       HWREG(EMAC0_BASE + EMAC_O_ADDR0H)

   #define EMAC0_ADDR0L_R       HWREG(EMAC0_BASE + EMAC_O_ADDR0L)

   #define EMAC0_ADDR1H_R       HWREG(EMAC0_BASE + EMAC_O_ADDR1H)

   #define EMAC0_ADDR1L_R       HWREG(EMAC0_BASE + EMAC_O_ADDR1L)

   #define EMAC0_ADDR2H_R       HWREG(EMAC0_BASE + EMAC_O_ADDR2H)

   #define EMAC0_ADDR2L_R       HWREG(EMAC0_BASE + EMAC_O_ADDR2L)

   #define EMAC0_ADDR3H_R       HWREG(EMAC0_BASE + EMAC_O_ADDR3H)

   #define EMAC0_ADDR3L_R       HWREG(EMAC0_BASE + EMAC_O_ADDR3L)

   #define EMAC0_WDOGTO_R       HWREG(EMAC0_BASE + EMAC_O_WDOGTO)

   #define EMAC0_MMCCTRL_R      HWREG(EMAC0_BASE + EMAC_O_MMCCTRL)

   #define EMAC0_MMCRXRIS_R     HWREG(EMAC0_BASE + EMAC_O_MMCRXRIS)

   #define EMAC0_MMCTXRIS_R     HWREG(EMAC0_BASE + EMAC_O_MMCTXRIS)

   #define EMAC0_MMCRXIM_R      HWREG(EMAC0_BASE + EMAC_O_MMCRXIM)

   #define EMAC0_MMCTXIM_R      HWREG(EMAC0_BASE + EMAC_O_MMCTXIM)

   #define EMAC0_TXCNTGB_R      HWREG(EMAC0_BASE + EMAC_O_TXCNTGB)

   #define EMAC0_TXCNTSCOL_R    HWREG(EMAC0_BASE + EMAC_O_TXCNTSCOL)

   #define EMAC0_TXCNTMCOL_R    HWREG(EMAC0_BASE + EMAC_O_TXCNTMCOL)

   #define EMAC0_TXOCTCNTG_R    HWREG(EMAC0_BASE + EMAC_O_TXOCTCNTG)

   #define EMAC0_RXCNTGB_R      HWREG(EMAC0_BASE + EMAC_O_RXCNTGB)

   #define EMAC0_RXCNTCRCERR_R  HWREG(EMAC0_BASE + EMAC_O_RXCNTCRCERR)

   #define EMAC0_RXCNTALGNERR_R HWREG(EMAC0_BASE + EMAC_O_RXCNTALGNERR)

   #define EMAC0_RXCNTGUNI_R    HWREG(EMAC0_BASE + EMAC_O_RXCNTGUNI)

   #define EMAC0_VLNINCREP_R    HWREG(EMAC0_BASE + EMAC_O_VLNINCREP)

   #define EMAC0_VLANHASH_R     HWREG(EMAC0_BASE + EMAC_O_VLANHASH)

   #define EMAC0_TIMSTCTRL_R    HWREG(EMAC0_BASE + EMAC_O_TIMSTCTRL)

   #define EMAC0_SUBSECINC_R    HWREG(EMAC0_BASE + EMAC_O_SUBSECINC)

   #define EMAC0_TIMSEC_R       HWREG(EMAC0_BASE + EMAC_O_TIMSEC)

   #define EMAC0_TIMNANO_R      HWREG(EMAC0_BASE + EMAC_O_TIMNANO)

   #define EMAC0_TIMSECU_R      HWREG(EMAC0_BASE + EMAC_O_TIMSECU)

   #define EMAC0_TIMNANOU_R     HWREG(EMAC0_BASE + EMAC_O_TIMNANOU)

   #define EMAC0_TIMADD_R       HWREG(EMAC0_BASE + EMAC_O_TIMADD)

   #define EMAC0_TARGSEC_R      HWREG(EMAC0_BASE + EMAC_O_TARGSEC)

   #define EMAC0_TARGNANO_R     HWREG(EMAC0_BASE + EMAC_O_TARGNANO)

   #define EMAC0_HWORDSEC_R     HWREG(EMAC0_BASE + EMAC_O_HWORDSEC)

   #define EMAC0_TIMSTAT_R      HWREG(EMAC0_BASE + EMAC_O_TIMSTAT)

   #define EMAC0_PPSCTRL_R      HWREG(EMAC0_BASE + EMAC_O_PPSCTRL)

   #define EMAC0_PPS0INTVL_R    HWREG(EMAC0_BASE + EMAC_O_PPS0INTVL)

   #define EMAC0_PPS0WIDTH_R    HWREG(EMAC0_BASE + EMAC_O_PPS0WIDTH)

   #define EMAC0_DMABUSMOD_R    HWREG(EMAC0_BASE + EMAC_O_DMABUSMOD)

   #define EMAC0_TXPOLLD_R      HWREG(EMAC0_BASE + EMAC_O_TXPOLLD)

   #define EMAC0_RXPOLLD_R      HWREG(EMAC0_BASE + EMAC_O_RXPOLLD)

   #define EMAC0_RXDLADDR_R     HWREG(EMAC0_BASE + EMAC_O_RXDLADDR)

   #define EMAC0_TXDLADDR_R     HWREG(EMAC0_BASE + EMAC_O_TXDLADDR)

   #define EMAC0_DMARIS_R       HWREG(EMAC0_BASE + EMAC_O_DMARIS)

   #define EMAC0_DMAOPMODE_R    HWREG(EMAC0_BASE + EMAC_O_DMAOPMODE)

   #define EMAC0_DMAIM_R        HWREG(EMAC0_BASE + EMAC_O_DMAIM)

   #define EMAC0_MFBOC_R        HWREG(EMAC0_BASE + EMAC_O_MFBOC)

   #define EMAC0_RXINTWDT_R     HWREG(EMAC0_BASE + EMAC_O_RXINTWDT)

   #define EMAC0_HOSTXDESC_R    HWREG(EMAC0_BASE + EMAC_O_HOSTXDESC)

   #define EMAC0_HOSRXDESC_R    HWREG(EMAC0_BASE + EMAC_O_HOSRXDESC)

   #define EMAC0_HOSTXBA_R      HWREG(EMAC0_BASE + EMAC_O_HOSTXBA)

   #define EMAC0_HOSRXBA_R      HWREG(EMAC0_BASE + EMAC_O_HOSRXBA)

   #define EMAC0_PP_R           HWREG(EMAC0_BASE + EMAC_O_PP)

   #define EMAC0_PC_R           HWREG(EMAC0_BASE + EMAC_O_PC)

   #define EMAC0_CC_R           HWREG(EMAC0_BASE + EMAC_O_CC)

   #define EMAC0_EPHYRIS_R      HWREG(EMAC0_BASE + EMAC_O_EPHYRIS)

   #define EMAC0_EPHYIM_R       HWREG(EMAC0_BASE + EMAC_O_EPHYIM)

   #define EMAC0_EPHYMISC_R     HWREG(EMAC0_BASE + EMAC_O_EPHYMISC)

#endif


//DMABUSMOD register

#define EMAC_DMABUSMOD_RPBL_1  (1 << EMAC_DMABUSMOD_RPBL_S)

#define EMAC_DMABUSMOD_RPBL_2  (2 << EMAC_DMABUSMOD_RPBL_S)

#define EMAC_DMABUSMOD_RPBL_4  (4 << EMAC_DMABUSMOD_RPBL_S)

#define EMAC_DMABUSMOD_RPBL_8  (8 << EMAC_DMABUSMOD_RPBL_S)

#define EMAC_DMABUSMOD_RPBL_16 (16 << EMAC_DMABUSMOD_RPBL_S)

#define EMAC_DMABUSMOD_RPBL_32 (32 << EMAC_DMABUSMOD_RPBL_S)


#define EMAC_DMABUSMOD_PR_1_1  (0 << EMAC_DMABUSMOD_PR_S)

#define EMAC_DMABUSMOD_PR_2_1  (1 << EMAC_DMABUSMOD_PR_S)

#define EMAC_DMABUSMOD_PR_3_1  (2 << EMAC_DMABUSMOD_PR_S)

#define EMAC_DMABUSMOD_PR_4_1  (3 << EMAC_DMABUSMOD_PR_S)


#define EMAC_DMABUSMOD_PBL_1   (1 << EMAC_DMABUSMOD_PBL_S)

#define EMAC_DMABUSMOD_PBL_2   (2 << EMAC_DMABUSMOD_PBL_S)

#define EMAC_DMABUSMOD_PBL_4   (4 << EMAC_DMABUSMOD_PBL_S)

#define EMAC_DMABUSMOD_PBL_8   (8 << EMAC_DMABUSMOD_PBL_S)

#define EMAC_DMABUSMOD_PBL_16  (16 << EMAC_DMABUSMOD_PBL_S)

#define EMAC_DMABUSMOD_PBL_32  (32 << EMAC_DMABUSMOD_PBL_S)


//Transmit DMA descriptor flags

#define EMAC_TDES0_OWN    0x80000000

#define EMAC_TDES0_IC     0x40000000

#define EMAC_TDES0_LS     0x20000000

#define EMAC_TDES0_FS     0x10000000

#define EMAC_TDES0_DC     0x08000000

#define EMAC_TDES0_DP     0x04000000

#define EMAC_TDES0_TTSE   0x02000000

#define EMAC_TDES0_CRCR   0x01000000

#define EMAC_TDES0_CIC    0x00C00000

#define EMAC_TDES0_TER    0x00200000

#define EMAC_TDES0_TCH    0x00100000

#define EMAC_TDES0_VLIC   0x000C0000

#define EMAC_TDES0_TTSS   0x00020000

#define EMAC_TDES0_IHE    0x00010000

#define EMAC_TDES0_ES     0x00008000

#define EMAC_TDES0_JT     0x00004000

#define EMAC_TDES0_FF     0x00002000

#define EMAC_TDES0_IPE    0x00001000

#define EMAC_TDES0_LCA    0x00000800

#define EMAC_TDES0_NC     0x00000400

#define EMAC_TDES0_LCO    0x00000200

#define EMAC_TDES0_EC     0x00000100

#define EMAC_TDES0_VF     0x00000080

#define EMAC_TDES0_CC     0x00000078

#define EMAC_TDES0_ED     0x00000004

#define EMAC_TDES0_UF     0x00000002

#define EMAC_TDES0_DB     0x00000001

#define EMAC_TDES1_SAIC   0xE0000000

#define EMAC_TDES1_TBS2   0x1FFF0000

#define EMAC_TDES1_TBS1   0x00001FFF

#define EMAC_TDES2_TBAP1  0xFFFFFFFF

#define EMAC_TDES3_TBAP2  0xFFFFFFFF

#define EMAC_TDES6_TTSL   0xFFFFFFFF

#define EMAC_TDES7_TTSH   0xFFFFFFFF


//Receive DMA descriptor flags

#define EMAC_RDES0_OWN    0x80000000

#define EMAC_RDES0_AFM    0x40000000

#define EMAC_RDES0_FL     0x3FFF0000

#define EMAC_RDES0_ES     0x00008000

#define EMAC_RDES0_DE     0x00004000

#define EMAC_RDES0_SAF    0x00002000

#define EMAC_RDES0_LE     0x00001000

#define EMAC_RDES0_OE     0x00000800

#define EMAC_RDES0_VLAN   0x00000400

#define EMAC_RDES0_FS     0x00000200

#define EMAC_RDES0_LS     0x00000100

#define EMAC_RDES0_TSA_GF 0x00000080

#define EMAC_RDES0_LCO    0x00000040

#define EMAC_RDES0_FT     0x00000020

#define EMAC_RDES0_RWT    0x00000010

#define EMAC_RDES0_RE     0x00000008

#define EMAC_RDES0_DBE    0x00000004

#define EMAC_RDES0_CE     0x00000002

#define EMAC_RDES0_ESA    0x00000001

#define EMAC_RDES1_DIC    0x80000000

#define EMAC_RDES1_RBS2   0x1FFF0000

#define EMAC_RDES1_RER    0x00008000

#define EMAC_RDES1_RCH    0x00004000

#define EMAC_RDES1_RBS1   0x00001FFF

#define EMAC_RDES2_RBAP1  0xFFFFFFFF

#define EMAC_RDES3_RBAP2  0xFFFFFFFF

#define EMAC_RDES4_TSD    0x00004000

#define EMAC_RDES4_PV     0x00002000

#define EMAC_RDES4_PFT    0x00001000

#define EMAC_RDES4_PMT    0x00000F00

#define EMAC_RDES4_IPV6PR 0x00000080

#define EMAC_RDES4_IPV4PR 0x00000040

#define EMAC_RDES4_IPCB   0x00000020

#define EMAC_RDES4_IPPE   0x00000010

#define EMAC_RDES4_IPHE   0x00000008

#define EMAC_RDES4_IPPT   0x00000007

#define EMAC_RDES6_RTSL   0xFFFFFFFF

#define EMAC_RDES7_RTSH   0xFFFFFFFF


#ifndef ti_sysbios_BIOS___VERS

   #define tm4c129EthIrqHandler EMAC0_Handler

#endif


//C++ guard

#ifdef __cplusplus

extern "C" {

#endif


/**

 * @brief Enhanced TX DMA descriptor

 **/


typedef struct

{

   uint32_t tdes0;

   uint32_t tdes1;

   uint32_t tdes2;

   uint32_t tdes3;

   uint32_t tdes4;

   uint32_t tdes5;

   uint32_t tdes6;

   uint32_t tdes7;

} Tm4c129TxDmaDesc;


/**

 * @brief Enhanced RX DMA descriptor

 **/


typedef struct

{

   uint32_t rdes0;

   uint32_t rdes1;

   uint32_t rdes2;

   uint32_t rdes3;

   uint32_t rdes4;

   uint32_t rdes5;

   uint32_t rdes6;

   uint32_t rdes7;

} Tm4c129RxDmaDesc;


//TM4C129 Ethernet MAC driver

extern const NicDriver tm4c129EthDriver;


//TM4C129 Ethernet MAC related functions

error_t tm4c129EthInit(NetInterface *interface);

void tm4c129EthInitGpio(NetInterface *interface);

void tm4c129EthInitDmaDesc(NetInterface *interface);


void tm4c129EthTick(NetInterface *interface);


void tm4c129EthEnableIrq(NetInterface *interface);

void tm4c129EthDisableIrq(NetInterface *interface);

void tm4c129EthIrqHandler(void);

void tm4c129EthEventHandler(NetInterface *interface);


error_t tm4c129EthSendPacket(NetInterface *interface,

   const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);


error_t tm4c129EthReceivePacket(NetInterface *interface);


error_t tm4c129EthUpdateMacAddrFilter(NetInterface *interface);

error_t tm4c129EthUpdateMacConfig(NetInterface *interface);


void tm4c129EthWritePhyReg(uint8_t opcode, uint8_t phyAddr,

   uint8_t regAddr, uint16_t data);


uint16_t tm4c129EthReadPhyReg(uint8_t opcode, uint8_t phyAddr,

   uint8_t regAddr);


void tm4c129EthDumpPhyReg(void);


uint32_t tm4c129EthCalcCrc(const void *data, size_t length);


//C++ guard

#ifdef __cplusplus

}

#endif


#endif