Finished by hand
[people/xl0/gpxe.git] / src / drivers / net / 3c90x.c
1 /*
2  * 3c90x.c -- This file implements the 3c90x driver for etherboot.  Written
3  * by Greg Beeley, Greg.Beeley@LightSys.org.  Modified by Steve Smith,
4  * Steve.Smith@Juno.Com. Alignment bug fix Neil Newell (nn@icenoir.net).
5  *
6  * This program Copyright (C) 1999 LightSys Technology Services, Inc.
7  * Portions Copyright (C) 1999 Steve Smith
8  *
9  * This program may be re-distributed in source or binary form, modified,
10  * sold, or copied for any purpose, provided that the above copyright message
11  * and this text are included with all source copies or derivative works, and
12  * provided that the above copyright message and this text are included in the
13  * documentation of any binary-only distributions.  This program is distributed
14  * WITHOUT ANY WARRANTY, without even the warranty of FITNESS FOR A PARTICULAR
15  * PURPOSE or MERCHANTABILITY.  Please read the associated documentation
16  * "3c90x.txt" before compiling and using this driver.
17  *
18  * --------
19  *
20  * Program written with the assistance of the 3com documentation for
21  * the 3c905B-TX card, as well as with some assistance from the 3c59x
22  * driver Donald Becker wrote for the Linux kernel, and with some assistance
23  * from the remainder of the Etherboot distribution.
24  *
25  * REVISION HISTORY:
26  *
27  * v0.10        1-26-1998       GRB     Initial implementation.
28  * v0.90        1-27-1998       GRB     System works.
29  * v1.00pre1    2-11-1998       GRB     Got prom boot issue fixed.
30  * v2.0         9-24-1999       SCS     Modified for 3c905 (from 3c905b code)
31  *                                      Re-wrote poll and transmit for
32  *                                      better error recovery and heavy
33  *                                      network traffic operation
34  * v2.01    5-26-2003 NN Fixed driver alignment issue which
35  *                  caused system lockups if driver structures
36  *                  not 8-byte aligned.
37  *
38  */
39
40 #include "etherboot.h"
41 #include "nic.h"
42 #include "pci.h"
43 #include "timer.h"
44
45 static struct nic_operations a3c90x_operations;
46 static struct pci_driver a3c90x_driver;
47
48 #define XCVR_MAGIC      (0x5A00)
49 /** any single transmission fails after 16 collisions or other errors
50  ** this is the number of times to retry the transmission -- this should
51  ** be plenty
52  **/
53 #define XMIT_RETRIES    250
54
55 /*** Register definitions for the 3c905 ***/
56 enum Registers
57     {
58     regPowerMgmtCtrl_w = 0x7c,        /** 905B Revision Only                 **/
59     regUpMaxBurst_w = 0x7a,           /** 905B Revision Only                 **/
60     regDnMaxBurst_w = 0x78,           /** 905B Revision Only                 **/
61     regDebugControl_w = 0x74,         /** 905B Revision Only                 **/
62     regDebugData_l = 0x70,            /** 905B Revision Only                 **/
63     regRealTimeCnt_l = 0x40,          /** Universal                          **/
64     regUpBurstThresh_b = 0x3e,        /** 905B Revision Only                 **/
65     regUpPoll_b = 0x3d,               /** 905B Revision Only                 **/
66     regUpPriorityThresh_b = 0x3c,     /** 905B Revision Only                 **/
67     regUpListPtr_l = 0x38,            /** Universal                          **/
68     regCountdown_w = 0x36,            /** Universal                          **/
69     regFreeTimer_w = 0x34,            /** Universal                          **/
70     regUpPktStatus_l = 0x30,          /** Universal with Exception, pg 130   **/
71     regTxFreeThresh_b = 0x2f,         /** 90X Revision Only                  **/
72     regDnPoll_b = 0x2d,               /** 905B Revision Only                 **/
73     regDnPriorityThresh_b = 0x2c,     /** 905B Revision Only                 **/
74     regDnBurstThresh_b = 0x2a,        /** 905B Revision Only                 **/
75     regDnListPtr_l = 0x24,            /** Universal with Exception, pg 107   **/
76     regDmaCtrl_l = 0x20,              /** Universal with Exception, pg 106   **/
77                                       /**                                    **/
78     regIntStatusAuto_w = 0x1e,        /** 905B Revision Only                 **/
79     regTxStatus_b = 0x1b,             /** Universal with Exception, pg 113   **/
80     regTimer_b = 0x1a,                /** Universal                          **/
81     regTxPktId_b = 0x18,              /** 905B Revision Only                 **/
82     regCommandIntStatus_w = 0x0e,     /** Universal (Command Variations)     **/
83     };
84
85 /** following are windowed registers **/
86 enum Registers7
87     {
88     regPowerMgmtEvent_7_w = 0x0c,     /** 905B Revision Only                 **/
89     regVlanEtherType_7_w = 0x04,      /** 905B Revision Only                 **/
90     regVlanMask_7_w = 0x00,           /** 905B Revision Only                 **/
91     };
92
93 enum Registers6
94     {
95     regBytesXmittedOk_6_w = 0x0c,     /** Universal                          **/
96     regBytesRcvdOk_6_w = 0x0a,        /** Universal                          **/
97     regUpperFramesOk_6_b = 0x09,      /** Universal                          **/
98     regFramesDeferred_6_b = 0x08,     /** Universal                          **/
99     regFramesRecdOk_6_b = 0x07,       /** Universal with Exceptions, pg 142  **/
100     regFramesXmittedOk_6_b = 0x06,    /** Universal                          **/
101     regRxOverruns_6_b = 0x05,         /** Universal                          **/
102     regLateCollisions_6_b = 0x04,     /** Universal                          **/
103     regSingleCollisions_6_b = 0x03,   /** Universal                          **/
104     regMultipleCollisions_6_b = 0x02, /** Universal                          **/
105     regSqeErrors_6_b = 0x01,          /** Universal                          **/
106     regCarrierLost_6_b = 0x00,        /** Universal                          **/
107     };
108
109 enum Registers5
110     {
111     regIndicationEnable_5_w = 0x0c,   /** Universal                          **/
112     regInterruptEnable_5_w = 0x0a,    /** Universal                          **/
113     regTxReclaimThresh_5_b = 0x09,    /** 905B Revision Only                 **/
114     regRxFilter_5_b = 0x08,           /** Universal                          **/
115     regRxEarlyThresh_5_w = 0x06,      /** Universal                          **/
116     regTxStartThresh_5_w = 0x00,      /** Universal                          **/
117     };
118
119 enum Registers4
120     {
121     regUpperBytesOk_4_b = 0x0d,       /** Universal                          **/
122     regBadSSD_4_b = 0x0c,             /** Universal                          **/
123     regMediaStatus_4_w = 0x0a,        /** Universal with Exceptions, pg 201  **/
124     regPhysicalMgmt_4_w = 0x08,       /** Universal                          **/
125     regNetworkDiagnostic_4_w = 0x06,  /** Universal with Exceptions, pg 203  **/
126     regFifoDiagnostic_4_w = 0x04,     /** Universal with Exceptions, pg 196  **/
127     regVcoDiagnostic_4_w = 0x02,      /** Undocumented?                      **/
128     };
129
130 enum Registers3
131     {
132     regTxFree_3_w = 0x0c,             /** Universal                          **/
133     regRxFree_3_w = 0x0a,             /** Universal with Exceptions, pg 125  **/
134     regResetMediaOptions_3_w = 0x08,  /** Media Options on B Revision,       **/
135                                       /** Reset Options on Non-B Revision    **/
136     regMacControl_3_w = 0x06,         /** Universal with Exceptions, pg 199  **/
137     regMaxPktSize_3_w = 0x04,         /** 905B Revision Only                 **/
138     regInternalConfig_3_l = 0x00,     /** Universal, different bit           **/
139                                       /** definitions, pg 59                 **/
140     };
141
142 enum Registers2
143     {
144     regResetOptions_2_w = 0x0c,       /** 905B Revision Only                 **/
145     regStationMask_2_3w = 0x06,       /** Universal with Exceptions, pg 127  **/
146     regStationAddress_2_3w = 0x00,    /** Universal with Exceptions, pg 127  **/
147     };
148
149 enum Registers1
150     {
151     regRxStatus_1_w = 0x0a,           /** 90X Revision Only, Pg 126          **/
152     };
153
154 enum Registers0
155     {
156     regEepromData_0_w = 0x0c,         /** Universal                          **/
157     regEepromCommand_0_w = 0x0a,      /** Universal                          **/
158     regBiosRomData_0_b = 0x08,        /** 905B Revision Only                 **/
159     regBiosRomAddr_0_l = 0x04,        /** 905B Revision Only                 **/
160     };
161
162
163 /*** The names for the eight register windows ***/
164 enum Windows
165     {
166     winPowerVlan7 = 0x07,
167     winStatistics6 = 0x06,
168     winTxRxControl5 = 0x05,
169     winDiagnostics4 = 0x04,
170     winTxRxOptions3 = 0x03,
171     winAddressing2 = 0x02,
172     winUnused1 = 0x01,
173     winEepromBios0 = 0x00,
174     };
175
176
177 /*** Command definitions for the 3c90X ***/
178 enum Commands
179     {
180     cmdGlobalReset = 0x00,             /** Universal with Exceptions, pg 151 **/
181     cmdSelectRegisterWindow = 0x01,    /** Universal                         **/
182     cmdEnableDcConverter = 0x02,       /**                                   **/
183     cmdRxDisable = 0x03,               /**                                   **/
184     cmdRxEnable = 0x04,                /** Universal                         **/
185     cmdRxReset = 0x05,                 /** Universal                         **/
186     cmdStallCtl = 0x06,                /** Universal                         **/
187     cmdTxEnable = 0x09,                /** Universal                         **/
188     cmdTxDisable = 0x0A,               /**                                   **/
189     cmdTxReset = 0x0B,                 /** Universal                         **/
190     cmdRequestInterrupt = 0x0C,        /**                                   **/
191     cmdAcknowledgeInterrupt = 0x0D,    /** Universal                         **/
192     cmdSetInterruptEnable = 0x0E,      /** Universal                         **/
193     cmdSetIndicationEnable = 0x0F,     /** Universal                         **/
194     cmdSetRxFilter = 0x10,             /** Universal                         **/
195     cmdSetRxEarlyThresh = 0x11,        /**                                   **/
196     cmdSetTxStartThresh = 0x13,        /**                                   **/
197     cmdStatisticsEnable = 0x15,        /**                                   **/
198     cmdStatisticsDisable = 0x16,       /**                                   **/
199     cmdDisableDcConverter = 0x17,      /**                                   **/
200     cmdSetTxReclaimThresh = 0x18,      /**                                   **/
201     cmdSetHashFilterBit = 0x19,        /**                                   **/
202     };
203
204
205 /*** Values for int status register bitmask **/
206 #define INT_INTERRUPTLATCH      (1<<0)
207 #define INT_HOSTERROR           (1<<1)
208 #define INT_TXCOMPLETE          (1<<2)
209 #define INT_RXCOMPLETE          (1<<4)
210 #define INT_RXEARLY             (1<<5)
211 #define INT_INTREQUESTED        (1<<6)
212 #define INT_UPDATESTATS         (1<<7)
213 #define INT_LINKEVENT           (1<<8)
214 #define INT_DNCOMPLETE          (1<<9)
215 #define INT_UPCOMPLETE          (1<<10)
216 #define INT_CMDINPROGRESS       (1<<12)
217 #define INT_WINDOWNUMBER        (7<<13)
218
219
220 /*** TX descriptor ***/
221 typedef struct
222     {
223     unsigned int        DnNextPtr;
224     unsigned int        FrameStartHeader;
225     unsigned int        HdrAddr;
226     unsigned int        HdrLength;
227     unsigned int        DataAddr;
228     unsigned int        DataLength;
229     }
230     TXD __attribute__ ((aligned(8))); /* 64-bit aligned for bus mastering */
231
232 /*** RX descriptor ***/
233 typedef struct
234     {
235     unsigned int        UpNextPtr;
236     unsigned int        UpPktStatus;
237     unsigned int        DataAddr;
238     unsigned int        DataLength;
239     }
240     RXD __attribute__ ((aligned(8))); /* 64-bit aligned for bus mastering */
241
242 /*** Global variables ***/
243 static struct
244     {
245     unsigned char       isBrev;
246     unsigned char       CurrentWindow;
247     unsigned int        IOAddr;
248     unsigned char       HWAddr[ETH_ALEN];
249     TXD                 TransmitDPD;
250     RXD                 ReceiveUPD;
251     }
252     INF_3C90X;
253
254
255 /*** a3c90x_internal_IssueCommand: sends a command to the 3c90x card
256  ***/
257 static int
258 a3c90x_internal_IssueCommand(int ioaddr, int cmd, int param)
259     {
260     unsigned int val;
261
262         /** Build the cmd. **/
263         val = cmd;
264         val <<= 11;
265         val |= param;
266
267         /** Send the cmd to the cmd register **/
268         outw(val, ioaddr + regCommandIntStatus_w);
269
270         /** Wait for the cmd to complete, if necessary **/
271         while (inw(ioaddr + regCommandIntStatus_w) & INT_CMDINPROGRESS);
272
273     return 0;
274     }
275
276
277 /*** a3c90x_internal_SetWindow: selects a register window set.
278  ***/
279 static int
280 a3c90x_internal_SetWindow(int ioaddr, int window)
281     {
282
283         /** Window already as set? **/
284         if (INF_3C90X.CurrentWindow == window) return 0;
285
286         /** Issue the window command. **/
287         a3c90x_internal_IssueCommand(ioaddr, cmdSelectRegisterWindow, window);
288         INF_3C90X.CurrentWindow = window;
289
290     return 0;
291     }
292
293
294 /*** a3c90x_internal_ReadEeprom - read data from the serial eeprom.
295  ***/
296 static unsigned short
297 a3c90x_internal_ReadEeprom(int ioaddr, int address)
298     {
299     unsigned short val;
300
301         /** Select correct window **/
302         a3c90x_internal_SetWindow(INF_3C90X.IOAddr, winEepromBios0);
303
304         /** Make sure the eeprom isn't busy **/
305         while((1<<15) & inw(ioaddr + regEepromCommand_0_w));
306
307         /** Read the value. **/
308         outw(address + ((0x02)<<6), ioaddr + regEepromCommand_0_w);
309         while((1<<15) & inw(ioaddr + regEepromCommand_0_w));
310         val = inw(ioaddr + regEepromData_0_w);
311
312     return val;
313     }
314
315
316 #if 0
317 /*** a3c90x_internal_WriteEepromWord - write a physical word of
318  *** data to the onboard serial eeprom (not the BIOS prom, but the
319  *** nvram in the card that stores, among other things, the MAC
320  *** address).
321  ***/
322 static int
323 a3c90x_internal_WriteEepromWord(int ioaddr, int address, unsigned short value)
324     {
325         /** Select register window **/
326         a3c90x_internal_SetWindow(ioaddr, winEepromBios0);
327
328         /** Verify Eeprom not busy **/
329         while((1<<15) & inw(ioaddr + regEepromCommand_0_w));
330
331         /** Issue WriteEnable, and wait for completion. **/
332         outw(0x30, ioaddr + regEepromCommand_0_w);
333         while((1<<15) & inw(ioaddr + regEepromCommand_0_w));
334
335         /** Issue EraseRegister, and wait for completion. **/
336         outw(address + ((0x03)<<6), ioaddr + regEepromCommand_0_w);
337         while((1<<15) & inw(ioaddr + regEepromCommand_0_w));
338
339         /** Send the new data to the eeprom, and wait for completion. **/
340         outw(value, ioaddr + regEepromData_0_w);
341         outw(0x30, ioaddr + regEepromCommand_0_w);
342         while((1<<15) & inw(ioaddr + regEepromCommand_0_w));
343
344         /** Burn the new data into the eeprom, and wait for completion. **/
345         outw(address + ((0x01)<<6), ioaddr + regEepromCommand_0_w);
346         while((1<<15) & inw(ioaddr + regEepromCommand_0_w));
347
348     return 0;
349     }
350 #endif
351
352 #if 0
353 /*** a3c90x_internal_WriteEeprom - write data to the serial eeprom,
354  *** and re-compute the eeprom checksum.
355  ***/
356 static int
357 a3c90x_internal_WriteEeprom(int ioaddr, int address, unsigned short value)
358     {
359     int cksum = 0,v;
360     int i;
361     int maxAddress, cksumAddress;
362
363         if (INF_3C90X.isBrev)
364             {
365             maxAddress=0x1f;
366             cksumAddress=0x20;
367             }
368         else
369             {
370             maxAddress=0x16;
371             cksumAddress=0x17;
372             }
373
374         /** Write the value. **/
375         if (a3c90x_internal_WriteEepromWord(ioaddr, address, value) == -1)
376             return -1;
377
378         /** Recompute the checksum. **/
379         for(i=0;i<=maxAddress;i++)
380             {
381             v = a3c90x_internal_ReadEeprom(ioaddr, i);
382             cksum ^= (v & 0xFF);
383             cksum ^= ((v>>8) & 0xFF);
384             }
385         /** Write the checksum to the location in the eeprom **/
386         if (a3c90x_internal_WriteEepromWord(ioaddr, cksumAddress, cksum) == -1)
387             return -1;
388
389     return 0;
390     }
391 #endif
392
393 /*** a3c90x_reset: exported function that resets the card to its default
394  *** state.  This is so the Linux driver can re-set the card up the way
395  *** it wants to.  If CFG_3C90X_PRESERVE_XCVR is defined, then the reset will
396  *** not alter the selected transceiver that we used to download the boot
397  *** image.
398  ***/
399 static void a3c90x_reset(void)
400     {
401 #ifdef  CFG_3C90X_PRESERVE_XCVR
402     int cfg;
403     /** Read the current InternalConfig value. **/
404     a3c90x_internal_SetWindow(INF_3C90X.IOAddr, winTxRxOptions3);
405     cfg = inl(INF_3C90X.IOAddr + regInternalConfig_3_l);
406 #endif
407
408     /** Send the reset command to the card **/
409     printf("Issuing RESET:\n");
410     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdGlobalReset, 0);
411
412     /** wait for reset command to complete **/
413     while (inw(INF_3C90X.IOAddr + regCommandIntStatus_w) & INT_CMDINPROGRESS);
414
415     /** global reset command resets station mask, non-B revision cards
416      ** require explicit reset of values
417      **/
418     a3c90x_internal_SetWindow(INF_3C90X.IOAddr, winAddressing2);
419     outw(0, INF_3C90X.IOAddr + regStationMask_2_3w+0);
420     outw(0, INF_3C90X.IOAddr + regStationMask_2_3w+2);
421     outw(0, INF_3C90X.IOAddr + regStationMask_2_3w+4);
422
423 #ifdef  CFG_3C90X_PRESERVE_XCVR
424     /** Re-set the original InternalConfig value from before reset **/
425     a3c90x_internal_SetWindow(INF_3C90X.IOAddr, winTxRxOptions3);
426     outl(cfg, INF_3C90X.IOAddr + regInternalConfig_3_l);
427
428     /** enable DC converter for 10-Base-T **/
429     if ((cfg&0x0300) == 0x0300)
430         {
431         a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdEnableDcConverter, 0);
432         }
433 #endif
434
435     /** Issue transmit reset, wait for command completion **/
436     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdTxReset, 0);
437     while (inw(INF_3C90X.IOAddr + regCommandIntStatus_w) & INT_CMDINPROGRESS)
438         ;
439     if (! INF_3C90X.isBrev)
440         outb(0x01, INF_3C90X.IOAddr + regTxFreeThresh_b);
441     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdTxEnable, 0);
442
443     /**
444      ** reset of the receiver on B-revision cards re-negotiates the link
445      ** takes several seconds (a computer eternity)
446      **/
447     if (INF_3C90X.isBrev)
448         a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdRxReset, 0x04);
449     else
450         a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdRxReset, 0x00);
451     while (inw(INF_3C90X.IOAddr + regCommandIntStatus_w) & INT_CMDINPROGRESS);
452         ;
453     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdRxEnable, 0);
454
455     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr,
456                                  cmdSetInterruptEnable, 0);
457     /** enable rxComplete and txComplete **/
458     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr,
459                                  cmdSetIndicationEnable, 0x0014);
460     /** acknowledge any pending status flags **/
461     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr,
462                                  cmdAcknowledgeInterrupt, 0x661);
463
464     return;
465     }
466
467
468
469 /*** a3c90x_transmit: exported function that transmits a packet.  Does not
470  *** return any particular status.  Parameters are:
471  *** d[6] - destination address, ethernet;
472  *** t - protocol type (ARP, IP, etc);
473  *** s - size of the non-header part of the packet that needs transmitted;
474  *** p - the pointer to the packet data itself.
475  ***/
476 static void
477 a3c90x_transmit(struct nic *nic __unused, const char *d, unsigned int t,
478                 unsigned int s, const char *p)
479     {
480
481     struct eth_hdr
482         {
483         unsigned char dst_addr[ETH_ALEN];
484         unsigned char src_addr[ETH_ALEN];
485         unsigned short type;
486         } hdr;
487
488     unsigned char status;
489     unsigned i, retries;
490
491     for (retries=0; retries < XMIT_RETRIES ; retries++)
492         {
493         /** Stall the download engine **/
494         a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdStallCtl, 2);
495
496         /** Make sure the card is not waiting on us **/
497         inw(INF_3C90X.IOAddr + regCommandIntStatus_w);
498         inw(INF_3C90X.IOAddr + regCommandIntStatus_w);
499
500         while (inw(INF_3C90X.IOAddr+regCommandIntStatus_w) &
501                INT_CMDINPROGRESS)
502             ;
503
504         /** Set the ethernet packet type **/
505         hdr.type = htons(t);
506
507         /** Copy the destination address **/
508         memcpy(hdr.dst_addr, d, ETH_ALEN);
509
510         /** Copy our MAC address **/
511         memcpy(hdr.src_addr, INF_3C90X.HWAddr, ETH_ALEN);
512
513         /** Setup the DPD (download descriptor) **/
514         INF_3C90X.TransmitDPD.DnNextPtr = 0;
515         /** set notification for transmission completion (bit 15) **/
516         INF_3C90X.TransmitDPD.FrameStartHeader = (s + sizeof(hdr)) | 0x8000;
517         INF_3C90X.TransmitDPD.HdrAddr = virt_to_bus(&hdr);
518         INF_3C90X.TransmitDPD.HdrLength = sizeof(hdr);
519         INF_3C90X.TransmitDPD.DataAddr = virt_to_bus(p);
520         INF_3C90X.TransmitDPD.DataLength = s + (1<<31);
521
522         /** Send the packet **/
523         outl(virt_to_bus(&(INF_3C90X.TransmitDPD)),
524              INF_3C90X.IOAddr + regDnListPtr_l);
525
526         /** End Stall and Wait for upload to complete. **/
527         a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdStallCtl, 3);
528         while(inl(INF_3C90X.IOAddr + regDnListPtr_l) != 0)
529             ;
530
531         /** Wait for NIC Transmit to Complete **/
532         load_timer2(10*TICKS_PER_MS);   /* Give it 10 ms */
533         while (!(inw(INF_3C90X.IOAddr + regCommandIntStatus_w)&0x0004) &&
534                 timer2_running())
535                 ;
536
537         if (!(inw(INF_3C90X.IOAddr + regCommandIntStatus_w)&0x0004))
538             {
539             printf("3C90X: Tx Timeout\n");
540             continue;
541             }
542
543         status = inb(INF_3C90X.IOAddr + regTxStatus_b);
544
545         /** acknowledge transmit interrupt by writing status **/
546         outb(0x00, INF_3C90X.IOAddr + regTxStatus_b);
547
548         /** successful completion (sans "interrupt Requested" bit) **/
549         if ((status & 0xbf) == 0x80)
550             return;
551
552            printf("3C90X: Status (%hhX)\n", status);
553         /** check error codes **/
554         if (status & 0x02)
555             {
556             printf("3C90X: Tx Reclaim Error (%hhX)\n", status);
557             a3c90x_reset();
558             }
559         else if (status & 0x04)
560             {
561             printf("3C90X: Tx Status Overflow (%hhX)\n", status);
562             for (i=0; i<32; i++)
563                 outb(0x00, INF_3C90X.IOAddr + regTxStatus_b);
564             /** must re-enable after max collisions before re-issuing tx **/
565             a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdTxEnable, 0);
566             }
567         else if (status & 0x08)
568             {
569             printf("3C90X: Tx Max Collisions (%hhX)\n", status);
570             /** must re-enable after max collisions before re-issuing tx **/
571             a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdTxEnable, 0);
572             }
573         else if (status & 0x10)
574             {
575             printf("3C90X: Tx Underrun (%hhX)\n", status);
576             a3c90x_reset();
577             }
578         else if (status & 0x20)
579             {
580             printf("3C90X: Tx Jabber (%hhX)\n", status);
581             a3c90x_reset();
582             }
583         else if ((status & 0x80) != 0x80)
584             {
585             printf("3C90X: Internal Error - Incomplete Transmission (%hhX)\n",
586                    status);
587             a3c90x_reset();
588             }
589         }
590
591     /** failed after RETRY attempts **/
592     printf("Failed to send after %d retries\n", retries);
593     return;
594
595     }
596
597
598
599 /*** a3c90x_poll: exported routine that waits for a certain length of time
600  *** for a packet, and if it sees none, returns 0.  This routine should
601  *** copy the packet to nic->packet if it gets a packet and set the size
602  *** in nic->packetlen.  Return 1 if a packet was found.
603  ***/
604 static int
605 a3c90x_poll(struct nic *nic, int retrieve)
606     {
607     int i, errcode;
608
609     if (!(inw(INF_3C90X.IOAddr + regCommandIntStatus_w)&0x0010))
610         {
611         return 0;
612         }
613
614     if ( ! retrieve ) return 1;
615
616     /** we don't need to acknowledge rxComplete -- the upload engine
617      ** does it for us.
618      **/
619
620     /** Build the up-load descriptor **/
621     INF_3C90X.ReceiveUPD.UpNextPtr = 0;
622     INF_3C90X.ReceiveUPD.UpPktStatus = 0;
623     INF_3C90X.ReceiveUPD.DataAddr = virt_to_bus(nic->packet);
624     INF_3C90X.ReceiveUPD.DataLength = 1536 + (1<<31);
625
626     /** Submit the upload descriptor to the NIC **/
627     outl(virt_to_bus(&(INF_3C90X.ReceiveUPD)),
628          INF_3C90X.IOAddr + regUpListPtr_l);
629
630     /** Wait for upload completion (upComplete(15) or upError (14)) **/
631     for(i=0;i<40000;i++);
632     while((INF_3C90X.ReceiveUPD.UpPktStatus & ((1<<14) | (1<<15))) == 0)
633         for(i=0;i<40000;i++);
634
635     /** Check for Error (else we have good packet) **/
636     if (INF_3C90X.ReceiveUPD.UpPktStatus & (1<<14))
637         {
638         errcode = INF_3C90X.ReceiveUPD.UpPktStatus;
639         if (errcode & (1<<16))
640             printf("3C90X: Rx Overrun (%hX)\n",errcode>>16);
641         else if (errcode & (1<<17))
642             printf("3C90X: Runt Frame (%hX)\n",errcode>>16);
643         else if (errcode & (1<<18))
644             printf("3C90X: Alignment Error (%hX)\n",errcode>>16);
645         else if (errcode & (1<<19))
646             printf("3C90X: CRC Error (%hX)\n",errcode>>16);
647         else if (errcode & (1<<20))
648             printf("3C90X: Oversized Frame (%hX)\n",errcode>>16);
649         else
650             printf("3C90X: Packet error (%hX)\n",errcode>>16);
651         return 0;
652         }
653
654     /** Ok, got packet.  Set length in nic->packetlen. **/
655     nic->packetlen = (INF_3C90X.ReceiveUPD.UpPktStatus & 0x1FFF);
656
657     return 1;
658     }
659
660
661
662 /*** a3c90x_disable: exported routine to disable the card.  What's this for?
663  *** the eepro100.c driver didn't have one, so I just left this one empty too.
664  *** Ideas anyone?
665  *** Must turn off receiver at least so stray packets will not corrupt memory
666  *** [Ken]
667  ***/
668 static void
669 a3c90x_disable ( struct nic *nic __unused ) {
670         /* reset and disable merge */
671         a3c90x_reset();
672         /* Disable the receiver and transmitter. */
673         outw(cmdRxDisable, INF_3C90X.IOAddr + regCommandIntStatus_w);
674         outw(cmdTxDisable, INF_3C90X.IOAddr + regCommandIntStatus_w);
675 }
676
677 static void a3c90x_irq(struct nic *nic __unused, irq_action_t action __unused)
678 {
679   switch ( action ) {
680   case DISABLE :
681     break;
682   case ENABLE :
683     break;
684   case FORCE :
685     break;
686   }
687 }
688
689 /*** a3c90x_probe: exported routine to probe for the 3c905 card and perform
690  *** initialization.  If this routine is called, the pci functions did find the
691  *** card.  We just have to init it here.
692  ***/
693 static int a3c90x_probe ( struct dev *dev ) {
694     struct nic *nic = nic_device ( dev );
695     struct pci_device *pci = pci_device ( dev );
696     int i, c;
697     unsigned short eeprom[0x21];
698     unsigned int cfg;
699     unsigned int mopt;
700     unsigned int mstat;
701     unsigned short linktype;
702 #define HWADDR_OFFSET   10
703
704     if ( ! find_pci_device ( pci, &a3c90x_driver ) )
705             return 0;
706     
707     if (pci->ioaddr == 0)
708           return 0;
709
710     nic->ioaddr = pci->ioaddr;
711     nic->irqno = 0;
712
713     INF_3C90X.IOAddr = pci->ioaddr & ~3;
714     INF_3C90X.CurrentWindow = 255;
715     switch (a3c90x_internal_ReadEeprom(INF_3C90X.IOAddr, 0x03))
716         {
717         case 0x9000: /** 10 Base TPO             **/
718         case 0x9001: /** 10/100 T4               **/
719         case 0x9050: /** 10/100 TPO              **/
720         case 0x9051: /** 10 Base Combo           **/
721                 INF_3C90X.isBrev = 0;
722                 break;
723
724         case 0x9004: /** 10 Base TPO             **/
725         case 0x9005: /** 10 Base Combo           **/
726         case 0x9006: /** 10 Base TPO and Base2   **/
727         case 0x900A: /** 10 Base FL              **/
728         case 0x9055: /** 10/100 TPO              **/
729         case 0x9056: /** 10/100 T4               **/
730         case 0x905A: /** 10 Base FX              **/
731         default:
732                 INF_3C90X.isBrev = 1;
733                 break;
734         }
735
736     /** Load the EEPROM contents **/
737     if (INF_3C90X.isBrev)
738         {
739         for(i=0;i<=0x20;i++)
740             {
741             eeprom[i] = a3c90x_internal_ReadEeprom(INF_3C90X.IOAddr, i);
742             }
743
744 #ifdef  CFG_3C90X_BOOTROM_FIX
745         /** Set xcvrSelect in InternalConfig in eeprom. **/
746         /* only necessary for 3c905b revision cards with boot PROM bug!!! */
747         a3c90x_internal_WriteEeprom(INF_3C90X.IOAddr, 0x13, 0x0160);
748 #endif
749
750 #ifdef  CFG_3C90X_XCVR
751         if (CFG_3C90X_XCVR == 255)
752             {
753             /** Clear the LanWorks register **/
754             a3c90x_internal_WriteEeprom(INF_3C90X.IOAddr, 0x16, 0);
755             }
756         else
757             {
758             /** Set the selected permanent-xcvrSelect in the
759              ** LanWorks register
760              **/
761             a3c90x_internal_WriteEeprom(INF_3C90X.IOAddr, 0x16,
762                             XCVR_MAGIC + ((CFG_3C90X_XCVR) & 0x000F));
763             }
764 #endif
765         }
766     else
767         {
768         for(i=0;i<=0x17;i++)
769             {
770             eeprom[i] = a3c90x_internal_ReadEeprom(INF_3C90X.IOAddr, i);
771             }
772         }
773
774     /** Print identification message **/
775     printf("\n\n3C90X Driver 2.00 "
776            "Copyright 1999 LightSys Technology Services, Inc.\n"
777            "Portions Copyright 1999 Steve Smith\n");
778     printf("Provided with ABSOLUTELY NO WARRANTY.\n");
779 #ifdef  CFG_3C90X_BOOTROM_FIX
780     if (INF_3C90X.isBrev)
781         {
782         printf("NOTE: 3c905b bootrom fix enabled; has side "
783            "effects.  See 3c90x.txt for info.\n");
784         }
785 #endif
786     printf("-------------------------------------------------------"
787            "------------------------\n");
788
789     /** Retrieve the Hardware address and print it on the screen. **/
790     INF_3C90X.HWAddr[0] = eeprom[HWADDR_OFFSET + 0]>>8;
791     INF_3C90X.HWAddr[1] = eeprom[HWADDR_OFFSET + 0]&0xFF;
792     INF_3C90X.HWAddr[2] = eeprom[HWADDR_OFFSET + 1]>>8;
793     INF_3C90X.HWAddr[3] = eeprom[HWADDR_OFFSET + 1]&0xFF;
794     INF_3C90X.HWAddr[4] = eeprom[HWADDR_OFFSET + 2]>>8;
795     INF_3C90X.HWAddr[5] = eeprom[HWADDR_OFFSET + 2]&0xFF;
796     printf("MAC Address = %!\n", INF_3C90X.HWAddr);
797
798     /* Test if the link is good, if not continue */
799     a3c90x_internal_SetWindow(INF_3C90X.IOAddr, winDiagnostics4);
800     mstat = inw(INF_3C90X.IOAddr + regMediaStatus_4_w);
801     if((mstat & (1<<11)) == 0) {
802         printf("Valid link not established\n");
803         return 0;
804     }
805
806     /** Program the MAC address into the station address registers **/
807     a3c90x_internal_SetWindow(INF_3C90X.IOAddr, winAddressing2);
808     outw(htons(eeprom[HWADDR_OFFSET + 0]), INF_3C90X.IOAddr + regStationAddress_2_3w);
809     outw(htons(eeprom[HWADDR_OFFSET + 1]), INF_3C90X.IOAddr + regStationAddress_2_3w+2);
810     outw(htons(eeprom[HWADDR_OFFSET + 2]), INF_3C90X.IOAddr + regStationAddress_2_3w+4);
811     outw(0, INF_3C90X.IOAddr + regStationMask_2_3w+0);
812     outw(0, INF_3C90X.IOAddr + regStationMask_2_3w+2);
813     outw(0, INF_3C90X.IOAddr + regStationMask_2_3w+4);
814
815     /** Fill in our entry in the etherboot arp table **/
816     for(i=0;i<ETH_ALEN;i++)
817         nic->node_addr[i] = (eeprom[HWADDR_OFFSET + i/2] >> (8*((i&1)^1))) & 0xff;
818
819     /** Read the media options register, print a message and set default
820      ** xcvr.
821      **
822      ** Uses Media Option command on B revision, Reset Option on non-B
823      ** revision cards -- same register address
824      **/
825     a3c90x_internal_SetWindow(INF_3C90X.IOAddr, winTxRxOptions3);
826     mopt = inw(INF_3C90X.IOAddr + regResetMediaOptions_3_w);
827
828     /** mask out VCO bit that is defined as 10baseFL bit on B-rev cards **/
829     if (! INF_3C90X.isBrev)
830         {
831         mopt &= 0x7F;
832         }
833
834     printf("Connectors present: ");
835     c = 0;
836     linktype = 0x0008;
837     if (mopt & 0x01)
838         {
839         printf("%s100Base-T4",(c++)?", ":"");
840         linktype = 0x0006;
841         }
842     if (mopt & 0x04)
843         {
844         printf("%s100Base-FX",(c++)?", ":"");
845         linktype = 0x0005;
846         }
847     if (mopt & 0x10)
848         {
849         printf("%s10Base-2",(c++)?", ":"");
850         linktype = 0x0003;
851         }
852     if (mopt & 0x20)
853         {
854         printf("%sAUI",(c++)?", ":"");
855         linktype = 0x0001;
856         }
857     if (mopt & 0x40)
858         {
859         printf("%sMII",(c++)?", ":"");
860         linktype = 0x0006;
861         }
862     if ((mopt & 0xA) == 0xA)
863         {
864         printf("%s10Base-T / 100Base-TX",(c++)?", ":"");
865         linktype = 0x0008;
866         }
867     else if ((mopt & 0xA) == 0x2)
868         {
869         printf("%s100Base-TX",(c++)?", ":"");
870         linktype = 0x0008;
871         }
872     else if ((mopt & 0xA) == 0x8)
873         {
874         printf("%s10Base-T",(c++)?", ":"");
875         linktype = 0x0008;
876         }
877     printf(".\n");
878
879     /** Determine transceiver type to use, depending on value stored in
880      ** eeprom 0x16
881      **/
882     if (INF_3C90X.isBrev)
883         {
884         if ((eeprom[0x16] & 0xFF00) == XCVR_MAGIC)
885             {
886             /** User-defined **/
887             linktype = eeprom[0x16] & 0x000F;
888             }
889         }
890     else
891         {
892 #ifdef  CFG_3C90X_XCVR
893             if (CFG_3C90X_XCVR != 255)
894                 linktype = CFG_3C90X_XCVR;
895 #endif  /* CFG_3C90X_XCVR */
896
897             /** I don't know what MII MAC only mode is!!! **/
898             if (linktype == 0x0009)
899                 {
900                 if (INF_3C90X.isBrev)
901                         printf("WARNING: MII External MAC Mode only supported on B-revision "
902                                "cards!!!!\nFalling Back to MII Mode\n");
903                 linktype = 0x0006;
904                 }
905         }
906
907     /** enable DC converter for 10-Base-T **/
908     if (linktype == 0x0003)
909         {
910         a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdEnableDcConverter, 0);
911         }
912
913     /** Set the link to the type we just determined. **/
914     a3c90x_internal_SetWindow(INF_3C90X.IOAddr, winTxRxOptions3);
915     cfg = inl(INF_3C90X.IOAddr + regInternalConfig_3_l);
916     cfg &= ~(0xF<<20);
917     cfg |= (linktype<<20);
918     outl(cfg, INF_3C90X.IOAddr + regInternalConfig_3_l);
919
920     /** Now that we set the xcvr type, reset the Tx and Rx, re-enable. **/
921     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdTxReset, 0x00);
922     while (inw(INF_3C90X.IOAddr + regCommandIntStatus_w) & INT_CMDINPROGRESS)
923         ;
924
925     if (!INF_3C90X.isBrev)
926         outb(0x01, INF_3C90X.IOAddr + regTxFreeThresh_b);
927
928     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdTxEnable, 0);
929
930     /**
931      ** reset of the receiver on B-revision cards re-negotiates the link
932      ** takes several seconds (a computer eternity)
933      **/
934     if (INF_3C90X.isBrev)
935         a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdRxReset, 0x04);
936     else
937         a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdRxReset, 0x00);
938     while (inw(INF_3C90X.IOAddr + regCommandIntStatus_w) & INT_CMDINPROGRESS)
939         ;
940
941     /** Set the RX filter = receive only individual pkts & multicast & bcast. **/
942     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdSetRxFilter, 0x01 + 0x02 + 0x04);
943     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdRxEnable, 0);
944
945
946     /**
947      ** set Indication and Interrupt flags , acknowledge any IRQ's
948      **/
949     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr, cmdSetInterruptEnable, 0);
950     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr,
951                                  cmdSetIndicationEnable, 0x0014);
952     a3c90x_internal_IssueCommand(INF_3C90X.IOAddr,
953                                  cmdAcknowledgeInterrupt, 0x661);
954
955     /** Set our exported functions **/
956     nic->nic_op = &a3c90x_operations;
957     return 1;
958 }
959
960 static struct nic_operations a3c90x_operations = {
961         .connect        = dummy_connect,
962         .poll           = a3c90x_poll,
963         .transmit       = a3c90x_transmit,
964         .irq            = a3c90x_irq,
965         .disable        = a3c90x_disable,
966 };
967
968 static struct pci_id a3c90x_nics[] = {
969 /* Original 90x revisions: */
970 PCI_ROM(0x10b7, 0x9000, "3c905-tpo",     "3Com900-TPO"),        /* 10 Base TPO */
971 PCI_ROM(0x10b7, 0x9001, "3c905-t4",      "3Com900-Combo"),      /* 10/100 T4 */
972 PCI_ROM(0x10b7, 0x9050, "3c905-tpo100",  "3Com905-TX"),         /* 100 Base TX / 10/100 TPO */
973 PCI_ROM(0x10b7, 0x9051, "3c905-combo",   "3Com905-T4"),         /* 100 Base T4 / 10 Base Combo */
974 /* Newer 90xB revisions: */
975 PCI_ROM(0x10b7, 0x9004, "3c905b-tpo",    "3Com900B-TPO"),       /* 10 Base TPO */
976 PCI_ROM(0x10b7, 0x9005, "3c905b-combo",  "3Com900B-Combo"),     /* 10 Base Combo */
977 PCI_ROM(0x10b7, 0x9006, "3c905b-tpb2",   "3Com900B-2/T"),       /* 10 Base TP and Base2 */
978 PCI_ROM(0x10b7, 0x900a, "3c905b-fl",     "3Com900B-FL"),        /* 10 Base FL */
979 PCI_ROM(0x10b7, 0x9055, "3c905b-tpo100", "3Com905B-TX"),        /* 10/100 TPO */
980 PCI_ROM(0x10b7, 0x9056, "3c905b-t4",     "3Com905B-T4"),        /* 10/100 T4 */
981 PCI_ROM(0x10b7, 0x9058, "3c905b-9058",   "3Com905B-9058"),      /* Cyclone 10/100/BNC */
982 PCI_ROM(0x10b7, 0x905a, "3c905b-fx",     "3Com905B-FL"),        /* 100 Base FX / 10 Base FX */
983 /* Newer 90xC revision: */
984 PCI_ROM(0x10b7, 0x9200, "3c905c-tpo",    "3Com905C-TXM"),       /* 10/100 TPO (3C905C-TXM) */
985 PCI_ROM(0x10b7, 0x9202, "3c920b-emb-ati", "3c920B-EMB-WNM (ATI Radeon 9100 IGP)"),      /* 3c920B-EMB-WNM (ATI Radeon 9100 IGP) */
986 PCI_ROM(0x10b7, 0x9210, "3c920b-emb-wnm","3Com20B-EMB WNM"),
987 PCI_ROM(0x10b7, 0x9800, "3c980",         "3Com980-Cyclone"),    /* Cyclone */
988 PCI_ROM(0x10b7, 0x9805, "3c9805",        "3Com9805"),           /* Dual Port Server Cyclone */
989 PCI_ROM(0x10b7, 0x7646, "3csoho100-tx",  "3CSOHO100-TX"),       /* Hurricane */
990 PCI_ROM(0x10b7, 0x4500, "3c450",         "3Com450 HomePNA Tornado"),
991 PCI_ROM(0x10b7, 0x1201, "3c982a",        "3Com982A"),
992 PCI_ROM(0x10b7, 0x1202, "3c982b",        "3Com982B"),
993 };
994
995 static struct pci_driver a3c90x_driver =
996         PCI_DRIVER ( "3C90X", a3c90x_nics, PCI_NO_CLASS );
997
998 BOOT_DRIVER ( "3C90X", a3c90x_probe );