2 * Copyright (c) 2009, Microsoft Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 * Place - Suite 330, Boston, MA 02111-1307 USA.
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
21 #include <linux/init.h>
22 #include <linux/module.h>
23 #include <linux/highmem.h>
24 #include <linux/device.h>
26 #include <linux/delay.h>
27 #include <linux/netdevice.h>
28 #include <linux/inetdevice.h>
29 #include <linux/etherdevice.h>
30 #include <linux/skbuff.h>
33 #include <net/route.h>
35 #include <net/pkt_sched.h>
39 #include "NetVscApi.h"
41 MODULE_LICENSE("GPL");
43 struct net_device_context
{
44 /* point back to our device context */
45 struct device_context
*device_ctx
;
46 struct net_device_stats stats
;
49 struct netvsc_driver_context
{
50 /* !! These must be the first 2 fields !! */
51 /* Which is a bug FIXME! */
52 struct driver_context drv_ctx
;
53 struct netvsc_driver drv_obj
;
56 static int netvsc_ringbuffer_size
= NETVSC_DEVICE_RING_BUFFER_SIZE
;
58 /* The one and only one */
59 static struct netvsc_driver_context g_netvsc_drv
;
61 static struct net_device_stats
*netvsc_get_stats(struct net_device
*net
)
63 struct net_device_context
*net_device_ctx
= netdev_priv(net
);
65 return &net_device_ctx
->stats
;
68 static void netvsc_set_multicast_list(struct net_device
*net
)
72 static int netvsc_open(struct net_device
*net
)
74 struct net_device_context
*net_device_ctx
= netdev_priv(net
);
75 struct hv_device
*device_obj
= &net_device_ctx
->device_ctx
->device_obj
;
78 DPRINT_ENTER(NETVSC_DRV
);
80 if (netif_carrier_ok(net
)) {
81 memset(&net_device_ctx
->stats
, 0,
82 sizeof(struct net_device_stats
));
84 /* Open up the device */
85 ret
= RndisFilterOnOpen(device_obj
);
87 DPRINT_ERR(NETVSC_DRV
,
88 "unable to open device (ret %d).", ret
);
92 netif_start_queue(net
);
94 DPRINT_ERR(NETVSC_DRV
, "unable to open device...link is down.");
97 DPRINT_EXIT(NETVSC_DRV
);
101 static int netvsc_close(struct net_device
*net
)
103 struct net_device_context
*net_device_ctx
= netdev_priv(net
);
104 struct driver_context
*driver_ctx
=
105 driver_to_driver_context(net_device_ctx
->device_ctx
->device
.driver
);
106 struct netvsc_driver_context
*net_drv_ctx
=
107 (struct netvsc_driver_context
*)driver_ctx
;
108 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
109 struct hv_device
*device_obj
= &net_device_ctx
->device_ctx
->device_obj
;
112 DPRINT_ENTER(NETVSC_DRV
);
114 netif_stop_queue(net
);
116 ret
= net_drv_obj
->OnClose(device_obj
);
118 DPRINT_ERR(NETVSC_DRV
, "unable to close device (ret %d).", ret
);
120 DPRINT_EXIT(NETVSC_DRV
);
125 static void netvsc_xmit_completion(void *context
)
127 struct hv_netvsc_packet
*packet
= (struct hv_netvsc_packet
*)context
;
128 struct sk_buff
*skb
= (struct sk_buff
*)
129 (unsigned long)packet
->Completion
.Send
.SendCompletionTid
;
130 struct net_device
*net
;
132 DPRINT_ENTER(NETVSC_DRV
);
138 dev_kfree_skb_any(skb
);
140 if (netif_queue_stopped(net
)) {
141 DPRINT_INFO(NETVSC_DRV
, "net device (%p) waking up...",
144 netif_wake_queue(net
);
148 DPRINT_EXIT(NETVSC_DRV
);
151 static int netvsc_start_xmit(struct sk_buff
*skb
, struct net_device
*net
)
153 struct net_device_context
*net_device_ctx
= netdev_priv(net
);
154 struct driver_context
*driver_ctx
=
155 driver_to_driver_context(net_device_ctx
->device_ctx
->device
.driver
);
156 struct netvsc_driver_context
*net_drv_ctx
=
157 (struct netvsc_driver_context
*)driver_ctx
;
158 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
159 struct hv_netvsc_packet
*packet
;
165 DPRINT_ENTER(NETVSC_DRV
);
167 /* Support only 1 chain of frags */
168 ASSERT(skb_shinfo(skb
)->frag_list
== NULL
);
169 ASSERT(skb
->dev
== net
);
171 DPRINT_DBG(NETVSC_DRV
, "xmit packet - len %d data_len %d",
172 skb
->len
, skb
->data_len
);
174 /* Add 1 for skb->data and any additional ones requested */
175 num_frags
= skb_shinfo(skb
)->nr_frags
+ 1 +
176 net_drv_obj
->AdditionalRequestPageBufferCount
;
178 /* Allocate a netvsc packet based on # of frags. */
179 packet
= kzalloc(sizeof(struct hv_netvsc_packet
) +
180 (num_frags
* sizeof(struct hv_page_buffer
)) +
181 net_drv_obj
->RequestExtSize
, GFP_ATOMIC
);
183 DPRINT_ERR(NETVSC_DRV
, "unable to allocate hv_netvsc_packet");
187 packet
->Extension
= (void *)(unsigned long)packet
+
188 sizeof(struct hv_netvsc_packet
) +
189 (num_frags
* sizeof(struct hv_page_buffer
));
191 /* Setup the rndis header */
192 packet
->PageBufferCount
= num_frags
;
194 /* TODO: Flush all write buffers/ memory fence ??? */
197 /* Initialize it from the skb */
199 packet
->TotalDataBufferLength
= skb
->len
;
202 * Start filling in the page buffers starting at
203 * AdditionalRequestPageBufferCount offset
205 packet
->PageBuffers
[net_drv_obj
->AdditionalRequestPageBufferCount
].Pfn
= virt_to_phys(skb
->data
) >> PAGE_SHIFT
;
206 packet
->PageBuffers
[net_drv_obj
->AdditionalRequestPageBufferCount
].Offset
= (unsigned long)skb
->data
& (PAGE_SIZE
- 1);
207 packet
->PageBuffers
[net_drv_obj
->AdditionalRequestPageBufferCount
].Length
= skb
->len
- skb
->data_len
;
209 ASSERT((skb
->len
- skb
->data_len
) <= PAGE_SIZE
);
211 for (i
= net_drv_obj
->AdditionalRequestPageBufferCount
+ 1;
212 i
< num_frags
; i
++) {
213 packet
->PageBuffers
[i
].Pfn
=
214 page_to_pfn(skb_shinfo(skb
)->frags
[i
-(net_drv_obj
->AdditionalRequestPageBufferCount
+1)].page
);
215 packet
->PageBuffers
[i
].Offset
=
216 skb_shinfo(skb
)->frags
[i
-(net_drv_obj
->AdditionalRequestPageBufferCount
+1)].page_offset
;
217 packet
->PageBuffers
[i
].Length
=
218 skb_shinfo(skb
)->frags
[i
-(net_drv_obj
->AdditionalRequestPageBufferCount
+1)].size
;
221 /* Set the completion routine */
222 packet
->Completion
.Send
.OnSendCompletion
= netvsc_xmit_completion
;
223 packet
->Completion
.Send
.SendCompletionContext
= packet
;
224 packet
->Completion
.Send
.SendCompletionTid
= (unsigned long)skb
;
227 ret
= net_drv_obj
->OnSend(&net_device_ctx
->device_ctx
->device_obj
,
232 net_device_ctx
->stats
.tx_bytes
+= skb
->len
;
233 net_device_ctx
->stats
.tx_packets
++;
237 DPRINT_ERR(NETVSC_DRV
, "unable to send..."
238 "retrying %d...", retries
);
243 /* no more room or we are shutting down */
244 DPRINT_ERR(NETVSC_DRV
, "unable to send (%d)..."
245 "marking net device (%p) busy", ret
, net
);
246 DPRINT_INFO(NETVSC_DRV
, "net device (%p) stopping", net
);
248 ret
= NETDEV_TX_BUSY
;
249 net_device_ctx
->stats
.tx_dropped
++;
251 netif_stop_queue(net
);
254 * Null it since the caller will free it instead of the
257 packet
->Completion
.Send
.SendCompletionTid
= 0;
260 * Release the resources since we will not get any send
263 netvsc_xmit_completion((void *)packet
);
266 DPRINT_DBG(NETVSC_DRV
, "# of xmits %lu total size %lu",
267 net_device_ctx
->stats
.tx_packets
,
268 net_device_ctx
->stats
.tx_bytes
);
270 DPRINT_EXIT(NETVSC_DRV
);
275 * netvsc_linkstatus_callback - Link up/down notification
277 static void netvsc_linkstatus_callback(struct hv_device
*device_obj
,
280 struct device_context
*device_ctx
= to_device_context(device_obj
);
281 struct net_device
*net
= dev_get_drvdata(&device_ctx
->device
);
283 DPRINT_ENTER(NETVSC_DRV
);
286 DPRINT_ERR(NETVSC_DRV
, "got link status but net device "
287 "not initialized yet");
292 netif_carrier_on(net
);
293 netif_wake_queue(net
);
295 netif_carrier_off(net
);
296 netif_stop_queue(net
);
298 DPRINT_EXIT(NETVSC_DRV
);
302 * netvsc_recv_callback - Callback when we receive a packet from the "wire" on the specified device.
304 static int netvsc_recv_callback(struct hv_device
*device_obj
,
305 struct hv_netvsc_packet
*packet
)
307 struct device_context
*device_ctx
= to_device_context(device_obj
);
308 struct net_device
*net
= dev_get_drvdata(&device_ctx
->device
);
309 struct net_device_context
*net_device_ctx
;
316 DPRINT_ENTER(NETVSC_DRV
);
319 DPRINT_ERR(NETVSC_DRV
, "got receive callback but net device "
320 "not initialized yet");
324 net_device_ctx
= netdev_priv(net
);
326 /* Allocate a skb - TODO preallocate this */
327 /* Pad 2-bytes to align IP header to 16 bytes */
328 skb
= dev_alloc_skb(packet
->TotalDataBufferLength
+ 2);
333 /* for kmap_atomic */
334 local_irq_save(flags
);
337 * Copy to skb. This copy is needed here since the memory pointed by
338 * hv_netvsc_packet cannot be deallocated
340 for (i
= 0; i
< packet
->PageBufferCount
; i
++) {
341 data
= kmap_atomic(pfn_to_page(packet
->PageBuffers
[i
].Pfn
),
343 data
= (void *)(unsigned long)data
+
344 packet
->PageBuffers
[i
].Offset
;
346 memcpy(skb_put(skb
, packet
->PageBuffers
[i
].Length
), data
,
347 packet
->PageBuffers
[i
].Length
);
349 kunmap_atomic((void *)((unsigned long)data
-
350 packet
->PageBuffers
[i
].Offset
), KM_IRQ1
);
353 local_irq_restore(flags
);
355 skb
->protocol
= eth_type_trans(skb
, net
);
357 skb
->ip_summed
= CHECKSUM_NONE
;
360 * Pass the skb back up. Network stack will deallocate the skb when it
367 net_device_ctx
->stats
.rx_dropped
++;
370 net_device_ctx
->stats
.rx_packets
++;
371 net_device_ctx
->stats
.rx_bytes
+= skb
->len
;
375 DPRINT_DBG(NETVSC_DRV
, "# of recvs %lu total size %lu",
376 net_device_ctx
->stats
.rx_packets
,
377 net_device_ctx
->stats
.rx_bytes
);
379 DPRINT_EXIT(NETVSC_DRV
);
384 static const struct net_device_ops device_ops
= {
385 .ndo_open
= netvsc_open
,
386 .ndo_stop
= netvsc_close
,
387 .ndo_start_xmit
= netvsc_start_xmit
,
388 .ndo_get_stats
= netvsc_get_stats
,
389 .ndo_set_multicast_list
= netvsc_set_multicast_list
,
392 static int netvsc_probe(struct device
*device
)
394 struct driver_context
*driver_ctx
=
395 driver_to_driver_context(device
->driver
);
396 struct netvsc_driver_context
*net_drv_ctx
=
397 (struct netvsc_driver_context
*)driver_ctx
;
398 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
399 struct device_context
*device_ctx
= device_to_device_context(device
);
400 struct hv_device
*device_obj
= &device_ctx
->device_obj
;
401 struct net_device
*net
= NULL
;
402 struct net_device_context
*net_device_ctx
;
403 struct netvsc_device_info device_info
;
406 DPRINT_ENTER(NETVSC_DRV
);
408 if (!net_drv_obj
->Base
.OnDeviceAdd
)
411 net
= alloc_netdev(sizeof(struct net_device_context
), "seth%d",
416 /* Set initial state */
417 netif_carrier_off(net
);
418 netif_stop_queue(net
);
420 net_device_ctx
= netdev_priv(net
);
421 net_device_ctx
->device_ctx
= device_ctx
;
422 dev_set_drvdata(device
, net
);
424 /* Notify the netvsc driver of the new device */
425 ret
= net_drv_obj
->Base
.OnDeviceAdd(device_obj
, &device_info
);
428 dev_set_drvdata(device
, NULL
);
430 DPRINT_ERR(NETVSC_DRV
, "unable to add netvsc device (ret %d)",
436 * If carrier is still off ie we did not get a link status callback,
437 * update it if necessary
440 * FIXME: We should use a atomic or test/set instead to avoid getting
441 * out of sync with the device's link status
443 if (!netif_carrier_ok(net
))
444 if (!device_info
.LinkState
)
445 netif_carrier_on(net
);
447 memcpy(net
->dev_addr
, device_info
.MacAddr
, ETH_ALEN
);
449 net
->netdev_ops
= &device_ops
;
451 SET_NETDEV_DEV(net
, device
);
453 ret
= register_netdev(net
);
455 /* Remove the device and release the resource */
456 net_drv_obj
->Base
.OnDeviceRemove(device_obj
);
460 DPRINT_EXIT(NETVSC_DRV
);
464 static int netvsc_remove(struct device
*device
)
466 struct driver_context
*driver_ctx
=
467 driver_to_driver_context(device
->driver
);
468 struct netvsc_driver_context
*net_drv_ctx
=
469 (struct netvsc_driver_context
*)driver_ctx
;
470 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
471 struct device_context
*device_ctx
= device_to_device_context(device
);
472 struct net_device
*net
= dev_get_drvdata(&device_ctx
->device
);
473 struct hv_device
*device_obj
= &device_ctx
->device_obj
;
476 DPRINT_ENTER(NETVSC_DRV
);
479 DPRINT_INFO(NETVSC
, "no net device to remove");
480 DPRINT_EXIT(NETVSC_DRV
);
484 if (!net_drv_obj
->Base
.OnDeviceRemove
) {
485 DPRINT_EXIT(NETVSC_DRV
);
489 /* Stop outbound asap */
490 netif_stop_queue(net
);
491 /* netif_carrier_off(net); */
493 unregister_netdev(net
);
496 * Call to the vsc driver to let it know that the device is being
499 ret
= net_drv_obj
->Base
.OnDeviceRemove(device_obj
);
502 DPRINT_ERR(NETVSC
, "unable to remove vsc device (ret %d)", ret
);
506 DPRINT_EXIT(NETVSC_DRV
);
510 static int netvsc_drv_exit_cb(struct device
*dev
, void *data
)
512 struct device
**curr
= (struct device
**)data
;
519 static void netvsc_drv_exit(void)
521 struct netvsc_driver
*netvsc_drv_obj
= &g_netvsc_drv
.drv_obj
;
522 struct driver_context
*drv_ctx
= &g_netvsc_drv
.drv_ctx
;
523 struct device
*current_dev
;
526 DPRINT_ENTER(NETVSC_DRV
);
532 ret
= driver_for_each_device(&drv_ctx
->driver
, NULL
,
533 ¤t_dev
, netvsc_drv_exit_cb
);
535 DPRINT_WARN(NETVSC_DRV
,
536 "driver_for_each_device returned %d", ret
);
538 if (current_dev
== NULL
)
541 /* Initiate removal from the top-down */
542 DPRINT_INFO(NETVSC_DRV
, "unregistering device (%p)...",
545 device_unregister(current_dev
);
548 if (netvsc_drv_obj
->Base
.OnCleanup
)
549 netvsc_drv_obj
->Base
.OnCleanup(&netvsc_drv_obj
->Base
);
551 vmbus_child_driver_unregister(drv_ctx
);
553 DPRINT_EXIT(NETVSC_DRV
);
558 static int netvsc_drv_init(int (*drv_init
)(struct hv_driver
*drv
))
560 struct netvsc_driver
*net_drv_obj
= &g_netvsc_drv
.drv_obj
;
561 struct driver_context
*drv_ctx
= &g_netvsc_drv
.drv_ctx
;
564 DPRINT_ENTER(NETVSC_DRV
);
566 vmbus_get_interface(&net_drv_obj
->Base
.VmbusChannelInterface
);
568 net_drv_obj
->RingBufferSize
= netvsc_ringbuffer_size
;
569 net_drv_obj
->OnReceiveCallback
= netvsc_recv_callback
;
570 net_drv_obj
->OnLinkStatusChanged
= netvsc_linkstatus_callback
;
572 /* Callback to client driver to complete the initialization */
573 drv_init(&net_drv_obj
->Base
);
575 drv_ctx
->driver
.name
= net_drv_obj
->Base
.name
;
576 memcpy(&drv_ctx
->class_id
, &net_drv_obj
->Base
.deviceType
,
577 sizeof(struct hv_guid
));
579 drv_ctx
->probe
= netvsc_probe
;
580 drv_ctx
->remove
= netvsc_remove
;
582 /* The driver belongs to vmbus */
583 ret
= vmbus_child_driver_register(drv_ctx
);
585 DPRINT_EXIT(NETVSC_DRV
);
590 static int __init
netvsc_init(void)
594 DPRINT_ENTER(NETVSC_DRV
);
595 DPRINT_INFO(NETVSC_DRV
, "Netvsc initializing....");
597 ret
= netvsc_drv_init(NetVscInitialize
);
599 DPRINT_EXIT(NETVSC_DRV
);
604 static void __exit
netvsc_exit(void)
606 DPRINT_ENTER(NETVSC_DRV
);
608 DPRINT_EXIT(NETVSC_DRV
);
611 module_param(netvsc_ringbuffer_size
, int, S_IRUGO
);
613 module_init(netvsc_init
);
614 module_exit(netvsc_exit
);