rx63n_eth.h

00001 /**
00002  * @file rx63n_eth.h
00003  * @brief Renesas RX63N Ethernet MAC controller
00004  *
00005  * @section License
00006  *
00007  * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
00008  *
00009  * This file is part of CycloneTCP Open.
00010  *
00011  * This program is free software; you can redistribute it and/or
00012  * modify it under the terms of the GNU General Public License
00013  * as published by the Free Software Foundation; either version 2
00014  * of the License, or (at your option) any later version.
00015  *
00016  * This program is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU General Public License
00022  * along with this program; if not, write to the Free Software Foundation,
00023  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
00024  *
00025  * @author Oryx Embedded SARL (www.oryx-embedded.com)
00026  * @version 1.7.6
00027  **/
00028 
00029 #ifndef _RX63N_ETH_H
00030 #define _RX63N_ETH_H
00031 
00032 //Dependencies
00033 #include "core/nic.h"
00034 
00035 //Number of TX buffers
00036 #ifndef RX63N_ETH_TX_BUFFER_COUNT
00037    #define RX63N_ETH_TX_BUFFER_COUNT 3
00038 #elif (RX63N_ETH_TX_BUFFER_COUNT < 1)
00039    #error RX63N_ETH_TX_BUFFER_COUNT parameter is not valid
00040 #endif
00041 
00042 //TX buffer size
00043 #ifndef RX63N_ETH_TX_BUFFER_SIZE
00044    #define RX63N_ETH_TX_BUFFER_SIZE 1536
00045 #elif (RX63N_ETH_TX_BUFFER_SIZE != 1536)
00046    #error RX63N_ETH_TX_BUFFER_SIZE parameter is not valid
00047 #endif
00048 
00049 //Number of RX buffers
00050 #ifndef RX63N_ETH_RX_BUFFER_COUNT
00051    #define RX63N_ETH_RX_BUFFER_COUNT 6
00052 #elif (RX63N_ETH_RX_BUFFER_COUNT < 1)
00053    #error RX63N_ETH_RX_BUFFER_COUNT parameter is not valid
00054 #endif
00055 
00056 //RX buffer size
00057 #ifndef RX63N_ETH_RX_BUFFER_SIZE
00058    #define RX63N_ETH_RX_BUFFER_SIZE 1536
00059 #elif (RX63N_ETH_RX_BUFFER_SIZE != 1536)
00060    #error RX63N_ETH_RX_BUFFER_SIZE parameter is not valid
00061 #endif
00062 
00063 //Ethernet interrupt priority
00064 #ifndef RX63N_ETH_IRQ_PRIORITY
00065    #define RX63N_ETH_IRQ_PRIORITY 2
00066 #elif (RX63N_ETH_IRQ_PRIORITY < 0)
00067    #error RX63N_ETH_IRQ_PRIORITY parameter is not valid
00068 #endif
00069 
00070 //EESR register
00071 #define EDMAC_EESR_TWB     0x40000000
00072 #define EDMAC_EESR_TABT    0x04000000
00073 #define EDMAC_EESR_RABT    0x02000000
00074 #define EDMAC_EESR_RFCOF   0x01000000
00075 #define EDMAC_EESR_ADE     0x00800000
00076 #define EDMAC_EESR_ECI     0x00400000
00077 #define EDMAC_EESR_TC      0x00200000
00078 #define EDMAC_EESR_TDE     0x00100000
00079 #define EDMAC_EESR_TFUF    0x00080000
00080 #define EDMAC_EESR_FR      0x00040000
00081 #define EDMAC_EESR_RDE     0x00020000
00082 #define EDMAC_EESR_RFOF    0x00010000
00083 #define EDMAC_EESR_CND     0x00000800
00084 #define EDMAC_EESR_DLC     0x00000400
00085 #define EDMAC_EESR_CD      0x00000200
00086 #define EDMAC_EESR_TRO     0x00000100
00087 #define EDMAC_EESR_RMAF    0x00000080
00088 #define EDMAC_EESR_RRF     0x00000010
00089 #define EDMAC_EESR_RTLF    0x00000008
00090 #define EDMAC_EESR_RTSF    0x00000004
00091 #define EDMAC_EESR_PRE     0x00000002
00092 #define EDMAC_EESR_CERF    0x00000001
00093 
00094 //Transmit DMA descriptor flags
00095 #define EDMAC_TD0_TACT     0x80000000
00096 #define EDMAC_TD0_TDLE     0x40000000
00097 #define EDMAC_TD0_TFP_SOF  0x20000000
00098 #define EDMAC_TD0_TFP_EOF  0x10000000
00099 #define EDMAC_TD0_TFE      0x08000000
00100 #define EDMAC_TD0_TWBI     0x04000000
00101 #define EDMAC_TD0_TFS_MASK 0x0000010F
00102 #define EDMAC_TD0_TFS_TABT 0x00000100
00103 #define EDMAC_TD0_TFS_CND  0x00000008
00104 #define EDMAC_TD0_TFS_DLC  0x00000004
00105 #define EDMAC_TD0_TFS_CD   0x00000002
00106 #define EDMAC_TD0_TFS_TRO  0x00000001
00107 #define EDMAC_TD1_TBL      0xFFFF0000
00108 #define EDMAC_TD2_TBA      0xFFFFFFFF
00109 
00110 //Receive DMA descriptor flags
00111 #define EDMAC_RD0_RACT     0x80000000
00112 #define EDMAC_RD0_RDLE     0x40000000
00113 #define EDMAC_RD0_RFP_SOF  0x20000000
00114 #define EDMAC_RD0_RFP_EOF  0x10000000
00115 #define EDMAC_RD0_RFE      0x08000000
00116 #define EDMAC_RD0_RFS_MASK 0x0000039F
00117 #define EDMAC_RD0_RFS_RFOF 0x00000200
00118 #define EDMAC_RD0_RFS_RABT 0x00000100
00119 #define EDMAC_RD0_RFS_RMAF 0x00000080
00120 #define EDMAC_RD0_RFS_RRF  0x00000010
00121 #define EDMAC_RD0_RFS_RTLF 0x00000008
00122 #define EDMAC_RD0_RFS_RTSF 0x00000004
00123 #define EDMAC_RD0_RFS_PRE  0x00000002
00124 #define EDMAC_RD0_RFS_CERF 0x00000001
00125 #define EDMAC_RD1_RBL      0xFFFF0000
00126 #define EDMAC_RD1_RFL      0x0000FFFF
00127 #define EDMAC_RD2_RBA      0xFFFFFFFF
00128 
00129 //Serial Management Interface
00130 #define SMI_SYNC           0xFFFFFFFF
00131 #define SMI_START          0x00000001
00132 #define SMI_WRITE          0x00000001
00133 #define SMI_READ           0x00000002
00134 #define SMI_TA             0x00000002
00135 
00136 
00137 /**
00138  * @brief Transmit DMA descriptor
00139  **/
00140 
00141 typedef struct
00142 {
00143    uint32_t td0;
00144    uint32_t td1;
00145    uint32_t td2;
00146    uint32_t padding;
00147 } Rx63nTxDmaDesc;
00148 
00149 
00150 /**
00151  * @brief Receive DMA descriptor
00152  **/
00153 
00154 typedef struct
00155 {
00156    uint32_t rd0;
00157    uint32_t rd1;
00158    uint32_t rd2;
00159    uint32_t padding;
00160 } Rx63nRxDmaDesc;
00161 
00162 
00163 //RX63N Ethernet MAC driver
00164 extern const NicDriver rx63nEthDriver;
00165 
00166 //RX63N Ethernet MAC related functions
00167 error_t rx63nEthInit(NetInterface *interface);
00168 void rx63nEthInitGpio(NetInterface *interface);
00169 void rx63nEthInitDmaDesc(NetInterface *interface);
00170 
00171 void rx63nEthTick(NetInterface *interface);
00172 
00173 void rx63nEthEnableIrq(NetInterface *interface);
00174 void rx63nEthDisableIrq(NetInterface *interface);
00175 void rx63nEthEventHandler(NetInterface *interface);
00176 
00177 error_t rx63nEthSendPacket(NetInterface *interface,
00178    const NetBuffer *buffer, size_t offset);
00179 
00180 error_t rx63nEthReceivePacket(NetInterface *interface);
00181 
00182 error_t rx63nEthSetMulticastFilter(NetInterface *interface);
00183 error_t rx63nEthUpdateMacConfig(NetInterface *interface);
00184 
00185 void rx63nEthWritePhyReg(uint8_t phyAddr, uint8_t regAddr, uint16_t data);
00186 uint16_t rx63nEthReadPhyReg(uint8_t phyAddr, uint8_t regAddr);
00187 
00188 void rx63nEthWriteSmi(uint32_t data, uint_t length);
00189 uint32_t rx63nEthReadSmi(uint_t length);
00190 
00191 #endif
00192