Fix pppol2tp getsockname()
[linux-2.6.git] / arch / ia64 / hp / sim / simeth.c
1 /*
2  * Simulated Ethernet Driver
3  *
4  * Copyright (C) 1999-2001, 2003 Hewlett-Packard Co
5  *      Stephane Eranian <eranian@hpl.hp.com>
6  */
7 #include <linux/kernel.h>
8 #include <linux/sched.h>
9 #include <linux/types.h>
10 #include <linux/in.h>
11 #include <linux/string.h>
12 #include <linux/init.h>
13 #include <linux/errno.h>
14 #include <linux/interrupt.h>
15 #include <linux/netdevice.h>
16 #include <linux/etherdevice.h>
17 #include <linux/inetdevice.h>
18 #include <linux/if_ether.h>
19 #include <linux/if_arp.h>
20 #include <linux/skbuff.h>
21 #include <linux/notifier.h>
22 #include <linux/bitops.h>
23 #include <asm/system.h>
24 #include <asm/irq.h>
25 #include <asm/hpsim.h>
26
27 #include "hpsim_ssc.h"
28
29 #define SIMETH_RECV_MAX 10
30
31 /*
32  * Maximum possible received frame for Ethernet.
33  * We preallocate an sk_buff of that size to avoid costly
34  * memcpy for temporary buffer into sk_buff. We do basically
35  * what's done in other drivers, like eepro with a ring.
36  * The difference is, of course, that we don't have real DMA !!!
37  */
38 #define SIMETH_FRAME_SIZE       ETH_FRAME_LEN
39
40
41 #define NETWORK_INTR                    8
42
43 struct simeth_local {
44         struct net_device_stats stats;
45         int                     simfd;   /* descriptor in the simulator */
46 };
47
48 static int simeth_probe1(void);
49 static int simeth_open(struct net_device *dev);
50 static int simeth_close(struct net_device *dev);
51 static int simeth_tx(struct sk_buff *skb, struct net_device *dev);
52 static int simeth_rx(struct net_device *dev);
53 static struct net_device_stats *simeth_get_stats(struct net_device *dev);
54 static irqreturn_t simeth_interrupt(int irq, void *dev_id);
55 static void set_multicast_list(struct net_device *dev);
56 static int simeth_device_event(struct notifier_block *this,unsigned long event, void *ptr);
57
58 static char *simeth_version="0.3";
59
60 /*
61  * This variable is used to establish a mapping between the Linux/ia64 kernel
62  * and the host linux kernel.
63  *
64  * As of today, we support only one card, even though most of the code
65  * is ready for many more. The mapping is then:
66  *      linux/ia64 -> linux/x86
67  *         eth0    -> eth1
68  *
69  * In the future, we some string operations, we could easily support up
70  * to 10 cards (0-9).
71  *
72  * The default mapping can be changed on the kernel command line by
73  * specifying simeth=ethX (or whatever string you want).
74  */
75 static char *simeth_device="eth0";       /* default host interface to use */
76
77
78
79 static volatile unsigned int card_count; /* how many cards "found" so far */
80 static int simeth_debug;                /* set to 1 to get debug information */
81
82 /*
83  * Used to catch IFF_UP & IFF_DOWN events
84  */
85 static struct notifier_block simeth_dev_notifier = {
86         simeth_device_event,
87         NULL
88 };
89
90
91 /*
92  * Function used when using a kernel command line option.
93  *
94  * Format: simeth=interface_name (like eth0)
95  */
96 static int __init
97 simeth_setup(char *str)
98 {
99         simeth_device = str;
100         return 1;
101 }
102
103 __setup("simeth=", simeth_setup);
104
105 /*
106  * Function used to probe for simeth devices when not installed
107  * as a loadable module
108  */
109
110 int __init
111 simeth_probe (void)
112 {
113         int r;
114
115         printk(KERN_INFO "simeth: v%s\n", simeth_version);
116
117         r = simeth_probe1();
118
119         if (r == 0) register_netdevice_notifier(&simeth_dev_notifier);
120
121         return r;
122 }
123
124 static inline int
125 netdev_probe(char *name, unsigned char *ether)
126 {
127         return ia64_ssc(__pa(name), __pa(ether), 0,0, SSC_NETDEV_PROBE);
128 }
129
130
131 static inline int
132 netdev_connect(int irq)
133 {
134         /* XXX Fix me
135          * this does not support multiple cards
136          * also no return value
137          */
138         ia64_ssc_connect_irq(NETWORK_INTR, irq);
139         return 0;
140 }
141
142 static inline int
143 netdev_attach(int fd, int irq, unsigned int ipaddr)
144 {
145         /* this puts the host interface in the right mode (start interrupting) */
146         return ia64_ssc(fd, ipaddr, 0,0, SSC_NETDEV_ATTACH);
147 }
148
149
150 static inline int
151 netdev_detach(int fd)
152 {
153         /*
154          * inactivate the host interface (don't interrupt anymore) */
155         return ia64_ssc(fd, 0,0,0, SSC_NETDEV_DETACH);
156 }
157
158 static inline int
159 netdev_send(int fd, unsigned char *buf, unsigned int len)
160 {
161         return ia64_ssc(fd, __pa(buf), len, 0, SSC_NETDEV_SEND);
162 }
163
164 static inline int
165 netdev_read(int fd, unsigned char *buf, unsigned int len)
166 {
167         return ia64_ssc(fd, __pa(buf), len, 0, SSC_NETDEV_RECV);
168 }
169
170 static const struct net_device_ops simeth_netdev_ops = {
171         .ndo_open               = simeth_open,
172         .ndo_stop               = simeth_close,
173         .ndo_start_xmit         = simeth_tx,
174         .ndo_get_stats          = simeth_get_stats,
175         .ndo_set_rx_mode        = set_multicast_list, /* not yet used */
176
177 };
178
179 /*
180  * Function shared with module code, so cannot be in init section
181  *
182  * So far this function "detects" only one card (test_&_set) but could
183  * be extended easily.
184  *
185  * Return:
186  *      - -ENODEV is no device found
187  *      - -ENOMEM is no more memory
188  *      - 0 otherwise
189  */
190 static int
191 simeth_probe1(void)
192 {
193         unsigned char mac_addr[ETH_ALEN];
194         struct simeth_local *local;
195         struct net_device *dev;
196         int fd, err, rc;
197
198         /*
199          * XXX Fix me
200          * let's support just one card for now
201          */
202         if (test_and_set_bit(0, &card_count))
203                 return -ENODEV;
204
205         /*
206          * check with the simulator for the device
207          */
208         fd = netdev_probe(simeth_device, mac_addr);
209         if (fd == -1)
210                 return -ENODEV;
211
212         dev = alloc_etherdev(sizeof(struct simeth_local));
213         if (!dev)
214                 return -ENOMEM;
215
216         memcpy(dev->dev_addr, mac_addr, sizeof(mac_addr));
217
218         local = netdev_priv(dev);
219         local->simfd = fd; /* keep track of underlying file descriptor */
220
221         dev->netdev_ops = &simeth_netdev_ops;
222
223         err = register_netdev(dev);
224         if (err) {
225                 free_netdev(dev);
226                 return err;
227         }
228
229         if ((rc = assign_irq_vector(AUTO_ASSIGN)) < 0)
230                 panic("%s: out of interrupt vectors!\n", __func__);
231         dev->irq = rc;
232
233         /*
234          * attach the interrupt in the simulator, this does enable interrupts
235          * until a netdev_attach() is called
236          */
237         netdev_connect(dev->irq);
238
239         printk(KERN_INFO "%s: hosteth=%s simfd=%d, HwAddr=%pm, IRQ %d\n",
240                dev->name, simeth_device, local->simfd, dev->dev_addr, dev->irq);
241
242         return 0;
243 }
244
245 /*
246  * actually binds the device to an interrupt vector
247  */
248 static int
249 simeth_open(struct net_device *dev)
250 {
251         if (request_irq(dev->irq, simeth_interrupt, 0, "simeth", dev)) {
252                 printk(KERN_WARNING "simeth: unable to get IRQ %d.\n", dev->irq);
253                 return -EAGAIN;
254         }
255
256         netif_start_queue(dev);
257
258         return 0;
259 }
260
261 /* copied from lapbether.c */
262 static __inline__ int dev_is_ethdev(struct net_device *dev)
263 {
264        return ( dev->type == ARPHRD_ETHER && strncmp(dev->name, "dummy", 5));
265 }
266
267
268 /*
269  * Handler for IFF_UP or IFF_DOWN
270  *
271  * The reason for that is that we don't want to be interrupted when the
272  * interface is down. There is no way to unconnect in the simualtor. Instead
273  * we use this function to shutdown packet processing in the frame filter
274  * in the simulator. Thus no interrupts are generated
275  *
276  *
277  * That's also the place where we pass the IP address of this device to the
278  * simulator so that that we can start filtering packets for it
279  *
280  * There may be a better way of doing this, but I don't know which yet.
281  */
282 static int
283 simeth_device_event(struct notifier_block *this,unsigned long event, void *ptr)
284 {
285         struct net_device *dev = ptr;
286         struct simeth_local *local;
287         struct in_device *in_dev;
288         struct in_ifaddr **ifap = NULL;
289         struct in_ifaddr *ifa = NULL;
290         int r;
291
292
293         if ( ! dev ) {
294                 printk(KERN_WARNING "simeth_device_event dev=0\n");
295                 return NOTIFY_DONE;
296         }
297
298         if (dev_net(dev) != &init_net)
299                 return NOTIFY_DONE;
300
301         if ( event != NETDEV_UP && event != NETDEV_DOWN ) return NOTIFY_DONE;
302
303         /*
304          * Check whether or not it's for an ethernet device
305          *
306          * XXX Fixme: This works only as long as we support one
307          * type of ethernet device.
308          */
309         if ( !dev_is_ethdev(dev) ) return NOTIFY_DONE;
310
311         if ((in_dev=dev->ip_ptr) != NULL) {
312                 for (ifap=&in_dev->ifa_list; (ifa=*ifap) != NULL; ifap=&ifa->ifa_next)
313                         if (strcmp(dev->name, ifa->ifa_label) == 0) break;
314         }
315         if ( ifa == NULL ) {
316                 printk(KERN_ERR "simeth_open: can't find device %s's ifa\n", dev->name);
317                 return NOTIFY_DONE;
318         }
319
320         printk(KERN_INFO "simeth_device_event: %s ipaddr=0x%x\n",
321                dev->name, ntohl(ifa->ifa_local));
322
323         /*
324          * XXX Fix me
325          * if the device was up, and we're simply reconfiguring it, not sure
326          * we get DOWN then UP.
327          */
328
329         local = netdev_priv(dev);
330         /* now do it for real */
331         r = event == NETDEV_UP ?
332                 netdev_attach(local->simfd, dev->irq, ntohl(ifa->ifa_local)):
333                 netdev_detach(local->simfd);
334
335         printk(KERN_INFO "simeth: netdev_attach/detach: event=%s ->%d\n",
336                event == NETDEV_UP ? "attach":"detach", r);
337
338         return NOTIFY_DONE;
339 }
340
341 static int
342 simeth_close(struct net_device *dev)
343 {
344         netif_stop_queue(dev);
345
346         free_irq(dev->irq, dev);
347
348         return 0;
349 }
350
351 /*
352  * Only used for debug
353  */
354 static void
355 frame_print(unsigned char *from, unsigned char *frame, int len)
356 {
357         int i;
358
359         printk("%s: (%d) %02x", from, len, frame[0] & 0xff);
360         for(i=1; i < 6; i++ ) {
361                 printk(":%02x", frame[i] &0xff);
362         }
363         printk(" %2x", frame[6] &0xff);
364         for(i=7; i < 12; i++ ) {
365                 printk(":%02x", frame[i] &0xff);
366         }
367         printk(" [%02x%02x]\n", frame[12], frame[13]);
368
369         for(i=14; i < len; i++ ) {
370                 printk("%02x ", frame[i] &0xff);
371                 if ( (i%10)==0) printk("\n");
372         }
373         printk("\n");
374 }
375
376
377 /*
378  * Function used to transmit of frame, very last one on the path before
379  * going to the simulator.
380  */
381 static int
382 simeth_tx(struct sk_buff *skb, struct net_device *dev)
383 {
384         struct simeth_local *local = netdev_priv(dev);
385
386 #if 0
387         /* ensure we have at least ETH_ZLEN bytes (min frame size) */
388         unsigned int length = ETH_ZLEN < skb->len ? skb->len : ETH_ZLEN;
389         /* Where do the extra padding bytes comes from inthe skbuff ? */
390 #else
391         /* the real driver in the host system is going to take care of that
392          * or maybe it's the NIC itself.
393          */
394         unsigned int length = skb->len;
395 #endif
396
397         local->stats.tx_bytes += skb->len;
398         local->stats.tx_packets++;
399
400
401         if (simeth_debug > 5) frame_print("simeth_tx", skb->data, length);
402
403         netdev_send(local->simfd, skb->data, length);
404
405         /*
406          * we are synchronous on write, so we don't simulate a
407          * trasnmit complete interrupt, thus we don't need to arm a tx
408          */
409
410         dev_kfree_skb(skb);
411         return NETDEV_TX_OK;
412 }
413
414 static inline struct sk_buff *
415 make_new_skb(struct net_device *dev)
416 {
417         struct sk_buff *nskb;
418
419         /*
420          * The +2 is used to make sure that the IP header is nicely
421          * aligned (on 4byte boundary I assume 14+2=16)
422          */
423         nskb = dev_alloc_skb(SIMETH_FRAME_SIZE + 2);
424         if ( nskb == NULL ) {
425                 printk(KERN_NOTICE "%s: memory squeeze. dropping packet.\n", dev->name);
426                 return NULL;
427         }
428
429         skb_reserve(nskb, 2);   /* Align IP on 16 byte boundaries */
430
431         skb_put(nskb,SIMETH_FRAME_SIZE);
432
433         return nskb;
434 }
435
436 /*
437  * called from interrupt handler to process a received frame
438  */
439 static int
440 simeth_rx(struct net_device *dev)
441 {
442         struct simeth_local     *local;
443         struct sk_buff          *skb;
444         int                     len;
445         int                     rcv_count = SIMETH_RECV_MAX;
446
447         local = netdev_priv(dev);
448         /*
449          * the loop concept has been borrowed from other drivers
450          * looks to me like it's a throttling thing to avoid pushing to many
451          * packets at one time into the stack. Making sure we can process them
452          * upstream and make forward progress overall
453          */
454         do {
455                 if ( (skb=make_new_skb(dev)) == NULL ) {
456                         printk(KERN_NOTICE "%s: memory squeeze. dropping packet.\n", dev->name);
457                         local->stats.rx_dropped++;
458                         return 0;
459                 }
460                 /*
461                  * Read only one frame at a time
462                  */
463                 len = netdev_read(local->simfd, skb->data, SIMETH_FRAME_SIZE);
464                 if ( len == 0 ) {
465                         if ( simeth_debug > 0 ) printk(KERN_WARNING "%s: count=%d netdev_read=0\n",
466                                                        dev->name, SIMETH_RECV_MAX-rcv_count);
467                         break;
468                 }
469 #if 0
470                 /*
471                  * XXX Fix me
472                  * Should really do a csum+copy here
473                  */
474                 skb_copy_to_linear_data(skb, frame, len);
475 #endif
476                 skb->protocol = eth_type_trans(skb, dev);
477
478                 if ( simeth_debug > 6 ) frame_print("simeth_rx", skb->data, len);
479
480                 /*
481                  * push the packet up & trigger software interrupt
482                  */
483                 netif_rx(skb);
484
485                 local->stats.rx_packets++;
486                 local->stats.rx_bytes += len;
487
488         } while ( --rcv_count );
489
490         return len; /* 0 = nothing left to read, otherwise, we can try again */
491 }
492
493 /*
494  * Interrupt handler (Yes, we can do it too !!!)
495  */
496 static irqreturn_t
497 simeth_interrupt(int irq, void *dev_id)
498 {
499         struct net_device *dev = dev_id;
500
501         /*
502          * very simple loop because we get interrupts only when receiving
503          */
504         while (simeth_rx(dev));
505         return IRQ_HANDLED;
506 }
507
508 static struct net_device_stats *
509 simeth_get_stats(struct net_device *dev)
510 {
511         struct simeth_local *local = netdev_priv(dev);
512
513         return &local->stats;
514 }
515
516 /* fake multicast ability */
517 static void
518 set_multicast_list(struct net_device *dev)
519 {
520         printk(KERN_WARNING "%s: set_multicast_list called\n", dev->name);
521 }
522
523 __initcall(simeth_probe);