drivers/usb/usbstor/misc.c

   1 /*
   2  * PROJECT:     ReactOS Universal Serial Bus Bulk Storage Driver
   3  * LICENSE:     GPL - See COPYING in the top level directory
   4  * FILE:        drivers/usb/usbstor/misc.c
   5  * PURPOSE:     USB block storage device driver.
   6  * PROGRAMMERS:
   7  *              James Tabor
   8  *              Michael Martin (michael.martin@reactos.org)
   9  *              Johannes Anderwald (johannes.anderwald@reactos.org)
  10  */
  11
  12 #include "usbstor.h"
  13
  14 //
  15 // driver verifier
  16 //
  17 IO_COMPLETION_ROUTINE SyncForwardIrpCompletionRoutine;
  18
  19 NTSTATUS
  20 NTAPI
  21 USBSTOR_SyncForwardIrpCompletionRoutine(
  22     PDEVICE_OBJECT DeviceObject,
  23     PIRP Irp,
  24     PVOID Context)
  25 {
  26     if (Irp->PendingReturned)
  27     {
  28         KeSetEvent((PKEVENT)Context, IO_NO_INCREMENT, FALSE);
  29     }
  30     return STATUS_MORE_PROCESSING_REQUIRED;
  31 }
  32
  33 NTSTATUS
  34 NTAPI
  35 USBSTOR_SyncForwardIrp(PDEVICE_OBJECT DeviceObject, PIRP Irp)
  36 {
  37     KEVENT Event;
  38     NTSTATUS Status;
  39
  40     //
  41     // initialize event
  42     //
  43     KeInitializeEvent(&Event, NotificationEvent, FALSE);
  44
  45     //
  46     // copy irp stack location
  47     //
  48     IoCopyCurrentIrpStackLocationToNext(Irp);
  49
  50     //
  51     // set completion routine
  52     //
  53     IoSetCompletionRoutine(Irp, USBSTOR_SyncForwardIrpCompletionRoutine, &Event, TRUE, TRUE, TRUE);
  54
  55
  56     //
  57     // call driver
  58     //
  59     Status = IoCallDriver(DeviceObject, Irp);
  60
  61     //
  62     // check if pending
  63     //
  64     if (Status == STATUS_PENDING)
  65     {
  66         //
  67         // wait for the request to finish
  68         //
  69         KeWaitForSingleObject(&Event, Executive, KernelMode, FALSE, NULL);
  70
  71         //
  72         // copy status code
  73         //
  74         Status = Irp->IoStatus.Status;
  75     }
  76
  77     //
  78     // done
  79     //
  80     return Status;
  81 }
  82
  83 NTSTATUS
  84 NTAPI
  85 USBSTOR_GetBusInterface(
  86     IN PDEVICE_OBJECT DeviceObject,
  87     OUT PUSB_BUS_INTERFACE_USBDI_V2 BusInterface)
  88 {
  89     KEVENT Event;
  90     NTSTATUS Status;
  91     PIRP Irp;
  92     IO_STATUS_BLOCK IoStatus;
  93     PIO_STACK_LOCATION Stack;
  94
  95     //
  96     // sanity checks
  97     //
  98     ASSERT(DeviceObject);
  99     ASSERT(BusInterface);
 100
 101
 102     //
 103     // initialize event
 104     //
 105     KeInitializeEvent(&Event, NotificationEvent, FALSE);
 106
 107
 108     //
 109     // create irp
 110     //
 111     Irp = IoBuildSynchronousFsdRequest(IRP_MJ_PNP,
 112                                        DeviceObject,
 113                                        NULL,
 114                                        0,
 115                                        NULL,
 116                                        &Event,
 117                                        &IoStatus);
 118
 119     //
 120     // was irp built
 121     //
 122     if (Irp == NULL)
 123     {
 124         //
 125         // no memory
 126         //
 127         return STATUS_INSUFFICIENT_RESOURCES;
 128     }
 129
 130     //
 131     // initialize request
 132     //
 133     Stack=IoGetNextIrpStackLocation(Irp);
 134     Stack->MajorFunction = IRP_MJ_PNP;
 135     Stack->MinorFunction = IRP_MN_QUERY_INTERFACE;
 136     Stack->Parameters.QueryInterface.Size = sizeof(BUS_INTERFACE_STANDARD);
 137     Stack->Parameters.QueryInterface.InterfaceType = (LPGUID)&USB_BUS_INTERFACE_USBDI_GUID;
 138     Stack->Parameters.QueryInterface.Version = 2;
 139     Stack->Parameters.QueryInterface.Interface = (PINTERFACE)BusInterface;
 140     Stack->Parameters.QueryInterface.InterfaceSpecificData = NULL;
 141     Irp->IoStatus.Status = STATUS_NOT_SUPPORTED;
 142
 143     //
 144     // call driver
 145     //
 146     Status= IoCallDriver(DeviceObject, Irp);
 147
 148     //
 149     // did operation complete
 150     //
 151     if (Status == STATUS_PENDING)
 152     {
 153         //
 154         // wait for completion
 155         //
 156         KeWaitForSingleObject(&Event, Executive, KernelMode, FALSE, NULL);
 157
 158         //
 159         // collect status
 160         //
 161         Status=IoStatus.Status;
 162     }
 163
 164     return Status;
 165 }
 166
 167 NTSTATUS
 168 USBSTOR_SyncUrbRequest(
 169     IN PDEVICE_OBJECT DeviceObject,
 170     OUT PURB UrbRequest)
 171 {
 172     PIRP Irp;
 173     PIO_STACK_LOCATION IoStack;
 174     KEVENT Event;
 175     NTSTATUS Status;
 176
 177     //
 178     // allocate irp
 179     //
 180     Irp = IoAllocateIrp(DeviceObject->StackSize, FALSE);
 181     if (!Irp)
 182     {
 183         //
 184         // no memory
 185         //
 186         return STATUS_INSUFFICIENT_RESOURCES;
 187     }
 188
 189     //
 190     // initialize event
 191     //
 192     KeInitializeEvent(&Event, NotificationEvent, FALSE);
 193
 194
 195     //
 196     // get next stack location
 197     //
 198     IoStack = IoGetNextIrpStackLocation(Irp);
 199
 200     //
 201     // initialize stack location
 202     //
 203     IoStack->MajorFunction = IRP_MJ_INTERNAL_DEVICE_CONTROL;
 204     IoStack->Parameters.DeviceIoControl.IoControlCode = IOCTL_INTERNAL_USB_SUBMIT_URB;
 205     IoStack->Parameters.Others.Argument1 = (PVOID)UrbRequest;
 206     IoStack->Parameters.DeviceIoControl.InputBufferLength = UrbRequest->UrbHeader.Length;
 207     Irp->IoStatus.Status = STATUS_SUCCESS;
 208
 209     //
 210     // setup completion routine
 211     //
 212     IoSetCompletionRoutine(Irp, USBSTOR_SyncForwardIrpCompletionRoutine, &Event, TRUE, TRUE, TRUE);
 213
 214     //
 215     // call driver
 216     //
 217     Status = IoCallDriver(DeviceObject, Irp);
 218
 219     //
 220     // check if request is pending
 221     //
 222     if (Status == STATUS_PENDING)
 223     {
 224         //
 225         // wait for completion
 226         //
 227         KeWaitForSingleObject(&Event, Executive, KernelMode, FALSE, NULL);
 228
 229         //
 230         // update status
 231         //
 232         Status = Irp->IoStatus.Status;
 233     }
 234
 235     //
 236     // free irp
 237     //
 238     IoFreeIrp(Irp);
 239
 240     //
 241     // done
 242     //
 243     return Status;
 244 }
 245
 246 PVOID
 247 AllocateItem(
 248     IN POOL_TYPE PoolType,
 249     IN ULONG ItemSize)
 250 {
 251     //
 252     // allocate item
 253     //
 254     PVOID Item = ExAllocatePoolWithTag(PoolType, ItemSize, USB_STOR_TAG);
 255
 256     if (Item)
 257     {
 258         //
 259         // zero item
 260         //
 261         RtlZeroMemory(Item, ItemSize);
 262     }
 263
 264     //
 265     // return element
 266     //
 267     return Item;
 268 }
 269
 270 VOID
 271 FreeItem(
 272     IN PVOID Item)
 273 {
 274     //
 275     // free item
 276     //
 277     ExFreePoolWithTag(Item, USB_STOR_TAG);
 278 }
 279
 280 NTSTATUS
 281 USBSTOR_GetMaxLUN(
 282     IN PDEVICE_OBJECT DeviceObject,
 283     IN PFDO_DEVICE_EXTENSION DeviceExtension)
 284 {
 285     PURB Urb;
 286     PUCHAR Buffer;
 287     NTSTATUS Status;
 288
 289     //
 290     // first allocate urb
 291     //
 292     Urb = (PURB)AllocateItem(NonPagedPool, sizeof(struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST));
 293     if (!Urb)
 294     {
 295         //
 296         // no memory
 297         //
 298         return STATUS_INSUFFICIENT_RESOURCES;
 299     }
 300
 301     //
 302     // allocate 1-byte buffer
 303     //
 304     Buffer = (PUCHAR)AllocateItem(NonPagedPool, sizeof(UCHAR));
 305     if (!Buffer)
 306     {
 307         //
 308         // no memory
 309         //
 310         FreeItem(Buffer);
 311         return STATUS_INSUFFICIENT_RESOURCES;
 312     }
 313
 314     //
 315     // initialize vendor request
 316     //
 317     Urb->UrbControlVendorClassRequest.Hdr.Length = sizeof(struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST);
 318     Urb->UrbControlVendorClassRequest.Hdr.Function = URB_FUNCTION_CLASS_INTERFACE;
 319     Urb->UrbControlVendorClassRequest.TransferFlags = USBD_TRANSFER_DIRECTION_IN;
 320     Urb->UrbControlVendorClassRequest.TransferBufferLength = 1;
 321     Urb->UrbControlVendorClassRequest.TransferBuffer = Buffer;
 322     Urb->UrbControlVendorClassRequest.Request = USB_BULK_GET_MAX_LUN;
 323
 324     //
 325     // submit request
 326     //
 327     Status = USBSTOR_SyncUrbRequest(DeviceObject, Urb);
 328
 329     //
 330     // free urb
 331     //
 332     FreeItem(Urb);
 333
 334     DPRINT1("MaxLUN: %x\n", *Buffer);
 335
 336     if (*Buffer > 0xF)
 337     {
 338         //
 339         // invalid response documented in usb mass storage specification
 340         //
 341         Status = STATUS_DEVICE_DATA_ERROR;
 342     }
 343     else
 344     {
 345         //
 346         // store maxlun
 347         //
 348         DeviceExtension->MaxLUN = *Buffer;
 349     }
 350
 351     //
 352     // free buffer
 353     //
 354     FreeItem(Buffer);
 355
 356     //
 357     // done
 358     //
 359     return Status;
 360
 361 }