drivers/input/kbdclass/kbdclass.c

   1 /*
   2  * COPYRIGHT:       See COPYING in the top level directory
   3  * PROJECT:         ReactOS Keyboard class driver
   4  * FILE:            drivers/kbdclass/kbdclass.c
   5  * PURPOSE:         Keyboard class driver
   6  *
   7  * PROGRAMMERS:     Hervé Poussineau (hpoussin@reactos.org)
   8  */
   9
  10 #define INITGUID
  11 #include "kbdclass.h"
  12
  13 static DRIVER_UNLOAD DriverUnload;
  14 static DRIVER_DISPATCH ClassCreate;
  15 static DRIVER_DISPATCH ClassClose;
  16 static DRIVER_DISPATCH ClassCleanup;
  17 static DRIVER_DISPATCH ClassRead;
  18 static DRIVER_DISPATCH ClassDeviceControl;
  19 static DRIVER_DISPATCH IrpStub;
  20 static DRIVER_ADD_DEVICE ClassAddDevice;
  21 static DRIVER_STARTIO ClassStartIo;
  22 static DRIVER_CANCEL ClassCancelRoutine;
  23 static NTSTATUS
  24 HandleReadIrp(
  25         IN PDEVICE_OBJECT DeviceObject,
  26         IN PIRP Irp,
  27         BOOLEAN IsInStartIo);
  28
  29 static VOID NTAPI
  30 DriverUnload(IN PDRIVER_OBJECT DriverObject)
  31 {
  32         // nothing to do here yet
  33 }
  34
  35 static NTSTATUS NTAPI
  36 ClassCreate(
  37         IN PDEVICE_OBJECT DeviceObject,
  38         IN PIRP Irp)
  39 {
  40         TRACE_(CLASS_NAME, "IRP_MJ_CREATE\n");
  41
  42         if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
  43                 return ForwardIrpAndForget(DeviceObject, Irp);
  44
  45         /* FIXME: open all associated Port devices */
  46         Irp->IoStatus.Status = STATUS_SUCCESS;
  47         Irp->IoStatus.Information = 0;
  48         IoCompleteRequest(Irp, IO_NO_INCREMENT);
  49         return STATUS_SUCCESS;
  50 }
  51
  52 static NTSTATUS NTAPI
  53 ClassClose(
  54         IN PDEVICE_OBJECT DeviceObject,
  55         IN PIRP Irp)
  56 {
  57         TRACE_(CLASS_NAME, "IRP_MJ_CLOSE\n");
  58
  59         if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
  60                 return ForwardIrpAndForget(DeviceObject, Irp);
  61
  62         /* FIXME: close all associated Port devices */
  63         Irp->IoStatus.Status = STATUS_SUCCESS;
  64         Irp->IoStatus.Information = 0;
  65         IoCompleteRequest(Irp, IO_NO_INCREMENT);
  66         return STATUS_SUCCESS;
  67 }
  68
  69 static NTSTATUS NTAPI
  70 ClassCleanup(
  71         IN PDEVICE_OBJECT DeviceObject,
  72         IN PIRP Irp)
  73 {
  74         TRACE_(CLASS_NAME, "IRP_MJ_CLEANUP\n");
  75
  76         if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
  77                 return ForwardIrpAndForget(DeviceObject, Irp);
  78
  79         /* FIXME: cleanup all associated Port devices */
  80         Irp->IoStatus.Status = STATUS_SUCCESS;
  81         Irp->IoStatus.Information = 0;
  82         IoCompleteRequest(Irp, IO_NO_INCREMENT);
  83         return STATUS_SUCCESS;
  84 }
  85
  86 static NTSTATUS NTAPI
  87 ClassRead(
  88         IN PDEVICE_OBJECT DeviceObject,
  89         IN PIRP Irp)
  90 {
  91         PCLASS_DEVICE_EXTENSION DeviceExtension = DeviceObject->DeviceExtension;
  92         KIRQL OldIrql;
  93         NTSTATUS Status;
  94
  95         TRACE_(CLASS_NAME, "IRP_MJ_READ\n");
  96
  97         ASSERT(DeviceExtension->Common.IsClassDO);
  98
  99         if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
 100                 return ForwardIrpAndForget(DeviceObject, Irp);
 101
 102         if (IoGetCurrentIrpStackLocation(Irp)->Parameters.Read.Length < sizeof(KEYBOARD_INPUT_DATA))
 103         {
 104                 Irp->IoStatus.Status = STATUS_BUFFER_TOO_SMALL;
 105                 Irp->IoStatus.Information = 0;
 106                 IoCompleteRequest(Irp, IO_NO_INCREMENT);
 107
 108                 return STATUS_BUFFER_TOO_SMALL;
 109         }
 110
 111         KeAcquireSpinLock(&DeviceExtension->SpinLock, &OldIrql);
 112         Status = HandleReadIrp(DeviceObject, Irp, FALSE);
 113         KeReleaseSpinLock(&DeviceExtension->SpinLock, OldIrql);
 114         return Status;
 115 }
 116
 117 static NTSTATUS NTAPI
 118 ClassDeviceControl(
 119         IN PDEVICE_OBJECT DeviceObject,
 120         IN PIRP Irp)
 121 {
 122         PCLASS_DEVICE_EXTENSION DeviceExtension;
 123         NTSTATUS Status = STATUS_NOT_SUPPORTED;
 124
 125         TRACE_(CLASS_NAME, "IRP_MJ_DEVICE_CONTROL\n");
 126
 127         if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
 128                 return ForwardIrpAndForget(DeviceObject, Irp);
 129
 130         DeviceExtension = (PCLASS_DEVICE_EXTENSION)DeviceObject->DeviceExtension;
 131
 132         switch (IoGetCurrentIrpStackLocation(Irp)->Parameters.DeviceIoControl.IoControlCode)
 133         {
 134                 case IOCTL_KEYBOARD_QUERY_ATTRIBUTES:
 135                 case IOCTL_KEYBOARD_QUERY_INDICATOR_TRANSLATION:
 136                 case IOCTL_KEYBOARD_QUERY_INDICATORS:
 137                 case IOCTL_KEYBOARD_QUERY_TYPEMATIC:
 138                 {
 139                         /* FIXME: We hope that all devices will return the same result.
 140                          * Ask only the first one */
 141                         PLIST_ENTRY Head = &((PCLASS_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->ListHead;
 142                         if (Head->Flink != Head)
 143                         {
 144                                 /* We have at least one device */
 145                                 PPORT_DEVICE_EXTENSION DevExt = CONTAINING_RECORD(Head->Flink, PORT_DEVICE_EXTENSION, ListEntry);
 146                                 IoGetCurrentIrpStackLocation(Irp)->MajorFunction = IRP_MJ_INTERNAL_DEVICE_CONTROL;
 147                                 IoSkipCurrentIrpStackLocation(Irp);
 148                                 return IoCallDriver(DevExt->DeviceObject, Irp);
 149                         }
 150                         break;
 151                 }
 152                 case IOCTL_KEYBOARD_SET_INDICATORS:
 153                 case IOCTL_KEYBOARD_SET_TYPEMATIC: /* not in MSDN, would seem logical */
 154                 {
 155                         /* Send it to all associated Port devices */
 156                         PLIST_ENTRY Head = &((PCLASS_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->ListHead;
 157                         PLIST_ENTRY Entry = Head->Flink;
 158                         Status = STATUS_SUCCESS;
 159                         while (Entry != Head)
 160                         {
 161                                 PPORT_DEVICE_EXTENSION DevExt = CONTAINING_RECORD(Entry, PORT_DEVICE_EXTENSION, ListEntry);
 162                                 NTSTATUS IntermediateStatus;
 163
 164                                 IoGetCurrentIrpStackLocation(Irp)->MajorFunction = IRP_MJ_INTERNAL_DEVICE_CONTROL;
 165                                 IntermediateStatus = ForwardIrpAndWait(DevExt->DeviceObject, Irp);
 166                                 if (!NT_SUCCESS(IntermediateStatus))
 167                                         Status = IntermediateStatus;
 168                                 Entry = Entry->Flink;
 169                         }
 170                         break;
 171                 }
 172                 default:
 173                         WARN_(CLASS_NAME, "IRP_MJ_DEVICE_CONTROL / unknown I/O control code 0x%lx\n",
 174                                 IoGetCurrentIrpStackLocation(Irp)->Parameters.DeviceIoControl.IoControlCode);
 175                         ASSERT(FALSE);
 176                         break;
 177         }
 178
 179         Irp->IoStatus.Status = Status;
 180         Irp->IoStatus.Information = 0;
 181         IoCompleteRequest(Irp, IO_NO_INCREMENT);
 182
 183         return Status;
 184 }
 185
 186 static NTSTATUS NTAPI
 187 IrpStub(
 188         IN PDEVICE_OBJECT DeviceObject,
 189         IN PIRP Irp)
 190 {
 191         NTSTATUS Status = STATUS_NOT_SUPPORTED;
 192
 193         if (!((PCOMMON_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsClassDO)
 194         {
 195                 /* Forward some IRPs to lower device */
 196                 switch (IoGetCurrentIrpStackLocation(Irp)->MajorFunction)
 197                 {
 198                         case IRP_MJ_PNP:
 199                         case IRP_MJ_INTERNAL_DEVICE_CONTROL:
 200                                 return ForwardIrpAndForget(DeviceObject, Irp);
 201                         default:
 202                         {
 203                                 ERR_(CLASS_NAME, "Port DO stub for major function 0x%lx\n",
 204                                         IoGetCurrentIrpStackLocation(Irp)->MajorFunction);
 205                                 ASSERT(FALSE);
 206                         }
 207                 }
 208         }
 209         else
 210         {
 211                 ERR_(CLASS_NAME, "Class DO stub for major function 0x%lx\n",
 212                         IoGetCurrentIrpStackLocation(Irp)->MajorFunction);
 213                 ASSERT(FALSE);
 214         }
 215
 216         Irp->IoStatus.Status = Status;
 217         IoCompleteRequest(Irp, IO_NO_INCREMENT);
 218         return Status;
 219 }
 220
 221 static NTSTATUS
 222 ReadRegistryEntries(
 223         IN PUNICODE_STRING RegistryPath,
 224         IN PCLASS_DRIVER_EXTENSION DriverExtension)
 225 {
 226         UNICODE_STRING ParametersRegistryKey;
 227         RTL_QUERY_REGISTRY_TABLE Parameters[4];
 228         NTSTATUS Status;
 229
 230         ULONG DefaultConnectMultiplePorts = 0;
 231         ULONG DefaultDataQueueSize = 0x64;
 232         PCWSTR DefaultDeviceBaseName = L"KeyboardClass";
 233
 234         ParametersRegistryKey.Length = 0;
 235         ParametersRegistryKey.MaximumLength = RegistryPath->Length + sizeof(L"\\Parameters") + sizeof(UNICODE_NULL);
 236         ParametersRegistryKey.Buffer = ExAllocatePoolWithTag(PagedPool, ParametersRegistryKey.MaximumLength, CLASS_TAG);
 237         if (!ParametersRegistryKey.Buffer)
 238         {
 239                 WARN_(CLASS_NAME, "ExAllocatePoolWithTag() failed\n");
 240                 return STATUS_NO_MEMORY;
 241         }
 242         RtlCopyUnicodeString(&ParametersRegistryKey, RegistryPath);
 243         RtlAppendUnicodeToString(&ParametersRegistryKey, L"\\Parameters");
 244         ParametersRegistryKey.Buffer[ParametersRegistryKey.Length / sizeof(WCHAR)] = UNICODE_NULL;
 245
 246         RtlZeroMemory(Parameters, sizeof(Parameters));
 247
 248         Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
 249         Parameters[0].Name = L"ConnectMultiplePorts";
 250         Parameters[0].EntryContext = &DriverExtension->ConnectMultiplePorts;
 251         Parameters[0].DefaultType = REG_DWORD;
 252         Parameters[0].DefaultData = &DefaultConnectMultiplePorts;
 253         Parameters[0].DefaultLength = sizeof(ULONG);
 254
 255         Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
 256         Parameters[1].Name = L"KeyboardDataQueueSize";
 257         Parameters[1].EntryContext = &DriverExtension->DataQueueSize;
 258         Parameters[1].DefaultType = REG_DWORD;
 259         Parameters[1].DefaultData = &DefaultDataQueueSize;
 260         Parameters[1].DefaultLength = sizeof(ULONG);
 261
 262         Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
 263         Parameters[2].Name = L"KeyboardDeviceBaseName";
 264         Parameters[2].EntryContext = &DriverExtension->DeviceBaseName;
 265         Parameters[2].DefaultType = REG_SZ;
 266         Parameters[2].DefaultData = (PVOID)DefaultDeviceBaseName;
 267         Parameters[2].DefaultLength = 0;
 268
 269         Status = RtlQueryRegistryValues(
 270                 RTL_REGISTRY_ABSOLUTE,
 271                 ParametersRegistryKey.Buffer,
 272                 Parameters,
 273                 NULL,
 274                 NULL);
 275
 276         if (NT_SUCCESS(Status))
 277         {
 278                 /* Check values */
 279                 if (DriverExtension->ConnectMultiplePorts != 0
 280                         && DriverExtension->ConnectMultiplePorts != 1)
 281                 {
 282                         DriverExtension->ConnectMultiplePorts = DefaultConnectMultiplePorts;
 283                 }
 284                 if (DriverExtension->DataQueueSize == 0)
 285                 {
 286                         DriverExtension->DataQueueSize = DefaultDataQueueSize;
 287                 }
 288         }
 289         else if (Status == STATUS_OBJECT_NAME_NOT_FOUND)
 290         {
 291                 /* Registry path doesn't exist. Set defaults */
 292                 DriverExtension->ConnectMultiplePorts = DefaultConnectMultiplePorts;
 293                 DriverExtension->DataQueueSize = DefaultDataQueueSize;
 294                 if (RtlCreateUnicodeString(&DriverExtension->DeviceBaseName, DefaultDeviceBaseName))
 295                         Status = STATUS_SUCCESS;
 296                 else
 297                         Status = STATUS_NO_MEMORY;
 298         }
 299
 300         ExFreePoolWithTag(ParametersRegistryKey.Buffer, CLASS_TAG);
 301         return Status;
 302 }
 303
 304 static NTSTATUS
 305 CreateClassDeviceObject(
 306         IN PDRIVER_OBJECT DriverObject,
 307         OUT PDEVICE_OBJECT *ClassDO OPTIONAL)
 308 {
 309         PCLASS_DRIVER_EXTENSION DriverExtension;
 310         ULONG DeviceId = 0;
 311         ULONG PrefixLength;
 312         UNICODE_STRING DeviceNameU;
 313         PWSTR DeviceIdW = NULL; /* Pointer into DeviceNameU.Buffer */
 314         PDEVICE_OBJECT Fdo;
 315         PCLASS_DEVICE_EXTENSION DeviceExtension;
 316         NTSTATUS Status;
 317
 318         TRACE_(CLASS_NAME, "CreateClassDeviceObject(0x%p)\n", DriverObject);
 319
 320         /* Create new device object */
 321         DriverExtension = IoGetDriverObjectExtension(DriverObject, DriverObject);
 322         DeviceNameU.Length = 0;
 323         DeviceNameU.MaximumLength =
 324                 wcslen(L"\\Device\\") * sizeof(WCHAR)    /* "\Device\" */
 325                 + DriverExtension->DeviceBaseName.Length /* "KeyboardClass" */
 326                 + 4 * sizeof(WCHAR)                      /* Id between 0 and 9999 */
 327                 + sizeof(UNICODE_NULL);                  /* Final NULL char */
 328         DeviceNameU.Buffer = ExAllocatePoolWithTag(PagedPool, DeviceNameU.MaximumLength, CLASS_TAG);
 329         if (!DeviceNameU.Buffer)
 330         {
 331                 WARN_(CLASS_NAME, "ExAllocatePoolWithTag() failed\n");
 332                 return STATUS_NO_MEMORY;
 333         }
 334         Status = RtlAppendUnicodeToString(&DeviceNameU, L"\\Device\\");
 335         if (!NT_SUCCESS(Status))
 336         {
 337                 WARN_(CLASS_NAME, "RtlAppendUnicodeToString() failed with status 0x%08lx\n", Status);
 338                 goto cleanup;
 339         }
 340         Status = RtlAppendUnicodeStringToString(&DeviceNameU, &DriverExtension->DeviceBaseName);
 341         if (!NT_SUCCESS(Status))
 342         {
 343                 WARN_(CLASS_NAME, "RtlAppendUnicodeStringToString() failed with status 0x%08lx\n", Status);
 344                 goto cleanup;
 345         }
 346         PrefixLength = DeviceNameU.MaximumLength - 4 * sizeof(WCHAR) - sizeof(UNICODE_NULL);
 347         DeviceIdW = &DeviceNameU.Buffer[PrefixLength / sizeof(WCHAR)];
 348         while (DeviceId < 9999)
 349         {
 350                 DeviceNameU.Length = (USHORT)(PrefixLength + swprintf(DeviceIdW, L"%lu", DeviceId) * sizeof(WCHAR));
 351                 Status = IoCreateDevice(
 352                         DriverObject,
 353                         sizeof(CLASS_DEVICE_EXTENSION),
 354                         &DeviceNameU,
 355                         FILE_DEVICE_KEYBOARD,
 356                         FILE_DEVICE_SECURE_OPEN,
 357                         TRUE,
 358                         &Fdo);
 359                 if (NT_SUCCESS(Status))
 360                         goto cleanup;
 361                 else if (Status != STATUS_OBJECT_NAME_COLLISION)
 362                 {
 363                         WARN_(CLASS_NAME, "IoCreateDevice() failed with status 0x%08lx\n", Status);
 364                         goto cleanup;
 365                 }
 366                 DeviceId++;
 367         }
 368         WARN_(CLASS_NAME, "Too many devices starting with '\\Device\\%wZ'\n", &DriverExtension->DeviceBaseName);
 369         Status = STATUS_TOO_MANY_NAMES;
 370 cleanup:
 371         if (!NT_SUCCESS(Status))
 372         {
 373                 ExFreePoolWithTag(DeviceNameU.Buffer, CLASS_TAG);
 374                 return Status;
 375         }
 376
 377         DeviceExtension = (PCLASS_DEVICE_EXTENSION)Fdo->DeviceExtension;
 378         RtlZeroMemory(DeviceExtension, sizeof(CLASS_DEVICE_EXTENSION));
 379         DeviceExtension->Common.IsClassDO = TRUE;
 380         DeviceExtension->DriverExtension = DriverExtension;
 381         InitializeListHead(&DeviceExtension->ListHead);
 382         KeInitializeSpinLock(&DeviceExtension->ListSpinLock);
 383         KeInitializeSpinLock(&DeviceExtension->SpinLock);
 384         DeviceExtension->InputCount = 0;
 385         DeviceExtension->PortData = ExAllocatePoolWithTag(NonPagedPool, DeviceExtension->DriverExtension->DataQueueSize * sizeof(KEYBOARD_INPUT_DATA), CLASS_TAG);
 386         if (!DeviceExtension->PortData)
 387         {
 388                 ExFreePoolWithTag(DeviceNameU.Buffer, CLASS_TAG);
 389                 return STATUS_NO_MEMORY;
 390         }
 391         DeviceExtension->DeviceName = DeviceNameU.Buffer;
 392         Fdo->Flags |= DO_POWER_PAGABLE;
 393         Fdo->Flags |= DO_BUFFERED_IO; /* FIXME: Why is it needed for 1st stage setup? */
 394         Fdo->Flags &= ~DO_DEVICE_INITIALIZING;
 395
 396         /* Add entry entry to HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\[DeviceBaseName] */
 397         RtlWriteRegistryValue(
 398                 RTL_REGISTRY_DEVICEMAP,
 399                 DriverExtension->DeviceBaseName.Buffer,
 400                 DeviceExtension->DeviceName,
 401                 REG_SZ,
 402                 DriverExtension->RegistryPath.Buffer,
 403                 DriverExtension->RegistryPath.MaximumLength);
 404
 405         if (ClassDO)
 406                 *ClassDO = Fdo;
 407
 408         return STATUS_SUCCESS;
 409 }
 410
 411 static NTSTATUS
 412 FillEntries(
 413         IN PDEVICE_OBJECT ClassDeviceObject,
 414         IN PIRP Irp,
 415         IN PKEYBOARD_INPUT_DATA DataStart,
 416         IN SIZE_T NumberOfEntries)
 417 {
 418         NTSTATUS Status = STATUS_SUCCESS;
 419
 420         if (ClassDeviceObject->Flags & DO_BUFFERED_IO)
 421         {
 422                 RtlCopyMemory(
 423                         Irp->AssociatedIrp.SystemBuffer,
 424                         DataStart,
 425                         NumberOfEntries * sizeof(KEYBOARD_INPUT_DATA));
 426         }
 427         else if (ClassDeviceObject->Flags & DO_DIRECT_IO)
 428         {
 429                 PVOID DestAddress = MmGetSystemAddressForMdlSafe(Irp->MdlAddress, NormalPagePriority);
 430                 if (DestAddress)
 431                 {
 432                         RtlCopyMemory(
 433                                 DestAddress,
 434                                 DataStart,
 435                                 NumberOfEntries * sizeof(KEYBOARD_INPUT_DATA));
 436                 }
 437                 else
 438                         Status = STATUS_UNSUCCESSFUL;
 439         }
 440         else
 441         {
 442                 _SEH_TRY
 443                 {
 444                         RtlCopyMemory(
 445                                 Irp->UserBuffer,
 446                                 DataStart,
 447                                 NumberOfEntries * sizeof(KEYBOARD_INPUT_DATA));
 448                 }
 449                 _SEH_HANDLE
 450                 {
 451                         Status = _SEH_GetExceptionCode();
 452                 }
 453                 _SEH_END;
 454         }
 455
 456         return Status;
 457 }
 458
 459 static BOOLEAN NTAPI
 460 ClassCallback(
 461         IN PDEVICE_OBJECT ClassDeviceObject,
 462         IN OUT PKEYBOARD_INPUT_DATA DataStart,
 463         IN PKEYBOARD_INPUT_DATA DataEnd,
 464         IN OUT PULONG ConsumedCount)
 465 {
 466         PCLASS_DEVICE_EXTENSION ClassDeviceExtension = ClassDeviceObject->DeviceExtension;
 467         KIRQL OldIrql;
 468         SIZE_T InputCount = DataEnd - DataStart;
 469         SIZE_T ReadSize;
 470
 471         TRACE_(CLASS_NAME, "ClassCallback()\n");
 472
 473         ASSERT(ClassDeviceExtension->Common.IsClassDO);
 474
 475         KeAcquireSpinLock(&ClassDeviceExtension->SpinLock, &OldIrql);
 476         if (InputCount > 0)
 477         {
 478                 if (ClassDeviceExtension->InputCount + InputCount > ClassDeviceExtension->DriverExtension->DataQueueSize)
 479                 {
 480                         /*
 481                          * We're exceeding the buffer, and data will be thrown away...
 482                          * FIXME: What could we do, as we are at DISPATCH_LEVEL?
 483                          */
 484                         ReadSize = ClassDeviceExtension->DriverExtension->DataQueueSize - ClassDeviceExtension->InputCount;
 485                 }
 486                 else
 487                         ReadSize = InputCount;
 488
 489                 /*
 490                  * Move the input data from the port data queue to our class data
 491                  * queue.
 492                  */
 493                 RtlCopyMemory(
 494                         &ClassDeviceExtension->PortData[ClassDeviceExtension->InputCount],
 495                         (PCHAR)DataStart,
 496                         sizeof(KEYBOARD_INPUT_DATA) * ReadSize);
 497
 498                 /* Move the counter up */
 499                 ClassDeviceExtension->InputCount += ReadSize;
 500
 501                 (*ConsumedCount) += (ULONG)ReadSize;
 502
 503                 /* Complete pending IRP (if any) */
 504                 if (ClassDeviceExtension->PendingIrp)
 505                         HandleReadIrp(ClassDeviceObject, ClassDeviceExtension->PendingIrp, FALSE);
 506         }
 507         KeReleaseSpinLock(&ClassDeviceExtension->SpinLock, OldIrql);
 508
 509         TRACE_(CLASS_NAME, "Leaving ClassCallback()\n");
 510         return TRUE;
 511 }
 512
 513 /* Send IOCTL_INTERNAL_*_CONNECT to port */
 514 static NTSTATUS
 515 ConnectPortDriver(
 516         IN PDEVICE_OBJECT PortDO,
 517         IN PDEVICE_OBJECT ClassDO)
 518 {
 519         KEVENT Event;
 520         PIRP Irp;
 521         IO_STATUS_BLOCK IoStatus;
 522         CONNECT_DATA ConnectData;
 523         NTSTATUS Status;
 524
 525         TRACE_(CLASS_NAME, "Connecting PortDO %p to ClassDO %p\n", PortDO, ClassDO);
 526
 527         KeInitializeEvent(&Event, NotificationEvent, FALSE);
 528
 529         ConnectData.ClassDeviceObject = ClassDO;
 530         ConnectData.ClassService      = ClassCallback;
 531
 532         Irp = IoBuildDeviceIoControlRequest(
 533                 IOCTL_INTERNAL_KEYBOARD_CONNECT,
 534                 PortDO,
 535                 &ConnectData, sizeof(CONNECT_DATA),
 536                 NULL, 0,
 537                 TRUE, &Event, &IoStatus);
 538         if (!Irp)
 539                 return STATUS_INSUFFICIENT_RESOURCES;
 540
 541         Status = IoCallDriver(PortDO, Irp);
 542
 543         if (Status == STATUS_PENDING)
 544                 KeWaitForSingleObject(&Event, Suspended, KernelMode, FALSE, NULL);
 545         else
 546                 IoStatus.Status = Status;
 547
 548         if (NT_SUCCESS(IoStatus.Status))
 549         {
 550                 ObReferenceObject(PortDO);
 551                 ExInterlockedInsertTailList(
 552                         &((PCLASS_DEVICE_EXTENSION)ClassDO->DeviceExtension)->ListHead,
 553                         &((PPORT_DEVICE_EXTENSION)PortDO->DeviceExtension)->ListEntry,
 554                         &((PCLASS_DEVICE_EXTENSION)ClassDO->DeviceExtension)->ListSpinLock);
 555                 if (ClassDO->StackSize <= PortDO->StackSize)
 556                 {
 557                         /* Increase the stack size, in case we have to
 558                          * forward some IRPs to the port device object
 559                          */
 560                         ClassDO->StackSize = PortDO->StackSize + 1;
 561                 }
 562         }
 563
 564         return IoStatus.Status;
 565 }
 566
 567 /* Send IOCTL_INTERNAL_*_DISCONNECT to port + destroy the Port DO */
 568 static VOID
 569 DestroyPortDriver(
 570         IN PDEVICE_OBJECT PortDO)
 571 {
 572         PPORT_DEVICE_EXTENSION DeviceExtension;
 573         PCLASS_DEVICE_EXTENSION ClassDeviceExtension;
 574         PCLASS_DRIVER_EXTENSION DriverExtension;
 575         KEVENT Event;
 576         PIRP Irp;
 577         IO_STATUS_BLOCK IoStatus;
 578         KIRQL OldIrql;
 579         NTSTATUS Status;
 580
 581         TRACE_(CLASS_NAME, "Destroying PortDO %p\n", PortDO);
 582
 583         DeviceExtension = (PPORT_DEVICE_EXTENSION)PortDO->DeviceExtension;
 584         ClassDeviceExtension = DeviceExtension->ClassDO->DeviceExtension;
 585         DriverExtension = IoGetDriverObjectExtension(PortDO->DriverObject, PortDO->DriverObject);
 586
 587         /* Send IOCTL_INTERNAL_*_DISCONNECT */
 588         KeInitializeEvent(&Event, NotificationEvent, FALSE);
 589         Irp = IoBuildDeviceIoControlRequest(
 590                 IOCTL_INTERNAL_KEYBOARD_DISCONNECT,
 591                 PortDO,
 592                 NULL, 0,
 593                 NULL, 0,
 594                 TRUE, &Event, &IoStatus);
 595         if (Irp)
 596         {
 597                 Status = IoCallDriver(PortDO, Irp);
 598                 if (Status == STATUS_PENDING)
 599                         KeWaitForSingleObject(&Event, Suspended, KernelMode, FALSE, NULL);
 600         }
 601
 602         /* Remove from ClassDeviceExtension->ListHead list */
 603         KeAcquireSpinLock(&ClassDeviceExtension->ListSpinLock, &OldIrql);
 604         RemoveHeadList(DeviceExtension->ListEntry.Blink);
 605         KeReleaseSpinLock(&ClassDeviceExtension->ListSpinLock, OldIrql);
 606
 607         /* Remove entry from HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\[DeviceBaseName] */
 608         RtlDeleteRegistryValue(
 609                 RTL_REGISTRY_DEVICEMAP,
 610                 DriverExtension->DeviceBaseName.Buffer,
 611                 ClassDeviceExtension->DeviceName);
 612
 613         if (DeviceExtension->LowerDevice)
 614                 IoDetachDevice(DeviceExtension->LowerDevice);
 615         ObDereferenceObject(PortDO);
 616
 617         if (!DriverExtension->ConnectMultiplePorts && DeviceExtension->ClassDO)
 618         {
 619                 ExFreePoolWithTag(ClassDeviceExtension->PortData, CLASS_TAG);
 620                 ExFreePoolWithTag((PVOID)ClassDeviceExtension->DeviceName, CLASS_TAG);
 621                 IoDeleteDevice(DeviceExtension->ClassDO);
 622         }
 623
 624         IoDeleteDevice(PortDO);
 625 }
 626
 627 static NTSTATUS NTAPI
 628 ClassAddDevice(
 629         IN PDRIVER_OBJECT DriverObject,
 630         IN PDEVICE_OBJECT Pdo)
 631 {
 632         PCLASS_DRIVER_EXTENSION DriverExtension;
 633         PDEVICE_OBJECT Fdo = NULL;
 634         PPORT_DEVICE_EXTENSION DeviceExtension = NULL;
 635         NTSTATUS Status;
 636
 637         TRACE_(CLASS_NAME, "ClassAddDevice called. Pdo = 0x%p\n", Pdo);
 638
 639         DriverExtension = IoGetDriverObjectExtension(DriverObject, DriverObject);
 640
 641         if (Pdo == NULL)
 642                 /* We may get a NULL Pdo at the first call as we're a legacy driver. Ignore it */
 643                 return STATUS_SUCCESS;
 644
 645         /* Create new device object */
 646         Status = IoCreateDevice(
 647                 DriverObject,
 648                 sizeof(PORT_DEVICE_EXTENSION),
 649                 NULL,
 650                 Pdo->DeviceType,
 651                 Pdo->Characteristics & FILE_DEVICE_SECURE_OPEN ? FILE_DEVICE_SECURE_OPEN : 0,
 652                 TRUE,
 653                 &Fdo);
 654         if (!NT_SUCCESS(Status))
 655         {
 656                 WARN_(CLASS_NAME, "IoCreateDevice() failed with status 0x%08lx\n", Status);
 657                 goto cleanup;
 658         }
 659         IoSetStartIoAttributes(Fdo, TRUE, TRUE);
 660
 661         DeviceExtension = (PPORT_DEVICE_EXTENSION)Fdo->DeviceExtension;
 662         RtlZeroMemory(DeviceExtension, sizeof(PORT_DEVICE_EXTENSION));
 663         DeviceExtension->Common.IsClassDO = FALSE;
 664         DeviceExtension->DeviceObject = Fdo;
 665         DeviceExtension->PnpState = dsStopped;
 666         Status = IoAttachDeviceToDeviceStackSafe(Fdo, Pdo, &DeviceExtension->LowerDevice);
 667         if (!NT_SUCCESS(Status))
 668         {
 669                 WARN_(CLASS_NAME, "IoAttachDeviceToDeviceStackSafe() failed with status 0x%08lx\n", Status);
 670                 goto cleanup;
 671         }
 672         if (DeviceExtension->LowerDevice->Flags & DO_POWER_PAGABLE)
 673                 Fdo->Flags |= DO_POWER_PAGABLE;
 674         if (DeviceExtension->LowerDevice->Flags & DO_BUFFERED_IO)
 675                 Fdo->Flags |= DO_BUFFERED_IO;
 676         if (DeviceExtension->LowerDevice->Flags & DO_DIRECT_IO)
 677                 Fdo->Flags |= DO_DIRECT_IO;
 678
 679         if (DriverExtension->ConnectMultiplePorts)
 680                 DeviceExtension->ClassDO = DriverExtension->MainClassDeviceObject;
 681         else
 682         {
 683                 /* We need a new class device object for this Fdo */
 684                 Status = CreateClassDeviceObject(
 685                         DriverObject,
 686                         &DeviceExtension->ClassDO);
 687                 if (!NT_SUCCESS(Status))
 688                 {
 689                         WARN_(CLASS_NAME, "CreateClassDeviceObject() failed with status 0x%08lx\n", Status);
 690                         goto cleanup;
 691                 }
 692         }
 693         Status = ConnectPortDriver(Fdo, DeviceExtension->ClassDO);
 694         if (!NT_SUCCESS(Status))
 695         {
 696                 WARN_(CLASS_NAME, "ConnectPortDriver() failed with status 0x%08lx\n", Status);
 697                 goto cleanup;
 698         }
 699         Fdo->Flags &= ~DO_DEVICE_INITIALIZING;
 700
 701         /* Register interface ; ignore the error (if any) as having
 702          * a registred interface is not so important... */
 703         Status = IoRegisterDeviceInterface(
 704                 Pdo,
 705                 &GUID_DEVINTERFACE_KEYBOARD,
 706                 NULL,
 707                 &DeviceExtension->InterfaceName);
 708         if (!NT_SUCCESS(Status))
 709                 DeviceExtension->InterfaceName.Length = 0;
 710
 711         return STATUS_SUCCESS;
 712
 713 cleanup:
 714         if (Fdo)
 715                 DestroyPortDriver(Fdo);
 716         return Status;
 717 }
 718
 719 static VOID NTAPI
 720 ClassCancelRoutine(
 721         IN PDEVICE_OBJECT DeviceObject,
 722         IN PIRP Irp)
 723 {
 724         PCLASS_DEVICE_EXTENSION ClassDeviceExtension = DeviceObject->DeviceExtension;
 725         KIRQL OldIrql;
 726         BOOLEAN wasQueued = FALSE;
 727
 728         TRACE_(CLASS_NAME, "ClassCancelRoutine(DeviceObject %p, Irp %p)\n", DeviceObject, Irp);
 729
 730         ASSERT(ClassDeviceExtension->Common.IsClassDO);
 731
 732         IoReleaseCancelSpinLock(Irp->CancelIrql);
 733
 734         KeAcquireSpinLock(&ClassDeviceExtension->SpinLock, &OldIrql);
 735
 736         if (ClassDeviceExtension->PendingIrp == Irp)
 737         {
 738                 ClassDeviceExtension->PendingIrp = NULL;
 739                 wasQueued = TRUE;
 740         }
 741         KeReleaseSpinLock(&ClassDeviceExtension->SpinLock, OldIrql);
 742
 743         if (wasQueued)
 744         {
 745                 Irp->IoStatus.Status = STATUS_CANCELLED;
 746                 Irp->IoStatus.Information = 0;
 747                 IoCompleteRequest(Irp, IO_NO_INCREMENT);
 748         }
 749         else
 750         {
 751                 /* Hm, this shouldn't happen */
 752                 ASSERT(FALSE);
 753         }
 754 }
 755
 756 static NTSTATUS
 757 HandleReadIrp(
 758         IN PDEVICE_OBJECT DeviceObject,
 759         IN PIRP Irp,
 760         BOOLEAN IsInStartIo)
 761 {
 762         PCLASS_DEVICE_EXTENSION DeviceExtension = DeviceObject->DeviceExtension;
 763         NTSTATUS Status;
 764
 765         TRACE_(CLASS_NAME, "HandleReadIrp(DeviceObject %p, Irp %p)\n", DeviceObject, Irp);
 766
 767         ASSERT(DeviceExtension->Common.IsClassDO);
 768
 769         if (DeviceExtension->InputCount > 0)
 770         {
 771                 SIZE_T NumberOfEntries;
 772
 773                 NumberOfEntries = MIN(
 774                         DeviceExtension->InputCount,
 775                         IoGetCurrentIrpStackLocation(Irp)->Parameters.Read.Length / sizeof(KEYBOARD_INPUT_DATA));
 776
 777                 Status = FillEntries(
 778                         DeviceObject,
 779                         Irp,
 780                         DeviceExtension->PortData,
 781                         NumberOfEntries);
 782
 783                 if (NT_SUCCESS(Status))
 784                 {
 785                         if (DeviceExtension->InputCount > NumberOfEntries)
 786                         {
 787                                 RtlMoveMemory(
 788                                         &DeviceExtension->PortData[0],
 789                                         &DeviceExtension->PortData[NumberOfEntries],
 790                                         (DeviceExtension->InputCount - NumberOfEntries) * sizeof(KEYBOARD_INPUT_DATA));
 791                         }
 792
 793                         DeviceExtension->InputCount -= NumberOfEntries;
 794
 795                         Irp->IoStatus.Information = NumberOfEntries * sizeof(KEYBOARD_INPUT_DATA);
 796                 }
 797
 798                 /* Go to next packet and complete this request */
 799                 Irp->IoStatus.Status = Status;
 800
 801                 (VOID)IoSetCancelRoutine(Irp, NULL);
 802                 IoCompleteRequest(Irp, IO_KEYBOARD_INCREMENT);
 803                 DeviceExtension->PendingIrp = NULL;
 804         }
 805         else
 806         {
 807                 (VOID)IoSetCancelRoutine(Irp, ClassCancelRoutine);
 808                 if (Irp->Cancel && IoSetCancelRoutine(Irp, NULL))
 809                 {
 810                         DeviceExtension->PendingIrp = NULL;
 811                         Status = STATUS_CANCELLED;
 812                 }
 813                 else
 814                 {
 815                         IoMarkIrpPending(Irp);
 816                         DeviceExtension->PendingIrp = Irp;
 817                         Status = STATUS_PENDING;
 818                 }
 819         }
 820         return Status;
 821 }
 822
 823 static VOID NTAPI
 824 ClassStartIo(
 825         IN PDEVICE_OBJECT DeviceObject,
 826         IN PIRP Irp)
 827 {
 828         PCLASS_DEVICE_EXTENSION DeviceExtension = DeviceObject->DeviceExtension;
 829         KIRQL OldIrql;
 830
 831         TRACE_(CLASS_NAME, "ClassStartIo(DeviceObject %p, Irp %p)\n", DeviceObject, Irp);
 832
 833         ASSERT(DeviceExtension->Common.IsClassDO);
 834
 835         KeAcquireSpinLock(&DeviceExtension->SpinLock, &OldIrql);
 836         HandleReadIrp(DeviceObject, Irp, TRUE);
 837         KeReleaseSpinLock(&DeviceExtension->SpinLock, OldIrql);
 838 }
 839
 840 static VOID NTAPI
 841 SearchForLegacyDrivers(
 842         IN PDRIVER_OBJECT DriverObject,
 843         IN PVOID Context, /* PCLASS_DRIVER_EXTENSION */
 844         IN ULONG Count)
 845 {
 846         UNICODE_STRING DeviceMapKeyU = RTL_CONSTANT_STRING(L"\\REGISTRY\\MACHINE\\HARDWARE\\DEVICEMAP");
 847         PCLASS_DRIVER_EXTENSION DriverExtension;
 848         UNICODE_STRING PortBaseName = {0, };
 849         PKEY_VALUE_BASIC_INFORMATION KeyValueInformation = NULL;
 850         OBJECT_ATTRIBUTES ObjectAttributes;
 851         HANDLE hDeviceMapKey = (HANDLE)-1;
 852         HANDLE hPortKey = (HANDLE)-1;
 853         ULONG Index = 0;
 854         ULONG Size, ResultLength;
 855         NTSTATUS Status;
 856
 857         TRACE_(CLASS_NAME, "SearchForLegacyDrivers(%p %p %lu)\n",
 858                 DriverObject, Context, Count);
 859
 860         if (Count != 1)
 861                 return;
 862         DriverExtension = (PCLASS_DRIVER_EXTENSION)Context;
 863
 864         /* Create port base name, by replacing Class by Port at the end of the class base name */
 865         Status = DuplicateUnicodeString(
 866                 RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE,
 867                 &DriverExtension->DeviceBaseName,
 868                 &PortBaseName);
 869         if (!NT_SUCCESS(Status))
 870         {
 871                 WARN_(CLASS_NAME, "DuplicateUnicodeString() failed with status 0x%08lx\n", Status);
 872                 goto cleanup;
 873         }
 874         PortBaseName.Length -= (sizeof(L"Class") - sizeof(UNICODE_NULL));
 875         RtlAppendUnicodeToString(&PortBaseName, L"Port");
 876
 877         /* Allocate memory */
 878         Size = sizeof(KEY_VALUE_BASIC_INFORMATION) + MAX_PATH;
 879         KeyValueInformation = ExAllocatePoolWithTag(PagedPool, Size, CLASS_TAG);
 880         if (!KeyValueInformation)
 881         {
 882                 WARN_(CLASS_NAME, "ExAllocatePoolWithTag() failed\n");
 883                 Status = STATUS_NO_MEMORY;
 884                 goto cleanup;
 885         }
 886
 887         /* Open HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP */
 888         InitializeObjectAttributes(&ObjectAttributes, &DeviceMapKeyU, OBJ_KERNEL_HANDLE | OBJ_CASE_INSENSITIVE, NULL, NULL);
 889         Status = ZwOpenKey(&hDeviceMapKey, 0, &ObjectAttributes);
 890         if (Status == STATUS_OBJECT_NAME_NOT_FOUND)
 891         {
 892                 INFO_(CLASS_NAME, "HKLM\\HARDWARE\\DEVICEMAP is non-existent\n");
 893                 Status = STATUS_SUCCESS;
 894                 goto cleanup;
 895         }
 896         else if (!NT_SUCCESS(Status))
 897         {
 898                 WARN_(CLASS_NAME, "ZwOpenKey() failed with status 0x%08lx\n", Status);
 899                 goto cleanup;
 900         }
 901
 902         /* Open sub key */
 903         InitializeObjectAttributes(&ObjectAttributes, &PortBaseName, OBJ_KERNEL_HANDLE | OBJ_CASE_INSENSITIVE, hDeviceMapKey, NULL);
 904         Status = ZwOpenKey(&hPortKey, KEY_QUERY_VALUE, &ObjectAttributes);
 905         if (Status == STATUS_OBJECT_NAME_NOT_FOUND)
 906         {
 907                 INFO_(CLASS_NAME, "HKLM\\HARDWARE\\DEVICEMAP\\%wZ is non-existent\n", &PortBaseName);
 908                 Status = STATUS_SUCCESS;
 909                 goto cleanup;
 910         }
 911         else if (!NT_SUCCESS(Status))
 912         {
 913                 WARN_(CLASS_NAME, "ZwOpenKey() failed with status 0x%08lx\n", Status);
 914                 goto cleanup;
 915         }
 916
 917         /* Read each value name */
 918         while (ZwEnumerateValueKey(hPortKey, Index++, KeyValueBasicInformation, KeyValueInformation, Size, &ResultLength) == STATUS_SUCCESS)
 919         {
 920                 UNICODE_STRING PortName;
 921                 PDEVICE_OBJECT PortDeviceObject = NULL;
 922                 PFILE_OBJECT FileObject = NULL;
 923
 924                 PortName.Length = PortName.MaximumLength = (USHORT)KeyValueInformation->NameLength;
 925                 PortName.Buffer = KeyValueInformation->Name;
 926
 927                 /* Open the device object pointer */
 928                 Status = IoGetDeviceObjectPointer(&PortName, FILE_READ_ATTRIBUTES, &FileObject, &PortDeviceObject);
 929                 if (!NT_SUCCESS(Status))
 930                 {
 931                         WARN_(CLASS_NAME, "IoGetDeviceObjectPointer(%wZ) failed with status 0x%08lx\n", &PortName, Status);
 932                         continue;
 933                 }
 934                 INFO_(CLASS_NAME, "Legacy driver found\n");
 935
 936                 Status = ClassAddDevice(DriverObject, PortDeviceObject);
 937                 if (!NT_SUCCESS(Status))
 938                 {
 939                         /* FIXME: Log the error */
 940                         WARN_(CLASS_NAME, "ClassAddDevice() failed with status 0x%08lx\n", Status);
 941                 }
 942         }
 943
 944 cleanup:
 945         if (KeyValueInformation != NULL)
 946                 ExFreePoolWithTag(KeyValueInformation, CLASS_TAG);
 947         if (hDeviceMapKey != (HANDLE)-1)
 948                 ZwClose(hDeviceMapKey);
 949         if (hPortKey != (HANDLE)-1)
 950                 ZwClose(hPortKey);
 951 }
 952
 953 /*
 954  * Standard DriverEntry method.
 955  */
 956 NTSTATUS NTAPI
 957 DriverEntry(
 958         IN PDRIVER_OBJECT DriverObject,
 959         IN PUNICODE_STRING RegistryPath)
 960 {
 961         PCLASS_DRIVER_EXTENSION DriverExtension;
 962         ULONG i;
 963         NTSTATUS Status;
 964
 965         Status = IoAllocateDriverObjectExtension(
 966                 DriverObject,
 967                 DriverObject,
 968                 sizeof(CLASS_DRIVER_EXTENSION),
 969                 (PVOID*)&DriverExtension);
 970         if (!NT_SUCCESS(Status))
 971         {
 972                 WARN_(CLASS_NAME, "IoAllocateDriverObjectExtension() failed with status 0x%08lx\n", Status);
 973                 return Status;
 974         }
 975         RtlZeroMemory(DriverExtension, sizeof(CLASS_DRIVER_EXTENSION));
 976
 977         Status = DuplicateUnicodeString(
 978                 RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE,
 979                 RegistryPath,
 980                 &DriverExtension->RegistryPath);
 981         if (!NT_SUCCESS(Status))
 982         {
 983                 WARN_(CLASS_NAME, "DuplicateUnicodeString() failed with status 0x%08lx\n", Status);
 984                 return Status;
 985         }
 986
 987         Status = ReadRegistryEntries(RegistryPath, DriverExtension);
 988         if (!NT_SUCCESS(Status))
 989         {
 990                 WARN_(CLASS_NAME, "ReadRegistryEntries() failed with status 0x%08lx\n", Status);
 991                 return Status;
 992         }
 993
 994         if (DriverExtension->ConnectMultiplePorts == 1)
 995         {
 996                 Status = CreateClassDeviceObject(
 997                         DriverObject,
 998                         &DriverExtension->MainClassDeviceObject);
 999                 if (!NT_SUCCESS(Status))
1000                 {
1001                         WARN_(CLASS_NAME, "CreateClassDeviceObject() failed with status 0x%08lx\n", Status);
1002                         return Status;
1003                 }
1004         }
1005
1006         DriverObject->DriverExtension->AddDevice = ClassAddDevice;
1007         DriverObject->DriverUnload = DriverUnload;
1008
1009         for (i = 0; i <= IRP_MJ_MAXIMUM_FUNCTION; i++)
1010                 DriverObject->MajorFunction[i] = IrpStub;
1011
1012         DriverObject->MajorFunction[IRP_MJ_CREATE]         = ClassCreate;
1013         DriverObject->MajorFunction[IRP_MJ_CLOSE]          = ClassClose;
1014         DriverObject->MajorFunction[IRP_MJ_CLEANUP]        = ClassCleanup;
1015         DriverObject->MajorFunction[IRP_MJ_READ]           = ClassRead;
1016         DriverObject->MajorFunction[IRP_MJ_DEVICE_CONTROL] = ClassDeviceControl;
1017         DriverObject->MajorFunction[IRP_MJ_INTERNAL_DEVICE_CONTROL] = ForwardIrpAndForget;
1018         DriverObject->DriverStartIo                        = ClassStartIo;
1019
1020         /* We will detect the legacy devices later */
1021         IoRegisterDriverReinitialization(
1022                 DriverObject,
1023                 SearchForLegacyDrivers,
1024                 DriverExtension);
1025
1026         return STATUS_SUCCESS;
1027 }