reactos/include/ddk/usbdi.h

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