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