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 driver_context
*driver_ctx
=
76 driver_to_driver_context(net_device_ctx
->device_ctx
->device
.driver
);
77 struct netvsc_driver_context
*net_drv_ctx
=
78 (struct netvsc_driver_context
*)driver_ctx
;
79 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
80 struct hv_device
*device_obj
= &net_device_ctx
->device_ctx
->device_obj
;
83 DPRINT_ENTER(NETVSC_DRV
);
85 if (netif_carrier_ok(net
)) {
86 memset(&net_device_ctx
->stats
, 0,
87 sizeof(struct net_device_stats
));
89 /* Open up the device */
90 ret
= net_drv_obj
->OnOpen(device_obj
);
92 DPRINT_ERR(NETVSC_DRV
,
93 "unable to open device (ret %d).", ret
);
97 netif_start_queue(net
);
99 DPRINT_ERR(NETVSC_DRV
, "unable to open device...link is down.");
102 DPRINT_EXIT(NETVSC_DRV
);
106 static int netvsc_close(struct net_device
*net
)
108 struct net_device_context
*net_device_ctx
= netdev_priv(net
);
109 struct driver_context
*driver_ctx
=
110 driver_to_driver_context(net_device_ctx
->device_ctx
->device
.driver
);
111 struct netvsc_driver_context
*net_drv_ctx
=
112 (struct netvsc_driver_context
*)driver_ctx
;
113 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
114 struct hv_device
*device_obj
= &net_device_ctx
->device_ctx
->device_obj
;
117 DPRINT_ENTER(NETVSC_DRV
);
119 netif_stop_queue(net
);
121 ret
= net_drv_obj
->OnClose(device_obj
);
123 DPRINT_ERR(NETVSC_DRV
, "unable to close device (ret %d).", ret
);
125 DPRINT_EXIT(NETVSC_DRV
);
130 static void netvsc_xmit_completion(void *context
)
132 struct hv_netvsc_packet
*packet
= (struct hv_netvsc_packet
*)context
;
133 struct sk_buff
*skb
= (struct sk_buff
*)
134 (unsigned long)packet
->Completion
.Send
.SendCompletionTid
;
135 struct net_device
*net
;
137 DPRINT_ENTER(NETVSC_DRV
);
143 dev_kfree_skb_any(skb
);
145 if (netif_queue_stopped(net
)) {
146 DPRINT_INFO(NETVSC_DRV
, "net device (%p) waking up...",
149 netif_wake_queue(net
);
153 DPRINT_EXIT(NETVSC_DRV
);
156 static int netvsc_start_xmit(struct sk_buff
*skb
, struct net_device
*net
)
158 struct net_device_context
*net_device_ctx
= netdev_priv(net
);
159 struct driver_context
*driver_ctx
=
160 driver_to_driver_context(net_device_ctx
->device_ctx
->device
.driver
);
161 struct netvsc_driver_context
*net_drv_ctx
=
162 (struct netvsc_driver_context
*)driver_ctx
;
163 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
164 struct hv_netvsc_packet
*packet
;
170 DPRINT_ENTER(NETVSC_DRV
);
172 /* Support only 1 chain of frags */
173 ASSERT(skb_shinfo(skb
)->frag_list
== NULL
);
174 ASSERT(skb
->dev
== net
);
176 DPRINT_DBG(NETVSC_DRV
, "xmit packet - len %d data_len %d",
177 skb
->len
, skb
->data_len
);
179 /* Add 1 for skb->data and any additional ones requested */
180 num_frags
= skb_shinfo(skb
)->nr_frags
+ 1 +
181 net_drv_obj
->AdditionalRequestPageBufferCount
;
183 /* Allocate a netvsc packet based on # of frags. */
184 packet
= kzalloc(sizeof(struct hv_netvsc_packet
) +
185 (num_frags
* sizeof(struct hv_page_buffer
)) +
186 net_drv_obj
->RequestExtSize
, GFP_ATOMIC
);
188 DPRINT_ERR(NETVSC_DRV
, "unable to allocate hv_netvsc_packet");
192 packet
->Extension
= (void *)(unsigned long)packet
+
193 sizeof(struct hv_netvsc_packet
) +
194 (num_frags
* sizeof(struct hv_page_buffer
));
196 /* Setup the rndis header */
197 packet
->PageBufferCount
= num_frags
;
199 /* TODO: Flush all write buffers/ memory fence ??? */
202 /* Initialize it from the skb */
204 packet
->TotalDataBufferLength
= skb
->len
;
207 * Start filling in the page buffers starting at
208 * AdditionalRequestPageBufferCount offset
210 packet
->PageBuffers
[net_drv_obj
->AdditionalRequestPageBufferCount
].Pfn
= virt_to_phys(skb
->data
) >> PAGE_SHIFT
;
211 packet
->PageBuffers
[net_drv_obj
->AdditionalRequestPageBufferCount
].Offset
= (unsigned long)skb
->data
& (PAGE_SIZE
- 1);
212 packet
->PageBuffers
[net_drv_obj
->AdditionalRequestPageBufferCount
].Length
= skb
->len
- skb
->data_len
;
214 ASSERT((skb
->len
- skb
->data_len
) <= PAGE_SIZE
);
216 for (i
= net_drv_obj
->AdditionalRequestPageBufferCount
+ 1;
217 i
< num_frags
; i
++) {
218 packet
->PageBuffers
[i
].Pfn
=
219 page_to_pfn(skb_shinfo(skb
)->frags
[i
-(net_drv_obj
->AdditionalRequestPageBufferCount
+1)].page
);
220 packet
->PageBuffers
[i
].Offset
=
221 skb_shinfo(skb
)->frags
[i
-(net_drv_obj
->AdditionalRequestPageBufferCount
+1)].page_offset
;
222 packet
->PageBuffers
[i
].Length
=
223 skb_shinfo(skb
)->frags
[i
-(net_drv_obj
->AdditionalRequestPageBufferCount
+1)].size
;
226 /* Set the completion routine */
227 packet
->Completion
.Send
.OnSendCompletion
= netvsc_xmit_completion
;
228 packet
->Completion
.Send
.SendCompletionContext
= packet
;
229 packet
->Completion
.Send
.SendCompletionTid
= (unsigned long)skb
;
232 ret
= net_drv_obj
->OnSend(&net_device_ctx
->device_ctx
->device_obj
,
237 net_device_ctx
->stats
.tx_bytes
+= skb
->len
;
238 net_device_ctx
->stats
.tx_packets
++;
242 DPRINT_ERR(NETVSC_DRV
, "unable to send..."
243 "retrying %d...", retries
);
248 /* no more room or we are shutting down */
249 DPRINT_ERR(NETVSC_DRV
, "unable to send (%d)..."
250 "marking net device (%p) busy", ret
, net
);
251 DPRINT_INFO(NETVSC_DRV
, "net device (%p) stopping", net
);
253 ret
= NETDEV_TX_BUSY
;
254 net_device_ctx
->stats
.tx_dropped
++;
256 netif_stop_queue(net
);
259 * Null it since the caller will free it instead of the
262 packet
->Completion
.Send
.SendCompletionTid
= 0;
265 * Release the resources since we will not get any send
268 netvsc_xmit_completion((void *)packet
);
271 DPRINT_DBG(NETVSC_DRV
, "# of xmits %lu total size %lu",
272 net_device_ctx
->stats
.tx_packets
,
273 net_device_ctx
->stats
.tx_bytes
);
275 DPRINT_EXIT(NETVSC_DRV
);
280 * netvsc_linkstatus_callback - Link up/down notification
282 static void netvsc_linkstatus_callback(struct hv_device
*device_obj
,
285 struct device_context
*device_ctx
= to_device_context(device_obj
);
286 struct net_device
*net
= dev_get_drvdata(&device_ctx
->device
);
288 DPRINT_ENTER(NETVSC_DRV
);
291 DPRINT_ERR(NETVSC_DRV
, "got link status but net device "
292 "not initialized yet");
297 netif_carrier_on(net
);
298 netif_wake_queue(net
);
300 netif_carrier_off(net
);
301 netif_stop_queue(net
);
303 DPRINT_EXIT(NETVSC_DRV
);
307 * netvsc_recv_callback - Callback when we receive a packet from the "wire" on the specified device.
309 static int netvsc_recv_callback(struct hv_device
*device_obj
,
310 struct hv_netvsc_packet
*packet
)
312 struct device_context
*device_ctx
= to_device_context(device_obj
);
313 struct net_device
*net
= dev_get_drvdata(&device_ctx
->device
);
314 struct net_device_context
*net_device_ctx
;
321 DPRINT_ENTER(NETVSC_DRV
);
324 DPRINT_ERR(NETVSC_DRV
, "got receive callback but net device "
325 "not initialized yet");
329 net_device_ctx
= netdev_priv(net
);
331 /* Allocate a skb - TODO preallocate this */
332 /* Pad 2-bytes to align IP header to 16 bytes */
333 skb
= dev_alloc_skb(packet
->TotalDataBufferLength
+ 2);
338 /* for kmap_atomic */
339 local_irq_save(flags
);
342 * Copy to skb. This copy is needed here since the memory pointed by
343 * hv_netvsc_packet cannot be deallocated
345 for (i
= 0; i
< packet
->PageBufferCount
; i
++) {
346 data
= kmap_atomic(pfn_to_page(packet
->PageBuffers
[i
].Pfn
),
348 data
= (void *)(unsigned long)data
+
349 packet
->PageBuffers
[i
].Offset
;
351 memcpy(skb_put(skb
, packet
->PageBuffers
[i
].Length
), data
,
352 packet
->PageBuffers
[i
].Length
);
354 kunmap_atomic((void *)((unsigned long)data
-
355 packet
->PageBuffers
[i
].Offset
), KM_IRQ1
);
358 local_irq_restore(flags
);
360 skb
->protocol
= eth_type_trans(skb
, net
);
362 skb
->ip_summed
= CHECKSUM_NONE
;
365 * Pass the skb back up. Network stack will deallocate the skb when it
372 net_device_ctx
->stats
.rx_dropped
++;
375 net_device_ctx
->stats
.rx_packets
++;
376 net_device_ctx
->stats
.rx_bytes
+= skb
->len
;
380 DPRINT_DBG(NETVSC_DRV
, "# of recvs %lu total size %lu",
381 net_device_ctx
->stats
.rx_packets
,
382 net_device_ctx
->stats
.rx_bytes
);
384 DPRINT_EXIT(NETVSC_DRV
);
389 static const struct net_device_ops device_ops
= {
390 .ndo_open
= netvsc_open
,
391 .ndo_stop
= netvsc_close
,
392 .ndo_start_xmit
= netvsc_start_xmit
,
393 .ndo_get_stats
= netvsc_get_stats
,
394 .ndo_set_multicast_list
= netvsc_set_multicast_list
,
397 static int netvsc_probe(struct device
*device
)
399 struct driver_context
*driver_ctx
=
400 driver_to_driver_context(device
->driver
);
401 struct netvsc_driver_context
*net_drv_ctx
=
402 (struct netvsc_driver_context
*)driver_ctx
;
403 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
404 struct device_context
*device_ctx
= device_to_device_context(device
);
405 struct hv_device
*device_obj
= &device_ctx
->device_obj
;
406 struct net_device
*net
= NULL
;
407 struct net_device_context
*net_device_ctx
;
408 struct netvsc_device_info device_info
;
411 DPRINT_ENTER(NETVSC_DRV
);
413 if (!net_drv_obj
->Base
.OnDeviceAdd
)
416 net
= alloc_netdev(sizeof(struct net_device_context
), "seth%d",
421 /* Set initial state */
422 netif_carrier_off(net
);
423 netif_stop_queue(net
);
425 net_device_ctx
= netdev_priv(net
);
426 net_device_ctx
->device_ctx
= device_ctx
;
427 dev_set_drvdata(device
, net
);
429 /* Notify the netvsc driver of the new device */
430 ret
= net_drv_obj
->Base
.OnDeviceAdd(device_obj
, &device_info
);
433 dev_set_drvdata(device
, NULL
);
435 DPRINT_ERR(NETVSC_DRV
, "unable to add netvsc device (ret %d)",
441 * If carrier is still off ie we did not get a link status callback,
442 * update it if necessary
445 * FIXME: We should use a atomic or test/set instead to avoid getting
446 * out of sync with the device's link status
448 if (!netif_carrier_ok(net
))
449 if (!device_info
.LinkState
)
450 netif_carrier_on(net
);
452 memcpy(net
->dev_addr
, device_info
.MacAddr
, ETH_ALEN
);
454 net
->netdev_ops
= &device_ops
;
456 SET_NETDEV_DEV(net
, device
);
458 ret
= register_netdev(net
);
460 /* Remove the device and release the resource */
461 net_drv_obj
->Base
.OnDeviceRemove(device_obj
);
465 DPRINT_EXIT(NETVSC_DRV
);
469 static int netvsc_remove(struct device
*device
)
471 struct driver_context
*driver_ctx
=
472 driver_to_driver_context(device
->driver
);
473 struct netvsc_driver_context
*net_drv_ctx
=
474 (struct netvsc_driver_context
*)driver_ctx
;
475 struct netvsc_driver
*net_drv_obj
= &net_drv_ctx
->drv_obj
;
476 struct device_context
*device_ctx
= device_to_device_context(device
);
477 struct net_device
*net
= dev_get_drvdata(&device_ctx
->device
);
478 struct hv_device
*device_obj
= &device_ctx
->device_obj
;
481 DPRINT_ENTER(NETVSC_DRV
);
484 DPRINT_INFO(NETVSC
, "no net device to remove");
485 DPRINT_EXIT(NETVSC_DRV
);
489 if (!net_drv_obj
->Base
.OnDeviceRemove
) {
490 DPRINT_EXIT(NETVSC_DRV
);
494 /* Stop outbound asap */
495 netif_stop_queue(net
);
496 /* netif_carrier_off(net); */
498 unregister_netdev(net
);
501 * Call to the vsc driver to let it know that the device is being
504 ret
= net_drv_obj
->Base
.OnDeviceRemove(device_obj
);
507 DPRINT_ERR(NETVSC
, "unable to remove vsc device (ret %d)", ret
);
511 DPRINT_EXIT(NETVSC_DRV
);
515 static int netvsc_drv_exit_cb(struct device
*dev
, void *data
)
517 struct device
**curr
= (struct device
**)data
;
524 static void netvsc_drv_exit(void)
526 struct netvsc_driver
*netvsc_drv_obj
= &g_netvsc_drv
.drv_obj
;
527 struct driver_context
*drv_ctx
= &g_netvsc_drv
.drv_ctx
;
528 struct device
*current_dev
;
531 DPRINT_ENTER(NETVSC_DRV
);
537 ret
= driver_for_each_device(&drv_ctx
->driver
, NULL
,
538 ¤t_dev
, netvsc_drv_exit_cb
);
540 DPRINT_WARN(NETVSC_DRV
,
541 "driver_for_each_device returned %d", ret
);
543 if (current_dev
== NULL
)
546 /* Initiate removal from the top-down */
547 DPRINT_INFO(NETVSC_DRV
, "unregistering device (%p)...",
550 device_unregister(current_dev
);
553 if (netvsc_drv_obj
->Base
.OnCleanup
)
554 netvsc_drv_obj
->Base
.OnCleanup(&netvsc_drv_obj
->Base
);
556 vmbus_child_driver_unregister(drv_ctx
);
558 DPRINT_EXIT(NETVSC_DRV
);
563 static int netvsc_drv_init(int (*drv_init
)(struct hv_driver
*drv
))
565 struct netvsc_driver
*net_drv_obj
= &g_netvsc_drv
.drv_obj
;
566 struct driver_context
*drv_ctx
= &g_netvsc_drv
.drv_ctx
;
569 DPRINT_ENTER(NETVSC_DRV
);
571 vmbus_get_interface(&net_drv_obj
->Base
.VmbusChannelInterface
);
573 net_drv_obj
->RingBufferSize
= netvsc_ringbuffer_size
;
574 net_drv_obj
->OnReceiveCallback
= netvsc_recv_callback
;
575 net_drv_obj
->OnLinkStatusChanged
= netvsc_linkstatus_callback
;
577 /* Callback to client driver to complete the initialization */
578 drv_init(&net_drv_obj
->Base
);
580 drv_ctx
->driver
.name
= net_drv_obj
->Base
.name
;
581 memcpy(&drv_ctx
->class_id
, &net_drv_obj
->Base
.deviceType
,
582 sizeof(struct hv_guid
));
584 drv_ctx
->probe
= netvsc_probe
;
585 drv_ctx
->remove
= netvsc_remove
;
587 /* The driver belongs to vmbus */
588 ret
= vmbus_child_driver_register(drv_ctx
);
590 DPRINT_EXIT(NETVSC_DRV
);
595 static int __init
netvsc_init(void)
599 DPRINT_ENTER(NETVSC_DRV
);
600 DPRINT_INFO(NETVSC_DRV
, "Netvsc initializing....");
602 ret
= netvsc_drv_init(NetVscInitialize
);
604 DPRINT_EXIT(NETVSC_DRV
);
609 static void __exit
netvsc_exit(void)
611 DPRINT_ENTER(NETVSC_DRV
);
613 DPRINT_EXIT(NETVSC_DRV
);
616 module_param(netvsc_ringbuffer_size
, int, S_IRUGO
);
618 module_init(netvsc_init
);
619 module_exit(netvsc_exit
);