2 * PROJECT: ReactOS Universal Serial Bus Bulk Storage Driver
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: drivers/usb/usbstor/error.c
5 * PURPOSE: USB block storage device driver.
8 * Michael Martin (michael.martin@reactos.org)
9 * Johannes Anderwald (johannes.anderwald@reactos.org)
18 USBSTOR_GetEndpointStatus(
19 IN PDEVICE_OBJECT DeviceObject
,
20 IN UCHAR bEndpointAddress
,
29 DPRINT("Allocating URB\n");
30 Urb
= (PURB
)AllocateItem(NonPagedPool
, sizeof(struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST
));
36 DPRINT1("OutofMemory!\n");
37 return STATUS_INSUFFICIENT_RESOURCES
;
43 UsbBuildGetStatusRequest(Urb
, URB_FUNCTION_GET_STATUS_FROM_ENDPOINT
, bEndpointAddress
& 0x0F, Value
, NULL
, NULL
);
48 DPRINT1("Sending Request DeviceObject %p, Urb %p\n", DeviceObject
, Urb
);
49 Status
= USBSTOR_SyncUrbRequest(DeviceObject
, Urb
);
65 USBSTOR_ResetPipeWithHandle(
66 IN PDEVICE_OBJECT DeviceObject
,
67 IN USBD_PIPE_HANDLE PipeHandle
)
75 DPRINT("Allocating URB\n");
76 Urb
= (PURB
)AllocateItem(NonPagedPool
, sizeof(struct _URB_PIPE_REQUEST
));
82 DPRINT1("OutofMemory!\n");
83 return STATUS_INSUFFICIENT_RESOURCES
;
89 Urb
->UrbPipeRequest
.Hdr
.Length
= sizeof(struct _URB_PIPE_REQUEST
);
90 Urb
->UrbPipeRequest
.Hdr
.Function
= URB_FUNCTION_SYNC_RESET_PIPE_AND_CLEAR_STALL
;
91 Urb
->UrbPipeRequest
.PipeHandle
= PipeHandle
;
96 DPRINT1("Sending Request DeviceObject %p, Urb %p\n", DeviceObject
, Urb
);
97 Status
= USBSTOR_SyncUrbRequest(DeviceObject
, Urb
);
112 USBSTOR_HandleTransferError(
113 PDEVICE_OBJECT DeviceObject
,
114 PIRP_CONTEXT Context
)
116 NTSTATUS Status
= STATUS_SUCCESS
;
117 PIO_STACK_LOCATION Stack
;
118 PSCSI_REQUEST_BLOCK Request
;
125 ASSERT(Context
->PDODeviceExtension
);
126 ASSERT(Context
->PDODeviceExtension
->Self
);
127 ASSERT(Context
->Irp
);
130 // first perform a mass storage reset step 1 in 5.3.4 USB Mass Storage Bulk Only Specification
132 Status
= USBSTOR_ResetDevice(Context
->FDODeviceExtension
->LowerDeviceObject
, Context
->FDODeviceExtension
);
133 if (NT_SUCCESS(Status
))
136 // step 2 reset bulk in pipe section 5.3.4
138 Status
= USBSTOR_ResetPipeWithHandle(Context
->FDODeviceExtension
->LowerDeviceObject
, Context
->FDODeviceExtension
->InterfaceInformation
->Pipes
[Context
->FDODeviceExtension
->BulkInPipeIndex
].PipeHandle
);
139 if (NT_SUCCESS(Status
))
142 // finally reset bulk out pipe
144 Status
= USBSTOR_ResetPipeWithHandle(Context
->FDODeviceExtension
->LowerDeviceObject
, Context
->FDODeviceExtension
->InterfaceInformation
->Pipes
[Context
->FDODeviceExtension
->BulkOutPipeIndex
].PipeHandle
);
149 // get next stack location
151 Stack
= IoGetCurrentIrpStackLocation(Context
->Irp
);
156 Request
= (PSCSI_REQUEST_BLOCK
)Stack
->Parameters
.Others
.Argument1
;
160 // obtain request type
162 pCDB
= (PCDB
)Request
->Cdb
;
165 if (Status
!= STATUS_SUCCESS
|| Context
->RetryCount
>= 1)
168 // Complete the master IRP
170 Context
->Irp
->IoStatus
.Status
= Status
;
171 Context
->Irp
->IoStatus
.Information
= 0;
172 USBSTOR_QueueTerminateRequest(Context
->PDODeviceExtension
->LowerDeviceObject
, Context
->Irp
);
173 IoCompleteRequest(Context
->Irp
, IO_NO_INCREMENT
);
176 // Start the next request
178 USBSTOR_QueueNextRequest(Context
->PDODeviceExtension
->LowerDeviceObject
);
181 // srb handling finished
183 Context
->FDODeviceExtension
->SrbErrorHandlingActive
= FALSE
;
188 Context
->FDODeviceExtension
->LastTimerActiveSrb
= NULL
;
192 DPRINT1("Retrying Count %lu %p\n", Context
->RetryCount
, Context
->PDODeviceExtension
->Self
);
195 // re-schedule request
197 USBSTOR_HandleExecuteSCSI(Context
->PDODeviceExtension
->Self
, Context
->Irp
, Context
->RetryCount
+ 1);
200 // srb error handling finished
202 Context
->FDODeviceExtension
->SrbErrorHandlingActive
= FALSE
;
205 // srb error handling finished
207 Context
->FDODeviceExtension
->TimerWorkQueueEnabled
= TRUE
;
212 Context
->FDODeviceExtension
->LastTimerActiveSrb
= NULL
;
216 // cleanup irp context
218 FreeItem(Context
->cbw
);
222 DPRINT1("USBSTOR_HandleTransferError returning with Status %x\n", Status
);
228 USBSTOR_ResetHandlerWorkItemRoutine(
232 PERRORHANDLER_WORKITEM_DATA WorkItemData
= (PERRORHANDLER_WORKITEM_DATA
)Context
;
235 // clear stall on BulkIn pipe
237 Status
= USBSTOR_ResetPipeWithHandle(WorkItemData
->Context
->FDODeviceExtension
->LowerDeviceObject
, WorkItemData
->Context
->FDODeviceExtension
->InterfaceInformation
->Pipes
[WorkItemData
->Context
->FDODeviceExtension
->BulkInPipeIndex
].PipeHandle
);
238 DPRINT1("USBSTOR_ResetPipeWithHandle Status %x\n", Status
);
241 // now resend the csw as the stall got cleared
243 USBSTOR_SendCSW(WorkItemData
->Context
, WorkItemData
->Irp
);
248 ErrorHandlerWorkItemRoutine(
251 PERRORHANDLER_WORKITEM_DATA WorkItemData
= (PERRORHANDLER_WORKITEM_DATA
)Context
;
253 if (WorkItemData
->Context
->ErrorIndex
== 2)
258 USBSTOR_HandleTransferError(WorkItemData
->DeviceObject
, WorkItemData
->Context
);
265 USBSTOR_ResetHandlerWorkItemRoutine(WorkItemData
);
269 // Free Work Item Data
271 ExFreePoolWithTag(WorkItemData
, USB_STOR_TAG
);
276 USBSTOR_TimerWorkerRoutine(
279 PFDO_DEVICE_EXTENSION FDODeviceExtension
;
281 PERRORHANDLER_WORKITEM_DATA WorkItemData
= (PERRORHANDLER_WORKITEM_DATA
)Context
;
284 // get device extension
286 FDODeviceExtension
= (PFDO_DEVICE_EXTENSION
)WorkItemData
->DeviceObject
->DeviceExtension
;
287 ASSERT(FDODeviceExtension
->Common
.IsFDO
);
290 // first perform a mass storage reset step 1 in 5.3.4 USB Mass Storage Bulk Only Specification
292 Status
= USBSTOR_ResetDevice(FDODeviceExtension
->LowerDeviceObject
, FDODeviceExtension
);
293 if (NT_SUCCESS(Status
))
296 // step 2 reset bulk in pipe section 5.3.4
298 Status
= USBSTOR_ResetPipeWithHandle(FDODeviceExtension
->LowerDeviceObject
, FDODeviceExtension
->InterfaceInformation
->Pipes
[FDODeviceExtension
->BulkInPipeIndex
].PipeHandle
);
299 if (NT_SUCCESS(Status
))
302 // finally reset bulk out pipe
304 Status
= USBSTOR_ResetPipeWithHandle(FDODeviceExtension
->LowerDeviceObject
, FDODeviceExtension
->InterfaceInformation
->Pipes
[FDODeviceExtension
->BulkOutPipeIndex
].PipeHandle
);
307 DPRINT1("Status %x\n", Status
);
312 FDODeviceExtension
->LastTimerActiveSrb
= NULL
;
315 // re-schedule request
317 //USBSTOR_HandleExecuteSCSI(WorkItemData->Context->PDODeviceExtension->Self, WorkItemData->Context->Irp, Context->RetryCount + 1);
322 // do not retry for the same packet again
324 FDODeviceExtension
->TimerWorkQueueEnabled
= FALSE
;
327 // Free Work Item Data
329 ExFreePoolWithTag(WorkItemData
, USB_STOR_TAG
);
335 USBSTOR_TimerRoutine(
336 PDEVICE_OBJECT DeviceObject
,
339 PFDO_DEVICE_EXTENSION FDODeviceExtension
;
340 BOOLEAN ResetDevice
= FALSE
;
341 PERRORHANDLER_WORKITEM_DATA WorkItemData
;
344 // get device extension
346 FDODeviceExtension
= (PFDO_DEVICE_EXTENSION
)Context
;
347 DPRINT1("[USBSTOR] TimerRoutine entered\n");
348 DPRINT1("[USBSTOR] ActiveSrb %p ResetInProgress %x LastTimerActiveSrb %p\n", FDODeviceExtension
->ActiveSrb
, FDODeviceExtension
->ResetInProgress
, FDODeviceExtension
->LastTimerActiveSrb
);
353 KeAcquireSpinLockAtDpcLevel(&FDODeviceExtension
->IrpListLock
);
356 // is there an active srb and no global reset is in progress
358 if (FDODeviceExtension
->ActiveSrb
&& FDODeviceExtension
->ResetInProgress
== FALSE
&& FDODeviceExtension
->TimerWorkQueueEnabled
)
360 if (FDODeviceExtension
->LastTimerActiveSrb
!= NULL
&& FDODeviceExtension
->LastTimerActiveSrb
== FDODeviceExtension
->ActiveSrb
)
365 DPRINT1("[USBSTOR] ActiveSrb %p hang detected\n", FDODeviceExtension
->ActiveSrb
);
373 FDODeviceExtension
->LastTimerActiveSrb
= FDODeviceExtension
->ActiveSrb
;
381 FDODeviceExtension
->LastTimerActiveSrb
= NULL
;
387 KeReleaseSpinLockFromDpcLevel(&FDODeviceExtension
->IrpListLock
);
390 if (ResetDevice
&& FDODeviceExtension
->TimerWorkQueueEnabled
&& FDODeviceExtension
->SrbErrorHandlingActive
== FALSE
)
392 WorkItemData
= ExAllocatePoolWithTag(NonPagedPool
,
393 sizeof(ERRORHANDLER_WORKITEM_DATA
),
398 // Initialize and queue the work item to handle the error
400 ExInitializeWorkItem(&WorkItemData
->WorkQueueItem
,
401 USBSTOR_TimerWorkerRoutine
,
404 WorkItemData
->DeviceObject
= FDODeviceExtension
->FunctionalDeviceObject
;
406 DPRINT1("[USBSTOR] Queing Timer WorkItem\n");
407 ExQueueWorkItem(&WorkItemData
->WorkQueueItem
, DelayedWorkQueue
);