1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
|
//
// This class represents a the Bluetooth Hands-Free Profile USB Headset device.
// There is one class for each interface (id = symbolic-link-name).
//
#ifdef SYSVAD_USB_SIDEBAND
//=====================================================================
//
// USB Sideband Headset class definition.
//
class CAdapterCommon;
class UsbHsDevice;
struct UsbHsWorkItemContext
{
CAdapterCommon * Adapter;
};
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME
(
UsbHsWorkItemContext,
GetUsbHsWorkItemContext
)
// start/stop the device
enum eUsbHsTaskAction
{
eUsbHsTaskStart = 1,
eUsbHsTaskStop = 2,
};
struct UsbHsWorkTask
{
LIST_ENTRY ListEntry;
UsbHsDevice * Device;
eUsbHsTaskAction Action;
};
//=====================================================================
//
// Device: Bluetooth Hands-Free Profile USB Headset definitions.
//
// BTH HFP device's notification work-item context.
struct UsbHsDeviceNotificationWorkItemContext
{
UsbHsDevice * UsbHsDevice;
};
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME
(
UsbHsDeviceNotificationWorkItemContext,
GetUsbHsDeviceNotificationWorkItemContext
)
// USB HS device's notification request context.
union UsbHsDeviceNotificationBuffer
{
SIDEBANDAUDIO_VOLUME_PARAMS Volume;
SIDEBANDAUDIO_MUTE_PARAMS Mute;
SIDEBANDAUDIO_SIDETONE_PARAMS Sidetone;
SIDEBANDAUDIO_STREAM_STATUS_PARAMS streamStatus;
};
struct UsbHsDeviceNotificationReqContext
{
UsbHsDevice *UsbHsDevice;
LONG Errors;
UsbHsDeviceNotificationBuffer Buffer;
WDFMEMORY MemIn;
WDFMEMORY MemOut;
};
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME
(
UsbHsDeviceNotificationReqContext,
GetUsbHsDeviceNotificationReqContext
)
enum eUsbHsState
{
eUsbHsStateInvalid = 0,
eUsbHsStateInitializing = 1,
eUsbHsStateRunning = 2,
eUsbHsStateStopping = 3,
eUsbHsStateStopped = 4,
eUsbHsStateFailed = 5,
};
// To support event notification.
struct UsbHsEventCallback
{
PFNEVENTNOTIFICATION Handler;
PVOID Context;
};
typedef struct _USBHSDEVICE_EP_TRANSPORT_RESOURCES
{
PUSB_INTERFACE_DESCRIPTOR pUsbInterfaceDescriptor;
PUSBD_ENDPOINT_OFFLOAD_INFORMATION pUsbOffloadInformation;
PUSBD_ENDPOINT_OFFLOAD_INFORMATION pSyncUsbOffloadInformation;
PSIDEBANDAUDIO_EP_USBAUDIO_TRANSPORT_RESOURCES pUsbAudioTransportResources;
PSIDEBANDAUDIO_EP_USBAUDIO_TRANSPORT_RESOURCES pSyncUsbAudioTransportResources;
PUSB_ENDPOINT_DESCRIPTOR pUsbEndpointDescriptor;
PUSB_ENDPOINT_DESCRIPTOR pSyncUsbEndpointDescriptor;
}USBHSDEVICE_EP_TRANSPORT_RESOURCES, *PUSBHSDEVICE_EP_TRANSPORT_RESOURCES;
#endif // SYSVAD_USB_SIDEBAND
class UsbHsDevice :
ISidebandDeviceCommon,
public CUnknown
{
private:
eUsbHsState m_State;
IAdapterCommon * m_Adapter;
WDFIOTARGET m_WdfIoTarget;
LIST_ENTRY m_ListEntry;
UNICODE_STRING m_SymbolicLinkName;
WCHAR m_SpeakerWaveNameBuffer[USBHS_INTERFACE_REFSTRING_MAX_LENGTH];
UNICODE_STRING m_SpeakerWaveRefString;
WCHAR m_SpeakerTopologyNameBuffer[USBHS_INTERFACE_REFSTRING_MAX_LENGTH];
UNICODE_STRING m_SpeakerTopologyRefString;
WCHAR m_MicWaveNameBuffer[USBHS_INTERFACE_REFSTRING_MAX_LENGTH];
UNICODE_STRING m_MicWaveRefString;
WCHAR m_MicTopologyNameBuffer[USBHS_INTERFACE_REFSTRING_MAX_LENGTH];
UNICODE_STRING m_MicTopologyRefString;
//
// The Topo Filter Desc and Topo Pins structures referenced from
// the Miniports structure are deep copies: they start as copies of the
// static structures and are modified to allow USB-Device pin
// categories based on the info obtained from
// IOCTL_SBAUD_GET_ENDPOINT_DESCRIPTOR
//
PENDPOINT_MINIPAIR m_SpeakerMiniports;
PENDPOINT_MINIPAIR m_MicMiniports;
PUNKNOWN m_UnknownSpeakerTopology;
PUNKNOWN m_UnknownSpeakerWave;
PUNKNOWN m_UnknownMicTopology;
PUNKNOWN m_UnknownMicWave;
PSIDEBANDAUDIO_DEVICE_DESCRIPTOR m_Descriptor;
//
// Using new Endpoint descriptor structure
// Old: SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR - IOCTL_SBAUD_GET_ENDPOINT_DESCRIPTOR
// Use SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR for 20H2 and older OS.
//
// New: SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 - IOCTL_SBAUD_GET_ENDPOINT_DESCRIPTOR2
//
// The new struct includes interface properties
// that need to be added to the KS Filter interface
//
// USB Audio class driver supports both old and new IOCTLs
//
PSIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 m_pSpeakerDescriptor;
PSIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 m_pMicDescriptor;
PKSPROPERTY_DESCRIPTION m_SpeakerVolumePropValues;
LONG m_SpeakerVolumeLevel;
PKSPROPERTY_DESCRIPTION m_MicVolumePropValues;
LONG m_MicVolumeLevel;
PKSPROPERTY_DESCRIPTION m_SpeakerMutePropValues;
LONG m_SpeakerMute;
PKSPROPERTY_DESCRIPTION m_MicMutePropValues;
LONG m_MicMute;
ULONG m_SpeakerEpIndex;
ULONG m_MicEpIndex;
union{
NTSTATUS m_SpeakerStreamStatus;
LONG m_SpeakerStreamStatusLong;
}; // unnamed.
union{
NTSTATUS m_MicStreamStatus;
LONG m_MicStreamStatusLong;
}; // unnamed.
KEVENT m_SpeakerStreamStatusEvent;
KEVENT m_MicStreamStatusEvent;
PSIDEBANDAUDIO_SUPPORTED_FORMATS m_pSpeakerSupportedFormatsIntersection;
ULONG m_SpeakerSelectedFormat;
PSIDEBANDAUDIO_SUPPORTED_FORMATS m_pMicSupportedFormatsIntersection;
ULONG m_MicSelectedFormat;
USBHSDEVICE_EP_TRANSPORT_RESOURCES m_SpeakerTransportResources;
USBHSDEVICE_EP_TRANSPORT_RESOURCES m_MicTransportResources;
//
// Set to TRUE when the HF (remote device) wants to disable the
// NR + EC of the AG (local system).
//
WDFREQUEST m_SpeakerStreamReq;
WDFREQUEST m_MicStreamReq;
WDFREQUEST m_SpeakerVolumeReq;
WDFREQUEST m_MicVolumeReq;
WDFREQUEST m_SpeakerMuteReq;
WDFREQUEST m_MicMuteReq;
WDFWORKITEM m_WorkItem;
WDFCOLLECTION m_ReqCollection;
KSPIN_LOCK m_Lock;
LONG m_nSpeakerStreamsOpen; // # of open streams.
LONG m_nMicStreamsOpen; // # of open streams.
LONG m_nSpeakerStreamsStart; // # of Started streams.
LONG m_nMicStreamsStart; // # of Started streams.
UsbHsEventCallback m_SpeakerVolumeCallback;
UsbHsEventCallback m_MicVolumeCallback;
UsbHsEventCallback m_SpeakerMuteCallback;
UsbHsEventCallback m_MicMuteCallback;
UsbHsEventCallback m_SpeakerConnectionStatusCallback;
UsbHsEventCallback m_MicConnectionStatusCallback;
UsbHsEventCallback m_SpeakerFormatChangeCallback;
UsbHsEventCallback m_MicFormatChangeCallback;
public:
//=====================================================================
// Default CUnknown
DECLARE_STD_UNKNOWN();
DEFINE_STD_CONSTRUCTOR(UsbHsDevice);
~UsbHsDevice();
NTSTATUS Init
(
_In_ IAdapterCommon * Adapter,
_In_ PUNICODE_STRING SymbolicLinkName
);
public:
//=====================================================================
//
// Public functions used by CAdapterCommon object.
//
VOID Start();
VOID Stop();
PLIST_ENTRY GetListEntry()
{
return &m_ListEntry;
}
PUNICODE_STRING GetSymbolicLinkName()
{
return &m_SymbolicLinkName;
}
static
UsbHsDevice *
GetUsbHsDevice
(
_In_ PLIST_ENTRY le
)
{
return CONTAINING_RECORD(le, UsbHsDevice, m_ListEntry);
}
public:
//=====================================================================
//
// ISidebandDeviceCommon functions.
//
STDMETHODIMP_(BOOL) IsVolumeSupported
(
_In_ eDeviceType deviceType
);
STDMETHODIMP_(PVOID) GetVolumeSettings
(
_In_ eDeviceType deviceType,
_Out_ PULONG Size
);
STDMETHODIMP_(NTSTATUS) GetVolume
(
_In_ eDeviceType deviceType,
_In_ LONG Channel,
_Out_ LONG *pVolume
);
STDMETHODIMP_(NTSTATUS) SetVolume
(
_In_ eDeviceType deviceType,
_In_ LONG Channel,
_In_ LONG Volume
);
STDMETHODIMP_(BOOL) IsMuteSupported
(
_In_ eDeviceType deviceType
);
STDMETHODIMP_(PVOID) GetMuteSettings
(
_In_ eDeviceType deviceType,
_Out_ PULONG Size
);
STDMETHODIMP_(LONG) GetMute
(
_In_ eDeviceType deviceType,
_In_ LONG Channel
);
STDMETHODIMP_(NTSTATUS) SetMute
(
_In_ eDeviceType deviceType,
_In_ LONG Channel,
_In_ LONG Mute
);
STDMETHODIMP_(BOOL) GetConnectionStatus();
STDMETHODIMP_(NTSTATUS) Connect();
STDMETHODIMP_(NTSTATUS) Disconnect();
STDMETHODIMP_(BOOL) GetStreamStatus(_In_ eDeviceType deviceType);
STDMETHODIMP_(NTSTATUS) StreamOpen(_In_ eDeviceType deviceType);
STDMETHODIMP_(NTSTATUS) StreamStart(_In_ eDeviceType deviceType);
STDMETHODIMP_(NTSTATUS) StreamSuspend(_In_ eDeviceType deviceType);
STDMETHODIMP_(NTSTATUS) StreamClose(_In_ eDeviceType deviceType);
STDMETHODIMP_(GUID) GetContainerId(_In_ eDeviceType deviceType);
STDMETHODIMP_(VOID) SetVolumeHandler
(
_In_ eDeviceType deviceType,
_In_opt_ PFNEVENTNOTIFICATION EventHandler,
_In_opt_ PVOID EventHandlerContext
);
STDMETHODIMP_(VOID) SetMuteHandler
(
_In_ eDeviceType deviceType,
_In_opt_ PFNEVENTNOTIFICATION EventHandler,
_In_opt_ PVOID EventHandlerContext
);
STDMETHODIMP_(VOID) SetConnectionStatusHandler
(
_In_ eDeviceType deviceType,
_In_opt_ PFNEVENTNOTIFICATION EventHandler,
_In_opt_ PVOID EventHandlerContext
);
STDMETHODIMP_(VOID) SetFormatChangeHandler
(
_In_ eDeviceType deviceType,
_In_opt_ PFNEVENTNOTIFICATION EventHandler,
_In_opt_ PVOID EventHandlerContext
);
STDMETHODIMP_(PPIN_DEVICE_FORMATS_AND_MODES) GetFormatsAndModes
(
_In_ eDeviceType deviceType
);
_IRQL_requires_max_(DISPATCH_LEVEL)
STDMETHODIMP_(BOOL) IsNRECSupported();
STDMETHODIMP_(BOOL) GetNRECDisableStatus();
private:
//=====================================================================
//
// Helper functions.
//
NTSTATUS SendIoCtrlSynchronously
(
_In_opt_ WDFREQUEST Request,
_In_ ULONG IoControlCode,
_In_ ULONG InLength,
_In_ ULONG OutLength,
_When_(InLength > 0 || OutLength > 0, _In_)
_When_(InLength == 0 && OutLength == 0, _In_opt_)
PVOID Buffer
);
NTSTATUS SendIoCtrlSynchronously
(
_In_opt_ WDFREQUEST Request,
_In_ ULONG IoControlCode,
_In_ ULONG InLength,
_In_ ULONG OutLength,
_When_(InLength > 0, _In_)
_When_(InLength == 0, _In_opt_)
PVOID InBuffer,
_When_(OutLength > 0, _In_)
_When_(OutLength == 0, _In_opt_)
PVOID OutBuffer
);
NTSTATUS SendIoCtrlAsynchronously
(
_In_ WDFREQUEST Request,
_In_ ULONG IoControlCode,
_In_opt_ WDFMEMORY MemIn,
_In_opt_ WDFMEMORY MemOut,
_In_ PFN_WDF_REQUEST_COMPLETION_ROUTINE CompletionRoutine,
_In_ WDFCONTEXT Context
);
NTSTATUS GetUsbHsDescriptor
(
_Out_ PSIDEBANDAUDIO_DEVICE_DESCRIPTOR *Descriptor
);
NTSTATUS GetUsbHsEndpointDescriptor
(
_In_ ULONG EpIndex,
_Out_ PSIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 *EpDescriptor
);
NTSTATUS GetUsbHsVolumePropertyValues
(
_In_ ULONG EpIndex,
_In_ ULONG Length,
_Out_ PKSPROPERTY_DESCRIPTION *PropValues
);
NTSTATUS SetUsbHsSpeakerVolume
(
_In_ LONG Channel,
_In_ LONG Volume
);
NTSTATUS GetUsbHsSpeakerVolume
(
_In_ LONG Channel,
_Out_ LONG *Volume
);
NTSTATUS EnableUsbHsSpeakerVolumeStatusNotification();
NTSTATUS SetUsbHsMicVolume
(
_In_ LONG Channel,
_In_ LONG Volume
);
NTSTATUS GetUsbHsMicVolume
(
_In_ LONG Channel,
_Out_ LONG * Volume
);
NTSTATUS EnableUsbHsMicVolumeStatusNotification();
NTSTATUS GetUsbHsMutePropertyValues
(
_In_ ULONG EpIndex,
_In_ ULONG Length,
_Out_ PKSPROPERTY_DESCRIPTION *PropValues
);
NTSTATUS SetUsbHsSpeakerMute
(
_In_ LONG Channel,
_In_ LONG Mute
);
NTSTATUS GetUsbHsSpeakerMute
(
_In_ LONG Channel,
_Out_ LONG *Mute
);
NTSTATUS EnableUsbHsSpeakerMuteStatusNotification();
NTSTATUS SetUsbHsMicMute
(
_In_ LONG Channel,
_In_ LONG Mute
);
NTSTATUS GetUsbHsMicMute
(
_In_ LONG Channel,
_Out_ LONG *Mute
);
NTSTATUS EnableUsbHsMicMuteStatusNotification();
NTSTATUS GetUsbHsEndpointFormatsIntersection
(
_In_ PSIDEBANDAUDIO_SUPPORTED_FORMATS pDeviceFormats,
_Out_ PSIDEBANDAUDIO_SUPPORTED_FORMATS *ppSupportedFormatsIntersection
);
NTSTATUS VerifyEndpointFormatCompatibility
(
_In_ PSIDEBANDAUDIO_SUPPORTED_FORMATS EpSupportedFormats,
_In_ PKSDATAFORMAT_WAVEFORMATEXTENSIBLE pHardwareSupportedFormats,
_In_ ULONG NumHardwareSupportedFormats,
_Out_ PULONG pHardwareFormatIndex
);
NTSTATUS FreeTransportResources
(
_In_ PUSBHSDEVICE_EP_TRANSPORT_RESOURCES pTransportResources
);
NTSTATUS GetTransportResources
(
_In_ ULONG EpIndex,
_In_ PSIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 pEndpointDescriptor,
_Out_ PUSBHSDEVICE_EP_TRANSPORT_RESOURCES pTransportResources
);
NTSTATUS SetTransportResources
(
_In_ PSIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 pEndpointDescriptor,
_In_ ULONG EpIndex
);
NTSTATUS GetSiop
(
_In_ const GUID *ParamSet,
_In_ ULONG SiopTypeId,
_In_ ULONG EpIndex,
_In_ ULONG PoolTag,
_Outptr_ PBYTE *ppOutputBuffer
);
static
NTSTATUS CreateCustomEndpointMinipair
(
_In_ PENDPOINT_MINIPAIR pBaseMinipair,
_In_ PUNICODE_STRING FriendlyName,
_In_ PGUID pCategory,
_Outptr_ PENDPOINT_MINIPAIR *ppCustomMinipair
);
static
NTSTATUS UpdateCustomEndpointCategory
(
_In_ PPCFILTER_DESCRIPTOR pCustomMinipairTopoFilter,
_In_ PPCPIN_DESCRIPTOR pCustomMinipairTopoPins,
_In_ PGUID pCategory
);
static
VOID DeleteCustomEndpointMinipair
(
_In_ PENDPOINT_MINIPAIR CustomMinipair
);
NTSTATUS SetSidebandClaimed(_In_ BOOL bClaimed);
NTSTATUS SpeakerStreamOpen();
NTSTATUS MicStreamOpen();
NTSTATUS SpeakerStreamStart();
NTSTATUS MicStreamStart();
NTSTATUS SpeakerStreamSuspend();
NTSTATUS MicStreamSuspend();
NTSTATUS SpeakerStreamClose();
NTSTATUS MicStreamClose();
NTSTATUS SetUsbHsStreamOpen(ULONG EpIndex, PKSDATAFORMAT_WAVEFORMATEXTENSIBLE pStreamFormat, PSIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 pEndpointDescriptor);
NTSTATUS SetUsbHsStreamStart(ULONG EpIndex);
NTSTATUS SetUsbHsStreamSuspend(ULONG EpIndex);
NTSTATUS SetUsbHsStreamClose(ULONG EpIndex);
NTSTATUS EnableUsbHsSpeakerStreamStatusNotification();
NTSTATUS StopUsbHsSpeakerStreamStatusNotification();
NTSTATUS EnableUsbHsMicStreamStatusNotification();
NTSTATUS StopUsbHsMicStreamStatusNotification();
NTSTATUS CreateFilterNames(
_In_ PUNICODE_STRING UsbHsDeviceSymbolicLinkName
);
#if 0
NTSTATUS GetSpeakerTransportResources();
NTSTATUS FreeSpeakerTransportResources();
NTSTATUS GetMicTransportResources();
NTSTATUS FreeMicTransportResources();
#endif
//
// WDF I/O Target callback.
//
static
EVT_WDF_IO_TARGET_QUERY_REMOVE EvtUsbHsTargetQueryRemove;
static
EVT_WDF_IO_TARGET_REMOVE_CANCELED EvtUsbHsTargetRemoveCanceled;
static
EVT_WDF_IO_TARGET_REMOVE_COMPLETE EvtUsbHsTargetRemoveComplete;
//
// Status notifications callbacks.
//
static
EVT_WDF_REQUEST_COMPLETION_ROUTINE EvtUsbHsDeviceStreamStatusCompletion;
static
EVT_WDF_REQUEST_COMPLETION_ROUTINE EvtUsbHsDeviceNotificationStatusCompletion;
static
EVT_WDF_WORKITEM EvtUsbHsDeviceNotificationStatusWorkItem;
};
|
