Import from Etherboot 5.4
[people/oremanj/gpxe.git] / src / drivers / net / forcedeth.c
1 /**************************************************************************
2 *    forcedeth.c -- Etherboot device driver for the NVIDIA nForce 
3 *                       media access controllers.
4 *
5 * Note: This driver is based on the Linux driver that was based on
6 *      a cleanroom reimplementation which was based on reverse
7 *      engineered documentation written by Carl-Daniel Hailfinger
8 *      and Andrew de Quincey. It's neither supported nor endorsed
9 *      by NVIDIA Corp. Use at your own risk.
10 *
11 *    Written 2004 by Timothy Legge <tlegge@rogers.com>
12 *
13 *    This program is free software; you can redistribute it and/or modify
14 *    it under the terms of the GNU General Public License as published by
15 *    the Free Software Foundation; either version 2 of the License, or
16 *    (at your option) any later version.
17 *
18 *    This program is distributed in the hope that it will be useful,
19 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
20 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 *    GNU General Public License for more details.
22 *
23 *    You should have received a copy of the GNU General Public License
24 *    along with this program; if not, write to the Free Software
25 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 *
27 *    Portions of this code based on:
28 *               forcedeth: Ethernet driver for NVIDIA nForce media access controllers:
29 *
30 *       (C) 2003 Manfred Spraul
31 *               See Linux Driver for full information
32 *       
33 *       Linux Driver Version 0.22, 19 Jan 2004
34
35
36 *    REVISION HISTORY:
37 *    ================
38 *    v1.0       01-31-2004      timlegge        Initial port of Linux driver
39 *    v1.1       02-03-2004      timlegge        Large Clean up, first release 
40 *    
41 *    Indent Options: indent -kr -i8
42 ***************************************************************************/
43
44 /* to get some global routines like printf */
45 #include "etherboot.h"
46 /* to get the interface to the body of the program */
47 #include "nic.h"
48 /* to get the PCI support functions, if this is a PCI NIC */
49 #include "pci.h"
50 /* Include timer support functions */
51 #include "timer.h"
52
53 #define drv_version "v1.1"
54 #define drv_date "02-03-2004"
55
56 //#define TFTM_DEBUG
57 #ifdef TFTM_DEBUG
58 #define dprintf(x) printf x
59 #else
60 #define dprintf(x)
61 #endif
62
63 typedef unsigned char u8;
64 typedef signed char s8;
65 typedef unsigned short u16;
66 typedef signed short s16;
67 typedef unsigned int u32;
68 typedef signed int s32;
69
70 /* Condensed operations for readability. */
71 #define virt_to_le32desc(addr)  cpu_to_le32(virt_to_bus(addr))
72 #define le32desc_to_virt(addr)  bus_to_virt(le32_to_cpu(addr))
73
74 static unsigned long BASE;
75 /* NIC specific static variables go here */
76
77
78 /*
79  * Hardware access:
80  */
81
82 #define DEV_NEED_LASTPACKET1    0x0001
83 #define DEV_IRQMASK_1           0x0002
84 #define DEV_IRQMASK_2           0x0004
85 #define DEV_NEED_TIMERIRQ       0x0008
86
87 enum {
88         NvRegIrqStatus = 0x000,
89 #define NVREG_IRQSTAT_MIIEVENT  0040
90 #define NVREG_IRQSTAT_MASK              0x1ff
91         NvRegIrqMask = 0x004,
92 #define NVREG_IRQ_RX                    0x0002
93 #define NVREG_IRQ_RX_NOBUF              0x0004
94 #define NVREG_IRQ_TX_ERR                0x0008
95 #define NVREG_IRQ_TX2                   0x0010
96 #define NVREG_IRQ_TIMER                 0x0020
97 #define NVREG_IRQ_LINK                  0x0040
98 #define NVREG_IRQ_TX1                   0x0100
99 #define NVREG_IRQMASK_WANTED_1          0x005f
100 #define NVREG_IRQMASK_WANTED_2          0x0147
101 #define NVREG_IRQ_UNKNOWN               (~(NVREG_IRQ_RX|NVREG_IRQ_RX_NOBUF|NVREG_IRQ_TX_ERR|NVREG_IRQ_TX2|NVREG_IRQ_TIMER|NVREG_IRQ_LINK|NVREG_IRQ_TX1))
102
103         NvRegUnknownSetupReg6 = 0x008,
104 #define NVREG_UNKSETUP6_VAL             3
105
106 /*
107  * NVREG_POLL_DEFAULT is the interval length of the timer source on the nic
108  * NVREG_POLL_DEFAULT=97 would result in an interval length of 1 ms
109  */
110         NvRegPollingInterval = 0x00c,
111 #define NVREG_POLL_DEFAULT      970
112         NvRegMisc1 = 0x080,
113 #define NVREG_MISC1_HD          0x02
114 #define NVREG_MISC1_FORCE       0x3b0f3c
115
116         NvRegTransmitterControl = 0x084,
117 #define NVREG_XMITCTL_START     0x01
118         NvRegTransmitterStatus = 0x088,
119 #define NVREG_XMITSTAT_BUSY     0x01
120
121         NvRegPacketFilterFlags = 0x8c,
122 #define NVREG_PFF_ALWAYS        0x7F0008
123 #define NVREG_PFF_PROMISC       0x80
124 #define NVREG_PFF_MYADDR        0x20
125
126         NvRegOffloadConfig = 0x90,
127 #define NVREG_OFFLOAD_HOMEPHY   0x601
128 #define NVREG_OFFLOAD_NORMAL    0x5ee
129         NvRegReceiverControl = 0x094,
130 #define NVREG_RCVCTL_START      0x01
131         NvRegReceiverStatus = 0x98,
132 #define NVREG_RCVSTAT_BUSY      0x01
133
134         NvRegRandomSeed = 0x9c,
135 #define NVREG_RNDSEED_MASK      0x00ff
136 #define NVREG_RNDSEED_FORCE     0x7f00
137
138         NvRegUnknownSetupReg1 = 0xA0,
139 #define NVREG_UNKSETUP1_VAL     0x16070f
140         NvRegUnknownSetupReg2 = 0xA4,
141 #define NVREG_UNKSETUP2_VAL     0x16
142         NvRegMacAddrA = 0xA8,
143         NvRegMacAddrB = 0xAC,
144         NvRegMulticastAddrA = 0xB0,
145 #define NVREG_MCASTADDRA_FORCE  0x01
146         NvRegMulticastAddrB = 0xB4,
147         NvRegMulticastMaskA = 0xB8,
148         NvRegMulticastMaskB = 0xBC,
149
150         NvRegTxRingPhysAddr = 0x100,
151         NvRegRxRingPhysAddr = 0x104,
152         NvRegRingSizes = 0x108,
153 #define NVREG_RINGSZ_TXSHIFT 0
154 #define NVREG_RINGSZ_RXSHIFT 16
155         NvRegUnknownTransmitterReg = 0x10c,
156         NvRegLinkSpeed = 0x110,
157 #define NVREG_LINKSPEED_FORCE 0x10000
158 #define NVREG_LINKSPEED_10      10
159 #define NVREG_LINKSPEED_100     100
160 #define NVREG_LINKSPEED_1000    1000
161         NvRegUnknownSetupReg5 = 0x130,
162 #define NVREG_UNKSETUP5_BIT31   (1<<31)
163         NvRegUnknownSetupReg3 = 0x134,
164 #define NVREG_UNKSETUP3_VAL1    0x200010
165         NvRegTxRxControl = 0x144,
166 #define NVREG_TXRXCTL_KICK      0x0001
167 #define NVREG_TXRXCTL_BIT1      0x0002
168 #define NVREG_TXRXCTL_BIT2      0x0004
169 #define NVREG_TXRXCTL_IDLE      0x0008
170 #define NVREG_TXRXCTL_RESET     0x0010
171         NvRegMIIStatus = 0x180,
172 #define NVREG_MIISTAT_ERROR             0x0001
173 #define NVREG_MIISTAT_LINKCHANGE        0x0008
174 #define NVREG_MIISTAT_MASK              0x000f
175 #define NVREG_MIISTAT_MASK2             0x000f
176         NvRegUnknownSetupReg4 = 0x184,
177 #define NVREG_UNKSETUP4_VAL     8
178
179         NvRegAdapterControl = 0x188,
180 #define NVREG_ADAPTCTL_START    0x02
181 #define NVREG_ADAPTCTL_LINKUP   0x04
182 #define NVREG_ADAPTCTL_PHYVALID 0x4000
183 #define NVREG_ADAPTCTL_RUNNING  0x100000
184 #define NVREG_ADAPTCTL_PHYSHIFT 24
185         NvRegMIISpeed = 0x18c,
186 #define NVREG_MIISPEED_BIT8     (1<<8)
187 #define NVREG_MIIDELAY  5
188         NvRegMIIControl = 0x190,
189 #define NVREG_MIICTL_INUSE      0x10000
190 #define NVREG_MIICTL_WRITE      0x08000
191 #define NVREG_MIICTL_ADDRSHIFT  5
192         NvRegMIIData = 0x194,
193         NvRegWakeUpFlags = 0x200,
194 #define NVREG_WAKEUPFLAGS_VAL           0x7770
195 #define NVREG_WAKEUPFLAGS_BUSYSHIFT     24
196 #define NVREG_WAKEUPFLAGS_ENABLESHIFT   16
197 #define NVREG_WAKEUPFLAGS_D3SHIFT       12
198 #define NVREG_WAKEUPFLAGS_D2SHIFT       8
199 #define NVREG_WAKEUPFLAGS_D1SHIFT       4
200 #define NVREG_WAKEUPFLAGS_D0SHIFT       0
201 #define NVREG_WAKEUPFLAGS_ACCEPT_MAGPAT         0x01
202 #define NVREG_WAKEUPFLAGS_ACCEPT_WAKEUPPAT      0x02
203 #define NVREG_WAKEUPFLAGS_ACCEPT_LINKCHANGE     0x04
204
205         NvRegPatternCRC = 0x204,
206         NvRegPatternMask = 0x208,
207         NvRegPowerCap = 0x268,
208 #define NVREG_POWERCAP_D3SUPP   (1<<30)
209 #define NVREG_POWERCAP_D2SUPP   (1<<26)
210 #define NVREG_POWERCAP_D1SUPP   (1<<25)
211         NvRegPowerState = 0x26c,
212 #define NVREG_POWERSTATE_POWEREDUP      0x8000
213 #define NVREG_POWERSTATE_VALID          0x0100
214 #define NVREG_POWERSTATE_MASK           0x0003
215 #define NVREG_POWERSTATE_D0             0x0000
216 #define NVREG_POWERSTATE_D1             0x0001
217 #define NVREG_POWERSTATE_D2             0x0002
218 #define NVREG_POWERSTATE_D3             0x0003
219 };
220
221
222
223 #define NV_TX_LASTPACKET        (1<<0)
224 #define NV_TX_RETRYERROR        (1<<3)
225 #define NV_TX_LASTPACKET1       (1<<8)
226 #define NV_TX_DEFERRED          (1<<10)
227 #define NV_TX_CARRIERLOST       (1<<11)
228 #define NV_TX_LATECOLLISION     (1<<12)
229 #define NV_TX_UNDERFLOW         (1<<13)
230 #define NV_TX_ERROR             (1<<14)
231 #define NV_TX_VALID             (1<<15)
232
233 #define NV_RX_DESCRIPTORVALID   (1<<0)
234 #define NV_RX_MISSEDFRAME       (1<<1)
235 #define NV_RX_SUBSTRACT1        (1<<3)
236 #define NV_RX_ERROR1            (1<<7)
237 #define NV_RX_ERROR2            (1<<8)
238 #define NV_RX_ERROR3            (1<<9)
239 #define NV_RX_ERROR4            (1<<10)
240 #define NV_RX_CRCERR            (1<<11)
241 #define NV_RX_OVERFLOW          (1<<12)
242 #define NV_RX_FRAMINGERR        (1<<13)
243 #define NV_RX_ERROR             (1<<14)
244 #define NV_RX_AVAIL             (1<<15)
245
246 /* Miscelaneous hardware related defines: */
247 #define NV_PCI_REGSZ            0x270
248
249 /* various timeout delays: all in usec */
250 #define NV_TXRX_RESET_DELAY     4
251 #define NV_TXSTOP_DELAY1        10
252 #define NV_TXSTOP_DELAY1MAX     500000
253 #define NV_TXSTOP_DELAY2        100
254 #define NV_RXSTOP_DELAY1        10
255 #define NV_RXSTOP_DELAY1MAX     500000
256 #define NV_RXSTOP_DELAY2        100
257 #define NV_SETUP5_DELAY         5
258 #define NV_SETUP5_DELAYMAX      50000
259 #define NV_POWERUP_DELAY        5
260 #define NV_POWERUP_DELAYMAX     5000
261 #define NV_MIIBUSY_DELAY        50
262 #define NV_MIIPHY_DELAY 10
263 #define NV_MIIPHY_DELAYMAX      10000
264
265 #define NV_WAKEUPPATTERNS       5
266 #define NV_WAKEUPMASKENTRIES    4
267
268 /* General driver defaults */
269 #define NV_WATCHDOG_TIMEO       (2*HZ)
270 #define DEFAULT_MTU             1500    /* also maximum supported, at least for now */
271
272 #define RX_RING         4
273 #define TX_RING         2
274 /* limited to 1 packet until we understand NV_TX_LASTPACKET */
275 #define TX_LIMIT_STOP   10
276 #define TX_LIMIT_START  5
277
278 /* rx/tx mac addr + type + vlan + align + slack*/
279 #define RX_NIC_BUFSIZE          (DEFAULT_MTU + 64)
280 /* even more slack */
281 #define RX_ALLOC_BUFSIZE        (DEFAULT_MTU + 128)
282
283 #define OOM_REFILL      (1+HZ/20)
284 #define POLL_WAIT       (1+HZ/100)
285
286 struct ring_desc {
287         u32 PacketBuffer;
288         u16 Length;
289         u16 Flags;
290 };
291
292
293 /* Define the TX and RX Descriptor and Buffers */
294 struct {
295         struct ring_desc tx_ring[TX_RING];
296         unsigned char txb[TX_RING * RX_NIC_BUFSIZE];
297         struct ring_desc rx_ring[RX_RING];
298         unsigned char rxb[RX_RING * RX_NIC_BUFSIZE];
299 } forcedeth_bufs __shared;
300 #define tx_ring forcedeth_bufs.tx_ring
301 #define rx_ring forcedeth_bufs.rx_ring
302 #define txb forcedeth_bufs.txb
303 #define rxb forcedeth_bufs.rxb
304
305 /* Private Storage for the NIC */
306 static struct forcedeth_private {
307         /* General data:
308          * Locking: spin_lock(&np->lock); */
309         int in_shutdown;
310         u32 linkspeed;
311         int duplex;
312         int phyaddr;
313
314         /* General data: RO fields */
315         u8 *ring_addr;
316         u32 orig_mac[2];
317         u32 irqmask;
318         /* rx specific fields.
319          * Locking: Within irq hander or disable_irq+spin_lock(&np->lock);
320          */
321         unsigned int cur_rx, refill_rx;
322         unsigned int rx_buf_sz;
323
324         /*
325          * tx specific fields.
326          */
327         unsigned int next_tx, nic_tx;
328         u16 tx_flags;
329 } npx;
330
331 static struct forcedeth_private *np;
332
333 static inline void pci_push(u8 * base)
334 {
335         /* force out pending posted writes */
336         readl(base);
337 }
338 static int reg_delay(int offset, u32 mask,
339                      u32 target, int delay, int delaymax, const char *msg)
340 {
341         u8 *base = (u8 *) BASE;
342
343         pci_push(base);
344         do {
345                 udelay(delay);
346                 delaymax -= delay;
347                 if (delaymax < 0) {
348                         if (msg)
349                                 printf(msg);
350                         return 1;
351                 }
352         } while ((readl(base + offset) & mask) != target);
353         return 0;
354 }
355
356 #define MII_READ        (-1)
357 #define MII_PHYSID1         0x02        /* PHYS ID 1                   */
358 #define MII_PHYSID2         0x03        /* PHYS ID 2                   */
359 #define MII_BMCR            0x00        /* Basic mode control register */
360 #define MII_BMSR            0x01        /* Basic mode status register  */
361 #define MII_ADVERTISE       0x04        /* Advertisement control reg   */
362 #define MII_LPA             0x05        /* Link partner ability reg    */
363
364 #define BMSR_ANEGCOMPLETE       0x0020  /* Auto-negotiation complete   */
365
366 /* Link partner ability register. */
367 #define LPA_SLCT                0x001f  /* Same as advertise selector  */
368 #define LPA_10HALF              0x0020  /* Can do 10mbps half-duplex   */
369 #define LPA_10FULL              0x0040  /* Can do 10mbps full-duplex   */
370 #define LPA_100HALF             0x0080  /* Can do 100mbps half-duplex  */
371 #define LPA_100FULL             0x0100  /* Can do 100mbps full-duplex  */
372 #define LPA_100BASE4            0x0200  /* Can do 100mbps 4k packets   */
373 #define LPA_RESV                0x1c00  /* Unused...                   */
374 #define LPA_RFAULT              0x2000  /* Link partner faulted        */
375 #define LPA_LPACK               0x4000  /* Link partner acked us       */
376 #define LPA_NPAGE               0x8000  /* Next page bit               */
377
378 /* mii_rw: read/write a register on the PHY.
379  *
380  * Caller must guarantee serialization
381  */
382 static int mii_rw(struct nic *nic __unused, int addr, int miireg,
383                   int value)
384 {
385         u8 *base = (u8 *) BASE;
386         int was_running;
387         u32 reg;
388         int retval;
389
390         writel(NVREG_MIISTAT_MASK, base + NvRegMIIStatus);
391         was_running = 0;
392         reg = readl(base + NvRegAdapterControl);
393         if (reg & NVREG_ADAPTCTL_RUNNING) {
394                 was_running = 1;
395                 writel(reg & ~NVREG_ADAPTCTL_RUNNING,
396                        base + NvRegAdapterControl);
397         }
398         reg = readl(base + NvRegMIIControl);
399         if (reg & NVREG_MIICTL_INUSE) {
400                 writel(NVREG_MIICTL_INUSE, base + NvRegMIIControl);
401                 udelay(NV_MIIBUSY_DELAY);
402         }
403
404         reg =
405             NVREG_MIICTL_INUSE | (addr << NVREG_MIICTL_ADDRSHIFT) | miireg;
406         if (value != MII_READ) {
407                 writel(value, base + NvRegMIIData);
408                 reg |= NVREG_MIICTL_WRITE;
409         }
410         writel(reg, base + NvRegMIIControl);
411
412         if (reg_delay(NvRegMIIControl, NVREG_MIICTL_INUSE, 0,
413                       NV_MIIPHY_DELAY, NV_MIIPHY_DELAYMAX, NULL)) {
414                 dprintf(("mii_rw of reg %d at PHY %d timed out.\n",
415                          miireg, addr));
416                 retval = -1;
417         } else if (value != MII_READ) {
418                 /* it was a write operation - fewer failures are detectable */
419                 dprintf(("mii_rw wrote 0x%x to reg %d at PHY %d\n",
420                          value, miireg, addr));
421                 retval = 0;
422         } else if (readl(base + NvRegMIIStatus) & NVREG_MIISTAT_ERROR) {
423                 dprintf(("mii_rw of reg %d at PHY %d failed.\n",
424                          miireg, addr));
425                 retval = -1;
426         } else {
427                 /* FIXME: why is that required? */
428                 udelay(50);
429                 retval = readl(base + NvRegMIIData);
430                 dprintf(("mii_rw read from reg %d at PHY %d: 0x%x.\n",
431                          miireg, addr, retval));
432         }
433         if (was_running) {
434                 reg = readl(base + NvRegAdapterControl);
435                 writel(reg | NVREG_ADAPTCTL_RUNNING,
436                        base + NvRegAdapterControl);
437         }
438         return retval;
439 }
440
441 static void start_rx(struct nic *nic __unused)
442 {
443         u8 *base = (u8 *) BASE;
444
445         dprintf(("start_rx\n"));
446         /* Already running? Stop it. */
447         if (readl(base + NvRegReceiverControl) & NVREG_RCVCTL_START) {
448                 writel(0, base + NvRegReceiverControl);
449                 pci_push(base);
450         }
451         writel(np->linkspeed, base + NvRegLinkSpeed);
452         pci_push(base);
453         writel(NVREG_RCVCTL_START, base + NvRegReceiverControl);
454         pci_push(base);
455 }
456
457 static void stop_rx(void)
458 {
459         u8 *base = (u8 *) BASE;
460
461         dprintf(("stop_rx\n"));
462         writel(0, base + NvRegReceiverControl);
463         reg_delay(NvRegReceiverStatus, NVREG_RCVSTAT_BUSY, 0,
464                   NV_RXSTOP_DELAY1, NV_RXSTOP_DELAY1MAX,
465                   "stop_rx: ReceiverStatus remained busy");
466
467         udelay(NV_RXSTOP_DELAY2);
468         writel(0, base + NvRegLinkSpeed);
469 }
470
471 static void start_tx(struct nic *nic __unused)
472 {
473         u8 *base = (u8 *) BASE;
474
475         dprintf(("start_tx\n"));
476         writel(NVREG_XMITCTL_START, base + NvRegTransmitterControl);
477         pci_push(base);
478 }
479
480 static void stop_tx(void)
481 {
482         u8 *base = (u8 *) BASE;
483
484         dprintf(("stop_tx\n"));
485         writel(0, base + NvRegTransmitterControl);
486         reg_delay(NvRegTransmitterStatus, NVREG_XMITSTAT_BUSY, 0,
487                   NV_TXSTOP_DELAY1, NV_TXSTOP_DELAY1MAX,
488                   "stop_tx: TransmitterStatus remained busy");
489
490         udelay(NV_TXSTOP_DELAY2);
491         writel(0, base + NvRegUnknownTransmitterReg);
492 }
493
494
495 static void txrx_reset(struct nic *nic __unused)
496 {
497         u8 *base = (u8 *) BASE;
498
499         dprintf(("txrx_reset\n"));
500         writel(NVREG_TXRXCTL_BIT2 | NVREG_TXRXCTL_RESET,
501                base + NvRegTxRxControl);
502         pci_push(base);
503         udelay(NV_TXRX_RESET_DELAY);
504         writel(NVREG_TXRXCTL_BIT2, base + NvRegTxRxControl);
505         pci_push(base);
506 }
507
508 /*
509  * alloc_rx: fill rx ring entries.
510  * Return 1 if the allocations for the skbs failed and the
511  * rx engine is without Available descriptors
512  */
513 static int alloc_rx(struct nic *nic __unused)
514 {
515         unsigned int refill_rx = np->refill_rx;
516         int i;
517         //while (np->cur_rx != refill_rx) {
518         for (i = 0; i < RX_RING; i++) {
519                 //int nr = refill_rx % RX_RING;
520                 rx_ring[i].PacketBuffer =
521                     virt_to_le32desc(&rxb[i * RX_NIC_BUFSIZE]);
522                 rx_ring[i].Length = cpu_to_le16(RX_NIC_BUFSIZE);
523                 wmb();
524                 rx_ring[i].Flags = cpu_to_le16(NV_RX_AVAIL);
525                 /*      printf("alloc_rx: Packet  %d marked as Available\n",
526                    refill_rx); */
527                 refill_rx++;
528         }
529         np->refill_rx = refill_rx;
530         if (np->cur_rx - refill_rx == RX_RING)
531                 return 1;
532         return 0;
533 }
534
535 static int update_linkspeed(struct nic *nic)
536 {
537         int adv, lpa, newdup;
538         u32 newls;
539         adv = mii_rw(nic, np->phyaddr, MII_ADVERTISE, MII_READ);
540         lpa = mii_rw(nic, np->phyaddr, MII_LPA, MII_READ);
541         dprintf(("update_linkspeed: PHY advertises 0x%hX, lpa 0x%hX.\n",
542                  adv, lpa));
543
544         /* FIXME: handle parallel detection properly, handle gigabit ethernet */
545         lpa = lpa & adv;
546         if (lpa & LPA_100FULL) {
547                 newls = NVREG_LINKSPEED_FORCE | NVREG_LINKSPEED_100;
548                 newdup = 1;
549         } else if (lpa & LPA_100HALF) {
550                 newls = NVREG_LINKSPEED_FORCE | NVREG_LINKSPEED_100;
551                 newdup = 0;
552         } else if (lpa & LPA_10FULL) {
553                 newls = NVREG_LINKSPEED_FORCE | NVREG_LINKSPEED_10;
554                 newdup = 1;
555         } else if (lpa & LPA_10HALF) {
556                 newls = NVREG_LINKSPEED_FORCE | NVREG_LINKSPEED_10;
557                 newdup = 0;
558         } else {
559                 printf("bad ability %hX - falling back to 10HD.\n", lpa);
560                 newls = NVREG_LINKSPEED_FORCE | NVREG_LINKSPEED_10;
561                 newdup = 0;
562         }
563         if (np->duplex != newdup || np->linkspeed != newls) {
564                 np->duplex = newdup;
565                 np->linkspeed = newls;
566                 return 1;
567         }
568         return 0;
569 }
570
571
572
573 static int init_ring(struct nic *nic)
574 {
575         int i;
576
577         np->next_tx = np->nic_tx = 0;
578         for (i = 0; i < TX_RING; i++) {
579                 tx_ring[i].Flags = 0;
580         }
581
582         np->cur_rx = 0;
583         np->refill_rx = 0;
584         for (i = 0; i < RX_RING; i++) {
585                 rx_ring[i].Flags = 0;
586         }
587         return alloc_rx(nic);
588 }
589
590 static void set_multicast(struct nic *nic)
591 {
592
593         u8 *base = (u8 *) BASE;
594         u32 addr[2];
595         u32 mask[2];
596         u32 pff;
597         u32 alwaysOff[2];
598         u32 alwaysOn[2];
599
600         memset(addr, 0, sizeof(addr));
601         memset(mask, 0, sizeof(mask));
602
603         pff = NVREG_PFF_MYADDR;
604
605         alwaysOn[0] = alwaysOn[1] = alwaysOff[0] = alwaysOff[1] = 0;
606
607         addr[0] = alwaysOn[0];
608         addr[1] = alwaysOn[1];
609         mask[0] = alwaysOn[0] | alwaysOff[0];
610         mask[1] = alwaysOn[1] | alwaysOff[1];
611
612         addr[0] |= NVREG_MCASTADDRA_FORCE;
613         pff |= NVREG_PFF_ALWAYS;
614         stop_rx();
615         writel(addr[0], base + NvRegMulticastAddrA);
616         writel(addr[1], base + NvRegMulticastAddrB);
617         writel(mask[0], base + NvRegMulticastMaskA);
618         writel(mask[1], base + NvRegMulticastMaskB);
619         writel(pff, base + NvRegPacketFilterFlags);
620         start_rx(nic);
621 }
622
623 /**************************************************************************
624 RESET - Reset the NIC to prepare for use
625 ***************************************************************************/
626 static int forcedeth_reset(struct nic *nic)
627 {
628         u8 *base = (u8 *) BASE;
629         int ret, oom, i;
630         ret = 0;
631         dprintf(("forcedeth: open\n"));
632
633         /* 1) erase previous misconfiguration */
634         /* 4.1-1: stop adapter: ignored, 4.3 seems to be overkill */
635         writel(NVREG_MCASTADDRA_FORCE, base + NvRegMulticastAddrA);
636         writel(0, base + NvRegMulticastAddrB);
637         writel(0, base + NvRegMulticastMaskA);
638         writel(0, base + NvRegMulticastMaskB);
639         writel(0, base + NvRegPacketFilterFlags);
640         writel(0, base + NvRegAdapterControl);
641         writel(0, base + NvRegLinkSpeed);
642         writel(0, base + NvRegUnknownTransmitterReg);
643         txrx_reset(nic);
644         writel(0, base + NvRegUnknownSetupReg6);
645
646         /* 2) initialize descriptor rings */
647         np->in_shutdown = 0;
648         oom = init_ring(nic);
649
650         /* 3) set mac address */
651         {
652                 u32 mac[2];
653
654                 mac[0] =
655                     (nic->node_addr[0] << 0) + (nic->node_addr[1] << 8) +
656                     (nic->node_addr[2] << 16) + (nic->node_addr[3] << 24);
657                 mac[1] =
658                     (nic->node_addr[4] << 0) + (nic->node_addr[5] << 8);
659
660                 writel(mac[0], base + NvRegMacAddrA);
661                 writel(mac[1], base + NvRegMacAddrB);
662         }
663
664         /* 4) continue setup */
665         np->linkspeed = NVREG_LINKSPEED_FORCE | NVREG_LINKSPEED_10;
666         np->duplex = 0;
667         writel(NVREG_UNKSETUP3_VAL1, base + NvRegUnknownSetupReg3);
668         writel(0, base + NvRegTxRxControl);
669         pci_push(base);
670         writel(NVREG_TXRXCTL_BIT1, base + NvRegTxRxControl);
671
672         reg_delay(NvRegUnknownSetupReg5, NVREG_UNKSETUP5_BIT31,
673                   NVREG_UNKSETUP5_BIT31, NV_SETUP5_DELAY,
674                   NV_SETUP5_DELAYMAX,
675                   "open: SetupReg5, Bit 31 remained off\n");
676         writel(0, base + NvRegUnknownSetupReg4);
677
678         /* 5) Find a suitable PHY */
679         writel(NVREG_MIISPEED_BIT8 | NVREG_MIIDELAY, base + NvRegMIISpeed);
680         for (i = 1; i < 32; i++) {
681                 int id1, id2;
682
683                 id1 = mii_rw(nic, i, MII_PHYSID1, MII_READ);
684                 if (id1 < 0)
685                         continue;
686                 id2 = mii_rw(nic, i, MII_PHYSID2, MII_READ);
687                 if (id2 < 0)
688                         continue;
689                 dprintf(("open: Found PHY %04x:%04x at address %d.\n",
690                          id1, id2, i));
691                 np->phyaddr = i;
692
693                 update_linkspeed(nic);
694
695                 break;
696         }
697         if (i == 32) {
698                 printf("open: failing due to lack of suitable PHY.\n");
699                 ret = -1;
700                 goto out_drain;
701         }
702
703         printf("%d-Mbs Link, %s-Duplex\n",
704                np->linkspeed & NVREG_LINKSPEED_10 ? 10 : 100,
705                np->duplex ? "Full" : "Half");
706         /* 6) continue setup */
707         writel(NVREG_MISC1_FORCE | (np->duplex ? 0 : NVREG_MISC1_HD),
708                base + NvRegMisc1);
709         writel(readl(base + NvRegTransmitterStatus),
710                base + NvRegTransmitterStatus);
711         writel(NVREG_PFF_ALWAYS, base + NvRegPacketFilterFlags);
712         writel(NVREG_OFFLOAD_NORMAL, base + NvRegOffloadConfig);
713
714         writel(readl(base + NvRegReceiverStatus),
715                base + NvRegReceiverStatus);
716
717         /* FIXME: I cheated and used the calculator to get a random number */
718         i = 75963081;
719         writel(NVREG_RNDSEED_FORCE | (i & NVREG_RNDSEED_MASK),
720                base + NvRegRandomSeed);
721         writel(NVREG_UNKSETUP1_VAL, base + NvRegUnknownSetupReg1);
722         writel(NVREG_UNKSETUP2_VAL, base + NvRegUnknownSetupReg2);
723         writel(NVREG_POLL_DEFAULT, base + NvRegPollingInterval);
724         writel(NVREG_UNKSETUP6_VAL, base + NvRegUnknownSetupReg6);
725         writel((np->
726                 phyaddr << NVREG_ADAPTCTL_PHYSHIFT) |
727                NVREG_ADAPTCTL_PHYVALID, base + NvRegAdapterControl);
728         writel(NVREG_UNKSETUP4_VAL, base + NvRegUnknownSetupReg4);
729         writel(NVREG_WAKEUPFLAGS_VAL, base + NvRegWakeUpFlags);
730
731         /* 7) start packet processing */
732         writel((u32) virt_to_le32desc(&rx_ring[0]),
733                base + NvRegRxRingPhysAddr);
734         writel((u32) virt_to_le32desc(&tx_ring[0]),
735                base + NvRegTxRingPhysAddr);
736
737
738         writel(((RX_RING - 1) << NVREG_RINGSZ_RXSHIFT) +
739                ((TX_RING - 1) << NVREG_RINGSZ_TXSHIFT),
740                base + NvRegRingSizes);
741
742         i = readl(base + NvRegPowerState);
743         if ((i & NVREG_POWERSTATE_POWEREDUP) == 0) {
744                 writel(NVREG_POWERSTATE_POWEREDUP | i,
745                        base + NvRegPowerState);
746         }
747         pci_push(base);
748         udelay(10);
749         writel(readl(base + NvRegPowerState) | NVREG_POWERSTATE_VALID,
750                base + NvRegPowerState);
751         writel(NVREG_ADAPTCTL_RUNNING, base + NvRegAdapterControl);
752
753         writel(0, base + NvRegIrqMask);
754         pci_push(base);
755         writel(NVREG_IRQSTAT_MASK, base + NvRegIrqStatus);
756         pci_push(base);
757         writel(NVREG_MIISTAT_MASK2, base + NvRegMIIStatus);
758         writel(NVREG_IRQSTAT_MASK, base + NvRegIrqStatus);
759         pci_push(base);
760 /*
761         writel(np->irqmask, base + NvRegIrqMask);
762 */
763         writel(NVREG_MCASTADDRA_FORCE, base + NvRegMulticastAddrA);
764         writel(0, base + NvRegMulticastAddrB);
765         writel(0, base + NvRegMulticastMaskA);
766         writel(0, base + NvRegMulticastMaskB);
767         writel(NVREG_PFF_ALWAYS | NVREG_PFF_MYADDR,
768                base + NvRegPacketFilterFlags);
769
770         set_multicast(nic);
771         //start_rx(nic);
772         start_tx(nic);
773
774         if (!
775             (mii_rw(nic, np->phyaddr, MII_BMSR, MII_READ) &
776              BMSR_ANEGCOMPLETE)) {
777                 printf("no link during initialization.\n");
778         }
779
780         udelay(10000);
781       out_drain:
782         return ret;
783 }
784
785 //extern void hex_dump(const char *data, const unsigned int len);
786
787 /**************************************************************************
788 POLL - Wait for a frame
789 ***************************************************************************/
790 static int forcedeth_poll(struct nic *nic, int retrieve)
791 {
792         /* return true if there's an ethernet packet ready to read */
793         /* nic->packet should contain data on return */
794         /* nic->packetlen should contain length of data */
795
796         struct ring_desc *prd;
797         int len;
798         int i;
799
800         i = np->cur_rx % RX_RING;
801         prd = &rx_ring[i];
802
803         if ( ! (prd->Flags & cpu_to_le16(NV_RX_DESCRIPTORVALID)) ) {
804           return 0;
805         }
806
807         if ( ! retrieve ) return 1;
808
809         /* got a valid packet - forward it to the network core */
810         len = cpu_to_le16(prd->Length);
811         nic->packetlen = len;
812         //hex_dump(rxb + (i * RX_NIC_BUFSIZE), len);
813         memcpy(nic->packet, rxb +
814                (i * RX_NIC_BUFSIZE), nic->packetlen);
815
816         wmb();
817         np->cur_rx++;
818         alloc_rx(nic);
819         return 1;
820 }
821
822
823 /**************************************************************************
824 TRANSMIT - Transmit a frame
825 ***************************************************************************/
826 static void forcedeth_transmit(struct nic *nic, const char *d,  /* Destination */
827                                unsigned int t,  /* Type */
828                                unsigned int s,  /* size */
829                                const char *p)
830 {                               /* Packet */
831         /* send the packet to destination */
832         u8 *ptxb;
833         u16 nstype;
834         //u16 status;
835         u8 *base = (u8 *) BASE;
836         int nr = np->next_tx % TX_RING;
837
838         /* point to the current txb incase multiple tx_rings are used */
839         ptxb = txb + (nr * RX_NIC_BUFSIZE);
840         //np->tx_skbuff[nr] = ptxb;
841
842         /* copy the packet to ring buffer */
843         memcpy(ptxb, d, ETH_ALEN);      /* dst */
844         memcpy(ptxb + ETH_ALEN, nic->node_addr, ETH_ALEN);      /* src */
845         nstype = htons((u16) t);        /* type */
846         memcpy(ptxb + 2 * ETH_ALEN, (u8 *) & nstype, 2);        /* type */
847         memcpy(ptxb + ETH_HLEN, p, s);
848
849         s += ETH_HLEN;
850         while (s < ETH_ZLEN)    /* pad to min length */
851                 ptxb[s++] = '\0';
852
853         tx_ring[nr].PacketBuffer = (u32) virt_to_le32desc(ptxb);
854         tx_ring[nr].Length = cpu_to_le16(s - 1);
855
856         wmb();
857         tx_ring[nr].Flags = np->tx_flags;
858
859         writel(NVREG_TXRXCTL_KICK, base + NvRegTxRxControl);
860         pci_push(base);
861         tx_ring[nr].Flags = np->tx_flags;
862         np->next_tx++;
863 }
864
865 /**************************************************************************
866 DISABLE - Turn off ethernet interface
867 ***************************************************************************/
868 static void forcedeth_disable ( struct nic *nic __unused ) {
869         /* put the card in its initial state */
870         /* This function serves 3 purposes.
871          * This disables DMA and interrupts so we don't receive
872          *  unexpected packets or interrupts from the card after
873          *  etherboot has finished. 
874          * This frees resources so etherboot may use
875          *  this driver on another interface
876          * This allows etherboot to reinitialize the interface
877          *  if something is something goes wrong.
878          */
879         u8 *base = (u8 *) BASE;
880         np->in_shutdown = 1;
881         stop_tx();
882         stop_rx();
883
884         /* disable interrupts on the nic or we will lock up */
885         writel(0, base + NvRegIrqMask);
886         pci_push(base);
887         dprintf(("Irqmask is zero again\n"));
888
889         /* specia op:o write back the misordered MAC address - otherwise
890          * the next probe_nic would see a wrong address.
891          */
892         writel(np->orig_mac[0], base + NvRegMacAddrA);
893         writel(np->orig_mac[1], base + NvRegMacAddrB);
894 }
895
896 /**************************************************************************
897 IRQ - Enable, Disable, or Force interrupts
898 ***************************************************************************/
899 static void forcedeth_irq(struct nic *nic __unused, irq_action_t action __unused)
900 {
901   switch ( action ) {
902   case DISABLE :
903     break;
904   case ENABLE :
905     break;
906   case FORCE :
907     break;
908   }
909 }
910
911 static struct nic_operations forcedeth_operations = {
912         .connect        = dummy_connect,
913         .poll           = forcedeth_poll,
914         .transmit       = forcedeth_transmit,
915         .irq            = forcedeth_irq,
916
917 };
918
919 static struct pci_id forcedeth_nics[] = {
920         PCI_ROM(0x10de, 0x01C3, "nforce", "nForce Ethernet Controller"),
921         PCI_ROM(0x10de, 0x0066, "nforce2", "nForce2 Ethernet Controller"),
922         PCI_ROM(0x10de, 0x00D6, "nforce3", "nForce3 Ethernet Controller"),
923 };
924
925 PCI_DRIVER ( forcedeth_driver, forcedeth_nics, PCI_NO_CLASS );
926
927 /**************************************************************************
928 PROBE - Look for an adapter, this routine's visible to the outside
929 ***************************************************************************/
930 #define IORESOURCE_MEM 0x00000200
931 #define board_found 1
932 #define valid_link 0
933 static int forcedeth_probe ( struct nic *nic, struct pci_device *pci ) {
934
935         unsigned long addr;
936         int sz;
937         u8 *base;
938
939         if (pci->ioaddr == 0)
940                 return 0;
941
942         printf("forcedeth.c: Found %s, vendor=0x%hX, device=0x%hX\n",
943                pci->name, pci->vendor_id, pci->device_id);
944
945         pci_fill_nic ( nic, pci );
946
947         /* point to private storage */
948         np = &npx;
949
950         adjust_pci_device(pci);
951
952         addr = pci_bar_start(pci, PCI_BASE_ADDRESS_0);
953         sz = pci_bar_size(pci, PCI_BASE_ADDRESS_0);
954
955         /* BASE is used throughout to address the card */
956         BASE = (unsigned long) ioremap(addr, sz);
957         if (!BASE)
958                 return 0;
959         //rx_ring[0] = rx_ring;
960         //tx_ring[0] = tx_ring; 
961
962         /* read the mac address */
963         base = (u8 *) BASE;
964         np->orig_mac[0] = readl(base + NvRegMacAddrA);
965         np->orig_mac[1] = readl(base + NvRegMacAddrB);
966
967         nic->node_addr[0] = (np->orig_mac[1] >> 8) & 0xff;
968         nic->node_addr[1] = (np->orig_mac[1] >> 0) & 0xff;
969         nic->node_addr[2] = (np->orig_mac[0] >> 24) & 0xff;
970         nic->node_addr[3] = (np->orig_mac[0] >> 16) & 0xff;
971         nic->node_addr[4] = (np->orig_mac[0] >> 8) & 0xff;
972         nic->node_addr[5] = (np->orig_mac[0] >> 0) & 0xff;
973 #ifdef LINUX
974         if (!is_valid_ether_addr(dev->dev_addr)) {
975                 /*
976                  * Bad mac address. At least one bios sets the mac address
977                  * to 01:23:45:67:89:ab
978                  */
979                 printk(KERN_ERR
980                        "%s: Invalid Mac address detected: %02x:%02x:%02x:%02x:%02x:%02x\n",
981                        pci_name(pci_dev), dev->dev_addr[0],
982                        dev->dev_addr[1], dev->dev_addr[2],
983                        dev->dev_addr[3], dev->dev_addr[4],
984                        dev->dev_addr[5]);
985                 printk(KERN_ERR
986                        "Please complain to your hardware vendor. Switching to a random MAC.\n");
987                 dev->dev_addr[0] = 0x00;
988                 dev->dev_addr[1] = 0x00;
989                 dev->dev_addr[2] = 0x6c;
990                 get_random_bytes(&dev->dev_addr[3], 3);
991         }
992 #endif
993         printf("%s: MAC Address %!, ", pci->name, nic->node_addr);
994
995         np->tx_flags =
996             cpu_to_le16(NV_TX_LASTPACKET | NV_TX_LASTPACKET1 |
997                         NV_TX_VALID);
998         switch (pci->device_id) {
999         case 0x01C3:            // nforce
1000                 np->irqmask = NVREG_IRQMASK_WANTED_2;
1001                 np->irqmask |= NVREG_IRQ_TIMER;
1002                 break;
1003         case 0x0066:            // nforce2
1004                 np->tx_flags |= cpu_to_le16(NV_TX_LASTPACKET1);
1005                 np->irqmask = NVREG_IRQMASK_WANTED_2;
1006                 np->irqmask |= NVREG_IRQ_TIMER;
1007                 break;
1008         case 0x00D6:            // nforce3
1009                 np->tx_flags |= cpu_to_le16(NV_TX_LASTPACKET1);
1010                 np->irqmask = NVREG_IRQMASK_WANTED_2;
1011                 np->irqmask |= NVREG_IRQ_TIMER;
1012
1013         }
1014         dprintf(("%s: forcedeth.c: subsystem: %hX:%hX bound to %s\n",
1015                  pci->name, pci->vendor, pci->dev_id, pci->name));
1016
1017         forcedeth_reset(nic);
1018 //      if (board_found && valid_link)
1019         /* point to NIC specific routines */
1020         nic->nic_op     = &forcedeth_operations;
1021         return 1;
1022 //      }
1023         /* else */
1024 }
1025
1026 DRIVER ( "forcedeth", nic_driver, pci_driver, forcedeth_driver,
1027          forcedeth_probe, forcedeth_disable );