archive
/
windows-server-2003
mirror of https://github.com/selfrender/Windows-Server-2003
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Leaked source code of windows server 2003
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
1 Branch
0 Tags
1.5 GiB
Tree: 7b07a90fc1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '7b07a90fc1'
${ noResults }
windows-server-2003/drivers/wdm/usb/usbutil/usbutil.h

468 lines
24 KiB
Raw Normal View History

commiting as it is
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. /***************************************************************************
  3. Copyright (c) 2001 Microsoft Corporation
  5. Module Name:
  7. USBUTIL.H
  9. Abstract:
  11. Public interface for generic USB routines - must be called at PASSIVE_LEVEL
  13. Environment:
  15. Kernel Mode Only
  17. Notes:
  19. THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  20. KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  21. IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR
  22. PURPOSE.
  24. Copyright (c) 2001 Microsoft Corporation. All Rights Reserved.
  27. Revision History:
  29. 01/08/2001 : created
  31. Authors:
  33. Tom Green
  36. ****************************************************************************/
  39. #ifndef __USBUTIL_H__
  40. #define __USBUTIL_H__
  42. //#include "intread.h"
  44. #define USBWRAP_NOTIFICATION_READ_COMPLETE 0x01
  45. #define USBWRAP_NOTIFICATION_READ_ERROR 0x02
  46. #define USBWRAP_NOTIFICATION_READ_COMPLETE_DIRECT 0x04
  47. #define USBWRAP_NOTIFICATION_BUFFER_CLIENT_FREE 0x10
  48. #define PUMP_STOPPED 0x0
  49. #define PUMP_STARTED 0x01
  51. #ifndef PINGPONG_COUNT
  52. #define PINGPONG_COUNT 3
  53. #endif
  56. #define USBInitializeBulkTransfers USBInitializeInterruptTransfers
  57. #define USBStartBulkTransfers USBStartInterruptTransfers
  58. #define USBStopBulkTransfers USBStopInterruptTransfers
  59. #define USBReleaseBulkTransfers USBReleaseInterruptTransfers
  61. #if DBG
  64. #define DBG_USBUTIL_ERROR 0x0001
  65. #define DBG_USBUTIL_ENTRY_EXIT 0x0002
  66. #define DBG_USBUTIL_FATAL_ERROR 0x0004
  67. #define DBG_USBUTIL_USB_ERROR 0x0008
  68. #define DBG_USBUTIL_DEVICE_ERROR 0x0010
  69. #define DBG_USBUTIL_PNP_ERROR 0x0020
  70. #define DBG_USBUTIL_POWER_ERROR 0x0040
  71. #define DBG_USBUTIL_OTHER_ERROR 0x0080
  72. #define DBG_USBUTIL_TRACE 0x0100
  74. extern ULONG USBUtil_DebugTraceLevel;
  76. typedef
  77. ULONG
  78. (__cdecl *PUSB_WRAP_PRINT)(
  79. PCH Format,
  80. ...
  81. );
  83. extern PUSB_WRAP_PRINT USBUtil_DbgPrint;
  84. #endif // DBG
  86. typedef enum _REQUEST_RECIPIENT
  87. {
  89. Device,
  90. Interface,
  91. Endpoint,
  92. Other
  94. } REQUEST_RECIPIENT;
  97. // prototype for callback into client driver for completion of interrupt requests
  98. typedef NTSTATUS (*INTERRUPT_CALLBACK)(IN PVOID Context,
  99. IN PVOID Buffer,
  100. ULONG BufferLength,
  101. ULONG NotificationType,
  102. OUT PBOOLEAN QueueData);
  104. //typedef struct _USB_WRAPPER_PINGPONG *PUSB_WRAPPER_PINGPONG;
  105. //typedef struct _INTERRUPT_READ_WRAPPER INTERRUPT_READ_WRAPPER;
  107. typedef PVOID USB_WRAPPER_HANDLE;
  109. // prototypes
  112. #define USBCallSync(LowerDevObj,Urb,MillisecondsTimeout,RemoveLock) \
  113. USBCallSyncEx(LowerDevObj,Urb,MillisecondsTimeout,RemoveLock, sizeof(IO_REMOVE_LOCK))
  116. /************************************************************************/
  117. /* USBCallSync */
  118. /************************************************************************/
  119. /* */
  120. /* Routine Description: */
  121. /* */
  122. /* Send URB down USB stack. Synchronous call. */
  123. /* Caller is responsible for URB (allocating and freeing) */
  124. /* */
  125. /* Arguments: */
  126. /* */
  127. /* LowerDevObj - pointer to a device object */
  128. /* Urb - pointer to URB */
  129. /* MillisecondsTimeout - milliseconds to wait for completion */
  130. /* RemoveLock - pointer to remove lock */
  131. /* */
  132. /* Return Value: */
  133. /* */
  134. /* NTSTATUS */
  135. /* */
  136. /************************************************************************/
  137. NTSTATUS
  138. USBCallSyncEx(IN PDEVICE_OBJECT LowerDevObj,
  139. IN PURB Urb,
  140. IN LONG MillisecondsTimeout,
  141. IN PIO_REMOVE_LOCK RemoveLock,
  142. IN ULONG RemLockSize);
  145. #define USBVendorRequest(LowerDevObj, \
  146. Recipient, \
  147. Request, \
  148. Value, \
  149. Index, \
  150. Buffer, \
  151. BufferSize, \
  152. Read, \
  153. MillisecondsTimeout, \
  154. RemoveLock) \
  155. USBVendorRequestEx(LowerDevObj, \
  156. Recipient, \
  157. Request, \
  158. Value, \
  159. Index, \
  160. Buffer, \
  161. BufferSize, \
  162. Read, \
  163. MillisecondsTimeout, \
  164. RemoveLock, \
  165. sizeof(IO_REMOVE_LOCK))
  167. /************************************************************************/
  168. /* USBVendorRequest */
  169. /************************************************************************/
  170. /* */
  171. /* Routine Description: */
  172. /* */
  173. /* Issue USB vendor specific request */
  174. /* */
  175. /* Arguments: */
  176. /* */
  177. /* LowerDevObj - pointer to a device object */
  178. /* Request - request field of vendor specific command */
  179. /* Value - value field of vendor specific command */
  180. /* Index - index field of vendor specific command */
  181. /* Buffer - pointer to data buffer */
  182. /* BufferSize - data buffer length */
  183. /* Read - data direction flag */
  184. /* Timeout - number of milliseconds to wait for completion */
  185. /* RemoveLock - pointer to remove lock */
  186. /* */
  187. /* Return Value: */
  188. /* */
  189. /* NTSTATUS */
  190. /* */
  191. /************************************************************************/
  192. NTSTATUS
  193. USBVendorRequestEx(IN PDEVICE_OBJECT LowerDevObj,
  194. IN REQUEST_RECIPIENT Recipient,
  195. IN UCHAR Request,
  196. IN USHORT Value,
  197. IN USHORT Index,
  198. IN OUT PVOID Buffer,
  199. IN OUT PULONG BufferSize,
  200. IN BOOLEAN Read,
  201. IN LONG MillisecondsTimeout,
  202. IN PIO_REMOVE_LOCK RemoveLock,
  203. IN ULONG RemLockSize);
  207. /************************************************************************/
  208. /* USBClassRequest */
  209. /************************************************************************/
  210. /* */
  211. /* Routine Description: */
  212. /* */
  213. /* Issue USB Class specific request */
  214. /* */
  215. /* Arguments: */
  216. /* */
  217. /* LowerDevObj - pointer to a device object */
  218. /* Request - request field of class specific command */
  219. /* Value - value field of class specific command */
  220. /* Index - index field of class specific command */
  221. /* Buffer - pointer to data buffer */
  222. /* BufferSize - data buffer length */
  223. /* Read - data direction flag */
  224. /* RemoveLock - pointer to remove lock */
  225. /* Timeout - number of milliseconds to wait for completion */
  226. /* */
  227. /* Return Value: */
  228. /* */
  229. /* NTSTATUS */
  230. /* */
  231. /************************************************************************/
  232. #define USBClassRequest(LowerDevObj, \
  233. Recipient, \
  234. Request, \
  235. Value, \
  236. Index, \
  237. Buffer, \
  238. BufferSize, \
  239. Read, \
  240. MillisecondsTimeout, \
  241. RemoveLock) \
  242. USBClassRequestEx(LowerDevObj, \
  243. Recipient, \
  244. Request, \
  245. Value, \
  246. Index, \
  247. Buffer, \
  248. BufferSize, \
  249. Read, \
  250. MillisecondsTimeout, \
  251. RemoveLock, \
  252. sizeof(IO_REMOVE_LOCK))
  255. NTSTATUS
  256. USBClassRequestEx(IN PDEVICE_OBJECT LowerDevObj,
  257. IN REQUEST_RECIPIENT Recipient,
  258. IN UCHAR Request,
  259. IN USHORT Value,
  260. IN USHORT Index,
  261. IN OUT PVOID Buffer,
  262. IN OUT PULONG BufferSize,
  263. IN BOOLEAN Read,
  264. IN LONG MillisecondsTimeout,
  265. IN PIO_REMOVE_LOCK RemoveLock,
  266. IN ULONG RemLockSize);
  268. /************************************************************************/
  269. /* USBInitializeInterruptTransfers */
  270. /************************************************************************/
  271. /* */
  272. /* Routine Description: */
  273. /* */
  274. /* Initialize interrupt read pipe */
  275. /* */
  276. /* Arguments: */
  277. /* */
  278. /* DeviceObject - pointer to the device object */
  279. /* LowerDevObj - pointer to the lower device object */
  280. /* Buffer - pointer to buffer for data from interrupt pipe */
  281. /* BuffSize - size of buffer passed in */
  282. /* InterruptPipe - pipe descriptor */
  283. /* DriverContext - context passed to driver callback routine */
  284. /* DriverCallback - driver routines called on completion */
  285. /* RemoveLock - pointer to remove lock for device */
  286. /* */
  287. /* Return Value: */
  288. /* */
  289. /* USB_WRAPPER_HANDLE */
  290. /* */
  291. /************************************************************************/
  292. #define USBInitializeInterruptTransfers(DeviceObject, \
  293. LowerDevObj, \
  294. MaxTransferSize, \
  295. InterruptPipe, \
  296. DriverContext, \
  297. DriverCallback, \
  298. NotificationTypes, \
  299. RemoveLock) \
  300. USBInitializeInterruptTransfersEx(DeviceObject, \
  301. LowerDevObj, \
  302. MaxTransferSize, \
  303. InterruptPipe, \
  304. DriverContext, \
  305. DriverCallback, \
  306. NotificationTypes, \
  307. PINGPONG_COUNT, \
  308. RemoveLock, \
  309. sizeof(IO_REMOVE_LOCK))
  311. USB_WRAPPER_HANDLE
  312. USBInitializeInterruptTransfersEx(IN PDEVICE_OBJECT DeviceObject,
  313. IN PDEVICE_OBJECT LowerDevObj,
  314. IN ULONG MaxTransferSize,
  315. IN PUSBD_PIPE_INFORMATION InterruptPipe,
  316. IN PVOID DriverContext,
  317. IN INTERRUPT_CALLBACK DriverCallback,
  318. IN ULONG NotificationTypes,
  319. IN ULONG PingPongCount,
  320. IN PIO_REMOVE_LOCK RemoveLock,
  321. IN ULONG RemLockSize);
  323. /************************************************************************/
  324. /* USBStartInterruptTransfers */
  325. /************************************************************************/
  326. /* */
  327. /* Routine Description: */
  328. /* */
  329. /* Start transfers on interrupt pipe */
  330. /* */
  331. /* Arguments: */
  332. /* */
  333. /* WrapperHandle - pointer to wrapper handle from Init call */
  334. /* */
  335. /* Return Value: */
  336. /* */
  337. /* NTSTATUS */
  338. /* */
  339. /************************************************************************/
  340. NTSTATUS
  341. USBStartInterruptTransfers(IN USB_WRAPPER_HANDLE WrapperHandle);
  344. /************************************************************************/
  345. /* USBStopInterruptTransfers */
  346. /************************************************************************/
  347. /* */
  348. /* Routine Description: */
  349. /* */
  350. /* Stop transfers on interrupt pipe and free resources */
  351. /* */
  352. /* Arguments: */
  353. /* */
  354. /* WrapperHandle - pointer to wrapper handle from Start call */
  355. /* */
  356. /* Return Value: */
  357. /* */
  358. /* NTSTATUS */
  359. /* */
  360. /************************************************************************/
  361. NTSTATUS
  362. USBStopInterruptTransfers(IN USB_WRAPPER_HANDLE WrapperHandle);
  364. /************************************************************************/
  365. /* USBStopInterruptTransfers */
  366. /************************************************************************/
  367. /* */
  368. /* Routine Description: */
  369. /* */
  370. /* Frees all resources allocated in */
  371. /* USBInitializeInterruptTransfers */
  372. /* */
  373. /* Arguments: */
  374. /* */
  375. /* WrapperHandle - pointer to wrapper handle from Init call */
  376. /* */
  377. /* Return Value: */
  378. /* */
  379. /* NTSTATUS */
  380. /* */
  381. /************************************************************************/
  382. NTSTATUS
  383. USBReleaseInterruptTransfers(IN USB_WRAPPER_HANDLE WrapperHandle);
  386. /************************************************************************/
  387. /* USBStartSelectiveSuspend */
  388. /************************************************************************/
  389. /* */
  390. /* Routine Description: */
  391. /* */
  392. /* Start selective suspend support for device */
  393. /* */
  394. /* Arguments: */
  395. /* */
  396. /* LowerDevObj - pointer to device object */
  397. /* */
  398. /* Return Value: */
  399. /* */
  400. /* USB_WRAPPER_HANDLE */
  401. /* */
  402. /************************************************************************/
  403. USB_WRAPPER_HANDLE
  404. USBStartSelectiveSuspend(IN PDEVICE_OBJECT LowerDevObj);
  406. /************************************************************************/
  407. /* USBStopSelectiveSuspend */
  408. /************************************************************************/
  409. /* */
  410. /* Routine Description: */
  411. /* */
  412. /* Stop selective suspend support for device */
  413. /* */
  414. /* Arguments: */
  415. /* */
  416. /* WrapperHandle - wrapper handle returned by start routine */
  417. /* */
  418. /* Return Value: */
  419. /* */
  420. /* NTSTATUS */
  421. /* */
  422. /************************************************************************/
  423. NTSTATUS
  424. USBStopSelectiveSuspend(IN USB_WRAPPER_HANDLE WrapperHandle);
  426. /************************************************************************/
  427. /* USBRequestIdle */
  428. /************************************************************************/
  429. /* */
  430. /* Routine Description: */
  431. /* */
  432. /* Idle request for device */
  433. /* */
  434. /* Arguments: */
  435. /* */
  436. /* WrapperHandle - wrapper handle returned by start routine */
  437. /* */
  438. /* Return Value: */
  439. /* */
  440. /* NTSTATUS */
  441. /* */
  442. /************************************************************************/
  443. NTSTATUS
  444. USBRequestIdle(IN USB_WRAPPER_HANDLE WrapperHandle);
  446. /************************************************************************/
  447. /* USBRequestWake */
  448. /************************************************************************/
  449. /* */
  450. /* Routine Description: */
  451. /* */
  452. /* Wake request for device */
  453. /* */
  454. /* Arguments: */
  455. /* */
  456. /* WrapperHandle - wrapper handle returned by start routine */
  457. /* */
  458. /* Return Value: */
  459. /* */
  460. /* NTSTATUS */
  461. /* */
  462. /************************************************************************/
  463. NTSTATUS
  464. USBRequestWake(IN USB_WRAPPER_HANDLE WrapperHandle);
  466. #endif // __USBUTIL_H__