-/*
- * COPYRIGHT: See COPYING in the top level directory
- * PROJECT: ReactOS kernel
- * FILE: drivers/input/kbdclass/kbdclass.c
- * PURPOSE: Keyboard class driver
- * PROGRAMMER: Victor Kirhenshtein (sauros@iname.com)
- * Jason Filby (jasonfilby@yahoo.com)
- * Tinus_
+/*
+ * COPYRIGHT: See COPYING in the top level directory
+ * PROJECT: ReactOS Keyboard class driver
+ * FILE: drivers/kbdclass/kbdclass.c
+ * PURPOSE: Keyboard class driver
+ *
+ * PROGRAMMERS: Hervé Poussineau (hpoussin@reactos.org)
*/
-/* INCLUDES ****************************************************************/
-
-#include <ddk/ntddk.h>
-
#define NDEBUG
#include <debug.h>
+#define INITGUID
#include "kbdclass.h"
-/* GLOBALS *******************************************************************/
+static NTSTATUS
+SearchForLegacyDrivers(
+ IN PDRIVER_OBJECT DriverObject,
+ IN PCLASS_DRIVER_EXTENSION DriverExtension);
-/*
- * Driver data
- */
+static VOID NTAPI
+DriverUnload(IN PDRIVER_OBJECT DriverObject)
+{
+ // nothing to do here yet
+}
+
+static NTSTATUS NTAPI
+ClassCreate(
+ IN PDEVICE_OBJECT DeviceObject,
+ IN PIRP Irp)
+{
+ DPRINT("IRP_MJ_CREATE\n");
+
+ if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
+ return ForwardIrpAndForget(DeviceObject, Irp);
-static BOOLEAN AlreadyOpened = FALSE;
+ /* FIXME: open all associated Port devices */
+ return STATUS_SUCCESS;
+}
-static VOID STDCALL KbdCopyKeys(PDEVICE_OBJECT DeviceObject,
- PIRP Irp)
+static NTSTATUS NTAPI
+ClassClose(
+ IN PDEVICE_OBJECT DeviceObject,
+ IN PIRP Irp)
{
- PDEVICE_EXTENSION DevExt = DeviceObject->DeviceExtension;
- PIO_STACK_LOCATION stk = IoGetCurrentIrpStackLocation(Irp);
- ULONG NrToRead = stk->Parameters.Read.Length /
- sizeof(KEYBOARD_INPUT_DATA);
- ULONG NrRead = Irp->IoStatus.Information/sizeof(KEYBOARD_INPUT_DATA);
- KEYBOARD_INPUT_DATA *Rec =
- (KEYBOARD_INPUT_DATA *)Irp->AssociatedIrp.SystemBuffer;
-
- while (DevExt->KeysInBuffer &&
- NrRead < NrToRead) {
- memcpy(&Rec[NrRead],
- &DevExt->KbdBuffer[DevExt->BufHead],
- sizeof(KEYBOARD_INPUT_DATA));
-
- if (++DevExt->BufHead >= KBD_BUFFER_SIZE)
- DevExt->BufHead = 0;
-
- DevExt->KeysInBuffer--;
- NrRead++;
- }
- Irp->IoStatus.Information = NrRead * sizeof(KEYBOARD_INPUT_DATA);
-
- if (NrRead < NrToRead) {
- Irp->IoStatus.Status = STATUS_PENDING;
- DPRINT("Pending... (NrRead %d, NrToRead %d\n", NrRead, NrToRead);
- } else {
- DPRINT("Send scancode: %x\n", ((KEYBOARD_INPUT_DATA*)Irp->AssociatedIrp.SystemBuffer)->MakeCode);
- Irp->IoStatus.Status = STATUS_SUCCESS;
- IoCompleteRequest(Irp, IO_NO_INCREMENT);
- IoStartNextPacket (DeviceObject, FALSE);
- DPRINT("Success!\n");
- }
+ DPRINT("IRP_MJ_CLOSE\n");
+
+ if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
+ return ForwardIrpAndForget(DeviceObject, Irp);
+
+ /* FIXME: close all associated Port devices */
+ return STATUS_SUCCESS;
}
-static VOID STDCALL KbdClassServiceCallback (
- PDEVICE_OBJECT DeviceObject,
- PKEYBOARD_INPUT_DATA InputDataStart,
- PKEYBOARD_INPUT_DATA InputDataEnd,
- PULONG InputDataConsumed)
+static NTSTATUS NTAPI
+ClassCleanup(
+ IN PDEVICE_OBJECT DeviceObject,
+ IN PIRP Irp)
{
- PDEVICE_EXTENSION DevExt = DeviceObject->DeviceExtension;
- PKEYBOARD_INPUT_DATA CurrentInput = InputDataStart;
+ DPRINT("IRP_MJ_CLEANUP\n");
- DPRINT("ServiceCallback called\n");
+ if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
+ return ForwardIrpAndForget(DeviceObject, Irp);
- while (DevExt->KeysInBuffer < KBD_BUFFER_SIZE &&
- CurrentInput < InputDataEnd) {
- memcpy(&DevExt->KbdBuffer[DevExt->BufTail],
- CurrentInput,
- sizeof(KEYBOARD_INPUT_DATA));
+ /* FIXME: cleanup all associated Port devices */
+ return STATUS_SUCCESS;
+}
- if (++DevExt->BufTail >= KBD_BUFFER_SIZE)
- DevExt->BufTail = 0;
- DevExt->KeysInBuffer++;
+static NTSTATUS NTAPI
+ClassRead(
+ IN PDEVICE_OBJECT DeviceObject,
+ IN PIRP Irp)
+{
+ DPRINT("IRP_MJ_READ\n");
- CurrentInput++;
- InputDataConsumed[0]++;
- }
+ if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
+ return ForwardIrpAndForget(DeviceObject, Irp);
- if (CurrentInput < InputDataStart)
- /* Copy the rest to the beginning, perhaps the keyboard
- * can buffer it for us */
- memmove(InputDataStart,
- CurrentInput,
- ((char *)InputDataEnd - (char *)CurrentInput));
+ if (IoGetCurrentIrpStackLocation(Irp)->Parameters.Read.Length < sizeof(KEYBOARD_INPUT_DATA))
+ {
+ Irp->IoStatus.Status = STATUS_BUFFER_TOO_SMALL;
+ Irp->IoStatus.Information = 0;
+ IoCompleteRequest(Irp, IO_NO_INCREMENT);
- if (DeviceObject->CurrentIrp) {
- PIRP Irp = DeviceObject->CurrentIrp;
- PIO_STACK_LOCATION stk = IoGetCurrentIrpStackLocation(Irp);
- if (stk->MajorFunction == IRP_MJ_READ)
- KbdCopyKeys(DeviceObject, Irp);
+ return STATUS_BUFFER_TOO_SMALL;
}
+
+ IoMarkIrpPending(Irp);
+ IoStartPacket(DeviceObject, Irp, NULL, NULL);
+ return STATUS_PENDING;
}
-VOID STDCALL KbdStartIo(PDEVICE_OBJECT DeviceObject, PIRP Irp)
+static NTSTATUS NTAPI
+ClassDeviceControl(
+ IN PDEVICE_OBJECT DeviceObject,
+ IN PIRP Irp)
{
- /* We only do this for read irps */
- DPRINT("KeyboardStartIo(DeviceObject %x Irp %x)\n",DeviceObject,Irp);
- KbdCopyKeys(DeviceObject, Irp);
-}
+ PCLASS_DEVICE_EXTENSION DeviceExtension;
+ NTSTATUS Status;
+ DPRINT("IRP_MJ_DEVICE_CONTROL\n");
+
+ if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
+ return ForwardIrpAndForget(DeviceObject, Irp);
+
+ DeviceExtension = (PCLASS_DEVICE_EXTENSION)DeviceObject->DeviceExtension;
+
+ switch (IoGetCurrentIrpStackLocation(Irp)->Parameters.DeviceIoControl.IoControlCode)
+ {
+ case IOCTL_KEYBOARD_QUERY_ATTRIBUTES:
+ case IOCTL_KEYBOARD_QUERY_INDICATOR_TRANSLATION:
+ case IOCTL_KEYBOARD_QUERY_INDICATORS:
+ case IOCTL_KEYBOARD_QUERY_TYPEMATIC:
+ case IOCTL_KEYBOARD_SET_INDICATORS:
+ case IOCTL_KEYBOARD_SET_TYPEMATIC: /* not in MSDN, would seem logical */
+ /* FIXME: send it to all associated Port devices */
+ Status = STATUS_NOT_SUPPORTED;
+ break;
+ default:
+ DPRINT1("IRP_MJ_DEVICE_CONTROL / unknown I/O control code 0x%lx\n",
+ IoGetCurrentIrpStackLocation(Irp)->Parameters.DeviceIoControl.IoControlCode);
+ Status = STATUS_NOT_SUPPORTED;
+ }
-/*
- * These are just passed down the stack but we must change the IOCTL to be
- * INTERNAL. MSDN says there might be more...
- */
-NTSTATUS STDCALL KbdDeviceControl(PDEVICE_OBJECT DeviceObject, PIRP Irp)
+ Irp->IoStatus.Status = Status;
+ Irp->IoStatus.Information = 0;
+ IoCompleteRequest(Irp, IO_NO_INCREMENT);
+
+ return Status;
+}
+
+static NTSTATUS NTAPI
+IrpStub(
+ IN PDEVICE_OBJECT DeviceObject,
+ IN PIRP Irp)
{
- PDEVICE_EXTENSION DevExt = DeviceObject->DeviceExtension;
- PIO_STACK_LOCATION Stk = IoGetCurrentIrpStackLocation(Irp);
- PIO_STACK_LOCATION NextStk = IoGetNextIrpStackLocation(Irp);
-
- DPRINT ("KbdDeviceControl %x\n", Stk->Parameters.DeviceIoControl.IoControlCode);
-
- switch (Stk->Parameters.DeviceIoControl.IoControlCode) {
- case IOCTL_KEYBOARD_QUERY_ATTRIBUTES:
- case IOCTL_KEYBOARD_QUERY_INDICATOR_TRANSLATION:
- case IOCTL_KEYBOARD_QUERY_INDICATORS:
- case IOCTL_KEYBOARD_QUERY_TYPEMATIC:
- case IOCTL_KEYBOARD_SET_INDICATORS:
- case IOCTL_KEYBOARD_SET_TYPEMATIC: /* not in MSDN, would seem logical */
- IoCopyCurrentIrpStackLocationToNext(Irp);
- NextStk->MajorFunction = IRP_MJ_INTERNAL_DEVICE_CONTROL;
-
- return IoCallDriver(DevExt->I8042Device, Irp);
- default:
- return STATUS_INVALID_DEVICE_REQUEST;
+ NTSTATUS Status = STATUS_NOT_SUPPORTED;
+
+ if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
+ {
+ /* Forward some IRPs to lower device */
+ switch (IoGetCurrentIrpStackLocation(Irp)->MajorFunction)
+ {
+ case IRP_MJ_INTERNAL_DEVICE_CONTROL:
+ return ForwardIrpAndForget(DeviceObject, Irp);
+ default:
+ {
+ DPRINT1("Port DO stub for major function 0x%lx\n",
+ IoGetCurrentIrpStackLocation(Irp)->MajorFunction);
+ ASSERT(FALSE);
+ Status = Irp->IoStatus.Status;
+ }
+ }
+ }
+ else
+ {
+ DPRINT1("Class DO stub for major function 0x%lx\n",
+ IoGetCurrentIrpStackLocation(Irp)->MajorFunction);
+ ASSERT(FALSE);
+ Status = Irp->IoStatus.Status;
}
+
+ Irp->IoStatus.Status = Status;
+ IoCompleteRequest(Irp, IO_NO_INCREMENT);
+ return Status;
}
-static NTSTATUS STDCALL KbdInternalDeviceControl(PDEVICE_OBJECT DeviceObject,
- PIRP Irp)
+static NTSTATUS
+ReadRegistryEntries(
+ IN PUNICODE_STRING RegistryPath,
+ IN PCLASS_DRIVER_EXTENSION DriverExtension)
{
- PDEVICE_EXTENSION DevExt = DeviceObject->DeviceExtension;
+ UNICODE_STRING ParametersRegistryKey;
+ RTL_QUERY_REGISTRY_TABLE Parameters[4];
+ NTSTATUS Status;
- DPRINT ("KbdInternalDeviceControl\n");
+ ULONG DefaultConnectMultiplePorts = 0;
+ ULONG DefaultDataQueueSize = 0x64;
+ UNICODE_STRING DefaultDeviceBaseName = RTL_CONSTANT_STRING(L"KeyboardClass");
+
+ ParametersRegistryKey.Length = 0;
+ ParametersRegistryKey.MaximumLength = RegistryPath->Length + sizeof(L"\\Parameters") + sizeof(UNICODE_NULL);
+ ParametersRegistryKey.Buffer = ExAllocatePool(PagedPool, ParametersRegistryKey.MaximumLength);
+ if (!ParametersRegistryKey.Buffer)
+ {
+ DPRINT("ExAllocatePool() failed\n");
+ return STATUS_INSUFFICIENT_RESOURCES;
+ }
+ RtlCopyUnicodeString(&ParametersRegistryKey, RegistryPath);
+ RtlAppendUnicodeToString(&ParametersRegistryKey, L"\\Parameters");
+ ParametersRegistryKey.Buffer[ParametersRegistryKey.Length / sizeof(WCHAR)] = UNICODE_NULL;
+
+ RtlZeroMemory(Parameters, sizeof(Parameters));
+
+ Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+ Parameters[0].Name = L"ConnectMultiplePorts";
+ Parameters[0].EntryContext = &DriverExtension->ConnectMultiplePorts;
+ Parameters[0].DefaultType = REG_DWORD;
+ Parameters[0].DefaultData = &DefaultConnectMultiplePorts;
+ Parameters[0].DefaultLength = sizeof(ULONG);
+
+ Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+ Parameters[1].Name = L"KeyboardDataQueueSize";
+ Parameters[1].EntryContext = &DriverExtension->DataQueueSize;
+ Parameters[1].DefaultType = REG_DWORD;
+ Parameters[1].DefaultData = &DefaultDataQueueSize;
+ Parameters[1].DefaultLength = sizeof(ULONG);
+
+ Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+ Parameters[2].Name = L"KeyboardDeviceBaseName";
+ Parameters[2].EntryContext = &DriverExtension->DeviceBaseName;
+ Parameters[2].DefaultType = REG_SZ;
+ Parameters[2].DefaultData = &DefaultDeviceBaseName;
+ Parameters[2].DefaultLength = 0;
+
+ Status = RtlQueryRegistryValues(
+ RTL_REGISTRY_ABSOLUTE,
+ ParametersRegistryKey.Buffer,
+ Parameters,
+ NULL,
+ NULL);
+
+ if (NT_SUCCESS(Status))
+ {
+ /* Check values */
+ if (DriverExtension->ConnectMultiplePorts != 0
+ && DriverExtension->ConnectMultiplePorts != 1)
+ {
+ DriverExtension->ConnectMultiplePorts = DefaultConnectMultiplePorts;
+ }
+ if (DriverExtension->DataQueueSize == 0)
+ {
+ DriverExtension->DataQueueSize = DefaultDataQueueSize;
+ }
+ }
+ else if (Status == STATUS_OBJECT_NAME_NOT_FOUND)
+ {
+ /* Registry path doesn't exist. Set defaults */
+ DriverExtension->ConnectMultiplePorts = DefaultConnectMultiplePorts;
+ DriverExtension->DataQueueSize = DefaultDataQueueSize;
+ Status = RtlDuplicateUnicodeString(
+ RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE,
+ &DefaultDeviceBaseName,
+ &DriverExtension->DeviceBaseName);
+ }
- IoSkipCurrentIrpStackLocation(Irp);
- return IoCallDriver(DevExt->I8042Device, Irp);
+ return Status;
}
-static NTSTATUS STDCALL KbdDispatch(PDEVICE_OBJECT DeviceObject, PIRP Irp)
+static NTSTATUS
+CreateClassDeviceObject(
+ IN PDRIVER_OBJECT DriverObject,
+ OUT PDEVICE_OBJECT *ClassDO OPTIONAL)
{
- PIO_STACK_LOCATION stk = IoGetCurrentIrpStackLocation(Irp);
+ PCLASS_DRIVER_EXTENSION DriverExtension;
+ UNICODE_STRING SymbolicLinkName = RTL_CONSTANT_STRING(L"\\??\\Keyboard");
+ ULONG DeviceId = 0;
+ ULONG PrefixLength;
+ UNICODE_STRING DeviceNameU;
+ PWSTR DeviceIdW = NULL; /* Pointer into DeviceNameU.Buffer */
+ PDEVICE_OBJECT Fdo;
+ PCLASS_DEVICE_EXTENSION DeviceExtension;
NTSTATUS Status;
- DPRINT("DeviceObject %x\n",DeviceObject);
- DPRINT("Irp %x\n",Irp);
-
- DPRINT("Dispatch: stk->MajorFunction %d\n", stk->MajorFunction);
- DPRINT("AlreadyOpened %d\n",AlreadyOpened);
-
- switch (stk->MajorFunction) {
- case IRP_MJ_CREATE:
- if (AlreadyOpened == TRUE) {
- CHECKPOINT;
- Status = STATUS_UNSUCCESSFUL;
- DPRINT1("Keyboard is already open\n");
- } else {
- CHECKPOINT;
- Status = STATUS_SUCCESS;
- AlreadyOpened = TRUE;
+ DPRINT("CreateClassDeviceObject(0x%p)\n", DriverObject);
+
+ /* Create new device object */
+ DriverExtension = IoGetDriverObjectExtension(DriverObject, DriverObject);
+ DeviceNameU.Length = 0;
+ DeviceNameU.MaximumLength =
+ wcslen(L"\\Device\\") * sizeof(WCHAR) /* "\Device\" */
+ + DriverExtension->DeviceBaseName.Length /* "KeyboardClass" */
+ + 4 * sizeof(WCHAR) /* Id between 0 and 9999 */
+ + sizeof(UNICODE_NULL); /* Final NULL char */
+ DeviceNameU.Buffer = ExAllocatePool(PagedPool, DeviceNameU.MaximumLength);
+ if (!DeviceNameU.Buffer)
+ {
+ DPRINT("ExAllocatePool() failed\n");
+ return STATUS_INSUFFICIENT_RESOURCES;
+ }
+ Status = RtlAppendUnicodeToString(&DeviceNameU, L"\\Device\\");
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("RtlAppendUnicodeToString() failed with status 0x%08lx\n", Status);
+ goto cleanup;
+ }
+ Status = RtlAppendUnicodeStringToString(&DeviceNameU, &DriverExtension->DeviceBaseName);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("RtlAppendUnicodeStringToString() failed with status 0x%08lx\n", Status);
+ goto cleanup;
+ }
+ PrefixLength = DeviceNameU.MaximumLength - 4 * sizeof(WCHAR) - sizeof(UNICODE_NULL);
+ DeviceIdW = &DeviceNameU.Buffer[PrefixLength / sizeof(WCHAR)];
+ while (DeviceId < 9999)
+ {
+ DeviceNameU.Length = PrefixLength + swprintf(DeviceIdW, L"%lu", DeviceId) * sizeof(WCHAR);
+ Status = IoCreateDevice(
+ DriverObject,
+ sizeof(CLASS_DEVICE_EXTENSION),
+ &DeviceNameU,
+ FILE_DEVICE_KEYBOARD,
+ FILE_DEVICE_SECURE_OPEN,
+ TRUE,
+ &Fdo);
+ if (NT_SUCCESS(Status))
+ goto cleanup;
+ else if (Status != STATUS_OBJECT_NAME_COLLISION)
+ {
+ DPRINT("IoCreateDevice() failed with status 0x%08lx\n", Status);
+ goto cleanup;
}
- break;
+ DeviceId++;
+ }
+ DPRINT("Too much devices starting with '\\Device\\%wZ'\n", &DriverExtension->DeviceBaseName);
+ Status = STATUS_UNSUCCESSFUL;
+cleanup:
+ if (!NT_SUCCESS(Status))
+ {
+ ExFreePool(DeviceNameU.Buffer);
+ return Status;
+ }
- case IRP_MJ_CLOSE:
- Status = STATUS_SUCCESS;
- AlreadyOpened = FALSE;
- break;
+ DeviceExtension = (PCLASS_DEVICE_EXTENSION)Fdo->DeviceExtension;
+ RtlZeroMemory(DeviceExtension, sizeof(CLASS_DEVICE_EXTENSION));
+ DeviceExtension->Common.IsClassDO = TRUE;
+ DeviceExtension->DriverExtension = DriverExtension;
+ KeInitializeSpinLock(&(DeviceExtension->SpinLock));
+ DeviceExtension->ReadIsPending = FALSE;
+ DeviceExtension->InputCount = 0;
+ DeviceExtension->PortData = ExAllocatePool(NonPagedPool, DeviceExtension->DriverExtension->DataQueueSize * sizeof(KEYBOARD_INPUT_DATA));
+ Fdo->Flags |= DO_POWER_PAGABLE;
+ Fdo->Flags &= ~DO_DEVICE_INITIALIZING;
+
+ /* Add entry entry to HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\[DeviceBaseName] */
+ RtlWriteRegistryValue(
+ RTL_REGISTRY_DEVICEMAP,
+ DriverExtension->DeviceBaseName.Buffer,
+ DeviceNameU.Buffer,
+ REG_SZ,
+ DriverExtension->RegistryPath.Buffer,
+ DriverExtension->RegistryPath.MaximumLength);
+
+ /* HACK: 1st stage setup needs a keyboard to open it in user-mode
+ * Create a link to user space... */
+ IoCreateSymbolicLink(&SymbolicLinkName, &DeviceNameU);
+
+ ExFreePool(DeviceNameU.Buffer);
+
+ if (ClassDO)
+ *ClassDO = Fdo;
+
+ return STATUS_SUCCESS;
+}
+
+static BOOLEAN
+ClassCallback(
+ IN PDEVICE_OBJECT ClassDeviceObject,
+ IN OUT PKEYBOARD_INPUT_DATA DataStart,
+ IN PKEYBOARD_INPUT_DATA DataEnd,
+ IN OUT PULONG ConsumedCount)
+{
+ PCLASS_DEVICE_EXTENSION ClassDeviceExtension = ClassDeviceObject->DeviceExtension;
+ PIRP Irp = NULL;
+ KIRQL OldIrql;
+ PIO_STACK_LOCATION Stack;
+ ULONG InputCount = DataEnd - DataStart;
+ ULONG ReadSize;
+
+ ASSERT(ClassDeviceExtension->Common.IsClassDO);
+
+ KeAcquireSpinLock(&ClassDeviceExtension->SpinLock, &OldIrql);
+
+ DPRINT("ClassCallback()\n");
+ /* A filter driver might have consumed all the data already; I'm
+ * not sure if they are supposed to move the packets when they
+ * consume them though.
+ */
+ if (ClassDeviceExtension->ReadIsPending == TRUE && InputCount)
+ {
+ Irp = ClassDeviceObject->CurrentIrp;
+ ClassDeviceObject->CurrentIrp = NULL;
+ Stack = IoGetCurrentIrpStackLocation(Irp);
+
+ /* A read request is waiting for input, so go straight to it */
+ /* FIXME: use SEH */
+ RtlCopyMemory(
+ Irp->MdlAddress ? MmGetSystemAddressForMdlSafe(Irp->MdlAddress, NormalPagePriority) : Irp->UserBuffer,
+ DataStart,
+ sizeof(KEYBOARD_INPUT_DATA));
+
+ /* Go to next packet and complete this request with STATUS_SUCCESS */
+ Irp->IoStatus.Status = STATUS_SUCCESS;
+ Irp->IoStatus.Information = sizeof(KEYBOARD_INPUT_DATA);
+ Stack->Parameters.Read.Length = sizeof(KEYBOARD_INPUT_DATA);
- case IRP_MJ_READ:
- DPRINT("Queueing packet\n");
- IoMarkIrpPending(Irp);
- IoStartPacket(DeviceObject,Irp,NULL,NULL);
- return(STATUS_PENDING);
+ ClassDeviceExtension->ReadIsPending = FALSE;
- default:
- Status = STATUS_NOT_IMPLEMENTED;
- break;
+ /* Skip the packet we just sent away */
+ DataStart++;
+ (*ConsumedCount)++;
+ InputCount--;
}
- Irp->IoStatus.Status = Status;
- Irp->IoStatus.Information = 0;
- IoCompleteRequest(Irp,IO_NO_INCREMENT);
- DPRINT("Status %d\n",Status);
- return(Status);
+ /* If we have data from the port driver and a higher service to send the data to */
+ if (InputCount != 0)
+ {
+ if (ClassDeviceExtension->InputCount + InputCount > ClassDeviceExtension->DriverExtension->DataQueueSize)
+ ReadSize = ClassDeviceExtension->DriverExtension->DataQueueSize - ClassDeviceExtension->InputCount;
+ else
+ ReadSize = InputCount;
+
+ /*
+ * FIXME: If we exceed the buffer, data gets thrown away.. better
+ * solution?
+ */
+
+ /*
+ * Move the input data from the port data queue to our class data
+ * queue.
+ */
+ RtlMoveMemory(
+ ClassDeviceExtension->PortData,
+ (PCHAR)DataStart,
+ sizeof(KEYBOARD_INPUT_DATA) * ReadSize);
+
+ /* Move the pointer and counter up */
+ ClassDeviceExtension->PortData += ReadSize;
+ ClassDeviceExtension->InputCount += ReadSize;
+
+ (*ConsumedCount) += ReadSize;
+ }
+ else
+ {
+ DPRINT("ClassCallBack() entered, InputCount = %lu - DOING NOTHING\n", InputCount);
+ }
+
+ KeReleaseSpinLock(&ClassDeviceExtension->SpinLock, OldIrql);
+
+ if (Irp != NULL)
+ {
+ IoStartNextPacket(ClassDeviceObject, FALSE);
+ IoCompleteRequest(Irp, IO_KEYBOARD_INCREMENT);
+ }
+
+ DPRINT("Leaving ClassCallback()\n");
+ return TRUE;
}
-static VOID STDCALL KbdClassSendConnect(PDEVICE_EXTENSION DevExt)
+/* Send IOCTL_INTERNAL_*_CONNECT to port */
+static NTSTATUS
+ConnectPortDriver(
+ IN PDEVICE_OBJECT PortDO,
+ IN PDEVICE_OBJECT ClassDO)
{
- CONNECT_DATA ConnectData;
KEVENT Event;
+ PIRP Irp;
IO_STATUS_BLOCK IoStatus;
+ CONNECT_DATA ConnectData;
NTSTATUS Status;
- PIRP Irp;
KeInitializeEvent(&Event, NotificationEvent, FALSE);
- ConnectData.ClassDeviceObject = DevExt->DeviceObject;
- ConnectData.ClassService = KbdClassServiceCallback;
-
- Irp = IoBuildDeviceIoControlRequest(
- IOCTL_INTERNAL_KEYBOARD_CONNECT,
- DevExt->I8042Device,
- &ConnectData,
- sizeof(CONNECT_DATA),
- NULL,
- 0,
- TRUE,
- &Event,
- &IoStatus);
-
- if (!Irp)
- return;
-
- Status = IoCallDriver(
- DevExt->I8042Device,
- Irp);
- DPRINT("SendConnect status: %x\n", Status);
-
- if (STATUS_PENDING ==Status)
- KeWaitForSingleObject(&Event,
- Executive,
- KernelMode,
- FALSE,
- NULL);
- DPRINT("SendConnect done\n");
+ ConnectData.ClassDeviceObject = ClassDO;
+ ConnectData.ClassService = ClassCallback;
+
+ Irp = IoBuildDeviceIoControlRequest(IOCTL_INTERNAL_KEYBOARD_CONNECT,
+ PortDO,
+ &ConnectData, sizeof(CONNECT_DATA),
+ NULL, 0,
+ TRUE, &Event, &IoStatus);
+
+ Status = IoCallDriver(PortDO, Irp);
+
+ if (Status == STATUS_PENDING)
+ KeWaitForSingleObject(&Event, Suspended, KernelMode, FALSE, NULL);
+ else
+ IoStatus.Status = Status;
+
+ if (NT_SUCCESS(IoStatus.Status))
+ ObReferenceObject(PortDO);
+
+ return IoStatus.Status;
+}
+
+static NTSTATUS NTAPI
+ClassAddDevice(
+ IN PDRIVER_OBJECT DriverObject,
+ IN PDEVICE_OBJECT Pdo)
+{
+ PCLASS_DRIVER_EXTENSION DriverExtension;
+ PDEVICE_OBJECT Fdo;
+ PPORT_DEVICE_EXTENSION DeviceExtension;
+ NTSTATUS Status;
+
+ DPRINT("ClassAddDevice called. Pdo = 0x%p\n", Pdo);
+
+ DriverExtension = IoGetDriverObjectExtension(DriverObject, DriverObject);
+
+ if (Pdo == NULL)
+ /* We're getting a NULL Pdo at the first call as we're a legacy driver.
+ * Use it to search for legacy port drivers. */
+ return SearchForLegacyDrivers(DriverObject, DriverExtension);
+
+ /* Create new device object */
+ Status = IoCreateDevice(
+ DriverObject,
+ sizeof(PORT_DEVICE_EXTENSION),
+ NULL,
+ Pdo->DeviceType,
+ FILE_DEVICE_SECURE_OPEN,
+ TRUE,
+ &Fdo);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("IoCreateDevice() failed with status 0x%08lx\n", Status);
+ return Status;
+ }
+
+ DeviceExtension = (PPORT_DEVICE_EXTENSION)Fdo->DeviceExtension;
+ RtlZeroMemory(DeviceExtension, sizeof(CLASS_DEVICE_EXTENSION));
+ DeviceExtension->Common.IsClassDO = FALSE;
+ DeviceExtension->PnpState = dsStopped;
+ Status = IoAttachDeviceToDeviceStackSafe(Fdo, Pdo, &DeviceExtension->LowerDevice);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("IoAttachDeviceToDeviceStackSafe() failed with status 0x%08lx\n", Status);
+ IoDeleteDevice(Fdo);
+ return Status;
+ }
+ if (DeviceExtension->LowerDevice->Flags & DO_POWER_PAGABLE)
+ Fdo->Flags |= DO_POWER_PAGABLE;
+ if (DeviceExtension->LowerDevice->Flags & DO_BUFFERED_IO)
+ Fdo->Flags |= DO_BUFFERED_IO;
+
+ if (DriverExtension->ConnectMultiplePorts)
+ Status = ConnectPortDriver(Fdo, DriverExtension->MainClassDeviceObject);
+ else
+ Status = ConnectPortDriver(Fdo, Fdo);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("ConnectPortDriver() failed with status 0x%08lx\n", Status);
+ IoDetachDevice(DeviceExtension->LowerDevice);
+ /* FIXME: why can't I cleanup without error? */
+ //IoDeleteDevice(Fdo);
+ return Status;
+ }
+ Fdo->Flags &= ~DO_DEVICE_INITIALIZING;
+
+ /* Register interface */
+ Status = IoRegisterDeviceInterface(
+ Pdo,
+ &GUID_DEVINTERFACE_KEYBOARD,
+ NULL,
+ &DeviceExtension->InterfaceName);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("IoRegisterDeviceInterface() failed with status 0x%08lx\n", Status);
+ return Status;
+ }
+
+ return STATUS_SUCCESS;
+}
+
+static VOID NTAPI
+ClassStartIo(
+ IN PDEVICE_OBJECT DeviceObject,
+ IN PIRP Irp)
+{
+ PCLASS_DEVICE_EXTENSION DeviceExtension = DeviceObject->DeviceExtension;
+ PIO_STACK_LOCATION Stack = IoGetCurrentIrpStackLocation(Irp);
+
+ ASSERT(DeviceExtension->Common.IsClassDO);
+
+ if (DeviceExtension->InputCount > 0)
+ {
+ KIRQL oldIrql;
+
+ KeAcquireSpinLock(&DeviceExtension->SpinLock, &oldIrql);
+
+ DPRINT("Mdl: %p, UserBuffer: %p, InputCount: %lu\n",
+ Irp->MdlAddress,
+ Irp->UserBuffer,
+ DeviceExtension->InputCount);
+
+ /* FIXME: use SEH */
+ RtlCopyMemory(
+ Irp->MdlAddress ? MmGetSystemAddressForMdlSafe(Irp->MdlAddress, NormalPagePriority) : Irp->UserBuffer,
+ DeviceExtension->PortData - DeviceExtension->InputCount,
+ sizeof(KEYBOARD_INPUT_DATA));
+
+ if (DeviceExtension->InputCount > 1)
+ {
+ RtlMoveMemory(
+ DeviceExtension->PortData - DeviceExtension->InputCount,
+ DeviceExtension->PortData - DeviceExtension->InputCount + 1,
+ (DeviceExtension->InputCount - 1) * sizeof(KEYBOARD_INPUT_DATA));
+ }
+ DeviceExtension->PortData--;
+ DeviceExtension->InputCount--;
+ DeviceExtension->ReadIsPending = FALSE;
+
+ /* Go to next packet and complete this request with STATUS_SUCCESS */
+ Irp->IoStatus.Status = STATUS_SUCCESS;
+ Irp->IoStatus.Information = sizeof(KEYBOARD_INPUT_DATA);
+ Stack->Parameters.Read.Length = sizeof(KEYBOARD_INPUT_DATA);
+ IoCompleteRequest(Irp, IO_KEYBOARD_INCREMENT);
+
+ IoStartNextPacket(DeviceObject, FALSE);
+ KeReleaseSpinLock(&DeviceExtension->SpinLock, oldIrql);
+ }
+ else
+ {
+ DeviceExtension->ReadIsPending = TRUE;
+ }
+}
+
+static NTSTATUS
+SearchForLegacyDrivers(
+ IN PDRIVER_OBJECT DriverObject,
+ IN PCLASS_DRIVER_EXTENSION DriverExtension)
+{
+ UNICODE_STRING DeviceMapKeyU = RTL_CONSTANT_STRING(L"\\REGISTRY\\MACHINE\\HARDWARE\\DEVICEMAP");
+ UNICODE_STRING PortBaseName = {0, };
+ PKEY_VALUE_BASIC_INFORMATION KeyValueInformation = NULL;
+ OBJECT_ATTRIBUTES ObjectAttributes;
+ HANDLE hDeviceMapKey = (HANDLE)-1;
+ HANDLE hPortKey = (HANDLE)-1;
+ ULONG Index = 0;
+ ULONG Size, ResultLength;
+ NTSTATUS Status;
+
+ /* Create port base name, by replacing Class by Port at the end of the class base name */
+ Status = RtlDuplicateUnicodeString(
+ RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE,
+ &DriverExtension->DeviceBaseName,
+ &PortBaseName);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("RtlDuplicateUnicodeString() failed with status 0x%08lx\n", Status);
+ goto cleanup;
+ }
+ PortBaseName.Length -= (sizeof(L"Class") - sizeof(UNICODE_NULL));
+ RtlAppendUnicodeToString(&PortBaseName, L"Port");
+
+ /* Allocate memory */
+ Size = sizeof(KEY_VALUE_BASIC_INFORMATION) + MAX_PATH;
+ KeyValueInformation = ExAllocatePool(PagedPool, Size);
+ if (!KeyValueInformation)
+ {
+ DPRINT("ExAllocatePool() failed\n");
+ Status = STATUS_INSUFFICIENT_RESOURCES;
+ goto cleanup;
+ }
+
+ /* Open HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP */
+ InitializeObjectAttributes(&ObjectAttributes, &DeviceMapKeyU, OBJ_KERNEL_HANDLE | OBJ_CASE_INSENSITIVE, NULL, NULL);
+ Status = ZwOpenKey(&hDeviceMapKey, 0, &ObjectAttributes);
+ if (Status == STATUS_OBJECT_NAME_NOT_FOUND)
+ {
+ DPRINT("HKLM\\HARDWARE\\DEVICEMAP is non-existent\n");
+ Status = STATUS_SUCCESS;
+ goto cleanup;
+ }
+ else if (!NT_SUCCESS(Status))
+ {
+ DPRINT("ZwOpenKey() failed with status 0x%08lx\n", Status);
+ goto cleanup;
+ }
+
+ /* Open sub key */
+ InitializeObjectAttributes(&ObjectAttributes, &PortBaseName, OBJ_KERNEL_HANDLE | OBJ_CASE_INSENSITIVE, hDeviceMapKey, NULL);
+ Status = ZwOpenKey(&hPortKey, KEY_QUERY_VALUE, &ObjectAttributes);
+ if (Status == STATUS_OBJECT_NAME_NOT_FOUND)
+ {
+ DPRINT("HKLM\\HARDWARE\\DEVICEMAP\\%wZ is non-existent\n", &PortBaseName);
+ Status = STATUS_SUCCESS;
+ goto cleanup;
+ }
+ else if (!NT_SUCCESS(Status))
+ {
+ DPRINT("ZwOpenKey() failed with status 0x%08lx\n", Status);
+ goto cleanup;
+ }
+
+ /* Read each value name */
+ while (ZwEnumerateValueKey(hPortKey, Index++, KeyValueBasicInformation, KeyValueInformation, Size, &ResultLength) == STATUS_SUCCESS)
+ {
+ UNICODE_STRING PortName;
+ PDEVICE_OBJECT PortDeviceObject = NULL;
+ PFILE_OBJECT FileObject = NULL;
+
+ PortName.Length = PortName.MaximumLength = KeyValueInformation->NameLength;
+ PortName.Buffer = KeyValueInformation->Name;
+
+ /* Open the device object pointer */
+ Status = IoGetDeviceObjectPointer(&PortName, FILE_READ_ATTRIBUTES, &FileObject, &PortDeviceObject);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("IoGetDeviceObjectPointer(%wZ) failed with status 0x%08lx\n", Status);
+ }
+
+ /* Connect the port device object */
+ if (DriverExtension->ConnectMultiplePorts)
+ {
+ Status = ConnectPortDriver(PortDeviceObject, DriverExtension->MainClassDeviceObject);
+ if (!NT_SUCCESS(Status))
+ {
+ /* FIXME: Log the error */
+ DPRINT("ConnectPortDriver() failed with status 0x%08lx\n", Status);
+ }
+ }
+ else
+ {
+ PDEVICE_OBJECT ClassDO;
+ Status = CreateClassDeviceObject(DriverObject, &ClassDO);
+ if (!NT_SUCCESS(Status))
+ {
+ /* FIXME: Log the error */
+ DPRINT("CreatePointerClassDeviceObject() failed with status 0x%08lx\n", Status);
+ continue;
+ }
+ Status = ConnectPortDriver(PortDeviceObject, ClassDO);
+ if (!NT_SUCCESS(Status))
+ {
+ /* FIXME: Log the error */
+ DPRINT("ConnectPortDriver() failed with status 0x%08lx\n", Status);
+ IoDeleteDevice(ClassDO);
+ }
+ }
+ }
+ if (Status == STATUS_NO_MORE_ENTRIES)
+ Status = STATUS_SUCCESS;
+
+cleanup:
+ if (KeyValueInformation != NULL)
+ ExFreePool(KeyValueInformation);
+ if (hDeviceMapKey != (HANDLE)-1)
+ ZwClose(hDeviceMapKey);
+ if (hPortKey != (HANDLE)-1)
+ ZwClose(hPortKey);
+ return Status;
}
-NTSTATUS STDCALL DriverEntry(PDRIVER_OBJECT DriverObject,
- PUNICODE_STRING RegistryPath)
/*
- * FUNCTION: Module entry point
+ * Standard DriverEntry method.
*/
+NTSTATUS NTAPI
+DriverEntry(
+ IN PDRIVER_OBJECT DriverObject,
+ IN PUNICODE_STRING RegistryPath)
{
- PDEVICE_OBJECT DeviceObject;
- PDEVICE_EXTENSION DevExt;
- PFILE_OBJECT I8042File;
+ PCLASS_DRIVER_EXTENSION DriverExtension;
+ ULONG i;
NTSTATUS Status;
- UNICODE_STRING DeviceName = RTL_CONSTANT_STRING(L"\\Device\\Keyboard");
- UNICODE_STRING SymlinkName = RTL_CONSTANT_STRING(L"\\??\\Keyboard");
- UNICODE_STRING I8042Name = RTL_CONSTANT_STRING(L"\\Device\\KeyboardClass0");
-
- DPRINT("Keyboard Class Driver 0.0.1\n");
-
- DriverObject->MajorFunction[IRP_MJ_CREATE] = KbdDispatch;
- DriverObject->MajorFunction[IRP_MJ_CLOSE] = KbdDispatch;
- DriverObject->MajorFunction[IRP_MJ_READ] = KbdDispatch;
- DriverObject->MajorFunction[IRP_MJ_INTERNAL_DEVICE_CONTROL] =
- KbdInternalDeviceControl;
- DriverObject->MajorFunction[IRP_MJ_DEVICE_CONTROL] = KbdDeviceControl;
-
- DriverObject->DriverStartIo = KbdStartIo;
-
- IoCreateDevice(DriverObject,
- sizeof(DEVICE_EXTENSION),
- &DeviceName,
- FILE_DEVICE_KEYBOARD,
- 0,
- TRUE,
- &DeviceObject);
-
- RtlZeroMemory(DeviceObject->DeviceExtension, sizeof(DEVICE_EXTENSION));
- DevExt = DeviceObject->DeviceExtension;
- DevExt->DeviceObject = DeviceObject;
-
- Status = IoGetDeviceObjectPointer(&I8042Name,
- FILE_READ_DATA,
- &I8042File,
- &DevExt->I8042Device);
-
- if (STATUS_SUCCESS != Status) {
- DPRINT("Failed to open device: %x\n", Status);
+
+ Status = IoAllocateDriverObjectExtension(
+ DriverObject,
+ DriverObject,
+ sizeof(CLASS_DRIVER_EXTENSION),
+ (PVOID*)&DriverExtension);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("IoAllocateDriverObjectExtension() failed with status 0x%08lx\n", Status);
+ return Status;
+ }
+ RtlZeroMemory(DriverExtension, sizeof(CLASS_DRIVER_EXTENSION));
+
+ Status = RtlDuplicateUnicodeString(
+ RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE,
+ RegistryPath,
+ &DriverExtension->RegistryPath);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("RtlDuplicateUnicodeString() failed with status 0x%08lx\n", Status);
return Status;
}
- ObReferenceObject(DevExt->I8042Device);
- ObDereferenceObject(I8042File);
+ Status = ReadRegistryEntries(RegistryPath, DriverExtension);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("ReadRegistryEntries() failed with status 0x%08lx\n", Status);
+ return Status;
+ }
- DeviceObject->Flags = DeviceObject->Flags | DO_BUFFERED_IO;
+ if (DriverExtension->ConnectMultiplePorts == 1)
+ {
+ Status = CreateClassDeviceObject(
+ DriverObject,
+ &DriverExtension->MainClassDeviceObject);
+ if (!NT_SUCCESS(Status))
+ {
+ DPRINT("CreateClassDeviceObject() failed with status 0x%08lx\n", Status);
+ return Status;
+ }
+ }
- DeviceObject->StackSize = 1 + DevExt->I8042Device->StackSize;
+ DriverObject->DriverExtension->AddDevice = ClassAddDevice;
+ DriverObject->DriverUnload = DriverUnload;
- IoCreateSymbolicLink(&SymlinkName, &DeviceName);
+ for (i = 0; i < IRP_MJ_MAXIMUM_FUNCTION; i++)
+ DriverObject->MajorFunction[i] = IrpStub;
- KbdClassSendConnect(DevExt);
+ DriverObject->MajorFunction[IRP_MJ_CREATE] = ClassCreate;
+ DriverObject->MajorFunction[IRP_MJ_CLOSE] = ClassClose;
+ DriverObject->MajorFunction[IRP_MJ_CLEANUP] = ClassCleanup;
+ DriverObject->MajorFunction[IRP_MJ_READ] = ClassRead;
+ DriverObject->MajorFunction[IRP_MJ_DEVICE_CONTROL] = ClassDeviceControl;
+ DriverObject->DriverStartIo = ClassStartIo;
- return(STATUS_SUCCESS);
+ return STATUS_SUCCESS;
}
projects / reactos.git / blobdiff