net: calxedaxgmac: fix condition in xgmac_set_features()
[deliverable/linux.git] / drivers / net / ethernet / freescale / fec.h
CommitLineData
1da177e4
LT
1/****************************************************************************/
2
3/*
7a77d918
GU
4 * fec.h -- Fast Ethernet Controller for Motorola ColdFire SoC
5 * processors.
1da177e4 6 *
7a77d918 7 * (C) Copyright 2000-2005, Greg Ungerer (gerg@snapgear.com)
1da177e4
LT
8 * (C) Copyright 2000-2001, Lineo (www.lineo.com)
9 */
10
11/****************************************************************************/
12#ifndef FEC_H
13#define FEC_H
14/****************************************************************************/
15
6605b730
FL
16#include <linux/clocksource.h>
17#include <linux/net_tstamp.h>
18#include <linux/ptp_clock_kernel.h>
6605b730 19
7a77d918 20#if defined(CONFIG_M523x) || defined(CONFIG_M527x) || defined(CONFIG_M528x) || \
b5680e0b
SG
21 defined(CONFIG_M520x) || defined(CONFIG_M532x) || \
22 defined(CONFIG_ARCH_MXC) || defined(CONFIG_SOC_IMX28)
1da177e4
LT
23/*
24 * Just figures, Motorola would have to change the offsets for
25 * registers in the same peripheral device on different models
26 * of the ColdFire!
27 */
f44d6305
SH
28#define FEC_IEVENT 0x004 /* Interrupt event reg */
29#define FEC_IMASK 0x008 /* Interrupt mask reg */
30#define FEC_R_DES_ACTIVE 0x010 /* Receive descriptor reg */
31#define FEC_X_DES_ACTIVE 0x014 /* Transmit descriptor reg */
32#define FEC_ECNTRL 0x024 /* Ethernet control reg */
33#define FEC_MII_DATA 0x040 /* MII manage frame reg */
34#define FEC_MII_SPEED 0x044 /* MII speed control reg */
35#define FEC_MIB_CTRLSTAT 0x064 /* MIB control/status reg */
36#define FEC_R_CNTRL 0x084 /* Receive control reg */
37#define FEC_X_CNTRL 0x0c4 /* Transmit Control reg */
38#define FEC_ADDR_LOW 0x0e4 /* Low 32bits MAC address */
39#define FEC_ADDR_HIGH 0x0e8 /* High 16bits MAC address */
40#define FEC_OPD 0x0ec /* Opcode + Pause duration */
41#define FEC_HASH_TABLE_HIGH 0x118 /* High 32bits hash table */
42#define FEC_HASH_TABLE_LOW 0x11c /* Low 32bits hash table */
43#define FEC_GRP_HASH_TABLE_HIGH 0x120 /* High 32bits hash table */
44#define FEC_GRP_HASH_TABLE_LOW 0x124 /* Low 32bits hash table */
45#define FEC_X_WMRK 0x144 /* FIFO transmit water mark */
46#define FEC_R_BOUND 0x14c /* FIFO receive bound reg */
47#define FEC_R_FSTART 0x150 /* FIFO receive start reg */
48#define FEC_R_DES_START 0x180 /* Receive descriptor ring */
49#define FEC_X_DES_START 0x184 /* Transmit descriptor ring */
50#define FEC_R_BUFF_SIZE 0x188 /* Maximum receive buff size */
baa70a5c
FL
51#define FEC_R_FIFO_RSFL 0x190 /* Receive FIFO section full threshold */
52#define FEC_R_FIFO_RSEM 0x194 /* Receive FIFO section empty threshold */
53#define FEC_R_FIFO_RAEM 0x198 /* Receive FIFO almost empty threshold */
54#define FEC_R_FIFO_RAFL 0x19c /* Receive FIFO almost full threshold */
5eb32bd0
BS
55#define FEC_MIIGSK_CFGR 0x300 /* MIIGSK Configuration reg */
56#define FEC_MIIGSK_ENR 0x308 /* MIIGSK Enable reg */
1da177e4 57
8d82f219
EB
58#define BM_MIIGSK_CFGR_MII 0x00
59#define BM_MIIGSK_CFGR_RMII 0x01
60#define BM_MIIGSK_CFGR_FRCONT_10M 0x40
61
1da177e4
LT
62#else
63
9ff1a91c
GU
64#define FEC_ECNTRL 0x000 /* Ethernet control reg */
65#define FEC_IEVENT 0x004 /* Interrupt even reg */
66#define FEC_IMASK 0x008 /* Interrupt mask reg */
67#define FEC_IVEC 0x00c /* Interrupt vec status reg */
68#define FEC_R_DES_ACTIVE 0x010 /* Receive descriptor reg */
5ca1ea23 69#define FEC_X_DES_ACTIVE 0x014 /* Transmit descriptor reg */
f44d6305
SH
70#define FEC_MII_DATA 0x040 /* MII manage frame reg */
71#define FEC_MII_SPEED 0x044 /* MII speed control reg */
72#define FEC_R_BOUND 0x08c /* FIFO receive bound reg */
73#define FEC_R_FSTART 0x090 /* FIFO receive start reg */
74#define FEC_X_WMRK 0x0a4 /* FIFO transmit water mark */
75#define FEC_X_FSTART 0x0ac /* FIFO transmit start reg */
76#define FEC_R_CNTRL 0x104 /* Receive control reg */
77#define FEC_MAX_FRM_LEN 0x108 /* Maximum frame length reg */
78#define FEC_X_CNTRL 0x144 /* Transmit Control reg */
79#define FEC_ADDR_LOW 0x3c0 /* Low 32bits MAC address */
80#define FEC_ADDR_HIGH 0x3c4 /* High 16bits MAC address */
81#define FEC_GRP_HASH_TABLE_HIGH 0x3c8 /* High 32bits hash table */
82#define FEC_GRP_HASH_TABLE_LOW 0x3cc /* Low 32bits hash table */
83#define FEC_R_DES_START 0x3d0 /* Receive descriptor ring */
84#define FEC_X_DES_START 0x3d4 /* Transmit descriptor ring */
85#define FEC_R_BUFF_SIZE 0x3d8 /* Maximum receive buff size */
86#define FEC_FIFO_RAM 0x400 /* FIFO RAM buffer */
1da177e4
LT
87
88#endif /* CONFIG_M5272 */
89
90
91/*
92 * Define the buffer descriptor structure.
93 */
b5680e0b 94#if defined(CONFIG_ARCH_MXC) || defined(CONFIG_SOC_IMX28)
2e28532f 95struct bufdesc {
196719ec
SH
96 unsigned short cbd_datlen; /* Data length */
97 unsigned short cbd_sc; /* Control and status info */
98 unsigned long cbd_bufaddr; /* Buffer address */
ff43da86 99};
acac8406
FL
100#else
101struct bufdesc {
102 unsigned short cbd_sc; /* Control and status info */
103 unsigned short cbd_datlen; /* Data length */
104 unsigned long cbd_bufaddr; /* Buffer address */
105};
106#endif
ff43da86
FL
107
108struct bufdesc_ex {
109 struct bufdesc desc;
6605b730
FL
110 unsigned long cbd_esc;
111 unsigned long cbd_prot;
112 unsigned long cbd_bdu;
113 unsigned long ts;
114 unsigned short res0[4];
2e28532f 115};
ff43da86 116
1da177e4
LT
117/*
118 * The following definitions courtesy of commproc.h, which where
119 * Copyright (c) 1997 Dan Malek (dmalek@jlc.net).
120 */
25985edc 121#define BD_SC_EMPTY ((ushort)0x8000) /* Receive is empty */
1da177e4
LT
122#define BD_SC_READY ((ushort)0x8000) /* Transmit is ready */
123#define BD_SC_WRAP ((ushort)0x2000) /* Last buffer descriptor */
124#define BD_SC_INTRPT ((ushort)0x1000) /* Interrupt on change */
25985edc 125#define BD_SC_CM ((ushort)0x0200) /* Continuous mode */
1da177e4
LT
126#define BD_SC_ID ((ushort)0x0100) /* Rec'd too many idles */
127#define BD_SC_P ((ushort)0x0100) /* xmt preamble */
128#define BD_SC_BR ((ushort)0x0020) /* Break received */
129#define BD_SC_FR ((ushort)0x0010) /* Framing error */
130#define BD_SC_PR ((ushort)0x0008) /* Parity error */
131#define BD_SC_OV ((ushort)0x0002) /* Overrun */
132#define BD_SC_CD ((ushort)0x0001) /* ?? */
133
134/* Buffer descriptor control/status used by Ethernet receive.
135*/
136#define BD_ENET_RX_EMPTY ((ushort)0x8000)
137#define BD_ENET_RX_WRAP ((ushort)0x2000)
138#define BD_ENET_RX_INTR ((ushort)0x1000)
139#define BD_ENET_RX_LAST ((ushort)0x0800)
140#define BD_ENET_RX_FIRST ((ushort)0x0400)
141#define BD_ENET_RX_MISS ((ushort)0x0100)
142#define BD_ENET_RX_LG ((ushort)0x0020)
143#define BD_ENET_RX_NO ((ushort)0x0010)
144#define BD_ENET_RX_SH ((ushort)0x0008)
145#define BD_ENET_RX_CR ((ushort)0x0004)
146#define BD_ENET_RX_OV ((ushort)0x0002)
147#define BD_ENET_RX_CL ((ushort)0x0001)
148#define BD_ENET_RX_STATS ((ushort)0x013f) /* All status bits */
149
150/* Buffer descriptor control/status used by Ethernet transmit.
151*/
152#define BD_ENET_TX_READY ((ushort)0x8000)
153#define BD_ENET_TX_PAD ((ushort)0x4000)
154#define BD_ENET_TX_WRAP ((ushort)0x2000)
155#define BD_ENET_TX_INTR ((ushort)0x1000)
156#define BD_ENET_TX_LAST ((ushort)0x0800)
157#define BD_ENET_TX_TC ((ushort)0x0400)
158#define BD_ENET_TX_DEF ((ushort)0x0200)
159#define BD_ENET_TX_HB ((ushort)0x0100)
160#define BD_ENET_TX_LC ((ushort)0x0080)
161#define BD_ENET_TX_RL ((ushort)0x0040)
162#define BD_ENET_TX_RCMASK ((ushort)0x003c)
163#define BD_ENET_TX_UN ((ushort)0x0002)
164#define BD_ENET_TX_CSL ((ushort)0x0001)
165#define BD_ENET_TX_STATS ((ushort)0x03ff) /* All status bits */
166
405f257f
FL
167/*enhanced buffer desciptor control/status used by Ethernet transmit*/
168#define BD_ENET_TX_INT 0x40000000
169#define BD_ENET_TX_TS 0x20000000
170
171
172/* This device has up to three irqs on some platforms */
173#define FEC_IRQ_NUM 3
174
175/* The number of Tx and Rx buffers. These are allocated from the page
176 * pool. The code may assume these are power of two, so it it best
177 * to keep them that size.
178 * We don't need to allocate pages for the transmitter. We just use
179 * the skbuffer directly.
180 */
181
182#define FEC_ENET_RX_PAGES 8
183#define FEC_ENET_RX_FRSIZE 2048
184#define FEC_ENET_RX_FRPPG (PAGE_SIZE / FEC_ENET_RX_FRSIZE)
185#define RX_RING_SIZE (FEC_ENET_RX_FRPPG * FEC_ENET_RX_PAGES)
186#define FEC_ENET_TX_FRSIZE 2048
187#define FEC_ENET_TX_FRPPG (PAGE_SIZE / FEC_ENET_TX_FRSIZE)
188#define TX_RING_SIZE 16 /* Must be power of two */
189#define TX_RING_MOD_MASK 15 /* for this to work */
190
191#define BD_ENET_RX_INT 0x00800000
192#define BD_ENET_RX_PTP ((ushort)0x0400)
193
194/* The FEC buffer descriptors track the ring buffers. The rx_bd_base and
195 * tx_bd_base always point to the base of the buffer descriptors. The
196 * cur_rx and cur_tx point to the currently available buffer.
197 * The dirty_tx tracks the current buffer that is being sent by the
198 * controller. The cur_tx and dirty_tx are equal under both completely
199 * empty and completely full conditions. The empty/ready indicator in
200 * the buffer descriptor determines the actual condition.
201 */
202struct fec_enet_private {
203 /* Hardware registers of the FEC device */
204 void __iomem *hwp;
205
206 struct net_device *netdev;
207
208 struct clk *clk_ipg;
209 struct clk *clk_ahb;
6605b730 210 struct clk *clk_ptp;
405f257f
FL
211
212 /* The saved address of a sent-in-place packet/buffer, for skfree(). */
213 unsigned char *tx_bounce[TX_RING_SIZE];
214 struct sk_buff *tx_skbuff[TX_RING_SIZE];
215 struct sk_buff *rx_skbuff[RX_RING_SIZE];
405f257f
FL
216
217 /* CPM dual port RAM relative addresses */
218 dma_addr_t bd_dma;
219 /* Address of Rx and Tx buffers */
220 struct bufdesc *rx_bd_base;
221 struct bufdesc *tx_bd_base;
222 /* The next free ring entry */
223 struct bufdesc *cur_rx, *cur_tx;
224 /* The ring entries to be free()ed */
225 struct bufdesc *dirty_tx;
226
405f257f
FL
227 /* hold while accessing the HW like ringbuffer for tx/rx but not MAC */
228 spinlock_t hw_lock;
229
230 struct platform_device *pdev;
231
232 int opened;
233 int dev_id;
234
235 /* Phylib and MDIO interface */
236 struct mii_bus *mii_bus;
237 struct phy_device *phy_dev;
238 int mii_timeout;
239 uint phy_speed;
240 phy_interface_t phy_interface;
241 int link;
242 int full_duplex;
d97e7497 243 int speed;
405f257f
FL
244 struct completion mdio_done;
245 int irq[FEC_IRQ_NUM];
ff43da86 246 int bufdesc_ex;
baa70a5c 247 int pause_flag;
6605b730 248
dc975382
FL
249 struct napi_struct napi;
250
6605b730
FL
251 struct ptp_clock *ptp_clock;
252 struct ptp_clock_info ptp_caps;
253 unsigned long last_overflow_check;
254 spinlock_t tmreg_lock;
255 struct cyclecounter cc;
256 struct timecounter tc;
257 int rx_hwtstamp_filter;
258 u32 base_incval;
259 u32 cycle_speed;
260 int hwts_rx_en;
261 int hwts_tx_en;
262 struct timer_list time_keep;
6605b730 263
405f257f 264};
1da177e4 265
6605b730
FL
266void fec_ptp_init(struct net_device *ndev, struct platform_device *pdev);
267void fec_ptp_start_cyclecounter(struct net_device *ndev);
268int fec_ptp_ioctl(struct net_device *ndev, struct ifreq *ifr, int cmd);
6605b730 269
1da177e4
LT
270/****************************************************************************/
271#endif /* FEC_H */
This page took 0.756808 seconds and 5 git commands to generate.