Merge branch 'linus' into irq/genirq
[linux-2.6] / drivers / net / sunqe.h
1 /* $Id: sunqe.h,v 1.13 2000/02/09 11:15:42 davem Exp $
2  * sunqe.h: Definitions for the Sun QuadEthernet driver.
3  *
4  * Copyright (C) 1996 David S. Miller (davem@caip.rutgers.edu)
5  */
6
7 #ifndef _SUNQE_H
8 #define _SUNQE_H
9
10 /* QEC global registers. */
11 #define GLOB_CTRL       0x00UL          /* Control                      */
12 #define GLOB_STAT       0x04UL          /* Status                       */
13 #define GLOB_PSIZE      0x08UL          /* Packet Size                  */
14 #define GLOB_MSIZE      0x0cUL          /* Local-memory Size            */
15 #define GLOB_RSIZE      0x10UL          /* Receive partition size       */
16 #define GLOB_TSIZE      0x14UL          /* Transmit partition size      */
17 #define GLOB_REG_SIZE   0x18UL
18
19 #define GLOB_CTRL_MMODE       0x40000000 /* MACE qec mode            */
20 #define GLOB_CTRL_BMODE       0x10000000 /* BigMAC qec mode          */
21 #define GLOB_CTRL_EPAR        0x00000020 /* Enable parity            */
22 #define GLOB_CTRL_ACNTRL      0x00000018 /* SBUS arbitration control */
23 #define GLOB_CTRL_B64         0x00000004 /* 64 byte dvma bursts      */
24 #define GLOB_CTRL_B32         0x00000002 /* 32 byte dvma bursts      */
25 #define GLOB_CTRL_B16         0x00000000 /* 16 byte dvma bursts      */
26 #define GLOB_CTRL_RESET       0x00000001 /* Reset the QEC            */
27
28 #define GLOB_STAT_TX          0x00000008 /* BigMAC Transmit IRQ      */
29 #define GLOB_STAT_RX          0x00000004 /* BigMAC Receive IRQ       */
30 #define GLOB_STAT_BM          0x00000002 /* BigMAC Global IRQ        */
31 #define GLOB_STAT_ER          0x00000001 /* BigMAC Error IRQ         */
32
33 #define GLOB_PSIZE_2048       0x00       /* 2k packet size           */
34 #define GLOB_PSIZE_4096       0x01       /* 4k packet size           */
35 #define GLOB_PSIZE_6144       0x10       /* 6k packet size           */
36 #define GLOB_PSIZE_8192       0x11       /* 8k packet size           */
37
38 /* In MACE mode, there are four qe channels.  Each channel has it's own
39  * status bits in the QEC status register.  This macro picks out the
40  * ones you want.
41  */
42 #define GLOB_STAT_PER_QE(status, channel) (((status) >> ((channel) * 4)) & 0xf)
43
44 /* The following registers are for per-qe channel information/status. */
45 #define CREG_CTRL       0x00UL  /* Control                   */
46 #define CREG_STAT       0x04UL  /* Status                    */
47 #define CREG_RXDS       0x08UL  /* RX descriptor ring ptr    */
48 #define CREG_TXDS       0x0cUL  /* TX descriptor ring ptr    */
49 #define CREG_RIMASK     0x10UL  /* RX Interrupt Mask         */
50 #define CREG_TIMASK     0x14UL  /* TX Interrupt Mask         */
51 #define CREG_QMASK      0x18UL  /* QEC Error Interrupt Mask  */
52 #define CREG_MMASK      0x1cUL  /* MACE Error Interrupt Mask */
53 #define CREG_RXWBUFPTR  0x20UL  /* Local memory rx write ptr */
54 #define CREG_RXRBUFPTR  0x24UL  /* Local memory rx read ptr  */
55 #define CREG_TXWBUFPTR  0x28UL  /* Local memory tx write ptr */
56 #define CREG_TXRBUFPTR  0x2cUL  /* Local memory tx read ptr  */
57 #define CREG_CCNT       0x30UL  /* Collision Counter         */
58 #define CREG_PIPG       0x34UL  /* Inter-Frame Gap           */
59 #define CREG_REG_SIZE   0x38UL
60
61 #define CREG_CTRL_RXOFF       0x00000004  /* Disable this qe's receiver*/
62 #define CREG_CTRL_RESET       0x00000002  /* Reset this qe channel     */
63 #define CREG_CTRL_TWAKEUP     0x00000001  /* Transmitter Wakeup, 'go'. */
64
65 #define CREG_STAT_EDEFER      0x10000000  /* Excessive Defers          */
66 #define CREG_STAT_CLOSS       0x08000000  /* Carrier Loss              */
67 #define CREG_STAT_ERETRIES    0x04000000  /* More than 16 retries      */
68 #define CREG_STAT_LCOLL       0x02000000  /* Late TX Collision         */
69 #define CREG_STAT_FUFLOW      0x01000000  /* FIFO Underflow            */
70 #define CREG_STAT_JERROR      0x00800000  /* Jabber Error              */
71 #define CREG_STAT_BERROR      0x00400000  /* Babble Error              */
72 #define CREG_STAT_TXIRQ       0x00200000  /* Transmit Interrupt        */
73 #define CREG_STAT_CCOFLOW     0x00100000  /* TX Coll-counter Overflow  */
74 #define CREG_STAT_TXDERROR    0x00080000  /* TX Descriptor is bogus    */
75 #define CREG_STAT_TXLERR      0x00040000  /* Late Transmit Error       */
76 #define CREG_STAT_TXPERR      0x00020000  /* Transmit Parity Error     */
77 #define CREG_STAT_TXSERR      0x00010000  /* Transmit SBUS error ack   */
78 #define CREG_STAT_RCCOFLOW    0x00001000  /* RX Coll-counter Overflow  */
79 #define CREG_STAT_RUOFLOW     0x00000800  /* Runt Counter Overflow     */
80 #define CREG_STAT_MCOFLOW     0x00000400  /* Missed Counter Overflow   */
81 #define CREG_STAT_RXFOFLOW    0x00000200  /* RX FIFO Overflow          */
82 #define CREG_STAT_RLCOLL      0x00000100  /* RX Late Collision         */
83 #define CREG_STAT_FCOFLOW     0x00000080  /* Frame Counter Overflow    */
84 #define CREG_STAT_CECOFLOW    0x00000040  /* CRC Error-counter Overflow*/
85 #define CREG_STAT_RXIRQ       0x00000020  /* Receive Interrupt         */
86 #define CREG_STAT_RXDROP      0x00000010  /* Dropped a RX'd packet     */
87 #define CREG_STAT_RXSMALL     0x00000008  /* Receive buffer too small  */
88 #define CREG_STAT_RXLERR      0x00000004  /* Receive Late Error        */
89 #define CREG_STAT_RXPERR      0x00000002  /* Receive Parity Error      */
90 #define CREG_STAT_RXSERR      0x00000001  /* Receive SBUS Error ACK    */
91
92 #define CREG_STAT_ERRORS      (CREG_STAT_EDEFER|CREG_STAT_CLOSS|CREG_STAT_ERETRIES|     \
93                                CREG_STAT_LCOLL|CREG_STAT_FUFLOW|CREG_STAT_JERROR|       \
94                                CREG_STAT_BERROR|CREG_STAT_CCOFLOW|CREG_STAT_TXDERROR|   \
95                                CREG_STAT_TXLERR|CREG_STAT_TXPERR|CREG_STAT_TXSERR|      \
96                                CREG_STAT_RCCOFLOW|CREG_STAT_RUOFLOW|CREG_STAT_MCOFLOW| \
97                                CREG_STAT_RXFOFLOW|CREG_STAT_RLCOLL|CREG_STAT_FCOFLOW|   \
98                                CREG_STAT_CECOFLOW|CREG_STAT_RXDROP|CREG_STAT_RXSMALL|   \
99                                CREG_STAT_RXLERR|CREG_STAT_RXPERR|CREG_STAT_RXSERR)
100
101 #define CREG_QMASK_COFLOW     0x00100000  /* CollCntr overflow         */
102 #define CREG_QMASK_TXDERROR   0x00080000  /* TXD error                 */
103 #define CREG_QMASK_TXLERR     0x00040000  /* TX late error             */
104 #define CREG_QMASK_TXPERR     0x00020000  /* TX parity error           */
105 #define CREG_QMASK_TXSERR     0x00010000  /* TX sbus error ack         */
106 #define CREG_QMASK_RXDROP     0x00000010  /* RX drop                   */
107 #define CREG_QMASK_RXBERROR   0x00000008  /* RX buffer error           */
108 #define CREG_QMASK_RXLEERR    0x00000004  /* RX late error             */
109 #define CREG_QMASK_RXPERR     0x00000002  /* RX parity error           */
110 #define CREG_QMASK_RXSERR     0x00000001  /* RX sbus error ack         */
111
112 #define CREG_MMASK_EDEFER     0x10000000  /* Excess defer              */
113 #define CREG_MMASK_CLOSS      0x08000000  /* Carrier loss              */
114 #define CREG_MMASK_ERETRY     0x04000000  /* Excess retry              */
115 #define CREG_MMASK_LCOLL      0x02000000  /* Late collision error      */
116 #define CREG_MMASK_UFLOW      0x01000000  /* Underflow                 */
117 #define CREG_MMASK_JABBER     0x00800000  /* Jabber error              */
118 #define CREG_MMASK_BABBLE     0x00400000  /* Babble error              */
119 #define CREG_MMASK_OFLOW      0x00000800  /* Overflow                  */
120 #define CREG_MMASK_RXCOLL     0x00000400  /* RX Coll-Cntr overflow     */
121 #define CREG_MMASK_RPKT       0x00000200  /* Runt pkt overflow         */
122 #define CREG_MMASK_MPKT       0x00000100  /* Missed pkt overflow       */
123
124 #define CREG_PIPG_TENAB       0x00000020  /* Enable Throttle           */
125 #define CREG_PIPG_MMODE       0x00000010  /* Manual Mode               */
126 #define CREG_PIPG_WMASK       0x0000000f  /* SBUS Wait Mask            */
127
128 /* Per-channel AMD 79C940 MACE registers. */
129 #define MREGS_RXFIFO    0x00UL  /* Receive FIFO                   */
130 #define MREGS_TXFIFO    0x01UL  /* Transmit FIFO                  */
131 #define MREGS_TXFCNTL   0x02UL  /* Transmit Frame Control         */
132 #define MREGS_TXFSTAT   0x03UL  /* Transmit Frame Status          */
133 #define MREGS_TXRCNT    0x04UL  /* Transmit Retry Count           */
134 #define MREGS_RXFCNTL   0x05UL  /* Receive Frame Control          */
135 #define MREGS_RXFSTAT   0x06UL  /* Receive Frame Status           */
136 #define MREGS_FFCNT     0x07UL  /* FIFO Frame Count               */
137 #define MREGS_IREG      0x08UL  /* Interrupt Register             */
138 #define MREGS_IMASK     0x09UL  /* Interrupt Mask                 */
139 #define MREGS_POLL      0x0aUL  /* POLL Register                  */
140 #define MREGS_BCONFIG   0x0bUL  /* BIU Config                     */
141 #define MREGS_FCONFIG   0x0cUL  /* FIFO Config                    */
142 #define MREGS_MCONFIG   0x0dUL  /* MAC Config                     */
143 #define MREGS_PLSCONFIG 0x0eUL  /* PLS Config                     */
144 #define MREGS_PHYCONFIG 0x0fUL  /* PHY Config                     */
145 #define MREGS_CHIPID1   0x10UL  /* Chip-ID, low bits              */
146 #define MREGS_CHIPID2   0x11UL  /* Chip-ID, high bits             */
147 #define MREGS_IACONFIG  0x12UL  /* Internal Address Config        */
148         /* 0x13UL, reserved */
149 #define MREGS_FILTER    0x14UL  /* Logical Address Filter         */
150 #define MREGS_ETHADDR   0x15UL  /* Our Ethernet Address           */
151         /* 0x16UL, reserved */
152         /* 0x17UL, reserved */
153 #define MREGS_MPCNT     0x18UL  /* Missed Packet Count            */
154         /* 0x19UL, reserved */
155 #define MREGS_RPCNT     0x1aUL  /* Runt Packet Count              */
156 #define MREGS_RCCNT     0x1bUL  /* RX Collision Count             */
157         /* 0x1cUL, reserved */
158 #define MREGS_UTEST     0x1dUL  /* User Test                      */
159 #define MREGS_RTEST1    0x1eUL  /* Reserved Test 1                */
160 #define MREGS_RTEST2    0x1fUL  /* Reserved Test 2                */
161 #define MREGS_REG_SIZE  0x20UL
162
163 #define MREGS_TXFCNTL_DRETRY        0x80 /* Retry disable                  */
164 #define MREGS_TXFCNTL_DFCS          0x08 /* Disable TX FCS                 */
165 #define MREGS_TXFCNTL_AUTOPAD       0x01 /* TX auto pad                    */
166
167 #define MREGS_TXFSTAT_VALID         0x80 /* TX valid                       */
168 #define MREGS_TXFSTAT_UNDERFLOW     0x40 /* TX underflow                   */
169 #define MREGS_TXFSTAT_LCOLL         0x20 /* TX late collision              */
170 #define MREGS_TXFSTAT_MRETRY        0x10 /* TX > 1 retries                 */
171 #define MREGS_TXFSTAT_ORETRY        0x08 /* TX 1 retry                     */
172 #define MREGS_TXFSTAT_PDEFER        0x04 /* TX pkt deferred                */
173 #define MREGS_TXFSTAT_CLOSS         0x02 /* TX carrier lost                */
174 #define MREGS_TXFSTAT_RERROR        0x01 /* TX retry error                 */
175
176 #define MREGS_TXRCNT_EDEFER         0x80 /* TX Excess defers               */
177 #define MREGS_TXRCNT_CMASK          0x0f /* TX retry count                 */
178
179 #define MREGS_RXFCNTL_LOWLAT        0x08 /* RX low latency                 */
180 #define MREGS_RXFCNTL_AREJECT       0x04 /* RX addr match rej              */
181 #define MREGS_RXFCNTL_AUTOSTRIP     0x01 /* RX auto strip                  */
182
183 #define MREGS_RXFSTAT_OVERFLOW      0x80 /* RX overflow                    */
184 #define MREGS_RXFSTAT_LCOLL         0x40 /* RX late collision              */
185 #define MREGS_RXFSTAT_FERROR        0x20 /* RX framing error               */
186 #define MREGS_RXFSTAT_FCSERROR      0x10 /* RX FCS error                   */
187 #define MREGS_RXFSTAT_RBCNT         0x0f /* RX msg byte count              */
188
189 #define MREGS_FFCNT_RX              0xf0 /* RX FIFO frame cnt              */
190 #define MREGS_FFCNT_TX              0x0f /* TX FIFO frame cnt              */
191
192 #define MREGS_IREG_JABBER           0x80 /* IRQ Jabber error               */
193 #define MREGS_IREG_BABBLE           0x40 /* IRQ Babble error               */
194 #define MREGS_IREG_COLL             0x20 /* IRQ Collision error            */
195 #define MREGS_IREG_RCCO             0x10 /* IRQ Collision cnt overflow     */
196 #define MREGS_IREG_RPKTCO           0x08 /* IRQ Runt packet count overflow */
197 #define MREGS_IREG_MPKTCO           0x04 /* IRQ missed packet cnt overflow */
198 #define MREGS_IREG_RXIRQ            0x02 /* IRQ RX'd a packet              */
199 #define MREGS_IREG_TXIRQ            0x01 /* IRQ TX'd a packet              */
200
201 #define MREGS_IMASK_BABBLE          0x40 /* IMASK Babble errors            */
202 #define MREGS_IMASK_COLL            0x20 /* IMASK Collision errors         */
203 #define MREGS_IMASK_MPKTCO          0x04 /* IMASK Missed pkt cnt overflow  */
204 #define MREGS_IMASK_RXIRQ           0x02 /* IMASK RX interrupts            */
205 #define MREGS_IMASK_TXIRQ           0x01 /* IMASK TX interrupts            */
206
207 #define MREGS_POLL_TXVALID          0x80 /* TX is valid                    */
208 #define MREGS_POLL_TDTR             0x40 /* TX data transfer request       */
209 #define MREGS_POLL_RDTR             0x20 /* RX data transfer request       */
210
211 #define MREGS_BCONFIG_BSWAP         0x40 /* Byte Swap                      */
212 #define MREGS_BCONFIG_4TS           0x00 /* 4byte transmit start point     */
213 #define MREGS_BCONFIG_16TS          0x10 /* 16byte transmit start point    */
214 #define MREGS_BCONFIG_64TS          0x20 /* 64byte transmit start point    */
215 #define MREGS_BCONFIG_112TS         0x30 /* 112byte transmit start point   */
216 #define MREGS_BCONFIG_RESET         0x01 /* SW-Reset the MACE              */
217
218 #define MREGS_FCONFIG_TXF8          0x00 /* TX fifo 8 write cycles         */
219 #define MREGS_FCONFIG_TXF32         0x80 /* TX fifo 32 write cycles        */
220 #define MREGS_FCONFIG_TXF16         0x40 /* TX fifo 16 write cycles        */
221 #define MREGS_FCONFIG_RXF64         0x20 /* RX fifo 64 write cycles        */
222 #define MREGS_FCONFIG_RXF32         0x10 /* RX fifo 32 write cycles        */
223 #define MREGS_FCONFIG_RXF16         0x00 /* RX fifo 16 write cycles        */
224 #define MREGS_FCONFIG_TFWU          0x08 /* TX fifo watermark update       */
225 #define MREGS_FCONFIG_RFWU          0x04 /* RX fifo watermark update       */
226 #define MREGS_FCONFIG_TBENAB        0x02 /* TX burst enable                */
227 #define MREGS_FCONFIG_RBENAB        0x01 /* RX burst enable                */
228
229 #define MREGS_MCONFIG_PROMISC       0x80 /* Promiscuous mode enable        */
230 #define MREGS_MCONFIG_TPDDISAB      0x40 /* TX 2part deferral enable       */
231 #define MREGS_MCONFIG_MBAENAB       0x20 /* Modified backoff enable        */
232 #define MREGS_MCONFIG_RPADISAB      0x08 /* RX physical addr disable       */
233 #define MREGS_MCONFIG_RBDISAB       0x04 /* RX broadcast disable           */
234 #define MREGS_MCONFIG_TXENAB        0x02 /* Enable transmitter             */
235 #define MREGS_MCONFIG_RXENAB        0x01 /* Enable receiver                */
236
237 #define MREGS_PLSCONFIG_TXMS        0x08 /* TX mode select                 */
238 #define MREGS_PLSCONFIG_GPSI        0x06 /* Use GPSI connector             */
239 #define MREGS_PLSCONFIG_DAI         0x04 /* Use DAI connector              */
240 #define MREGS_PLSCONFIG_TP          0x02 /* Use TwistedPair connector      */
241 #define MREGS_PLSCONFIG_AUI         0x00 /* Use AUI connector              */
242 #define MREGS_PLSCONFIG_IOENAB      0x01 /* PLS I/O enable                 */
243
244 #define MREGS_PHYCONFIG_LSTAT       0x80 /* Link status                    */
245 #define MREGS_PHYCONFIG_LTESTDIS    0x40 /* Disable link test logic        */
246 #define MREGS_PHYCONFIG_RXPOLARITY  0x20 /* RX polarity                    */
247 #define MREGS_PHYCONFIG_APCDISAB    0x10 /* AutoPolarityCorrect disab      */
248 #define MREGS_PHYCONFIG_LTENAB      0x08 /* Select low threshold           */
249 #define MREGS_PHYCONFIG_AUTO        0x04 /* Connector port auto-sel        */
250 #define MREGS_PHYCONFIG_RWU         0x02 /* Remote WakeUp                  */
251 #define MREGS_PHYCONFIG_AW          0x01 /* Auto Wakeup                    */
252
253 #define MREGS_IACONFIG_ACHNGE       0x80 /* Do address change              */
254 #define MREGS_IACONFIG_PARESET      0x04 /* Physical address reset         */
255 #define MREGS_IACONFIG_LARESET      0x02 /* Logical address reset          */
256
257 #define MREGS_UTEST_RTRENAB         0x80 /* Enable resv test register      */
258 #define MREGS_UTEST_RTRDISAB        0x40 /* Disab resv test register       */
259 #define MREGS_UTEST_RPACCEPT        0x20 /* Accept runt packets            */
260 #define MREGS_UTEST_FCOLL           0x10 /* Force collision status         */
261 #define MREGS_UTEST_FCSENAB         0x08 /* Enable FCS on RX               */
262 #define MREGS_UTEST_INTLOOPM        0x06 /* Intern lpback w/MENDEC         */
263 #define MREGS_UTEST_INTLOOP         0x04 /* Intern lpback                  */
264 #define MREGS_UTEST_EXTLOOP         0x02 /* Extern lpback                  */
265 #define MREGS_UTEST_NOLOOP          0x00 /* No loopback                    */
266
267 struct qe_rxd {
268         u32 rx_flags;
269         u32 rx_addr;
270 };
271
272 #define RXD_OWN      0x80000000 /* Ownership.      */
273 #define RXD_UPDATE   0x10000000 /* Being Updated?  */
274 #define RXD_LENGTH   0x000007ff /* Packet Length.  */
275
276 struct qe_txd {
277         u32 tx_flags;
278         u32 tx_addr;
279 };
280
281 #define TXD_OWN      0x80000000 /* Ownership.      */
282 #define TXD_SOP      0x40000000 /* Start Of Packet */
283 #define TXD_EOP      0x20000000 /* End Of Packet   */
284 #define TXD_UPDATE   0x10000000 /* Being Updated?  */
285 #define TXD_LENGTH   0x000007ff /* Packet Length.  */
286
287 #define TX_RING_MAXSIZE   256
288 #define RX_RING_MAXSIZE   256
289
290 #define TX_RING_SIZE      16
291 #define RX_RING_SIZE      16
292
293 #define NEXT_RX(num)       (((num) + 1) & (RX_RING_MAXSIZE - 1))
294 #define NEXT_TX(num)       (((num) + 1) & (TX_RING_MAXSIZE - 1))
295 #define PREV_RX(num)       (((num) - 1) & (RX_RING_MAXSIZE - 1))
296 #define PREV_TX(num)       (((num) - 1) & (TX_RING_MAXSIZE - 1))
297
298 #define TX_BUFFS_AVAIL(qp)                                    \
299         (((qp)->tx_old <= (qp)->tx_new) ?                     \
300           (qp)->tx_old + (TX_RING_SIZE - 1) - (qp)->tx_new :  \
301                             (qp)->tx_old - (qp)->tx_new - 1)
302
303 struct qe_init_block {
304         struct qe_rxd qe_rxd[RX_RING_MAXSIZE];
305         struct qe_txd qe_txd[TX_RING_MAXSIZE];
306 };
307
308 #define qib_offset(mem, elem) \
309 ((__u32)((unsigned long)(&(((struct qe_init_block *)0)->mem[elem]))))
310
311 struct sunqe;
312
313 struct sunqec {
314         void __iomem            *gregs;         /* QEC Global Registers         */
315         struct sunqe            *qes[4];        /* Each child MACE              */
316         unsigned int            qec_bursts;     /* Support burst sizes          */
317         struct of_device        *op;            /* QEC's OF device              */
318         struct sunqec           *next_module;   /* List of all QECs in system   */
319 };
320
321 #define PKT_BUF_SZ      1664
322 #define RXD_PKT_SZ      1664
323
324 struct sunqe_buffers {
325         u8      tx_buf[TX_RING_SIZE][PKT_BUF_SZ];
326         u8      __pad[2];
327         u8      rx_buf[RX_RING_SIZE][PKT_BUF_SZ];
328 };
329
330 #define qebuf_offset(mem, elem) \
331 ((__u32)((unsigned long)(&(((struct sunqe_buffers *)0)->mem[elem][0]))))
332
333 struct sunqe {
334         void __iomem                    *qcregs;                /* QEC per-channel Registers   */
335         void __iomem                    *mregs;         /* Per-channel MACE Registers  */
336         struct qe_init_block            *qe_block;      /* RX and TX descriptors       */
337         __u32                           qblock_dvma;    /* RX and TX descriptors       */
338         spinlock_t                      lock;           /* Protects txfull state       */
339         int                             rx_new, rx_old; /* RX ring extents             */
340         int                             tx_new, tx_old; /* TX ring extents             */
341         struct sunqe_buffers            *buffers;       /* CPU visible address.        */
342         __u32                           buffers_dvma;   /* DVMA visible address.       */
343         struct sunqec                   *parent;
344         u8                              mconfig;        /* Base MACE mconfig value     */
345         struct of_device                *op;            /* QE's OF device struct       */
346         struct net_device               *dev;           /* QE's netdevice struct       */
347         int                             channel;        /* Who am I?                   */
348 };
349
350 #endif /* !(_SUNQE_H) */