home *** CD-ROM | disk | FTP | other *** search
/ H4CK3R 14 / hacker14.iso / programacao / cwin / c.exe / $INSTDIR / include / ddk / usbdi.h < prev    next >
Encoding:
C/C++ Source or Header  |  2003-12-15  |  13.0 KB  |  413 lines
  1. /*
  2.  * usbdi.h
  3.  *
  4.  * USBD and USB device driver definitions
  5.  *
  6.  * This file is part of the w32api package.
  7.  *
  8.  * Contributors:
  9.  *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10.  *
  11.  * THIS SOFTWARE IS NOT COPYRIGHTED
  12.  *
  13.  * This source code is offered for use in the public domain. You may
  14.  * use, modify or distribute it freely.
  15.  *
  16.  * This code is distributed in the hope that it will be useful but
  17.  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18.  * DISCLAIMED. This includes but is not limited to warranties of
  19.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20.  *
  21.  */
  22.  
  23. #ifndef __USBDI_H
  24. #define __USBDI_H
  25.  
  26. #if __GNUC__ >=3
  27. #pragma GCC system_header
  28. #endif
  29.  
  30. #ifdef __USB_H
  31. #error usb.h cannot be included with usbdi.h
  32. #else
  33.  
  34. #ifdef __cplusplus
  35. extern "C" {
  36. #endif
  37.  
  38. #pragma pack(push,4)
  39.  
  40. #include "ntddk.h"
  41. #include "usbioctl.h"
  42.  
  43.  
  44. #define USBDI_VERSION                     0x300
  45.  
  46. #define USB_DEFAULT_DEVICE_ADDRESS        0
  47. #define USB_DEFAULT_ENDPOINT_ADDRESS      0
  48. #define USB_DEFAULT_MAX_PACKET            64
  49.  
  50. #define URB_FROM_IRP(Irp) ((IoGetCurrentIrpStackLocation(Irp))->Parameters.Others.Argument1)
  51.  
  52. #define URB_FUNCTION_SELECT_CONFIGURATION           0x0000
  53. #define URB_FUNCTION_SELECT_INTERFACE               0x0001
  54. #define URB_FUNCTION_ABORT_PIPE                     0x0002
  55. #define URB_FUNCTION_TAKE_FRAME_LENGTH_CONTROL      0x0003
  56. #define URB_FUNCTION_RELEASE_FRAME_LENGTH_CONTROL   0x0004
  57. #define URB_FUNCTION_GET_FRAME_LENGTH               0x0005
  58. #define URB_FUNCTION_SET_FRAME_LENGTH               0x0006
  59. #define URB_FUNCTION_GET_CURRENT_FRAME_NUMBER       0x0007
  60. #define URB_FUNCTION_CONTROL_TRANSFER               0x0008
  61. #define URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER     0x0009
  62. #define URB_FUNCTION_ISOCH_TRANSFER                 0x000A
  63. #define URB_FUNCTION_RESET_PIPE                     0x001E
  64. #define URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE     0x000B
  65. #define URB_FUNCTION_GET_DESCRIPTOR_FROM_ENDPOINT   0x0024
  66. #define URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE  0x0028
  67. #define URB_FUNCTION_SET_DESCRIPTOR_TO_DEVICE       0x000C
  68. #define URB_FUNCTION_SET_DESCRIPTOR_TO_ENDPOINT     0x0025
  69. #define URB_FUNCTION_SET_DESCRIPTOR_TO_INTERFACE    0x0029
  70. #define URB_FUNCTION_SET_FEATURE_TO_DEVICE          0x000D
  71. #define URB_FUNCTION_SET_FEATURE_TO_INTERFACE       0x000E
  72. #define URB_FUNCTION_SET_FEATURE_TO_ENDPOINT        0x000F
  73. #define URB_FUNCTION_SET_FEATURE_TO_OTHER           0x0023
  74. #define URB_FUNCTION_CLEAR_FEATURE_TO_DEVICE        0x0010
  75. #define URB_FUNCTION_CLEAR_FEATURE_TO_INTERFACE     0x0011
  76. #define URB_FUNCTION_CLEAR_FEATURE_TO_ENDPOINT      0x0012
  77. #define URB_FUNCTION_CLEAR_FEATURE_TO_OTHER         0x0022
  78. #define URB_FUNCTION_GET_STATUS_FROM_DEVICE         0x0013
  79. #define URB_FUNCTION_GET_STATUS_FROM_INTERFACE      0x0014
  80. #define URB_FUNCTION_GET_STATUS_FROM_ENDPOINT       0x0015
  81. #define URB_FUNCTION_GET_STATUS_FROM_OTHER          0x0021
  82. #define URB_FUNCTION_RESERVED0                      0x0016
  83. #define URB_FUNCTION_VENDOR_DEVICE                  0x0017
  84. #define URB_FUNCTION_VENDOR_INTERFACE               0x0018
  85. #define URB_FUNCTION_VENDOR_ENDPOINT                0x0019
  86. #define URB_FUNCTION_VENDOR_OTHER                   0x0020
  87. #define URB_FUNCTION_CLASS_DEVICE                   0x001A
  88. #define URB_FUNCTION_CLASS_INTERFACE                0x001B
  89. #define URB_FUNCTION_CLASS_ENDPOINT                 0x001C
  90. #define URB_FUNCTION_CLASS_OTHER                    0x001F
  91. #define URB_FUNCTION_RESERVED                       0x001D
  92. #define URB_FUNCTION_GET_CONFIGURATION              0x0026
  93. #define URB_FUNCTION_GET_INTERFACE                  0x0027
  94. #define URB_FUNCTION_LAST                           0x0029
  95.  
  96. typedef LONG USBD_STATUS;
  97. typedef PVOID USBD_PIPE_HANDLE;
  98. typedef PVOID USBD_CONFIGURATION_HANDLE;
  99. typedef PVOID USBD_INTERFACE_HANDLE;
  100.  
  101. #define USBD_ERROR(Status) ((USBD_STATUS)(Status) < 0)
  102. #define USBD_HALTED(Status) ((ULONG)(Status) >> 30 == 3)
  103. #define USBD_PENDING(Status) ((ULONG)(Status) >> 30 == 1)
  104. #define USBD_STATUS(Status) ((ULONG)(Status) & 0x0FFFFFFFL)
  105. #define USBD_SUCCESS(Status) ((USBD_STATUS)(Status) >= 0)
  106.  
  107. #define USBD_STATUS_SUCCESS               ((USBD_STATUS)0x00000000L)
  108. #define USBD_STATUS_PENDING               ((USBD_STATUS)0x40000000L)
  109. #define USBD_STATUS_HALTED                ((USBD_STATUS)0xC0000000L)
  110. #define USBD_STATUS_ERROR                 ((USBD_STATUS)0x80000000L)
  111. #define USBD_STATUS_NO_MEMORY             ((USBD_STATUS)0x80000100L)
  112. #define USBD_STATUS_INVALID_URB_FUNCTION  ((USBD_STATUS)0x80000200L)
  113. #define USBD_STATUS_INVALID_PARAMETER     ((USBD_STATUS)0x80000300L)
  114. #define USBD_STATUS_ERROR_BUSY            ((USBD_STATUS)0x80000400L)
  115. #define USBD_STATUS_REQUEST_FAILED        ((USBD_STATUS)0x80000500L)
  116. #define USBD_STATUS_INVALID_PIPE_HANDLE   ((USBD_STATUS)0x80000600L)
  117. #define USBD_STATUS_NO_BANDWIDTH          ((USBD_STATUS)0x80000700L)
  118. #define USBD_STATUS_INTERNAL_HC_ERROR     ((USBD_STATUS)0x80000800L)
  119. #define USBD_STATUS_ERROR_SHORT_TRANSFER  ((USBD_STATUS)0x80000900L)
  120. #define USBD_STATUS_CRC                   ((USBD_STATUS)0xC0000001L)
  121. #define USBD_STATUS_BTSTUFF               ((USBD_STATUS)0xC0000002L)
  122. #define USBD_STATUS_DATA_TOGGLE_MISMATCH  ((USBD_STATUS)0xC0000003L)
  123. #define USBD_STATUS_STALL_PID             ((USBD_STATUS)0xC0000004L)
  124. #define USBD_STATUS_DEV_NOT_RESPONDING    ((USBD_STATUS)0xC0000005L)
  125. #define USBD_STATUS_PID_CHECK_FAILURE     ((USBD_STATUS)0xC0000006L)
  126. #define USBD_STATUS_UNEXPECTED_PID        ((USBD_STATUS)0xC0000007L)
  127. #define USBD_STATUS_DATA_OVERRUN          ((USBD_STATUS)0xC0000008L)
  128. #define USBD_STATUS_DATA_UNDERRUN         ((USBD_STATUS)0xC0000009L)
  129. #define USBD_STATUS_RESERVED1             ((USBD_STATUS)0xC000000AL)
  130. #define USBD_STATUS_RESERVED2             ((USBD_STATUS)0xC000000BL)
  131. #define USBD_STATUS_BUFFER_OVERRUN        ((USBD_STATUS)0xC000000CL)
  132. #define USBD_STATUS_BUFFER_UNDERRUN       ((USBD_STATUS)0xC000000DL)
  133. #define USBD_STATUS_NOT_ACCESSED          ((USBD_STATUS)0xC000000FL)
  134. #define USBD_STATUS_FIFO                  ((USBD_STATUS)0xC0000010L)
  135. #define USBD_STATUS_ENDPOINT_HALTED       ((USBD_STATUS)0xC0000030L)
  136. #define USBD_STATUS_BAD_START_FRAME       ((USBD_STATUS)0xC0000A00L)
  137. #define USBD_STATUS_ISOCH_REQUEST_FAILED  ((USBD_STATUS)0xC0000B00L)
  138. #define USBD_STATUS_FRAME_CONTROL_OWNED   ((USBD_STATUS)0xC0000C00L)
  139. #define USBD_STATUS_FRAME_CONTROL_NOT_OWNED \
  140.                                           ((USBD_STATUS)0xC0000D00L)
  141. #define USBD_STATUS_INAVLID_CONFIGURATION_DESCRIPTOR \
  142.                                           ((USBD_STATUS)0xC0000F00L)
  143. #define USBD_STATUS_CANCELING             ((USBD_STATUS)0x00020000L)
  144.  
  145. #define USBD_PIPE_DIRECTION_IN(pipeInformation) \
  146.   ((pipeInformation)->EndpointAddress & USB_ENDPOINT_DIRECTION_MASK) 
  147.  
  148. struct _URB_HEADER { 
  149.     USHORT  Length;
  150.     USHORT  Function;
  151.     USBD_STATUS  Status;
  152.     PVOID  UsbdDeviceHandle;
  153.     ULONG  UsbdFlags;
  154. };
  155.  
  156. struct _URB_HCD_AREA {
  157.     PVOID  HcdEndpoint;
  158.     PIRP  HcdIrp;
  159.     LIST_ENTRY  HcdListEntry;
  160.     LIST_ENTRY  HcdListEntry2;
  161.     PVOID  HcdCurrentIoFlushPointer;
  162.     PVOID  HcdExtension;
  163. };
  164.  
  165. struct _URB_BULK_OR_INTERRUPT_TRANSFER {
  166.     struct _URB_HEADER  Hdr;
  167.     USBD_PIPE_HANDLE  PipeHandle;
  168.     ULONG  TransferFlags;
  169.     ULONG  TransferBufferLength;
  170.     PVOID  TransferBuffer;
  171.     PMDL  TransferBufferMDL;
  172.     struct _URB  *UrbLink;
  173.     struct _URB_HCD_AREA  hca;
  174. };
  175.  
  176. struct _URB_CONTROL_DESCRIPTOR_REQUEST {
  177.     struct _URB_HEADER  Hdr;
  178.     PVOID  Reserved;
  179.     ULONG  Reserved0;
  180.     ULONG  TransferBufferLength;
  181.     PVOID  TransferBuffer;
  182.     PMDL  TransferBufferMDL;
  183.     struct _URB  *UrbLink;
  184.     struct _URB_HCD_AREA  hca;
  185.     USHORT  Reserved1;
  186.     UCHAR  Index;
  187.     UCHAR  DescriptorType;
  188.     USHORT  LanguageId;
  189.     USHORT  Reserved2;
  190. };
  191.  
  192. struct _URB_CONTROL_FEATURE_REQUEST {
  193.     struct _URB_HEADER  Hdr;
  194.     PVOID  Reserved;
  195.     ULONG  Reserved2;
  196.     ULONG  Reserved3;
  197.     PVOID  Reserved4;
  198.     PMDL  Reserved5;
  199.     struct _URB  *UrbLink;
  200.     struct _URB_HCD_AREA  hca;
  201.     USHORT  Reserved0;
  202.     USHORT  FeatureSelector;
  203.     USHORT  Index;
  204.     USHORT  Reserved1;
  205. };
  206.  
  207. struct _URB_CONTROL_GET_CONFIGURATION_REQUEST {
  208.     struct _URB_HEADER  Hdr;
  209.     PVOID  Reserved;
  210.     ULONG  Reserved0;
  211.     ULONG  TransferBufferLength;
  212.     PVOID  TransferBuffer;
  213.     PMDL  TransferBufferMDL;
  214.     struct _URB  *UrbLink;
  215.     struct _URB_HCD_AREA  hca;
  216.     UCHAR  Reserved1[8];    
  217. };
  218.  
  219. struct _URB_CONTROL_GET_INTERFACE_REQUEST {
  220.     struct _URB_HEADER  Hdr;
  221.     PVOID  Reserved;
  222.     ULONG  Reserved0;
  223.     ULONG  TransferBufferLength;
  224.     PVOID  TransferBuffer;
  225.     PMDL  TransferBufferMDL;
  226.     struct _URB  *UrbLink;
  227.     struct _URB_HCD_AREA  hca;
  228.     UCHAR  Reserved1[4];
  229.     USHORT  Interface;
  230.     USHORT  Reserved2;
  231. };
  232.  
  233. struct _URB_CONTROL_GET_STATUS_REQUEST {
  234.     struct _URB_HEADER  Hdr;
  235.     PVOID  Reserved;
  236.     ULONG  Reserved0;
  237.     ULONG  TransferBufferLength;
  238.     PVOID  TransferBuffer;
  239.     PMDL  TransferBufferMDL;
  240.     struct _URB  *UrbLink;
  241.     struct _URB_HCD_AREA  hca;
  242.     UCHAR  Reserved1[4];
  243.     USHORT  Index;
  244.     USHORT  Reserved2;
  245. };
  246.  
  247. struct _URB_CONTROL_TRANSFER {
  248.     struct _URB_HEADER  Hdr;
  249.     USBD_PIPE_HANDLE  PipeHandle;
  250.     ULONG  TransferFlags;
  251.     ULONG  TransferBufferLength;
  252.     PVOID  TransferBuffer;
  253.     PMDL  TransferBufferMDL;
  254.     struct _URB  *UrbLink;
  255.     struct _URB_HCD_AREA  hca;
  256.     UCHAR  SetupPacket[8];
  257. };
  258.  
  259. struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST {
  260.     struct _URB_HEADER  Hdr;
  261.     PVOID  Reserved;
  262.     ULONG  TransferFlags;
  263.     ULONG  TransferBufferLength;
  264.     PVOID  TransferBuffer;
  265.     PMDL  TransferBufferMDL;
  266.     struct _URB  *UrbLink;
  267.     struct _URB_HCD_AREA  hca;
  268.     UCHAR  RequestTypeReservedBits;
  269.     UCHAR  Request;
  270.     USHORT  Value;
  271.     USHORT  Index;
  272.     USHORT  Reserved1;
  273. };
  274.  
  275. struct _URB_FRAME_LENGTH_CONTROL {
  276.     struct _URB_HEADER  Hdr;
  277. };
  278.  
  279. struct _URB_GET_CURRENT_FRAME_NUMBER {
  280.     struct _URB_HEADER  Hdr;
  281.     ULONG  FrameNumber;
  282. };
  283.  
  284. struct _URB_GET_FRAME_LENGTH {
  285.     struct _URB_HEADER  Hdr;
  286.     ULONG  FrameLength;
  287.     ULONG  FrameNumber;
  288. };
  289.  
  290. typedef struct _USBD_ISO_PACKET_DESCRIPTOR {
  291.   ULONG  Offset;
  292.   ULONG  Length;
  293.   USBD_STATUS  Status;
  294. } USBD_ISO_PACKET_DESCRIPTOR, *PUSBD_ISO_PACKET_DESCRIPTOR;
  295.  
  296. struct _URB_ISOCH_TRANSFER {
  297.     struct _URB_HEADER  Hdr;
  298.     USBD_PIPE_HANDLE  PipeHandle;
  299.     ULONG  TransferFlags;
  300.     ULONG  TransferBufferLength;
  301.     PVOID  TransferBuffer;
  302.     PMDL  TransferBufferMDL;
  303.     struct _URB  *UrbLink;
  304.     struct _URB_HCD_AREA  hca;
  305.     ULONG  StartFrame;
  306.     ULONG  NumberOfPackets;
  307.     ULONG  ErrorCount;
  308.     USBD_ISO_PACKET_DESCRIPTOR  IsoPacket[1]; 
  309. };
  310.  
  311. struct _URB_PIPE_REQUEST {
  312.     struct _URB_HEADER  Hdr;
  313.     USBD_PIPE_HANDLE  PipeHandle;
  314.     ULONG  Reserved;
  315. };
  316.  
  317. struct _URB_SET_FRAME_LENGTH {
  318.     struct _URB_HEADER  Hdr;
  319.     LONG  FrameLengthDelta;
  320. };
  321.  
  322. typedef struct _USBD_DEVICE_INFORMATION {
  323.     ULONG  OffsetNext;
  324.     PVOID  UsbdDeviceHandle;
  325.     USB_DEVICE_DESCRIPTOR  DeviceDescriptor;
  326. } USBD_DEVICE_INFORMATION, *PUSBD_DEVICE_INFORMATION;
  327.  
  328. typedef enum _USBD_PIPE_TYPE {
  329.     UsbdPipeTypeControl,
  330.     UsbdPipeTypeIsochronous,
  331.     UsbdPipeTypeBulk,
  332.     UsbdPipeTypeInterrupt
  333. } USBD_PIPE_TYPE;
  334.  
  335. /* USBD_PIPE_INFORMATION.PipeFlags constants */
  336. #define USBD_PF_CHANGE_MAX_PACKET         0x00000001
  337. #define USBD_PF_DOUBLE_BUFFER             0x00000002 
  338. #define USBD_PF_ENABLE_RT_THREAD_ACCESS   0x00000004 
  339. #define USBD_PF_MAP_ADD_TRANSFERS         0x00000008
  340.  
  341. typedef struct _USBD_PIPE_INFORMATION {
  342.   USHORT  MaximumPacketSize;
  343.   UCHAR  EndpointAddress;
  344.   UCHAR  Interval;
  345.   USBD_PIPE_TYPE  PipeType;
  346.   USBD_PIPE_HANDLE  PipeHandle;
  347.   ULONG  MaximumTransferSize;
  348.   ULONG  PipeFlags;
  349. } USBD_PIPE_INFORMATION, *PUSBD_PIPE_INFORMATION;
  350.  
  351. typedef struct _USBD_INTERFACE_INFORMATION {
  352.   USHORT  Length;
  353.   UCHAR  InterfaceNumber;
  354.   UCHAR  AlternateSetting;
  355.   UCHAR  Class;
  356.   UCHAR  SubClass;
  357.   UCHAR  Protocol;
  358.   UCHAR  Reserved;
  359.   USBD_INTERFACE_HANDLE  InterfaceHandle;
  360.   ULONG  NumberOfPipes; 
  361.   USBD_PIPE_INFORMATION  Pipes[1];
  362. } USBD_INTERFACE_INFORMATION, *PUSBD_INTERFACE_INFORMATION;
  363.  
  364. struct _URB_SELECT_CONFIGURATION {
  365.     struct _URB_HEADER  Hdr;
  366.     PUSB_CONFIGURATION_DESCRIPTOR  ConfigurationDescriptor;
  367.     USBD_CONFIGURATION_HANDLE  ConfigurationHandle;
  368.     USBD_INTERFACE_INFORMATION  Interface;
  369. };
  370.  
  371. struct _URB_SELECT_INTERFACE {
  372.     struct _URB_HEADER  Hdr;
  373.     USBD_CONFIGURATION_HANDLE  ConfigurationHandle;
  374.     USBD_INTERFACE_INFORMATION  Interface;
  375. };
  376.  
  377. typedef struct _USBD_VERSION_INFORMATION {
  378.     ULONG  USBDI_Version;
  379.     ULONG  Supported_USB_Version;
  380. } USBD_VERSION_INFORMATION, *PUSBD_VERSION_INFORMATION;
  381.  
  382. typedef struct _URB {
  383.     union {
  384.         struct _URB_HEADER  UrbHeader;
  385.         struct _URB_SELECT_INTERFACE  UrbSelectInterface;
  386.         struct _URB_SELECT_CONFIGURATION  UrbSelectConfiguration;
  387.         struct _URB_PIPE_REQUEST  UrbPipeRequest;
  388.         struct _URB_FRAME_LENGTH_CONTROL  UrbFrameLengthControl;
  389.         struct _URB_GET_FRAME_LENGTH  UrbGetFrameLength;
  390.         struct _URB_SET_FRAME_LENGTH  UrbSetFrameLength;
  391.         struct _URB_GET_CURRENT_FRAME_NUMBER  UrbGetCurrentFrameNumber;
  392.         struct _URB_CONTROL_TRANSFER  UrbControlTransfer;
  393.         struct _URB_BULK_OR_INTERRUPT_TRANSFER  UrbBulkOrInterruptTransfer;
  394.         struct _URB_ISOCH_TRANSFER  UrbIsochronousTransfer;
  395.         struct _URB_CONTROL_DESCRIPTOR_REQUEST  UrbControlDescriptorRequest;
  396.         struct _URB_CONTROL_GET_STATUS_REQUEST  UrbControlGetStatusRequest;
  397.         struct _URB_CONTROL_FEATURE_REQUEST  UrbControlFeatureRequest;
  398.         struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST  UrbControlVendorClassRequest;
  399.         struct _URB_CONTROL_GET_INTERFACE_REQUEST  UrbControlGetInterfaceRequest;
  400.         struct _URB_CONTROL_GET_CONFIGURATION_REQUEST  UrbControlGetConfigurationRequest;
  401.     };
  402. } URB, *PURB;
  403.  
  404. #pragma pack(pop)
  405.  
  406. #ifdef __cplusplus
  407. }
  408. #endif
  409.  
  410. #endif /* defined __USB_H */
  411.  
  412. #endif /* __USBDI_H */
  413.