reactos/w32api/include/ddk/usbuser.h

   1 /*
   2  * usbuser.h
   3  *
   4  * USB user mode IOCTL interface
   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 __USBUSER_H
  24 #define __USBUSER_H
  25
  26 #if __GNUC__ >=3
  27 #pragma GCC system_header
  28 #endif
  29
  30 #include "usb.h"
  31 #include "usbiodef.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 #include <pshpack1.h>
  38
  39 #define USBUSER_VERSION                   0x0004
  40
  41 #define IOCTL_USB_USER_REQUEST            USB_CTL(HCD_USER_REQUEST)
  42
  43 #ifndef IOCTL_USB_DIAGNOSTIC_MODE_ON
  44 #define IOCTL_USB_DIAGNOSTIC_MODE_ON      USB_CTL(HCD_DIAGNOSTIC_MODE_ON)
  45 #endif
  46 #ifndef IOCTL_USB_DIAGNOSTIC_MODE_OFF
  47 #define IOCTL_USB_DIAGNOSTIC_MODE_OFF     USB_CTL(HCD_DIAGNOSTIC_MODE_OFF)
  48 #endif
  49
  50 #ifndef IOCTL_USB_GET_ROOT_HUB_NAME
  51 #define IOCTL_USB_GET_ROOT_HUB_NAME       USB_CTL(HCD_GET_ROOT_HUB_NAME)
  52 #endif
  53 #ifndef IOCTL_GET_HCD_DRIVERKEY_NAME
  54 #define IOCTL_GET_HCD_DRIVERKEY_NAME      USB_CTL(HCD_GET_DRIVERKEY_NAME)
  55 #endif
  56
  57 typedef enum _USB_USER_ERROR_CODE {
  58         UsbUserSuccess = 0,
  59         UsbUserNotSupported,
  60         UsbUserInvalidRequestCode,
  61         UsbUserFeatureDisabled,
  62         UsbUserInvalidHeaderParameter,
  63         UsbUserInvalidParameter,
  64         UsbUserMiniportError,
  65         UsbUserBufferTooSmall,
  66         UsbUserErrorNotMapped,
  67         UsbUserDeviceNotStarted,
  68         UsbUserNoDeviceConnected
  69 } USB_USER_ERROR_CODE;
  70
  71 #define USBUSER_GET_CONTROLLER_INFO_0     0x00000001
  72 #define USBUSER_GET_CONTROLLER_DRIVER_KEY 0x00000002
  73 #define USBUSER_PASS_THRU                 0x00000003
  74 #define USBUSER_GET_POWER_STATE_MAP       0x00000004
  75 #define USBUSER_GET_BANDWIDTH_INFORMATION 0x00000005
  76 #define USBUSER_GET_BUS_STATISTICS_0      0x00000006
  77 #define USBUSER_GET_ROOTHUB_SYMBOLIC_NAME 0x00000007
  78 #define USBUSER_GET_USB_DRIVER_VERSION    0x00000008
  79 #define USBUSER_GET_USB2_HW_VERSION       0x00000009
  80 #define USBUSER_OP_SEND_ONE_PACKET        0x10000001
  81 #define USBUSER_OP_RAW_RESET_PORT         0x20000001
  82 #define USBUSER_OP_OPEN_RAW_DEVICE        0x20000002
  83 #define USBUSER_OP_CLOSE_RAW_DEVICE       0x20000003
  84 #define USBUSER_OP_SEND_RAW_COMMAND       0x20000004
  85 #define USBUSER_INVALID_REQUEST           0xFFFFFFF0
  86 #define USBUSER_OP_MASK_DEVONLY_API       0x10000000
  87 #define USBUSER_OP_MASK_HCTEST_API        0x20000000
  88
  89 #define USB_PACKETFLAG_LOW_SPEED          0x00000001
  90 #define USB_PACKETFLAG_FULL_SPEED         0x00000002
  91 #define USB_PACKETFLAG_HIGH_SPEED         0x00000004
  92 #define USB_PACKETFLAG_ASYNC_IN           0x00000008
  93 #define USB_PACKETFLAG_ASYNC_OUT          0x00000010
  94 #define USB_PACKETFLAG_ISO_IN             0x00000020
  95 #define USB_PACKETFLAG_ISO_OUT            0x00000040
  96 #define USB_PACKETFLAG_SETUP              0x00000080
  97 #define USB_PACKETFLAG_TOGGLE0            0x00000100
  98 #define USB_PACKETFLAG_TOGGLE1            0x00000200
  99
 100 typedef struct _PACKET_PARAMETERS {
 101         UCHAR  DeviceAddress;
 102         UCHAR  EndpointAddress;
 103         USHORT  MaximumPacketSize;
 104         ULONG  Timeout;
 105         ULONG  Flags;
 106         ULONG  DataLength;
 107         USHORT  HubDeviceAddress;
 108         USHORT  PortTTNumber;
 109         UCHAR  ErrorCount;
 110         UCHAR  Pad[3];
 111         USBD_STATUS  UsbdStatusCode;
 112         UCHAR  Data[4];
 113 } PACKET_PARAMETERS, *PPACKET_PARAMETERS;
 114
 115 typedef struct _RAW_RESET_PORT_PARAMETERS {
 116         USHORT  PortNumber;
 117         USHORT  PortStatus;
 118 } RAW_RESET_PORT_PARAMETERS, *PRAW_RESET_PORT_PARAMETERS;
 119
 120 typedef struct _USB_BANDWIDTH_INFO {
 121         ULONG  DeviceCount;
 122         ULONG  TotalBusBandwidth;
 123         ULONG  Total32secBandwidth;
 124         ULONG  AllocedBulkAndControl;
 125         ULONG  AllocedIso;
 126         ULONG  AllocedInterrupt_1ms;
 127         ULONG  AllocedInterrupt_2ms;
 128         ULONG  AllocedInterrupt_4ms;
 129         ULONG  AllocedInterrupt_8ms;
 130         ULONG  AllocedInterrupt_16ms;
 131         ULONG  AllocedInterrupt_32ms;
 132 } USB_BANDWIDTH_INFO, *PUSB_BANDWIDTH_INFO;
 133
 134 typedef struct _USBUSER_REQUEST_HEADER {
 135         ULONG  UsbUserRequest;
 136         USB_USER_ERROR_CODE  UsbUserStatusCode;
 137         ULONG  RequestBufferLength;
 138         ULONG  ActualBufferLength;
 139 } USBUSER_REQUEST_HEADER, *PUSBUSER_REQUEST_HEADER;
 140
 141 typedef struct _USBUSER_BANDWIDTH_INFO_REQUEST {
 142         USBUSER_REQUEST_HEADER  Header;
 143         USB_BANDWIDTH_INFO  BandwidthInformation;
 144 } USBUSER_BANDWIDTH_INFO_REQUEST, *PUSBUSER_BANDWIDTH_INFO_REQUEST;
 145
 146 typedef struct _USB_BUS_STATISTICS_0 {
 147         ULONG  DeviceCount;
 148         LARGE_INTEGER  CurrentSystemTime;
 149         ULONG  CurrentUsbFrame;
 150         ULONG  BulkBytes;
 151         ULONG  IsoBytes;
 152         ULONG  InterruptBytes;
 153         ULONG  ControlDataBytes;
 154         ULONG  PciInterruptCount;
 155         ULONG  HardResetCount;
 156         ULONG  WorkerSignalCount;
 157         ULONG  CommonBufferBytes;
 158         ULONG  WorkerIdleTimeMs;
 159         BOOLEAN  RootHubEnabled;
 160         UCHAR  RootHubDevicePowerState;
 161         UCHAR  Unused;
 162         UCHAR  NameIndex;
 163 } USB_BUS_STATISTICS_0, *PUSB_BUS_STATISTICS_0;
 164
 165 typedef struct _USBUSER_BUS_STATISTICS_0_REQUEST {
 166         USBUSER_REQUEST_HEADER  Header;
 167         USB_BUS_STATISTICS_0  BusStatistics0;
 168 } USBUSER_BUS_STATISTICS_0_REQUEST, *PUSBUSER_BUS_STATISTICS_0_REQUEST;
 169
 170 /* USB_CONTROLLER_INFO_0.HcFeatureFlags constants */
 171 #define USB_HC_FEATURE_FLAG_PORT_POWER_SWITCHING  0x00000001
 172 #define USB_HC_FEATURE_FLAG_SEL_SUSPEND           0x00000002
 173 #define USB_HC_FEATURE_LEGACY_BIOS                0x00000004
 174
 175 typedef struct _USB_CLOSE_RAW_DEVICE_PARAMETERS {
 176   ULONG  xxx;
 177 } USB_CLOSE_RAW_DEVICE_PARAMETERS , *PUSB_CLOSE_RAW_DEVICE_PARAMETERS;
 178
 179 typedef struct _USBUSER_CLOSE_RAW_DEVICE {
 180         USBUSER_REQUEST_HEADER  Header;
 181         USB_CLOSE_RAW_DEVICE_PARAMETERS  Parameters;
 182 } USBUSER_CLOSE_RAW_DEVICE, *PUSBUSER_CLOSE_RAW_DEVICE;
 183
 184 typedef struct _USB_CONTROLLER_INFO_0 {
 185   ULONG  PciVendorId;
 186   ULONG  PciDeviceId;
 187   ULONG  PciRevision;
 188   ULONG  NumberOfRootPorts;
 189   USB_CONTROLLER_FLAVOR  ControllerFlavor;
 190   ULONG  HcFeatureFlags;
 191 } USB_CONTROLLER_INFO_0 , *PUSB_CONTROLLER_INFO_0;
 192
 193 typedef struct _USBUSER_CONTROLLER_INFO_0 {
 194   USBUSER_REQUEST_HEADER  Header;
 195   USB_CONTROLLER_INFO_0  Info0;
 196 } USBUSER_CONTROLLER_INFO_0, *PUSBUSER_CONTROLLER_INFO_0;
 197
 198 typedef struct _USB_DRIVER_VERSION_PARAMETERS {
 199         ULONG  DriverTrackingCode;
 200         ULONG  USBDI_Version;
 201         ULONG  USBUSER_Version;
 202         BOOLEAN  CheckedPortDriver;
 203         BOOLEAN  CheckedMiniportDriver;
 204         USHORT  USB_Version;
 205 } USB_DRIVER_VERSION_PARAMETERS , *PUSB_DRIVER_VERSION_PARAMETERS;
 206
 207 typedef struct _USBUSER_GET_DRIVER_VERSION {
 208         USBUSER_REQUEST_HEADER  Header;
 209         USB_DRIVER_VERSION_PARAMETERS  Parameters;
 210 } USBUSER_GET_DRIVER_VERSION, *PUSBUSER_GET_DRIVER_VERSION;
 211
 212 typedef struct _USB_OPEN_RAW_DEVICE_PARAMETERS {
 213         USHORT  PortStatus;
 214         USHORT  MaxPacketEp0;
 215 } USB_OPEN_RAW_DEVICE_PARAMETERS , *PUSB_OPEN_RAW_DEVICE_PARAMETERS;
 216
 217 typedef struct _USBUSER_OPEN_RAW_DEVICE {
 218         USBUSER_REQUEST_HEADER  Header;
 219         USB_OPEN_RAW_DEVICE_PARAMETERS  Parameters;
 220 } USBUSER_OPEN_RAW_DEVICE, *PUSBUSER_OPEN_RAW_DEVICE;
 221
 222 typedef enum _WDMUSB_POWER_STATE {
 223         WdmUsbPowerNotMapped = 0,
 224         WdmUsbPowerSystemUnspecified = 100,
 225         WdmUsbPowerSystemWorking,
 226         WdmUsbPowerSystemSleeping1,
 227         WdmUsbPowerSystemSleeping2,
 228         WdmUsbPowerSystemSleeping3,
 229         WdmUsbPowerSystemHibernate,
 230         WdmUsbPowerSystemShutdown,
 231         WdmUsbPowerDeviceUnspecified = 200,
 232         WdmUsbPowerDeviceD0,
 233         WdmUsbPowerDeviceD1,
 234         WdmUsbPowerDeviceD2,
 235         WdmUsbPowerDeviceD3
 236 } WDMUSB_POWER_STATE;
 237
 238 typedef struct _USB_POWER_INFO {
 239         WDMUSB_POWER_STATE  SystemState;
 240         WDMUSB_POWER_STATE  HcDevicePowerState;
 241         WDMUSB_POWER_STATE  HcDeviceWake;
 242         WDMUSB_POWER_STATE  HcSystemWake;
 243         WDMUSB_POWER_STATE  RhDevicePowerState;
 244         WDMUSB_POWER_STATE  RhDeviceWake;
 245         WDMUSB_POWER_STATE  RhSystemWake;
 246         WDMUSB_POWER_STATE  LastSystemSleepState;
 247         BOOLEAN  CanWakeup;
 248         BOOLEAN  IsPowered;
 249 } USB_POWER_INFO, *PUSB_POWER_INFO;
 250
 251 typedef struct _USBUSER_POWER_INFO_REQUEST {
 252         USBUSER_REQUEST_HEADER  Header;
 253         USB_POWER_INFO  PowerInformation;
 254 } USBUSER_POWER_INFO_REQUEST, *PUSBUSER_POWER_INFO_REQUEST;
 255
 256 typedef struct _USB_UNICODE_NAME {
 257         ULONG  Length;
 258         WCHAR  String[1];
 259 } USB_UNICODE_NAME, *PUSB_UNICODE_NAME;
 260
 261 typedef struct _USBUSER_CONTROLLER_UNICODE_NAME {
 262         USBUSER_REQUEST_HEADER  Header;
 263   USB_UNICODE_NAME  UnicodeName;
 264 } USBUSER_CONTROLLER_UNICODE_NAME, *PUSBUSER_CONTROLLER_UNICODE_NAME;
 265
 266 typedef struct _USB_PASS_THRU_PARAMETERS {
 267         GUID  FunctionGUID;
 268         ULONG  ParameterLength;
 269         UCHAR  Parameters[4];
 270 } USB_PASS_THRU_PARAMETERS, *PUSB_PASS_THRU_PARAMETERS;
 271
 272 typedef struct _USBUSER_PASS_THRU_REQUEST {
 273         USBUSER_REQUEST_HEADER  Header;
 274         USB_PASS_THRU_PARAMETERS  PassThru;
 275 } USBUSER_PASS_THRU_REQUEST, *PUSBUSER_PASS_THRU_REQUEST;
 276
 277 typedef struct _USBUSER_RAW_RESET_ROOT_PORT {
 278         USBUSER_REQUEST_HEADER  Header;
 279         RAW_RESET_PORT_PARAMETERS  Parameters;
 280 } USBUSER_RAW_RESET_ROOT_PORT, *PUSBUSER_RAW_RESET_ROOT_PORT;
 281
 282 typedef struct _USBUSER_SEND_ONE_PACKET {
 283         USBUSER_REQUEST_HEADER  Header;
 284         PACKET_PARAMETERS  PacketParameters;
 285 } USBUSER_SEND_ONE_PACKET, *PUSBUSER_SEND_ONE_PACKET;
 286
 287 typedef struct _USB_SEND_RAW_COMMAND_PARAMETERS {
 288         UCHAR  Usb_bmRequest;
 289         UCHAR  Usb_bRequest;
 290         USHORT  Usb_wVlaue;
 291         USHORT  Usb_wIndex;
 292         USHORT  Usb_wLength;
 293         USHORT  DeviceAddress;
 294         USHORT  MaximumPacketSize;
 295         ULONG  Timeout;
 296         ULONG  DataLength;
 297         USBD_STATUS  UsbdStatusCode;
 298         UCHAR  Data[4];
 299 } USB_SEND_RAW_COMMAND_PARAMETERS, *PUSB_SEND_RAW_COMMAND_PARAMETERS;
 300
 301 typedef struct _USBUSER_SEND_RAW_COMMAND {
 302         USBUSER_REQUEST_HEADER  Header;
 303         USB_SEND_RAW_COMMAND_PARAMETERS  Parameters;
 304 } USBUSER_SEND_RAW_COMMAND, *PUSBUSER_SEND_RAW_COMMAND;
 305
 306 /* USB_USB2HW_VERSION_PARAMETERS.Usb2HwRevision constants */
 307 #define USB2HW_UNKNOWN                    0x00
 308 #define USB2HW_A0                         0xA0
 309 #define USB2HW_A1                         0xA1
 310 #define USB2HW_B0                         0xB0
 311
 312 typedef struct _USB_USB2HW_VERSION_PARAMETERS {
 313   UCHAR  Usb2HwRevision;
 314 } USB_USB2HW_VERSION_PARAMETERS, *PUSB_USB2HW_VERSION_PARAMETERS;
 315
 316 typedef struct _USBUSER_GET_USB2HW_VERSION {
 317         USBUSER_REQUEST_HEADER  Header;
 318         USB_USB2HW_VERSION_PARAMETERS  Parameters;
 319 } USBUSER_GET_USB2HW_VERSION, *PUSBUSER_GET_USB2HW_VERSION;
 320
 321 #include <poppack.h>
 322
 323 #ifdef __cplusplus
 324 }
 325 #endif
 326
 327 #endif /* __USBUSER_H */