/*
* (C) Copyright 2007 Pengutronix, Sascha Hauer <s.hauer@pengutronix.de>
* (C) Copyright 2007 Pengutronix, Juergen Beisert <j.beisert@pengutronix.de>
*
* (C) Copyright 2003
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
*
* This file is based on mpc4200fec.h
* (C) Copyright Motorola, Inc., 2000
*
* 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., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*/
#ifndef __IMX27_FEC_H
#define __IMX27_FEC_H
/**
* Layout description of the FEC
*/
typedef struct ethernet_register_set {
/* [10:2]addr = 00 */
/* Control and status Registers (offset 000-1FF) */
uint32_t fec_id; /* MBAR_ETH + 0x000 */
uint32_t ievent; /* MBAR_ETH + 0x004 */
uint32_t imask; /* MBAR_ETH + 0x008 */
uint32_t RES0[1]; /* MBAR_ETH + 0x00C */
uint32_t r_des_active; /* MBAR_ETH + 0x010 */
uint32_t x_des_active; /* MBAR_ETH + 0x014 */
uint32_t r_des_active_cl; /* MBAR_ETH + 0x018 */
uint32_t x_des_active_cl; /* MBAR_ETH + 0x01C */
uint32_t ivent_set; /* MBAR_ETH + 0x020 */
uint32_t ecntrl; /* MBAR_ETH + 0x024 */
uint32_t RES1[6]; /* MBAR_ETH + 0x028-03C */
uint32_t mii_data; /* MBAR_ETH + 0x040 */
uint32_t mii_speed; /* MBAR_ETH + 0x044 */
uint32_t mii_status; /* MBAR_ETH + 0x048 */
uint32_t RES2[5]; /* MBAR_ETH + 0x04C-05C */
uint32_t mib_data; /* MBAR_ETH + 0x060 */
uint32_t mib_control; /* MBAR_ETH + 0x064 */
uint32_t RES3[6]; /* MBAR_ETH + 0x068-7C */
uint32_t r_activate; /* MBAR_ETH + 0x080 */
uint32_t r_cntrl; /* MBAR_ETH + 0x084 */
uint32_t r_hash; /* MBAR_ETH + 0x088 */
uint32_t r_data; /* MBAR_ETH + 0x08C */
uint32_t ar_done; /* MBAR_ETH + 0x090 */
uint32_t r_test; /* MBAR_ETH + 0x094 */
uint32_t r_mib; /* MBAR_ETH + 0x098 */
uint32_t r_da_low; /* MBAR_ETH + 0x09C */
uint32_t r_da_high; /* MBAR_ETH + 0x0A0 */
uint32_t RES4[7]; /* MBAR_ETH + 0x0A4-0BC */
uint32_t x_activate; /* MBAR_ETH + 0x0C0 */
uint32_t x_cntrl; /* MBAR_ETH + 0x0C4 */
uint32_t backoff; /* MBAR_ETH + 0x0C8 */
uint32_t x_data; /* MBAR_ETH + 0x0CC */
uint32_t x_status; /* MBAR_ETH + 0x0D0 */
uint32_t x_mib; /* MBAR_ETH + 0x0D4 */
uint32_t x_test; /* MBAR_ETH + 0x0D8 */
uint32_t fdxfc_da1; /* MBAR_ETH + 0x0DC */
uint32_t fdxfc_da2; /* MBAR_ETH + 0x0E0 */
uint32_t paddr1; /* MBAR_ETH + 0x0E4 */
uint32_t paddr2; /* MBAR_ETH + 0x0E8 */
uint32_t op_pause; /* MBAR_ETH + 0x0EC */
uint32_t RES5[4]; /* MBAR_ETH + 0x0F0-0FC */
uint32_t instr_reg; /* MBAR_ETH + 0x100 */
uint32_t context_reg; /* MBAR_ETH + 0x104 */
uint32_t test_cntrl; /* MBAR_ETH + 0x108 */
uint32_t acc_reg; /* MBAR_ETH + 0x10C */
uint32_t ones; /* MBAR_ETH + 0x110 */
uint32_t zeros; /* MBAR_ETH + 0x114 */
uint32_t iaddr1; /* MBAR_ETH + 0x118 */
uint32_t iaddr2; /* MBAR_ETH + 0x11C */
uint32_t gaddr1; /* MBAR_ETH + 0x120 */
uint32_t gaddr2; /* MBAR_ETH + 0x124 */
uint32_t random; /* MBAR_ETH + 0x128 */
uint32_t rand1; /* MBAR_ETH + 0x12C */
uint32_t tmp; /* MBAR_ETH + 0x130 */
uint32_t RES6[3]; /* MBAR_ETH + 0x134-13C */
uint32_t fifo_id; /* MBAR_ETH + 0x140 */
uint32_t x_wmrk; /* MBAR_ETH + 0x144 */
uint32_t fcntrl; /* MBAR_ETH + 0x148 */
uint32_t r_bound; /* MBAR_ETH + 0x14C */
uint32_t r_fstart; /* MBAR_ETH + 0x150 */
uint32_t r_count; /* MBAR_ETH + 0x154 */
uint32_t r_lag; /* MBAR_ETH + 0x158 */
uint32_t r_read; /* MBAR_ETH + 0x15C */
uint32_t r_write; /* MBAR_ETH + 0x160 */
uint32_t x_count; /* MBAR_ETH + 0x164 */
uint32_t x_lag; /* MBAR_ETH + 0x168 */
uint32_t x_retry; /* MBAR_ETH + 0x16C */
uint32_t x_write; /* MBAR_ETH + 0x170 */
uint32_t x_read; /* MBAR_ETH + 0x174 */
uint32_t RES7[2]; /* MBAR_ETH + 0x178-17C */
uint32_t fm_cntrl; /* MBAR_ETH + 0x180 */
#define erdsr fm_cntrl
uint32_t rfifo_data; /* MBAR_ETH + 0x184 */
#define etdsr rfifo_data
uint32_t rfifo_status; /* MBAR_ETH + 0x188 */
#define emrbr rfifo_status
uint32_t rfifo_cntrl; /* MBAR_ETH + 0x18C */
uint32_t rfifo_lrf_ptr; /* MBAR_ETH + 0x190 */
uint32_t rfifo_lwf_ptr; /* MBAR_ETH + 0x194 */
uint32_t rfifo_alarm; /* MBAR_ETH + 0x198 */
uint32_t rfifo_rdptr; /* MBAR_ETH + 0x19C */
uint32_t rfifo_wrptr; /* MBAR_ETH + 0x1A0 */
uint32_t tfifo_data; /* MBAR_ETH + 0x1A4 */
uint32_t tfifo_status; /* MBAR_ETH + 0x1A8 */
uint32_t tfifo_cntrl; /* MBAR_ETH + 0x1AC */
uint32_t tfifo_lrf_ptr; /* MBAR_ETH + 0x1B0 */
uint32_t tfifo_lwf_ptr; /* MBAR_ETH + 0x1B4 */
uint32_t tfifo_alarm; /* MBAR_ETH + 0x1B8 */
uint32_t tfifo_rdptr; /* MBAR_ETH + 0x1BC */
uint32_t tfifo_wrptr; /* MBAR_ETH + 0x1C0 */
uint32_t reset_cntrl; /* MBAR_ETH + 0x1C4 */
uint32_t xmit_fsm; /* MBAR_ETH + 0x1C8 */
uint32_t RES8[3]; /* MBAR_ETH + 0x1CC-1D4 */
uint32_t rdes_data0; /* MBAR_ETH + 0x1D8 */
uint32_t rdes_data1; /* MBAR_ETH + 0x1DC */
uint32_t r_length; /* MBAR_ETH + 0x1E0 */
uint32_t x_length; /* MBAR_ETH + 0x1E4 */
uint32_t x_addr; /* MBAR_ETH + 0x1E8 */
uint32_t cdes_data; /* MBAR_ETH + 0x1EC */
uint32_t status; /* MBAR_ETH + 0x1F0 */
uint32_t dma_control; /* MBAR_ETH + 0x1F4 */
uint32_t des_cmnd; /* MBAR_ETH + 0x1F8 */
uint32_t data; /* MBAR_ETH + 0x1FC */
/* MIB COUNTERS (Offset 200-2FF) */
uint32_t rmon_t_drop; /* MBAR_ETH + 0x200 */
uint32_t rmon_t_packets; /* MBAR_ETH + 0x204 */
uint32_t rmon_t_bc_pkt; /* MBAR_ETH + 0x208 */
uint32_t rmon_t_mc_pkt; /* MBAR_ETH + 0x20C */
uint32_t rmon_t_crc_align; /* MBAR_ETH + 0x210 */
uint32_t rmon_t_undersize; /* MBAR_ETH + 0x214 */
uint32_t rmon_t_oversize; /* MBAR_ETH + 0x218 */
uint32_t rmon_t_frag; /* MBAR_ETH + 0x21C */
uint32_t rmon_t_jab; /* MBAR_ETH + 0x220 */
uint32_t rmon_t_col; /* MBAR_ETH + 0x224 */
uint32_t rmon_t_p64; /* MBAR_ETH + 0x228 */
uint32_t rmon_t_p65to127; /* MBAR_ETH + 0x22C */
uint32_t rmon_t_p128to255; /* MBAR_ETH + 0x230 */
uint32_t rmon_t_p256to511; /* MBAR_ETH + 0x234 */
uint32_t rmon_t_p512to1023; /* MBAR_ETH + 0x238 */
uint32_t rmon_t_p1024to2047; /* MBAR_ETH + 0x23C */
uint32_t rmon_t_p_gte2048; /* MBAR_ETH + 0x240 */
uint32_t rmon_t_octets; /* MBAR_ETH + 0x244 */
uint32_t ieee_t_drop; /* MBAR_ETH + 0x248 */
uint32_t ieee_t_frame_ok; /* MBAR_ETH + 0x24C */
uint32_t ieee_t_1col; /* MBAR_ETH + 0x250 */
uint32_t ieee_t_mcol; /* MBAR_ETH + 0x254 */
uint32_t ieee_t_def; /* MBAR_ETH + 0x258 */
uint32_t ieee_t_lcol; /* MBAR_ETH + 0x25C */
uint32_t ieee_t_excol; /* MBAR_ETH + 0x260 */
uint32_t ieee_t_macerr; /* MBAR_ETH + 0x264 */
uint32_t ieee_t_cserr; /* MBAR_ETH + 0x268 */
uint32_t ieee_t_sqe; /* MBAR_ETH + 0x26C */
uint32_t t_fdxfc; /* MBAR_ETH + 0x270 */
uint32_t ieee_t_octets_ok; /* MBAR_ETH + 0x274 */
uint32_t RES9[2]; /* MBAR_ETH + 0x278-27C */
uint32_t rmon_r_drop; /* MBAR_ETH + 0x280 */
uint32_t rmon_r_packets; /* MBAR_ETH + 0x284 */
uint32_t rmon_r_bc_pkt; /* MBAR_ETH + 0x288 */
uint32_t rmon_r_mc_pkt; /* MBAR_ETH + 0x28C */
uint32_t rmon_r_crc_align; /* MBAR_ETH + 0x290 */
uint32_t rmon_r_undersize; /* MBAR_ETH + 0x294 */
uint32_t rmon_r_oversize; /* MBAR_ETH + 0x298 */
uint32_t rmon_r_frag; /* MBAR_ETH + 0x29C */
uint32_t rmon_r_jab; /* MBAR_ETH + 0x2A0 */
uint32_t rmon_r_resvd_0; /* MBAR_ETH + 0x2A4 */
uint32_t rmon_r_p64; /* MBAR_ETH + 0x2A8 */
uint32_t rmon_r_p65to127; /* MBAR_ETH + 0x2AC */
uint32_t rmon_r_p128to255; /* MBAR_ETH + 0x2B0 */
uint32_t rmon_r_p256to511; /* MBAR_ETH + 0x2B4 */
uint32_t rmon_r_p512to1023; /* MBAR_ETH + 0x2B8 */
uint32_t rmon_r_p1024to2047; /* MBAR_ETH + 0x2BC */
uint32_t rmon_r_p_gte2048; /* MBAR_ETH + 0x2C0 */
uint32_t rmon_r_octets; /* MBAR_ETH + 0x2C4 */
uint32_t ieee_r_drop; /* MBAR_ETH + 0x2C8 */
uint32_t ieee_r_frame_ok; /* MBAR_ETH + 0x2CC */
uint32_t ieee_r_crc; /* MBAR_ETH + 0x2D0 */
uint32_t ieee_r_align; /* MBAR_ETH + 0x2D4 */
uint32_t r_macerr; /* MBAR_ETH + 0x2D8 */
uint32_t r_fdxfc; /* MBAR_ETH + 0x2DC */
uint32_t ieee_r_octets_ok; /* MBAR_ETH + 0x2E0 */
uint32_t RES10[6]; /* MBAR_ETH + 0x2E4-2FC */
uint32_t RES11[64]; /* MBAR_ETH + 0x300-3FF */
} ethernet_regs;
#define FEC_IEVENT_HBERR 0x80000000
#define FEC_IEVENT_BABR 0x40000000
#define FEC_IEVENT_BABT 0x20000000
#define FEC_IEVENT_GRA 0x10000000
#define FEC_IEVENT_TFINT 0x08000000
#define FEC_IEVENT_MII 0x00800000
#define FEC_IEVENT_LATE_COL 0x00200000
#define FEC_IEVENT_COL_RETRY_LIM 0x00100000
#define FEC_IEVENT_XFIFO_UN 0x00080000
#define FEC_IEVENT_XFIFO_ERROR 0x00040000
#define FEC_IEVENT_RFIFO_ERROR 0x00020000
#define FEC_IMASK_HBERR 0x80000000
#define FEC_IMASK_BABR 0x40000000
#define FEC_IMASK_BABT 0x20000000
#define FEC_IMASK_GRA 0x10000000
#define FEC_IMASK_MII 0x00800000
#define FEC_IMASK_LATE_COL 0x00200000
#define FEC_IMASK_COL_RETRY_LIM 0x00100000
#define FEC_IMASK_XFIFO_UN 0x00080000
#define FEC_IMASK_XFIFO_ERROR 0x00040000
#define FEC_IMASK_RFIFO_ERROR 0x00020000
#define FEC_RCNTRL_MAX_FL_SHIFT 16
#define FEC_RCNTRL_LOOP 0x01
#define FEC_RCNTRL_DRT 0x02
#define FEC_RCNTRL_MII_MODE 0x04
#define FEC_RCNTRL_PROM 0x08
#define FEC_RCNTRL_BC_REJ 0x10
#define FEC_RCNTRL_FCE 0x20
#define FEC_TCNTRL_GTS 0x00000001
#define FEC_TCNTRL_HBC 0x00000002
#define FEC_TCNTRL_FDEN 0x00000004
#define FEC_TCNTRL_TFC_PAUSE 0x00000008
#define FEC_TCNTRL_RFC_PAUSE 0x00000010
#define FEC_ECNTRL_RESET 0x00000001 /**< reset the FEC */
#define FEC_ECNTRL_ETHER_EN 0x00000002 /**< enable the FEC */
/**
* @brief Descriptor buffer alignment
*
* i.MX27 requires a 16 byte alignment (but for the first element only)
*/
#define DB_ALIGNMENT 16
/**
* @brief Data buffer alignment
*
* i.MX27 requires a four byte alignment
*
* Note: Valid for member data_pointer in struct buffer_descriptor
*/
#define DB_DATA_ALIGNMENT 4
/**
* @brief Receive & Transmit Buffer Descriptor definitions
*
* Note: The first BD must be aligned (see DB_ALIGNMENT)
*/
typedef struct buffer_descriptor {
uint16_t data_length; /**< payload's length in bytes */
uint16_t status; /**< BD's staus (see datasheet) */
uint32_t data_pointer; /**< payload's buffer address */
} FEC_BD;
/**
* @brief i.MX27-FEC private structure
*/
typedef struct {
ethernet_regs *eth; /**< pointer to register'S base */
xceiver_type xcv_type; /**< transceiver type */
FEC_BD *rbd_base; /**< RBD ring */
int rbd_index; /**< next receive BD to read */
FEC_BD *tbd_base; /**< TBD ring */
int tbd_index; /**< next transmit BD to write */
struct miiphy_device miiphy;
} fec_priv;
/**
* @brief Numbers of buffer descriptors for receiving
*
* The number defines the stocked memory buffers for the receiving task.
* Larger values makes no sense in this limited environment.
*/
#define FEC_RBD_NUM 64
/**
* @brief Define the ethernet packet size limit in memory
*
* Note: Do not shrink this number. This will force the FEC to spread larger
* frames in more than one BD. This is nothing to worry about, but the current
* driver can't handle it.
*/
#define FEC_MAX_PKT_SIZE 1536
/* Receive BD status bits */
#define FEC_RBD_EMPTY 0x8000 /**< Receive BD status: Buffer is empty */
#define FEC_RBD_WRAP 0x2000 /**< Receive BD status: Last BD in ring */
#define FEC_RBD_INT 0x1000 /**< Receive BD status: Interrupt */
#define FEC_RBD_LAST 0x0800 /**< Receive BD status: Buffer is last in frame (useless here!) */
#define FEC_RBD_MISS 0x0100 /**< Receive BD status: Miss bit for prom mode */
#define FEC_RBD_BC 0x0080 /**< Receive BD status: The received frame is broadcast frame */
#define FEC_RBD_MC 0x0040 /**< Receive BD status: The received frame is multicast frame */
#define FEC_RBD_LG 0x0020 /**< Receive BD status: Frame length violation */
#define FEC_RBD_NO 0x0010 /**< Receive BD status: Nonoctet align frame */
#define FEC_RBD_SH 0x0008 /**< Receive BD status: Short frame */
#define FEC_RBD_CR 0x0004 /**< Receive BD status: CRC error */
#define FEC_RBD_OV 0x0002 /**< Receive BD status: Receive FIFO overrun */
#define FEC_RBD_TR 0x0001 /**< Receive BD status: Frame is truncated */
#define FEC_RBD_ERR (FEC_RBD_LG | FEC_RBD_NO | FEC_RBD_CR | \
FEC_RBD_OV | FEC_RBD_TR)
/* Transmit BD status bits */
#define FEC_TBD_READY 0x8000 /**< Tansmit BD status: Buffer is ready */
#define FEC_TBD_WRAP 0x2000 /**< Tansmit BD status: Mark as last BD in ring */
#define FEC_TBD_INT 0x1000 /**< Tansmit BD status: Interrupt */
#define FEC_TBD_LAST 0x0800 /**< Tansmit BD status: Buffer is last in frame */
#define FEC_TBD_TC 0x0400 /**< Tansmit BD status: Transmit the CRC */
#define FEC_TBD_ABC 0x0200 /**< Tansmit BD status: Append bad CRC */
/* MII-related definitios */
#define FEC_MII_DATA_ST 0x40000000 /**< Start of frame delimiter */
#define FEC_MII_DATA_OP_RD 0x20000000 /**< Perform a read operation */
#define FEC_MII_DATA_OP_WR 0x10000000 /**< Perform a write operation */
#define FEC_MII_DATA_PA_MSK 0x0f800000 /**< PHY Address field mask */
#define FEC_MII_DATA_RA_MSK 0x007c0000 /**< PHY Register field mask */
#define FEC_MII_DATA_TA 0x00020000 /**< Turnaround */
#define FEC_MII_DATA_DATAMSK 0x0000ffff /**< PHY data field */
#define FEC_MII_DATA_RA_SHIFT 18 /* MII Register address bits */
#define FEC_MII_DATA_PA_SHIFT 23 /* MII PHY address bits */
#endif /* __IMX27_FEC_H */
/**
* @file
* @brief Definitions for the FEC driver (i.MX27)
*/
