reactos/drivers/usb/usbaudio/usbaudio.h

   1 #pragma once
   2
   3 #include <ntddk.h>
   4 #include <portcls.h>
   5 #include <ksmedia.h>
   6 #include <hubbusif.h>
   7 #include <usbbusif.h>
   8 #include <usbioctl.h>
   9 #include <usb.h>
  10 #include <usbdlib.h>
  11 #include <debug.h>
  12
  13 #define USBAUDIO_TAG 'AbsU'
  14 #define USB_AUDIO_CONTROL_TERMINAL_DESCRIPTOR_TYPE (0x24)
  15
  16 /* Universal Serial Bus Device Class Definition for Terminal Types Section 2.2 */
  17 #define USB_AUDIO_STREAMING_TERMINAL_TYPE (0x0101)
  18
  19 #define USB_AUDIO_MICROPHONE_TERMINAL_TYPE (0x0201)
  20 #define USB_AUDIO_DESKTOP_MICROPHONE_TERMINAL_TYPE (0x0202)
  21 #define USB_AUDIO_PERSONAL_MICROPHONE_TERMINAL_TYPE (0x0203)
  22 #define USB_AUDIO_OMMNI_MICROPHONE_TERMINAL_TYPE (0x0204)
  23 #define USB_AUDIO_ARRAY_MICROPHONE_TERMINAL_TYPE (0x0205)
  24 #define USB_AUDIO_ARRAY_PROCESSING_MICROPHONE_TERMINAL_TYPE (0x0206)
  25
  26 #define USB_AUDIO_SPEAKER_TERMINAL_TYPE (0x0301)
  27 #define USB_HEADPHONES_SPEAKER_TERMINAL_TYPE (0x0302)
  28 #define USB_AUDIO_HMDA_TERMINAL_TYPE (0x0303)
  29 #define USB_AUDIO_DESKTOP_SPEAKER_TERMINAL_TYPE (0x0304)
  30 #define USB_AUDIO_ROOM_SPEAKER_TERMINAL_TYPE (0x0305)
  31 #define USB_AUDIO_COMMUNICATION_SPEAKER_TERMINAL_TYPE (0x0306)
  32 #define USB_AUDIO_SUBWOOFER_TERMINAL_TYPE (0x0307)
  33 #define USB_AUDIO_UNDEFINED_TERMINAL_TYPE (0xFFFF)
  34
  35 #define USB_AUDIO_INPUT_TERMINAL (0x02)
  36 #define USB_AUDIO_OUTPUT_TERMINAL (0x03)
  37
  38 #include <pshpack1.h>
  39
  40 typedef struct
  41 {
  42     UCHAR bLength;
  43     UCHAR bDescriptorType;
  44     UCHAR bDescriptorSubtype;
  45     USHORT bcdADC;
  46     USHORT wTotalLength;
  47     UCHAR bInCollection;
  48     UCHAR baInterfaceNr;
  49 }USB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR, *PUSB_AUDIO_CONTROL_INTERFACE_HEADER_DESCRIPTOR;
  50
  51 typedef struct
  52 {
  53     UCHAR bLength;
  54     UCHAR bDescriptorType;
  55     UCHAR bDescriptorSubtype;
  56     UCHAR bTerminalID;
  57     USHORT wTerminalType;
  58     UCHAR bAssocTerminal;
  59     UCHAR bSourceID;
  60     UCHAR iTerminal;
  61 }USB_AUDIO_CONTROL_OUTPUT_TERMINAL_DESCRIPTOR, *PUSB_AUDIO_CONTROL_OUTPUT_TERMINAL_DESCRIPTOR;
  62
  63
  64 typedef struct
  65 {
  66     UCHAR bLength;
  67     UCHAR bDescriptorType;
  68     UCHAR bDescriptorSubtype;
  69     UCHAR bTerminalID;
  70     USHORT wTerminalType;
  71     UCHAR bAssocTerminal;
  72     UCHAR bNrChannels;
  73     USHORT wChannelConfig;
  74     UCHAR iChannelNames;
  75     UCHAR iTerminal;
  76 }USB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR, *PUSB_AUDIO_CONTROL_INPUT_TERMINAL_DESCRIPTOR;
  77
  78 typedef struct
  79 {
  80     UCHAR bLength;
  81     UCHAR bDescriptorType;
  82     UCHAR bDescriptorSubtype;
  83     UCHAR bUnitID;
  84     UCHAR bSourceID;
  85     UCHAR bControlSize;
  86     UCHAR bmaControls[1];
  87     UCHAR iFeature;
  88 }USB_AUDIO_CONTROL_FEATURE_UNIT_DESCRIPTOR, *PUSB_AUDIO_CONTROL_FEATURE_UNIT_DESCRIPTOR;
  89
  90 typedef struct
  91 {
  92     UCHAR bLength;
  93     UCHAR bDescriptorType;
  94     UCHAR bDescriptorSubtype;
  95     UCHAR bUnitID;
  96     UCHAR bNrInPins;
  97     UCHAR baSourceID[1];
  98     UCHAR bNrChannels;
  99     USHORT wChannelConfig;
 100     UCHAR iChannelNames;
 101     UCHAR bmControls;
 102     UCHAR iMixer;
 103 }USB_AUDIO_CONTROL_MIXER_UNIT_DESCRIPTOR, *PUSB_AUDIO_CONTROL_MIXER_UNIT_DESCRIPTOR;
 104
 105
 106 typedef struct
 107 {
 108     UCHAR bLength;
 109     UCHAR bDescriptorType;
 110     UCHAR bDescriptorSubtype;
 111     UCHAR bTerminalLink;
 112     UCHAR bDelay;
 113     USHORT wFormatTag;
 114 }USB_AUDIO_STREAMING_INTERFACE_DESCRIPTOR, *PUSB_AUDIO_STREAMING_INTERFACE_DESCRIPTOR;
 115
 116 typedef struct
 117 {
 118     UCHAR bLength;
 119     UCHAR bDescriptorType;
 120     UCHAR bDescriptorSubtype;
 121     UCHAR bFormatType;
 122     UCHAR bNrChannels;
 123     UCHAR bSubframeSize;
 124     UCHAR bBitResolution;
 125     UCHAR bSamFreqType;
 126     UCHAR tSamFreq[1];
 127 }USB_AUDIO_STREAMING_FORMAT_TYPE_DESCRIPTOR, *PUSB_AUDIO_STREAMING_FORMAT_TYPE_DESCRIPTOR;
 128
 129 #include <poppack.h>
 130
 131 typedef struct __DEVICE_EXTENSION__
 132 {
 133     PDEVICE_OBJECT LowerDevice;                                  /* lower device*/
 134     PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor;       /* usb configuration descriptor */
 135     PUSB_DEVICE_DESCRIPTOR DeviceDescriptor;                     /* usb device descriptor */
 136     PUSBD_INTERFACE_INFORMATION InterfaceInfo;                   /* interface information */
 137     USBD_CONFIGURATION_HANDLE ConfigurationHandle;               /* configuration handle */
 138
 139 }DEVICE_EXTENSION, *PDEVICE_EXTENSION;
 140
 141 typedef struct
 142 {
 143     PDEVICE_EXTENSION DeviceExtension;                           /* device extension */
 144     PDEVICE_OBJECT LowerDevice;                                  /* lower device*/
 145
 146 }FILTER_CONTEXT, *PFILTER_CONTEXT;
 147
 148 typedef struct
 149 {
 150     PDEVICE_EXTENSION DeviceExtension;                           /* device extension */
 151     PDEVICE_OBJECT LowerDevice;                                  /* lower device*/
 152     LIST_ENTRY IrpListHead;                                      /* irp list*/
 153     LIST_ENTRY DoneIrpListHead;                                  /* irp done list head */
 154     KSPIN_LOCK IrpListLock;                                      /* irp list lock*/
 155     PUCHAR Buffer;                                               /* iso buffer*/
 156     ULONG BufferSize;                                            /* iso buffer size */
 157     PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor;               /* interface descriptor */
 158         WORK_QUEUE_ITEM  CaptureWorkItem;                            /* work item */
 159         PKSWORKER        CaptureWorker;                              /* capture worker */
 160         WORK_QUEUE_ITEM  StarvationWorkItem;                            /* work item */
 161         PKSWORKER        StarvationWorker;                              /* capture worker */
 162 }PIN_CONTEXT, *PPIN_CONTEXT;
 163
 164 /* filter.c */
 165
 166 NTSTATUS
 167 NTAPI
 168 USBAudioCreateFilterContext(
 169     PKSDEVICE Device);
 170
 171 /* pool.c */
 172 PVOID
 173 NTAPI
 174 AllocFunction(
 175     IN ULONG ItemSize);
 176
 177 VOID
 178 NTAPI
 179 FreeFunction(
 180     IN PVOID Item);
 181
 182 /* usbaudio.c */
 183
 184 NTSTATUS
 185 SubmitUrbSync(
 186     IN PDEVICE_OBJECT Device,
 187     IN PURB Urb);
 188
 189 NTSTATUS
 190 NTAPI
 191 USBAudioAddDevice(
 192   _In_ PKSDEVICE Device
 193 );
 194
 195 NTSTATUS
 196 NTAPI
 197 USBAudioPnPStart(
 198   _In_     PKSDEVICE         Device,
 199   _In_     PIRP              Irp,
 200   _In_opt_ PCM_RESOURCE_LIST TranslatedResourceList,
 201   _In_opt_ PCM_RESOURCE_LIST UntranslatedResourceList
 202 );
 203
 204 NTSTATUS
 205 NTAPI
 206 USBAudioPnPQueryStop(
 207   _In_ PKSDEVICE Device,
 208   _In_ PIRP      Irp
 209 );
 210
 211 VOID
 212 NTAPI
 213 USBAudioPnPCancelStop(
 214   _In_ PKSDEVICE Device,
 215   _In_ PIRP      Irp
 216 );
 217
 218 VOID
 219 NTAPI
 220 USBAudioPnPStop(
 221   _In_ PKSDEVICE Device,
 222   _In_ PIRP      Irp
 223 );
 224
 225 NTSTATUS
 226 NTAPI
 227 USBAudioPnPQueryRemove(
 228   _In_ PKSDEVICE Device,
 229   _In_ PIRP      Irp
 230 );
 231
 232 VOID
 233 NTAPI
 234 USBAudioPnPCancelRemove(
 235   _In_ PKSDEVICE Device,
 236   _In_ PIRP      Irp
 237 );
 238
 239 VOID
 240 NTAPI
 241 USBAudioPnPRemove(
 242   _In_ PKSDEVICE Device,
 243   _In_ PIRP      Irp
 244 );
 245
 246 NTSTATUS
 247 NTAPI
 248 USBAudioPnPQueryCapabilities(
 249   _In_    PKSDEVICE            Device,
 250   _In_    PIRP                 Irp,
 251   _Inout_ PDEVICE_CAPABILITIES Capabilities
 252 );
 253
 254 VOID
 255 NTAPI
 256 USBAudioPnPSurpriseRemoval(
 257   _In_ PKSDEVICE Device,
 258   _In_ PIRP      Irp
 259 );
 260
 261 NTSTATUS
 262 NTAPI
 263 USBAudioPnPQueryPower(
 264   _In_ PKSDEVICE          Device,
 265   _In_ PIRP               Irp,
 266   _In_ DEVICE_POWER_STATE DeviceTo,
 267   _In_ DEVICE_POWER_STATE DeviceFrom,
 268   _In_ SYSTEM_POWER_STATE SystemTo,
 269   _In_ SYSTEM_POWER_STATE SystemFrom,
 270   _In_ POWER_ACTION       Action
 271 );
 272
 273 VOID
 274 NTAPI
 275 USBAudioPnPSetPower(
 276   _In_ PKSDEVICE          Device,
 277   _In_ PIRP               Irp,
 278   _In_ DEVICE_POWER_STATE To,
 279   _In_ DEVICE_POWER_STATE From
 280 );
 281
 282 /* pin.c*/
 283
 284 NTSTATUS
 285 NTAPI
 286 UsbAudioPinDataIntersect(
 287     _In_  PVOID        Context,
 288     _In_  PIRP         Irp,
 289     _In_  PKSP_PIN     Pin,
 290     _In_  PKSDATARANGE DataRange,
 291     _In_  PKSDATARANGE MatchingDataRange,
 292     _In_  ULONG        DataBufferSize,
 293     _Out_ PVOID        Data,
 294     _Out_ PULONG       DataSize);
 295
 296 NTSTATUS
 297 NTAPI
 298 UsbAudioCaptureComplete(
 299         IN PDEVICE_OBJECT DeviceObject,
 300         IN PIRP Irp,
 301         IN PVOID Context);
 302
 303 NTSTATUS
 304 NTAPI
 305 USBAudioPinCreate(
 306     _In_ PKSPIN Pin,
 307     _In_ PIRP Irp);
 308
 309 NTSTATUS
 310 NTAPI
 311 USBAudioPinClose(
 312     _In_ PKSPIN Pin,
 313     _In_ PIRP Irp);
 314
 315 NTSTATUS
 316 NTAPI
 317 USBAudioPinProcess(
 318     _In_ PKSPIN Pin);
 319
 320 VOID
 321 NTAPI
 322 USBAudioPinReset(
 323     _In_ PKSPIN Pin);
 324
 325 NTSTATUS
 326 NTAPI
 327 USBAudioPinSetDataFormat(
 328     _In_ PKSPIN Pin,
 329     _In_opt_ PKSDATAFORMAT OldFormat,
 330     _In_opt_ PKSMULTIPLE_ITEM OldAttributeList,
 331     _In_ const KSDATARANGE* DataRange,
 332     _In_opt_ const KSATTRIBUTE_LIST* AttributeRange);
 333
 334 NTSTATUS
 335 NTAPI
 336 USBAudioPinSetDeviceState(
 337     _In_ PKSPIN Pin,
 338     _In_ KSSTATE ToState,
 339     _In_ KSSTATE FromState);
 340