3 * Copyright (c) 2009, Microsoft Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307 USA.
19 * Hank Janssen <hjanssen@microsoft.com>
25 #include "include/logging.h"
27 #include "RndisFilter.h"
33 static const char* gDriverName="netvsc";
35 // {F8615163-DF3E-46c5-913F-F2D2F965ED0E}
36 static const GUID gNetVscDeviceType={
37 .Data = {0x63, 0x51, 0x61, 0xF8, 0x3E, 0xDF, 0xc5, 0x46, 0x91, 0x3F, 0xF2, 0xD2, 0xF9, 0x65, 0xED, 0x0E}
46 DEVICE_OBJECT *Device,
61 NetVscOnChannelCallback(
66 NetVscInitializeSendBufferWithNetVsp(
71 NetVscInitializeReceiveBufferWithNetVsp(
76 NetVscDestroySendBuffer(
77 NETVSC_DEVICE *NetDevice
81 NetVscDestroyReceiveBuffer(
82 NETVSC_DEVICE *NetDevice
91 NetVscOnSendCompletion(
92 DEVICE_OBJECT *Device,
93 VMPACKET_DESCRIPTOR *Packet
98 DEVICE_OBJECT *Device,
104 DEVICE_OBJECT *Device,
105 VMPACKET_DESCRIPTOR *Packet
109 NetVscOnReceiveCompletion(
114 NetVscSendReceiveCompletion(
115 DEVICE_OBJECT *Device,
119 static inline NETVSC_DEVICE* AllocNetDevice(DEVICE_OBJECT *Device)
121 NETVSC_DEVICE *netDevice;
123 netDevice = MemAllocZeroed(sizeof(NETVSC_DEVICE));
127 // Set to 2 to allow both inbound and outbound traffic
128 InterlockedCompareExchange(&netDevice->RefCount, 2, 0);
130 netDevice->Device = Device;
131 Device->Extension = netDevice;
136 static inline void FreeNetDevice(NETVSC_DEVICE *Device)
138 ASSERT(Device->RefCount == 0);
139 Device->Device->Extension = NULL;
144 // Get the net device object iff exists and its refcount > 1
145 static inline NETVSC_DEVICE* GetOutboundNetDevice(DEVICE_OBJECT *Device)
147 NETVSC_DEVICE *netDevice;
149 netDevice = (NETVSC_DEVICE*)Device->Extension;
150 if (netDevice && netDevice->RefCount > 1)
152 InterlockedIncrement(&netDevice->RefCount);
162 // Get the net device object iff exists and its refcount > 0
163 static inline NETVSC_DEVICE* GetInboundNetDevice(DEVICE_OBJECT *Device)
165 NETVSC_DEVICE *netDevice;
167 netDevice = (NETVSC_DEVICE*)Device->Extension;
168 if (netDevice && netDevice->RefCount)
170 InterlockedIncrement(&netDevice->RefCount);
180 static inline void PutNetDevice(DEVICE_OBJECT *Device)
182 NETVSC_DEVICE *netDevice;
184 netDevice = (NETVSC_DEVICE*)Device->Extension;
187 InterlockedDecrement(&netDevice->RefCount);
190 static inline NETVSC_DEVICE* ReleaseOutboundNetDevice(DEVICE_OBJECT *Device)
192 NETVSC_DEVICE *netDevice;
194 netDevice = (NETVSC_DEVICE*)Device->Extension;
195 if (netDevice == NULL)
198 // Busy wait until the ref drop to 2, then set it to 1
199 while (InterlockedCompareExchange(&netDevice->RefCount, 1, 2) != 2)
207 static inline NETVSC_DEVICE* ReleaseInboundNetDevice(DEVICE_OBJECT *Device)
209 NETVSC_DEVICE *netDevice;
211 netDevice = (NETVSC_DEVICE*)Device->Extension;
212 if (netDevice == NULL)
215 // Busy wait until the ref drop to 1, then set it to 0
216 while (InterlockedCompareExchange(&netDevice->RefCount, 0, 1) != 1)
221 Device->Extension = NULL;
240 NETVSC_DRIVER_OBJECT* driver = (NETVSC_DRIVER_OBJECT*)drv;
243 DPRINT_ENTER(NETVSC);
245 DPRINT_DBG(NETVSC, "sizeof(NETVSC_PACKET)=%d, sizeof(NVSP_MESSAGE)=%d, sizeof(VMTRANSFER_PAGE_PACKET_HEADER)=%d",
246 sizeof(NETVSC_PACKET), sizeof(NVSP_MESSAGE), sizeof(VMTRANSFER_PAGE_PACKET_HEADER));
248 // Make sure we are at least 2 pages since 1 page is used for control
249 ASSERT(driver->RingBufferSize >= (PAGE_SIZE << 1));
251 drv->name = gDriverName;
252 memcpy(&drv->deviceType, &gNetVscDeviceType, sizeof(GUID));
254 // Make sure it is set by the caller
255 ASSERT(driver->OnReceiveCallback);
256 ASSERT(driver->OnLinkStatusChanged);
258 // Setup the dispatch table
259 driver->Base.OnDeviceAdd = NetVscOnDeviceAdd;
260 driver->Base.OnDeviceRemove = NetVscOnDeviceRemove;
261 driver->Base.OnCleanup = NetVscOnCleanup;
263 driver->OnSend = NetVscOnSend;
265 RndisFilterInit(driver);
273 NetVscInitializeReceiveBufferWithNetVsp(
274 DEVICE_OBJECT *Device
278 NETVSC_DEVICE *netDevice;
279 NVSP_MESSAGE *initPacket;
281 DPRINT_ENTER(NETVSC);
283 netDevice = GetOutboundNetDevice(Device);
286 DPRINT_ERR(NETVSC, "unable to get net device...device being destroyed?");
290 ASSERT(netDevice->ReceiveBufferSize > 0);
291 ASSERT((netDevice->ReceiveBufferSize & (PAGE_SIZE-1)) == 0); // page-size grandularity
293 netDevice->ReceiveBuffer = PageAlloc(netDevice->ReceiveBufferSize >> PAGE_SHIFT);
294 if (!netDevice->ReceiveBuffer)
296 DPRINT_ERR(NETVSC, "unable to allocate receive buffer of size %d", netDevice->ReceiveBufferSize);
300 ASSERT(((ULONG_PTR)netDevice->ReceiveBuffer & (PAGE_SIZE-1)) == 0); // page-aligned buffer
302 DPRINT_INFO(NETVSC, "Establishing receive buffer's GPADL...");
304 // Establish the gpadl handle for this buffer on this channel.
305 // Note: This call uses the vmbus connection rather than the channel to establish
307 ret = Device->Driver->VmbusChannelInterface.EstablishGpadl(Device,
308 netDevice->ReceiveBuffer,
309 netDevice->ReceiveBufferSize,
310 &netDevice->ReceiveBufferGpadlHandle);
314 DPRINT_ERR(NETVSC, "unable to establish receive buffer's gpadl");
318 //WaitEventWait(ext->ChannelInitEvent);
320 // Notify the NetVsp of the gpadl handle
321 DPRINT_INFO(NETVSC, "Sending NvspMessage1TypeSendReceiveBuffer...");
323 initPacket = &netDevice->ChannelInitPacket;
325 memset(initPacket, 0, sizeof(NVSP_MESSAGE));
327 initPacket->Header.MessageType = NvspMessage1TypeSendReceiveBuffer;
328 initPacket->Messages.Version1Messages.SendReceiveBuffer.GpadlHandle = netDevice->ReceiveBufferGpadlHandle;
329 initPacket->Messages.Version1Messages.SendReceiveBuffer.Id = NETVSC_RECEIVE_BUFFER_ID;
331 // Send the gpadl notification request
332 ret = Device->Driver->VmbusChannelInterface.SendPacket(Device,
334 sizeof(NVSP_MESSAGE),
335 (ULONG_PTR)initPacket,
336 VmbusPacketTypeDataInBand,
337 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
340 DPRINT_ERR(NETVSC, "unable to send receive buffer's gpadl to netvsp");
344 WaitEventWait(netDevice->ChannelInitEvent);
346 // Check the response
347 if (initPacket->Messages.Version1Messages.SendReceiveBufferComplete.Status != NvspStatusSuccess)
350 "Unable to complete receive buffer initialzation with NetVsp - status %d",
351 initPacket->Messages.Version1Messages.SendReceiveBufferComplete.Status);
356 // Parse the response
357 ASSERT(netDevice->ReceiveSectionCount == 0);
358 ASSERT(netDevice->ReceiveSections == NULL);
360 netDevice->ReceiveSectionCount = initPacket->Messages.Version1Messages.SendReceiveBufferComplete.NumSections;
362 netDevice->ReceiveSections = MemAlloc(netDevice->ReceiveSectionCount * sizeof(NVSP_1_RECEIVE_BUFFER_SECTION));
363 if (netDevice->ReceiveSections == NULL)
369 memcpy(netDevice->ReceiveSections,
370 initPacket->Messages.Version1Messages.SendReceiveBufferComplete.Sections,
371 netDevice->ReceiveSectionCount * sizeof(NVSP_1_RECEIVE_BUFFER_SECTION));
374 "Receive sections info (count %d, offset %d, endoffset %d, suballoc size %d, num suballocs %d)",
375 netDevice->ReceiveSectionCount, netDevice->ReceiveSections[0].Offset, netDevice->ReceiveSections[0].EndOffset,
376 netDevice->ReceiveSections[0].SubAllocationSize, netDevice->ReceiveSections[0].NumSubAllocations);
379 //For 1st release, there should only be 1 section that represents the entire receive buffer
380 if (netDevice->ReceiveSectionCount != 1 ||
381 netDevice->ReceiveSections->Offset != 0 )
390 NetVscDestroyReceiveBuffer(netDevice);
393 PutNetDevice(Device);
400 NetVscInitializeSendBufferWithNetVsp(
401 DEVICE_OBJECT *Device
405 NETVSC_DEVICE *netDevice;
406 NVSP_MESSAGE *initPacket;
408 DPRINT_ENTER(NETVSC);
410 netDevice = GetOutboundNetDevice(Device);
413 DPRINT_ERR(NETVSC, "unable to get net device...device being destroyed?");
417 ASSERT(netDevice->SendBufferSize > 0);
418 ASSERT((netDevice->SendBufferSize & (PAGE_SIZE-1)) == 0); // page-size grandularity
420 netDevice->SendBuffer = PageAlloc(netDevice->SendBufferSize >> PAGE_SHIFT);
421 if (!netDevice->SendBuffer)
423 DPRINT_ERR(NETVSC, "unable to allocate send buffer of size %d", netDevice->SendBufferSize);
427 ASSERT(((ULONG_PTR)netDevice->SendBuffer & (PAGE_SIZE-1)) == 0); // page-aligned buffer
429 DPRINT_INFO(NETVSC, "Establishing send buffer's GPADL...");
431 // Establish the gpadl handle for this buffer on this channel.
432 // Note: This call uses the vmbus connection rather than the channel to establish
434 ret = Device->Driver->VmbusChannelInterface.EstablishGpadl(Device,
435 netDevice->SendBuffer,
436 netDevice->SendBufferSize,
437 &netDevice->SendBufferGpadlHandle);
441 DPRINT_ERR(NETVSC, "unable to establish send buffer's gpadl");
445 //WaitEventWait(ext->ChannelInitEvent);
447 // Notify the NetVsp of the gpadl handle
448 DPRINT_INFO(NETVSC, "Sending NvspMessage1TypeSendSendBuffer...");
450 initPacket = &netDevice->ChannelInitPacket;
452 memset(initPacket, 0, sizeof(NVSP_MESSAGE));
454 initPacket->Header.MessageType = NvspMessage1TypeSendSendBuffer;
455 initPacket->Messages.Version1Messages.SendReceiveBuffer.GpadlHandle = netDevice->SendBufferGpadlHandle;
456 initPacket->Messages.Version1Messages.SendReceiveBuffer.Id = NETVSC_SEND_BUFFER_ID;
458 // Send the gpadl notification request
459 ret = Device->Driver->VmbusChannelInterface.SendPacket(Device,
461 sizeof(NVSP_MESSAGE),
462 (ULONG_PTR)initPacket,
463 VmbusPacketTypeDataInBand,
464 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
467 DPRINT_ERR(NETVSC, "unable to send receive buffer's gpadl to netvsp");
471 WaitEventWait(netDevice->ChannelInitEvent);
473 // Check the response
474 if (initPacket->Messages.Version1Messages.SendSendBufferComplete.Status != NvspStatusSuccess)
477 "Unable to complete send buffer initialzation with NetVsp - status %d",
478 initPacket->Messages.Version1Messages.SendSendBufferComplete.Status);
483 netDevice->SendSectionSize = initPacket->Messages.Version1Messages.SendSendBufferComplete.SectionSize;
488 NetVscDestroySendBuffer(netDevice);
491 PutNetDevice(Device);
497 NetVscDestroyReceiveBuffer(
498 NETVSC_DEVICE *NetDevice
501 NVSP_MESSAGE *revokePacket;
505 DPRINT_ENTER(NETVSC);
507 // If we got a section count, it means we received a SendReceiveBufferComplete msg
508 // (ie sent NvspMessage1TypeSendReceiveBuffer msg) therefore, we need to send a revoke msg here
509 if (NetDevice->ReceiveSectionCount)
511 DPRINT_INFO(NETVSC, "Sending NvspMessage1TypeRevokeReceiveBuffer...");
513 // Send the revoke receive buffer
514 revokePacket = &NetDevice->RevokePacket;
515 memset(revokePacket, 0, sizeof(NVSP_MESSAGE));
517 revokePacket->Header.MessageType = NvspMessage1TypeRevokeReceiveBuffer;
518 revokePacket->Messages.Version1Messages.RevokeReceiveBuffer.Id = NETVSC_RECEIVE_BUFFER_ID;
520 ret = NetDevice->Device->Driver->VmbusChannelInterface.SendPacket(NetDevice->Device,
522 sizeof(NVSP_MESSAGE),
523 (ULONG_PTR)revokePacket,
524 VmbusPacketTypeDataInBand,
526 // If we failed here, we might as well return and have a leak rather than continue and a bugchk
529 DPRINT_ERR(NETVSC, "unable to send revoke receive buffer to netvsp");
535 // Teardown the gpadl on the vsp end
536 if (NetDevice->ReceiveBufferGpadlHandle)
538 DPRINT_INFO(NETVSC, "Tearing down receive buffer's GPADL...");
540 ret = NetDevice->Device->Driver->VmbusChannelInterface.TeardownGpadl(NetDevice->Device,
541 NetDevice->ReceiveBufferGpadlHandle);
543 // If we failed here, we might as well return and have a leak rather than continue and a bugchk
546 DPRINT_ERR(NETVSC, "unable to teardown receive buffer's gpadl");
550 NetDevice->ReceiveBufferGpadlHandle = 0;
553 if (NetDevice->ReceiveBuffer)
555 DPRINT_INFO(NETVSC, "Freeing up receive buffer...");
557 // Free up the receive buffer
558 PageFree(NetDevice->ReceiveBuffer, NetDevice->ReceiveBufferSize >> PAGE_SHIFT);
559 NetDevice->ReceiveBuffer = NULL;
562 if (NetDevice->ReceiveSections)
564 MemFree(NetDevice->ReceiveSections);
565 NetDevice->ReceiveSections = NULL;
566 NetDevice->ReceiveSectionCount = 0;
578 NetVscDestroySendBuffer(
579 NETVSC_DEVICE *NetDevice
582 NVSP_MESSAGE *revokePacket;
586 DPRINT_ENTER(NETVSC);
588 // If we got a section count, it means we received a SendReceiveBufferComplete msg
589 // (ie sent NvspMessage1TypeSendReceiveBuffer msg) therefore, we need to send a revoke msg here
590 if (NetDevice->SendSectionSize)
592 DPRINT_INFO(NETVSC, "Sending NvspMessage1TypeRevokeSendBuffer...");
594 // Send the revoke send buffer
595 revokePacket = &NetDevice->RevokePacket;
596 memset(revokePacket, 0, sizeof(NVSP_MESSAGE));
598 revokePacket->Header.MessageType = NvspMessage1TypeRevokeSendBuffer;
599 revokePacket->Messages.Version1Messages.RevokeSendBuffer.Id = NETVSC_SEND_BUFFER_ID;
601 ret = NetDevice->Device->Driver->VmbusChannelInterface.SendPacket(NetDevice->Device,
603 sizeof(NVSP_MESSAGE),
604 (ULONG_PTR)revokePacket,
605 VmbusPacketTypeDataInBand,
607 // If we failed here, we might as well return and have a leak rather than continue and a bugchk
610 DPRINT_ERR(NETVSC, "unable to send revoke send buffer to netvsp");
616 // Teardown the gpadl on the vsp end
617 if (NetDevice->SendBufferGpadlHandle)
619 DPRINT_INFO(NETVSC, "Tearing down send buffer's GPADL...");
621 ret = NetDevice->Device->Driver->VmbusChannelInterface.TeardownGpadl(NetDevice->Device,
622 NetDevice->SendBufferGpadlHandle);
624 // If we failed here, we might as well return and have a leak rather than continue and a bugchk
627 DPRINT_ERR(NETVSC, "unable to teardown send buffer's gpadl");
631 NetDevice->SendBufferGpadlHandle = 0;
634 if (NetDevice->SendBuffer)
636 DPRINT_INFO(NETVSC, "Freeing up send buffer...");
638 // Free up the receive buffer
639 PageFree(NetDevice->SendBuffer, NetDevice->SendBufferSize >> PAGE_SHIFT);
640 NetDevice->SendBuffer = NULL;
652 DEVICE_OBJECT *Device
656 NETVSC_DEVICE *netDevice;
657 NVSP_MESSAGE *initPacket;
660 DPRINT_ENTER(NETVSC);
662 netDevice = GetOutboundNetDevice(Device);
665 DPRINT_ERR(NETVSC, "unable to get net device...device being destroyed?");
670 initPacket = &netDevice->ChannelInitPacket;
672 memset(initPacket, 0, sizeof(NVSP_MESSAGE));
673 initPacket->Header.MessageType = NvspMessageTypeInit;
674 initPacket->Messages.InitMessages.Init.MinProtocolVersion = NVSP_MIN_PROTOCOL_VERSION;
675 initPacket->Messages.InitMessages.Init.MaxProtocolVersion = NVSP_MAX_PROTOCOL_VERSION;
677 DPRINT_INFO(NETVSC, "Sending NvspMessageTypeInit...");
679 // Send the init request
680 ret = Device->Driver->VmbusChannelInterface.SendPacket(Device,
682 sizeof(NVSP_MESSAGE),
683 (ULONG_PTR)initPacket,
684 VmbusPacketTypeDataInBand,
685 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
689 DPRINT_ERR(NETVSC, "unable to send NvspMessageTypeInit");
693 WaitEventWait(netDevice->ChannelInitEvent);
695 // Now, check the response
696 //ASSERT(initPacket->Messages.InitMessages.InitComplete.MaximumMdlChainLength <= MAX_MULTIPAGE_BUFFER_COUNT);
697 DPRINT_INFO(NETVSC, "NvspMessageTypeInit status(%d) max mdl chain (%d)",
698 initPacket->Messages.InitMessages.InitComplete.Status,
699 initPacket->Messages.InitMessages.InitComplete.MaximumMdlChainLength);
701 if (initPacket->Messages.InitMessages.InitComplete.Status != NvspStatusSuccess)
703 DPRINT_ERR(NETVSC, "unable to initialize with netvsp (status 0x%x)", initPacket->Messages.InitMessages.InitComplete.Status);
708 if (initPacket->Messages.InitMessages.InitComplete.NegotiatedProtocolVersion != NVSP_PROTOCOL_VERSION_1)
710 DPRINT_ERR(NETVSC, "unable to initialize with netvsp (version expected 1 got %d)",
711 initPacket->Messages.InitMessages.InitComplete.NegotiatedProtocolVersion);
715 DPRINT_INFO(NETVSC, "Sending NvspMessage1TypeSendNdisVersion...");
717 // Send the ndis version
718 memset(initPacket, 0, sizeof(NVSP_MESSAGE));
720 ndisVersion = 0x00050000;
722 initPacket->Header.MessageType = NvspMessage1TypeSendNdisVersion;
723 initPacket->Messages.Version1Messages.SendNdisVersion.NdisMajorVersion = (ndisVersion & 0xFFFF0000) >> 16;
724 initPacket->Messages.Version1Messages.SendNdisVersion.NdisMinorVersion = ndisVersion & 0xFFFF;
726 // Send the init request
727 ret = Device->Driver->VmbusChannelInterface.SendPacket(Device,
729 sizeof(NVSP_MESSAGE),
730 (ULONG_PTR)initPacket,
731 VmbusPacketTypeDataInBand,
735 DPRINT_ERR(NETVSC, "unable to send NvspMessage1TypeSendNdisVersion");
740 // BUGBUG - We have to wait for the above msg since the netvsp uses KMCL which acknowledges packet (completion packet)
741 // since our Vmbus always set the VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED flag
742 //WaitEventWait(NetVscChannel->ChannelInitEvent);
744 // Post the big receive buffer to NetVSP
745 ret = NetVscInitializeReceiveBufferWithNetVsp(Device);
748 ret = NetVscInitializeSendBufferWithNetVsp(Device);
752 PutNetDevice(Device);
758 NetVscDisconnectFromVsp(
759 NETVSC_DEVICE *NetDevice
762 DPRINT_ENTER(NETVSC);
764 NetVscDestroyReceiveBuffer(NetDevice);
765 NetVscDestroySendBuffer(NetDevice);
777 Callback when the device belonging to this driver is added
782 DEVICE_OBJECT *Device,
789 NETVSC_DEVICE* netDevice;
790 NETVSC_PACKET* packet;
793 NETVSC_DRIVER_OBJECT *netDriver = (NETVSC_DRIVER_OBJECT*) Device->Driver;;
795 DPRINT_ENTER(NETVSC);
797 netDevice = AllocNetDevice(Device);
804 DPRINT_DBG(NETVSC, "netvsc channel object allocated - %p", netDevice);
806 // Initialize the NetVSC channel extension
807 netDevice->ReceiveBufferSize = NETVSC_RECEIVE_BUFFER_SIZE;
808 netDevice->ReceivePacketListLock = SpinlockCreate();
810 netDevice->SendBufferSize = NETVSC_SEND_BUFFER_SIZE;
812 INITIALIZE_LIST_HEAD(&netDevice->ReceivePacketList);
814 for (i=0; i < NETVSC_RECEIVE_PACKETLIST_COUNT; i++)
816 packet = MemAllocZeroed(sizeof(NETVSC_PACKET) + (NETVSC_RECEIVE_SG_COUNT* sizeof(PAGE_BUFFER)));
819 DPRINT_DBG(NETVSC, "unable to allocate netvsc pkts for receive pool (wanted %d got %d)", NETVSC_RECEIVE_PACKETLIST_COUNT, i);
823 INSERT_TAIL_LIST(&netDevice->ReceivePacketList, &packet->ListEntry);
825 netDevice->ChannelInitEvent = WaitEventCreate();
828 ret = Device->Driver->VmbusChannelInterface.Open(Device,
829 netDriver->RingBufferSize,
830 netDriver->RingBufferSize,
832 NetVscOnChannelCallback,
838 DPRINT_ERR(NETVSC, "unable to open channel: %d", ret);
844 DPRINT_INFO(NETVSC, "*** NetVSC channel opened successfully! ***");
846 // Connect with the NetVsp
847 ret = NetVscConnectToVsp(Device);
850 DPRINT_ERR(NETVSC, "unable to connect to NetVSP - %d", ret);
855 DPRINT_INFO(NETVSC, "*** NetVSC channel handshake result - %d ***", ret);
861 // Now, we can close the channel safely
862 Device->Driver->VmbusChannelInterface.Close(Device);
868 WaitEventClose(netDevice->ChannelInitEvent);
870 while (!IsListEmpty(&netDevice->ReceivePacketList))
872 entry = REMOVE_HEAD_LIST(&netDevice->ReceivePacketList);
873 packet = CONTAINING_RECORD(entry, NETVSC_PACKET, ListEntry);
877 SpinlockClose(netDevice->ReceivePacketListLock);
879 ReleaseOutboundNetDevice(Device);
880 ReleaseInboundNetDevice(Device);
882 FreeNetDevice(netDevice);
893 NetVscOnDeviceRemove()
896 Callback when the root bus device is removed
900 NetVscOnDeviceRemove(
901 DEVICE_OBJECT *Device
904 NETVSC_DEVICE *netDevice;
905 NETVSC_PACKET *netvscPacket;
909 DPRINT_ENTER(NETVSC);
911 DPRINT_INFO(NETVSC, "Disabling outbound traffic on net device (%p)...", Device->Extension);
913 // Stop outbound traffic ie sends and receives completions
914 netDevice = ReleaseOutboundNetDevice(Device);
917 DPRINT_ERR(NETVSC, "No net device present!!");
921 // Wait for all send completions
922 while (netDevice->NumOutstandingSends)
924 DPRINT_INFO(NETVSC, "waiting for %d requests to complete...", netDevice->NumOutstandingSends);
929 DPRINT_INFO(NETVSC, "Disconnecting from netvsp...");
931 NetVscDisconnectFromVsp(netDevice);
933 DPRINT_INFO(NETVSC, "Disabling inbound traffic on net device (%p)...", Device->Extension);
935 // Stop inbound traffic ie receives and sends completions
936 netDevice = ReleaseInboundNetDevice(Device);
938 // At this point, no one should be accessing netDevice except in here
939 DPRINT_INFO(NETVSC, "net device (%p) safe to remove", netDevice);
941 // Now, we can close the channel safely
942 Device->Driver->VmbusChannelInterface.Close(Device);
944 // Release all resources
945 while (!IsListEmpty(&netDevice->ReceivePacketList))
947 entry = REMOVE_HEAD_LIST(&netDevice->ReceivePacketList);
948 netvscPacket = CONTAINING_RECORD(entry, NETVSC_PACKET, ListEntry);
950 MemFree(netvscPacket);
953 SpinlockClose(netDevice->ReceivePacketListLock);
954 WaitEventClose(netDevice->ChannelInitEvent);
955 FreeNetDevice(netDevice);
969 Perform any cleanup when the driver is removed
977 DPRINT_ENTER(NETVSC);
983 NetVscOnSendCompletion(
984 DEVICE_OBJECT *Device,
985 VMPACKET_DESCRIPTOR *Packet
988 NETVSC_DEVICE* netDevice;
989 NVSP_MESSAGE *nvspPacket;
990 NETVSC_PACKET *nvscPacket;
992 DPRINT_ENTER(NETVSC);
994 netDevice = GetInboundNetDevice(Device);
997 DPRINT_ERR(NETVSC, "unable to get net device...device being destroyed?");
1002 nvspPacket = (NVSP_MESSAGE*)((ULONG_PTR)Packet + (Packet->DataOffset8 << 3));
1004 DPRINT_DBG(NETVSC, "send completion packet - type %d", nvspPacket->Header.MessageType);
1006 if (nvspPacket->Header.MessageType == NvspMessageTypeInitComplete ||
1007 nvspPacket->Header.MessageType == NvspMessage1TypeSendReceiveBufferComplete ||
1008 nvspPacket->Header.MessageType == NvspMessage1TypeSendSendBufferComplete)
1010 // Copy the response back
1011 memcpy(&netDevice->ChannelInitPacket, nvspPacket, sizeof(NVSP_MESSAGE));
1012 WaitEventSet(netDevice->ChannelInitEvent);
1014 else if (nvspPacket->Header.MessageType == NvspMessage1TypeSendRNDISPacketComplete)
1016 // Get the send context
1017 nvscPacket = (NETVSC_PACKET *)(ULONG_PTR)Packet->TransactionId;
1020 // Notify the layer above us
1021 nvscPacket->Completion.Send.OnSendCompletion(nvscPacket->Completion.Send.SendCompletionContext);
1023 InterlockedDecrement(&netDevice->NumOutstandingSends);
1027 DPRINT_ERR(NETVSC, "Unknown send completion packet type - %d received!!", nvspPacket->Header.MessageType);
1030 PutNetDevice(Device);
1031 DPRINT_EXIT(NETVSC);
1038 DEVICE_OBJECT *Device,
1039 NETVSC_PACKET *Packet
1042 NETVSC_DEVICE* netDevice;
1045 NVSP_MESSAGE sendMessage;
1047 DPRINT_ENTER(NETVSC);
1049 netDevice = GetOutboundNetDevice(Device);
1052 DPRINT_ERR(NETVSC, "net device (%p) shutting down...ignoring outbound packets", netDevice);
1053 DPRINT_EXIT(NETVSC);
1057 sendMessage.Header.MessageType = NvspMessage1TypeSendRNDISPacket;
1058 if (Packet->IsDataPacket)
1059 sendMessage.Messages.Version1Messages.SendRNDISPacket.ChannelType = 0;// 0 is RMC_DATA;
1061 sendMessage.Messages.Version1Messages.SendRNDISPacket.ChannelType = 1;// 1 is RMC_CONTROL;
1063 // Not using send buffer section
1064 sendMessage.Messages.Version1Messages.SendRNDISPacket.SendBufferSectionIndex = 0xFFFFFFFF;
1065 sendMessage.Messages.Version1Messages.SendRNDISPacket.SendBufferSectionSize = 0;
1067 if (Packet->PageBufferCount)
1069 ret = Device->Driver->VmbusChannelInterface.SendPacketPageBuffer(Device,
1070 Packet->PageBuffers,
1071 Packet->PageBufferCount,
1073 sizeof(NVSP_MESSAGE),
1078 ret = Device->Driver->VmbusChannelInterface.SendPacket(Device,
1080 sizeof(NVSP_MESSAGE),
1082 VmbusPacketTypeDataInBand,
1083 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
1089 DPRINT_ERR(NETVSC, "Unable to send packet %p ret %d", Packet, ret);
1092 InterlockedIncrement(&netDevice->NumOutstandingSends);
1093 PutNetDevice(Device);
1095 DPRINT_EXIT(NETVSC);
1102 DEVICE_OBJECT *Device,
1103 VMPACKET_DESCRIPTOR *Packet
1106 NETVSC_DEVICE* netDevice;
1107 VMTRANSFER_PAGE_PACKET_HEADER *vmxferpagePacket;
1108 NVSP_MESSAGE *nvspPacket;
1109 NETVSC_PACKET *netvscPacket=NULL;
1112 ULONG_PTR end, endVirtual;
1113 //NETVSC_DRIVER_OBJECT *netvscDriver;
1114 XFERPAGE_PACKET *xferpagePacket=NULL;
1115 LIST_ENTRY listHead;
1118 int count=0, bytesRemain=0;
1120 DPRINT_ENTER(NETVSC);
1122 netDevice = GetInboundNetDevice(Device);
1125 DPRINT_ERR(NETVSC, "unable to get net device...device being destroyed?");
1126 DPRINT_EXIT(NETVSC);
1130 // All inbound packets other than send completion should be xfer page packet
1131 if (Packet->Type != VmbusPacketTypeDataUsingTransferPages)
1133 DPRINT_ERR(NETVSC, "Unknown packet type received - %d", Packet->Type);
1134 PutNetDevice(Device);
1138 nvspPacket = (NVSP_MESSAGE*)((ULONG_PTR)Packet + (Packet->DataOffset8 << 3));
1140 // Make sure this is a valid nvsp packet
1141 if (nvspPacket->Header.MessageType != NvspMessage1TypeSendRNDISPacket )
1143 DPRINT_ERR(NETVSC, "Unknown nvsp packet type received - %d", nvspPacket->Header.MessageType);
1144 PutNetDevice(Device);
1148 DPRINT_DBG(NETVSC, "NVSP packet received - type %d", nvspPacket->Header.MessageType);
1150 vmxferpagePacket = (VMTRANSFER_PAGE_PACKET_HEADER*)Packet;
1152 if (vmxferpagePacket->TransferPageSetId != NETVSC_RECEIVE_BUFFER_ID)
1154 DPRINT_ERR(NETVSC, "Invalid xfer page set id - expecting %x got %x", NETVSC_RECEIVE_BUFFER_ID, vmxferpagePacket->TransferPageSetId);
1155 PutNetDevice(Device);
1159 DPRINT_DBG(NETVSC, "xfer page - range count %d", vmxferpagePacket->RangeCount);
1161 INITIALIZE_LIST_HEAD(&listHead);
1163 // Grab free packets (range count + 1) to represent this xfer page packet. +1 to represent
1164 // the xfer page packet itself. We grab it here so that we know exactly how many we can fulfil
1165 SpinlockAcquire(netDevice->ReceivePacketListLock);
1166 while (!IsListEmpty(&netDevice->ReceivePacketList))
1168 entry = REMOVE_HEAD_LIST(&netDevice->ReceivePacketList);
1169 netvscPacket = CONTAINING_RECORD(entry, NETVSC_PACKET, ListEntry);
1171 INSERT_TAIL_LIST(&listHead, &netvscPacket->ListEntry);
1173 if (++count == vmxferpagePacket->RangeCount + 1)
1176 SpinlockRelease(netDevice->ReceivePacketListLock);
1178 // We need at least 2 netvsc pkts (1 to represent the xfer page and at least 1 for the range)
1179 // i.e. we can handled some of the xfer page packet ranges...
1182 DPRINT_ERR(NETVSC, "Got only %d netvsc pkt...needed %d pkts. Dropping this xfer page packet completely!", count, vmxferpagePacket->RangeCount+1);
1184 // Return it to the freelist
1185 SpinlockAcquire(netDevice->ReceivePacketListLock);
1186 for (i=count; i != 0; i--)
1188 entry = REMOVE_HEAD_LIST(&listHead);
1189 netvscPacket = CONTAINING_RECORD(entry, NETVSC_PACKET, ListEntry);
1191 INSERT_TAIL_LIST(&netDevice->ReceivePacketList, &netvscPacket->ListEntry);
1193 SpinlockRelease(netDevice->ReceivePacketListLock);
1195 NetVscSendReceiveCompletion(Device, vmxferpagePacket->d.TransactionId);
1197 PutNetDevice(Device);
1201 // Remove the 1st packet to represent the xfer page packet itself
1202 entry = REMOVE_HEAD_LIST(&listHead);
1203 xferpagePacket = CONTAINING_RECORD(entry, XFERPAGE_PACKET, ListEntry);
1204 xferpagePacket->Count = count - 1; // This is how much we can satisfy
1205 ASSERT(xferpagePacket->Count > 0 && xferpagePacket->Count <= vmxferpagePacket->RangeCount);
1207 if (xferpagePacket->Count != vmxferpagePacket->RangeCount)
1209 DPRINT_INFO(NETVSC, "Needed %d netvsc pkts to satisy this xfer page...got %d", vmxferpagePacket->RangeCount, xferpagePacket->Count);
1212 // Each range represents 1 RNDIS pkt that contains 1 ethernet frame
1213 for (i=0; i < (count - 1); i++)
1215 entry = REMOVE_HEAD_LIST(&listHead);
1216 netvscPacket = CONTAINING_RECORD(entry, NETVSC_PACKET, ListEntry);
1218 // Initialize the netvsc packet
1219 netvscPacket->XferPagePacket = xferpagePacket;
1220 netvscPacket->Completion.Recv.OnReceiveCompletion = NetVscOnReceiveCompletion;
1221 netvscPacket->Completion.Recv.ReceiveCompletionContext = netvscPacket;
1222 netvscPacket->Device = Device;
1223 netvscPacket->Completion.Recv.ReceiveCompletionTid = vmxferpagePacket->d.TransactionId; // Save this so that we can send it back
1225 netvscPacket->TotalDataBufferLength = vmxferpagePacket->Ranges[i].ByteCount;
1226 netvscPacket->PageBufferCount = 1;
1228 ASSERT(vmxferpagePacket->Ranges[i].ByteOffset + vmxferpagePacket->Ranges[i].ByteCount < netDevice->ReceiveBufferSize);
1230 netvscPacket->PageBuffers[0].Length = vmxferpagePacket->Ranges[i].ByteCount;
1232 start = GetPhysicalAddress((void*)((ULONG_PTR)netDevice->ReceiveBuffer + vmxferpagePacket->Ranges[i].ByteOffset));
1234 netvscPacket->PageBuffers[0].Pfn = start >> PAGE_SHIFT;
1235 endVirtual = (ULONG_PTR)netDevice->ReceiveBuffer
1236 + vmxferpagePacket->Ranges[i].ByteOffset
1237 + vmxferpagePacket->Ranges[i].ByteCount -1;
1238 end = GetPhysicalAddress((void*)endVirtual);
1240 // Calculate the page relative offset
1241 netvscPacket->PageBuffers[0].Offset = vmxferpagePacket->Ranges[i].ByteOffset & (PAGE_SIZE -1);
1242 if ((end >> PAGE_SHIFT) != (start>>PAGE_SHIFT)) {
1243 //Handle frame across multiple pages:
1244 netvscPacket->PageBuffers[0].Length =
1245 (netvscPacket->PageBuffers[0].Pfn <<PAGE_SHIFT) + PAGE_SIZE - start;
1246 bytesRemain = netvscPacket->TotalDataBufferLength - netvscPacket->PageBuffers[0].Length;
1247 for (j=1; j<NETVSC_PACKET_MAXPAGE; j++) {
1248 netvscPacket->PageBuffers[j].Offset = 0;
1249 if (bytesRemain <= PAGE_SIZE) {
1250 netvscPacket->PageBuffers[j].Length = bytesRemain;
1253 netvscPacket->PageBuffers[j].Length = PAGE_SIZE;
1254 bytesRemain -= PAGE_SIZE;
1256 netvscPacket->PageBuffers[j].Pfn =
1257 GetPhysicalAddress((void*)(endVirtual - bytesRemain)) >> PAGE_SHIFT;
1258 netvscPacket->PageBufferCount++;
1259 if (bytesRemain == 0)
1262 ASSERT(bytesRemain == 0);
1264 DPRINT_DBG(NETVSC, "[%d] - (abs offset %u len %u) => (pfn %llx, offset %u, len %u)",
1266 vmxferpagePacket->Ranges[i].ByteOffset,
1267 vmxferpagePacket->Ranges[i].ByteCount,
1268 netvscPacket->PageBuffers[0].Pfn,
1269 netvscPacket->PageBuffers[0].Offset,
1270 netvscPacket->PageBuffers[0].Length);
1272 // Pass it to the upper layer
1273 ((NETVSC_DRIVER_OBJECT*)Device->Driver)->OnReceiveCallback(Device, netvscPacket);
1275 NetVscOnReceiveCompletion(netvscPacket->Completion.Recv.ReceiveCompletionContext);
1278 ASSERT(IsListEmpty(&listHead));
1280 PutNetDevice(Device);
1281 DPRINT_EXIT(NETVSC);
1286 NetVscSendReceiveCompletion(
1287 DEVICE_OBJECT *Device,
1288 UINT64 TransactionId
1291 NVSP_MESSAGE recvcompMessage;
1295 DPRINT_DBG(NETVSC, "Sending receive completion pkt - %llx", TransactionId);
1297 recvcompMessage.Header.MessageType = NvspMessage1TypeSendRNDISPacketComplete;
1299 // FIXME: Pass in the status
1300 recvcompMessage.Messages.Version1Messages.SendRNDISPacketComplete.Status = NvspStatusSuccess;
1303 // Send the completion
1304 ret = Device->Driver->VmbusChannelInterface.SendPacket(Device,
1306 sizeof(NVSP_MESSAGE),
1308 VmbusPacketTypeCompletion,
1310 if (ret == 0) // success
1314 else if (ret == -1) // no more room...wait a bit and attempt to retry 3 times
1317 DPRINT_ERR(NETVSC, "unable to send receive completion pkt (tid %llx)...retrying %d", TransactionId, retries);
1322 goto retry_send_cmplt;
1326 DPRINT_ERR(NETVSC, "unable to send receive completion pkt (tid %llx)...give up retrying", TransactionId);
1331 DPRINT_ERR(NETVSC, "unable to send receive completion pkt - %llx", TransactionId);
1336 // Send a receive completion packet to RNDIS device (ie NetVsp)
1339 NetVscOnReceiveCompletion(
1342 NETVSC_PACKET *packet = (NETVSC_PACKET*)Context;
1343 DEVICE_OBJECT *device = (DEVICE_OBJECT*)packet->Device;
1344 NETVSC_DEVICE* netDevice;
1345 UINT64 transactionId=0;
1346 BOOL fSendReceiveComp = FALSE;
1348 DPRINT_ENTER(NETVSC);
1350 ASSERT(packet->XferPagePacket);
1352 // Even though it seems logical to do a GetOutboundNetDevice() here to send out receive completion,
1353 // we are using GetInboundNetDevice() since we may have disable outbound traffic already.
1354 netDevice = GetInboundNetDevice(device);
1357 DPRINT_ERR(NETVSC, "unable to get net device...device being destroyed?");
1358 DPRINT_EXIT(NETVSC);
1362 // Overloading use of the lock.
1363 SpinlockAcquire(netDevice->ReceivePacketListLock);
1365 ASSERT(packet->XferPagePacket->Count > 0);
1366 packet->XferPagePacket->Count--;
1368 // Last one in the line that represent 1 xfer page packet.
1369 // Return the xfer page packet itself to the freelist
1370 if (packet->XferPagePacket->Count == 0)
1372 fSendReceiveComp = TRUE;
1373 transactionId = packet->Completion.Recv.ReceiveCompletionTid;
1375 INSERT_TAIL_LIST(&netDevice->ReceivePacketList, &packet->XferPagePacket->ListEntry);
1378 // Put the packet back
1379 INSERT_TAIL_LIST(&netDevice->ReceivePacketList, &packet->ListEntry);
1380 SpinlockRelease(netDevice->ReceivePacketListLock);
1382 // Send a receive completion for the xfer page packet
1383 if (fSendReceiveComp)
1385 NetVscSendReceiveCompletion(device, transactionId);
1388 PutNetDevice(device);
1389 DPRINT_EXIT(NETVSC);
1395 NetVscOnChannelCallback(
1399 const int netPacketSize=2048;
1401 DEVICE_OBJECT *device=(DEVICE_OBJECT*)Context;
1402 NETVSC_DEVICE *netDevice;
1406 UCHAR packet[netPacketSize];
1407 VMPACKET_DESCRIPTOR *desc;
1408 UCHAR *buffer=packet;
1409 int bufferlen=netPacketSize;
1412 DPRINT_ENTER(NETVSC);
1416 netDevice = GetInboundNetDevice(device);
1419 DPRINT_ERR(NETVSC, "net device (%p) shutting down...ignoring inbound packets", netDevice);
1420 DPRINT_EXIT(NETVSC);
1426 ret = device->Driver->VmbusChannelInterface.RecvPacketRaw(device,
1436 DPRINT_DBG(NETVSC, "receive %d bytes, tid %llx", bytesRecvd, requestId);
1438 desc = (VMPACKET_DESCRIPTOR*)buffer;
1441 case VmbusPacketTypeCompletion:
1442 NetVscOnSendCompletion(device, desc);
1445 case VmbusPacketTypeDataUsingTransferPages:
1446 NetVscOnReceive(device, desc);
1450 DPRINT_ERR(NETVSC, "unhandled packet type %d, tid %llx len %d\n", desc->Type, requestId, bytesRecvd);
1455 if (bufferlen > netPacketSize)
1460 bufferlen = netPacketSize;
1465 //DPRINT_DBG(NETVSC, "nothing else to read...");
1468 if (bufferlen > netPacketSize)
1473 bufferlen = netPacketSize;
1479 else if (ret == -2) // Handle large packet
1481 buffer = MemAllocAtomic(bytesRecvd);
1484 // Try again next time around
1485 DPRINT_ERR(NETVSC, "unable to allocate buffer of size (%d)!!", bytesRecvd);
1489 bufferlen = bytesRecvd;
1497 PutNetDevice(device);
1498 DPRINT_EXIT(NETVSC);