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/kernel.h>
22 #include <linux/sched.h>
23 #include <linux/wait.h>
24 #include <linux/highmem.h>
25 #include <linux/slab.h>
27 #include <linux/if_ether.h>
28 #include <linux/netdevice.h>
30 #include "hyperv_net.h"
33 enum rndis_device_state {
34 RNDIS_DEV_UNINITIALIZED = 0,
35 RNDIS_DEV_INITIALIZING,
36 RNDIS_DEV_INITIALIZED,
37 RNDIS_DEV_DATAINITIALIZED,
41 struct netvsc_device *net_dev;
43 enum rndis_device_state state;
47 spinlock_t request_lock;
48 struct list_head req_list;
50 unsigned char hw_mac_adr[ETH_ALEN];
53 struct rndis_request {
54 struct list_head list_ent;
55 struct completion wait_event;
58 * FIXME: We assumed a fixed size response here. If we do ever need to
59 * handle a bigger response, we can either define a max response
60 * message or add a response buffer variable above this field
62 struct rndis_message response_msg;
64 /* Simplify allocation by having a netvsc packet inline */
65 struct hv_netvsc_packet pkt;
66 struct hv_page_buffer buf;
67 /* FIXME: We assumed a fixed size request here. */
68 struct rndis_message request_msg;
71 static void rndis_filter_send_completion(void *ctx);
73 static void rndis_filter_send_request_completion(void *ctx);
77 static struct rndis_device *get_rndis_device(void)
79 struct rndis_device *device;
81 device = kzalloc(sizeof(struct rndis_device), GFP_KERNEL);
85 spin_lock_init(&device->request_lock);
87 INIT_LIST_HEAD(&device->req_list);
89 device->state = RNDIS_DEV_UNINITIALIZED;
94 static struct rndis_request *get_rndis_request(struct rndis_device *dev,
98 struct rndis_request *request;
99 struct rndis_message *rndis_msg;
100 struct rndis_set_request *set;
103 request = kzalloc(sizeof(struct rndis_request), GFP_KERNEL);
107 init_completion(&request->wait_event);
109 rndis_msg = &request->request_msg;
110 rndis_msg->ndis_msg_type = msg_type;
111 rndis_msg->msg_len = msg_len;
114 * Set the request id. This field is always after the rndis header for
115 * request/response packet types so we just used the SetRequest as a
118 set = &rndis_msg->msg.set_req;
119 set->req_id = atomic_inc_return(&dev->new_req_id);
121 /* Add to the request list */
122 spin_lock_irqsave(&dev->request_lock, flags);
123 list_add_tail(&request->list_ent, &dev->req_list);
124 spin_unlock_irqrestore(&dev->request_lock, flags);
129 static void put_rndis_request(struct rndis_device *dev,
130 struct rndis_request *req)
134 spin_lock_irqsave(&dev->request_lock, flags);
135 list_del(&req->list_ent);
136 spin_unlock_irqrestore(&dev->request_lock, flags);
141 static void dump_rndis_message(struct hv_device *hv_dev,
142 struct rndis_message *rndis_msg)
144 struct net_device *netdev;
145 struct netvsc_device *net_device;
147 net_device = hv_get_drvdata(hv_dev);
148 netdev = net_device->ndev;
150 switch (rndis_msg->ndis_msg_type) {
151 case REMOTE_NDIS_PACKET_MSG:
152 netdev_dbg(netdev, "REMOTE_NDIS_PACKET_MSG (len %u, "
153 "data offset %u data len %u, # oob %u, "
154 "oob offset %u, oob len %u, pkt offset %u, "
157 rndis_msg->msg.pkt.data_offset,
158 rndis_msg->msg.pkt.data_len,
159 rndis_msg->msg.pkt.num_oob_data_elements,
160 rndis_msg->msg.pkt.oob_data_offset,
161 rndis_msg->msg.pkt.oob_data_len,
162 rndis_msg->msg.pkt.per_pkt_info_offset,
163 rndis_msg->msg.pkt.per_pkt_info_len);
166 case REMOTE_NDIS_INITIALIZE_CMPLT:
167 netdev_dbg(netdev, "REMOTE_NDIS_INITIALIZE_CMPLT "
168 "(len %u, id 0x%x, status 0x%x, major %d, minor %d, "
169 "device flags %d, max xfer size 0x%x, max pkts %u, "
172 rndis_msg->msg.init_complete.req_id,
173 rndis_msg->msg.init_complete.status,
174 rndis_msg->msg.init_complete.major_ver,
175 rndis_msg->msg.init_complete.minor_ver,
176 rndis_msg->msg.init_complete.dev_flags,
177 rndis_msg->msg.init_complete.max_xfer_size,
178 rndis_msg->msg.init_complete.
180 rndis_msg->msg.init_complete.
181 pkt_alignment_factor);
184 case REMOTE_NDIS_QUERY_CMPLT:
185 netdev_dbg(netdev, "REMOTE_NDIS_QUERY_CMPLT "
186 "(len %u, id 0x%x, status 0x%x, buf len %u, "
189 rndis_msg->msg.query_complete.req_id,
190 rndis_msg->msg.query_complete.status,
191 rndis_msg->msg.query_complete.
193 rndis_msg->msg.query_complete.
197 case REMOTE_NDIS_SET_CMPLT:
199 "REMOTE_NDIS_SET_CMPLT (len %u, id 0x%x, status 0x%x)\n",
201 rndis_msg->msg.set_complete.req_id,
202 rndis_msg->msg.set_complete.status);
205 case REMOTE_NDIS_INDICATE_STATUS_MSG:
206 netdev_dbg(netdev, "REMOTE_NDIS_INDICATE_STATUS_MSG "
207 "(len %u, status 0x%x, buf len %u, buf offset %u)\n",
209 rndis_msg->msg.indicate_status.status,
210 rndis_msg->msg.indicate_status.status_buflen,
211 rndis_msg->msg.indicate_status.status_buf_offset);
215 netdev_dbg(netdev, "0x%x (len %u)\n",
216 rndis_msg->ndis_msg_type,
222 static int rndis_filter_send_request(struct rndis_device *dev,
223 struct rndis_request *req)
226 struct hv_netvsc_packet *packet;
228 /* Setup the packet to send it */
231 packet->is_data_pkt = false;
232 packet->total_data_buflen = req->request_msg.msg_len;
233 packet->page_buf_cnt = 1;
235 packet->page_buf[0].pfn = virt_to_phys(&req->request_msg) >>
237 packet->page_buf[0].len = req->request_msg.msg_len;
238 packet->page_buf[0].offset =
239 (unsigned long)&req->request_msg & (PAGE_SIZE - 1);
241 packet->completion.send.send_completion_ctx = req;/* packet; */
242 packet->completion.send.send_completion =
243 rndis_filter_send_request_completion;
244 packet->completion.send.send_completion_tid = (unsigned long)dev;
246 ret = netvsc_send(dev->net_dev->dev, packet);
250 static void rndis_filter_receive_response(struct rndis_device *dev,
251 struct rndis_message *resp)
253 struct rndis_request *request = NULL;
256 struct net_device *ndev;
258 ndev = dev->net_dev->ndev;
260 spin_lock_irqsave(&dev->request_lock, flags);
261 list_for_each_entry(request, &dev->req_list, list_ent) {
263 * All request/response message contains RequestId as the 1st
266 if (request->request_msg.msg.init_req.req_id
267 == resp->msg.init_complete.req_id) {
272 spin_unlock_irqrestore(&dev->request_lock, flags);
275 if (resp->msg_len <= sizeof(struct rndis_message)) {
276 memcpy(&request->response_msg, resp,
280 "rndis response buffer overflow "
281 "detected (size %u max %zu)\n",
283 sizeof(struct rndis_filter_packet));
285 if (resp->ndis_msg_type ==
286 REMOTE_NDIS_RESET_CMPLT) {
287 /* does not have a request id field */
288 request->response_msg.msg.reset_complete.
289 status = STATUS_BUFFER_OVERFLOW;
291 request->response_msg.msg.
292 init_complete.status =
293 STATUS_BUFFER_OVERFLOW;
297 complete(&request->wait_event);
300 "no rndis request found for this response "
301 "(id 0x%x res type 0x%x)\n",
302 resp->msg.init_complete.req_id,
303 resp->ndis_msg_type);
307 static void rndis_filter_receive_indicate_status(struct rndis_device *dev,
308 struct rndis_message *resp)
310 struct rndis_indicate_status *indicate =
311 &resp->msg.indicate_status;
313 if (indicate->status == RNDIS_STATUS_MEDIA_CONNECT) {
314 netvsc_linkstatus_callback(
315 dev->net_dev->dev, 1);
316 } else if (indicate->status == RNDIS_STATUS_MEDIA_DISCONNECT) {
317 netvsc_linkstatus_callback(
318 dev->net_dev->dev, 0);
326 static void rndis_filter_receive_data(struct rndis_device *dev,
327 struct rndis_message *msg,
328 struct hv_netvsc_packet *pkt)
330 struct rndis_packet *rndis_pkt;
334 rndis_pkt = &msg->msg.pkt;
337 * FIXME: Handle multiple rndis pkt msgs that maybe enclosed in this
338 * netvsc packet (ie TotalDataBufferLength != MessageLength)
341 /* Remove the rndis header and pass it back up the stack */
342 data_offset = RNDIS_HEADER_SIZE + rndis_pkt->data_offset;
344 pkt->total_data_buflen -= data_offset;
345 pkt->page_buf[0].offset += data_offset;
346 pkt->page_buf[0].len -= data_offset;
348 /* Drop the 0th page, if rndis data go beyond page boundary */
349 if (pkt->page_buf[0].offset >= PAGE_SIZE) {
350 pkt->page_buf[1].offset = pkt->page_buf[0].offset - PAGE_SIZE;
351 pkt->page_buf[1].len -= pkt->page_buf[1].offset;
353 for (i = 0; i < pkt->page_buf_cnt; i++)
354 pkt->page_buf[i] = pkt->page_buf[i+1];
357 pkt->is_data_pkt = true;
359 netvsc_recv_callback(dev->net_dev->dev, pkt);
362 int rndis_filter_receive(struct hv_device *dev,
363 struct hv_netvsc_packet *pkt)
365 struct netvsc_device *net_dev = hv_get_drvdata(dev);
366 struct rndis_device *rndis_dev;
367 struct rndis_message rndis_msg;
368 struct rndis_message *rndis_hdr;
369 struct net_device *ndev;
371 ndev = net_dev->ndev;
376 /* Make sure the rndis device state is initialized */
377 if (!net_dev->extension) {
378 netdev_err(ndev, "got rndis message but no rndis device - "
379 "dropping this message!\n");
383 rndis_dev = (struct rndis_device *)net_dev->extension;
384 if (rndis_dev->state == RNDIS_DEV_UNINITIALIZED) {
385 netdev_err(ndev, "got rndis message but rndis device "
386 "uninitialized...dropping this message!\n");
390 rndis_hdr = (struct rndis_message *)kmap_atomic(
391 pfn_to_page(pkt->page_buf[0].pfn), KM_IRQ0);
393 rndis_hdr = (void *)((unsigned long)rndis_hdr +
394 pkt->page_buf[0].offset);
396 /* Make sure we got a valid rndis message */
397 if ((rndis_hdr->ndis_msg_type != REMOTE_NDIS_PACKET_MSG) &&
398 (rndis_hdr->msg_len > sizeof(struct rndis_message))) {
399 netdev_err(ndev, "incoming rndis message buffer overflow "
400 "detected (got %u, max %zu)..marking it an error!\n",
402 sizeof(struct rndis_message));
405 memcpy(&rndis_msg, rndis_hdr,
406 (rndis_hdr->msg_len > sizeof(struct rndis_message)) ?
407 sizeof(struct rndis_message) :
410 kunmap_atomic(rndis_hdr - pkt->page_buf[0].offset, KM_IRQ0);
412 dump_rndis_message(dev, &rndis_msg);
414 switch (rndis_msg.ndis_msg_type) {
415 case REMOTE_NDIS_PACKET_MSG:
417 rndis_filter_receive_data(rndis_dev, &rndis_msg, pkt);
420 case REMOTE_NDIS_INITIALIZE_CMPLT:
421 case REMOTE_NDIS_QUERY_CMPLT:
422 case REMOTE_NDIS_SET_CMPLT:
423 /* completion msgs */
424 rndis_filter_receive_response(rndis_dev, &rndis_msg);
427 case REMOTE_NDIS_INDICATE_STATUS_MSG:
428 /* notification msgs */
429 rndis_filter_receive_indicate_status(rndis_dev, &rndis_msg);
433 "unhandled rndis message (type %u len %u)\n",
434 rndis_msg.ndis_msg_type,
442 static int rndis_filter_query_device(struct rndis_device *dev, u32 oid,
443 void *result, u32 *result_size)
445 struct rndis_request *request;
446 u32 inresult_size = *result_size;
447 struct rndis_query_request *query;
448 struct rndis_query_complete *query_complete;
456 request = get_rndis_request(dev, REMOTE_NDIS_QUERY_MSG,
457 RNDIS_MESSAGE_SIZE(struct rndis_query_request));
463 /* Setup the rndis query */
464 query = &request->request_msg.msg.query_req;
466 query->info_buf_offset = sizeof(struct rndis_query_request);
467 query->info_buflen = 0;
468 query->dev_vc_handle = 0;
470 ret = rndis_filter_send_request(dev, request);
474 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
480 /* Copy the response back */
481 query_complete = &request->response_msg.msg.query_complete;
483 if (query_complete->info_buflen > inresult_size) {
489 (void *)((unsigned long)query_complete +
490 query_complete->info_buf_offset),
491 query_complete->info_buflen);
493 *result_size = query_complete->info_buflen;
497 put_rndis_request(dev, request);
502 static int rndis_filter_query_device_mac(struct rndis_device *dev)
506 return rndis_filter_query_device(dev,
507 RNDIS_OID_802_3_PERMANENT_ADDRESS,
508 dev->hw_mac_adr, &size);
511 static int rndis_filter_query_device_link_status(struct rndis_device *dev)
513 u32 size = sizeof(u32);
515 return rndis_filter_query_device(dev,
516 RNDIS_OID_GEN_MEDIA_CONNECT_STATUS,
517 &dev->link_stat, &size);
520 static int rndis_filter_set_packet_filter(struct rndis_device *dev,
523 struct rndis_request *request;
524 struct rndis_set_request *set;
525 struct rndis_set_complete *set_complete;
528 struct net_device *ndev;
530 ndev = dev->net_dev->ndev;
532 request = get_rndis_request(dev, REMOTE_NDIS_SET_MSG,
533 RNDIS_MESSAGE_SIZE(struct rndis_set_request) +
540 /* Setup the rndis set */
541 set = &request->request_msg.msg.set_req;
542 set->oid = RNDIS_OID_GEN_CURRENT_PACKET_FILTER;
543 set->info_buflen = sizeof(u32);
544 set->info_buf_offset = sizeof(struct rndis_set_request);
546 memcpy((void *)(unsigned long)set + sizeof(struct rndis_set_request),
547 &new_filter, sizeof(u32));
549 ret = rndis_filter_send_request(dev, request);
553 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
557 "timeout before we got a set response...\n");
559 * We can't deallocate the request since we may still receive a
560 * send completion for it.
564 set_complete = &request->response_msg.msg.set_complete;
565 status = set_complete->status;
570 put_rndis_request(dev, request);
576 static int rndis_filter_init_device(struct rndis_device *dev)
578 struct rndis_request *request;
579 struct rndis_initialize_request *init;
580 struct rndis_initialize_complete *init_complete;
584 request = get_rndis_request(dev, REMOTE_NDIS_INITIALIZE_MSG,
585 RNDIS_MESSAGE_SIZE(struct rndis_initialize_request));
591 /* Setup the rndis set */
592 init = &request->request_msg.msg.init_req;
593 init->major_ver = RNDIS_MAJOR_VERSION;
594 init->minor_ver = RNDIS_MINOR_VERSION;
595 /* FIXME: Use 1536 - rounded ethernet frame size */
596 init->max_xfer_size = 2048;
598 dev->state = RNDIS_DEV_INITIALIZING;
600 ret = rndis_filter_send_request(dev, request);
602 dev->state = RNDIS_DEV_UNINITIALIZED;
607 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
614 init_complete = &request->response_msg.msg.init_complete;
615 status = init_complete->status;
616 if (status == RNDIS_STATUS_SUCCESS) {
617 dev->state = RNDIS_DEV_INITIALIZED;
620 dev->state = RNDIS_DEV_UNINITIALIZED;
626 put_rndis_request(dev, request);
631 static void rndis_filter_halt_device(struct rndis_device *dev)
633 struct rndis_request *request;
634 struct rndis_halt_request *halt;
636 /* Attempt to do a rndis device halt */
637 request = get_rndis_request(dev, REMOTE_NDIS_HALT_MSG,
638 RNDIS_MESSAGE_SIZE(struct rndis_halt_request));
642 /* Setup the rndis set */
643 halt = &request->request_msg.msg.halt_req;
644 halt->req_id = atomic_inc_return(&dev->new_req_id);
646 /* Ignore return since this msg is optional. */
647 rndis_filter_send_request(dev, request);
649 dev->state = RNDIS_DEV_UNINITIALIZED;
653 put_rndis_request(dev, request);
657 static int rndis_filter_open_device(struct rndis_device *dev)
661 if (dev->state != RNDIS_DEV_INITIALIZED)
664 ret = rndis_filter_set_packet_filter(dev,
665 NDIS_PACKET_TYPE_BROADCAST |
666 NDIS_PACKET_TYPE_ALL_MULTICAST |
667 NDIS_PACKET_TYPE_DIRECTED);
669 dev->state = RNDIS_DEV_DATAINITIALIZED;
674 static int rndis_filter_close_device(struct rndis_device *dev)
678 if (dev->state != RNDIS_DEV_DATAINITIALIZED)
681 ret = rndis_filter_set_packet_filter(dev, 0);
683 dev->state = RNDIS_DEV_INITIALIZED;
688 int rndis_filter_device_add(struct hv_device *dev,
689 void *additional_info)
692 struct netvsc_device *net_device;
693 struct rndis_device *rndisDevice;
694 struct netvsc_device_info *deviceInfo = additional_info;
696 rndisDevice = get_rndis_device();
701 * Let the inner driver handle this first to create the netvsc channel
702 * NOTE! Once the channel is created, we may get a receive callback
703 * (RndisFilterOnReceive()) before this call is completed
705 ret = netvsc_device_add(dev, additional_info);
712 /* Initialize the rndis device */
713 net_device = hv_get_drvdata(dev);
715 net_device->extension = rndisDevice;
716 rndisDevice->net_dev = net_device;
718 /* Send the rndis initialization message */
719 ret = rndis_filter_init_device(rndisDevice);
722 * TODO: If rndis init failed, we will need to shut down the
727 /* Get the mac address */
728 ret = rndis_filter_query_device_mac(rndisDevice);
731 * TODO: shutdown rndis device and the channel
735 memcpy(deviceInfo->mac_adr, rndisDevice->hw_mac_adr, ETH_ALEN);
737 rndis_filter_query_device_link_status(rndisDevice);
739 deviceInfo->link_state = rndisDevice->link_stat;
741 dev_info(&dev->device, "Device MAC %pM link state %s",
742 rndisDevice->hw_mac_adr,
743 ((deviceInfo->link_state) ? ("down\n") : ("up\n")));
748 void rndis_filter_device_remove(struct hv_device *dev)
750 struct netvsc_device *net_dev = hv_get_drvdata(dev);
751 struct rndis_device *rndis_dev = net_dev->extension;
753 /* Halt and release the rndis device */
754 rndis_filter_halt_device(rndis_dev);
757 net_dev->extension = NULL;
759 netvsc_device_remove(dev);
763 int rndis_filter_open(struct hv_device *dev)
765 struct netvsc_device *net_device = hv_get_drvdata(dev);
770 return rndis_filter_open_device(net_device->extension);
773 int rndis_filter_close(struct hv_device *dev)
775 struct netvsc_device *netDevice = hv_get_drvdata(dev);
780 return rndis_filter_close_device(netDevice->extension);
783 int rndis_filter_send(struct hv_device *dev,
784 struct hv_netvsc_packet *pkt)
787 struct rndis_filter_packet *filterPacket;
788 struct rndis_message *rndisMessage;
789 struct rndis_packet *rndisPacket;
790 u32 rndisMessageSize;
792 /* Add the rndis header */
793 filterPacket = (struct rndis_filter_packet *)pkt->extension;
795 memset(filterPacket, 0, sizeof(struct rndis_filter_packet));
797 rndisMessage = &filterPacket->msg;
798 rndisMessageSize = RNDIS_MESSAGE_SIZE(struct rndis_packet);
800 rndisMessage->ndis_msg_type = REMOTE_NDIS_PACKET_MSG;
801 rndisMessage->msg_len = pkt->total_data_buflen +
804 rndisPacket = &rndisMessage->msg.pkt;
805 rndisPacket->data_offset = sizeof(struct rndis_packet);
806 rndisPacket->data_len = pkt->total_data_buflen;
808 pkt->is_data_pkt = true;
809 pkt->page_buf[0].pfn = virt_to_phys(rndisMessage) >> PAGE_SHIFT;
810 pkt->page_buf[0].offset =
811 (unsigned long)rndisMessage & (PAGE_SIZE-1);
812 pkt->page_buf[0].len = rndisMessageSize;
814 /* Save the packet send completion and context */
815 filterPacket->completion = pkt->completion.send.send_completion;
816 filterPacket->completion_ctx =
817 pkt->completion.send.send_completion_ctx;
820 pkt->completion.send.send_completion = rndis_filter_send_completion;
821 pkt->completion.send.send_completion_ctx = filterPacket;
823 ret = netvsc_send(dev, pkt);
826 * Reset the completion to originals to allow retries from
829 pkt->completion.send.send_completion =
830 filterPacket->completion;
831 pkt->completion.send.send_completion_ctx =
832 filterPacket->completion_ctx;
838 static void rndis_filter_send_completion(void *ctx)
840 struct rndis_filter_packet *filterPacket = ctx;
842 /* Pass it back to the original handler */
843 filterPacket->completion(filterPacket->completion_ctx);
847 static void rndis_filter_send_request_completion(void *ctx)