ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / net / ibmveth.c
1 /**************************************************************************/
2 /*                                                                        */
3 /* IBM eServer i/pSeries Virtual Ethernet Device Driver                   */
4 /* Copyright (C) 2003 IBM Corp.                                           */
5 /*  Dave Larson (larson1@us.ibm.com)                                      */
6 /*  Santiago Leon (santil@us.ibm.com)                                     */
7 /*                                                                        */
8 /*  This program is free software; you can redistribute it and/or modify  */
9 /*  it under the terms of the GNU General Public License as published by  */
10 /*  the Free Software Foundation; either version 2 of the License, or     */
11 /*  (at your option) any later version.                                   */
12 /*                                                                        */
13 /*  This program is distributed in the hope that it will be useful,       */
14 /*  but WITHOUT ANY WARRANTY; without even the implied warranty of        */
15 /*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         */
16 /*  GNU General Public License for more details.                          */
17 /*                                                                        */
18 /*  You should have received a copy of the GNU General Public License     */
19 /*  along with this program; if not, write to the Free Software           */
20 /*  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  */
21 /*                                                                   USA  */
22 /*                                                                        */
23 /* This module contains the implementation of a virtual ethernet device   */
24 /* for use with IBM i/pSeries LPAR Linux.  It utilizes the logical LAN    */
25 /* option of the RS/6000 Platform Architechture to interface with virtual */
26 /* ethernet NICs that are presented to the partition by the hypervisor.   */
27 /*                                                                        */ 
28 /**************************************************************************/
29 /*
30   TODO:
31   - remove frag processing code - no longer needed
32   - add support for sysfs
33   - possibly remove procfs support
34 */
35
36 #include <linux/config.h>
37 #include <linux/module.h>
38 #include <linux/version.h>
39 #include <linux/types.h>
40 #include <linux/errno.h>
41 #include <linux/ioport.h>
42 #include <linux/dma-mapping.h>
43 #include <linux/kernel.h>
44 #include <linux/netdevice.h>
45 #include <linux/etherdevice.h>
46 #include <linux/skbuff.h>
47 #include <linux/init.h>
48 #include <linux/delay.h>
49 #include <linux/mm.h>
50 #include <linux/ethtool.h>
51 #include <linux/proc_fs.h>
52 #include <asm/semaphore.h>
53 #include <asm/hvcall.h>
54 #include <asm/atomic.h>
55 #include <asm/iommu.h>
56 #include <asm/vio.h>
57 #include <asm/uaccess.h>
58 #include <linux/proc_fs.h>
59 #include <linux/seq_file.h>
60
61 #include "ibmveth.h"
62
63 #define DEBUG 1
64
65 #define ibmveth_printk(fmt, args...) \
66   printk(KERN_INFO "%s: " fmt, __FILE__, ## args)
67
68 #define ibmveth_error_printk(fmt, args...) \
69   printk(KERN_ERR "(%s:%3.3d ua:%x) ERROR: " fmt, __FILE__, __LINE__ , adapter->vdev->unit_address, ## args)
70
71 #ifdef DEBUG
72 #define ibmveth_debug_printk_no_adapter(fmt, args...) \
73   printk(KERN_DEBUG "(%s:%3.3d): " fmt, __FILE__, __LINE__ , ## args)
74 #define ibmveth_debug_printk(fmt, args...) \
75   printk(KERN_DEBUG "(%s:%3.3d ua:%x): " fmt, __FILE__, __LINE__ , adapter->vdev->unit_address, ## args)
76 #define ibmveth_assert(expr) \
77   if(!(expr)) {                                   \
78     printk(KERN_DEBUG "assertion failed (%s:%3.3d ua:%x): %s\n", __FILE__, __LINE__, adapter->vdev->unit_address, #expr); \
79     BUG(); \
80   }
81 #else
82 #define ibmveth_debug_printk_no_adapter(fmt, args...)
83 #define ibmveth_debug_printk(fmt, args...)
84 #define ibmveth_assert(expr) 
85 #endif
86
87 static int ibmveth_open(struct net_device *dev);
88 static int ibmveth_close(struct net_device *dev);
89 static int ibmveth_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
90 static int ibmveth_poll(struct net_device *dev, int *budget);
91 static int ibmveth_start_xmit(struct sk_buff *skb, struct net_device *dev);
92 static struct net_device_stats *ibmveth_get_stats(struct net_device *dev);
93 static void ibmveth_set_multicast_list(struct net_device *dev);
94 static int ibmveth_change_mtu(struct net_device *dev, int new_mtu);
95 static void ibmveth_proc_register_driver(void);
96 static void ibmveth_proc_unregister_driver(void);
97 static void ibmveth_proc_register_adapter(struct ibmveth_adapter *adapter);
98 static void ibmveth_proc_unregister_adapter(struct ibmveth_adapter *adapter);
99 static irqreturn_t ibmveth_interrupt(int irq, void *dev_instance, struct pt_regs *regs);
100
101 #ifdef CONFIG_PROC_FS
102 #define IBMVETH_PROC_DIR "ibmveth"
103 static struct proc_dir_entry *ibmveth_proc_dir;
104 #endif
105
106 static const char ibmveth_driver_name[] = "ibmveth";
107 static const char ibmveth_driver_string[] = "IBM i/pSeries Virtual Ethernet Driver";
108 static const char ibmveth_driver_version[] = "1.0";
109
110 MODULE_AUTHOR("Dave Larson <larson1@us.ibm.com>");
111 MODULE_DESCRIPTION("IBM i/pSeries Virtual Ethernet Driver");
112 MODULE_LICENSE("GPL");
113
114 /* simple methods of getting data from the current rxq entry */
115 static inline int ibmveth_rxq_pending_buffer(struct ibmveth_adapter *adapter)
116 {
117         return (adapter->rx_queue.queue_addr[adapter->rx_queue.index].toggle == adapter->rx_queue.toggle);
118 }
119
120 static inline int ibmveth_rxq_buffer_valid(struct ibmveth_adapter *adapter)
121 {
122         return (adapter->rx_queue.queue_addr[adapter->rx_queue.index].valid);
123 }
124
125 static inline int ibmveth_rxq_frame_offset(struct ibmveth_adapter *adapter)
126 {
127         return (adapter->rx_queue.queue_addr[adapter->rx_queue.index].offset);
128 }
129
130 static inline int ibmveth_rxq_frame_length(struct ibmveth_adapter *adapter)
131 {
132         return (adapter->rx_queue.queue_addr[adapter->rx_queue.index].length);
133 }
134
135 /* setup the initial settings for a buffer pool */
136 static void ibmveth_init_buffer_pool(struct ibmveth_buff_pool *pool, u32 pool_index, u32 pool_size, u32 buff_size)
137 {
138         pool->size = pool_size;
139         pool->index = pool_index;
140         pool->buff_size = buff_size;
141         pool->threshold = pool_size / 2;
142 }
143
144 /* allocate and setup an buffer pool - called during open */
145 static int ibmveth_alloc_buffer_pool(struct ibmveth_buff_pool *pool)
146 {
147         int i;
148
149         pool->free_map = kmalloc(sizeof(u16) * pool->size, GFP_KERNEL); 
150
151         if(!pool->free_map) {
152                 return -1;
153         }
154
155         pool->dma_addr = kmalloc(sizeof(dma_addr_t) * pool->size, GFP_KERNEL); 
156         if(!pool->dma_addr) {
157                 kfree(pool->free_map);
158                 pool->free_map = NULL;
159                 return -1;
160         }
161
162         pool->skbuff = kmalloc(sizeof(void*) * pool->size, GFP_KERNEL);
163
164         if(!pool->skbuff) {
165                 kfree(pool->dma_addr);
166                 pool->dma_addr = NULL;
167
168                 kfree(pool->free_map);
169                 pool->free_map = NULL;
170                 return -1;
171         }
172
173         memset(pool->skbuff, 0, sizeof(void*) * pool->size);
174         memset(pool->dma_addr, 0, sizeof(dma_addr_t) * pool->size);
175
176         for(i = 0; i < pool->size; ++i) {
177                 pool->free_map[i] = i;
178         }
179
180         atomic_set(&pool->available, 0);
181         pool->producer_index = 0;
182         pool->consumer_index = 0;
183
184         return 0;
185 }
186
187 /* replenish the buffers for a pool.  note that we don't need to
188  * skb_reserve these since they are used for incoming...
189  */
190 static void ibmveth_replenish_buffer_pool(struct ibmveth_adapter *adapter, struct ibmveth_buff_pool *pool)
191 {
192         u32 i;
193         u32 count = pool->size - atomic_read(&pool->available);
194         u32 buffers_added = 0;
195
196         mb();
197
198         for(i = 0; i < count; ++i) {
199                 struct sk_buff *skb;
200                 unsigned int free_index, index;
201                 u64 correlator;
202                 union ibmveth_buf_desc desc;
203                 unsigned long lpar_rc;
204                 dma_addr_t dma_addr;
205
206                 skb = alloc_skb(pool->buff_size, GFP_ATOMIC);
207
208                 if(!skb) {
209                         ibmveth_debug_printk("replenish: unable to allocate skb\n");
210                         adapter->replenish_no_mem++;
211                         break;
212                 }
213
214                 free_index = pool->consumer_index++ % pool->size;
215                 index = pool->free_map[free_index];
216         
217                 ibmveth_assert(index != 0xffff);
218                 ibmveth_assert(pool->skbuff[index] == NULL);
219
220                 dma_addr = vio_map_single(adapter->vdev, skb->data, pool->buff_size, DMA_FROM_DEVICE);
221
222                 pool->dma_addr[index] = dma_addr;
223                 pool->skbuff[index] = skb;
224
225                 correlator = ((u64)pool->index << 32) | index;
226                 *(u64*)skb->data = correlator;
227
228                 desc.desc = 0;
229                 desc.fields.valid = 1;
230                 desc.fields.length = pool->buff_size;
231                 desc.fields.address = dma_addr; 
232
233                 lpar_rc = h_add_logical_lan_buffer(adapter->vdev->unit_address, desc.desc);
234                     
235                 if(lpar_rc != H_Success) {
236                         pool->skbuff[index] = NULL;
237                         pool->consumer_index--;
238                         vio_unmap_single(adapter->vdev, pool->dma_addr[index], pool->buff_size, DMA_FROM_DEVICE);
239                         dev_kfree_skb_any(skb);
240                         adapter->replenish_add_buff_failure++;
241                         break;
242                 } else {
243                         pool->free_map[free_index] = 0xffff;
244                         buffers_added++;
245                         adapter->replenish_add_buff_success++;
246                 }
247         }
248     
249         mb();
250         atomic_add(buffers_added, &(pool->available));
251 }
252
253 /* check if replenishing is needed.  */
254 static inline int ibmveth_is_replenishing_needed(struct ibmveth_adapter *adapter)
255 {
256         return ((atomic_read(&adapter->rx_buff_pool[0].available) < adapter->rx_buff_pool[0].threshold) ||
257                 (atomic_read(&adapter->rx_buff_pool[1].available) < adapter->rx_buff_pool[1].threshold) ||
258                 (atomic_read(&adapter->rx_buff_pool[2].available) < adapter->rx_buff_pool[2].threshold));
259 }
260
261 /* replenish tasklet routine */
262 static void ibmveth_replenish_task(struct ibmveth_adapter *adapter) 
263 {
264         adapter->replenish_task_cycles++;
265
266         ibmveth_replenish_buffer_pool(adapter, &adapter->rx_buff_pool[0]);
267         ibmveth_replenish_buffer_pool(adapter, &adapter->rx_buff_pool[1]);
268         ibmveth_replenish_buffer_pool(adapter, &adapter->rx_buff_pool[2]);
269
270         adapter->rx_no_buffer = *(u64*)(((char*)adapter->buffer_list_addr) + 4096 - 8);
271
272         atomic_inc(&adapter->not_replenishing);
273         ibmveth_assert(atomic_read(&adapter->not_replenishing) == 1);
274 }
275
276 /* kick the replenish tasklet if we need replenishing and it isn't already running */
277 static inline void ibmveth_schedule_replenishing(struct ibmveth_adapter *adapter)
278 {
279         if(ibmveth_is_replenishing_needed(adapter) && 
280            (atomic_dec_if_positive(&adapter->not_replenishing) == 0)) { 
281                 schedule_work(&adapter->replenish_task);
282         }
283 }
284
285 /* empty and free ana buffer pool - also used to do cleanup in error paths */
286 static void ibmveth_free_buffer_pool(struct ibmveth_adapter *adapter, struct ibmveth_buff_pool *pool)
287 {
288         int i;
289
290         if(pool->free_map) {
291                 kfree(pool->free_map);
292                 pool->free_map  = NULL;
293         }
294
295         if(pool->skbuff && pool->dma_addr) {
296                 for(i = 0; i < pool->size; ++i) {
297                         struct sk_buff *skb = pool->skbuff[i];
298                         if(skb) {
299                                 vio_unmap_single(adapter->vdev,
300                                                  pool->dma_addr[i],
301                                                  pool->buff_size,
302                                                  DMA_FROM_DEVICE);
303                                 dev_kfree_skb_any(skb);
304                                 pool->skbuff[i] = NULL;
305                         }
306                 }
307         }
308
309         if(pool->dma_addr) {
310                 kfree(pool->dma_addr);
311                 pool->dma_addr = NULL;
312         }
313
314         if(pool->skbuff) {
315                 kfree(pool->skbuff);
316                 pool->skbuff = NULL;
317         }
318 }
319
320 /* remove a buffer from a pool */
321 static void ibmveth_remove_buffer_from_pool(struct ibmveth_adapter *adapter, u64 correlator)
322 {
323         unsigned int pool  = correlator >> 32;
324         unsigned int index = correlator & 0xffffffffUL;
325         unsigned int free_index;
326         struct sk_buff *skb;
327
328         ibmveth_assert(pool < IbmVethNumBufferPools);
329         ibmveth_assert(index < adapter->rx_buff_pool[pool].size);
330
331         skb = adapter->rx_buff_pool[pool].skbuff[index];
332
333         ibmveth_assert(skb != NULL);
334
335         adapter->rx_buff_pool[pool].skbuff[index] = NULL;
336
337         vio_unmap_single(adapter->vdev,
338                          adapter->rx_buff_pool[pool].dma_addr[index],
339                          adapter->rx_buff_pool[pool].buff_size,
340                          DMA_FROM_DEVICE);
341
342         free_index = adapter->rx_buff_pool[pool].producer_index++ % adapter->rx_buff_pool[pool].size;
343         adapter->rx_buff_pool[pool].free_map[free_index] = index;
344
345         mb();
346
347         atomic_dec(&(adapter->rx_buff_pool[pool].available));
348 }
349
350 /* get the current buffer on the rx queue */
351 static inline struct sk_buff *ibmveth_rxq_get_buffer(struct ibmveth_adapter *adapter)
352 {
353         u64 correlator = adapter->rx_queue.queue_addr[adapter->rx_queue.index].correlator;
354         unsigned int pool = correlator >> 32;
355         unsigned int index = correlator & 0xffffffffUL;
356
357         ibmveth_assert(pool < IbmVethNumBufferPools);
358         ibmveth_assert(index < adapter->rx_buff_pool[pool].size);
359
360         return adapter->rx_buff_pool[pool].skbuff[index];
361 }
362
363 /* recycle the current buffer on the rx queue */
364 static void ibmveth_rxq_recycle_buffer(struct ibmveth_adapter *adapter)
365 {
366         u32 q_index = adapter->rx_queue.index;
367         u64 correlator = adapter->rx_queue.queue_addr[q_index].correlator;
368         unsigned int pool = correlator >> 32;
369         unsigned int index = correlator & 0xffffffffUL;
370         union ibmveth_buf_desc desc;
371         unsigned long lpar_rc;
372
373         ibmveth_assert(pool < IbmVethNumBufferPools);
374         ibmveth_assert(index < adapter->rx_buff_pool[pool].size);
375
376         desc.desc = 0;
377         desc.fields.valid = 1;
378         desc.fields.length = adapter->rx_buff_pool[pool].buff_size;
379         desc.fields.address = adapter->rx_buff_pool[pool].dma_addr[index];
380
381         lpar_rc = h_add_logical_lan_buffer(adapter->vdev->unit_address, desc.desc);
382                     
383         if(lpar_rc != H_Success) {
384                 ibmveth_debug_printk("h_add_logical_lan_buffer failed during recycle rc=%ld", lpar_rc);
385                 ibmveth_remove_buffer_from_pool(adapter, adapter->rx_queue.queue_addr[adapter->rx_queue.index].correlator);
386         }
387
388         if(++adapter->rx_queue.index == adapter->rx_queue.num_slots) {
389                 adapter->rx_queue.index = 0;
390                 adapter->rx_queue.toggle = !adapter->rx_queue.toggle;
391         }
392 }
393
394 static inline void ibmveth_rxq_harvest_buffer(struct ibmveth_adapter *adapter)
395 {
396         ibmveth_remove_buffer_from_pool(adapter, adapter->rx_queue.queue_addr[adapter->rx_queue.index].correlator);
397
398         if(++adapter->rx_queue.index == adapter->rx_queue.num_slots) {
399                 adapter->rx_queue.index = 0;
400                 adapter->rx_queue.toggle = !adapter->rx_queue.toggle;
401         }
402 }
403
404 static void ibmveth_cleanup(struct ibmveth_adapter *adapter)
405 {
406         if(adapter->buffer_list_addr != NULL) {
407                 if(!dma_mapping_error(adapter->buffer_list_dma)) {
408                         vio_unmap_single(adapter->vdev, adapter->buffer_list_dma, 4096, DMA_BIDIRECTIONAL);
409                         adapter->buffer_list_dma = DMA_ERROR_CODE;
410                 }
411                 free_page((unsigned long)adapter->buffer_list_addr);
412                 adapter->buffer_list_addr = NULL;
413         } 
414
415         if(adapter->filter_list_addr != NULL) {
416                 if(!dma_mapping_error(adapter->filter_list_dma)) {
417                         vio_unmap_single(adapter->vdev, adapter->filter_list_dma, 4096, DMA_BIDIRECTIONAL);
418                         adapter->filter_list_dma = DMA_ERROR_CODE;
419                 }
420                 free_page((unsigned long)adapter->filter_list_addr);
421                 adapter->filter_list_addr = NULL;
422         }
423
424         if(adapter->rx_queue.queue_addr != NULL) {
425                 if(!dma_mapping_error(adapter->rx_queue.queue_dma)) {
426                         vio_unmap_single(adapter->vdev, adapter->rx_queue.queue_dma, adapter->rx_queue.queue_len, DMA_BIDIRECTIONAL);
427                         adapter->rx_queue.queue_dma = DMA_ERROR_CODE;
428                 }
429                 kfree(adapter->rx_queue.queue_addr);
430                 adapter->rx_queue.queue_addr = NULL;
431         }
432
433         ibmveth_free_buffer_pool(adapter, &adapter->rx_buff_pool[0]);
434         ibmveth_free_buffer_pool(adapter, &adapter->rx_buff_pool[1]);
435         ibmveth_free_buffer_pool(adapter, &adapter->rx_buff_pool[2]);
436 }
437
438 static int ibmveth_open(struct net_device *netdev)
439 {
440         struct ibmveth_adapter *adapter = netdev->priv;
441         u64 mac_address = 0;
442         int rxq_entries;
443         unsigned long lpar_rc;
444         int rc;
445         union ibmveth_buf_desc rxq_desc;
446
447         ibmveth_debug_printk("open starting\n");
448
449         rxq_entries =
450                 adapter->rx_buff_pool[0].size +
451                 adapter->rx_buff_pool[1].size +
452                 adapter->rx_buff_pool[2].size + 1;
453     
454         adapter->buffer_list_addr = (void*) get_zeroed_page(GFP_KERNEL);
455         adapter->filter_list_addr = (void*) get_zeroed_page(GFP_KERNEL);
456  
457         if(!adapter->buffer_list_addr || !adapter->filter_list_addr) {
458                 ibmveth_error_printk("unable to allocate filter or buffer list pages\n");
459                 ibmveth_cleanup(adapter);
460                 return -ENOMEM;
461         }
462
463         adapter->rx_queue.queue_len = sizeof(struct ibmveth_rx_q_entry) * rxq_entries;
464         adapter->rx_queue.queue_addr = kmalloc(adapter->rx_queue.queue_len, GFP_KERNEL);
465
466         if(!adapter->rx_queue.queue_addr) {
467                 ibmveth_error_printk("unable to allocate rx queue pages\n");
468                 ibmveth_cleanup(adapter);
469                 return -ENOMEM;
470         }
471
472         adapter->buffer_list_dma = vio_map_single(adapter->vdev, adapter->buffer_list_addr, 4096, DMA_BIDIRECTIONAL);
473         adapter->filter_list_dma = vio_map_single(adapter->vdev, adapter->filter_list_addr, 4096, DMA_BIDIRECTIONAL);
474         adapter->rx_queue.queue_dma = vio_map_single(adapter->vdev, adapter->rx_queue.queue_addr, adapter->rx_queue.queue_len, DMA_BIDIRECTIONAL);
475
476         if((dma_mapping_error(adapter->buffer_list_dma) ) ||
477            (dma_mapping_error(adapter->filter_list_dma)) ||
478            (dma_mapping_error(adapter->rx_queue.queue_dma))) {
479                 ibmveth_error_printk("unable to map filter or buffer list pages\n");
480                 ibmveth_cleanup(adapter);
481                 return -ENOMEM;
482         }
483
484         adapter->rx_queue.index = 0;
485         adapter->rx_queue.num_slots = rxq_entries;
486         adapter->rx_queue.toggle = 1;
487
488         if(ibmveth_alloc_buffer_pool(&adapter->rx_buff_pool[0]) ||
489            ibmveth_alloc_buffer_pool(&adapter->rx_buff_pool[1]) ||
490            ibmveth_alloc_buffer_pool(&adapter->rx_buff_pool[2]))
491         {
492                 ibmveth_error_printk("unable to allocate buffer pools\n");
493                 ibmveth_cleanup(adapter);
494                 return -ENOMEM;
495         }
496
497         memcpy(&mac_address, netdev->dev_addr, netdev->addr_len);
498         mac_address = mac_address >> 16;
499
500         rxq_desc.desc = 0;
501         rxq_desc.fields.valid = 1;
502         rxq_desc.fields.length = adapter->rx_queue.queue_len;
503         rxq_desc.fields.address = adapter->rx_queue.queue_dma;
504
505         ibmveth_debug_printk("buffer list @ 0x%p\n", adapter->buffer_list_addr);
506         ibmveth_debug_printk("filter list @ 0x%p\n", adapter->filter_list_addr);
507         ibmveth_debug_printk("receive q   @ 0x%p\n", adapter->rx_queue.queue_addr);
508
509     
510         lpar_rc = h_register_logical_lan(adapter->vdev->unit_address,
511                                          adapter->buffer_list_dma,
512                                          rxq_desc.desc,
513                                          adapter->filter_list_dma,
514                                          mac_address);
515
516         if(lpar_rc != H_Success) {
517                 ibmveth_error_printk("h_register_logical_lan failed with %ld\n", lpar_rc);
518                 ibmveth_error_printk("buffer TCE:0x%x filter TCE:0x%x rxq desc:0x%lx MAC:0x%lx\n",
519                                      adapter->buffer_list_dma,
520                                      adapter->filter_list_dma,
521                                      rxq_desc.desc,
522                                      mac_address);
523                 ibmveth_cleanup(adapter);
524                 return -ENONET; 
525         }
526
527         ibmveth_debug_printk("registering irq 0x%x\n", netdev->irq);
528         if((rc = request_irq(netdev->irq, &ibmveth_interrupt, 0, netdev->name, netdev)) != 0) {
529                 ibmveth_error_printk("unable to request irq 0x%x, rc %d\n", netdev->irq, rc);
530                 do {
531                         rc = h_free_logical_lan(adapter->vdev->unit_address);
532                 } while H_isLongBusy(rc);
533
534                 ibmveth_cleanup(adapter);
535                 return rc;
536         }
537
538         netif_start_queue(netdev);
539
540         ibmveth_debug_printk("scheduling initial replenish cycle\n");
541         ibmveth_schedule_replenishing(adapter);
542
543         ibmveth_debug_printk("open complete\n");
544
545         return 0;
546 }
547
548 static int ibmveth_close(struct net_device *netdev)
549 {
550         struct ibmveth_adapter *adapter = netdev->priv;
551         long lpar_rc;
552     
553         ibmveth_debug_printk("close starting\n");
554
555         netif_stop_queue(netdev);
556
557         free_irq(netdev->irq, netdev);
558
559         cancel_delayed_work(&adapter->replenish_task);
560         flush_scheduled_work();
561
562         do {
563                 lpar_rc = h_free_logical_lan(adapter->vdev->unit_address);
564         } while H_isLongBusy(lpar_rc);
565
566         if(lpar_rc != H_Success)
567         {
568                 ibmveth_error_printk("h_free_logical_lan failed with %lx, continuing with close\n",
569                                      lpar_rc);
570         }
571
572         adapter->rx_no_buffer = *(u64*)(((char*)adapter->buffer_list_addr) + 4096 - 8);
573
574         ibmveth_cleanup(adapter);
575
576         ibmveth_debug_printk("close complete\n");
577
578         return 0;
579 }
580
581 static int netdev_get_settings(struct net_device *dev, struct ethtool_cmd *cmd) {
582         cmd->supported = (SUPPORTED_1000baseT_Full | SUPPORTED_Autoneg | SUPPORTED_FIBRE);
583         cmd->advertising = (ADVERTISED_1000baseT_Full | ADVERTISED_Autoneg | ADVERTISED_FIBRE);
584         cmd->speed = SPEED_1000;
585         cmd->duplex = DUPLEX_FULL;
586         cmd->port = PORT_FIBRE;
587         cmd->phy_address = 0;
588         cmd->transceiver = XCVR_INTERNAL;
589         cmd->autoneg = AUTONEG_ENABLE;
590         cmd->maxtxpkt = 0;
591         cmd->maxrxpkt = 1;
592         return 0;
593 }
594
595 static void netdev_get_drvinfo (struct net_device *dev, struct ethtool_drvinfo *info) {
596         strncpy(info->driver, ibmveth_driver_name, sizeof(info->driver) - 1);
597         strncpy(info->version, ibmveth_driver_version, sizeof(info->version) - 1);
598 }
599
600 static u32 netdev_get_link(struct net_device *dev) {
601         return 0;
602 }
603
604 static struct ethtool_ops netdev_ethtool_ops = {
605         .get_drvinfo            = netdev_get_drvinfo,
606         .get_settings           = netdev_get_settings,
607         .get_link               = netdev_get_link,
608         .get_sg                 = ethtool_op_get_sg,
609         .get_tx_csum            = ethtool_op_get_tx_csum,
610 };
611
612 static int ibmveth_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
613 {
614         return -EOPNOTSUPP;
615 }
616
617 #define page_offset(v) ((unsigned long)(v) & ((1 << 12) - 1))
618
619 static int ibmveth_start_xmit(struct sk_buff *skb, struct net_device *netdev)
620 {
621         struct ibmveth_adapter *adapter = netdev->priv;
622         union ibmveth_buf_desc desc[IbmVethMaxSendFrags];
623         unsigned long lpar_rc;
624         int nfrags = 0, curfrag;
625         unsigned long correlator;
626         unsigned int retry_count;
627
628         if ((skb_shinfo(skb)->nr_frags + 1) > IbmVethMaxSendFrags) {
629                 adapter->stats.tx_dropped++;
630                 dev_kfree_skb(skb);
631                 return 0;
632         }
633
634         memset(&desc, 0, sizeof(desc));
635
636         /* nfrags = number of frags after the initial fragment */
637         nfrags = skb_shinfo(skb)->nr_frags;
638
639         if(nfrags)
640                 adapter->tx_multidesc_send++;
641
642         /* map the initial fragment */
643         desc[0].fields.length  = nfrags ? skb->len - skb->data_len : skb->len;
644         desc[0].fields.address = vio_map_single(adapter->vdev, skb->data,
645                                         desc[0].fields.length, DMA_TO_DEVICE);
646         desc[0].fields.valid   = 1;
647
648         if(dma_mapping_error(desc[0].fields.address)) {
649                 ibmveth_error_printk("tx: unable to map initial fragment\n");
650                 adapter->tx_map_failed++;
651                 adapter->stats.tx_dropped++;
652                 dev_kfree_skb(skb);
653                 return 0;
654         }
655
656         curfrag = nfrags;
657
658         /* map fragments past the initial portion if there are any */
659         while(curfrag--) {
660                 skb_frag_t *frag = &skb_shinfo(skb)->frags[curfrag];
661                 desc[curfrag+1].fields.address
662                         = vio_map_single(adapter->vdev,
663                                 page_address(frag->page) + frag->page_offset,
664                                 frag->size, DMA_TO_DEVICE);
665                 desc[curfrag+1].fields.length = frag->size;
666                 desc[curfrag+1].fields.valid  = 1;
667
668                 if(dma_mapping_error(desc[curfrag+1].fields.address)) {
669                         ibmveth_error_printk("tx: unable to map fragment %d\n", curfrag);
670                         adapter->tx_map_failed++;
671                         adapter->stats.tx_dropped++;
672                         /* Free all the mappings we just created */
673                         while(curfrag < nfrags) {
674                                 vio_unmap_single(adapter->vdev,
675                                                  desc[curfrag+1].fields.address,
676                                                  desc[curfrag+1].fields.length,
677                                                  DMA_TO_DEVICE);
678                                 curfrag++;
679                         }
680                         dev_kfree_skb(skb);
681                         return 0;
682                 }
683         }
684
685         /* send the frame. Arbitrarily set retrycount to 1024 */
686         correlator = 0;
687         retry_count = 1024;
688         do {
689                 lpar_rc = h_send_logical_lan(adapter->vdev->unit_address,
690                                              desc[0].desc,
691                                              desc[1].desc,
692                                              desc[2].desc,
693                                              desc[3].desc,
694                                              desc[4].desc,
695                                              desc[5].desc,
696                                              correlator);
697         } while ((lpar_rc == H_Busy) && (retry_count--));
698     
699         if(lpar_rc != H_Success && lpar_rc != H_Dropped) {
700                 int i;
701                 ibmveth_error_printk("tx: h_send_logical_lan failed with rc=%ld\n", lpar_rc);
702                 for(i = 0; i < 6; i++) {
703                         ibmveth_error_printk("tx: desc[%i] valid=%d, len=%d, address=0x%d\n", i,
704                                              desc[i].fields.valid, desc[i].fields.length, desc[i].fields.address);
705                 }
706                 adapter->tx_send_failed++;
707                 adapter->stats.tx_dropped++;
708         } else {
709                 adapter->stats.tx_packets++;
710                 adapter->stats.tx_bytes += skb->len;
711         }
712
713         do {
714                 vio_unmap_single(adapter->vdev, desc[nfrags].fields.address, desc[nfrags].fields.length, DMA_TO_DEVICE);
715         } while(--nfrags >= 0);
716
717         dev_kfree_skb(skb);
718         return 0;
719 }
720
721 static int ibmveth_poll(struct net_device *netdev, int *budget)
722 {
723         struct ibmveth_adapter *adapter = netdev->priv;
724         int max_frames_to_process = netdev->quota;
725         int frames_processed = 0;
726         int more_work = 1;
727         unsigned long lpar_rc;
728
729  restart_poll:
730         do {
731                 struct net_device *netdev = adapter->netdev;
732
733                 if(ibmveth_rxq_pending_buffer(adapter)) {
734                         struct sk_buff *skb;
735
736                         if(!ibmveth_rxq_buffer_valid(adapter)) {
737                                 wmb(); /* suggested by larson1 */
738                                 adapter->rx_invalid_buffer++;
739                                 ibmveth_debug_printk("recycling invalid buffer\n");
740                                 ibmveth_rxq_recycle_buffer(adapter);
741                         } else {
742                                 int length = ibmveth_rxq_frame_length(adapter);
743                                 int offset = ibmveth_rxq_frame_offset(adapter);
744                                 skb = ibmveth_rxq_get_buffer(adapter);
745
746                                 ibmveth_rxq_harvest_buffer(adapter);
747
748                                 skb_reserve(skb, offset);
749                                 skb_put(skb, length);
750                                 skb->dev = netdev;
751                                 skb->protocol = eth_type_trans(skb, netdev);
752
753                                 netif_receive_skb(skb); /* send it up */
754
755                                 adapter->stats.rx_packets++;
756                                 adapter->stats.rx_bytes += length;
757                                 frames_processed++;
758                         }
759                 } else {
760                         more_work = 0;
761                 }
762         } while(more_work && (frames_processed < max_frames_to_process));
763
764         ibmveth_schedule_replenishing(adapter);
765
766         if(more_work) {
767                 /* more work to do - return that we are not done yet */
768                 netdev->quota -= frames_processed;
769                 *budget -= frames_processed;
770                 return 1; 
771         }
772
773         /* we think we are done - reenable interrupts, then check once more to make sure we are done */
774         lpar_rc = h_vio_signal(adapter->vdev->unit_address, VIO_IRQ_ENABLE);
775
776         ibmveth_assert(lpar_rc == H_Success);
777
778         netif_rx_complete(netdev);
779
780         if(ibmveth_rxq_pending_buffer(adapter) && netif_rx_reschedule(netdev, frames_processed))
781         {
782                 lpar_rc = h_vio_signal(adapter->vdev->unit_address, VIO_IRQ_DISABLE);
783                 ibmveth_assert(lpar_rc == H_Success);
784                 more_work = 1;
785                 goto restart_poll;
786         }
787
788         netdev->quota -= frames_processed;
789         *budget -= frames_processed;
790
791         /* we really are done */
792         return 0;
793 }
794
795 static irqreturn_t ibmveth_interrupt(int irq, void *dev_instance, struct pt_regs *regs)
796 {   
797         struct net_device *netdev = dev_instance;
798         struct ibmveth_adapter *adapter = netdev->priv;
799         unsigned long lpar_rc;
800
801         if(netif_rx_schedule_prep(netdev)) {
802                 lpar_rc = h_vio_signal(adapter->vdev->unit_address, VIO_IRQ_DISABLE);
803                 ibmveth_assert(lpar_rc == H_Success);
804                 __netif_rx_schedule(netdev);
805         }
806         return IRQ_HANDLED;
807 }
808
809 static struct net_device_stats *ibmveth_get_stats(struct net_device *dev)
810 {
811         struct ibmveth_adapter *adapter = dev->priv;
812         return &adapter->stats;
813 }
814
815 static void ibmveth_set_multicast_list(struct net_device *netdev)
816 {
817         struct ibmveth_adapter *adapter = netdev->priv;
818         unsigned long lpar_rc;
819
820         if((netdev->flags & IFF_PROMISC) || (netdev->mc_count > adapter->mcastFilterSize)) {
821                 lpar_rc = h_multicast_ctrl(adapter->vdev->unit_address,
822                                            IbmVethMcastEnableRecv |
823                                            IbmVethMcastDisableFiltering,
824                                            0);
825                 if(lpar_rc != H_Success) {
826                         ibmveth_error_printk("h_multicast_ctrl rc=%ld when entering promisc mode\n", lpar_rc);
827                 }
828         } else {
829                 struct dev_mc_list *mclist = netdev->mc_list;
830                 int i;
831                 /* clear the filter table & disable filtering */
832                 lpar_rc = h_multicast_ctrl(adapter->vdev->unit_address,
833                                            IbmVethMcastEnableRecv |
834                                            IbmVethMcastDisableFiltering |
835                                            IbmVethMcastClearFilterTable,
836                                            0);
837                 if(lpar_rc != H_Success) {
838                         ibmveth_error_printk("h_multicast_ctrl rc=%ld when attempting to clear filter table\n", lpar_rc);
839                 }
840                 /* add the addresses to the filter table */
841                 for(i = 0; i < netdev->mc_count; ++i, mclist = mclist->next) {
842                         // add the multicast address to the filter table
843                         unsigned long mcast_addr = 0;
844                         memcpy(((char *)&mcast_addr)+2, mclist->dmi_addr, 6);
845                         lpar_rc = h_multicast_ctrl(adapter->vdev->unit_address,
846                                                    IbmVethMcastAddFilter,
847                                                    mcast_addr);
848                         if(lpar_rc != H_Success) {
849                                 ibmveth_error_printk("h_multicast_ctrl rc=%ld when adding an entry to the filter table\n", lpar_rc);
850                         }
851                 }
852         
853                 /* re-enable filtering */
854                 lpar_rc = h_multicast_ctrl(adapter->vdev->unit_address,
855                                            IbmVethMcastEnableFiltering,
856                                            0);
857                 if(lpar_rc != H_Success) {
858                         ibmveth_error_printk("h_multicast_ctrl rc=%ld when enabling filtering\n", lpar_rc);
859                 }
860         }
861 }
862
863 static int ibmveth_change_mtu(struct net_device *dev, int new_mtu)
864 {
865         if ((new_mtu < 68) || (new_mtu > (1<<20)))
866                 return -EINVAL;
867         dev->mtu = new_mtu;
868         return 0;       
869 }
870
871 static int __devinit ibmveth_probe(struct vio_dev *dev, const struct vio_device_id *id)
872 {
873         int rc;
874         struct net_device *netdev;
875         struct ibmveth_adapter *adapter;
876
877         unsigned int *mac_addr_p;
878         unsigned int *mcastFilterSize_p;
879
880
881         ibmveth_debug_printk_no_adapter("entering ibmveth_probe for UA 0x%x\n", 
882                                         dev->unit_address);
883
884         mac_addr_p = (unsigned int *) vio_get_attribute(dev, VETH_MAC_ADDR, 0);
885         if(!mac_addr_p) {
886                 ibmveth_error_printk("Can't find VETH_MAC_ADDR attribute\n");
887                 return 0;
888         }
889         
890         mcastFilterSize_p= (unsigned int *) vio_get_attribute(dev, VETH_MCAST_FILTER_SIZE, 0);
891         if(!mcastFilterSize_p) {
892                 ibmveth_error_printk("Can't find VETH_MCAST_FILTER_SIZE attribute\n");
893                 return 0;
894         }
895         
896         netdev = alloc_etherdev(sizeof(struct ibmveth_adapter));
897
898         if(!netdev)
899                 return -ENOMEM;
900
901         SET_MODULE_OWNER(netdev);
902
903         adapter = netdev->priv;
904         memset(adapter, 0, sizeof(adapter));
905         dev->driver_data = netdev;
906
907         adapter->vdev = dev;
908         adapter->netdev = netdev;
909         adapter->mcastFilterSize= *mcastFilterSize_p;
910         
911         /*      Some older boxes running PHYP non-natively have an OF that
912                 returns a 8-byte local-mac-address field (and the first 
913                 2 bytes have to be ignored) while newer boxes' OF return
914                 a 6-byte field. Note that IEEE 1275 specifies that 
915                 local-mac-address must be a 6-byte field.
916                 The RPA doc specifies that the first byte must be 10b, so 
917                 we'll just look for it to solve this 8 vs. 6 byte field issue */
918
919         while (*((char*)mac_addr_p) != (char)(0x02))
920                 ((char*)mac_addr_p)++;
921
922         adapter->mac_addr = 0;
923         memcpy(&adapter->mac_addr, mac_addr_p, 6);
924
925         adapter->liobn = dev->iommu_table->it_index;
926         
927         netdev->irq = dev->irq;
928         netdev->open               = ibmveth_open;
929         netdev->poll               = ibmveth_poll;
930         netdev->weight             = 16;
931         netdev->stop               = ibmveth_close;
932         netdev->hard_start_xmit    = ibmveth_start_xmit;
933         netdev->get_stats          = ibmveth_get_stats;
934         netdev->set_multicast_list = ibmveth_set_multicast_list;
935         netdev->do_ioctl           = ibmveth_ioctl;
936         netdev->ethtool_ops           = &netdev_ethtool_ops;
937         netdev->change_mtu         = ibmveth_change_mtu;
938
939         memcpy(&netdev->dev_addr, &adapter->mac_addr, netdev->addr_len);
940
941         ibmveth_init_buffer_pool(&adapter->rx_buff_pool[0], 0, IbmVethPool0DftCnt, IbmVethPool0DftSize);
942         ibmveth_init_buffer_pool(&adapter->rx_buff_pool[1], 1, IbmVethPool1DftCnt, IbmVethPool1DftSize);
943         ibmveth_init_buffer_pool(&adapter->rx_buff_pool[2], 2, IbmVethPool2DftCnt, IbmVethPool2DftSize);
944
945         ibmveth_debug_printk("adapter @ 0x%p\n", adapter);
946
947         INIT_WORK(&adapter->replenish_task, (void*)ibmveth_replenish_task, (void*)adapter);
948
949         adapter->buffer_list_dma = DMA_ERROR_CODE;
950         adapter->filter_list_dma = DMA_ERROR_CODE;
951         adapter->rx_queue.queue_dma = DMA_ERROR_CODE;
952
953         atomic_set(&adapter->not_replenishing, 1);
954
955         ibmveth_debug_printk("registering netdev...\n");
956
957         rc = register_netdev(netdev);
958
959         if(rc) {
960                 ibmveth_debug_printk("failed to register netdev rc=%d\n", rc);
961                 free_netdev(netdev);
962                 return rc;
963         }
964
965         ibmveth_debug_printk("registered\n");
966
967         ibmveth_proc_register_adapter(adapter);
968
969         return 0;
970 }
971
972 static int __devexit ibmveth_remove(struct vio_dev *dev)
973 {
974         struct net_device *netdev = dev->driver_data;
975         struct ibmveth_adapter *adapter = netdev->priv;
976
977         unregister_netdev(netdev);
978
979         ibmveth_proc_unregister_adapter(adapter);
980
981         free_netdev(netdev);
982         return 0;
983 }
984
985 #ifdef CONFIG_PROC_FS
986 static void ibmveth_proc_register_driver(void)
987 {
988         ibmveth_proc_dir = create_proc_entry(IBMVETH_PROC_DIR, S_IFDIR, proc_net);
989         if (ibmveth_proc_dir) {
990                 SET_MODULE_OWNER(ibmveth_proc_dir);
991         }
992 }
993
994 static void ibmveth_proc_unregister_driver(void)
995 {
996         remove_proc_entry(IBMVETH_PROC_DIR, proc_net);
997 }
998
999 static void *ibmveth_seq_start(struct seq_file *seq, loff_t *pos) 
1000 {
1001         if (*pos == 0) {
1002                 return (void *)1;
1003         } else {
1004                 return NULL;
1005         }
1006 }
1007
1008 static void *ibmveth_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1009 {
1010         ++*pos;
1011         return NULL;
1012 }
1013
1014 static void ibmveth_seq_stop(struct seq_file *seq, void *v) 
1015 {
1016 }
1017
1018 static int ibmveth_seq_show(struct seq_file *seq, void *v) 
1019 {
1020         struct ibmveth_adapter *adapter = seq->private;
1021         char *current_mac = ((char*) &adapter->netdev->dev_addr);
1022         char *firmware_mac = ((char*) &adapter->mac_addr) ;
1023
1024         seq_printf(seq, "%s %s\n\n", ibmveth_driver_string, ibmveth_driver_version);
1025         
1026         seq_printf(seq, "Unit Address:    0x%x\n", adapter->vdev->unit_address);
1027         seq_printf(seq, "LIOBN:           0x%lx\n", adapter->liobn);
1028         seq_printf(seq, "Current MAC:     %02X:%02X:%02X:%02X:%02X:%02X\n",
1029                    current_mac[0], current_mac[1], current_mac[2],
1030                    current_mac[3], current_mac[4], current_mac[5]);
1031         seq_printf(seq, "Firmware MAC:    %02X:%02X:%02X:%02X:%02X:%02X\n",
1032                    firmware_mac[0], firmware_mac[1], firmware_mac[2],
1033                    firmware_mac[3], firmware_mac[4], firmware_mac[5]);
1034         
1035         seq_printf(seq, "\nAdapter Statistics:\n");
1036         seq_printf(seq, "  TX:  skbuffs linearized:          %ld\n", adapter->tx_linearized);
1037         seq_printf(seq, "       multi-descriptor sends:      %ld\n", adapter->tx_multidesc_send);
1038         seq_printf(seq, "       skb_linearize failures:      %ld\n", adapter->tx_linearize_failed);
1039         seq_printf(seq, "       vio_map_single failres:      %ld\n", adapter->tx_map_failed);
1040         seq_printf(seq, "       send failures:               %ld\n", adapter->tx_send_failed);
1041         seq_printf(seq, "  RX:  replenish task cycles:       %ld\n", adapter->replenish_task_cycles);
1042         seq_printf(seq, "       alloc_skb_failures:          %ld\n", adapter->replenish_no_mem);
1043         seq_printf(seq, "       add buffer failures:         %ld\n", adapter->replenish_add_buff_failure);
1044         seq_printf(seq, "       invalid buffers:             %ld\n", adapter->rx_invalid_buffer);
1045         seq_printf(seq, "       no buffers:                  %ld\n", adapter->rx_no_buffer);
1046         
1047         return 0;
1048 }
1049 static struct seq_operations ibmveth_seq_ops = {
1050         .start = ibmveth_seq_start,
1051         .next  = ibmveth_seq_next,
1052         .stop  = ibmveth_seq_stop,
1053         .show  = ibmveth_seq_show,
1054 };
1055
1056 static int ibmveth_proc_open(struct inode *inode, struct file *file)
1057 {
1058         struct seq_file *seq;
1059         struct proc_dir_entry *proc;
1060         int rc;
1061
1062         rc = seq_open(file, &ibmveth_seq_ops);
1063         if (!rc) {
1064                 /* recover the pointer buried in proc_dir_entry data */
1065                 seq = file->private_data;
1066                 proc = PDE(inode);
1067                 seq->private = proc->data;
1068         }
1069         return rc;
1070 }
1071
1072 static struct file_operations ibmveth_proc_fops = {
1073         .owner   = THIS_MODULE,
1074         .open    = ibmveth_proc_open,
1075         .read    = seq_read,
1076         .llseek  = seq_lseek,
1077         .release = seq_release,
1078 };
1079
1080 static void ibmveth_proc_register_adapter(struct ibmveth_adapter *adapter)
1081 {
1082         struct proc_dir_entry *entry;
1083         if (ibmveth_proc_dir) {
1084                 entry = create_proc_entry(adapter->netdev->name, S_IFREG, ibmveth_proc_dir);
1085                 if (!entry) {
1086                         ibmveth_error_printk("Cannot create adapter proc entry");
1087                 } else {
1088                         entry->data = (void *) adapter;
1089                         entry->proc_fops = &ibmveth_proc_fops;
1090                         SET_MODULE_OWNER(entry);
1091                 }
1092         }
1093         return;
1094 }
1095
1096 static void ibmveth_proc_unregister_adapter(struct ibmveth_adapter *adapter)
1097 {
1098         if (ibmveth_proc_dir) {
1099                 remove_proc_entry(adapter->netdev->name, ibmveth_proc_dir);
1100         }
1101 }
1102
1103 #else /* CONFIG_PROC_FS */
1104 static void ibmveth_proc_register_adapter(struct ibmveth_adapter *adapter) 
1105 {
1106 }
1107
1108 static void ibmveth_proc_unregister_adapter(struct ibmveth_adapter *adapter) 
1109 {
1110 }
1111 static void ibmveth_proc_register_driver(void)
1112 {
1113 }
1114
1115 static void ibmveth_proc_unregister_driver(void)
1116 {
1117 }
1118 #endif /* CONFIG_PROC_FS */
1119
1120 static struct vio_device_id ibmveth_device_table[] __devinitdata= {
1121         { "network", "IBM,l-lan"},
1122         { 0,}
1123 };
1124
1125 MODULE_DEVICE_TABLE(vio, ibmveth_device_table);
1126
1127 static struct vio_driver ibmveth_driver = {
1128         .name        = (char *)ibmveth_driver_name,
1129         .id_table    = ibmveth_device_table,
1130         .probe       = ibmveth_probe,
1131         .remove      = ibmveth_remove
1132 };
1133
1134 static int __init ibmveth_module_init(void)
1135 {
1136         ibmveth_printk("%s: %s %s\n", ibmveth_driver_name, ibmveth_driver_string, ibmveth_driver_version);
1137
1138         ibmveth_proc_register_driver();
1139
1140         return vio_register_driver(&ibmveth_driver);
1141 }
1142
1143 static void __exit ibmveth_module_exit(void)
1144 {
1145         vio_unregister_driver(&ibmveth_driver);
1146         ibmveth_proc_unregister_driver();
1147 }       
1148
1149 module_init(ibmveth_module_init);
1150 module_exit(ibmveth_module_exit);