2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS NDIS library
4 * FILE: ndis/miniport.c
5 * PURPOSE: Routines used by NDIS miniport drivers
6 * PROGRAMMERS: Casper S. Hornstrup (chorns@users.sourceforge.net)
7 * Vizzini (vizzini@plasmic.com)
9 * CSH 01/08-2000 Created
10 * 20 Aug 2003 vizzini - DMA support
11 * 3 Oct 2003 vizzini - SendPackets support
21 #undef NdisMSendComplete
25 IN NDIS_HANDLE MiniportAdapterHandle
,
26 IN PNDIS_PACKET Packet
,
27 IN NDIS_STATUS Status
);
29 /* Root of the scm database */
30 #define SERVICES_ROOT L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\"
33 * Define to 1 to get a debugger breakpoint at the end of NdisInitializeWrapper
34 * for each new miniport starting up
36 #define BREAK_ON_MINIPORT_INIT 0
39 * This has to be big enough to hold the results of querying the Route value
40 * from the Linkage key. Please re-code me to determine this dynamically.
42 #define ROUTE_DATA_SIZE 256
44 /* Number of media we know */
45 #define MEDIA_ARRAY_SIZE 15
47 static NDIS_MEDIUM MediaArray
[MEDIA_ARRAY_SIZE
] =
56 NdisMediumArcnet878_2
,
58 NdisMediumWirelessWan
,
66 /* global list and lock of Miniports NDIS has registered */
67 LIST_ENTRY MiniportListHead
;
68 KSPIN_LOCK MiniportListLock
;
70 /* global list and lock of adapters NDIS has registered */
71 LIST_ENTRY AdapterListHead
;
72 KSPIN_LOCK AdapterListLock
;
81 if ((DebugTraceLevel
& DEBUG_PACKET
) > 0) {
82 Length
= CopyPacketToBuffer(
88 DbgPrint("*** PACKET START ***");
90 for (i
= 0; i
< Length
; i
++) {
92 DbgPrint("\n%04X ", i
);
93 DbgPrint("%02X ", Buffer
[i
]);
96 DbgPrint("*** PACKET STOP ***\n");
104 UINT HeaderBufferSize
,
105 PVOID LookaheadBuffer
,
106 UINT LookaheadBufferSize
)
109 if ((DebugTraceLevel
& DEBUG_PACKET
) > 0) {
113 DbgPrint("*** RECEIVE PACKET START ***\n");
116 for (i
= 0; i
< HeaderBufferSize
; i
++) {
118 DbgPrint("\n%04X ", i
);
119 DbgPrint("%02X ", *p
++);
122 DbgPrint("\nFRAME:");
125 Length
= (LookaheadBufferSize
< 64)? LookaheadBufferSize
: 64;
126 for (i
= 0; i
< Length
; i
++) {
128 DbgPrint("\n%04X ", i
);
129 DbgPrint("%02X ", *p
++);
132 DbgPrint("\n*** RECEIVE PACKET STOP ***\n");
140 PLOGICAL_ADAPTER Adapter
,
141 NDIS_HANDLE MacReceiveContext
,
143 UINT HeaderBufferSize
,
144 PVOID LookaheadBuffer
,
145 UINT LookaheadBufferSize
,
148 * FUNCTION: Indicate received data to bound protocols
150 * Adapter = Pointer to logical adapter
151 * MacReceiveContext = MAC receive context handle
152 * HeaderBuffer = Pointer to header buffer
153 * HeaderBufferSize = Size of header buffer
154 * LookaheadBuffer = Pointer to lookahead buffer
155 * LookaheadBufferSize = Size of lookahead buffer
156 * PacketSize = Total size of received packet
160 PLIST_ENTRY CurrentEntry
;
161 PADAPTER_BINDING AdapterBinding
;
163 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called. Adapter (0x%X) HeaderBuffer (0x%X) "
164 "HeaderBufferSize (0x%X) LookaheadBuffer (0x%X) LookaheadBufferSize (0x%X).\n",
165 Adapter
, HeaderBuffer
, HeaderBufferSize
, LookaheadBuffer
, LookaheadBufferSize
));
167 MiniDisplayPacket2(HeaderBuffer
, HeaderBufferSize
, LookaheadBuffer
, LookaheadBufferSize
);
170 * XXX Think about this. This is probably broken. Spinlocks are
171 * taken out for now until i comprehend the Right Way to do this.
173 * This used to acquire the MiniportBlock spinlock and hold it until
174 * just before the call to ReceiveHandler. It would then release and
175 * subsequently re-acquire the lock.
177 * I don't see how this does any good, as it would seem he's just
178 * trying to protect the packet list. If somebody else dequeues
179 * a packet, we are in fact in bad shape, but we don't want to
180 * necessarily call the receive handler at elevated irql either.
182 * therefore: We *are* going to call the receive handler at high irql
183 * (due to holding the lock) for now, and eventually we have to
184 * figure out another way to protect this packet list.
186 * UPDATE: this is busted; this results in a recursive lock acquisition.
188 //NDIS_DbgPrint(MAX_TRACE, ("acquiring miniport block lock\n"));
189 //KeAcquireSpinLock(&Adapter->NdisMiniportBlock.Lock, &OldIrql);
191 CurrentEntry
= Adapter
->ProtocolListHead
.Flink
;
192 NDIS_DbgPrint(DEBUG_MINIPORT
, ("CurrentEntry = %x\n", CurrentEntry
));
194 if (CurrentEntry
== &Adapter
->ProtocolListHead
)
196 NDIS_DbgPrint(DEBUG_MINIPORT
, ("WARNING: No upper protocol layer.\n"));
199 while (CurrentEntry
!= &Adapter
->ProtocolListHead
)
201 AdapterBinding
= CONTAINING_RECORD(CurrentEntry
, ADAPTER_BINDING
, AdapterListEntry
);
202 NDIS_DbgPrint(DEBUG_MINIPORT
, ("AdapterBinding = %x\n", AdapterBinding
));
205 /* KeReleaseSpinLock(&Adapter->NdisMiniportBlock.Lock, OldIrql); */
210 NDIS_DbgPrint(MIN_TRACE
, ("AdapterBinding was null\n"));
214 if(!AdapterBinding
->ProtocolBinding
)
216 NDIS_DbgPrint(MIN_TRACE
, ("AdapterBinding->ProtocolBinding was null\n"));
220 if(!AdapterBinding
->ProtocolBinding
->Chars
.ReceiveHandler
)
222 NDIS_DbgPrint(MIN_TRACE
, ("AdapterBinding->ProtocolBinding->Chars.ReceiveHandler was null\n"));
229 ("XXX (%x) %x %x %x %x %x %x %x XXX\n",
230 *AdapterBinding
->ProtocolBinding
->Chars
.ReceiveHandler
,
231 AdapterBinding
->NdisOpenBlock
.NdisCommonOpenBlock
.ProtocolBindingContext
,
239 /* call the receive handler */
240 (*AdapterBinding
->ProtocolBinding
->Chars
.ReceiveHandler
)(
241 AdapterBinding
->NdisOpenBlock
.NdisCommonOpenBlock
.ProtocolBindingContext
,
250 /* KeAcquireSpinLock(&Adapter->NdisMiniportBlock.Lock, &OldIrql); */
252 CurrentEntry
= CurrentEntry
->Flink
;
255 //KeReleaseSpinLock(&Adapter->NdisMiniportBlock.Lock, OldIrql);
257 NDIS_DbgPrint(MAX_TRACE
, ("Leaving.\n"));
262 MiniIndicateReceivePacket(
263 IN NDIS_HANDLE Miniport
,
264 IN PPNDIS_PACKET PacketArray
,
265 IN UINT NumberOfPackets
)
267 * FUNCTION: receives miniport packet array indications
269 * Miniport: Miniport handle for the adapter
270 * PacketArray: pointer to a list of packet pointers to indicate
271 * NumberOfPackets: number of packets to indicate
273 * - This currently is a big temporary hack. In the future this should
274 * call ProtocolReceivePacket() on each bound protocol if it exists.
275 * For now it just mimics NdisMEthIndicateReceive.
280 for(i
= 0; i
< NumberOfPackets
; i
++)
282 PCHAR PacketBuffer
= 0;
283 UINT PacketLength
= 0;
284 PNDIS_BUFFER NdisBuffer
= 0;
286 #define PACKET_TAG (('k' << 24) + ('P' << 16) + ('D' << 8) + 'N')
288 NdisAllocateMemoryWithTag((PVOID
)&PacketBuffer
, 1518, PACKET_TAG
);
291 NDIS_DbgPrint(MIN_TRACE
, ("insufficient resources\n"));
295 NdisQueryPacket(PacketArray
[i
], NULL
, NULL
, &NdisBuffer
, NULL
);
299 PNDIS_BUFFER CurrentBuffer
;
303 NdisQueryBuffer(NdisBuffer
, &BufferVa
, &BufferLen
);
304 memcpy(PacketBuffer
+ PacketLength
, BufferVa
, BufferLen
);
305 PacketLength
+= BufferLen
;
307 CurrentBuffer
= NdisBuffer
;
308 NdisGetNextBuffer(CurrentBuffer
, &NdisBuffer
);
311 NDIS_DbgPrint(MID_TRACE
, ("indicating a %d-byte packet\n", PacketLength
));
313 MiniIndicateData(Miniport
, NULL
, PacketBuffer
, 14, PacketBuffer
+14, PacketLength
-14, PacketLength
-14);
315 NdisFreeMemory(PacketBuffer
, 0, 0);
322 IN NDIS_HANDLE MiniportAdapterHandle
,
323 IN NDIS_STATUS Status
,
324 IN BOOLEAN AddressingReset
)
332 IN NDIS_HANDLE MiniportAdapterHandle
,
333 IN PNDIS_PACKET Packet
,
334 IN NDIS_STATUS Status
)
336 * FUNCTION: Forwards a message to the initiating protocol saying
337 * that a packet was handled
339 * NdisAdapterHandle = Handle input to MiniportInitialize
340 * Packet = Pointer to NDIS packet that was sent
341 * Status = Status of send operation
344 PADAPTER_BINDING AdapterBinding
;
346 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
348 AdapterBinding
= (PADAPTER_BINDING
)Packet
->Reserved
[0];
350 (*AdapterBinding
->ProtocolBinding
->Chars
.SendCompleteHandler
)(
351 AdapterBinding
->NdisOpenBlock
.NdisCommonOpenBlock
.ProtocolBindingContext
,
358 MiniSendResourcesAvailable(
359 IN NDIS_HANDLE MiniportAdapterHandle
)
366 MiniTransferDataComplete(
367 IN NDIS_HANDLE MiniportAdapterHandle
,
368 IN PNDIS_PACKET Packet
,
369 IN NDIS_STATUS Status
,
370 IN UINT BytesTransferred
)
372 PADAPTER_BINDING AdapterBinding
;
374 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
376 AdapterBinding
= (PADAPTER_BINDING
)Packet
->Reserved
[0];
378 (*AdapterBinding
->ProtocolBinding
->Chars
.SendCompleteHandler
)(
379 AdapterBinding
->NdisOpenBlock
.NdisCommonOpenBlock
.ProtocolBindingContext
,
386 MiniAdapterHasAddress(
387 PLOGICAL_ADAPTER Adapter
,
390 * FUNCTION: Determines whether a packet has the same destination address as an adapter
392 * Adapter = Pointer to logical adapter object
393 * Packet = Pointer to NDIS packet
395 * TRUE if the destination address is that of the adapter, FALSE if not
401 PNDIS_BUFFER NdisBuffer
;
404 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
409 NDIS_DbgPrint(MID_TRACE
, ("Adapter object was null\n"));
415 NDIS_DbgPrint(MID_TRACE
, ("Packet was null\n"));
420 NdisQueryPacket(Packet
, NULL
, NULL
, &NdisBuffer
, NULL
);
424 NDIS_DbgPrint(MID_TRACE
, ("Packet contains no buffers.\n"));
428 NdisQueryBuffer(NdisBuffer
, (PVOID
)&Start2
, &BufferLength
);
430 /* FIXME: Should handle fragmented packets */
432 switch (Adapter
->NdisMiniportBlock
.MediaType
)
434 case NdisMedium802_3
:
435 Length
= ETH_LENGTH_OF_ADDRESS
;
436 /* Destination address is the first field */
440 NDIS_DbgPrint(MIN_TRACE
, ("Adapter has unsupported media type (0x%X).\n", Adapter
->NdisMiniportBlock
.MediaType
));
444 if (BufferLength
< Length
)
446 NDIS_DbgPrint(MID_TRACE
, ("Buffer is too small.\n"));
450 Start1
= (PUCHAR
)&Adapter
->Address
;
451 NDIS_DbgPrint(MAX_TRACE
, ("packet address: %x:%x:%x:%x:%x:%x adapter address: %x:%x:%x:%x:%x:%x\n",
452 *((char *)Start1
), *(((char *)Start1
)+1), *(((char *)Start1
)+2), *(((char *)Start1
)+3), *(((char *)Start1
)+4), *(((char *)Start1
)+5),
453 *((char *)Start2
), *(((char *)Start2
)+1), *(((char *)Start2
)+2), *(((char *)Start2
)+3), *(((char *)Start2
)+4), *(((char *)Start2
)+5))
456 return (RtlCompareMemory((PVOID
)Start1
, (PVOID
)Start2
, Length
) == Length
);
462 PNDIS_STRING AdapterName
)
464 * FUNCTION: Finds an adapter object by name
466 * AdapterName = Pointer to name of adapter
468 * Pointer to logical adapter object, or NULL if none was found.
469 * If found, the adapter is referenced for the caller. The caller
470 * is responsible for dereferencing after use
474 PLIST_ENTRY CurrentEntry
;
475 PLOGICAL_ADAPTER Adapter
= 0;
479 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
481 if(IsListEmpty(&AdapterListHead
))
483 NDIS_DbgPrint(DEBUG_MINIPORT
, ("No registered miniports for protocol to bind to\n"));
487 KeAcquireSpinLock(&AdapterListLock
, &OldIrql
);
491 CurrentEntry
= AdapterListHead
.Flink
;
493 while (CurrentEntry
!= &AdapterListHead
)
495 Adapter
= CONTAINING_RECORD(CurrentEntry
, LOGICAL_ADAPTER
, ListEntry
);
499 NDIS_DbgPrint(DEBUG_MINIPORT
, ("AdapterName = %wZ\n", AdapterName
));
500 NDIS_DbgPrint(DEBUG_MINIPORT
, ("DeviceName = %wZ\n", &Adapter
->NdisMiniportBlock
.MiniportName
));
502 if (RtlCompareUnicodeString(AdapterName
, &Adapter
->NdisMiniportBlock
.MiniportName
, TRUE
) == 0)
504 ReferenceObject(Adapter
);
509 CurrentEntry
= CurrentEntry
->Flink
;
513 KeReleaseSpinLock(&AdapterListLock
, OldIrql
);
517 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Leaving. Adapter found at 0x%x\n", Adapter
));
521 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Leaving (adapter not found).\n"));
529 MiniQueryInformation(
530 PLOGICAL_ADAPTER Adapter
,
535 * FUNCTION: Queries a logical adapter for properties
537 * Adapter = Pointer to the logical adapter object to query
538 * Oid = Specifies the Object ID to query for
539 * Size = If non-zero overrides the length in the adapter object
540 * BytesWritten = Address of buffer to place number of bytes written
542 * If the specified buffer is too small, a new buffer is allocated,
543 * and the query is attempted again
545 * Status of operation
547 * Is there any way to use the buffer provided by the protocol?
550 NDIS_STATUS NdisStatus
;
553 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
555 if (Adapter
->QueryBufferLength
== 0)
557 /* XXX is 32 the right number? */
558 Adapter
->QueryBuffer
= ExAllocatePool(NonPagedPool
, (Size
== 0)? 32 : Size
);
560 if (!Adapter
->QueryBuffer
)
562 NDIS_DbgPrint(MIN_TRACE
, ("Insufficient resources.\n"));
563 return NDIS_STATUS_RESOURCES
;
567 Adapter
->QueryBufferLength
= (Size
== 0)? 32 : Size
;
570 /* this is the third time i've seen this conditional */
571 BytesNeeded
= (Size
== 0)? Adapter
->QueryBufferLength
: Size
;
573 /* call the miniport's queryinfo handler */
574 NdisStatus
= (*Adapter
->Miniport
->Chars
.QueryInformationHandler
)(
575 Adapter
->NdisMiniportBlock
.MiniportAdapterContext
,
577 Adapter
->QueryBuffer
,
582 /* XXX is status_pending part of success macro? */
583 if ((NT_SUCCESS(NdisStatus
)) || (NdisStatus
== NDIS_STATUS_PENDING
))
585 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Miniport returned status (0x%X).\n", NdisStatus
));
589 if (NdisStatus
== NDIS_STATUS_INVALID_LENGTH
)
591 ExFreePool(Adapter
->QueryBuffer
);
593 Adapter
->QueryBufferLength
+= BytesNeeded
;
594 Adapter
->QueryBuffer
= ExAllocatePool(NonPagedPool
, Adapter
->QueryBufferLength
);
596 if (!Adapter
->QueryBuffer
)
598 NDIS_DbgPrint(MIN_TRACE
, ("Insufficient resources.\n"));
599 return NDIS_STATUS_RESOURCES
;
602 NdisStatus
= (*Adapter
->Miniport
->Chars
.QueryInformationHandler
)(
603 Adapter
->NdisMiniportBlock
.MiniportAdapterContext
,
605 Adapter
->QueryBuffer
,
606 Adapter
->QueryBufferLength
,
618 PLOGICAL_ADAPTER Adapter
,
619 NDIS_WORK_ITEM_TYPE WorkItemType
,
620 PVOID WorkItemContext
)
622 * FUNCTION: Queues a work item for execution at a later time
624 * Adapter = Pointer to the logical adapter object to queue work item on
625 * WorkItemType = Type of work item to queue
626 * WorkItemContext = Pointer to context information for work item
628 * Adapter lock must be held when called
630 * Status of operation
633 PNDIS_MINIPORT_WORK_ITEM Item
;
635 NDIS_DbgPrint(MAX_TRACE
, ("Called.\n"));
638 ASSERT(KeGetCurrentIrql() >= DISPATCH_LEVEL
);
641 if (Adapter
->WorkQueueLevel
< NDIS_MINIPORT_WORK_QUEUE_SIZE
- 1)
643 Item
= &Adapter
->WorkQueue
[Adapter
->WorkQueueLevel
];
644 Adapter
->WorkQueueLevel
++;
649 Item
= ExAllocatePool(NonPagedPool
, sizeof(NDIS_MINIPORT_WORK_ITEM
));
652 NDIS_DbgPrint(MIN_TRACE
, ("Insufficient resources.\n"));
653 return NDIS_STATUS_RESOURCES
;
657 Item
->WorkItemType
= WorkItemType
;
658 Item
->WorkItemContext
= WorkItemContext
;
660 /* safe due to adapter lock held */
661 Item
->Link
.Next
= NULL
;
662 if (!Adapter
->WorkQueueHead
)
664 Adapter
->WorkQueueHead
= Item
;
665 Adapter
->WorkQueueTail
= Item
;
669 Adapter
->WorkQueueTail
->Link
.Next
= (PSINGLE_LIST_ENTRY
)Item
;
670 Adapter
->WorkQueueTail
= Item
;
673 KeInsertQueueDpc(&Adapter
->MiniportDpc
, NULL
, NULL
);
675 return NDIS_STATUS_SUCCESS
;
682 PLOGICAL_ADAPTER Adapter
,
683 NDIS_WORK_ITEM_TYPE
*WorkItemType
,
684 PVOID
*WorkItemContext
)
686 * FUNCTION: Dequeues a work item from the work queue of a logical adapter
688 * Adapter = Pointer to the logical adapter object to dequeue work item from
689 * WorkItemType = Address of buffer for work item type
690 * WorkItemContext = Address of buffer for pointer to context information
692 * Adapter lock must be held when called
694 * Status of operation
697 PNDIS_MINIPORT_WORK_ITEM Item
;
699 NDIS_DbgPrint(MAX_TRACE
, ("Called.\n"));
701 Item
= Adapter
->WorkQueueHead
;
705 /* safe due to adapter lock held */
706 Adapter
->WorkQueueHead
= (PNDIS_MINIPORT_WORK_ITEM
)Item
->Link
.Next
;
708 if (Item
== Adapter
->WorkQueueTail
)
709 Adapter
->WorkQueueTail
= NULL
;
711 *WorkItemType
= Item
->WorkItemType
;
712 *WorkItemContext
= Item
->WorkItemContext
;
716 return NDIS_STATUS_SUCCESS
;
719 return NDIS_STATUS_FAILURE
;
725 PLOGICAL_ADAPTER Adapter
,
726 PNDIS_REQUEST NdisRequest
)
728 * FUNCTION: Sends a request to a miniport
730 * Adapter = Pointer to logical adapter object
731 * NdisRequest = Pointer to NDIS request structure describing request
733 * Status of operation
736 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
738 Adapter
->NdisMiniportBlock
.MediaRequest
= NdisRequest
;
740 switch (NdisRequest
->RequestType
)
742 case NdisRequestQueryInformation
:
743 return (*Adapter
->Miniport
->Chars
.QueryInformationHandler
)(
744 Adapter
->NdisMiniportBlock
.MiniportAdapterContext
,
745 NdisRequest
->DATA
.QUERY_INFORMATION
.Oid
,
746 NdisRequest
->DATA
.QUERY_INFORMATION
.InformationBuffer
,
747 NdisRequest
->DATA
.QUERY_INFORMATION
.InformationBufferLength
,
748 (PULONG
)&NdisRequest
->DATA
.QUERY_INFORMATION
.BytesWritten
,
749 (PULONG
)&NdisRequest
->DATA
.QUERY_INFORMATION
.BytesNeeded
);
752 case NdisRequestSetInformation
:
753 return (*Adapter
->Miniport
->Chars
.SetInformationHandler
)(
754 Adapter
->NdisMiniportBlock
.MiniportAdapterContext
,
755 NdisRequest
->DATA
.SET_INFORMATION
.Oid
,
756 NdisRequest
->DATA
.SET_INFORMATION
.InformationBuffer
,
757 NdisRequest
->DATA
.SET_INFORMATION
.InformationBufferLength
,
758 (PULONG
)&NdisRequest
->DATA
.SET_INFORMATION
.BytesRead
,
759 (PULONG
)&NdisRequest
->DATA
.SET_INFORMATION
.BytesNeeded
);
763 return NDIS_STATUS_FAILURE
;
768 #undef NdisMQueryInformationComplete
774 NdisMQueryInformationComplete(
775 IN NDIS_HANDLE MiniportAdapterHandle
,
776 IN NDIS_STATUS Status
)
778 PNDIS_MINIPORT_BLOCK MiniportBlock
=
779 (PNDIS_MINIPORT_BLOCK
)MiniportAdapterHandle
;
780 ASSERT(MiniportBlock
);
781 if( MiniportBlock
->QueryCompleteHandler
)
782 (MiniportBlock
->QueryCompleteHandler
)(MiniportAdapterHandle
, Status
);
786 VOID STDCALL
MiniportDpc(
788 IN PVOID DeferredContext
,
789 IN PVOID SystemArgument1
,
790 IN PVOID SystemArgument2
)
792 * FUNCTION: Deferred routine to handle serialization
794 * Dpc = Pointer to DPC object
795 * DeferredContext = Pointer to context information (LOGICAL_ADAPTER)
796 * SystemArgument1 = Unused
797 * SystemArgument2 = Unused
800 NDIS_STATUS NdisStatus
;
801 PVOID WorkItemContext
;
802 NDIS_WORK_ITEM_TYPE WorkItemType
;
803 PLOGICAL_ADAPTER Adapter
= GET_LOGICAL_ADAPTER(DeferredContext
);
805 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
807 NdisStatus
= MiniDequeueWorkItem(Adapter
, &WorkItemType
, &WorkItemContext
);
809 if (NdisStatus
== NDIS_STATUS_SUCCESS
)
811 switch (WorkItemType
)
813 case NdisWorkItemSend
:
815 * called by ProSend when protocols want to send packets to the miniport
818 MiniDisplayPacket((PNDIS_PACKET
)WorkItemContext
);
820 if(Adapter
->Miniport
->Chars
.SendPacketsHandler
)
822 NDIS_DbgPrint(MAX_TRACE
, ("Calling miniport's SendPackets handler\n"));
825 * XXX assumes single-packet - prolly OK since we'll call something
826 * different on multi-packet sends
828 (*Adapter
->Miniport
->Chars
.SendPacketsHandler
)(
829 Adapter
->NdisMiniportBlock
.MiniportAdapterContext
, (PPNDIS_PACKET
)&WorkItemContext
, 1);
831 NDIS_GET_PACKET_STATUS((PNDIS_PACKET
)WorkItemContext
);
833 NDIS_DbgPrint(MAX_TRACE
, ("back from miniport's SendPackets handler\n"));
837 NDIS_DbgPrint(MAX_TRACE
, ("Calling miniport's Send handler\n"));
839 NdisStatus
= (*Adapter
->Miniport
->Chars
.SendHandler
)(
840 Adapter
->NdisMiniportBlock
.MiniportAdapterContext
, (PNDIS_PACKET
)WorkItemContext
, 0);
842 NDIS_DbgPrint(MAX_TRACE
, ("back from miniport's Send handler\n"));
844 if( NdisStatus
!= NDIS_STATUS_PENDING
) {
846 ( Adapter
, (PNDIS_PACKET
)WorkItemContext
, NdisStatus
);
847 Adapter
->MiniportBusy
= FALSE
;
851 case NdisWorkItemSendLoopback
:
853 * called by ProSend when protocols want to send loopback packets
855 /* XXX atm ProIndicatePacket sends a packet up via the loopback adapter only */
856 NdisStatus
= ProIndicatePacket(Adapter
, (PNDIS_PACKET
)WorkItemContext
);
857 MiniSendComplete((NDIS_HANDLE
)Adapter
, (PNDIS_PACKET
)WorkItemContext
, NdisStatus
);
860 case NdisWorkItemReturnPackets
:
863 case NdisWorkItemResetRequested
:
866 case NdisWorkItemResetInProgress
:
869 case NdisWorkItemHalt
:
872 case NdisWorkItemMiniportCallback
:
875 case NdisWorkItemRequest
:
876 NdisStatus
= MiniDoRequest(Adapter
, (PNDIS_REQUEST
)WorkItemContext
);
878 if (NdisStatus
== NDIS_STATUS_PENDING
)
881 switch (((PNDIS_REQUEST
)WorkItemContext
)->RequestType
)
883 case NdisRequestQueryInformation
:
884 NdisMQueryInformationComplete((NDIS_HANDLE
)Adapter
, NdisStatus
);
887 case NdisRequestSetInformation
:
888 NdisMSetInformationComplete((NDIS_HANDLE
)Adapter
, NdisStatus
);
892 NDIS_DbgPrint(MIN_TRACE
, ("Unknown NDIS request type.\n"));
898 NDIS_DbgPrint(MIN_TRACE
, ("Unknown NDIS work item type (%d).\n", WorkItemType
));
911 IN NDIS_HANDLE LogHandle
)
923 IN NDIS_HANDLE MiniportAdapterHandle
,
925 OUT PNDIS_HANDLE LogHandle
)
929 return NDIS_STATUS_FAILURE
;
938 NdisMDeregisterAdapterShutdownHandler(
939 IN NDIS_HANDLE MiniportHandle
)
941 * FUNCTION: de-registers a shutdown handler
942 * ARGUMENTS: MiniportHandle: Handle passed into MiniportInitialize
945 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
946 PLOGICAL_ADAPTER Adapter
= (PLOGICAL_ADAPTER
)MiniportHandle
;
948 if(Adapter
->BugcheckContext
->ShutdownHandler
)
949 KeDeregisterBugCheckCallback(Adapter
->BugcheckContext
->CallbackRecord
);
959 IN NDIS_HANDLE LogHandle
)
964 #undef NdisMIndicateStatus
972 IN NDIS_HANDLE MiniportAdapterHandle
,
973 IN NDIS_STATUS GeneralStatus
,
974 IN PVOID StatusBuffer
,
975 IN UINT StatusBufferSize
)
980 #undef NdisMIndicateStatusComplete
987 NdisMIndicateStatusComplete(
988 IN NDIS_HANDLE MiniportAdapterHandle
)
999 NdisInitializeWrapper(
1000 OUT PNDIS_HANDLE NdisWrapperHandle
,
1001 IN PVOID SystemSpecific1
,
1002 IN PVOID SystemSpecific2
,
1003 IN PVOID SystemSpecific3
)
1005 * FUNCTION: Notifies the NDIS library that a new miniport is initializing
1007 * NdisWrapperHandle = Address of buffer to place NDIS wrapper handle
1008 * SystemSpecific1 = Pointer to the driver's driver object
1009 * SystemSpecific2 = Pointer to the driver's registry path
1010 * SystemSpecific3 = Always NULL
1012 * - SystemSpecific2 goes invalid so we copy it
1015 PMINIPORT_DRIVER Miniport
;
1016 PUNICODE_STRING RegistryPath
;
1017 WCHAR
*RegistryBuffer
;
1019 NDIS_DbgPrint(MAX_TRACE
, ("Called.\n"));
1021 ASSERT(NdisWrapperHandle
);
1023 *NdisWrapperHandle
= NULL
;
1025 #if BREAK_ON_MINIPORT_INIT
1026 __asm__ ("int $3\n");
1029 Miniport
= ExAllocatePool(NonPagedPool
, sizeof(MINIPORT_DRIVER
));
1033 NDIS_DbgPrint(MIN_TRACE
, ("Insufficient resources.\n"));
1037 RtlZeroMemory(Miniport
, sizeof(MINIPORT_DRIVER
));
1039 KeInitializeSpinLock(&Miniport
->Lock
);
1041 Miniport
->RefCount
= 1;
1043 Miniport
->DriverObject
= (PDRIVER_OBJECT
)SystemSpecific1
;
1045 /* set the miniport's driver registry path */
1046 RegistryPath
= ExAllocatePool(PagedPool
, sizeof(UNICODE_STRING
));
1049 NDIS_DbgPrint(MIN_TRACE
, ("Insufficient resources.\n"));
1053 RegistryPath
->Length
= ((PUNICODE_STRING
)SystemSpecific2
)->Length
;
1054 RegistryPath
->MaximumLength
= RegistryPath
->Length
+ sizeof(WCHAR
); /* room for 0-term */
1056 RegistryBuffer
= ExAllocatePool(PagedPool
, RegistryPath
->MaximumLength
);
1059 NDIS_DbgPrint(MIN_TRACE
, ("Insufficient resources.\n"));
1063 RtlCopyMemory(RegistryBuffer
, ((PUNICODE_STRING
)SystemSpecific2
)->Buffer
, RegistryPath
->Length
);
1064 RegistryBuffer
[RegistryPath
->Length
/sizeof(WCHAR
)] = 0;
1066 RegistryPath
->Buffer
= RegistryBuffer
;
1067 Miniport
->RegistryPath
= RegistryPath
;
1069 InitializeListHead(&Miniport
->AdapterListHead
);
1071 /* Put miniport in global miniport list */
1072 ExInterlockedInsertTailList(&MiniportListHead
, &Miniport
->ListEntry
, &MiniportListLock
);
1074 *NdisWrapperHandle
= Miniport
;
1078 VOID STDCALL
NdisIBugcheckCallback(
1082 * FUNCTION: Internal callback for handling bugchecks - calls adapter's shutdown handler
1084 * Buffer: Pointer to a bugcheck callback context
1088 PMINIPORT_BUGCHECK_CONTEXT Context
= (PMINIPORT_BUGCHECK_CONTEXT
)Buffer
;
1089 ADAPTER_SHUTDOWN_HANDLER sh
= (ADAPTER_SHUTDOWN_HANDLER
)Context
->ShutdownHandler
;
1091 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
1094 sh(Context
->DriverContext
);
1103 NdisMRegisterAdapterShutdownHandler(
1104 IN NDIS_HANDLE MiniportHandle
,
1105 IN PVOID ShutdownContext
,
1106 IN ADAPTER_SHUTDOWN_HANDLER ShutdownHandler
)
1108 * FUNCTION: Register a shutdown handler for an adapter
1110 * MiniportHandle: Handle originally passed into MiniportInitialize
1111 * ShutdownContext: Pre-initialized bugcheck context
1112 * ShutdownHandler: Function to call to handle the bugcheck
1114 * - I'm not sure about ShutdownContext
1115 * - FIXME - memory leak below
1118 PLOGICAL_ADAPTER Adapter
= (PLOGICAL_ADAPTER
)MiniportHandle
;
1119 PMINIPORT_BUGCHECK_CONTEXT BugcheckContext
= Adapter
->BugcheckContext
;
1121 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Called.\n"));
1126 BugcheckContext
= ExAllocatePool(NonPagedPool
, sizeof(MINIPORT_BUGCHECK_CONTEXT
));
1127 if(!BugcheckContext
)
1129 NDIS_DbgPrint(MIN_TRACE
, ("Insufficient resources.\n"));
1133 BugcheckContext
->ShutdownHandler
= ShutdownHandler
;
1134 BugcheckContext
->DriverContext
= ShutdownContext
;
1136 /* not sure if this needs to be initialized or not... oh well, it's a leak. */
1137 BugcheckContext
->CallbackRecord
= ExAllocatePool(NonPagedPool
, sizeof(KBUGCHECK_CALLBACK_RECORD
));
1139 KeRegisterBugCheckCallback(BugcheckContext
->CallbackRecord
, NdisIBugcheckCallback
,
1140 BugcheckContext
, sizeof(BugcheckContext
), (PUCHAR
)"Ndis Miniport");
1146 PLOGICAL_ADAPTER Adapter
,
1147 NDIS_OID AddressOID
)
1149 * FUNCTION: Queries miniport for information
1151 * Adapter = Pointer to logical adapter
1152 * AddressOID = OID to use to query for current address
1154 * Status of operation
1158 NDIS_STATUS NdisStatus
;
1160 NDIS_DbgPrint(MAX_TRACE
, ("Called.\n"));
1162 /* Get MAC options for adapter */
1163 NdisStatus
= MiniQueryInformation(Adapter
, OID_GEN_MAC_OPTIONS
, 0, &BytesWritten
);
1165 if (NdisStatus
!= NDIS_STATUS_SUCCESS
)
1167 NDIS_DbgPrint(MIN_TRACE
, ("OID_GEN_MAC_OPTIONS failed. NdisStatus (0x%X).\n", NdisStatus
));
1171 RtlCopyMemory(&Adapter
->NdisMiniportBlock
.MacOptions
, Adapter
->QueryBuffer
, sizeof(UINT
));
1173 NDIS_DbgPrint(DEBUG_MINIPORT
, ("MacOptions (0x%X).\n", Adapter
->NdisMiniportBlock
.MacOptions
));
1175 /* Get current hardware address of adapter */
1176 NdisStatus
= MiniQueryInformation(Adapter
, AddressOID
, 0, &BytesWritten
);
1178 if (NdisStatus
!= NDIS_STATUS_SUCCESS
)
1180 NDIS_DbgPrint(MIN_TRACE
, ("Address OID (0x%X) failed. NdisStatus (0x%X).\n", AddressOID
, NdisStatus
));
1184 RtlCopyMemory(&Adapter
->Address
, Adapter
->QueryBuffer
, Adapter
->AddressLength
);
1189 PUCHAR A
= (PUCHAR
)&Adapter
->Address
.Type
.Medium802_3
;
1191 NDIS_DbgPrint(MAX_TRACE
, ("Adapter address is (%02X %02X %02X %02X %02X %02X).\n", A
[0], A
[1], A
[2], A
[3], A
[4], A
[5]));
1195 /* Get maximum lookahead buffer size of adapter */
1196 NdisStatus
= MiniQueryInformation(Adapter
, OID_GEN_MAXIMUM_LOOKAHEAD
, 0, &BytesWritten
);
1198 if (NdisStatus
!= NDIS_STATUS_SUCCESS
)
1200 NDIS_DbgPrint(MIN_TRACE
, ("OID_GEN_MAXIMUM_LOOKAHEAD failed. NdisStatus (0x%X).\n", NdisStatus
));
1204 Adapter
->NdisMiniportBlock
.MaximumLookahead
= *((PULONG
)Adapter
->QueryBuffer
);
1206 NDIS_DbgPrint(DEBUG_MINIPORT
, ("MaxLookaheadLength (0x%X).\n", Adapter
->NdisMiniportBlock
.MaximumLookahead
));
1208 /* Get current lookahead buffer size of adapter */
1209 NdisStatus
= MiniQueryInformation(Adapter
, OID_GEN_CURRENT_LOOKAHEAD
, 0, &BytesWritten
);
1211 if (NdisStatus
!= NDIS_STATUS_SUCCESS
)
1213 NDIS_DbgPrint(MIN_TRACE
, ("OID_GEN_CURRENT_LOOKAHEAD failed. NdisStatus (0x%X).\n", NdisStatus
));
1217 Adapter
->NdisMiniportBlock
.CurrentLookahead
= *((PULONG
)Adapter
->QueryBuffer
);
1219 NDIS_DbgPrint(DEBUG_MINIPORT
, ("CurLookaheadLength (0x%X).\n", Adapter
->NdisMiniportBlock
.CurrentLookahead
));
1221 if (Adapter
->NdisMiniportBlock
.MaximumLookahead
!= 0)
1223 Adapter
->LookaheadLength
= Adapter
->NdisMiniportBlock
.MaximumLookahead
+ Adapter
->MediumHeaderSize
;
1224 Adapter
->LookaheadBuffer
= ExAllocatePool(NonPagedPool
, Adapter
->LookaheadLength
);
1226 if (!Adapter
->LookaheadBuffer
)
1227 return NDIS_STATUS_RESOURCES
;
1230 return STATUS_SUCCESS
;
1236 NdisIForwardIrpAndWaitCompletionRoutine(
1241 PKEVENT Event
= Context
;
1243 if (Irp
->PendingReturned
)
1244 KeSetEvent(Event
, IO_NO_INCREMENT
, FALSE
);
1246 return STATUS_MORE_PROCESSING_REQUIRED
;
1252 NdisIForwardIrpAndWait(PLOGICAL_ADAPTER Adapter
, PIRP Irp
)
1257 KeInitializeEvent(&Event
, NotificationEvent
, FALSE
);
1258 IoCopyCurrentIrpStackLocationToNext(Irp
);
1259 IoSetCompletionRoutine(Irp
, NdisIForwardIrpAndWaitCompletionRoutine
, &Event
,
1261 Status
= IoCallDriver(Adapter
->NdisMiniportBlock
.NextDeviceObject
, Irp
);
1262 if (Status
== STATUS_PENDING
)
1264 KeWaitForSingleObject(&Event
, Executive
, KernelMode
, FALSE
, NULL
);
1265 Status
= Irp
->IoStatus
.Status
;
1273 NdisIPnPStartDevice(
1274 IN PDEVICE_OBJECT DeviceObject
,
1277 * FUNCTION: Handle the PnP start device event
1279 * DeviceObejct = Functional Device Object
1280 * Irp = IRP_MN_START_DEVICE I/O request packet
1282 * Status of operation
1285 PIO_STACK_LOCATION Stack
= IoGetCurrentIrpStackLocation(Irp
);
1286 PLOGICAL_ADAPTER Adapter
= (PLOGICAL_ADAPTER
)DeviceObject
->DeviceExtension
;
1287 NDIS_WRAPPER_CONTEXT WrapperContext
;
1288 NDIS_STATUS NdisStatus
;
1289 NDIS_STATUS OpenErrorStatus
;
1291 UINT SelectedMediumIndex
= 0;
1292 NDIS_OID AddressOID
;
1293 BOOLEAN Success
= FALSE
;
1294 ULONG ResourceCount
;
1295 ULONG ResourceListSize
;
1296 UNICODE_STRING ParamName
;
1297 PNDIS_CONFIGURATION_PARAMETER ConfigParam
;
1298 NDIS_HANDLE ConfigHandle
;
1300 /* FIXME - KIRQL OldIrql; */
1303 * Prepare wrapper context used by HW and configuration routines.
1306 Status
= IoOpenDeviceRegistryKey(
1307 Adapter
->NdisMiniportBlock
.PhysicalDeviceObject
, PLUGPLAY_REGKEY_DRIVER
,
1308 KEY_ALL_ACCESS
, &WrapperContext
.RegistryHandle
);
1309 if (!NT_SUCCESS(Status
))
1311 NDIS_DbgPrint(MIN_TRACE
,("failed to open adapter-specific reg key\n"));
1315 NDIS_DbgPrint(MAX_TRACE
, ("opened device reg key\n"));
1317 WrapperContext
.DeviceObject
= Adapter
->NdisMiniportBlock
.DeviceObject
;
1320 * Store the adapter resources used by HW routines such as
1321 * NdisMQueryAdapterResources.
1324 if (Stack
->Parameters
.StartDevice
.AllocatedResources
!= NULL
&&
1325 Stack
->Parameters
.StartDevice
.AllocatedResourcesTranslated
!= NULL
)
1327 ResourceCount
= Stack
->Parameters
.StartDevice
.AllocatedResources
->List
[0].
1328 PartialResourceList
.Count
;
1330 FIELD_OFFSET(CM_RESOURCE_LIST
, List
[0].PartialResourceList
.
1331 PartialDescriptors
[ResourceCount
]);
1333 Adapter
->NdisMiniportBlock
.AllocatedResources
=
1334 ExAllocatePool(PagedPool
, ResourceListSize
);
1335 if (Adapter
->NdisMiniportBlock
.AllocatedResources
== NULL
)
1337 return STATUS_INSUFFICIENT_RESOURCES
;
1340 Adapter
->NdisMiniportBlock
.AllocatedResourcesTranslated
=
1341 ExAllocatePool(PagedPool
, ResourceListSize
);
1342 if (Adapter
->NdisMiniportBlock
.AllocatedResourcesTranslated
== NULL
)
1344 ExFreePool(Adapter
->NdisMiniportBlock
.AllocatedResources
);
1345 Adapter
->NdisMiniportBlock
.AllocatedResources
= NULL
;
1346 return STATUS_INSUFFICIENT_RESOURCES
;
1349 RtlCopyMemory(Adapter
->NdisMiniportBlock
.AllocatedResources
,
1350 Stack
->Parameters
.StartDevice
.AllocatedResources
,
1353 RtlCopyMemory(Adapter
->NdisMiniportBlock
.AllocatedResourcesTranslated
,
1354 Stack
->Parameters
.StartDevice
.AllocatedResourcesTranslated
,
1359 * Store the Bus Type, Bus Number and Slot information. It's used by
1360 * the hardware routines then.
1363 NdisOpenConfiguration(&NdisStatus
, &ConfigHandle
, (NDIS_HANDLE
)&WrapperContext
);
1365 Size
= sizeof(ULONG
);
1366 Status
= IoGetDeviceProperty(Adapter
->NdisMiniportBlock
.PhysicalDeviceObject
,
1367 DevicePropertyLegacyBusType
, Size
,
1368 &Adapter
->NdisMiniportBlock
.BusType
, &Size
);
1369 if (!NT_SUCCESS(Status
) || Adapter
->NdisMiniportBlock
.BusType
== -1)
1371 NdisInitUnicodeString(&ParamName
, L
"BusType");
1372 NdisReadConfiguration(&NdisStatus
, &ConfigParam
, ConfigHandle
,
1373 &ParamName
, NdisParameterInteger
);
1374 if (NdisStatus
== NDIS_STATUS_SUCCESS
)
1375 Adapter
->NdisMiniportBlock
.BusType
= ConfigParam
->ParameterData
.IntegerData
;
1377 Adapter
->NdisMiniportBlock
.BusType
= Isa
;
1380 Status
= IoGetDeviceProperty(Adapter
->NdisMiniportBlock
.PhysicalDeviceObject
,
1381 DevicePropertyBusNumber
, Size
,
1382 &Adapter
->NdisMiniportBlock
.BusNumber
, &Size
);
1383 if (!NT_SUCCESS(Status
) || Adapter
->NdisMiniportBlock
.BusNumber
== -1)
1385 NdisInitUnicodeString(&ParamName
, L
"BusNumber");
1386 NdisReadConfiguration(&NdisStatus
, &ConfigParam
, ConfigHandle
,
1387 &ParamName
, NdisParameterInteger
);
1388 if (NdisStatus
== NDIS_STATUS_SUCCESS
)
1389 Adapter
->NdisMiniportBlock
.BusNumber
= ConfigParam
->ParameterData
.IntegerData
;
1391 Adapter
->NdisMiniportBlock
.BusNumber
= 0;
1393 WrapperContext
.BusNumber
= Adapter
->NdisMiniportBlock
.BusNumber
;
1395 Status
= IoGetDeviceProperty(Adapter
->NdisMiniportBlock
.PhysicalDeviceObject
,
1396 DevicePropertyAddress
, Size
,
1397 &Adapter
->NdisMiniportBlock
.SlotNumber
, &Size
);
1398 if (!NT_SUCCESS(Status
) || Adapter
->NdisMiniportBlock
.SlotNumber
== -1)
1400 NdisInitUnicodeString(&ParamName
, L
"SlotNumber");
1401 NdisReadConfiguration(&NdisStatus
, &ConfigParam
, ConfigHandle
,
1402 &ParamName
, NdisParameterInteger
);
1403 if (NdisStatus
== NDIS_STATUS_SUCCESS
)
1404 Adapter
->NdisMiniportBlock
.SlotNumber
= ConfigParam
->ParameterData
.IntegerData
;
1406 Adapter
->NdisMiniportBlock
.SlotNumber
= 0;
1409 NdisCloseConfiguration(ConfigHandle
);
1412 * Call MiniportInitialize.
1415 NDIS_DbgPrint(MID_TRACE
, ("calling MiniportInitialize\n"));
1416 NdisStatus
= (*Adapter
->Miniport
->Chars
.InitializeHandler
)(
1417 &OpenErrorStatus
, &SelectedMediumIndex
, &MediaArray
[0],
1418 MEDIA_ARRAY_SIZE
, Adapter
, (NDIS_HANDLE
)&WrapperContext
);
1420 ZwClose(WrapperContext
.RegistryHandle
);
1422 if (NdisStatus
!= NDIS_STATUS_SUCCESS
||
1423 SelectedMediumIndex
>= MEDIA_ARRAY_SIZE
)
1425 NDIS_DbgPrint(MIN_TRACE
, ("MiniportInitialize() failed for an adapter.\n"));
1426 return (NTSTATUS
)NdisStatus
;
1429 /* Set handlers (some NDIS macros require these) */
1431 Adapter
->NdisMiniportBlock
.EthRxCompleteHandler
= EthFilterDprIndicateReceiveComplete
;
1432 Adapter
->NdisMiniportBlock
.EthRxIndicateHandler
= EthFilterDprIndicateReceive
;
1433 Adapter
->NdisMiniportBlock
.SendCompleteHandler
= MiniSendComplete
;
1434 Adapter
->NdisMiniportBlock
.SendResourcesHandler
= MiniSendResourcesAvailable
;
1435 Adapter
->NdisMiniportBlock
.ResetCompleteHandler
= MiniResetComplete
;
1436 Adapter
->NdisMiniportBlock
.TDCompleteHandler
= MiniTransferDataComplete
;
1437 Adapter
->NdisMiniportBlock
.PacketIndicateHandler
= MiniIndicateReceivePacket
;
1439 Adapter
->NdisMiniportBlock
.MediaType
= MediaArray
[SelectedMediumIndex
];
1441 switch (Adapter
->NdisMiniportBlock
.MediaType
)
1443 case NdisMedium802_3
:
1444 Adapter
->MediumHeaderSize
= 14; /* XXX figure out what to do about LLC */
1445 AddressOID
= OID_802_3_CURRENT_ADDRESS
;
1446 Adapter
->AddressLength
= ETH_LENGTH_OF_ADDRESS
;
1447 NdisStatus
= DoQueries(Adapter
, AddressOID
);
1448 if (NdisStatus
== NDIS_STATUS_SUCCESS
)
1450 Success
= EthCreateFilter(32, /* FIXME: Query this from miniport. */
1451 Adapter
->Address
.Type
.Medium802_3
,
1452 &Adapter
->NdisMiniportBlock
.FilterDbs
.EthDB
);
1454 Adapter
->NdisMiniportBlock
.FilterDbs
.EthDB
->Miniport
= (PNDIS_MINIPORT_BLOCK
)Adapter
;
1456 NdisStatus
= NDIS_STATUS_RESOURCES
;
1461 /* FIXME: Support other types of media */
1462 NDIS_DbgPrint(MIN_TRACE
, ("error: unsupported media\n"));
1464 /* FIXME - KeReleaseSpinLock(&Adapter->NdisMiniportBlock.Lock, OldIrql); */
1465 return STATUS_UNSUCCESSFUL
;
1468 if (!Success
|| NdisStatus
!= NDIS_STATUS_SUCCESS
)
1470 NDIS_DbgPrint(MAX_TRACE
, ("couldn't create filter (%x)\n", NdisStatus
));
1471 if (Adapter
->LookaheadBuffer
)
1473 ExFreePool(Adapter
->LookaheadBuffer
);
1474 Adapter
->LookaheadBuffer
= NULL
;
1476 return (NTSTATUS
)NdisStatus
;
1479 Adapter
->NdisMiniportBlock
.OldPnPDeviceState
= Adapter
->NdisMiniportBlock
.PnPDeviceState
;
1480 Adapter
->NdisMiniportBlock
.PnPDeviceState
= NdisPnPDeviceStarted
;
1482 /* Put adapter in adapter list for this miniport */
1483 ExInterlockedInsertTailList(&Adapter
->Miniport
->AdapterListHead
, &Adapter
->MiniportListEntry
, &Adapter
->Miniport
->Lock
);
1485 /* Put adapter in global adapter list */
1486 ExInterlockedInsertTailList(&AdapterListHead
, &Adapter
->ListEntry
, &AdapterListLock
);
1488 return STATUS_SUCCESS
;
1495 IN PDEVICE_OBJECT DeviceObject
,
1498 * FUNCTION: Handle the PnP stop device event
1500 * DeviceObejct = Functional Device Object
1501 * Irp = IRP_MN_STOP_DEVICE I/O request packet
1503 * Status of operation
1506 PLOGICAL_ADAPTER Adapter
= (PLOGICAL_ADAPTER
)DeviceObject
->DeviceExtension
;
1509 /* Remove adapter from adapter list for this miniport */
1510 KeAcquireSpinLock(&Adapter
->Miniport
->Lock
, &OldIrql
);
1511 RemoveEntryList(&Adapter
->MiniportListEntry
);
1512 KeReleaseSpinLock(&Adapter
->Miniport
->Lock
, OldIrql
);
1514 /* Remove adapter from global adapter list */
1515 KeAcquireSpinLock(&AdapterListLock
, &OldIrql
);
1516 RemoveEntryList(&Adapter
->ListEntry
);
1517 KeReleaseSpinLock(&AdapterListLock
, OldIrql
);
1519 (*Adapter
->Miniport
->Chars
.HaltHandler
)(Adapter
);
1521 if (Adapter
->LookaheadBuffer
)
1523 ExFreePool(Adapter
->LookaheadBuffer
);
1524 Adapter
->LookaheadBuffer
= NULL
;
1526 if (Adapter
->NdisMiniportBlock
.AllocatedResources
)
1528 ExFreePool(Adapter
->NdisMiniportBlock
.AllocatedResources
);
1529 Adapter
->NdisMiniportBlock
.AllocatedResources
= NULL
;
1531 if (Adapter
->NdisMiniportBlock
.AllocatedResourcesTranslated
)
1533 ExFreePool(Adapter
->NdisMiniportBlock
.AllocatedResourcesTranslated
);
1534 Adapter
->NdisMiniportBlock
.AllocatedResourcesTranslated
= NULL
;
1537 Adapter
->NdisMiniportBlock
.OldPnPDeviceState
= Adapter
->NdisMiniportBlock
.PnPDeviceState
;
1538 Adapter
->NdisMiniportBlock
.PnPDeviceState
= NdisPnPDeviceStopped
;
1540 return STATUS_SUCCESS
;
1547 IN PDEVICE_OBJECT DeviceObject
,
1550 PIO_STACK_LOCATION Stack
= IoGetCurrentIrpStackLocation(Irp
);
1551 PLOGICAL_ADAPTER Adapter
= (PLOGICAL_ADAPTER
)DeviceObject
->DeviceExtension
;
1554 switch (Stack
->MinorFunction
)
1556 case IRP_MN_START_DEVICE
:
1557 Status
= NdisIForwardIrpAndWait(Adapter
, Irp
);
1558 if (NT_SUCCESS(Status
) && NT_SUCCESS(Irp
->IoStatus
.Status
))
1560 Status
= NdisIPnPStartDevice(DeviceObject
, Irp
);
1562 Irp
->IoStatus
.Status
= Status
;
1563 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
1566 case IRP_MN_STOP_DEVICE
:
1568 Status
= STATUS_UNSUCCESSFUL
;
1570 Status
= NdisIForwardIrpAndWait(Adapter
, Irp
);
1571 if (NT_SUCCESS(Status
) && NT_SUCCESS(Irp
->IoStatus
.Status
))
1573 Status
= NdisIPnPStopDevice(DeviceObject
, Irp
);
1575 Irp
->IoStatus
.Status
= Status
;
1576 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);
1580 IoSkipCurrentIrpStackLocation(Irp
);
1581 Status
= IoCallDriver(Adapter
->NdisMiniportBlock
.NextDeviceObject
, Irp
);
1592 IN PDRIVER_OBJECT DriverObject
,
1593 IN PDEVICE_OBJECT PhysicalDeviceObject
)
1595 * FUNCTION: Create a device for an adapter found using PnP
1597 * DriverObject = Pointer to the miniport driver object
1598 * PhysicalDeviceObject = Pointer to the PDO for our adapter
1601 static const WCHAR ClassKeyName
[] = {'C','l','a','s','s','\\'};
1602 static const WCHAR LinkageKeyName
[] = {'\\','L','i','n','k','a','g','e',0};
1603 PMINIPORT_DRIVER Miniport
;
1604 PMINIPORT_DRIVER
*MiniportPtr
;
1605 WCHAR
*LinkageKeyBuffer
;
1606 ULONG DriverKeyLength
;
1607 RTL_QUERY_REGISTRY_TABLE QueryTable
[2];
1608 UNICODE_STRING ExportName
;
1609 PDEVICE_OBJECT DeviceObject
;
1610 PLOGICAL_ADAPTER Adapter
;
1614 * Gain the access to the miniport data structure first.
1617 MiniportPtr
= IoGetDriverObjectExtension(DriverObject
, (PVOID
)TAG('D','I','M','N'));
1618 if (MiniportPtr
== NULL
)
1620 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Can't get driver object extension.\n"));
1621 return STATUS_UNSUCCESSFUL
;
1623 Miniport
= *MiniportPtr
;
1626 * Get name of the Linkage registry key for our adapter. It's located under
1627 * the driver key for our driver and so we have basicly two ways to do it.
1628 * Either we can use IoOpenDriverRegistryKey or compose it using information
1629 * gathered by IoGetDeviceProperty. I choosed the second because
1630 * IoOpenDriverRegistryKey wasn't implemented at the time of writing.
1633 Status
= IoGetDeviceProperty(PhysicalDeviceObject
, DevicePropertyDriverKeyName
,
1634 0, NULL
, &DriverKeyLength
);
1635 if (Status
!= STATUS_BUFFER_TOO_SMALL
)
1637 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Can't get miniport driver key length.\n"));
1641 LinkageKeyBuffer
= ExAllocatePool(PagedPool
, DriverKeyLength
+
1642 sizeof(ClassKeyName
) + sizeof(LinkageKeyName
));
1643 if (LinkageKeyBuffer
== NULL
)
1645 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Can't allocate memory for driver key name.\n"));
1646 return STATUS_INSUFFICIENT_RESOURCES
;
1649 Status
= IoGetDeviceProperty(PhysicalDeviceObject
, DevicePropertyDriverKeyName
,
1650 DriverKeyLength
, LinkageKeyBuffer
+
1651 (sizeof(ClassKeyName
) / sizeof(WCHAR
)),
1653 if (!NT_SUCCESS(Status
))
1655 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Can't get miniport driver key.\n"));
1656 ExFreePool(LinkageKeyBuffer
);
1660 /* Compose the linkage key name. */
1661 RtlCopyMemory(LinkageKeyBuffer
, ClassKeyName
, sizeof(ClassKeyName
));
1662 RtlCopyMemory(LinkageKeyBuffer
+ ((sizeof(ClassKeyName
) + DriverKeyLength
) /
1663 sizeof(WCHAR
)) - 1, LinkageKeyName
, sizeof(LinkageKeyName
));
1665 NDIS_DbgPrint(DEBUG_MINIPORT
, ("LinkageKey: %S.\n", LinkageKeyBuffer
));
1668 * Now open the linkage key and read the "Export" and "RootDevice" values
1669 * which contains device name and root service respectively.
1672 RtlZeroMemory(QueryTable
, sizeof(QueryTable
));
1673 RtlInitUnicodeString(&ExportName
, NULL
);
1674 QueryTable
[0].Flags
= RTL_QUERY_REGISTRY_REQUIRED
| RTL_QUERY_REGISTRY_DIRECT
;
1675 QueryTable
[0].Name
= L
"Export";
1676 QueryTable
[0].EntryContext
= &ExportName
;
1678 Status
= RtlQueryRegistryValues(RTL_REGISTRY_CONTROL
, LinkageKeyBuffer
,
1679 QueryTable
, NULL
, NULL
);
1680 ExFreePool(LinkageKeyBuffer
);
1681 if (!NT_SUCCESS(Status
))
1683 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Can't get miniport device name. (%x)\n", Status
));
1688 * Create the device object.
1691 NDIS_DbgPrint(MAX_TRACE
, ("creating device %wZ\n", &ExportName
));
1693 Status
= IoCreateDevice(Miniport
->DriverObject
, sizeof(LOGICAL_ADAPTER
),
1694 &ExportName
, FILE_DEVICE_PHYSICAL_NETCARD
,
1695 0, FALSE
, &DeviceObject
);
1696 if (!NT_SUCCESS(Status
))
1698 NDIS_DbgPrint(MIN_TRACE
, ("Could not create device object.\n"));
1699 RtlFreeUnicodeString(&ExportName
);
1704 * Initialize the adapter structure.
1707 Adapter
= (PLOGICAL_ADAPTER
)DeviceObject
->DeviceExtension
;
1708 KeInitializeSpinLock(&Adapter
->NdisMiniportBlock
.Lock
);
1709 InitializeListHead(&Adapter
->ProtocolListHead
);
1710 Adapter
->RefCount
= 1;
1711 Adapter
->Miniport
= Miniport
;
1713 Adapter
->NdisMiniportBlock
.MiniportName
= ExportName
;
1715 Adapter
->NdisMiniportBlock
.DeviceObject
= DeviceObject
;
1716 Adapter
->NdisMiniportBlock
.PhysicalDeviceObject
= PhysicalDeviceObject
;
1717 Adapter
->NdisMiniportBlock
.NextDeviceObject
=
1718 IoAttachDeviceToDeviceStack(Adapter
->NdisMiniportBlock
.DeviceObject
,
1719 PhysicalDeviceObject
);
1721 Adapter
->NdisMiniportBlock
.OldPnPDeviceState
= 0;
1722 Adapter
->NdisMiniportBlock
.PnPDeviceState
= NdisPnPDeviceAdded
;
1724 KeInitializeDpc(&Adapter
->MiniportDpc
, MiniportDpc
, (PVOID
)Adapter
);
1726 DeviceObject
->Flags
&= ~DO_DEVICE_INITIALIZING
;
1728 return STATUS_SUCCESS
;
1737 NdisMRegisterMiniport(
1738 IN NDIS_HANDLE NdisWrapperHandle
,
1739 IN PNDIS_MINIPORT_CHARACTERISTICS MiniportCharacteristics
,
1740 IN UINT CharacteristicsLength
)
1742 * FUNCTION: Registers a miniport's MiniportXxx entry points with the NDIS library
1744 * NdisWrapperHandle = Pointer to handle returned by NdisMInitializeWrapper
1745 * MiniportCharacteristics = Pointer to a buffer with miniport characteristics
1746 * CharacteristicsLength = Number of bytes in characteristics buffer
1748 * Status of operation
1752 PMINIPORT_DRIVER Miniport
= GET_MINIPORT_DRIVER(NdisWrapperHandle
);
1753 PMINIPORT_DRIVER
*MiniportPtr
;
1756 NDIS_DbgPrint(MAX_TRACE
, ("Called.\n"));
1758 switch (MiniportCharacteristics
->MajorNdisVersion
)
1761 MinSize
= sizeof(NDIS30_MINIPORT_CHARACTERISTICS
);
1765 MinSize
= sizeof(NDIS40_MINIPORT_CHARACTERISTICS
);
1769 MinSize
= sizeof(NDIS50_MINIPORT_CHARACTERISTICS
);
1773 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Bad miniport characteristics version.\n"));
1774 return NDIS_STATUS_BAD_VERSION
;
1777 if (CharacteristicsLength
< MinSize
)
1779 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Bad miniport characteristics.\n"));
1780 return NDIS_STATUS_BAD_CHARACTERISTICS
;
1783 /* Check if mandatory MiniportXxx functions are specified */
1784 if ((!MiniportCharacteristics
->HaltHandler
) ||
1785 (!MiniportCharacteristics
->InitializeHandler
)||
1786 (!MiniportCharacteristics
->QueryInformationHandler
) ||
1787 (!MiniportCharacteristics
->ResetHandler
) ||
1788 (!MiniportCharacteristics
->SetInformationHandler
))
1790 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Bad miniport characteristics.\n"));
1791 return NDIS_STATUS_BAD_CHARACTERISTICS
;
1794 if (MiniportCharacteristics
->MajorNdisVersion
== 0x03)
1796 if (!MiniportCharacteristics
->SendHandler
)
1798 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Bad miniport characteristics.\n"));
1799 return NDIS_STATUS_BAD_CHARACTERISTICS
;
1802 else if (MiniportCharacteristics
->MajorNdisVersion
>= 0x04)
1805 if ((!MiniportCharacteristics
->SendHandler
) &&
1806 (!MiniportCharacteristics
->SendPacketsHandler
))
1808 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Bad miniport characteristics.\n"));
1809 return NDIS_STATUS_BAD_CHARACTERISTICS
;
1813 /* TODO: verify NDIS5 and NDIS5.1 */
1815 RtlCopyMemory(&Miniport
->Chars
, MiniportCharacteristics
, MinSize
);
1818 * NOTE: This is VERY unoptimal! Should we store the MINIPORT_DRIVER
1819 * struture in the driver extension or what?
1822 Status
= IoAllocateDriverObjectExtension(Miniport
->DriverObject
, (PVOID
)TAG('D','I','M','N'),
1823 sizeof(PMINIPORT_DRIVER
), (PVOID
*)&MiniportPtr
);
1824 if (!NT_SUCCESS(Status
))
1826 NDIS_DbgPrint(DEBUG_MINIPORT
, ("Can't allocate driver object extension.\n"));
1827 return NDIS_STATUS_RESOURCES
;
1830 *MiniportPtr
= Miniport
;
1832 Miniport
->DriverObject
->MajorFunction
[IRP_MJ_PNP
] = NdisIDispatchPnp
;
1833 Miniport
->DriverObject
->DriverExtension
->AddDevice
= NdisIAddDevice
;
1835 return NDIS_STATUS_SUCCESS
;
1845 IN NDIS_HANDLE MiniportAdapterHandle
,
1846 IN NDIS_STATUS Status
,
1847 IN BOOLEAN AddressingReset
)
1849 MiniResetComplete(MiniportAdapterHandle
, Status
, AddressingReset
);
1859 IN NDIS_HANDLE MiniportAdapterHandle
,
1860 IN PNDIS_PACKET Packet
,
1861 IN NDIS_STATUS Status
)
1863 * FUNCTION: Forwards a message to the initiating protocol saying
1864 * that a packet was handled
1866 * NdisAdapterHandle = Handle input to MiniportInitialize
1867 * Packet = Pointer to NDIS packet that was sent
1868 * Status = Status of send operation
1871 MiniSendComplete(MiniportAdapterHandle
, Packet
, Status
);
1880 NdisMSendResourcesAvailable(
1881 IN NDIS_HANDLE MiniportAdapterHandle
)
1883 MiniSendResourcesAvailable(MiniportAdapterHandle
);
1892 NdisMTransferDataComplete(
1893 IN NDIS_HANDLE MiniportAdapterHandle
,
1894 IN PNDIS_PACKET Packet
,
1895 IN NDIS_STATUS Status
,
1896 IN UINT BytesTransferred
)
1898 MiniTransferDataComplete(MiniportAdapterHandle
, Packet
, Status
, BytesTransferred
);
1901 #undef NdisMSetInformationComplete
1909 NdisMSetInformationComplete(
1910 IN NDIS_HANDLE MiniportAdapterHandle
,
1911 IN NDIS_STATUS Status
)
1913 (*((PNDIS_MINIPORT_BLOCK
)(MiniportAdapterHandle
))->SetCompleteHandler
)(MiniportAdapterHandle
, Status
);
1916 #undef NdisMSetAttributes
1925 IN NDIS_HANDLE MiniportAdapterHandle
,
1926 IN NDIS_HANDLE MiniportAdapterContext
,
1927 IN BOOLEAN BusMaster
,
1928 IN NDIS_INTERFACE_TYPE AdapterType
)
1930 * FUNCTION: Informs the NDIS library of significant features of the caller's NIC
1932 * MiniportAdapterHandle = Handle input to MiniportInitialize
1933 * MiniportAdapterContext = Pointer to context information
1934 * BusMaster = Specifies TRUE if the caller's NIC is a busmaster DMA device
1935 * AdapterType = Specifies the I/O bus interface of the caller's NIC
1938 NDIS_DbgPrint(MAX_TRACE
, ("Called.\n"));
1939 NdisMSetAttributesEx(MiniportAdapterHandle
, MiniportAdapterContext
, 0,
1940 BusMaster
? NDIS_ATTRIBUTE_BUS_MASTER
: 0,
1950 NdisMSetAttributesEx(
1951 IN NDIS_HANDLE MiniportAdapterHandle
,
1952 IN NDIS_HANDLE MiniportAdapterContext
,
1953 IN UINT CheckForHangTimeInSeconds OPTIONAL
,
1954 IN ULONG AttributeFlags
,
1955 IN NDIS_INTERFACE_TYPE AdapterType
)
1957 * FUNCTION: Informs the NDIS library of significant features of the caller's NIC
1959 * MiniportAdapterHandle = Handle input to MiniportInitialize
1960 * MiniportAdapterContext = Pointer to context information
1961 * CheckForHangTimeInSeconds = Specifies interval in seconds at which
1962 * MiniportCheckForHang should be called
1963 * AttributeFlags = Bitmask that indicates specific attributes
1964 * AdapterType = Specifies the I/O bus interface of the caller's NIC
1967 /* TODO: Take CheckForHandTimeInSeconds into account! */
1969 PLOGICAL_ADAPTER Adapter
= GET_LOGICAL_ADAPTER(MiniportAdapterHandle
);
1971 NDIS_DbgPrint(MAX_TRACE
, ("Called.\n"));
1973 Adapter
->NdisMiniportBlock
.MiniportAdapterContext
= MiniportAdapterContext
;
1974 Adapter
->NdisMiniportBlock
.Flags
= AttributeFlags
;
1975 Adapter
->NdisMiniportBlock
.AdapterType
= AdapterType
;
1976 Adapter
->AttributesSet
= TRUE
;
1977 if (AttributeFlags
& NDIS_ATTRIBUTE_INTERMEDIATE_DRIVER
)
1978 NDIS_DbgPrint(MAX_TRACE
, ("Intermediate drivers not supported yet.\n"));
1988 IN ULONG MicrosecondsToSleep
)
1990 * FUNCTION: delay the thread's execution for MicrosecondsToSleep
1992 * MicrosecondsToSleep: duh...
1994 * - Because this is a blocking call, current IRQL must be < DISPATCH_LEVEL
1998 LARGE_INTEGER DueTime
;
2002 DueTime
.QuadPart
= (-1) * 10 * MicrosecondsToSleep
;
2004 KeInitializeTimer(&Timer
);
2005 KeSetTimer(&Timer
, DueTime
, 0);
2006 KeWaitForSingleObject(&Timer
, Executive
, KernelMode
, FALSE
, 0);
2015 NdisMSynchronizeWithInterrupt(
2016 IN PNDIS_MINIPORT_INTERRUPT Interrupt
,
2017 IN PVOID SynchronizeFunction
,
2018 IN PVOID SynchronizeContext
)
2020 return(KeSynchronizeExecution(Interrupt
->InterruptObject
,
2021 (PKSYNCHRONIZE_ROUTINE
)SynchronizeFunction
,
2022 SynchronizeContext
));
2032 IN NDIS_HANDLE LogHandle
,
2034 IN UINT LogBufferSize
)
2038 return NDIS_STATUS_FAILURE
;
2047 NdisTerminateWrapper(
2048 IN NDIS_HANDLE NdisWrapperHandle
,
2049 IN PVOID SystemSpecific
)
2051 * FUNCTION: Releases resources allocated by a call to NdisInitializeWrapper
2053 * NdisWrapperHandle = Handle returned by NdisInitializeWrapper (MINIPORT_DRIVER)
2054 * SystemSpecific = Always NULL
2057 PMINIPORT_DRIVER Miniport
= GET_MINIPORT_DRIVER(NdisWrapperHandle
);
2059 NDIS_DbgPrint(MAX_TRACE
, ("Called.\n"));
2061 ExFreePool(Miniport
->RegistryPath
->Buffer
);
2062 ExFreePool(Miniport
->RegistryPath
);
2063 ExFreePool(Miniport
);