2 * Simulated Ethernet Driver
4 * Copyright (C) 1999-2001, 2003 Hewlett-Packard Co
5 * Stephane Eranian <eranian@hpl.hp.com>
7 #include <linux/kernel.h>
8 #include <linux/sched.h>
9 #include <linux/types.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>
26 #define SIMETH_RECV_MAX 10
29 * Maximum possible received frame for Ethernet.
30 * We preallocate an sk_buff of that size to avoid costly
31 * memcpy for temporary buffer into sk_buff. We do basically
32 * what's done in other drivers, like eepro with a ring.
33 * The difference is, of course, that we don't have real DMA !!!
35 #define SIMETH_FRAME_SIZE ETH_FRAME_LEN
38 #define SSC_NETDEV_PROBE 100
39 #define SSC_NETDEV_SEND 101
40 #define SSC_NETDEV_RECV 102
41 #define SSC_NETDEV_ATTACH 103
42 #define SSC_NETDEV_DETACH 104
44 #define NETWORK_INTR 8
47 struct net_device_stats stats
;
48 int simfd
; /* descriptor in the simulator */
51 static int simeth_probe1(void);
52 static int simeth_open(struct net_device
*dev
);
53 static int simeth_close(struct net_device
*dev
);
54 static int simeth_tx(struct sk_buff
*skb
, struct net_device
*dev
);
55 static int simeth_rx(struct net_device
*dev
);
56 static struct net_device_stats
*simeth_get_stats(struct net_device
*dev
);
57 static irqreturn_t
simeth_interrupt(int irq
, void *dev_id
);
58 static void set_multicast_list(struct net_device
*dev
);
59 static int simeth_device_event(struct notifier_block
*this,unsigned long event
, void *ptr
);
61 static char *simeth_version
="0.3";
64 * This variable is used to establish a mapping between the Linux/ia64 kernel
65 * and the host linux kernel.
67 * As of today, we support only one card, even though most of the code
68 * is ready for many more. The mapping is then:
69 * linux/ia64 -> linux/x86
72 * In the future, we some string operations, we could easily support up
75 * The default mapping can be changed on the kernel command line by
76 * specifying simeth=ethX (or whatever string you want).
78 static char *simeth_device
="eth0"; /* default host interface to use */
82 static volatile unsigned int card_count
; /* how many cards "found" so far */
83 static int simeth_debug
; /* set to 1 to get debug information */
86 * Used to catch IFF_UP & IFF_DOWN events
88 static struct notifier_block simeth_dev_notifier
= {
95 * Function used when using a kernel command line option.
97 * Format: simeth=interface_name (like eth0)
100 simeth_setup(char *str
)
106 __setup("simeth=", simeth_setup
);
109 * Function used to probe for simeth devices when not installed
110 * as a loadable module
118 printk(KERN_INFO
"simeth: v%s\n", simeth_version
);
122 if (r
== 0) register_netdevice_notifier(&simeth_dev_notifier
);
127 extern long ia64_ssc (long, long, long, long, int);
128 extern void ia64_ssc_connect_irq (long intr
, long irq
);
131 netdev_probe(char *name
, unsigned char *ether
)
133 return ia64_ssc(__pa(name
), __pa(ether
), 0,0, SSC_NETDEV_PROBE
);
138 netdev_connect(int irq
)
141 * this does not support multiple cards
142 * also no return value
144 ia64_ssc_connect_irq(NETWORK_INTR
, irq
);
149 netdev_attach(int fd
, int irq
, unsigned int ipaddr
)
151 /* this puts the host interface in the right mode (start interrupting) */
152 return ia64_ssc(fd
, ipaddr
, 0,0, SSC_NETDEV_ATTACH
);
157 netdev_detach(int fd
)
160 * inactivate the host interface (don't interrupt anymore) */
161 return ia64_ssc(fd
, 0,0,0, SSC_NETDEV_DETACH
);
165 netdev_send(int fd
, unsigned char *buf
, unsigned int len
)
167 return ia64_ssc(fd
, __pa(buf
), len
, 0, SSC_NETDEV_SEND
);
171 netdev_read(int fd
, unsigned char *buf
, unsigned int len
)
173 return ia64_ssc(fd
, __pa(buf
), len
, 0, SSC_NETDEV_RECV
);
177 * Function shared with module code, so cannot be in init section
179 * So far this function "detects" only one card (test_&_set) but could
180 * be extended easily.
183 * - -ENODEV is no device found
184 * - -ENOMEM is no more memory
190 unsigned char mac_addr
[ETH_ALEN
];
191 struct simeth_local
*local
;
192 struct net_device
*dev
;
197 * let's support just one card for now
199 if (test_and_set_bit(0, &card_count
))
203 * check with the simulator for the device
205 fd
= netdev_probe(simeth_device
, mac_addr
);
209 dev
= alloc_etherdev(sizeof(struct simeth_local
));
213 memcpy(dev
->dev_addr
, mac_addr
, sizeof(mac_addr
));
216 local
->simfd
= fd
; /* keep track of underlying file descriptor */
218 dev
->open
= simeth_open
;
219 dev
->stop
= simeth_close
;
220 dev
->hard_start_xmit
= simeth_tx
;
221 dev
->get_stats
= simeth_get_stats
;
222 dev
->set_multicast_list
= set_multicast_list
; /* no yet used */
224 err
= register_netdev(dev
);
230 if ((rc
= assign_irq_vector(AUTO_ASSIGN
)) < 0)
231 panic("%s: out of interrupt vectors!\n", __FUNCTION__
);
235 * attach the interrupt in the simulator, this does enable interrupts
236 * until a netdev_attach() is called
238 netdev_connect(dev
->irq
);
240 printk(KERN_INFO
"%s: hosteth=%s simfd=%d, HwAddr",
241 dev
->name
, simeth_device
, local
->simfd
);
242 for(i
= 0; i
< ETH_ALEN
; i
++) {
243 printk(" %2.2x", dev
->dev_addr
[i
]);
245 printk(", IRQ %d\n", dev
->irq
);
251 * actually binds the device to an interrupt vector
254 simeth_open(struct net_device
*dev
)
256 if (request_irq(dev
->irq
, simeth_interrupt
, 0, "simeth", dev
)) {
257 printk(KERN_WARNING
"simeth: unable to get IRQ %d.\n", dev
->irq
);
261 netif_start_queue(dev
);
266 /* copied from lapbether.c */
267 static __inline__
int dev_is_ethdev(struct net_device
*dev
)
269 return ( dev
->type
== ARPHRD_ETHER
&& strncmp(dev
->name
, "dummy", 5));
274 * Handler for IFF_UP or IFF_DOWN
276 * The reason for that is that we don't want to be interrupted when the
277 * interface is down. There is no way to unconnect in the simualtor. Instead
278 * we use this function to shutdown packet processing in the frame filter
279 * in the simulator. Thus no interrupts are generated
282 * That's also the place where we pass the IP address of this device to the
283 * simulator so that that we can start filtering packets for it
285 * There may be a better way of doing this, but I don't know which yet.
288 simeth_device_event(struct notifier_block
*this,unsigned long event
, void *ptr
)
290 struct net_device
*dev
= ptr
;
291 struct simeth_local
*local
;
292 struct in_device
*in_dev
;
293 struct in_ifaddr
**ifap
= NULL
;
294 struct in_ifaddr
*ifa
= NULL
;
299 printk(KERN_WARNING
"simeth_device_event dev=0\n");
303 if ( event
!= NETDEV_UP
&& event
!= NETDEV_DOWN
) return NOTIFY_DONE
;
306 * Check whether or not it's for an ethernet device
308 * XXX Fixme: This works only as long as we support one
309 * type of ethernet device.
311 if ( !dev_is_ethdev(dev
) ) return NOTIFY_DONE
;
313 if ((in_dev
=dev
->ip_ptr
) != NULL
) {
314 for (ifap
=&in_dev
->ifa_list
; (ifa
=*ifap
) != NULL
; ifap
=&ifa
->ifa_next
)
315 if (strcmp(dev
->name
, ifa
->ifa_label
) == 0) break;
318 printk(KERN_ERR
"simeth_open: can't find device %s's ifa\n", dev
->name
);
322 printk(KERN_INFO
"simeth_device_event: %s ipaddr=0x%x\n",
323 dev
->name
, ntohl(ifa
->ifa_local
));
327 * if the device was up, and we're simply reconfiguring it, not sure
328 * we get DOWN then UP.
332 /* now do it for real */
333 r
= event
== NETDEV_UP
?
334 netdev_attach(local
->simfd
, dev
->irq
, ntohl(ifa
->ifa_local
)):
335 netdev_detach(local
->simfd
);
337 printk(KERN_INFO
"simeth: netdev_attach/detach: event=%s ->%d\n",
338 event
== NETDEV_UP
? "attach":"detach", r
);
344 simeth_close(struct net_device
*dev
)
346 netif_stop_queue(dev
);
348 free_irq(dev
->irq
, dev
);
354 * Only used for debug
357 frame_print(unsigned char *from
, unsigned char *frame
, int len
)
361 printk("%s: (%d) %02x", from
, len
, frame
[0] & 0xff);
362 for(i
=1; i
< 6; i
++ ) {
363 printk(":%02x", frame
[i
] &0xff);
365 printk(" %2x", frame
[6] &0xff);
366 for(i
=7; i
< 12; i
++ ) {
367 printk(":%02x", frame
[i
] &0xff);
369 printk(" [%02x%02x]\n", frame
[12], frame
[13]);
371 for(i
=14; i
< len
; i
++ ) {
372 printk("%02x ", frame
[i
] &0xff);
373 if ( (i
%10)==0) printk("\n");
380 * Function used to transmit of frame, very last one on the path before
381 * going to the simulator.
384 simeth_tx(struct sk_buff
*skb
, struct net_device
*dev
)
386 struct simeth_local
*local
= dev
->priv
;
389 /* ensure we have at least ETH_ZLEN bytes (min frame size) */
390 unsigned int length
= ETH_ZLEN
< skb
->len
? skb
->len
: ETH_ZLEN
;
391 /* Where do the extra padding bytes comes from inthe skbuff ? */
393 /* the real driver in the host system is going to take care of that
394 * or maybe it's the NIC itself.
396 unsigned int length
= skb
->len
;
399 local
->stats
.tx_bytes
+= skb
->len
;
400 local
->stats
.tx_packets
++;
403 if (simeth_debug
> 5) frame_print("simeth_tx", skb
->data
, length
);
405 netdev_send(local
->simfd
, skb
->data
, length
);
408 * we are synchronous on write, so we don't simulate a
409 * trasnmit complete interrupt, thus we don't need to arm a tx
416 static inline struct sk_buff
*
417 make_new_skb(struct net_device
*dev
)
419 struct sk_buff
*nskb
;
422 * The +2 is used to make sure that the IP header is nicely
423 * aligned (on 4byte boundary I assume 14+2=16)
425 nskb
= dev_alloc_skb(SIMETH_FRAME_SIZE
+ 2);
426 if ( nskb
== NULL
) {
427 printk(KERN_NOTICE
"%s: memory squeeze. dropping packet.\n", dev
->name
);
431 skb_reserve(nskb
, 2); /* Align IP on 16 byte boundaries */
433 skb_put(nskb
,SIMETH_FRAME_SIZE
);
439 * called from interrupt handler to process a received frame
442 simeth_rx(struct net_device
*dev
)
444 struct simeth_local
*local
;
447 int rcv_count
= SIMETH_RECV_MAX
;
451 * the loop concept has been borrowed from other drivers
452 * looks to me like it's a throttling thing to avoid pushing to many
453 * packets at one time into the stack. Making sure we can process them
454 * upstream and make forward progress overall
457 if ( (skb
=make_new_skb(dev
)) == NULL
) {
458 printk(KERN_NOTICE
"%s: memory squeeze. dropping packet.\n", dev
->name
);
459 local
->stats
.rx_dropped
++;
463 * Read only one frame at a time
465 len
= netdev_read(local
->simfd
, skb
->data
, SIMETH_FRAME_SIZE
);
467 if ( simeth_debug
> 0 ) printk(KERN_WARNING
"%s: count=%d netdev_read=0\n",
468 dev
->name
, SIMETH_RECV_MAX
-rcv_count
);
474 * Should really do a csum+copy here
476 skb_copy_to_linear_data(skb
, frame
, len
);
478 skb
->protocol
= eth_type_trans(skb
, dev
);
480 if ( simeth_debug
> 6 ) frame_print("simeth_rx", skb
->data
, len
);
483 * push the packet up & trigger software interrupt
487 local
->stats
.rx_packets
++;
488 local
->stats
.rx_bytes
+= len
;
490 } while ( --rcv_count
);
492 return len
; /* 0 = nothing left to read, otherwise, we can try again */
496 * Interrupt handler (Yes, we can do it too !!!)
499 simeth_interrupt(int irq
, void *dev_id
)
501 struct net_device
*dev
= dev_id
;
504 printk(KERN_WARNING
"simeth: irq %d for unknown device\n", irq
);
509 * very simple loop because we get interrupts only when receiving
511 while (simeth_rx(dev
));
515 static struct net_device_stats
*
516 simeth_get_stats(struct net_device
*dev
)
518 struct simeth_local
*local
= dev
->priv
;
520 return &local
->stats
;
523 /* fake multicast ability */
525 set_multicast_list(struct net_device
*dev
)
527 printk(KERN_WARNING
"%s: set_multicast_list called\n", dev
->name
);
530 __initcall(simeth_probe
);