reactos/drivers/usb/miniport/common/main.c

   1 /*
   2  * COPYRIGHT:       See COPYING in the top level directory
   3  * PROJECT:         ReactOS USB miniport driver (Cromwell type)
   4  * FILE:            drivers/usb/miniport/common/main.c
   5  * PURPOSE:         Driver entry
   6  *
   7  * PROGRAMMERS:     Aleksey Bragin (aleksey@reactos.com)
   8  *                  Hervé Poussineau (hpoussin@reactos.org),
   9  *
  10  * Some parts of code are inspired (or even just copied) from
  11  * ReactOS Videoport driver (drivers/video/videoprt)
  12  */
  13
  14 #define NDEBUG
  15 #include <debug.h>
  16
  17 #define INITGUID
  18 #include "usbcommon.h"
  19
  20 // data for embedded drivers
  21 CONNECT_DATA KbdClassInformation;
  22 CONNECT_DATA MouseClassInformation;
  23 PDEVICE_OBJECT KeyboardFdo = NULL;
  24 PDEVICE_OBJECT MouseFdo = NULL;
  25
  26 static NTSTATUS
  27 CreateRootHubPdo(
  28         IN PDRIVER_OBJECT DriverObject,
  29         IN PDEVICE_OBJECT Fdo,
  30         OUT PDEVICE_OBJECT* pPdo)
  31 {
  32         PDEVICE_OBJECT Pdo;
  33         PUSBMP_DEVICE_EXTENSION DeviceExtension;
  34         NTSTATUS Status;
  35
  36         DPRINT("USBMP: CreateRootHubPdo()\n");
  37
  38         Status = IoCreateDevice(
  39                 DriverObject,
  40                 sizeof(USBMP_DEVICE_EXTENSION),
  41                 NULL, /* DeviceName */
  42                 FILE_DEVICE_BUS_EXTENDER,
  43                 FILE_DEVICE_SECURE_OPEN | FILE_AUTOGENERATED_DEVICE_NAME,
  44                 FALSE,
  45                 &Pdo);
  46         if (!NT_SUCCESS(Status))
  47         {
  48                 DPRINT("USBMP: IoCreateDevice() call failed with status 0x%08x\n", Status);
  49                 return Status;
  50         }
  51
  52         Pdo->Flags |= DO_BUS_ENUMERATED_DEVICE;
  53         Pdo->Flags |= DO_POWER_PAGABLE;
  54
  55         // zerofill device extension
  56         DeviceExtension = (PUSBMP_DEVICE_EXTENSION)Pdo->DeviceExtension;
  57         RtlZeroMemory(DeviceExtension, sizeof(USBMP_DEVICE_EXTENSION));
  58
  59         DeviceExtension->IsFDO = FALSE;
  60         DeviceExtension->FunctionalDeviceObject = Fdo;
  61
  62         Pdo->Flags &= ~DO_DEVICE_INITIALIZING;
  63
  64         *pPdo = Pdo;
  65         return STATUS_SUCCESS;
  66 }
  67
  68 static NTSTATUS
  69 AddDevice_Keyboard(
  70         IN PDRIVER_OBJECT DriverObject,
  71         IN PDEVICE_OBJECT Pdo)
  72 {
  73         UNICODE_STRING DeviceName = RTL_CONSTANT_STRING(L"\\Device\\KeyboardClass0");
  74         PDEVICE_OBJECT Fdo;
  75         NTSTATUS Status;
  76
  77         Status = IoCreateDevice(DriverObject,
  78                 8, // debug
  79                 &DeviceName,
  80                 FILE_DEVICE_KEYBOARD,
  81                 FILE_DEVICE_SECURE_OPEN,
  82                 TRUE,
  83                 &Fdo);
  84
  85         if (!NT_SUCCESS(Status))
  86         {
  87                 DPRINT1("USBMP: IoCreateDevice() for usb keyboard driver failed with status 0x%08lx\n", Status);
  88                 return Status;
  89         }
  90         KeyboardFdo = Fdo;
  91         Fdo->Flags &= ~DO_DEVICE_INITIALIZING;
  92         DPRINT("USBMP: Created keyboard Fdo: %p\n", Fdo);
  93
  94         return STATUS_SUCCESS;
  95 }
  96
  97 static NTSTATUS
  98 AddDevice_Mouse(
  99         IN PDRIVER_OBJECT DriverObject,
 100         IN PDEVICE_OBJECT Pdo)
 101 {
 102         UNICODE_STRING DeviceName = RTL_CONSTANT_STRING(L"\\Device\\PointerClass0");
 103         PDEVICE_OBJECT Fdo;
 104         NTSTATUS Status;
 105
 106         Status = IoCreateDevice(DriverObject,
 107                 8, // debug
 108                 &DeviceName,
 109                 FILE_DEVICE_MOUSE,
 110                 FILE_DEVICE_SECURE_OPEN,
 111                 TRUE,
 112                 &Fdo);
 113
 114         if (!NT_SUCCESS(Status))
 115         {
 116                 DPRINT1("USBMP: IoCreateDevice() for usb mouse driver failed with status 0x%08lx\n", Status);
 117                 return Status;
 118         }
 119         MouseFdo = Fdo;
 120         Fdo->Flags &= ~DO_DEVICE_INITIALIZING;
 121         DPRINT("USBMP: Created mouse Fdo: %p\n", Fdo);
 122
 123         return STATUS_SUCCESS;
 124 }
 125
 126 NTSTATUS STDCALL
 127 AddDevice(
 128         IN PDRIVER_OBJECT DriverObject,
 129         IN PDEVICE_OBJECT pdo)
 130 {
 131         PDEVICE_OBJECT fdo;
 132         NTSTATUS Status;
 133         WCHAR DeviceBuffer[20];
 134         WCHAR LinkDeviceBuffer[20];
 135         UNICODE_STRING DeviceName;
 136         UNICODE_STRING LinkDeviceName;
 137         PUSBMP_DRIVER_EXTENSION DriverExtension;
 138         PUSBMP_DEVICE_EXTENSION DeviceExtension;
 139         ULONG DeviceNumber;
 140
 141         /* FIXME: actually, we prevent multiple USB controllers on a computer */
 142         static BOOLEAN xbox_workaround = FALSE;
 143
 144         DPRINT("USBMP: AddDevice called\n");
 145
 146         if (xbox_workaround)
 147                 // Fail for any other host controller than the first
 148                 return STATUS_INSUFFICIENT_RESOURCES;
 149         xbox_workaround = TRUE;
 150
 151         // Allocate driver extension now
 152         DriverExtension = IoGetDriverObjectExtension(DriverObject, DriverObject);
 153         if (DriverExtension == NULL)
 154         {
 155                 Status = IoAllocateDriverObjectExtension(
 156                                         DriverObject,
 157                                         DriverObject,
 158                                         sizeof(USBMP_DRIVER_EXTENSION),
 159                                         (PVOID *)&DriverExtension);
 160
 161                 if (!NT_SUCCESS(Status))
 162                 {
 163                         DPRINT("USBMP: Allocating DriverObjectExtension failed.\n");
 164                         return Status;
 165                 }
 166         }
 167
 168         // Create a unicode device name
 169 //      DeviceNumber = 0; //TODO: Allocate new device number every time
 170         swprintf(DeviceBuffer, L"\\Device\\USBFDO-%lu", DeviceNumber);
 171         RtlInitUnicodeString(&DeviceName, DeviceBuffer);
 172
 173         Status = IoCreateDevice(DriverObject,
 174                                 sizeof(USBMP_DEVICE_EXTENSION),
 175                                 &DeviceName,
 176                                 FILE_DEVICE_BUS_EXTENDER,
 177                                 0,
 178                                 FALSE,
 179                                 &fdo);
 180
 181         if (!NT_SUCCESS(Status))
 182         {
 183                 DPRINT("USBMP: IoCreateDevice call failed with status 0x%08lx\n", Status);
 184                 return Status;
 185         }
 186
 187         // zerofill device extension
 188         DeviceExtension = (PUSBMP_DEVICE_EXTENSION)fdo->DeviceExtension;
 189         RtlZeroMemory(DeviceExtension, sizeof(USBMP_DEVICE_EXTENSION));
 190
 191         /* Create root hub Pdo */
 192         Status = CreateRootHubPdo(DriverObject, fdo, &DeviceExtension->RootHubPdo);
 193         if (!NT_SUCCESS(Status))
 194         {
 195                 DPRINT("USBMP: CreateRootHubPdo() failed with status 0x%08lx\n", Status);
 196                 IoDeleteDevice(fdo);
 197                 return Status;
 198         }
 199
 200         /* Register device interface for controller */
 201         Status = IoRegisterDeviceInterface(
 202                 pdo,
 203                 &GUID_DEVINTERFACE_USB_HOST_CONTROLLER,
 204                 NULL,
 205                 &DeviceExtension->HcdInterfaceName);
 206         if (!NT_SUCCESS(Status))
 207         {
 208                 DPRINT("USBMP: IoRegisterDeviceInterface() failed with status 0x%08lx\n", Status);
 209                 IoDeleteDevice(DeviceExtension->RootHubPdo);
 210                 IoDeleteDevice(fdo);
 211                 return Status;
 212         }
 213
 214         DeviceExtension->NextDeviceObject = IoAttachDeviceToDeviceStack(fdo, pdo);
 215
 216         // Initialize device extension
 217         DeviceExtension->IsFDO = TRUE;
 218         DeviceExtension->DeviceNumber = DeviceNumber;
 219         DeviceExtension->PhysicalDeviceObject = pdo;
 220         DeviceExtension->FunctionalDeviceObject = fdo;
 221         DeviceExtension->DriverExtension = DriverExtension;
 222
 223         fdo->Flags &= ~DO_DEVICE_INITIALIZING;
 224
 225         /* FIXME: do a loop to find an available number */
 226         swprintf(LinkDeviceBuffer, L"\\??\\HCD%lu", 0);
 227
 228         RtlInitUnicodeString(&LinkDeviceName, LinkDeviceBuffer);
 229
 230         Status = IoCreateSymbolicLink(&LinkDeviceName, &DeviceName);
 231
 232         if (NT_SUCCESS(Status))
 233                 Status = AddDevice_Keyboard(DriverObject, pdo);
 234         if (NT_SUCCESS(Status))
 235                 Status = AddDevice_Mouse(DriverObject, pdo);
 236
 237         if (!NT_SUCCESS(Status))
 238         {
 239                 DPRINT("USBMP: IoCreateSymbolicLink() call failed with status 0x%08x\n", Status);
 240                 IoDeleteDevice(DeviceExtension->RootHubPdo);
 241                 IoDeleteDevice(fdo);
 242                 return Status;
 243         }
 244
 245
 246         return STATUS_SUCCESS;
 247 }
 248
 249 NTSTATUS STDCALL
 250 IrpStub(
 251         IN PDEVICE_OBJECT DeviceObject,
 252         IN PIRP Irp)
 253 {
 254         NTSTATUS Status = STATUS_NOT_SUPPORTED;
 255
 256         if (((PUSBMP_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsFDO)
 257         {
 258                 DPRINT1("USBMP: FDO stub for major function 0x%lx\n",
 259                         IoGetCurrentIrpStackLocation(Irp)->MajorFunction);
 260 #ifndef NDEBUG
 261                 DbgBreakPoint();
 262 #endif
 263                 return ForwardIrpAndForget(DeviceObject, Irp);
 264         }
 265         else
 266         {
 267                 /* We can't forward request to the lower driver, because
 268                  * we are a Pdo, so we don't have lower driver...
 269                  */
 270                 DPRINT1("USBMP: PDO stub for major function 0x%lx\n",
 271                         IoGetCurrentIrpStackLocation(Irp)->MajorFunction);
 272 #ifndef NDEBUG
 273                 DbgBreakPoint();
 274 #endif
 275         }
 276
 277         Status = Irp->IoStatus.Status;
 278         IoCompleteRequest(Irp, IO_NO_INCREMENT);
 279         return Status;
 280 }
 281
 282 static NTSTATUS STDCALL
 283 DispatchCreate(PDEVICE_OBJECT DeviceObject, PIRP Irp)
 284 {
 285         if (((PUSBMP_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsFDO)
 286                 return UsbMpCreate(DeviceObject, Irp);
 287         else
 288                 return IrpStub(DeviceObject, Irp);
 289 }
 290
 291 static NTSTATUS STDCALL
 292 DispatchClose(PDEVICE_OBJECT DeviceObject, PIRP Irp)
 293 {
 294         if (((PUSBMP_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsFDO)
 295                 return UsbMpClose(DeviceObject, Irp);
 296         else
 297                 return IrpStub(DeviceObject, Irp);
 298 }
 299
 300 static NTSTATUS STDCALL
 301 DispatchCleanup(PDEVICE_OBJECT DeviceObject, PIRP Irp)
 302 {
 303         if (((PUSBMP_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsFDO)
 304                 return UsbMpCleanup(DeviceObject, Irp);
 305         else
 306                 return IrpStub(DeviceObject, Irp);
 307 }
 308
 309 static NTSTATUS STDCALL
 310 DispatchDeviceControl(PDEVICE_OBJECT DeviceObject, PIRP Irp)
 311 {
 312         if (((PUSBMP_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsFDO)
 313                 return UsbMpDeviceControlFdo(DeviceObject, Irp);
 314         else
 315                 return UsbMpDeviceControlPdo(DeviceObject, Irp);
 316 }
 317
 318 static NTSTATUS STDCALL
 319 DispatchInternalDeviceControl(PDEVICE_OBJECT DeviceObject, PIRP Irp)
 320 {
 321         if (((PUSBMP_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsFDO)
 322                 return UsbMpInternalDeviceControlFdo(DeviceObject, Irp);
 323         else
 324                 return IrpStub(DeviceObject, Irp);
 325 }
 326
 327 static NTSTATUS STDCALL
 328 DispatchPnp(PDEVICE_OBJECT DeviceObject, PIRP Irp)
 329 {
 330         if (((PUSBMP_DEVICE_EXTENSION)DeviceObject->DeviceExtension)->IsFDO)
 331                 return UsbMpPnpFdo(DeviceObject, Irp);
 332         else
 333                 return UsbMpPnpPdo(DeviceObject, Irp);
 334 }
 335
 336 static NTSTATUS STDCALL
 337 DispatchPower(PDEVICE_OBJECT fido, PIRP Irp)
 338 {
 339         DPRINT1("USBMP: IRP_MJ_POWER unimplemented\n");
 340         Irp->IoStatus.Information = 0;
 341         Irp->IoStatus.Status = STATUS_SUCCESS;
 342         IoCompleteRequest(Irp, IO_NO_INCREMENT);
 343         return STATUS_SUCCESS;
 344 }
 345
 346 /*
 347  * Standard DriverEntry method.
 348  */
 349 NTSTATUS STDCALL
 350 DriverEntry(IN PDRIVER_OBJECT DriverObject, IN PUNICODE_STRING RegPath)
 351 {
 352         USBPORT_INTERFACE UsbPortInterface;
 353         ULONG i;
 354
 355         DriverObject->DriverUnload = DriverUnload;
 356         DriverObject->DriverExtension->AddDevice = AddDevice;
 357
 358         for (i = 0; i < IRP_MJ_MAXIMUM_FUNCTION; i++)
 359                 DriverObject->MajorFunction[i] = IrpStub;
 360
 361         DriverObject->MajorFunction[IRP_MJ_CREATE] = DispatchCreate;
 362         DriverObject->MajorFunction[IRP_MJ_CLOSE] = DispatchClose;
 363         DriverObject->MajorFunction[IRP_MJ_CLEANUP] = DispatchCleanup;
 364         DriverObject->MajorFunction[IRP_MJ_DEVICE_CONTROL] = DispatchDeviceControl;
 365         DriverObject->MajorFunction[IRP_MJ_INTERNAL_DEVICE_CONTROL] = DispatchInternalDeviceControl;
 366         DriverObject->MajorFunction[IRP_MJ_PNP] = DispatchPnp;
 367         DriverObject->MajorFunction[IRP_MJ_POWER] = DispatchPower;
 368
 369         // Register in usbcore.sys
 370         UsbPortInterface.KbdConnectData = &KbdClassInformation;
 371         UsbPortInterface.MouseConnectData = &MouseClassInformation;
 372
 373         KbdClassInformation.ClassService = NULL;
 374         KbdClassInformation.ClassDeviceObject = NULL;
 375         MouseClassInformation.ClassService = NULL;
 376         MouseClassInformation.ClassDeviceObject = NULL;
 377
 378         RegisterPortDriver(DriverObject, &UsbPortInterface);
 379
 380         return STATUS_SUCCESS;
 381 }