cc904c71e1f66f832f2dd77de04496d11e8a076d
[people/mcb30/gpxe.git] / src / drivers / net / depca.c
1 #warning "depca.c almost certainly won't work"
2
3 /* Not fixed for relocation yet. Probably won't work relocated above 16MB */
4 #ifdef ALLMULTI
5 #error multicast support is not yet implemented
6 #endif
7 /* Etherboot: depca.h merged, comments from Linux driver retained */
8 /*  depca.c: A DIGITAL DEPCA  & EtherWORKS ethernet driver for linux.
9
10     Written 1994, 1995 by David C. Davies.
11
12
13                       Copyright 1994 David C. Davies
14                                    and 
15                          United States Government
16          (as represented by the Director, National Security Agency).  
17
18                Copyright 1995  Digital Equipment Corporation.
19
20
21     This software may be used and distributed according to the terms of
22     the GNU Public License, incorporated herein by reference.
23
24     This driver is written for the Digital Equipment Corporation series
25     of DEPCA and EtherWORKS ethernet cards:
26
27         DEPCA       (the original)
28         DE100
29         DE101
30         DE200 Turbo
31         DE201 Turbo
32         DE202 Turbo (TP BNC)
33         DE210
34         DE422       (EISA)
35
36     The  driver has been tested on DE100, DE200 and DE202 cards  in  a
37     relatively busy network. The DE422 has been tested a little.
38
39     This  driver will NOT work   for the DE203,  DE204  and DE205 series  of
40     cards,  since they have  a  new custom ASIC in   place of the AMD  LANCE
41     chip.  See the 'ewrk3.c'   driver in the  Linux  source tree for running
42     those cards.
43
44     I have benchmarked the driver with a  DE100 at 595kB/s to (542kB/s from)
45     a DECstation 5000/200.
46
47     The author may be reached at davies@maniac.ultranet.com
48
49     =========================================================================
50
51     The  driver was originally based  on   the 'lance.c' driver from  Donald
52     Becker   which  is included with  the  standard  driver distribution for
53     linux.  V0.4  is  a complete  re-write  with only  the kernel  interface
54     remaining from the original code.
55
56     1) Lance.c code in /linux/drivers/net/
57     2) "Ethernet/IEEE 802.3 Family. 1992 World Network Data Book/Handbook",
58        AMD, 1992 [(800) 222-9323].
59     3) "Am79C90 CMOS Local Area Network Controller for Ethernet (C-LANCE)",
60        AMD, Pub. #17881, May 1993.
61     4) "Am79C960 PCnet-ISA(tm), Single-Chip Ethernet Controller for ISA",
62        AMD, Pub. #16907, May 1992
63     5) "DEC EtherWORKS LC Ethernet Controller Owners Manual",
64        Digital Equipment corporation, 1990, Pub. #EK-DE100-OM.003
65     6) "DEC EtherWORKS Turbo Ethernet Controller Owners Manual",
66        Digital Equipment corporation, 1990, Pub. #EK-DE200-OM.003
67     7) "DEPCA Hardware Reference Manual", Pub. #EK-DEPCA-PR
68        Digital Equipment Corporation, 1989
69     8) "DEC EtherWORKS Turbo_(TP BNC) Ethernet Controller Owners Manual",
70        Digital Equipment corporation, 1991, Pub. #EK-DE202-OM.001
71     
72
73     Peter Bauer's depca.c (V0.5) was referred to when debugging V0.1 of this
74     driver.
75
76     The original DEPCA  card requires that the  ethernet ROM address counter
77     be enabled to count and has an 8 bit NICSR.  The ROM counter enabling is
78     only  done when a  0x08 is read as the  first address octet (to minimise
79     the chances  of writing over some  other hardware's  I/O register).  The
80     NICSR accesses   have been changed  to  byte accesses  for all the cards
81     supported by this driver, since there is only one  useful bit in the MSB
82     (remote boot timeout) and it  is not used.  Also, there  is a maximum of
83     only 48kB network  RAM for this  card.  My thanks  to Torbjorn Lindh for
84     help debugging all this (and holding my feet to  the fire until I got it
85     right).
86
87     The DE200  series  boards have  on-board 64kB  RAM for  use  as a shared
88     memory network  buffer. Only the DE100  cards make use  of a  2kB buffer
89     mode which has not  been implemented in  this driver (only the 32kB  and
90     64kB modes are supported [16kB/48kB for the original DEPCA]).
91
92     At the most only 2 DEPCA cards can  be supported on  the ISA bus because
93     there is only provision  for two I/O base addresses  on each card (0x300
94     and 0x200). The I/O address is detected by searching for a byte sequence
95     in the Ethernet station address PROM at the expected I/O address for the
96     Ethernet  PROM.   The shared memory  base   address  is 'autoprobed'  by
97     looking  for the self  test PROM  and detecting the  card name.   When a
98     second  DEPCA is  detected,  information  is   placed in the   base_addr
99     variable of the  next device structure (which  is created if necessary),
100     thus  enabling ethif_probe  initialization  for the device.  More than 2
101     EISA cards can  be  supported, but  care will  be  needed assigning  the
102     shared memory to ensure that each slot has the  correct IRQ, I/O address
103     and shared memory address assigned.
104
105     ************************************************************************
106
107     NOTE: If you are using two  ISA DEPCAs, it is  important that you assign
108     the base memory addresses correctly.   The  driver autoprobes I/O  0x300
109     then 0x200.  The  base memory address for  the first device must be less
110     than that of the second so that the auto probe will correctly assign the
111     I/O and memory addresses on the same card.  I can't think of a way to do
112     this unambiguously at the moment, since there is nothing on the cards to
113     tie I/O and memory information together.
114
115     I am unable  to  test  2 cards   together for now,    so this  code   is
116     unchecked. All reports, good or bad, are welcome.
117
118     ************************************************************************
119
120     The board IRQ   setting must be  at an  unused IRQ which  is auto-probed
121     using Donald Becker's autoprobe routines. DEPCA and DE100 board IRQs are
122     {2,3,4,5,7}, whereas the  DE200 is at {5,9,10,11,15}.  Note that IRQ2 is
123     really IRQ9 in machines with 16 IRQ lines.
124
125     No 16MB memory  limitation should exist with this  driver as DMA is  not
126     used and the common memory area is in low memory on the network card (my
127     current system has 20MB and I've not had problems yet).
128
129     The ability to load this driver as a loadable module has been added. To
130     utilise this ability, you have to do <8 things:
131
132     0) have a copy of the loadable modules code installed on your system.
133     1) copy depca.c from the  /linux/drivers/net directory to your favourite
134     temporary directory.
135     2) if you wish, edit the  source code near  line 1530 to reflect the I/O
136     address and IRQ you're using (see also 5).
137     3) compile  depca.c, but include -DMODULE in  the command line to ensure
138     that the correct bits are compiled (see end of source code).
139     4) if you are wanting to add a new  card, goto 5. Otherwise, recompile a
140     kernel with the depca configuration turned off and reboot.
141     5) insmod depca.o [irq=7] [io=0x200] [mem=0xd0000] [adapter_name=DE100]
142        [Alan Cox: Changed the code to allow command line irq/io assignments]
143        [Dave Davies: Changed the code to allow command line mem/name
144                                                                 assignments]
145     6) run the net startup bits for your eth?? interface manually 
146     (usually /etc/rc.inet[12] at boot time). 
147     7) enjoy!
148
149     Note that autoprobing is not allowed in loadable modules - the system is
150     already up and running and you're messing with interrupts.
151
152     To unload a module, turn off the associated interface 
153     'ifconfig eth?? down' then 'rmmod depca'.
154
155     To assign a base memory address for the shared memory  when running as a
156     loadable module, see 5 above.  To include the adapter  name (if you have
157     no PROM  but know the card name)  also see 5  above. Note that this last
158     option  will not work  with kernel  built-in  depca's. 
159
160     The shared memory assignment for a loadable module  makes sense to avoid
161     the 'memory autoprobe' picking the wrong shared memory  (for the case of
162     2 depca's in a PC).
163
164     ************************************************************************
165     Support for MCA EtherWORKS cards added 11-3-98.
166     Verified to work with up to 2 DE212 cards in a system (although not
167       fully stress-tested).  
168
169     Currently known bugs/limitations:
170
171     Note:  with the MCA stuff as a module, it trusts the MCA configuration,
172            not the command line for IRQ and memory address.  You can
173            specify them if you want, but it will throw your values out.
174            You still have to pass the IO address it was configured as
175            though.
176
177     ************************************************************************
178     TO DO:
179     ------
180
181
182     Revision History
183     ----------------
184
185     Version   Date        Description
186   
187       0.1     25-jan-94   Initial writing.
188       0.2     27-jan-94   Added LANCE TX hardware buffer chaining.
189       0.3      1-feb-94   Added multiple DEPCA support.
190       0.31     4-feb-94   Added DE202 recognition.
191       0.32    19-feb-94   Tidy up. Improve multi-DEPCA support.
192       0.33    25-feb-94   Fix DEPCA ethernet ROM counter enable.
193                           Add jabber packet fix from murf@perftech.com
194                           and becker@super.org
195       0.34     7-mar-94   Fix DEPCA max network memory RAM & NICSR access.
196       0.35     8-mar-94   Added DE201 recognition. Tidied up.
197       0.351   30-apr-94   Added EISA support. Added DE422 recognition.
198       0.36    16-may-94   DE422 fix released.
199       0.37    22-jul-94   Added MODULE support
200       0.38    15-aug-94   Added DBR ROM switch in depca_close(). 
201                           Multi DEPCA bug fix.
202       0.38axp 15-sep-94   Special version for Alpha AXP Linux V1.0.
203       0.381   12-dec-94   Added DE101 recognition, fix multicast bug.
204       0.382    9-feb-95   Fix recognition bug reported by <bkm@star.rl.ac.uk>.
205       0.383   22-feb-95   Fix for conflict with VESA SCSI reported by
206                           <stromain@alf.dec.com>
207       0.384   17-mar-95   Fix a ring full bug reported by <bkm@star.rl.ac.uk>
208       0.385    3-apr-95   Fix a recognition bug reported by 
209                                                 <ryan.niemi@lastfrontier.com>
210       0.386   21-apr-95   Fix the last fix...sorry, must be galloping senility
211       0.40    25-May-95   Rewrite for portability & updated.
212                           ALPHA support from <jestabro@amt.tay1.dec.com>
213       0.41    26-Jun-95   Added verify_area() calls in depca_ioctl() from
214                           suggestion by <heiko@colossus.escape.de>
215       0.42    27-Dec-95   Add 'mem' shared memory assignment for loadable 
216                           modules.
217                           Add 'adapter_name' for loadable modules when no PROM.
218                           Both above from a suggestion by 
219                           <pchen@woodruffs121.residence.gatech.edu>.
220                           Add new multicasting code.
221       0.421   22-Apr-96   Fix alloc_device() bug <jari@markkus2.fimr.fi>
222       0.422   29-Apr-96   Fix depca_hw_init() bug <jari@markkus2.fimr.fi>
223       0.423    7-Jun-96   Fix module load bug <kmg@barco.be>
224       0.43    16-Aug-96   Update alloc_device() to conform to de4x5.c
225       0.44     1-Sep-97   Fix *_probe() to test check_region() first - bug
226                            reported by <mmogilvi@elbert.uccs.edu>
227       0.45     3-Nov-98   Added support for MCA EtherWORKS (DE210/DE212) cards
228                            by <tymm@computer.org> 
229       0.451    5-Nov-98   Fixed mca stuff cuz I'm a dummy. <tymm@computer.org>
230       0.5     14-Nov-98   Re-spin for 2.1.x kernels.
231       0.51    27-Jun-99   Correct received packet length for CRC from
232                            report by <worm@dkik.dk>
233
234     =========================================================================
235 */
236
237 #include "etherboot.h"
238 #include "nic.h"
239 #include "isa.h"
240 #include "console.h"
241
242 /*
243 ** I/O addresses. Note that the 2k buffer option is not supported in
244 ** this driver.
245 */
246 #define DEPCA_NICSR 0x00   /* Network interface CSR */
247 #define DEPCA_RBI   0x02   /* RAM buffer index (2k buffer mode) */
248 #define DEPCA_DATA  0x04   /* LANCE registers' data port */
249 #define DEPCA_ADDR  0x06   /* LANCE registers' address port */
250 #define DEPCA_HBASE 0x08   /* EISA high memory base address reg. */
251 #define DEPCA_PROM  0x0c   /* Ethernet address ROM data port */
252 #define DEPCA_CNFG  0x0c   /* EISA Configuration port */
253 #define DEPCA_RBSA  0x0e   /* RAM buffer starting address (2k buff.) */
254
255 /*
256 ** These are LANCE registers addressable through nic->ioaddr + DEPCA_ADDR 
257 */
258 #define CSR0       0
259 #define CSR1       1
260 #define CSR2       2
261 #define CSR3       3
262
263 /* 
264 ** NETWORK INTERFACE CSR (NI_CSR) bit definitions 
265 */
266  
267 #define TO              0x0100  /* Time Out for remote boot */
268 #define SHE             0x0080  /* SHadow memory Enable */
269 #define BS              0x0040  /* Bank Select */
270 #define BUF             0x0020  /* BUFfer size (1->32k, 0->64k) */
271 #define RBE             0x0010  /* Remote Boot Enable (1->net boot) */
272 #define AAC             0x0008  /* Address ROM Address Counter (1->enable) */
273 #define _128KB          0x0008  /* 128kB Network RAM (1->enable) */
274 #define IM              0x0004  /* Interrupt Mask (1->mask) */
275 #define IEN             0x0002  /* Interrupt tristate ENable (1->enable) */
276 #define LED             0x0001  /* LED control */
277
278 /* 
279 ** Control and Status Register 0 (CSR0) bit definitions 
280 */
281
282 #define ERR             0x8000  /* Error summary */
283 #define BABL            0x4000  /* Babble transmitter timeout error  */
284 #define CERR            0x2000  /* Collision Error */
285 #define MISS            0x1000  /* Missed packet */
286 #define MERR            0x0800  /* Memory Error */
287 #define RINT            0x0400  /* Receiver Interrupt */
288 #define TINT            0x0200  /* Transmit Interrupt */
289 #define IDON            0x0100  /* Initialization Done */
290 #define INTR            0x0080  /* Interrupt Flag */
291 #define INEA            0x0040  /* Interrupt Enable */
292 #define RXON            0x0020  /* Receiver on */
293 #define TXON            0x0010  /* Transmitter on */
294 #define TDMD            0x0008  /* Transmit Demand */
295 #define STOP            0x0004  /* Stop */
296 #define STRT            0x0002  /* Start */
297 #define INIT            0x0001  /* Initialize */
298 #define INTM            0xff00  /* Interrupt Mask */
299 #define INTE            0xfff0  /* Interrupt Enable */
300
301 /*
302 ** CONTROL AND STATUS REGISTER 3 (CSR3)
303 */
304
305 #define BSWP            0x0004  /* Byte SWaP */
306 #define ACON            0x0002  /* ALE control */
307 #define BCON            0x0001  /* Byte CONtrol */
308
309 /*
310 ** Initialization Block Mode Register 
311 */
312
313 #define PROM            0x8000  /* Promiscuous Mode */
314 #define EMBA            0x0080  /* Enable Modified Back-off Algorithm */
315 #define INTL            0x0040  /* Internal Loopback */
316 #define DRTY            0x0020  /* Disable Retry */
317 #define COLL            0x0010  /* Force Collision */
318 #define DTCR            0x0008  /* Disable Transmit CRC */
319 #define LOOP            0x0004  /* Loopback */
320 #define DTX             0x0002  /* Disable the Transmitter */
321 #define DRX             0x0001  /* Disable the Receiver */
322
323 /*
324 ** Receive Message Descriptor 1 (RMD1) bit definitions. 
325 */
326
327 #define R_OWN       0x80000000  /* Owner bit 0 = host, 1 = lance */
328 #define R_ERR           0x4000  /* Error Summary */
329 #define R_FRAM          0x2000  /* Framing Error */
330 #define R_OFLO          0x1000  /* Overflow Error */
331 #define R_CRC           0x0800  /* CRC Error */
332 #define R_BUFF          0x0400  /* Buffer Error */
333 #define R_STP           0x0200  /* Start of Packet */
334 #define R_ENP           0x0100  /* End of Packet */
335
336 /*
337 ** Transmit Message Descriptor 1 (TMD1) bit definitions. 
338 */
339
340 #define T_OWN       0x80000000  /* Owner bit 0 = host, 1 = lance */
341 #define T_ERR           0x4000  /* Error Summary */
342 #define T_ADD_FCS       0x2000  /* More the 1 retry needed to Xmit */
343 #define T_MORE          0x1000  /* >1 retry to transmit packet */
344 #define T_ONE           0x0800  /* 1 try needed to transmit the packet */
345 #define T_DEF           0x0400  /* Deferred */
346 #define T_STP       0x02000000  /* Start of Packet */
347 #define T_ENP       0x01000000  /* End of Packet */
348 #define T_FLAGS     0xff000000  /* TX Flags Field */
349
350 /*
351 ** Transmit Message Descriptor 3 (TMD3) bit definitions.
352 */
353
354 #define TMD3_BUFF    0x8000     /* BUFFer error */
355 #define TMD3_UFLO    0x4000     /* UnderFLOw error */
356 #define TMD3_RES     0x2000     /* REServed */
357 #define TMD3_LCOL    0x1000     /* Late COLlision */
358 #define TMD3_LCAR    0x0800     /* Loss of CARrier */
359 #define TMD3_RTRY    0x0400     /* ReTRY error */
360
361 /*
362 ** Ethernet PROM defines
363 */
364 #define PROBE_LENGTH    32
365
366 /*
367 ** Set the number of Tx and Rx buffers. Ensure that the memory requested
368 ** here is <= to the amount of shared memory set up by the board switches.
369 ** The number of descriptors MUST BE A POWER OF 2.
370 **
371 ** total_memory = NUM_RX_DESC*(8+RX_BUFF_SZ) + NUM_TX_DESC*(8+TX_BUFF_SZ)
372 */
373 #define NUM_RX_DESC     2               /* Number of RX descriptors */
374 #define NUM_TX_DESC     2               /* Number of TX descriptors */
375 #define RX_BUFF_SZ      1536            /* Buffer size for each Rx buffer */
376 #define TX_BUFF_SZ      1536            /* Buffer size for each Tx buffer */
377
378 /*
379 ** ISA Bus defines
380 */
381 #ifndef DEPCA_MODEL
382 #define DEPCA_MODEL     DEPCA
383 #endif
384
385 static enum {
386         DEPCA, DE100, DE101, DE200, DE201, DE202, DE210, DE212, DE422, unknown
387 } adapter = DEPCA_MODEL;
388
389 /*
390 ** Name <-> Adapter mapping
391 */
392
393 static char *adapter_name[] = {
394         "DEPCA",
395         "DE100","DE101",
396         "DE200","DE201","DE202",
397         "DE210","DE212",
398         "DE422",
399         ""
400 };
401
402 #ifndef DEPCA_RAM_BASE
403 #define DEPCA_RAM_BASE  0xd0000
404 #endif
405
406 /*
407 ** Memory Alignment. Each descriptor is 4 longwords long. To force a
408 ** particular alignment on the TX descriptor, adjust DESC_SKIP_LEN and
409 ** DESC_ALIGN. ALIGN aligns the start address of the private memory area
410 ** and hence the RX descriptor ring's first entry. 
411 */
412 #define ALIGN4      ((u32)4 - 1)       /* 1 longword align */
413 #define ALIGN8      ((u32)8 - 1)       /* 2 longword (quadword) align */
414 #define ALIGN         ALIGN8              /* Keep the LANCE happy... */
415
416 /*
417 ** The DEPCA Rx and Tx ring descriptors. 
418 */
419 struct depca_rx_desc {
420     volatile s32 base;
421     s16 buf_length;             /* This length is negative 2's complement! */
422     s16 msg_length;             /* This length is "normal". */
423 };
424
425 struct depca_tx_desc {
426     volatile s32 base;
427     s16 length;                 /* This length is negative 2's complement! */
428     s16 misc;                   /* Errors and TDR info */
429 };
430
431 #define LA_MASK 0x0000ffff      /* LANCE address mask for mapping network RAM
432                                    to LANCE memory address space */
433
434 /*
435 ** The Lance initialization block, described in databook, in common memory.
436 */
437 struct depca_init {
438     u16 mode;                   /* Mode register */
439     u8  phys_addr[ETH_ALEN];    /* Physical ethernet address */
440     u8  mcast_table[8];         /* Multicast Hash Table. */
441     u32 rx_ring;                /* Rx ring base pointer & ring length */
442     u32 tx_ring;                /* Tx ring base pointer & ring length */
443 };
444
445 struct depca_private {
446         struct depca_rx_desc    *rx_ring;
447         struct depca_tx_desc    *tx_ring;
448         struct depca_init       init_block;     /* Shadow init block */
449         char                    *rx_memcpy[NUM_RX_DESC];
450         char                    *tx_memcpy[NUM_TX_DESC];
451         u32                     bus_offset;     /* ISA bus address offset */
452         u32                     sh_mem;         /* address of shared mem */
453         u32                     dma_buffs;      /* Rx & Tx buffer start */
454         int                     rx_cur, tx_cur; /* Next free ring entry */
455         int                     txRingMask, rxRingMask;
456         s32                     rx_rlen, tx_rlen;
457         /* log2([rt]xRingMask+1) for the descriptors */
458 };
459
460 static Address          mem_start = DEPCA_RAM_BASE;
461 static Address          mem_len, offset;
462 static struct depca_private     lp;
463
464 /*
465 ** Miscellaneous defines...
466 */
467 #define STOP_DEPCA(ioaddr) \
468     outw(CSR0, ioaddr + DEPCA_ADDR);\
469     outw(STOP, ioaddr + DEPCA_DATA)
470
471 /* Initialize the lance Rx and Tx descriptor rings. */
472 static void depca_init_ring(struct nic *nic)
473 {
474         int     i;
475         u32     p;
476
477         lp.rx_cur = lp.tx_cur = 0;
478         /* Initialize the base addresses and length of each buffer in the ring */
479         for (i = 0; i <= lp.rxRingMask; i++) {
480                 writel((p = lp.dma_buffs + i * RX_BUFF_SZ) | R_OWN, &lp.rx_ring[i].base);
481                 writew(-RX_BUFF_SZ, &lp.rx_ring[i].buf_length);
482                 lp.rx_memcpy[i] = (char *) (p + lp.bus_offset);
483         }
484         for (i = 0; i <= lp.txRingMask; i++) {
485                 writel((p = lp.dma_buffs + (i + lp.txRingMask + 1) * TX_BUFF_SZ) & 0x00ffffff, &lp.tx_ring[i].base);
486                 lp.tx_memcpy[i] = (char *) (p + lp.bus_offset);
487         }
488
489         /* Set up the initialization block */
490         lp.init_block.rx_ring = ((u32) ((u32) lp.rx_ring) & LA_MASK) | lp.rx_rlen;
491         lp.init_block.tx_ring = ((u32) ((u32) lp.tx_ring) & LA_MASK) | lp.tx_rlen;
492         for (i = 0; i < ETH_ALEN; i++)
493                 lp.init_block.phys_addr[i] = nic->node_addr[i];
494         lp.init_block.mode = 0x0000;    /* Enable the Tx and Rx */
495         memset(lp.init_block.mcast_table, 0, sizeof(lp.init_block.mcast_table));
496 }
497
498 static inline void LoadCSRs(struct nic *nic)
499 {
500         outw(CSR1, nic->ioaddr + DEPCA_ADDR);   /* initialisation block address LSW */
501         outw((u16) (lp.sh_mem & LA_MASK), nic->ioaddr + DEPCA_DATA);
502         outw(CSR2, nic->ioaddr + DEPCA_ADDR);   /* initialisation block address MSW */
503         outw((u16) ((lp.sh_mem & LA_MASK) >> 16), nic->ioaddr + DEPCA_DATA);
504         outw(CSR3, nic->ioaddr + DEPCA_ADDR);   /* ALE control */
505         outw(ACON, nic->ioaddr + DEPCA_DATA);
506         outw(CSR0, nic->ioaddr + DEPCA_ADDR);   /* Point back to CSR0 */
507 }
508
509 static inline int InitRestartDepca(struct nic *nic)
510 {
511         int             i;
512
513         /* Copy the shadow init_block to shared memory */
514         memcpy_toio((char *)lp.sh_mem, &lp.init_block, sizeof(struct depca_init));
515         outw(CSR0, nic->ioaddr + DEPCA_ADDR);           /* point back to CSR0 */
516         outw(INIT, nic->ioaddr + DEPCA_DATA);           /* initialise DEPCA */
517
518         for (i = 0; i < 100 && !(inw(nic->ioaddr + DEPCA_DATA) & IDON); i++)
519                 ;
520         if (i < 100) {
521                 /* clear IDON by writing a 1, and start LANCE */
522                 outw(IDON | STRT, nic->ioaddr + DEPCA_DATA);
523         } else {
524                 printf("DEPCA not initialised\n");
525                 return (1);
526         }
527         return (0);
528 }
529
530 /**************************************************************************
531 RESET - Reset adapter
532 ***************************************************************************/
533 static void depca_reset(struct nic *nic)
534 {
535         s16     nicsr;
536         int     i, j;
537
538         STOP_DEPCA(nic->ioaddr);
539         nicsr = inb(nic->ioaddr + DEPCA_NICSR);
540         nicsr = ((nicsr & ~SHE & ~RBE & ~IEN) | IM);
541         outb(nicsr, nic->ioaddr + DEPCA_NICSR);
542         if (inw(nic->ioaddr + DEPCA_DATA) != STOP)
543         {
544                 printf("depca: Cannot stop NIC\n");
545                 return;
546         }
547
548         /* Initialisation block */
549         lp.sh_mem = mem_start;
550         mem_start += sizeof(struct depca_init);
551         /* Tx & Rx descriptors (aligned to a quadword boundary) */
552         mem_start = (mem_start + ALIGN) & ~ALIGN;
553         lp.rx_ring = (struct depca_rx_desc *) mem_start;
554         mem_start += (sizeof(struct depca_rx_desc) * NUM_RX_DESC);
555         lp.tx_ring = (struct depca_tx_desc *) mem_start;
556         mem_start += (sizeof(struct depca_tx_desc) * NUM_TX_DESC);
557
558         lp.bus_offset = mem_start & 0x00ff0000;
559         /* LANCE re-mapped start address */
560         lp.dma_buffs = mem_start & LA_MASK;
561
562         /* Finish initialising the ring information. */
563         lp.rxRingMask = NUM_RX_DESC - 1;
564         lp.txRingMask = NUM_TX_DESC - 1;
565
566         /* Calculate Tx/Rx RLEN size for the descriptors. */
567         for (i = 0, j = lp.rxRingMask; j > 0; i++) {
568                 j >>= 1;
569         }
570         lp.rx_rlen = (s32) (i << 29);
571         for (i = 0, j = lp.txRingMask; j > 0; i++) {
572                 j >>= 1;
573         }
574         lp.tx_rlen = (s32) (i << 29);
575
576         /* Load the initialisation block */
577         depca_init_ring(nic);
578         LoadCSRs(nic);
579         InitRestartDepca(nic);
580 }
581
582 /**************************************************************************
583 POLL - Wait for a frame
584 ***************************************************************************/
585 static int depca_poll(struct nic *nic, int retrieve)
586 {
587         int             entry;
588         u32             status;
589
590         entry = lp.rx_cur;
591         if ((status = readl(&lp.rx_ring[entry].base) & R_OWN))
592                 return (0);
593
594         if ( ! retrieve ) return 1;
595
596         memcpy(nic->packet, lp.rx_memcpy[entry], nic->packetlen = lp.rx_ring[entry].msg_length);
597         lp.rx_ring[entry].base |= R_OWN;
598         lp.rx_cur = (++lp.rx_cur) & lp.rxRingMask;
599         return (1);
600 }
601
602 /**************************************************************************
603 TRANSMIT - Transmit a frame
604 ***************************************************************************/
605 static void depca_transmit(
606         struct nic *nic,
607         const char *d,                  /* Destination */
608         unsigned int t,                 /* Type */
609         unsigned int s,                 /* size */
610         const char *p)                  /* Packet */
611 {
612         int             entry, len;
613         char            *mem;
614
615         /* send the packet to destination */
616         /*
617         ** Caution: the right order is important here... dont
618         ** setup the ownership rights until all the other
619         ** information is in place
620         */
621         mem = lp.tx_memcpy[entry = lp.tx_cur];
622         memcpy_toio(mem, d, ETH_ALEN);
623         memcpy_toio(mem + ETH_ALEN, nic->node_addr, ETH_ALEN);
624         mem[ETH_ALEN * 2] = t >> 8;
625         mem[ETH_ALEN * 2 + 1] = t;
626         memcpy_toio(mem + ETH_HLEN, p, s);
627         s += ETH_HLEN;
628         len = (s < ETH_ZLEN ? ETH_ZLEN : s);
629         /* clean out flags */
630         writel(readl(&lp.tx_ring[entry].base) & ~T_FLAGS, &lp.tx_ring[entry].base);
631         /* clears other error flags */
632         writew(0x0000, &lp.tx_ring[entry].misc);
633         /* packet length in buffer */
634         writew(-len, &lp.tx_ring[entry].length);
635         /* start and end of packet, ownership */
636         writel(readl(&lp.tx_ring[entry].base) | (T_STP|T_ENP|T_OWN), &lp.tx_ring[entry].base);
637         /* update current pointers */
638         lp.tx_cur = (++lp.tx_cur) & lp.txRingMask;
639 }
640
641 /**************************************************************************
642 DISABLE - Turn off ethernet interface
643 ***************************************************************************/
644 static void depca_disable ( struct nic *nic, struct isa_device *isa __unused ) {
645         nic_disable ( nic );
646         /* reset and disable merge */
647         depca_reset(nic);
648
649         STOP_DEPCA(nic->ioaddr);
650 }
651
652 /**************************************************************************
653 IRQ - Interrupt Control
654 ***************************************************************************/
655 static void depca_irq(struct nic *nic __unused, irq_action_t action __unused)
656 {
657   switch ( action ) {
658   case DISABLE :
659     break;
660   case ENABLE :
661     break;
662   case FORCE :
663     break;
664   }
665 }
666
667 /*
668 ** Look for a special sequence in the Ethernet station address PROM that
669 ** is common across all DEPCA products. Note that the original DEPCA needs
670 ** its ROM address counter to be initialized and enabled. Only enable
671 ** if the first address octet is a 0x08 - this minimises the chances of
672 ** messing around with some other hardware, but it assumes that this DEPCA
673 ** card initialized itself correctly.
674 **
675 ** Search the Ethernet address ROM for the signature. Since the ROM address
676 ** counter can start at an arbitrary point, the search must include the entire
677 ** probe sequence length plus the (length_of_the_signature - 1).
678 ** Stop the search IMMEDIATELY after the signature is found so that the
679 ** PROM address counter is correctly positioned at the start of the
680 ** ethernet address for later read out.
681 */
682
683
684 /*
685  * Ugly, ugly, ugly.  I can't quite make out where the split should be
686  * between probe1 and probe()...
687  *
688  */
689 static u8 nicsr;
690
691
692 static int depca_probe1 ( isa_probe_addr_t ioaddr ) {
693         u8      data;
694         /* This is only correct for little endian machines, but then
695            Etherboot doesn't work on anything but a PC */
696         u8      sig[] = { 0xFF, 0x00, 0x55, 0xAA, 0xFF, 0x00, 0x55, 0xAA };
697         int     i, j;
698
699         data = inb(ioaddr + DEPCA_PROM);                /* clear counter on DEPCA */
700         data = inb(ioaddr + DEPCA_PROM);                /* read data */
701         if (data == 0x8) {
702                 nicsr = inb(ioaddr + DEPCA_NICSR);
703                 nicsr |= AAC;
704                 outb(nicsr, ioaddr + DEPCA_NICSR);
705         }
706         for (i = 0, j = 0; j < (int)sizeof(sig) && i < PROBE_LENGTH+((int)sizeof(sig))-1; ++i) {
707                 data = inb(ioaddr + DEPCA_PROM);
708                 if (data == sig[j])             /* track signature */
709                         ++j;
710                 else
711                         j = (data == sig[0]) ? 1 : 0;
712         }
713         if (j != sizeof(sig))
714                 return (0);
715         /* put the card in its initial state */
716         STOP_DEPCA(ioaddr);
717         nicsr = ((inb(ioaddr + DEPCA_NICSR) & ~SHE & ~RBE & ~IEN) | IM);
718         outb(nicsr, ioaddr + DEPCA_NICSR);
719         if (inw(ioaddr + DEPCA_DATA) != STOP)
720                 return (0);
721         memcpy((char *)mem_start, sig, sizeof(sig));
722         if (memcmp((char *)mem_start, sig, sizeof(sig)) != 0)
723                 return (0);
724
725         return 1;
726 }
727
728 static struct nic_operations depca_operations = {
729         .connect        = dummy_connect,
730         .poll           = depca_poll,
731         .transmit       = depca_transmit,
732         .irq            = depca_irq,
733
734 };
735
736 /**************************************************************************
737 PROBE - Look for an adapter, this routine's visible to the outside
738 ***************************************************************************/
739 static int depca_probe ( struct nic *nic, struct isa_device *isa ) {
740
741         int     i, j;
742         long    sum, chksum;
743
744         nic->irqno    = 0;
745         isa_fill_nic ( nic, isa );
746         nic->ioaddr   = isa->ioaddr;
747
748         for (i = 0, j = 0, sum = 0; j < 3; j++) {
749                 sum <<= 1;
750                 if (sum > 0xFFFF)
751                         sum -= 0xFFFF;
752                 sum += (u8)(nic->node_addr[i++] = inb(nic->ioaddr + DEPCA_PROM));
753                 sum += (u16)((nic->node_addr[i++] = inb(nic->ioaddr + DEPCA_PROM)) << 8);
754                 if (sum > 0xFFFF)
755                         sum -= 0xFFFF;
756         }
757         if (sum == 0xFFFF)
758                 sum = 0;
759         chksum = (u8)inb(nic->ioaddr + DEPCA_PROM);
760         chksum |= (u16)(inb(nic->ioaddr + DEPCA_PROM) << 8);
761         mem_len = (adapter == DEPCA) ? (48 << 10) : (64 << 10);
762         offset = 0;
763         if (nicsr & BUF) {
764                 offset = 0x8000;
765                 nicsr &= ~BS;
766                 mem_len -= (32 << 10);
767         }
768         if (adapter != DEPCA)   /* enable shadow RAM */
769                 outb(nicsr |= SHE, nic->ioaddr + DEPCA_NICSR);
770         printf("%s base %#hX, memory [%#hX-%#hX], addr %!",
771                adapter_name[adapter], nic->ioaddr, mem_start,
772                mem_start + mem_len,
773                nic->node_addr);
774         if (sum != chksum)
775                 printf(" (bad checksum)");
776         putchar('\n');
777
778         depca_reset(nic);
779
780         /* point to NIC specific routines */
781         nic->nic_op     = &depca_operations;
782         return 1;
783 }
784
785 static isa_probe_addr_t depca_probe_addrs[] = {
786         0x300, 0x200,
787 };
788
789 ISA_DRIVER ( depca_driver, depca_probe_addrs, depca_probe1,
790                      GENERIC_ISAPNP_VENDOR, 0x80f7 );
791
792 DRIVER ( "depce", nic_driver, isa_driver, depca_driver,
793          depca_probe, depca_disable );
794
795 ISA_ROM ( "depca", "Digital DE100 and DE200" );