miniport.c
上传用户:sabrinaco
上传日期:2016-01-19
资源大小:3177k
文件大小:35k
开发平台:

Visual C++

  1. /*++
  2. Copyright (c) 1992-2000  Microsoft Corporation
  3. Module Name:
  4.     miniport.c
  5. Abstract:
  6.     Ndis Intermediate Miniport driver sample. This is a passthru driver.
  7. Author:
  8. Environment:
  9. Revision History:
  10. --*/
  11. #include "precomp.h"
  12. #pragma hdrstop
  13. NDIS_STATUS
  14. MPInitialize(
  15.     OUT PNDIS_STATUS            OpenErrorStatus,
  16.     OUT PUINT                   SelectedMediumIndex,
  17.     IN  PNDIS_MEDIUM            MediumArray,
  18.     IN  UINT                    MediumArraySize,
  19.     IN  NDIS_HANDLE             MiniportAdapterHandle,
  20.     IN  NDIS_HANDLE             WrapperConfigurationContext
  21.     )
  22. /*++
  23. Routine Description:
  24.     This is the initialize handler which gets called as a result of
  25.     the BindAdapter handler calling NdisIMInitializeDeviceInstanceEx.
  26.     The context parameter which we pass there is the adapter structure
  27.     which we retrieve here.
  28.     Arguments:
  29.     OpenErrorStatus         Not used by us.
  30.     SelectedMediumIndex     Place-holder for what media we are using
  31.     MediumArray             Array of ndis media passed down to us to pick from
  32.     MediumArraySize         Size of the array
  33.     MiniportAdapterHandle   The handle NDIS uses to refer to us
  34.     WrapperConfigurationContext For use by NdisOpenConfiguration
  35. Return Value:
  36.     NDIS_STATUS_SUCCESS unless something goes wrong
  37. --*/
  38. {
  39.     UINT     i;
  40.     PADAPT          pAdapt;
  41.     NDIS_STATUS     Status = NDIS_STATUS_FAILURE;
  42.     NDIS_MEDIUM     Medium;
  43.     do
  44.     {
  45.      //
  46.         // Start off by retrieving our adapter context and storing
  47.         // the Miniport handle in it.
  48.      //
  49.         pAdapt = NdisIMGetDeviceContext(MiniportAdapterHandle);
  50.         pAdapt->MiniportHandle = MiniportAdapterHandle;
  51.         DBGPRINT(("==> Miniport Initialize: Adapt %pn", pAdapt));
  52.      //
  53.         // Usually we export the medium type of the adapter below as our
  54.         // virtual miniport's medium type. However if the adapter below us
  55.         // is a WAN device, then we claim to be of medium type 802.3.
  56.      //
  57.         Medium = pAdapt->Medium;
  58.         if (Medium == NdisMediumWan)
  59.      {
  60.             Medium = NdisMedium802_3;
  61.      }
  62.         for (i = 0; i < MediumArraySize; i++)
  63.      {
  64.             if (MediumArray[i] == Medium)
  65.      {
  66.                 *SelectedMediumIndex = i;
  67.              break;
  68.      }
  69.      }
  70.         if (i == MediumArraySize)
  71.      {
  72.             Status = NDIS_STATUS_UNSUPPORTED_MEDIA;
  73.             break;
  74.      }
  75.      //
  76.         // Set the attributes now. NDIS_ATTRIBUTE_DESERIALIZE enables us
  77.         // to make up-calls to NDIS without having to call NdisIMSwitchToMiniport
  78.         // or NdisIMQueueCallBack. This also forces us to protect our data using
  79.         // spinlocks where appropriate. Also in this case NDIS does not queue
  80.         // packets on our behalf. Since this is a very simple pass-thru
  81.         // miniport, we do not have a need to protect anything. However in
  82.         // a general case there will be a need to use per-adapter spin-locks
  83.         // for the packet queues at the very least.
  84.      //
  85.         NdisMSetAttributesEx(MiniportAdapterHandle,
  86.                  pAdapt,
  87.                             0,                   // CheckForHangTimeInSeconds
  88.                             NDIS_ATTRIBUTE_IGNORE_PACKET_TIMEOUT |
  89.                                 NDIS_ATTRIBUTE_IGNORE_REQUEST_TIMEOUT|
  90.                                 NDIS_ATTRIBUTE_INTERMEDIATE_DRIVER |
  91.                                 NDIS_ATTRIBUTE_DESERIALIZE |
  92.                                 NDIS_ATTRIBUTE_NO_HALT_ON_SUSPEND,
  93.              0);
  94.      //
  95.         // Initialize LastIndicatedStatus to be NDIS_STATUS_MEDIA_CONNECT
  96.         //
  97.         pAdapt->LastIndicatedStatus = NDIS_STATUS_MEDIA_CONNECT;
  98.         
  99.         //
  100.         // Initialize the power states for both the lower binding (PTDeviceState)
  101.         // and our miniport edge to Powered On.
  102.      //
  103.         pAdapt->MPDeviceState = NdisDeviceStateD0;
  104.         pAdapt->PTDeviceState = NdisDeviceStateD0;
  105.      //
  106.         // Add this adapter to the global pAdapt List
  107.      //
  108.         NdisAcquireSpinLock(&GlobalLock);
  109.         pAdapt->Next = pAdaptList;
  110.         pAdaptList = pAdapt;
  111.         NdisReleaseSpinLock(&GlobalLock);
  112.     
  113.      //
  114.         // Create an ioctl interface
  115.      //
  116.         (VOID)PtRegisterDevice();
  117.         Status = NDIS_STATUS_SUCCESS;
  118.     }
  119.     while (FALSE);
  120.     //
  121.     // If we had received an UnbindAdapter notification on the underlying
  122.     // adapter, we would have blocked that thread waiting for the IM Init
  123.     // process to complete. Wake up any such thread.
  124.     //
  125.     ASSERT(pAdapt->MiniportInitPending == TRUE);
  126.     pAdapt->MiniportInitPending = FALSE;
  127.     NdisSetEvent(&pAdapt->MiniportInitEvent);
  128.     DBGPRINT(("<== Miniport Initialize: Adapt %p, Status %xn", pAdapt, Status));
  129.     return Status;
  130. }
  131. NDIS_STATUS
  132. MPSend(
  133.     IN  NDIS_HANDLE             MiniportAdapterContext,
  134.     IN  PNDIS_PACKET         Packet,
  135.     IN  UINT         Flags
  136.     )
  137. /*++
  138. Routine Description:
  139.     Send Packet handler. Either this or our SendPackets (array) handler is called
  140.     based on which one is enabled in our Miniport Characteristics.
  141. Arguments:
  142.     MiniportAdapterContext  Pointer to the adapter
  143.     Packet                  Packet to send
  144.     Flags                   Unused, passed down below
  145. Return Value:
  146.     Return code from NdisSend
  147. --*/
  148. {
  149.     PADAPT              pAdapt = (PADAPT)MiniportAdapterContext;
  150.     NDIS_STATUS         Status;
  151.     PNDIS_PACKET        MyPacket;
  152.     PVOID               MediaSpecificInfo = NULL;
  153.     ULONG               MediaSpecificInfoSize = 0;
  154. #ifdef NDIS51
  155.     //
  156.     // Use NDIS 5.1 packet stacking:
  157.     //
  158.     {
  159.         PNDIS_PACKET_STACK      pStack;
  160.         BOOLEAN          Remaining;
  161.      //
  162.         // Packet stacks: Check if we can use the same packet for sending down.
  163.      //
  164.         pStack = NdisIMGetCurrentPacketStack(Packet, &Remaining);
  165.         if (Remaining)
  166.      {
  167.          //
  168.             // We can reuse "Packet".
  169.          //
  170.             // NOTE: if we needed to keep per-packet information in packets
  171.             // sent down, we can use pStack->IMReserved[].
  172.          //
  173.             ASSERT(pStack);
  174.             NdisSend(&Status,
  175.                      pAdapt->BindingHandle,
  176.                   Packet);
  177.             return(Status);
  178.      }
  179.     }
  180. #endif // NDIS51
  181.     //
  182.     // We are either not using packet stacks, or there isn't stack space
  183.     // in the original packet passed down to us. Allocate a new packet
  184.     // to wrap the data with.
  185.     //
  186.     NdisAllocatePacket(&Status,
  187.                        &MyPacket,
  188.                        pAdapt->SendPacketPoolHandle);
  189.     if (Status == NDIS_STATUS_SUCCESS)
  190.     {
  191.         PSEND_RSVD       SendRsvd;
  192.      //
  193.         // Save a pointer to the original packet in our reserved
  194.         // area in the new packet. This is needed so that we can
  195.         // get back to the original packet when the new packet's send
  196.         // is completed.
  197.      //
  198.         SendRsvd = (PSEND_RSVD)(MyPacket->ProtocolReserved);
  199.         SendRsvd->OriginalPkt = Packet;
  200.         MyPacket->Private.Flags = Flags;
  201.      //
  202.         // Set up the new packet so that it describes the same
  203.         // data as the original packet.
  204.      //
  205.         MyPacket->Private.Head = Packet->Private.Head;
  206.         MyPacket->Private.Tail = Packet->Private.Tail;
  207. #ifdef WIN9X
  208.      //
  209.         // Work around the fact that NDIS does not initialize this
  210.         // to FALSE on Win9x.
  211.      //
  212.         MyPacket->Private.ValidCounts = FALSE;
  213. #endif
  214.      //
  215.         // Copy the OOB Offset from the original packet to the new
  216.         // packet.
  217.      //
  218.         NdisMoveMemory(NDIS_OOB_DATA_FROM_PACKET(MyPacket),
  219.                        NDIS_OOB_DATA_FROM_PACKET(Packet),
  220.                        sizeof(NDIS_PACKET_OOB_DATA));
  221. #ifndef WIN9X
  222.      //
  223.         // Copy the right parts of per packet info into the new packet.
  224.         // This API is not available on Win9x since task offload is
  225.         // not supported on that platform.
  226.      //
  227.         NdisIMCopySendPerPacketInfo(MyPacket, Packet);
  228. #endif
  229.     
  230.      //
  231.         // Copy the Media specific information
  232.      //
  233.         NDIS_GET_PACKET_MEDIA_SPECIFIC_INFO(Packet,
  234.                                  &MediaSpecificInfo,
  235.                                      &MediaSpecificInfoSize);
  236.         if (MediaSpecificInfo || MediaSpecificInfoSize)
  237.      {
  238.             NDIS_SET_PACKET_MEDIA_SPECIFIC_INFO(MyPacket,
  239.                                  MediaSpecificInfo,
  240.                                      MediaSpecificInfoSize);
  241.      }
  242.         NdisSend(&Status,
  243.                  pAdapt->BindingHandle,
  244.                  MyPacket);
  245.         if (Status != NDIS_STATUS_PENDING)
  246.      {
  247. #ifndef WIN9X
  248.             NdisIMCopySendCompletePerPacketInfo (Packet, MyPacket);
  249. #endif
  250.             NdisFreePacket(MyPacket);
  251.      }
  252.     }
  253.     else
  254.     {
  255.      //
  256.         // We are out of packets. Silently drop it. Alternatively we can deal with it:
  257.         //  - By keeping separate send and receive pools
  258.         //  - Dynamically allocate more pools as needed and free them when not needed
  259.      //
  260.     }
  261.     return(Status);
  262. }
  263. VOID
  264. MPSendPackets(
  265.     IN  NDIS_HANDLE             MiniportAdapterContext,
  266.     IN  PPNDIS_PACKET           PacketArray,
  267.     IN  UINT                 NumberOfPackets
  268.     )
  269. /*++
  270. Routine Description:
  271.     Send Packet Array handler. Either this or our SendPacket handler is called
  272.     based on which one is enabled in our Miniport Characteristics.
  273. Arguments:
  274.     MiniportAdapterContext  Pointer to our adapter
  275.     PacketArray             Set of packets to send
  276.     NumberOfPackets         Self-explanatory
  277. Return Value:
  278.     None
  279. --*/
  280. {
  281.     PADAPT              pAdapt = (PADAPT)MiniportAdapterContext;
  282.     NDIS_STATUS         Status;
  283.     UINT     i;
  284.     PVOID               MediaSpecificInfo = NULL;
  285.     UINT                MediaSpecificInfoSize = 0;
  286.     for (i = 0; i < NumberOfPackets; i++)
  287.     {
  288.         PNDIS_PACKET    Packet, MyPacket;
  289.         Packet = PacketArray[i];
  290. #ifdef NDIS51
  291.      //
  292.         // Use NDIS 5.1 packet stacking:
  293.      //
  294.      {
  295.             PNDIS_PACKET_STACK pStack;
  296.             BOOLEAN          Remaining;
  297.          //
  298.             // Packet stacks: Check if we can use the same packet for sending down.
  299.          //
  300.             pStack = NdisIMGetCurrentPacketStack(Packet, &Remaining);
  301.             if (Remaining)
  302.      {
  303.          //
  304.                 // We can reuse "Packet".
  305.          //
  306.                 // NOTE: if we needed to keep per-packet information in packets
  307.                 // sent down, we can use pStack->IMReserved[].
  308.          //
  309.                 ASSERT(pStack);
  310.                 NdisSend(&Status,
  311.                          pAdapt->BindingHandle,
  312.                   Packet);
  313.     
  314.                 if (Status != NDIS_STATUS_PENDING)
  315.          {
  316.                     NdisMSendComplete(ADAPT_MINIPORT_HANDLE(pAdapt),
  317.                        Packet,
  318.                            Status);
  319.          }
  320.                 continue;
  321.      }
  322.      }
  323. #endif
  324.         NdisAllocatePacket(&Status,
  325.                         &MyPacket,
  326.                            pAdapt->SendPacketPoolHandle);
  327.         if (Status == NDIS_STATUS_SUCCESS)
  328.      {
  329.             PSEND_RSVD   SendRsvd;
  330.             SendRsvd = (PSEND_RSVD)(MyPacket->ProtocolReserved);
  331.             SendRsvd->OriginalPkt = Packet;
  332.             MyPacket->Private.Flags = NdisGetPacketFlags(Packet);
  333.             MyPacket->Private.Head = Packet->Private.Head;
  334.             MyPacket->Private.Tail = Packet->Private.Tail;
  335. #ifdef WIN9X
  336.          //
  337.             // Work around the fact that NDIS does not initialize this
  338.             // to FALSE on Win9x.
  339.          //
  340.             MyPacket->Private.ValidCounts = FALSE;
  341. #endif // WIN9X
  342.          //
  343.             // Copy the OOB data from the original packet to the new
  344.             // packet.
  345.          //
  346.             NdisMoveMemory(NDIS_OOB_DATA_FROM_PACKET(MyPacket),
  347.                            NDIS_OOB_DATA_FROM_PACKET(Packet),
  348.                            sizeof(NDIS_PACKET_OOB_DATA));
  349.          //
  350.             // Copy relevant parts of the per packet info into the new packet
  351.          //
  352. #ifndef WIN9X
  353.             NdisIMCopySendPerPacketInfo(MyPacket, Packet);
  354. #endif
  355.          //
  356.             // Copy the Media specific information
  357.          //
  358.             NDIS_GET_PACKET_MEDIA_SPECIFIC_INFO(Packet,
  359.                                  &MediaSpecificInfo,
  360.                                      &MediaSpecificInfoSize);
  361.             if (MediaSpecificInfo || MediaSpecificInfoSize)
  362.      {
  363.                 NDIS_SET_PACKET_MEDIA_SPECIFIC_INFO(MyPacket,
  364.                                  MediaSpecificInfo,
  365.                                      MediaSpecificInfoSize);
  366.      }
  367.             NdisSend(&Status,
  368.                      pAdapt->BindingHandle,
  369.                   MyPacket);
  370.             if (Status != NDIS_STATUS_PENDING)
  371.      {
  372. #ifndef WIN9X
  373.                 NdisIMCopySendCompletePerPacketInfo (Packet, MyPacket);
  374. #endif
  375.                 NdisFreePacket(MyPacket);
  376.      }
  377.      }
  378.         if (Status != NDIS_STATUS_PENDING)
  379.      {
  380.             NdisMSendComplete(ADAPT_MINIPORT_HANDLE(pAdapt),
  381.                    Packet,
  382.                        Status);
  383.      }
  384.     }
  385. }
  386. NDIS_STATUS
  387. MPQueryInformation(
  388.     IN  NDIS_HANDLE             MiniportAdapterContext,
  389.     IN  NDIS_OID     Oid,
  390.     IN  PVOID                   InformationBuffer,
  391.     IN  ULONG                   InformationBufferLength,
  392.     OUT PULONG                  BytesWritten,
  393.     OUT PULONG               BytesNeeded
  394.     )
  395. /*++
  396. Routine Description:
  397.     Entry point called by NDIS to query for the value of the specified OID.
  398.     Typical processing is to forward the query down to the underlying miniport.
  399.     The following OIDs are filtered here:
  400.     OID_PNP_QUERY_POWER - return success right here
  401.     OID_GEN_SUPPORTED_GUIDS - do not forward, otherwise we will show up
  402.     multiple instances of private GUIDs supported by the underlying miniport.
  403.     OID_PNP_CAPABILITIES - we do send this down to the lower miniport, but
  404.     the values returned are postprocessed before we complete this request;
  405.     see PtRequestComplete.
  406.     NOTE on OID_TCP_TASK_OFFLOAD - if this IM driver modifies the contents
  407.     of data it passes through such that a lower miniport may not be able
  408.     to perform TCP task offload, then it should not forward this OID down,
  409.     but fail it here with the status NDIS_STATUS_NOT_SUPPORTED. This is to
  410.     avoid performing incorrect transformations on data.
  411.     If our miniport edge (upper edge) is at a low-power state, fail the request.
  412.     If our protocol edge (lower edge) has been notified of a low-power state,
  413.     we pend this request until the miniport below has been set to D0. Since
  414.     requests to miniports are serialized always, at most a single request will
  415.     be pended.
  416. Arguments:
  417.     MiniportAdapterContext  Pointer to the adapter structure
  418.     Oid                     Oid for this query
  419.     InformationBuffer       Buffer for information
  420.     InformationBufferLength Size of this buffer
  421.     BytesWritten            Specifies how much info is written
  422.     BytesNeeded             In case the buffer is smaller than what we need, tell them how much is needed
  423. Return Value:
  424.     Return code from the NdisRequest below.
  425. --*/
  426. {
  427.     PADAPT      pAdapt = (PADAPT)MiniportAdapterContext;
  428.     NDIS_STATUS Status = NDIS_STATUS_FAILURE;
  429.     do
  430.     {
  431.         if (Oid == OID_PNP_QUERY_POWER)
  432.      {
  433.          //
  434.             //  Do not forward this.
  435.          //
  436.             Status = NDIS_STATUS_SUCCESS;
  437.             break;
  438.      }
  439.         if (Oid == OID_GEN_SUPPORTED_GUIDS)
  440.      {
  441.          //
  442.             //  Do not forward this, otherwise we will end up with multiple
  443.             //  instances of private GUIDs that the underlying miniport
  444.             //  supports.
  445.          //
  446.             Status = NDIS_STATUS_NOT_SUPPORTED;
  447.             break;
  448.      }
  449.         if (Oid == OID_TCP_TASK_OFFLOAD)
  450.      {
  451.          //
  452.             // Fail this -if- this driver performs data transformations
  453.             // that can interfere with a lower driver's ability to offload
  454.             // TCP tasks.
  455.          //
  456.             // Status = NDIS_STATUS_NOT_SUPPORTED;
  457.             // break;
  458.          //
  459.      }
  460.      //
  461.         // All other queries are failed, if the miniport is not at D0
  462.      //
  463.         if (pAdapt->MPDeviceState > NdisDeviceStateD0 || pAdapt->StandingBy == TRUE)
  464.      {
  465.             Status = NDIS_STATUS_FAILURE;
  466.             break;
  467.      }
  468.         pAdapt->Request.RequestType = NdisRequestQueryInformation;
  469.         pAdapt->Request.DATA.QUERY_INFORMATION.Oid = Oid;
  470.         pAdapt->Request.DATA.QUERY_INFORMATION.InformationBuffer = InformationBuffer;
  471.         pAdapt->Request.DATA.QUERY_INFORMATION.InformationBufferLength = InformationBufferLength;
  472.         pAdapt->BytesNeeded = BytesNeeded;
  473.         pAdapt->BytesReadOrWritten = BytesWritten;
  474.         pAdapt->OutstandingRequests = TRUE;
  475.      //
  476.         // If the Protocol device state is OFF, mark this request as being
  477.         // pended. We queue this until the device state is back to D0.
  478.      //
  479.         if (pAdapt->PTDeviceState > NdisDeviceStateD0)
  480.      {
  481.             pAdapt->QueuedRequest = TRUE;
  482.             Status = NDIS_STATUS_PENDING;
  483.             break;
  484.      }
  485.      //
  486.         // default case, most requests will be passed to the miniport below
  487.      //
  488.         NdisRequest(&Status,
  489.                     pAdapt->BindingHandle,
  490.                     &pAdapt->Request);
  491.         if (Status != NDIS_STATUS_PENDING)
  492.      {
  493.             PtRequestComplete(pAdapt, &pAdapt->Request, Status);
  494.             Status = NDIS_STATUS_PENDING;
  495.      }
  496.     } while (FALSE);
  497.     return(Status);
  498. }
  499. VOID
  500. MPQueryPNPCapabilities(
  501.     IN OUT  PADAPT       pAdapt,
  502.     OUT     PNDIS_STATUS    pStatus
  503.     )
  504. /*++
  505. Routine Description:
  506.     Postprocess a request for OID_PNP_CAPABILITIES that was forwarded
  507.     down to the underlying miniport, and has been completed by it.
  508. Arguments:
  509.     pAdapt - Pointer to the adapter structure
  510.     pStatus - Place to return final status
  511. Return Value:
  512.     None.
  513. --*/
  514. {
  515.     PNDIS_PNP_CAPABILITIES          pPNPCapabilities;
  516.     PNDIS_PM_WAKE_UP_CAPABILITIES   pPMstruct;
  517.     if (pAdapt->Request.DATA.QUERY_INFORMATION.InformationBufferLength >= sizeof(NDIS_PNP_CAPABILITIES))
  518.     {
  519.         pPNPCapabilities = (PNDIS_PNP_CAPABILITIES)(pAdapt->Request.DATA.QUERY_INFORMATION.InformationBuffer);
  520.      //
  521.         // The following fields must be overwritten by an IM driver.
  522.      //
  523.         pPMstruct= & pPNPCapabilities->WakeUpCapabilities;
  524.         pPMstruct->MinMagicPacketWakeUp = NdisDeviceStateUnspecified;
  525.         pPMstruct->MinPatternWakeUp = NdisDeviceStateUnspecified;
  526.         pPMstruct->MinLinkChangeWakeUp = NdisDeviceStateUnspecified;
  527.         *pAdapt->BytesReadOrWritten = sizeof(NDIS_PNP_CAPABILITIES);
  528.         *pAdapt->BytesNeeded = 0;
  529.      //
  530.         // Setting our internal flags
  531.         // Default, device is ON
  532.      //
  533.         pAdapt->MPDeviceState = NdisDeviceStateD0;
  534.         pAdapt->PTDeviceState = NdisDeviceStateD0;
  535.         *pStatus = NDIS_STATUS_SUCCESS;
  536.     }
  537.     else
  538.     {
  539.         *pAdapt->BytesNeeded= sizeof(NDIS_PNP_CAPABILITIES);
  540.         *pStatus = NDIS_STATUS_RESOURCES;
  541.     }
  542. }
  543. NDIS_STATUS
  544. MPSetInformation(
  545.     IN  NDIS_HANDLE             MiniportAdapterContext,
  546.     IN  NDIS_OID     Oid,
  547.     IN  PVOID                   InformationBuffer,
  548.     IN  ULONG                   InformationBufferLength,
  549.     OUT PULONG               BytesRead,
  550.     OUT PULONG               BytesNeeded
  551.     )
  552. /*++
  553. Routine Description:
  554.     Miniport SetInfo handler.
  555.     In the case of OID_PNP_SET_POWER, record the power state and return the OID.
  556.     Do not pass below
  557.     If the device is suspended, do not block the SET_POWER_OID 
  558.     as it is used to reactivate the Passthru miniport
  559.     
  560.     PM- If the MP is not ON (DeviceState > D0) return immediately  (except for 'query power' and 'set power')
  561.          If MP is ON, but the PT is not at D0, then queue the queue the request for later processing
  562.     Requests to miniports are always serialized
  563. Arguments:
  564.     MiniportAdapterContext  Pointer to the adapter structure
  565.     Oid                     Oid for this query
  566.     InformationBuffer       Buffer for information
  567.     InformationBufferLength Size of this buffer
  568.     BytesRead               Specifies how much info is read
  569.     BytesNeeded             In case the buffer is smaller than what we need, tell them how much is needed
  570. Return Value:
  571.     Return code from the NdisRequest below.
  572. --*/
  573. {
  574.     PADAPT      pAdapt = (PADAPT)MiniportAdapterContext;
  575.     NDIS_STATUS Status;
  576.     Status = NDIS_STATUS_FAILURE;
  577.     do
  578.     {
  579.      //
  580.         // The Set Power should not be sent to the miniport below the Passthru, but is handled internally
  581.      //
  582.         if (Oid == OID_PNP_SET_POWER)
  583.      {
  584.             MPProcessSetPowerOid(&Status, 
  585.                       pAdapt, 
  586.                               InformationBuffer, 
  587.                                  InformationBufferLength, 
  588.                       BytesRead, 
  589.                           BytesNeeded);
  590.             break;
  591.      }
  592.      //
  593.         // All other Set Information requests are failed, if the miniport is
  594.         // not at D0 or is transitioning to a device state greater than D0.
  595.      //
  596.         if (pAdapt->MPDeviceState > NdisDeviceStateD0 || pAdapt->StandingBy == TRUE)
  597.      {
  598.             Status = NDIS_STATUS_FAILURE;
  599.             break;
  600.      }
  601.         // Set up the Request and return the result
  602.         pAdapt->Request.RequestType = NdisRequestSetInformation;
  603.         pAdapt->Request.DATA.SET_INFORMATION.Oid = Oid;
  604.         pAdapt->Request.DATA.SET_INFORMATION.InformationBuffer = InformationBuffer;
  605.         pAdapt->Request.DATA.SET_INFORMATION.InformationBufferLength = InformationBufferLength;
  606.         pAdapt->BytesNeeded = BytesNeeded;
  607.         pAdapt->BytesReadOrWritten = BytesRead;
  608.         pAdapt->OutstandingRequests = TRUE;
  609.      //
  610.         // If the device below is at a low power state, we cannot send it the
  611.         // request now, and must pend it.
  612.      //
  613.         if (pAdapt->PTDeviceState > NdisDeviceStateD0)
  614.      {
  615.             pAdapt->QueuedRequest = TRUE;
  616.             Status = NDIS_STATUS_PENDING;
  617.             break;
  618.      }
  619.      //
  620.         // Forward the request to the device below.
  621.      //
  622.         NdisRequest(&Status,
  623.                     pAdapt->BindingHandle,
  624.                     &pAdapt->Request);
  625.         if (Status == NDIS_STATUS_SUCCESS)
  626.      {
  627.             *BytesRead = pAdapt->Request.DATA.SET_INFORMATION.BytesRead;
  628.             *BytesNeeded = pAdapt->Request.DATA.SET_INFORMATION.BytesNeeded;
  629.      }
  630.         if (Status != NDIS_STATUS_PENDING)
  631.      {
  632.             pAdapt->OutstandingRequests = FALSE;
  633.      }
  634.     } while (FALSE);
  635.     return(Status);
  636. }
  637. VOID
  638. MPProcessSetPowerOid(
  639.     IN OUT PNDIS_STATUS         pNdisStatus,
  640.     IN  PADAPT           pAdapt,
  641.     IN  PVOID                   InformationBuffer,
  642.     IN  ULONG                   InformationBufferLength,
  643.     OUT PULONG               BytesRead,
  644.     OUT PULONG               BytesNeeded
  645.     )
  646. /*++
  647. Routine Description:
  648.     This routine does all the procssing for a request with a SetPower Oid
  649.     The miniport shoud accept  the Set Power and transition to the new state
  650.     The Set Power should not be passed to the miniport below
  651.     If the IM miniport is going into a low power state, then there is no guarantee if it will ever
  652.     be asked go back to D0, before getting halted. No requests should be pended or queued.
  653.     
  654. Arguments:
  655.     pNdisStatus         - Status of the operation
  656.     pAdapt              - The Adapter structure
  657.     InformationBuffer   - The New DeviceState
  658.     InformationBufferLength
  659.     BytesRead           - No of bytes read
  660.     BytesNeeded         -  No of bytes needed
  661. Return Value:
  662.     Status  - NDIS_STATUS_SUCCESS if all the wait events succeed.
  663. --*/
  664. {
  665.     
  666.     NDIS_DEVICE_POWER_STATE NewDeviceState;
  667.     DBGPRINT(("==>MPProcessSetPowerOid: Adapt %pn", pAdapt)); 
  668.     ASSERT (InformationBuffer != NULL);
  669.     *pNdisStatus = NDIS_STATUS_FAILURE;
  670.     do 
  671.     {
  672.      //
  673.         // Check for invalid length
  674.      //
  675.         if (InformationBufferLength < sizeof(NDIS_DEVICE_POWER_STATE))
  676.      {
  677.             *pNdisStatus = NDIS_STATUS_INVALID_LENGTH;
  678.             break;
  679.      }
  680.         NewDeviceState = (*(PNDIS_DEVICE_POWER_STATE)InformationBuffer);
  681.      //
  682.         // Check for invalid device state
  683.      //
  684.         if ((pAdapt->MPDeviceState > NdisDeviceStateD0) && (NewDeviceState != NdisDeviceStateD0))
  685.      {
  686.          //
  687.             // If the miniport is in a non-D0 state, the miniport can only receive a Set Power to D0
  688.          //
  689.             ASSERT (!(pAdapt->MPDeviceState > NdisDeviceStateD0) && (NewDeviceState != NdisDeviceStateD0));
  690.             *pNdisStatus = NDIS_STATUS_FAILURE;
  691.             break;
  692.      }
  693.      //
  694.         // Is the miniport transitioning from an On (D0) state to an Low Power State (>D0)
  695.         // If so, then set the StandingBy Flag - (Block all incoming requests)
  696.      //
  697.         if (pAdapt->MPDeviceState == NdisDeviceStateD0 && NewDeviceState > NdisDeviceStateD0)
  698.      {
  699.             pAdapt->StandingBy = TRUE;
  700.      }
  701.      //
  702.         // If the miniport is transitioning from a low power state to ON (D0), then clear the StandingBy flag
  703.         // All incoming requests will be pended until the physical miniport turns ON.
  704.      //
  705.         if (pAdapt->MPDeviceState > NdisDeviceStateD0 &&  NewDeviceState == NdisDeviceStateD0)
  706.      {
  707.             pAdapt->StandingBy = FALSE;
  708.      }
  709.     
  710.      //
  711.         // Now update the state in the pAdapt structure;
  712.      //
  713.         pAdapt->MPDeviceState = NewDeviceState;
  714.     
  715.         *pNdisStatus = NDIS_STATUS_SUCCESS;
  716.     
  717.     } while (FALSE);
  718.     
  719.     if (*pNdisStatus == NDIS_STATUS_SUCCESS)
  720.     {
  721.         //
  722.         // The miniport resume from low power state
  723.         // 
  724.         if (pAdapt->StandingBy == FALSE)
  725.         {
  726.             //
  727.             // If we need to indicate the media connect state
  728.             // 
  729.             if (pAdapt->LastIndicatedStatus != pAdapt->LatestUnIndicateStatus)
  730.             {
  731.                NdisMIndicateStatus(pAdapt->MiniportHandle,
  732.                                         pAdapt->LatestUnIndicateStatus,
  733.                                         (PVOID)NULL,
  734.                                         0);
  735.                NdisMIndicateStatusComplete(pAdapt->MiniportHandle);
  736.                pAdapt->LastIndicatedStatus = pAdapt->LatestUnIndicateStatus;
  737.             }
  738.         }
  739.         else
  740.         {
  741.             //
  742.             // Initialize LatestUnIndicatedStatus
  743.             //
  744.             pAdapt->LatestUnIndicateStatus = pAdapt->LastIndicatedStatus;
  745.         }
  746.         *BytesRead = sizeof(NDIS_DEVICE_POWER_STATE);
  747.         *BytesNeeded = 0;
  748.     }
  749.     else
  750.     {
  751.         *BytesRead = 0;
  752.         *BytesNeeded = sizeof (NDIS_DEVICE_POWER_STATE);
  753.     }
  754.     DBGPRINT(("<==MPProcessSetPowerOid: Adapt %pn", pAdapt)); 
  755. }
  756. VOID
  757. MPReturnPacket(
  758.     IN  NDIS_HANDLE             MiniportAdapterContext,
  759.     IN  PNDIS_PACKET         Packet
  760.     )
  761. /*++
  762. Routine Description:
  763.     NDIS Miniport entry point called whenever protocols are done with
  764.     a packet that we had indicated up and they had queued up for returning
  765.     later.
  766. Arguments:
  767.     MiniportAdapterContext  - pointer to ADAPT structure
  768.     Packet  - packet being returned.
  769. Return Value:
  770.     None.
  771. --*/
  772. {
  773.     PADAPT          pAdapt = (PADAPT)MiniportAdapterContext;
  774. #ifdef NDIS51
  775.     //
  776.     // Packet stacking: Check if this packet belongs to us.
  777.     //
  778.     if (NdisGetPoolFromPacket(Packet) != pAdapt->RecvPacketPoolHandle)
  779.     {
  780.      //
  781.         // We reused the original packet in a receive indication.
  782.         // Simply return it to the miniport below us.
  783.      //
  784.         NdisReturnPackets(&Packet, 1);
  785.     }
  786.     else
  787. #endif // NDIS51
  788.     {
  789.      //
  790.         // This is a packet allocated from this IM's receive packet pool.
  791.         // Reclaim our packet, and return the original to the driver below.
  792.      //
  793.         PNDIS_PACKET    MyPacket;
  794.         PRECV_RSVD      RecvRsvd;
  795.     
  796.         RecvRsvd = (PRECV_RSVD)(Packet->MiniportReserved);
  797.         MyPacket = RecvRsvd->OriginalPkt;
  798.     
  799.         NdisFreePacket(Packet);
  800.         NdisReturnPackets(&MyPacket, 1);
  801.     }
  802. }
  803. NDIS_STATUS
  804. MPTransferData(
  805.     OUT PNDIS_PACKET         Packet,
  806.     OUT PUINT                   BytesTransferred,
  807.     IN  NDIS_HANDLE             MiniportAdapterContext,
  808.     IN  NDIS_HANDLE             MiniportReceiveContext,
  809.     IN  UINT             ByteOffset,
  810.     IN  UINT                 BytesToTransfer
  811.     )
  812. /*++
  813. Routine Description:
  814.     Miniport's transfer data handler.
  815. Arguments:
  816.     Packet                  Destination packet
  817.     BytesTransferred        Place-holder for how much data was copied
  818.     MiniportAdapterContext  Pointer to the adapter structure
  819.     MiniportReceiveContext  Context
  820.     ByteOffset              Offset into the packet for copying data
  821.     BytesToTransfer         How much to copy.
  822. Return Value:
  823.     Status of transfer
  824. --*/
  825. {
  826.     PADAPT      pAdapt = (PADAPT)MiniportAdapterContext;
  827.     NDIS_STATUS Status;
  828.     //
  829.     // Return, if the device is OFF
  830.     //
  831.     if (IsIMDeviceStateOn(pAdapt) == FALSE)
  832.     {
  833.         return NDIS_STATUS_FAILURE;
  834.     }
  835.     NdisTransferData(&Status,
  836.                      pAdapt->BindingHandle,
  837.                      MiniportReceiveContext,
  838.                      ByteOffset,
  839.                      BytesToTransfer,
  840.                   Packet,
  841.                      BytesTransferred);
  842.     return(Status);
  843. }
  844. VOID
  845. MPHalt(
  846.     IN  NDIS_HANDLE             MiniportAdapterContext
  847.     )
  848. /*++
  849. Routine Description:
  850.     Halt handler. All the hard-work for clean-up is done here.
  851. Arguments:
  852.     MiniportAdapterContext  Pointer to the Adapter
  853. Return Value:
  854.     None.
  855. --*/
  856. {
  857.     PADAPT          pAdapt = (PADAPT)MiniportAdapterContext;
  858.     NDIS_STATUS     Status;
  859.     PADAPT          pCursor, *ppCursor;
  860.     PADAPT          pPromoteAdapt = NULL;
  861.     DBGPRINT(("==>MiniportHalt: Adapt %pn", pAdapt));
  862.     //
  863.     // Remove this adapter from the global list
  864.     //
  865.     NdisAcquireSpinLock(&GlobalLock);
  866.     for (ppCursor = &pAdaptList; *ppCursor != NULL; ppCursor = &(*ppCursor)->Next)
  867.     {
  868.         if (*ppCursor == pAdapt)
  869.      {
  870.             *ppCursor = pAdapt->Next;
  871.             break;
  872.      }
  873.     }
  874.     NdisReleaseSpinLock(&GlobalLock);
  875.     //
  876.     // Delete the ioctl interface that was created when the miniport
  877.     // was created.
  878.     //
  879.     (VOID)PtDeregisterDevice();
  880.     //
  881.     // If we have a valid bind, close the miniport below the protocol
  882.     //
  883.     if (pAdapt->BindingHandle != NULL)
  884.     {
  885.      //
  886.         // Close the binding below. and wait for it to complete
  887.      //
  888.         NdisResetEvent(&pAdapt->Event);
  889.         NdisCloseAdapter(&Status, pAdapt->BindingHandle);
  890.         if (Status == NDIS_STATUS_PENDING)
  891.      {
  892.             NdisWaitEvent(&pAdapt->Event, 0);
  893.             Status = pAdapt->Status;
  894.      }
  895.         ASSERT (Status == NDIS_STATUS_SUCCESS);
  896.         pAdapt->BindingHandle = NULL;
  897.     }
  898.     //
  899.     //  Free all resources on this adapter structure.
  900.     //
  901.     PtDerefAdapter(pAdapt);
  902.     DBGPRINT(("<== MiniportHalt: pAdapt %pn", pAdapt));
  903. }
  904. NDIS_STATUS
  905. MPReset(
  906.     OUT PBOOLEAN                AddressingReset,
  907.     IN  NDIS_HANDLE             MiniportAdapterContext
  908.     )
  909. /*++
  910. Routine Description:
  911.     Reset Handler. We just don't do anything.
  912. Arguments:
  913.     AddressingReset         To let NDIS know whether we need help from it with our reset
  914.     MiniportAdapterContext  Pointer to our adapter
  915. Return Value:
  916. --*/
  917. {
  918.     PADAPT  pAdapt = (PADAPT)MiniportAdapterContext;
  919.     *AddressingReset = FALSE;
  920.     return(NDIS_STATUS_SUCCESS);
  921. }
  922. #ifdef NDIS51_MINIPORT
  923. VOID
  924. MPCancelSendPackets(
  925.     IN  NDIS_HANDLE         MiniportAdapterContext,
  926.     IN  PVOID            CancelId
  927.     )
  928. /*++
  929. Routine Description:
  930.     The miniport entry point to handle cancellation of all send packets
  931.     that match the given CancelId. If we have queued any packets that match
  932.     this, then we should dequeue them and call NdisMSendComplete for all
  933.     such packets, with a status of NDIS_STATUS_REQUEST_ABORTED.
  934.     We should also call NdisCancelSendPackets in turn, on each lower binding
  935.     that this adapter corresponds to. This is to let miniports below cancel
  936.     any matching packets.
  937. Arguments:
  938.     MiniportAdapterContext  - pointer to ADAPT structure
  939.     CancelId    - ID of packets to be cancelled.
  940. Return Value:
  941.     None
  942. --*/
  943. {
  944.     PADAPT  pAdapt = (PADAPT)MiniportAdapterContext;
  945.     //
  946.     // If we queue packets on our adapter structure, this would be 
  947.     // the place to acquire a spinlock to it, unlink any packets whose
  948.     // Id matches CancelId, release the spinlock and call NdisMSendComplete
  949.     // with NDIS_STATUS_REQUEST_ABORTED for all unlinked packets.
  950.     //
  951.     //
  952.     // Next, pass this down so that we let the miniport(s) below cancel
  953.     // any packets that they might have queued.
  954.     //
  955.     NdisCancelSendPackets(pAdapt->BindingHandle, CancelId);
  956.     return;
  957. }
  958. VOID
  959. MPDevicePnPEvent(
  960.     IN NDIS_HANDLE              MiniportAdapterContext,
  961.     IN NDIS_DEVICE_PNP_EVENT    DevicePnPEvent,
  962.     IN PVOID                    InformationBuffer,
  963.     IN ULONG                    InformationBufferLength
  964.     )
  965. /*++
  966. Routine Description:
  967.     This handler is called to notify us of PnP events directed to
  968.     our miniport device object.
  969. Arguments:
  970.     MiniportAdapterContext  - pointer to ADAPT structure
  971.     DevicePnPEvent - the event
  972.     InformationBuffer - Points to additional event-specific information
  973.     InformationBufferLength - length of above
  974. Return Value:
  975.     None
  976. --*/
  977. {
  978.     // TBD - add code/comments about processing this.
  979.     return;
  980. }
  981. VOID
  982. MPAdapterShutdown(
  983.     IN NDIS_HANDLE              MiniportAdapterContext
  984.     )
  985. /*++
  986. Routine Description:
  987.     This handler is called to notify us of an impending system shutdown.
  988. Arguments:
  989.     MiniportAdapterContext  - pointer to ADAPT structure
  990. Return Value:
  991.     None
  992. --*/
  993. {
  994.     return;
  995. }
  996. #endif
  997. VOID
  998. MPFreeAllPacketPools(
  999.     PADAPT           pAdapt
  1000.     )
  1001. /*++
  1002. Routine Description:
  1003.     Free all packet pools on the specified adapter.
  1004.     
  1005. Arguments:
  1006.     pAdapt  - pointer to ADAPT structure
  1007. Return Value:
  1008.     None
  1009. --*/
  1010. {
  1011.     if (pAdapt->RecvPacketPoolHandle != NULL)
  1012.     {
  1013.      //
  1014.         // Free the packet pool that is used to indicate receives
  1015.      //
  1016.         NdisFreePacketPool(pAdapt->RecvPacketPoolHandle);
  1017.         pAdapt->RecvPacketPoolHandle = NULL;
  1018.     }
  1019.     if (pAdapt->SendPacketPoolHandle != NULL)
  1020.     {
  1021.      //
  1022.         //  Free the packet pool that is used to send packets below
  1023.      //
  1024.         NdisFreePacketPool(pAdapt->SendPacketPoolHandle);
  1025.         pAdapt->SendPacketPoolHandle = NULL;
  1026.     }
  1027. }