ReactOS  0.4.13-dev-479-gec9c8fd
usbstor.c
Go to the documentation of this file.
1 /*
2  * PROJECT: ReactOS Universal Serial Bus Bulk Storage Driver
3  * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later)
4  * PURPOSE: USB block storage device driver.
5  * COPYRIGHT: 2005-2006 James Tabor
6  * 2011-2012 Michael Martin (michael.martin@reactos.org)
7  * 2011-2013 Johannes Anderwald (johannes.anderwald@reactos.org)
8  */
9 
10 #include "usbstor.h"
11 
12 #define NDEBUG
13 #include <debug.h>
14 
15 
17 NTAPI
21 {
24  PFDO_DEVICE_EXTENSION DeviceExtension;
25 
27  if (!NT_SUCCESS(Status))
28  {
29  DPRINT1("USBSTOR_AddDevice: Failed to create FDO Status %x\n", Status);
30  return Status;
31  }
32 
34  ASSERT(DeviceExtension);
35  RtlZeroMemory(DeviceExtension, sizeof(FDO_DEVICE_EXTENSION));
36 
37  // initialize device extension
38  DeviceExtension->Common.IsFDO = TRUE;
39  DeviceExtension->FunctionalDeviceObject = DeviceObject;
40  DeviceExtension->PhysicalDeviceObject = PhysicalDeviceObject;
41  DeviceExtension->LowerDeviceObject = IoAttachDeviceToDeviceStack(DeviceObject, PhysicalDeviceObject);
42 
43  KeInitializeSpinLock(&DeviceExtension->CommonLock);
44 
46 
47  // did attaching fail
48  if (!DeviceExtension->LowerDeviceObject)
49  {
51 
52  return STATUS_DEVICE_REMOVED;
53  }
54 
56 
57  // device is initialized
59 
60  return STATUS_SUCCESS;
61 }
62 
63 VOID
64 NTAPI
67 {
68  // no-op
69 }
70 
72 NTAPI
75  PIRP Irp)
76 {
77  // function always succeeds ;)
78  DPRINT("USBSTOR_DispatchClose\n");
79  Irp->IoStatus.Information = 0;
80  Irp->IoStatus.Status = STATUS_SUCCESS;
82  return STATUS_SUCCESS;
83 }
84 
86 NTAPI
89  PIRP Irp)
90 {
92 
94  Irp->IoStatus.Status = Status;
96  return Status;
97 }
98 
100 NTAPI
103  PIRP Irp)
104 {
106 }
107 
108 NTSTATUS
109 NTAPI
112  PIRP Irp)
113 {
114  // read write ioctl is not supported
115  Irp->IoStatus.Information = 0;
116  Irp->IoStatus.Status = STATUS_INVALID_PARAMETER;
119 }
120 
121 NTSTATUS
122 NTAPI
125  PIRP Irp)
126 {
127  PUSBSTOR_COMMON_DEVICE_EXTENSION DeviceExtension;
128 
130 
131  if (DeviceExtension->IsFDO)
132  {
134  }
135  else
136  {
138  }
139 }
140 
141 NTSTATUS
142 NTAPI
145  IN PIRP Irp)
146 {
149 
150  if (DeviceExtension->IsFDO)
151  {
152  return IoCallDriver(((PFDO_DEVICE_EXTENSION)DeviceExtension)->LowerDeviceObject, Irp);
153  }
154  else
155  {
156  return IoCallDriver(((PPDO_DEVICE_EXTENSION)DeviceExtension)->LowerDeviceObject, Irp);
157  }
158 }
159 
160 NTSTATUS
161 NTAPI
164  PIRP Irp)
165 {
166  PFDO_DEVICE_EXTENSION DeviceExtension;
167 
168  // get common device extension
170 
171  if (DeviceExtension->Common.IsFDO)
172  {
175  return PoCallDriver(DeviceExtension->LowerDeviceObject, Irp);
176  }
177  else
178  {
180  Irp->IoStatus.Status = STATUS_SUCCESS;
182  return STATUS_SUCCESS;
183  }
184 }
185 
186 NTSTATUS
187 NTAPI
190  IN PUNICODE_STRING RegPath)
191 {
192 
193  DPRINT("********* USB Storage *********\n");
194 
207 
208  return STATUS_SUCCESS;
209 }
#define DO_DEVICE_INITIALIZING
Definition: env_spec_w32.h:399
#define DO_POWER_PAGABLE
#define IN
Definition: typedefs.h:38
#define STATUS_DEVICE_REMOVED
Definition: ntstatus.h:795
#define TRUE
Definition: types.h:120
#define IRP_MJ_CREATE
Definition: rdpdr.c:44
NTSTATUS NTAPI PoCallDriver(IN PDEVICE_OBJECT DeviceObject, IN OUT PIRP Irp)
Definition: power.c:485
_In_ PIRP Irp
Definition: csq.h:116
#define STATUS_INVALID_PARAMETER
Definition: udferr_usr.h:135
#define IRP_MJ_PNP
Definition: cdrw_usr.h:52
LONG NTSTATUS
Definition: precomp.h:26
NTSTATUS USBSTOR_FdoHandlePnp(IN PDEVICE_OBJECT DeviceObject, IN OUT PIRP Irp)
Definition: fdo.c:273
struct _FDO_DEVICE_EXTENSION * PFDO_DEVICE_EXTENSION
NTSTATUS NTAPI USBSTOR_DispatchClose(PDEVICE_OBJECT DeviceObject, PIRP Irp)
Definition: usbstor.c:73
#define IRP_MJ_SCSI
struct __COMMON_DEVICE_EXTENSION__ * PUSBSTOR_COMMON_DEVICE_EXTENSION
NTSTATUS NTAPI USBSTOR_DispatchDeviceControl(PDEVICE_OBJECT DeviceObject, PIRP Irp)
Definition: usbstor.c:87
NTSTATUS(* NTAPI)(IN PFILE_FULL_EA_INFORMATION EaBuffer, IN ULONG EaLength, OUT PULONG ErrorOffset)
Definition: IoEaTest.cpp:117
PDEVICE_OBJECT NTAPI IoAttachDeviceToDeviceStack(IN PDEVICE_OBJECT SourceDevice, IN PDEVICE_OBJECT TargetDevice)
Definition: device.c:966
PDRIVER_EXTENSION DriverExtension
Definition: iotypes.h:2173
NTSTATUS NTAPI USBSTOR_DispatchReadWrite(PDEVICE_OBJECT DeviceObject, PIRP Irp)
Definition: usbstor.c:110
NTSTATUS NTAPI USBSTOR_DispatchScsi(PDEVICE_OBJECT DeviceObject, PIRP Irp)
Definition: usbstor.c:101
FORCEINLINE VOID KeInitializeSpinLock(_Out_ PKSPIN_LOCK SpinLock)
Definition: kefuncs.h:251
PVOID DeviceExtension
Definition: env_spec_w32.h:418
static PDRIVER_OBJECT DriverObject
Definition: template.c:42
#define IoCompleteRequest
Definition: irp.c:1240
void DPRINT(...)
Definition: polytest.cpp:61
#define FILE_AUTOGENERATED_DEVICE_NAME
Definition: iotypes.h:138
NTSTATUS USBSTOR_PdoHandlePnp(IN PDEVICE_OBJECT DeviceObject, IN OUT PIRP Irp)
Definition: pdo.c:549
if(!(yy_init))
Definition: macro.lex.yy.c:714
#define NT_SUCCESS(StatCode)
Definition: apphelp.c:32
NTSTATUS NTAPI IoInitializeTimer(IN PDEVICE_OBJECT DeviceObject, IN PIO_TIMER_ROUTINE TimerRoutine, IN PVOID Context)
Definition: iotimer.c:92
#define DO_BUFFERED_IO
Definition: env_spec_w32.h:394
NTSTATUS USBSTOR_HandleInternalDeviceControl(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: disk.c:81
VOID NTAPI USBSTOR_StartIo(PDEVICE_OBJECT DeviceObject, PIRP Irp)
Definition: queue.c:300
ASSERT((InvokeOnSuccess||InvokeOnError||InvokeOnCancel) ?(CompletionRoutine !=NULL) :TRUE)
#define IRP_MJ_POWER
#define IRP_MJ_CLOSE
Definition: rdpdr.c:45
NTSTATUS NTAPI USBSTOR_DispatchSystemControl(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: usbstor.c:143
PDRIVER_UNLOAD DriverUnload
Definition: iotypes.h:2179
NTSTATUS NTAPI USBSTOR_DispatchPower(PDEVICE_OBJECT DeviceObject, PIRP Irp)
Definition: usbstor.c:162
_In_z_ PCCHAR _In_ PDEVICE_OBJECT LowerDeviceObject
Definition: classpnp.h:789
COMMON_DEVICE_EXTENSION Common
Definition: pci.h:80
#define IRP_MJ_SYSTEM_CONTROL
VOID NTAPI USBSTOR_TimerRoutine(PDEVICE_OBJECT DeviceObject, PVOID Context)
Definition: error.c:206
Status
Definition: gdiplustypes.h:24
IN PDEVICE_OBJECT DeviceObject
Definition: fatprocs.h:1560
VOID NTAPI IoDeleteDevice(IN PDEVICE_OBJECT DeviceObject)
Definition: device.c:1250
NTSTATUS NTAPI DriverEntry(IN PDRIVER_OBJECT DriverObject, IN PUNICODE_STRING RegPath)
Definition: usbstor.c:188
PDRIVER_ADD_DEVICE AddDevice
Definition: iotypes.h:2111
VOID NTAPI PoStartNextPowerIrp(IN PIRP Irp)
Definition: power.c:626
NTSTATUS NTAPI IoCallDriver(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: irp.c:1218
#define IoSkipCurrentIrpStackLocation(Irp)
Definition: ntifs_ex.h:421
VOID NTAPI USBSTOR_Unload(PDRIVER_OBJECT DriverObject)
Definition: usbstor.c:65
#define DPRINT1
Definition: precomp.h:8
#define IRP_MJ_READ
Definition: rdpdr.c:46
PDRIVER_DISPATCH MajorFunction[IRP_MJ_MAXIMUM_FUNCTION+1]
Definition: iotypes.h:2180
#define IO_NO_INCREMENT
Definition: iotypes.h:565
NTSTATUS NTAPI IoCreateDevice(IN PDRIVER_OBJECT DriverObject, IN ULONG DeviceExtensionSize, IN PUNICODE_STRING DeviceName, IN DEVICE_TYPE DeviceType, IN ULONG DeviceCharacteristics, IN BOOLEAN Exclusive, OUT PDEVICE_OBJECT *DeviceObject)
Definition: device.c:1031
#define RtlZeroMemory(Destination, Length)
Definition: typedefs.h:261
PDRIVER_STARTIO DriverStartIo
Definition: iotypes.h:2178
#define IRP_MJ_WRITE
Definition: rdpdr.c:47
#define FILE_DEVICE_SECURE_OPEN
Definition: cdrw_usr.h:46
NTSTATUS NTAPI USBSTOR_AddDevice(IN PDRIVER_OBJECT DriverObject, IN PDEVICE_OBJECT PhysicalDeviceObject)
Definition: usbstor.c:18
return STATUS_SUCCESS
Definition: btrfs.c:2777
#define FILE_DEVICE_BUS_EXTENDER
Definition: winioctl.h:147
NTSTATUS USBSTOR_HandleDeviceControl(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp)
Definition: disk.c:418
NTSTATUS NTAPI USBSTOR_DispatchPnp(PDEVICE_OBJECT DeviceObject, PIRP Irp)
Definition: usbstor.c:123
#define IRP_MJ_DEVICE_CONTROL
Definition: rdpdr.c:52