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>
31 #include "hyperv_net.h"
34 enum rndis_device_state {
35 RNDIS_DEV_UNINITIALIZED = 0,
36 RNDIS_DEV_INITIALIZING,
37 RNDIS_DEV_INITIALIZED,
38 RNDIS_DEV_DATAINITIALIZED,
42 struct netvsc_device *net_dev;
44 enum rndis_device_state state;
48 spinlock_t request_lock;
49 struct list_head req_list;
51 unsigned char hw_mac_adr[ETH_ALEN];
54 struct rndis_request {
55 struct list_head list_ent;
56 struct completion wait_event;
59 * FIXME: We assumed a fixed size response here. If we do ever need to
60 * handle a bigger response, we can either define a max response
61 * message or add a response buffer variable above this field
63 struct rndis_message response_msg;
65 /* Simplify allocation by having a netvsc packet inline */
66 struct hv_netvsc_packet pkt;
67 struct hv_page_buffer buf;
68 /* FIXME: We assumed a fixed size request here. */
69 struct rndis_message request_msg;
72 static void rndis_filter_send_completion(void *ctx);
74 static void rndis_filter_send_request_completion(void *ctx);
78 static struct rndis_device *get_rndis_device(void)
80 struct rndis_device *device;
82 device = kzalloc(sizeof(struct rndis_device), GFP_KERNEL);
86 spin_lock_init(&device->request_lock);
88 INIT_LIST_HEAD(&device->req_list);
90 device->state = RNDIS_DEV_UNINITIALIZED;
95 static struct rndis_request *get_rndis_request(struct rndis_device *dev,
99 struct rndis_request *request;
100 struct rndis_message *rndis_msg;
101 struct rndis_set_request *set;
104 request = kzalloc(sizeof(struct rndis_request), GFP_KERNEL);
108 init_completion(&request->wait_event);
110 rndis_msg = &request->request_msg;
111 rndis_msg->ndis_msg_type = msg_type;
112 rndis_msg->msg_len = msg_len;
115 * Set the request id. This field is always after the rndis header for
116 * request/response packet types so we just used the SetRequest as a
119 set = &rndis_msg->msg.set_req;
120 set->req_id = atomic_inc_return(&dev->new_req_id);
122 /* Add to the request list */
123 spin_lock_irqsave(&dev->request_lock, flags);
124 list_add_tail(&request->list_ent, &dev->req_list);
125 spin_unlock_irqrestore(&dev->request_lock, flags);
130 static void put_rndis_request(struct rndis_device *dev,
131 struct rndis_request *req)
135 spin_lock_irqsave(&dev->request_lock, flags);
136 list_del(&req->list_ent);
137 spin_unlock_irqrestore(&dev->request_lock, flags);
142 static void dump_rndis_message(struct hv_device *hv_dev,
143 struct rndis_message *rndis_msg)
145 struct net_device *netdev = dev_get_drvdata(&hv_dev->device);
147 switch (rndis_msg->ndis_msg_type) {
148 case REMOTE_NDIS_PACKET_MSG:
149 netdev_dbg(netdev, "REMOTE_NDIS_PACKET_MSG (len %u, "
150 "data offset %u data len %u, # oob %u, "
151 "oob offset %u, oob len %u, pkt offset %u, "
154 rndis_msg->msg.pkt.data_offset,
155 rndis_msg->msg.pkt.data_len,
156 rndis_msg->msg.pkt.num_oob_data_elements,
157 rndis_msg->msg.pkt.oob_data_offset,
158 rndis_msg->msg.pkt.oob_data_len,
159 rndis_msg->msg.pkt.per_pkt_info_offset,
160 rndis_msg->msg.pkt.per_pkt_info_len);
163 case REMOTE_NDIS_INITIALIZE_CMPLT:
164 netdev_dbg(netdev, "REMOTE_NDIS_INITIALIZE_CMPLT "
165 "(len %u, id 0x%x, status 0x%x, major %d, minor %d, "
166 "device flags %d, max xfer size 0x%x, max pkts %u, "
169 rndis_msg->msg.init_complete.req_id,
170 rndis_msg->msg.init_complete.status,
171 rndis_msg->msg.init_complete.major_ver,
172 rndis_msg->msg.init_complete.minor_ver,
173 rndis_msg->msg.init_complete.dev_flags,
174 rndis_msg->msg.init_complete.max_xfer_size,
175 rndis_msg->msg.init_complete.
177 rndis_msg->msg.init_complete.
178 pkt_alignment_factor);
181 case REMOTE_NDIS_QUERY_CMPLT:
182 netdev_dbg(netdev, "REMOTE_NDIS_QUERY_CMPLT "
183 "(len %u, id 0x%x, status 0x%x, buf len %u, "
186 rndis_msg->msg.query_complete.req_id,
187 rndis_msg->msg.query_complete.status,
188 rndis_msg->msg.query_complete.
190 rndis_msg->msg.query_complete.
194 case REMOTE_NDIS_SET_CMPLT:
196 "REMOTE_NDIS_SET_CMPLT (len %u, id 0x%x, status 0x%x)\n",
198 rndis_msg->msg.set_complete.req_id,
199 rndis_msg->msg.set_complete.status);
202 case REMOTE_NDIS_INDICATE_STATUS_MSG:
203 netdev_dbg(netdev, "REMOTE_NDIS_INDICATE_STATUS_MSG "
204 "(len %u, status 0x%x, buf len %u, buf offset %u)\n",
206 rndis_msg->msg.indicate_status.status,
207 rndis_msg->msg.indicate_status.status_buflen,
208 rndis_msg->msg.indicate_status.status_buf_offset);
212 netdev_dbg(netdev, "0x%x (len %u)\n",
213 rndis_msg->ndis_msg_type,
219 static int rndis_filter_send_request(struct rndis_device *dev,
220 struct rndis_request *req)
223 struct hv_netvsc_packet *packet;
225 /* Setup the packet to send it */
228 packet->is_data_pkt = false;
229 packet->total_data_buflen = req->request_msg.msg_len;
230 packet->page_buf_cnt = 1;
232 packet->page_buf[0].pfn = virt_to_phys(&req->request_msg) >>
234 packet->page_buf[0].len = req->request_msg.msg_len;
235 packet->page_buf[0].offset =
236 (unsigned long)&req->request_msg & (PAGE_SIZE - 1);
238 packet->completion.send.send_completion_ctx = req;/* packet; */
239 packet->completion.send.send_completion =
240 rndis_filter_send_request_completion;
241 packet->completion.send.send_completion_tid = (unsigned long)dev;
243 ret = netvsc_send(dev->net_dev->dev, packet);
247 static void rndis_filter_receive_response(struct rndis_device *dev,
248 struct rndis_message *resp)
250 struct rndis_request *request = NULL;
254 spin_lock_irqsave(&dev->request_lock, flags);
255 list_for_each_entry(request, &dev->req_list, list_ent) {
257 * All request/response message contains RequestId as the 1st
260 if (request->request_msg.msg.init_req.req_id
261 == resp->msg.init_complete.req_id) {
266 spin_unlock_irqrestore(&dev->request_lock, flags);
269 if (resp->msg_len <= sizeof(struct rndis_message)) {
270 memcpy(&request->response_msg, resp,
273 dev_err(&dev->net_dev->dev->device,
274 "rndis response buffer overflow "
275 "detected (size %u max %zu)\n",
277 sizeof(struct rndis_filter_packet));
279 if (resp->ndis_msg_type ==
280 REMOTE_NDIS_RESET_CMPLT) {
281 /* does not have a request id field */
282 request->response_msg.msg.reset_complete.
283 status = STATUS_BUFFER_OVERFLOW;
285 request->response_msg.msg.
286 init_complete.status =
287 STATUS_BUFFER_OVERFLOW;
291 complete(&request->wait_event);
293 dev_err(&dev->net_dev->dev->device,
294 "no rndis request found for this response "
295 "(id 0x%x res type 0x%x)\n",
296 resp->msg.init_complete.req_id,
297 resp->ndis_msg_type);
301 static void rndis_filter_receive_indicate_status(struct rndis_device *dev,
302 struct rndis_message *resp)
304 struct rndis_indicate_status *indicate =
305 &resp->msg.indicate_status;
307 if (indicate->status == RNDIS_STATUS_MEDIA_CONNECT) {
308 netvsc_linkstatus_callback(
309 dev->net_dev->dev, 1);
310 } else if (indicate->status == RNDIS_STATUS_MEDIA_DISCONNECT) {
311 netvsc_linkstatus_callback(
312 dev->net_dev->dev, 0);
320 static void rndis_filter_receive_data(struct rndis_device *dev,
321 struct rndis_message *msg,
322 struct hv_netvsc_packet *pkt)
324 struct rndis_packet *rndis_pkt;
327 rndis_pkt = &msg->msg.pkt;
330 * FIXME: Handle multiple rndis pkt msgs that maybe enclosed in this
331 * netvsc packet (ie TotalDataBufferLength != MessageLength)
334 /* Remove the rndis header and pass it back up the stack */
335 data_offset = RNDIS_HEADER_SIZE + rndis_pkt->data_offset;
337 pkt->total_data_buflen -= data_offset;
338 pkt->page_buf[0].offset += data_offset;
339 pkt->page_buf[0].len -= data_offset;
341 pkt->is_data_pkt = true;
343 netvsc_recv_callback(dev->net_dev->dev, pkt);
346 int rndis_filter_receive(struct hv_device *dev,
347 struct hv_netvsc_packet *pkt)
349 struct netvsc_device *net_dev = dev->ext;
350 struct rndis_device *rndis_dev;
351 struct rndis_message rndis_msg;
352 struct rndis_message *rndis_hdr;
357 /* Make sure the rndis device state is initialized */
358 if (!net_dev->extension) {
359 dev_err(&dev->device, "got rndis message but no rndis device - "
360 "dropping this message!\n");
364 rndis_dev = (struct rndis_device *)net_dev->extension;
365 if (rndis_dev->state == RNDIS_DEV_UNINITIALIZED) {
366 dev_err(&dev->device, "got rndis message but rndis device "
367 "uninitialized...dropping this message!\n");
371 rndis_hdr = (struct rndis_message *)kmap_atomic(
372 pfn_to_page(pkt->page_buf[0].pfn), KM_IRQ0);
374 rndis_hdr = (void *)((unsigned long)rndis_hdr +
375 pkt->page_buf[0].offset);
377 /* Make sure we got a valid rndis message */
378 if ((rndis_hdr->ndis_msg_type != REMOTE_NDIS_PACKET_MSG) &&
379 (rndis_hdr->msg_len > sizeof(struct rndis_message))) {
380 dev_err(&dev->device, "incoming rndis message buffer overflow "
381 "detected (got %u, max %zu)..marking it an error!\n",
383 sizeof(struct rndis_message));
386 memcpy(&rndis_msg, rndis_hdr,
387 (rndis_hdr->msg_len > sizeof(struct rndis_message)) ?
388 sizeof(struct rndis_message) :
391 kunmap_atomic(rndis_hdr - pkt->page_buf[0].offset, KM_IRQ0);
393 dump_rndis_message(dev, &rndis_msg);
395 switch (rndis_msg.ndis_msg_type) {
396 case REMOTE_NDIS_PACKET_MSG:
398 rndis_filter_receive_data(rndis_dev, &rndis_msg, pkt);
401 case REMOTE_NDIS_INITIALIZE_CMPLT:
402 case REMOTE_NDIS_QUERY_CMPLT:
403 case REMOTE_NDIS_SET_CMPLT:
404 /* completion msgs */
405 rndis_filter_receive_response(rndis_dev, &rndis_msg);
408 case REMOTE_NDIS_INDICATE_STATUS_MSG:
409 /* notification msgs */
410 rndis_filter_receive_indicate_status(rndis_dev, &rndis_msg);
413 dev_err(&dev->device,
414 "unhandled rndis message (type %u len %u)\n",
415 rndis_msg.ndis_msg_type,
423 static int rndis_filter_query_device(struct rndis_device *dev, u32 oid,
424 void *result, u32 *result_size)
426 struct rndis_request *request;
427 u32 inresult_size = *result_size;
428 struct rndis_query_request *query;
429 struct rndis_query_complete *query_complete;
437 request = get_rndis_request(dev, REMOTE_NDIS_QUERY_MSG,
438 RNDIS_MESSAGE_SIZE(struct rndis_query_request));
444 /* Setup the rndis query */
445 query = &request->request_msg.msg.query_req;
447 query->info_buf_offset = sizeof(struct rndis_query_request);
448 query->info_buflen = 0;
449 query->dev_vc_handle = 0;
451 ret = rndis_filter_send_request(dev, request);
455 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
461 /* Copy the response back */
462 query_complete = &request->response_msg.msg.query_complete;
464 if (query_complete->info_buflen > inresult_size) {
470 (void *)((unsigned long)query_complete +
471 query_complete->info_buf_offset),
472 query_complete->info_buflen);
474 *result_size = query_complete->info_buflen;
478 put_rndis_request(dev, request);
483 static int rndis_filter_query_device_mac(struct rndis_device *dev)
487 return rndis_filter_query_device(dev,
488 RNDIS_OID_802_3_PERMANENT_ADDRESS,
489 dev->hw_mac_adr, &size);
492 static int rndis_filter_query_device_link_status(struct rndis_device *dev)
494 u32 size = sizeof(u32);
496 return rndis_filter_query_device(dev,
497 RNDIS_OID_GEN_MEDIA_CONNECT_STATUS,
498 &dev->link_stat, &size);
501 static int rndis_filter_set_packet_filter(struct rndis_device *dev,
504 struct rndis_request *request;
505 struct rndis_set_request *set;
506 struct rndis_set_complete *set_complete;
510 request = get_rndis_request(dev, REMOTE_NDIS_SET_MSG,
511 RNDIS_MESSAGE_SIZE(struct rndis_set_request) +
518 /* Setup the rndis set */
519 set = &request->request_msg.msg.set_req;
520 set->oid = RNDIS_OID_GEN_CURRENT_PACKET_FILTER;
521 set->info_buflen = sizeof(u32);
522 set->info_buf_offset = sizeof(struct rndis_set_request);
524 memcpy((void *)(unsigned long)set + sizeof(struct rndis_set_request),
525 &new_filter, sizeof(u32));
527 ret = rndis_filter_send_request(dev, request);
531 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
535 dev_err(&dev->net_dev->dev->device,
536 "timeout before we got a set response...\n");
538 * We can't deallocate the request since we may still receive a
539 * send completion for it.
545 set_complete = &request->response_msg.msg.set_complete;
546 status = set_complete->status;
551 put_rndis_request(dev, request);
557 static int rndis_filter_init_device(struct rndis_device *dev)
559 struct rndis_request *request;
560 struct rndis_initialize_request *init;
561 struct rndis_initialize_complete *init_complete;
565 request = get_rndis_request(dev, REMOTE_NDIS_INITIALIZE_MSG,
566 RNDIS_MESSAGE_SIZE(struct rndis_initialize_request));
572 /* Setup the rndis set */
573 init = &request->request_msg.msg.init_req;
574 init->major_ver = RNDIS_MAJOR_VERSION;
575 init->minor_ver = RNDIS_MINOR_VERSION;
576 /* FIXME: Use 1536 - rounded ethernet frame size */
577 init->max_xfer_size = 2048;
579 dev->state = RNDIS_DEV_INITIALIZING;
581 ret = rndis_filter_send_request(dev, request);
583 dev->state = RNDIS_DEV_UNINITIALIZED;
588 t = wait_for_completion_timeout(&request->wait_event, 5*HZ);
595 init_complete = &request->response_msg.msg.init_complete;
596 status = init_complete->status;
597 if (status == RNDIS_STATUS_SUCCESS) {
598 dev->state = RNDIS_DEV_INITIALIZED;
601 dev->state = RNDIS_DEV_UNINITIALIZED;
607 put_rndis_request(dev, request);
612 static void rndis_filter_halt_device(struct rndis_device *dev)
614 struct rndis_request *request;
615 struct rndis_halt_request *halt;
617 /* Attempt to do a rndis device halt */
618 request = get_rndis_request(dev, REMOTE_NDIS_HALT_MSG,
619 RNDIS_MESSAGE_SIZE(struct rndis_halt_request));
623 /* Setup the rndis set */
624 halt = &request->request_msg.msg.halt_req;
625 halt->req_id = atomic_inc_return(&dev->new_req_id);
627 /* Ignore return since this msg is optional. */
628 rndis_filter_send_request(dev, request);
630 dev->state = RNDIS_DEV_UNINITIALIZED;
634 put_rndis_request(dev, request);
638 static int rndis_filter_open_device(struct rndis_device *dev)
642 if (dev->state != RNDIS_DEV_INITIALIZED)
645 ret = rndis_filter_set_packet_filter(dev,
646 NDIS_PACKET_TYPE_BROADCAST |
647 NDIS_PACKET_TYPE_ALL_MULTICAST |
648 NDIS_PACKET_TYPE_DIRECTED);
650 dev->state = RNDIS_DEV_DATAINITIALIZED;
655 static int rndis_filter_close_device(struct rndis_device *dev)
659 if (dev->state != RNDIS_DEV_DATAINITIALIZED)
662 ret = rndis_filter_set_packet_filter(dev, 0);
664 dev->state = RNDIS_DEV_INITIALIZED;
669 int rndis_filter_device_add(struct hv_device *dev,
670 void *additional_info)
673 struct netvsc_device *netDevice;
674 struct rndis_device *rndisDevice;
675 struct netvsc_device_info *deviceInfo = additional_info;
677 rndisDevice = get_rndis_device();
682 * Let the inner driver handle this first to create the netvsc channel
683 * NOTE! Once the channel is created, we may get a receive callback
684 * (RndisFilterOnReceive()) before this call is completed
686 ret = netvsc_device_add(dev, additional_info);
693 /* Initialize the rndis device */
694 netDevice = dev->ext;
696 netDevice->extension = rndisDevice;
697 rndisDevice->net_dev = netDevice;
699 /* Send the rndis initialization message */
700 ret = rndis_filter_init_device(rndisDevice);
703 * TODO: If rndis init failed, we will need to shut down the
708 /* Get the mac address */
709 ret = rndis_filter_query_device_mac(rndisDevice);
712 * TODO: shutdown rndis device and the channel
716 memcpy(deviceInfo->mac_adr, rndisDevice->hw_mac_adr, ETH_ALEN);
718 rndis_filter_query_device_link_status(rndisDevice);
720 deviceInfo->link_state = rndisDevice->link_stat;
722 dev_info(&dev->device, "Device MAC %pM link state %s",
723 rndisDevice->hw_mac_adr,
724 ((deviceInfo->link_state) ? ("down\n") : ("up\n")));
729 void rndis_filter_device_remove(struct hv_device *dev)
731 struct netvsc_device *net_dev = dev->ext;
732 struct rndis_device *rndis_dev = net_dev->extension;
734 /* Halt and release the rndis device */
735 rndis_filter_halt_device(rndis_dev);
738 net_dev->extension = NULL;
740 netvsc_device_remove(dev);
744 int rndis_filter_open(struct hv_device *dev)
746 struct netvsc_device *netDevice = dev->ext;
751 return rndis_filter_open_device(netDevice->extension);
754 int rndis_filter_close(struct hv_device *dev)
756 struct netvsc_device *netDevice = dev->ext;
761 return rndis_filter_close_device(netDevice->extension);
764 int rndis_filter_send(struct hv_device *dev,
765 struct hv_netvsc_packet *pkt)
768 struct rndis_filter_packet *filterPacket;
769 struct rndis_message *rndisMessage;
770 struct rndis_packet *rndisPacket;
771 u32 rndisMessageSize;
773 /* Add the rndis header */
774 filterPacket = (struct rndis_filter_packet *)pkt->extension;
776 memset(filterPacket, 0, sizeof(struct rndis_filter_packet));
778 rndisMessage = &filterPacket->msg;
779 rndisMessageSize = RNDIS_MESSAGE_SIZE(struct rndis_packet);
781 rndisMessage->ndis_msg_type = REMOTE_NDIS_PACKET_MSG;
782 rndisMessage->msg_len = pkt->total_data_buflen +
785 rndisPacket = &rndisMessage->msg.pkt;
786 rndisPacket->data_offset = sizeof(struct rndis_packet);
787 rndisPacket->data_len = pkt->total_data_buflen;
789 pkt->is_data_pkt = true;
790 pkt->page_buf[0].pfn = virt_to_phys(rndisMessage) >> PAGE_SHIFT;
791 pkt->page_buf[0].offset =
792 (unsigned long)rndisMessage & (PAGE_SIZE-1);
793 pkt->page_buf[0].len = rndisMessageSize;
795 /* Save the packet send completion and context */
796 filterPacket->completion = pkt->completion.send.send_completion;
797 filterPacket->completion_ctx =
798 pkt->completion.send.send_completion_ctx;
801 pkt->completion.send.send_completion = rndis_filter_send_completion;
802 pkt->completion.send.send_completion_ctx = filterPacket;
804 ret = netvsc_send(dev, pkt);
807 * Reset the completion to originals to allow retries from
810 pkt->completion.send.send_completion =
811 filterPacket->completion;
812 pkt->completion.send.send_completion_ctx =
813 filterPacket->completion_ctx;
819 static void rndis_filter_send_completion(void *ctx)
821 struct rndis_filter_packet *filterPacket = ctx;
823 /* Pass it back to the original handler */
824 filterPacket->completion(filterPacket->completion_ctx);
828 static void rndis_filter_send_request_completion(void *ctx)