Sample Code
Windows Driver Samples/ HBtnKey Input Driver/ C++/ HBtnKey/ pnp.c/
/*++
Copyright (c) 2000,2001 Microsoft Corporation
Module Name:
pnp.c
Abstract:
This module contains code to handle PnP and Power IRPs.
Environment:
Kernel mode
--*/
#include "pch.h"
#define MODULE_ID 1
#ifdef ALLOC_PRAGMA
#pragma alloc_text(PAGE, HbtnPower)
#pragma alloc_text(PAGE, SendSyncIrp)
#endif
/*++
@doc EXTERNAL
@func NTSTATUS | HbtnPnp |
Plug and Play dispatch routine for this driver.
@parm IN PDEVICE_OBJECT | DevObj | Pointer to the device object.
@parm IN PIRP | Irp | Pointer to an I/O request packet.
@rvalue SUCCESS | returns STATUS_SUCCESS.
@rvalue FAILURE | returns NT status code.
--*/
NTSTATUS EXTERNAL
HbtnPnp(
IN PDEVICE_OBJECT DevObj,
IN PIRP Irp
)
{
NTSTATUS status = STATUS_SUCCESS;
PIO_STACK_LOCATION irpsp = NULL;
PDEVICE_EXTENSION devext = NULL;
irpsp = IoGetCurrentIrpStackLocation(Irp);
TEnter(Func,("(DevObj=%p,Irp=%p,IrpSp=%p,Minor=%s)\n",
DevObj, Irp, irpsp,
LookupName(irpsp->MinorFunction, PnpMinorIrpNames)));
devext = GET_MINIDRIVER_DEVICE_EXTENSION(DevObj);
status = IoAcquireRemoveLock(&devext->RemoveLock, Irp);
if (!NT_SUCCESS(status))
{
//
// Someone sent us another plug and play IRP after removed
//
LogError(ERRLOG_DEVICE_REMOVED,
status,
UNIQUE_ERRID(0x10),
NULL,
NULL);
TWarn(("received IRP after device was removed.\n"));
Irp->IoStatus.Information = 0;
Irp->IoStatus.Status = status;
IoCompleteRequest(Irp, IO_NO_INCREMENT);
}
else
{
BOOLEAN fRemove = FALSE;
BOOLEAN fForward = FALSE;
switch (irpsp->MinorFunction)
{
case IRP_MN_START_DEVICE:
case IRP_MN_CANCEL_REMOVE_DEVICE:
TAssert(!(devext->dwfHBtn & HBTNF_DEVICE_STARTED));
//
// Forward the IRP down the stack
//
status = SendSyncIrp(devext->LowerDevObj, Irp, TRUE);
if (NT_SUCCESS(status))
{
status = OemStartDevice(devext, Irp);
if (NT_SUCCESS(status))
{
devext->dwfHBtn |= HBTNF_DEVICE_STARTED;
}
}
else
{
LogError(ERRLOG_LOWERDRV_IRP_FAILED,
status,
UNIQUE_ERRID(0x20),
NULL,
NULL);
TErr(("failed to forward IRP.\n"));
}
Irp->IoStatus.Information = 0;
Irp->IoStatus.Status = status;
IoCompleteRequest(Irp, IO_NO_INCREMENT);
break;
case IRP_MN_REMOVE_DEVICE:
case IRP_MN_SURPRISE_REMOVAL:
fRemove = TRUE;
//
// Fall through.
//
case IRP_MN_STOP_DEVICE:
case IRP_MN_QUERY_REMOVE_DEVICE:
//
// After the start IRP has been sent to the lower driver
// object, the bus may NOT send any more IRPS down ``touch''
// until another START has occured. Whatever access is
// required must be done before Irp passed on.
//
if (devext->dwfHBtn & HBTNF_DEVICE_STARTED)
{
status = OemRemoveDevice(devext, Irp);
devext->dwfHBtn &= ~HBTNF_DEVICE_STARTED;
}
//
// We don't need a completion routine so fire and forget.
// Set the current stack location to the next stack location and
// call the next device object.
//
fForward = TRUE;
Irp->IoStatus.Status = status;
break;
case IRP_MN_QUERY_CAPABILITIES:
status = SendSyncIrp(devext->LowerDevObj, Irp, TRUE);
if (NT_SUCCESS(status))
{
PDEVICE_CAPABILITIES devcaps;
devcaps = irpsp->Parameters.DeviceCapabilities.Capabilities;
if (devcaps != NULL)
{
SYSTEM_POWER_STATE i;
//
// This device is built-in to the system, so it should
// be impossible to surprise remove this device, but
// we will handle it anyway.
//
devcaps->SurpriseRemovalOK = TRUE;
//
// While the underlying serial bus might be able to
// wake the machine from low power (via wake on ring),
// the tablet cannot.
//
devcaps->SystemWake = PowerSystemUnspecified;
devcaps->DeviceWake = PowerDeviceUnspecified;
devcaps->WakeFromD0 =
devcaps->WakeFromD1 =
devcaps->WakeFromD2 =
devcaps->WakeFromD3 = FALSE;
devcaps->DeviceState[PowerSystemWorking] =
PowerDeviceD0;
for (i = PowerSystemSleeping1;
i < PowerSystemMaximum;
i++)
{
devcaps->DeviceState[i] = PowerDeviceD3;
}
}
}
else
{
LogError(ERRLOG_LOWERDRV_IRP_FAILED,
status,
UNIQUE_ERRID(0x30),
NULL,
NULL);
TErr(("failed to forward IRP.\n"));
}
IoCompleteRequest(Irp, IO_NO_INCREMENT);
break;
case IRP_MN_QUERY_PNP_DEVICE_STATE:
Irp->IoStatus.Information &= ~PNP_DEVICE_NOT_DISABLEABLE;
Irp->IoStatus.Status = STATUS_SUCCESS;
fForward = TRUE;
break;
default:
fForward = TRUE;
break;
}
if (fForward)
{
IoSkipCurrentIrpStackLocation(Irp);
TInfo((".IoCallDriver(DevObj=%p,Irp=%p)\n",
devext->LowerDevObj, Irp));
status = IoCallDriver(devext->LowerDevObj, Irp);
TInfo((".IoCallDriver=%x\n", status));
}
if (fRemove)
{
//
// Wait for the remove lock to free.
//
IoReleaseRemoveLockAndWait(&devext->RemoveLock, Irp);
}
else
{
IoReleaseRemoveLock(&devext->RemoveLock, Irp);
}
}
TExit(Func,("=%x\n", status));
return status;
} //HbtnPnp
/*++
@doc EXTERNAL
@func NTSTATUS | HbtnPower | The power dispatch routine for this driver.
@parm IN PDEVICE_OBJECT | DevObj | Points to the device object.
@parm IN PIRP | Irp | Points to an I/O request packet.
@rvalue SUCCESS | returns STATUS_SUCCESS.
@rvalue FAILURE | returns NT status code.
--*/
NTSTATUS EXTERNAL
HbtnPower(
IN PDEVICE_OBJECT DevObj,
IN PIRP Irp
)
{
NTSTATUS status = STATUS_SUCCESS;
PDEVICE_EXTENSION devext = NULL;
PAGED_CODE();
TEnter(Func,("(DevObj=%p,Irp=%p,Minor=%s)\n",
DevObj, Irp,
LookupName(IoGetCurrentIrpStackLocation(Irp)->MinorFunction,
PowerMinorIrpNames)));
devext = GET_MINIDRIVER_DEVICE_EXTENSION(DevObj);
status = IoAcquireRemoveLock(&devext->RemoveLock, Irp);
if (!NT_SUCCESS(status))
{
//
// Someone sent us another power IRP after removed
//
LogError(ERRLOG_DEVICE_REMOVED,
status,
UNIQUE_ERRID(0x40),
NULL,
NULL);
TErr(("received IRP after device was removed.\n"));
Irp->IoStatus.Status = status;
IoCompleteRequest(Irp, IO_NO_INCREMENT);
}
else
{
#ifdef PERFORMANCE_TEST
ULONGLONG BeforeTime, AfterTime;
PIO_STACK_LOCATION irpsp = IoGetCurrentIrpStackLocation(Irp);
#endif
IoSkipCurrentIrpStackLocation(Irp);
TInfo((".PoCallDriver(DevObj=%p,Irp=%p)\n",
devext->LowerDevObj, Irp));
#ifdef PERFORMANCE_TEST
BeforeTime = KeQueryInterruptTime();
#endif
status = PoCallDriver(devext->LowerDevObj, Irp);
#ifdef PERFORMANCE_TEST
AfterTime = KeQueryInterruptTime();
AfterTime -= BeforeTime;
AfterTime /= 10000;
LOGDBGMSG((ERRLOG_DEBUG_INFORMATION,
status,
"%d:PowerIrp(%s,%x,%x)",
(ULONG)AfterTime,
LookupName(irpsp->MinorFunction, PowerMinorIrpNames),
irpsp->Parameters.Power.Type,
irpsp->Parameters.Power.State));
#endif
TExit(Func,(".PoCallDriver=%x\n", status));
IoReleaseRemoveLock(&devext->RemoveLock, Irp);
}
TExit(Func,("=%x\n", status));
return status;
} //HbtnPower
/*++
@doc INTERNAL
@func NTSTATUS | SendSyncIrp |
Send an IRP synchronously down the stack.
@parm IN PDEVICE_OBJECT | DevObj | Points to the device object.
@parm IN PIRP | Irp | Points to the IRP.
@parm IN BOOLEAN | fCopyToNext | if TRUE, copy the irpsp to next location.
@rvalue SUCCESS | returns STATUS_SUCCESS.
@rvalue FAILURE | returns NT status code.
--*/
NTSTATUS INTERNAL
SendSyncIrp(
_In_ PDEVICE_OBJECT DevObj,
_In_ PIRP Irp,
_In_ BOOLEAN fCopyToNext
)
{
NTSTATUS status = STATUS_SUCCESS;
PIO_STACK_LOCATION irpsp = IoGetCurrentIrpStackLocation(Irp);
KEVENT event = {0};
PAGED_CODE();
TEnter(Func,("(DevObj=%p,Irp=%p,fCopyToNext=%x,MajorFunc=%s)\n",
DevObj, Irp, fCopyToNext,
LookupName(irpsp->MajorFunction, MajorIrpNames)));
KeInitializeEvent(&event, SynchronizationEvent, FALSE);
if (fCopyToNext)
{
IoCopyCurrentIrpStackLocationToNext(Irp);
}
IoSetCompletionRoutine(Irp, IrpCompletion, &event, TRUE, TRUE, TRUE);
if (irpsp->MajorFunction == IRP_MJ_POWER)
{
TInfo((".PoCallDriver(DevObj=%p,Irp=%p)\n", DevObj, Irp));
status = PoCallDriver(DevObj, Irp);
TInfo((".IoCallDriver=%x\n", status));
}
else
{
TInfo((".IoCallDriver(DevObj=%p,Irp=%p)\n", DevObj, Irp));
status = IoCallDriver(DevObj, Irp);
TInfo((".IoCallDriver=%x\n", status));
}
if (status == STATUS_PENDING)
{
status = KeWaitForSingleObject(&event,
Executive,
KernelMode,
FALSE,
NULL);
}
if (NT_SUCCESS(status))
{
status = Irp->IoStatus.Status;
}
TExit(Func,("=%x\n", status));
return status;
} //SendSyncIrp
/*++
@doc INTERNAL
@func NTSTATUS | IrpCompletion | Completion routine for all IRPs.
@parm IN PDEVICE_OBJECT | DevObj | Points to the device object.
@parm IN PIRP | Irp | Points to an I/O request packet.
@parm IN PKEVENT | Event | Points to the event to notify.
@rvalue Always returns STATUS_MORE_PROCESSING_REQUIRED.
--*/
NTSTATUS INTERNAL
IrpCompletion(
_In_ PDEVICE_OBJECT DevObj,
_In_ PIRP Irp,
_In_reads_opt_(_Inexpressible_("varies")) PVOID Event
)
{
NTSTATUS status = STATUS_MORE_PROCESSING_REQUIRED;
TEnter(Func,("(DevObj=%p,Irp=%p,Event=%p)\n", DevObj, Irp, Event));
UNREFERENCED_PARAMETER(DevObj);
UNREFERENCED_PARAMETER(Irp);
ASSERT(Event);
if(NULL != Event)
{
KeSetEvent((PKEVENT)Event, 0, FALSE);
}
TExit(Func,("=%x\n", status));
return status;
} //IrpCompletion
Our Services
-
What our customers say about us?
Read our customer testimonials to find out why our clients keep returning for their projects.
View Testimonials
