reactos/include/ddk/usbdlib.h

   1 #pragma once
   2
   3 #ifndef DECLSPEC_EXPORT
   4 #define DECLSPEC_EXPORT __declspec(dllexport)
   5 #endif
   6
   7 typedef struct _USBD_INTERFACE_LIST_ENTRY {
   8   PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor;
   9   PUSBD_INTERFACE_INFORMATION Interface;
  10 } USBD_INTERFACE_LIST_ENTRY, *PUSBD_INTERFACE_LIST_ENTRY;
  11
  12 #define UsbBuildInterruptOrBulkTransferRequest(urb,length, pipeHandle, transferBuffer, transferBufferMDL, transferBufferLength, transferFlags, link) { \
  13   (urb)->UrbHeader.Function = URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER;                                                                                 \
  14   (urb)->UrbHeader.Length = (length);                                                                                                                  \
  15   (urb)->UrbBulkOrInterruptTransfer.PipeHandle = (pipeHandle);                                                                                         \
  16   (urb)->UrbBulkOrInterruptTransfer.TransferBufferLength = (transferBufferLength);                                                                     \
  17   (urb)->UrbBulkOrInterruptTransfer.TransferBufferMDL = (transferBufferMDL);                                                                           \
  18   (urb)->UrbBulkOrInterruptTransfer.TransferBuffer = (transferBuffer);                                                                                 \
  19   (urb)->UrbBulkOrInterruptTransfer.TransferFlags = (transferFlags);                                                                                   \
  20   (urb)->UrbBulkOrInterruptTransfer.UrbLink = (link);                                                                                                  \
  21 }
  22
  23 #define UsbBuildGetDescriptorRequest(urb, length, descriptorType, descriptorIndex, languageId, transferBuffer, transferBufferMDL, transferBufferLength, link) { \
  24   (urb)->UrbHeader.Function =  URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE;                                                                                         \
  25   (urb)->UrbHeader.Length = (length);                                                                                                                           \
  26   (urb)->UrbControlDescriptorRequest.TransferBufferLength = (transferBufferLength);                                                                             \
  27   (urb)->UrbControlDescriptorRequest.TransferBufferMDL = (transferBufferMDL);                                                                                   \
  28   (urb)->UrbControlDescriptorRequest.TransferBuffer = (transferBuffer);                                                                                         \
  29   (urb)->UrbControlDescriptorRequest.DescriptorType = (descriptorType);                                                                                         \
  30   (urb)->UrbControlDescriptorRequest.Index = (descriptorIndex);                                                                                                 \
  31   (urb)->UrbControlDescriptorRequest.LanguageId = (languageId);                                                                                                 \
  32   (urb)->UrbControlDescriptorRequest.UrbLink = (link);                                                                                                          \
  33 }
  34
  35 #define UsbBuildGetStatusRequest(urb, op, index, transferBuffer, transferBufferMDL, link) { \
  36   (urb)->UrbHeader.Function =  (op);                                                        \
  37   (urb)->UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_STATUS_REQUEST);                 \
  38   (urb)->UrbControlGetStatusRequest.TransferBufferLength = sizeof(USHORT);                  \
  39   (urb)->UrbControlGetStatusRequest.TransferBufferMDL = (transferBufferMDL);                \
  40   (urb)->UrbControlGetStatusRequest.TransferBuffer = (transferBuffer);                      \
  41   (urb)->UrbControlGetStatusRequest.Index = (index);                                        \
  42   (urb)->UrbControlGetStatusRequest.UrbLink = (link);                                       \
  43 }
  44
  45 #define UsbBuildFeatureRequest(urb, op, featureSelector, index, link) {  \
  46   (urb)->UrbHeader.Function =  (op);                                     \
  47   (urb)->UrbHeader.Length = sizeof(struct _URB_CONTROL_FEATURE_REQUEST); \
  48   (urb)->UrbControlFeatureRequest.FeatureSelector = (featureSelector);   \
  49   (urb)->UrbControlFeatureRequest.Index = (index);                       \
  50   (urb)->UrbControlFeatureRequest.UrbLink = (link);                      \
  51 }
  52
  53 #define UsbBuildSelectConfigurationRequest(urb, length, configurationDescriptor) {   \
  54   (urb)->UrbHeader.Function =  URB_FUNCTION_SELECT_CONFIGURATION;                    \
  55   (urb)->UrbHeader.Length = (length);                                                \
  56   (urb)->UrbSelectConfiguration.ConfigurationDescriptor = (configurationDescriptor); \
  57 }
  58
  59 #define UsbBuildSelectInterfaceRequest(urb, length, configurationHandle, interfaceNumber, alternateSetting) {             \
  60   (urb)->UrbHeader.Function =  URB_FUNCTION_SELECT_INTERFACE;                                                             \
  61   (urb)->UrbHeader.Length = (length);                                                                                     \
  62   (urb)->UrbSelectInterface.Interface.AlternateSetting = (alternateSetting);                                              \
  63   (urb)->UrbSelectInterface.Interface.InterfaceNumber = (interfaceNumber);                                                \
  64   (urb)->UrbSelectInterface.Interface.Length = (length - sizeof(struct _URB_HEADER) - sizeof(USBD_CONFIGURATION_HANDLE)); \
  65   (urb)->UrbSelectInterface.ConfigurationHandle = (configurationHandle);                                                  \
  66 }
  67
  68 #define UsbBuildVendorRequest(urb, cmd, length, transferFlags, reservedbits, request, value, index, transferBuffer, transferBufferMDL, transferBufferLength, link) { \
  69   (urb)->UrbHeader.Function =  cmd;                                                                                                                                  \
  70   (urb)->UrbHeader.Length = (length);                                                                                                                                \
  71   (urb)->UrbControlVendorClassRequest.TransferBufferLength = (transferBufferLength);                                                                                 \
  72   (urb)->UrbControlVendorClassRequest.TransferBufferMDL = (transferBufferMDL);                                                                                       \
  73   (urb)->UrbControlVendorClassRequest.TransferBuffer = (transferBuffer);                                                                                             \
  74   (urb)->UrbControlVendorClassRequest.RequestTypeReservedBits = (reservedbits);                                                                                      \
  75   (urb)->UrbControlVendorClassRequest.Request = (request);                                                                                                           \
  76   (urb)->UrbControlVendorClassRequest.Value = (value);                                                                                                               \
  77   (urb)->UrbControlVendorClassRequest.Index = (index);                                                                                                               \
  78   (urb)->UrbControlVendorClassRequest.TransferFlags = (transferFlags);                                                                                               \
  79   (urb)->UrbControlVendorClassRequest.UrbLink = (link);                                                                                                              \
  80 }
  81
  82 #if (NTDDI_VERSION >= NTDDI_WINXP)
  83
  84 #define UsbBuildOsFeatureDescriptorRequest(urb, length, interface, index, transferBuffer, transferBufferMDL, transferBufferLength, link) { \
  85   (urb)->UrbHeader.Function = URB_FUNCTION_GET_MS_FEATURE_DESCRIPTOR;                                                                      \
  86   (urb)->UrbHeader.Length = (length);                                                                                                      \
  87   (urb)->UrbOSFeatureDescriptorRequest.TransferBufferLength = (transferBufferLength);                                                      \
  88   (urb)->UrbOSFeatureDescriptorRequest.TransferBufferMDL = (transferBufferMDL);                                                            \
  89   (urb)->UrbOSFeatureDescriptorRequest.TransferBuffer = (transferBuffer);                                                                  \
  90   (urb)->UrbOSFeatureDescriptorRequest.InterfaceNumber = (interface);                                                                      \
  91   (urb)->UrbOSFeatureDescriptorRequest.MS_FeatureDescriptorIndex = (index);                                                                \
  92   urb)->UrbOSFeatureDescriptorRequest.UrbLink = (link);                                                                                    \
  93 }
  94
  95 #endif /* NTDDI_VERSION >= NTDDI_WINXP */
  96
  97 #define URB_STATUS(urb)                      ((urb)->UrbHeader.Status)
  98
  99 #define GET_SELECT_CONFIGURATION_REQUEST_SIZE(totalInterfaces, totalPipes) \
 100   (sizeof(struct _URB_SELECT_CONFIGURATION) +                              \
 101   ((totalInterfaces-1) * sizeof(USBD_INTERFACE_INFORMATION)) +             \
 102   ((totalPipes-totalInterfaces)*sizeof(USBD_PIPE_INFORMATION)))
 103
 104 #define GET_SELECT_INTERFACE_REQUEST_SIZE(totalPipes) \
 105   (sizeof(struct _URB_SELECT_INTERFACE) +             \
 106   ((totalPipes-1)*sizeof(USBD_PIPE_INFORMATION)))
 107
 108 #define GET_USBD_INTERFACE_SIZE(numEndpoints)                                 \
 109   (sizeof(USBD_INTERFACE_INFORMATION) +                                       \
 110   (sizeof(USBD_PIPE_INFORMATION)*(numEndpoints)) - sizeof(USBD_PIPE_INFORMATION))
 111
 112 #define  GET_ISO_URB_SIZE(n) (sizeof(struct _URB_ISOCH_TRANSFER)+ \
 113   sizeof(USBD_ISO_PACKET_DESCRIPTOR)*n)
 114
 115 #ifndef _USBD_
 116
 117 _IRQL_requires_max_(DISPATCH_LEVEL)
 118 DECLSPEC_IMPORT
 119 VOID
 120 NTAPI
 121 USBD_GetUSBDIVersion(
 122   _Out_ PUSBD_VERSION_INFORMATION VersionInformation);
 123
 124 DECLSPEC_IMPORT
 125 PUSB_INTERFACE_DESCRIPTOR
 126 NTAPI
 127 USBD_ParseConfigurationDescriptor(
 128   _In_ PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor,
 129   _In_ UCHAR InterfaceNumber,
 130   _In_ UCHAR AlternateSetting);
 131
 132 DECLSPEC_IMPORT
 133 PURB
 134 NTAPI
 135 USBD_CreateConfigurationRequest(
 136   _In_ PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor,
 137   _Out_ PUSHORT Siz);
 138
 139 _IRQL_requires_max_(APC_LEVEL)
 140 DECLSPEC_IMPORT
 141 PUSB_COMMON_DESCRIPTOR
 142 NTAPI
 143 USBD_ParseDescriptors(
 144   _In_ PVOID DescriptorBuffer,
 145   _In_ ULONG TotalLength,
 146   _In_ PVOID StartPosition,
 147   _In_ LONG DescriptorType);
 148
 149 _IRQL_requires_max_(APC_LEVEL)
 150 DECLSPEC_IMPORT
 151 PUSB_INTERFACE_DESCRIPTOR
 152 NTAPI
 153 USBD_ParseConfigurationDescriptorEx(
 154   _In_ PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor,
 155   _In_ PVOID StartPosition,
 156   _In_ LONG InterfaceNumber,
 157   _In_ LONG AlternateSetting,
 158   _In_ LONG InterfaceClass,
 159   _In_ LONG InterfaceSubClass,
 160   _In_ LONG InterfaceProtocol);
 161
 162 _IRQL_requires_max_(DISPATCH_LEVEL)
 163 DECLSPEC_IMPORT
 164 PURB
 165 NTAPI
 166 USBD_CreateConfigurationRequestEx(
 167   _In_ PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor,
 168   _In_ PUSBD_INTERFACE_LIST_ENTRY InterfaceList);
 169
 170 _IRQL_requires_max_(PASSIVE_LEVEL)
 171 DECLSPEC_EXPORT
 172 ULONG
 173 NTAPI
 174 USBD_GetInterfaceLength(
 175   _In_ PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor,
 176   _In_ PUCHAR BufferEnd);
 177
 178 _IRQL_requires_max_(PASSIVE_LEVEL)
 179 DECLSPEC_EXPORT
 180 VOID
 181 NTAPI
 182 USBD_RegisterHcFilter(
 183   _In_ PDEVICE_OBJECT DeviceObject,
 184   _In_ PDEVICE_OBJECT FilterDeviceObject);
 185
 186 _IRQL_requires_max_(APC_LEVEL)
 187 DECLSPEC_EXPORT
 188 NTSTATUS
 189 NTAPI
 190 USBD_GetPdoRegistryParameter(
 191   _In_ PDEVICE_OBJECT PhysicalDeviceObject,
 192   _Inout_updates_bytes_(ParameterLength) PVOID Parameter,
 193   _In_ ULONG ParameterLength,
 194   _In_reads_bytes_(KeyNameLength) PWSTR KeyName,
 195   _In_ ULONG KeyNameLength);
 196
 197 DECLSPEC_EXPORT
 198 NTSTATUS
 199 NTAPI
 200 USBD_QueryBusTime(
 201   _In_ PDEVICE_OBJECT RootHubPdo,
 202   _Out_ PULONG CurrentFrame);
 203
 204 #if (NTDDI_VERSION >= NTDDI_WINXP)
 205
 206 _IRQL_requires_max_(DISPATCH_LEVEL)
 207 DECLSPEC_IMPORT
 208 ULONG
 209 NTAPI
 210 USBD_CalculateUsbBandwidth(
 211   _In_ ULONG MaxPacketSize,
 212   _In_ UCHAR EndpointType,
 213   _In_ BOOLEAN LowSpeed);
 214
 215 #endif
 216
 217 #if (NTDDI_VERSION >= NTDDI_VISTA)
 218
 219 _IRQL_requires_max_(DISPATCH_LEVEL)
 220 DECLSPEC_IMPORT
 221 USBD_STATUS
 222 NTAPI
 223 USBD_ValidateConfigurationDescriptor(
 224   _In_reads_bytes_(BufferLength) PUSB_CONFIGURATION_DESCRIPTOR ConfigDesc,
 225   _In_ ULONG BufferLength,
 226   _In_ USHORT Level,
 227   _Out_ PUCHAR *Offset,
 228   _In_opt_ ULONG Tag);
 229
 230 #endif
 231
 232 #endif /* ! _USBD_ */
 233