Remove multiple KERN_ prefixes from printk formats
[linux-2.6.git] / drivers / net / yellowfin.c
1 /* yellowfin.c: A Packet Engines G-NIC ethernet driver for linux. */
2 /*
3         Written 1997-2001 by Donald Becker.
4
5         This software may be used and distributed according to the terms of
6         the GNU General Public License (GPL), incorporated herein by reference.
7         Drivers based on or derived from this code fall under the GPL and must
8         retain the authorship, copyright and license notice.  This file is not
9         a complete program and may only be used when the entire operating
10         system is licensed under the GPL.
11
12         This driver is for the Packet Engines G-NIC PCI Gigabit Ethernet adapter.
13         It also supports the Symbios Logic version of the same chip core.
14
15         The author may be reached as becker@scyld.com, or C/O
16         Scyld Computing Corporation
17         410 Severn Ave., Suite 210
18         Annapolis MD 21403
19
20         Support and updates available at
21         http://www.scyld.com/network/yellowfin.html
22         [link no longer provides useful info -jgarzik]
23
24 */
25
26 #define DRV_NAME        "yellowfin"
27 #define DRV_VERSION     "2.1"
28 #define DRV_RELDATE     "Sep 11, 2006"
29
30 #define PFX DRV_NAME ": "
31
32 /* The user-configurable values.
33    These may be modified when a driver module is loaded.*/
34
35 static int debug = 1;                   /* 1 normal messages, 0 quiet .. 7 verbose. */
36 /* Maximum events (Rx packets, etc.) to handle at each interrupt. */
37 static int max_interrupt_work = 20;
38 static int mtu;
39 #ifdef YF_PROTOTYPE                     /* Support for prototype hardware errata. */
40 /* System-wide count of bogus-rx frames. */
41 static int bogus_rx;
42 static int dma_ctrl = 0x004A0263;                       /* Constrained by errata */
43 static int fifo_cfg = 0x0020;                           /* Bypass external Tx FIFO. */
44 #elif defined(YF_NEW)                                   /* A future perfect board :->.  */
45 static int dma_ctrl = 0x00CAC277;                       /* Override when loading module! */
46 static int fifo_cfg = 0x0028;
47 #else
48 static const int dma_ctrl = 0x004A0263;                         /* Constrained by errata */
49 static const int fifo_cfg = 0x0020;                             /* Bypass external Tx FIFO. */
50 #endif
51
52 /* Set the copy breakpoint for the copy-only-tiny-frames scheme.
53    Setting to > 1514 effectively disables this feature. */
54 static int rx_copybreak;
55
56 /* Used to pass the media type, etc.
57    No media types are currently defined.  These exist for driver
58    interoperability.
59 */
60 #define MAX_UNITS 8                             /* More are supported, limit only on options */
61 static int options[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
62 static int full_duplex[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
63
64 /* Do ugly workaround for GX server chipset errata. */
65 static int gx_fix;
66
67 /* Operational parameters that are set at compile time. */
68
69 /* Keep the ring sizes a power of two for efficiency.
70    Making the Tx ring too long decreases the effectiveness of channel
71    bonding and packet priority.
72    There are no ill effects from too-large receive rings. */
73 #define TX_RING_SIZE    16
74 #define TX_QUEUE_SIZE   12              /* Must be > 4 && <= TX_RING_SIZE */
75 #define RX_RING_SIZE    64
76 #define STATUS_TOTAL_SIZE       TX_RING_SIZE*sizeof(struct tx_status_words)
77 #define TX_TOTAL_SIZE           2*TX_RING_SIZE*sizeof(struct yellowfin_desc)
78 #define RX_TOTAL_SIZE           RX_RING_SIZE*sizeof(struct yellowfin_desc)
79
80 /* Operational parameters that usually are not changed. */
81 /* Time in jiffies before concluding the transmitter is hung. */
82 #define TX_TIMEOUT  (2*HZ)
83 #define PKT_BUF_SZ              1536                    /* Size of each temporary Rx buffer.*/
84
85 #define yellowfin_debug debug
86
87 #include <linux/module.h>
88 #include <linux/kernel.h>
89 #include <linux/string.h>
90 #include <linux/timer.h>
91 #include <linux/errno.h>
92 #include <linux/ioport.h>
93 #include <linux/slab.h>
94 #include <linux/interrupt.h>
95 #include <linux/pci.h>
96 #include <linux/init.h>
97 #include <linux/mii.h>
98 #include <linux/netdevice.h>
99 #include <linux/etherdevice.h>
100 #include <linux/skbuff.h>
101 #include <linux/ethtool.h>
102 #include <linux/crc32.h>
103 #include <linux/bitops.h>
104 #include <asm/uaccess.h>
105 #include <asm/processor.h>              /* Processor type for cache alignment. */
106 #include <asm/unaligned.h>
107 #include <asm/io.h>
108
109 /* These identify the driver base version and may not be removed. */
110 static const char version[] __devinitconst =
111   KERN_INFO DRV_NAME ".c:v1.05  1/09/2001  Written by Donald Becker <becker@scyld.com>\n"
112   "  (unofficial 2.4.x port, " DRV_VERSION ", " DRV_RELDATE ")\n";
113
114 MODULE_AUTHOR("Donald Becker <becker@scyld.com>");
115 MODULE_DESCRIPTION("Packet Engines Yellowfin G-NIC Gigabit Ethernet driver");
116 MODULE_LICENSE("GPL");
117
118 module_param(max_interrupt_work, int, 0);
119 module_param(mtu, int, 0);
120 module_param(debug, int, 0);
121 module_param(rx_copybreak, int, 0);
122 module_param_array(options, int, NULL, 0);
123 module_param_array(full_duplex, int, NULL, 0);
124 module_param(gx_fix, int, 0);
125 MODULE_PARM_DESC(max_interrupt_work, "G-NIC maximum events handled per interrupt");
126 MODULE_PARM_DESC(mtu, "G-NIC MTU (all boards)");
127 MODULE_PARM_DESC(debug, "G-NIC debug level (0-7)");
128 MODULE_PARM_DESC(rx_copybreak, "G-NIC copy breakpoint for copy-only-tiny-frames");
129 MODULE_PARM_DESC(options, "G-NIC: Bits 0-3: media type, bit 17: full duplex");
130 MODULE_PARM_DESC(full_duplex, "G-NIC full duplex setting(s) (1)");
131 MODULE_PARM_DESC(gx_fix, "G-NIC: enable GX server chipset bug workaround (0-1)");
132
133 /*
134                                 Theory of Operation
135
136 I. Board Compatibility
137
138 This device driver is designed for the Packet Engines "Yellowfin" Gigabit
139 Ethernet adapter.  The G-NIC 64-bit PCI card is supported, as well as the
140 Symbios 53C885E dual function chip.
141
142 II. Board-specific settings
143
144 PCI bus devices are configured by the system at boot time, so no jumpers
145 need to be set on the board.  The system BIOS preferably should assign the
146 PCI INTA signal to an otherwise unused system IRQ line.
147 Note: Kernel versions earlier than 1.3.73 do not support shared PCI
148 interrupt lines.
149
150 III. Driver operation
151
152 IIIa. Ring buffers
153
154 The Yellowfin uses the Descriptor Based DMA Architecture specified by Apple.
155 This is a descriptor list scheme similar to that used by the EEPro100 and
156 Tulip.  This driver uses two statically allocated fixed-size descriptor lists
157 formed into rings by a branch from the final descriptor to the beginning of
158 the list.  The ring sizes are set at compile time by RX/TX_RING_SIZE.
159
160 The driver allocates full frame size skbuffs for the Rx ring buffers at
161 open() time and passes the skb->data field to the Yellowfin as receive data
162 buffers.  When an incoming frame is less than RX_COPYBREAK bytes long,
163 a fresh skbuff is allocated and the frame is copied to the new skbuff.
164 When the incoming frame is larger, the skbuff is passed directly up the
165 protocol stack and replaced by a newly allocated skbuff.
166
167 The RX_COPYBREAK value is chosen to trade-off the memory wasted by
168 using a full-sized skbuff for small frames vs. the copying costs of larger
169 frames.  For small frames the copying cost is negligible (esp. considering
170 that we are pre-loading the cache with immediately useful header
171 information).  For large frames the copying cost is non-trivial, and the
172 larger copy might flush the cache of useful data.
173
174 IIIC. Synchronization
175
176 The driver runs as two independent, single-threaded flows of control.  One
177 is the send-packet routine, which enforces single-threaded use by the
178 dev->tbusy flag.  The other thread is the interrupt handler, which is single
179 threaded by the hardware and other software.
180
181 The send packet thread has partial control over the Tx ring and 'dev->tbusy'
182 flag.  It sets the tbusy flag whenever it's queuing a Tx packet. If the next
183 queue slot is empty, it clears the tbusy flag when finished otherwise it sets
184 the 'yp->tx_full' flag.
185
186 The interrupt handler has exclusive control over the Rx ring and records stats
187 from the Tx ring.  After reaping the stats, it marks the Tx queue entry as
188 empty by incrementing the dirty_tx mark. Iff the 'yp->tx_full' flag is set, it
189 clears both the tx_full and tbusy flags.
190
191 IV. Notes
192
193 Thanks to Kim Stearns of Packet Engines for providing a pair of G-NIC boards.
194 Thanks to Bruce Faust of Digitalscape for providing both their SYM53C885 board
195 and an AlphaStation to verifty the Alpha port!
196
197 IVb. References
198
199 Yellowfin Engineering Design Specification, 4/23/97 Preliminary/Confidential
200 Symbios SYM53C885 PCI-SCSI/Fast Ethernet Multifunction Controller Preliminary
201    Data Manual v3.0
202 http://cesdis.gsfc.nasa.gov/linux/misc/NWay.html
203 http://cesdis.gsfc.nasa.gov/linux/misc/100mbps.html
204
205 IVc. Errata
206
207 See Packet Engines confidential appendix (prototype chips only).
208 */
209
210
211
212 enum capability_flags {
213         HasMII=1, FullTxStatus=2, IsGigabit=4, HasMulticastBug=8, FullRxStatus=16,
214         HasMACAddrBug=32, /* Only on early revs.  */
215         DontUseEeprom=64, /* Don't read the MAC from the EEPROm. */
216 };
217
218 /* The PCI I/O space extent. */
219 enum {
220         YELLOWFIN_SIZE  = 0x100,
221 };
222
223 struct pci_id_info {
224         const char *name;
225         struct match_info {
226                 int     pci, pci_mask, subsystem, subsystem_mask;
227                 int revision, revision_mask;                            /* Only 8 bits. */
228         } id;
229         int drv_flags;                          /* Driver use, intended as capability flags. */
230 };
231
232 static const struct pci_id_info pci_id_tbl[] = {
233         {"Yellowfin G-NIC Gigabit Ethernet", { 0x07021000, 0xffffffff},
234          FullTxStatus | IsGigabit | HasMulticastBug | HasMACAddrBug | DontUseEeprom},
235         {"Symbios SYM83C885", { 0x07011000, 0xffffffff},
236           HasMII | DontUseEeprom },
237         { }
238 };
239
240 static const struct pci_device_id yellowfin_pci_tbl[] = {
241         { 0x1000, 0x0702, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
242         { 0x1000, 0x0701, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 1 },
243         { }
244 };
245 MODULE_DEVICE_TABLE (pci, yellowfin_pci_tbl);
246
247
248 /* Offsets to the Yellowfin registers.  Various sizes and alignments. */
249 enum yellowfin_offsets {
250         TxCtrl=0x00, TxStatus=0x04, TxPtr=0x0C,
251         TxIntrSel=0x10, TxBranchSel=0x14, TxWaitSel=0x18,
252         RxCtrl=0x40, RxStatus=0x44, RxPtr=0x4C,
253         RxIntrSel=0x50, RxBranchSel=0x54, RxWaitSel=0x58,
254         EventStatus=0x80, IntrEnb=0x82, IntrClear=0x84, IntrStatus=0x86,
255         ChipRev=0x8C, DMACtrl=0x90, TxThreshold=0x94,
256         Cnfg=0xA0, FrameGap0=0xA2, FrameGap1=0xA4,
257         MII_Cmd=0xA6, MII_Addr=0xA8, MII_Wr_Data=0xAA, MII_Rd_Data=0xAC,
258         MII_Status=0xAE,
259         RxDepth=0xB8, FlowCtrl=0xBC,
260         AddrMode=0xD0, StnAddr=0xD2, HashTbl=0xD8, FIFOcfg=0xF8,
261         EEStatus=0xF0, EECtrl=0xF1, EEAddr=0xF2, EERead=0xF3, EEWrite=0xF4,
262         EEFeature=0xF5,
263 };
264
265 /* The Yellowfin Rx and Tx buffer descriptors.
266    Elements are written as 32 bit for endian portability. */
267 struct yellowfin_desc {
268         __le32 dbdma_cmd;
269         __le32 addr;
270         __le32 branch_addr;
271         __le32 result_status;
272 };
273
274 struct tx_status_words {
275 #ifdef __BIG_ENDIAN
276         u16 tx_errs;
277         u16 tx_cnt;
278         u16 paused;
279         u16 total_tx_cnt;
280 #else  /* Little endian chips. */
281         u16 tx_cnt;
282         u16 tx_errs;
283         u16 total_tx_cnt;
284         u16 paused;
285 #endif /* __BIG_ENDIAN */
286 };
287
288 /* Bits in yellowfin_desc.cmd */
289 enum desc_cmd_bits {
290         CMD_TX_PKT=0x10000000, CMD_RX_BUF=0x20000000, CMD_TXSTATUS=0x30000000,
291         CMD_NOP=0x60000000, CMD_STOP=0x70000000,
292         BRANCH_ALWAYS=0x0C0000, INTR_ALWAYS=0x300000, WAIT_ALWAYS=0x030000,
293         BRANCH_IFTRUE=0x040000,
294 };
295
296 /* Bits in yellowfin_desc.status */
297 enum desc_status_bits { RX_EOP=0x0040, };
298
299 /* Bits in the interrupt status/mask registers. */
300 enum intr_status_bits {
301         IntrRxDone=0x01, IntrRxInvalid=0x02, IntrRxPCIFault=0x04,IntrRxPCIErr=0x08,
302         IntrTxDone=0x10, IntrTxInvalid=0x20, IntrTxPCIFault=0x40,IntrTxPCIErr=0x80,
303         IntrEarlyRx=0x100, IntrWakeup=0x200, };
304
305 #define PRIV_ALIGN      31      /* Required alignment mask */
306 #define MII_CNT         4
307 struct yellowfin_private {
308         /* Descriptor rings first for alignment.
309            Tx requires a second descriptor for status. */
310         struct yellowfin_desc *rx_ring;
311         struct yellowfin_desc *tx_ring;
312         struct sk_buff* rx_skbuff[RX_RING_SIZE];
313         struct sk_buff* tx_skbuff[TX_RING_SIZE];
314         dma_addr_t rx_ring_dma;
315         dma_addr_t tx_ring_dma;
316
317         struct tx_status_words *tx_status;
318         dma_addr_t tx_status_dma;
319
320         struct timer_list timer;        /* Media selection timer. */
321         /* Frequently used and paired value: keep adjacent for cache effect. */
322         int chip_id, drv_flags;
323         struct pci_dev *pci_dev;
324         unsigned int cur_rx, dirty_rx;          /* Producer/consumer ring indices */
325         unsigned int rx_buf_sz;                         /* Based on MTU+slack. */
326         struct tx_status_words *tx_tail_desc;
327         unsigned int cur_tx, dirty_tx;
328         int tx_threshold;
329         unsigned int tx_full:1;                         /* The Tx queue is full. */
330         unsigned int full_duplex:1;                     /* Full-duplex operation requested. */
331         unsigned int duplex_lock:1;
332         unsigned int medialock:1;                       /* Do not sense media. */
333         unsigned int default_port:4;            /* Last dev->if_port value. */
334         /* MII transceiver section. */
335         int mii_cnt;                                            /* MII device addresses. */
336         u16 advertising;                                        /* NWay media advertisement */
337         unsigned char phys[MII_CNT];            /* MII device addresses, only first one used */
338         spinlock_t lock;
339         void __iomem *base;
340 };
341
342 static int read_eeprom(void __iomem *ioaddr, int location);
343 static int mdio_read(void __iomem *ioaddr, int phy_id, int location);
344 static void mdio_write(void __iomem *ioaddr, int phy_id, int location, int value);
345 static int netdev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
346 static int yellowfin_open(struct net_device *dev);
347 static void yellowfin_timer(unsigned long data);
348 static void yellowfin_tx_timeout(struct net_device *dev);
349 static void yellowfin_init_ring(struct net_device *dev);
350 static int yellowfin_start_xmit(struct sk_buff *skb, struct net_device *dev);
351 static irqreturn_t yellowfin_interrupt(int irq, void *dev_instance);
352 static int yellowfin_rx(struct net_device *dev);
353 static void yellowfin_error(struct net_device *dev, int intr_status);
354 static int yellowfin_close(struct net_device *dev);
355 static void set_rx_mode(struct net_device *dev);
356 static const struct ethtool_ops ethtool_ops;
357
358 static const struct net_device_ops netdev_ops = {
359         .ndo_open               = yellowfin_open,
360         .ndo_stop               = yellowfin_close,
361         .ndo_start_xmit         = yellowfin_start_xmit,
362         .ndo_set_multicast_list = set_rx_mode,
363         .ndo_change_mtu         = eth_change_mtu,
364         .ndo_validate_addr      = eth_validate_addr,
365         .ndo_set_mac_address    = eth_mac_addr,
366         .ndo_do_ioctl           = netdev_ioctl,
367         .ndo_tx_timeout         = yellowfin_tx_timeout,
368 };
369
370 static int __devinit yellowfin_init_one(struct pci_dev *pdev,
371                                         const struct pci_device_id *ent)
372 {
373         struct net_device *dev;
374         struct yellowfin_private *np;
375         int irq;
376         int chip_idx = ent->driver_data;
377         static int find_cnt;
378         void __iomem *ioaddr;
379         int i, option = find_cnt < MAX_UNITS ? options[find_cnt] : 0;
380         int drv_flags = pci_id_tbl[chip_idx].drv_flags;
381         void *ring_space;
382         dma_addr_t ring_dma;
383 #ifdef USE_IO_OPS
384         int bar = 0;
385 #else
386         int bar = 1;
387 #endif
388
389 /* when built into the kernel, we only print version if device is found */
390 #ifndef MODULE
391         static int printed_version;
392         if (!printed_version++)
393                 printk(version);
394 #endif
395
396         i = pci_enable_device(pdev);
397         if (i) return i;
398
399         dev = alloc_etherdev(sizeof(*np));
400         if (!dev) {
401                 printk (KERN_ERR PFX "cannot allocate ethernet device\n");
402                 return -ENOMEM;
403         }
404         SET_NETDEV_DEV(dev, &pdev->dev);
405
406         np = netdev_priv(dev);
407
408         if (pci_request_regions(pdev, DRV_NAME))
409                 goto err_out_free_netdev;
410
411         pci_set_master (pdev);
412
413         ioaddr = pci_iomap(pdev, bar, YELLOWFIN_SIZE);
414         if (!ioaddr)
415                 goto err_out_free_res;
416
417         irq = pdev->irq;
418
419         if (drv_flags & DontUseEeprom)
420                 for (i = 0; i < 6; i++)
421                         dev->dev_addr[i] = ioread8(ioaddr + StnAddr + i);
422         else {
423                 int ee_offset = (read_eeprom(ioaddr, 6) == 0xff ? 0x100 : 0);
424                 for (i = 0; i < 6; i++)
425                         dev->dev_addr[i] = read_eeprom(ioaddr, ee_offset + i);
426         }
427
428         /* Reset the chip. */
429         iowrite32(0x80000000, ioaddr + DMACtrl);
430
431         dev->base_addr = (unsigned long)ioaddr;
432         dev->irq = irq;
433
434         pci_set_drvdata(pdev, dev);
435         spin_lock_init(&np->lock);
436
437         np->pci_dev = pdev;
438         np->chip_id = chip_idx;
439         np->drv_flags = drv_flags;
440         np->base = ioaddr;
441
442         ring_space = pci_alloc_consistent(pdev, TX_TOTAL_SIZE, &ring_dma);
443         if (!ring_space)
444                 goto err_out_cleardev;
445         np->tx_ring = (struct yellowfin_desc *)ring_space;
446         np->tx_ring_dma = ring_dma;
447
448         ring_space = pci_alloc_consistent(pdev, RX_TOTAL_SIZE, &ring_dma);
449         if (!ring_space)
450                 goto err_out_unmap_tx;
451         np->rx_ring = (struct yellowfin_desc *)ring_space;
452         np->rx_ring_dma = ring_dma;
453