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
|
/*++
Copyright (c) Microsoft Corporation All Rights Reserved
Module Name:
usbhstopo.cpp
Abstract:
Implementation of topology miniport for the USB Headset (external).
--*/
#ifdef SYSVAD_USB_SIDEBAND
#pragma warning (disable : 4127)
#include <sysvad.h>
#include "simple.h"
#include "mintopo.h"
#include "usbhstopo.h"
//=============================================================================
#pragma code_seg("PAGE")
NTSTATUS
PropertyHandler_UsbHsVolumeLevel_BasicSupport
(
_In_ PPCPROPERTY_REQUEST PropertyRequest
)
/*++
Routine Description:
Handles basic support for USB Headset ( KSPROPSETID_Audio, KSPROPERTY_AUDIO_VOLUMELEVEL )
Arguments:
PropertyRequest -
Return Value:
NT status code.
--*/
{
PAGED_CODE();
DPF_ENTER(("[%!FUNC!]"));
NTSTATUS ntStatus = STATUS_SUCCESS;
ULONG cbDescriptionSize = sizeof(KSPROPERTY_DESCRIPTION);
ASSERT(PropertyRequest);
if (PropertyRequest->ValueSize >= cbDescriptionSize)
{
PCMiniportTopology miniport = (PCMiniportTopology)PropertyRequest->MajorTarget;
ULONG volumeSettingsSize = 0;
PKSPROPERTY_DESCRIPTION volumeSettings;
PKSPROPERTY_DESCRIPTION propDesc;
PSIDEBANDDEVICECOMMON usbHsDevice;
propDesc = PKSPROPERTY_DESCRIPTION(PropertyRequest->Value);
usbHsDevice = miniport->GetSidebandDevice(); // weak ref.
ASSERT(usbHsDevice != NULL);
volumeSettings = (PKSPROPERTY_DESCRIPTION)usbHsDevice->GetVolumeSettings(miniport->m_DeviceType, &volumeSettingsSize);
ASSERT(volumeSettings != NULL);
ASSERT(volumeSettingsSize != 0);
ULONG cbFullProperty = volumeSettings->DescriptionSize;
// if return buffer can hold a range description, return it
if(PropertyRequest->ValueSize >= cbFullProperty)
{
RtlCopyMemory(propDesc, volumeSettings, volumeSettings->DescriptionSize);
// set the return value size
PropertyRequest->ValueSize = cbFullProperty;
}
else
{
// otherwise only return description header
RtlCopyMemory(propDesc, volumeSettings, cbDescriptionSize);
// set the return value size
PropertyRequest->ValueSize = cbDescriptionSize;
}
}
else if(PropertyRequest->ValueSize >= sizeof(ULONG))
{
// if return buffer can hold a ULONG, return the access flags
PULONG AccessFlags = PULONG(PropertyRequest->Value);
PropertyRequest->ValueSize = sizeof(ULONG);
*AccessFlags = KSPROPERTY_TYPE_ALL;
}
else
{
PropertyRequest->ValueSize = 0;
ntStatus = STATUS_BUFFER_TOO_SMALL;
}
return ntStatus;
}
//=============================================================================
#pragma code_seg("PAGE")
NTSTATUS
PropertyHandler_UsbHsMute_BasicSupport
(
_In_ PPCPROPERTY_REQUEST PropertyRequest
)
/*++
Routine Description:
Handles basic support for USB Headset ( KSPROPSETID_Audio, KSPROPERTY_AUDIO_MUTE )
Arguments:
PropertyRequest -
Return Value:
NT status code.
--*/
{
PAGED_CODE();
DPF_ENTER(("[%!FUNC!]"));
NTSTATUS ntStatus = STATUS_SUCCESS;
ULONG cbDescriptionSize = sizeof(KSPROPERTY_DESCRIPTION);
ASSERT(PropertyRequest);
if (PropertyRequest->ValueSize >= cbDescriptionSize)
{
PCMiniportTopology miniport = (PCMiniportTopology)PropertyRequest->MajorTarget;
ULONG muteSettingsSize = 0;
PKSPROPERTY_DESCRIPTION muteSettings;
PKSPROPERTY_DESCRIPTION propDesc;
PSIDEBANDDEVICECOMMON usbHsDevice;
propDesc = PKSPROPERTY_DESCRIPTION(PropertyRequest->Value);
usbHsDevice = miniport->GetSidebandDevice(); // weak ref.
ASSERT(usbHsDevice != NULL);
muteSettings = (PKSPROPERTY_DESCRIPTION)usbHsDevice->GetMuteSettings(miniport->m_DeviceType, &muteSettingsSize);
ASSERT(muteSettings != NULL);
ASSERT(muteSettingsSize != 0);
ULONG cbFullProperty = muteSettings->DescriptionSize;
// if return buffer can hold mute description, return it
if(PropertyRequest->ValueSize >= cbFullProperty)
{
RtlCopyMemory(propDesc, muteSettings, muteSettings->DescriptionSize);
// set the return value size
PropertyRequest->ValueSize = cbFullProperty;
}
else
{
// otherwise only return description header
RtlCopyMemory(propDesc, muteSettings, cbDescriptionSize);
// set the return value size
PropertyRequest->ValueSize = cbDescriptionSize;
}
}
else if(PropertyRequest->ValueSize >= sizeof(ULONG))
{
// if return buffer can hold a ULONG, return the access flags
PULONG AccessFlags = PULONG(PropertyRequest->Value);
PropertyRequest->ValueSize = sizeof(ULONG);
*AccessFlags = KSPROPERTY_TYPE_ALL;
}
else
{
PropertyRequest->ValueSize = 0;
ntStatus = STATUS_BUFFER_TOO_SMALL;
}
return ntStatus;
}
//=============================================================================
#pragma code_seg("PAGE")
NTSTATUS
PropertyHandler_UsbHsJackDescription
(
_In_ PPCPROPERTY_REQUEST PropertyRequest,
_In_ ULONG cJackDescriptions,
_In_reads_(cJackDescriptions) PKSJACK_DESCRIPTION * JackDescriptions
)
/*++
Routine Description:
Handles ( KSPROPSETID_Jack, KSPROPERTY_JACK_DESCRIPTION )
Arguments:
PropertyRequest -
cJackDescriptions -
JackDescriptions -
Return Value:
NT status code.
--*/
{
PAGED_CODE();
ASSERT(PropertyRequest);
DPF_ENTER(("[%!FUNC!]"));
NTSTATUS ntStatus = STATUS_INVALID_DEVICE_REQUEST;
ULONG nPinId = (ULONG)-1;
PCMiniportTopology miniport = (PCMiniportTopology)PropertyRequest->MajorTarget;
if (PropertyRequest->InstanceSize >= sizeof(ULONG))
{
nPinId = *(PULONG(PropertyRequest->Instance));
if ((nPinId < cJackDescriptions) && (JackDescriptions[nPinId] != NULL))
{
if (PropertyRequest->Verb & KSPROPERTY_TYPE_BASICSUPPORT)
{
ntStatus =
PropertyHandler_BasicSupport
(
PropertyRequest,
KSPROPERTY_TYPE_BASICSUPPORT | KSPROPERTY_TYPE_GET,
VT_ILLEGAL
);
}
else
{
ULONG cbNeeded = sizeof(KSMULTIPLE_ITEM) + sizeof(KSJACK_DESCRIPTION);
if (PropertyRequest->ValueSize == 0)
{
PropertyRequest->ValueSize = cbNeeded;
ntStatus = STATUS_BUFFER_OVERFLOW;
}
else if (PropertyRequest->ValueSize < cbNeeded)
{
ntStatus = STATUS_BUFFER_TOO_SMALL;
}
else
{
if (PropertyRequest->Verb & KSPROPERTY_TYPE_GET)
{
PSIDEBANDDEVICECOMMON usbHsDevice = NULL;
PKSMULTIPLE_ITEM pMI = (PKSMULTIPLE_ITEM)PropertyRequest->Value;
PKSJACK_DESCRIPTION pDesc = (PKSJACK_DESCRIPTION)(pMI+1);
usbHsDevice = miniport->GetSidebandDevice(); // weak ref.
ASSERT(usbHsDevice != NULL);
pMI->Size = cbNeeded;
pMI->Count = 1;
RtlCopyMemory(pDesc, JackDescriptions[nPinId], sizeof(KSJACK_DESCRIPTION));
pDesc->IsConnected = usbHsDevice->GetConnectionStatus() ? TRUE : FALSE;
ntStatus = STATUS_SUCCESS;
}
}
}
}
}
return ntStatus;
}
//=============================================================================
#pragma code_seg("PAGE")
NTSTATUS
PropertyHandler_UsbHsJackDescription2
(
_In_ PPCPROPERTY_REQUEST PropertyRequest,
_In_ ULONG cJackDescriptions,
_In_reads_(cJackDescriptions) PKSJACK_DESCRIPTION * JackDescriptions
)
/*++
Routine Description:
Handles ( KSPROPSETID_Jack, KSPROPERTY_JACK_DESCRIPTION2 )
Arguments:
PropertyRequest -
cJackDescriptions -
JackDescriptions -
Return Value:
NT status code.
--*/
{
PAGED_CODE();
ASSERT(PropertyRequest);
DPF_ENTER(("[%!FUNC!]"));
NTSTATUS ntStatus = STATUS_INVALID_DEVICE_REQUEST;
ULONG nPinId = (ULONG)-1;
if (PropertyRequest->InstanceSize >= sizeof(ULONG))
{
nPinId = *(PULONG(PropertyRequest->Instance));
if ((nPinId < cJackDescriptions) && (JackDescriptions[nPinId] != NULL))
{
if (PropertyRequest->Verb & KSPROPERTY_TYPE_BASICSUPPORT)
{
ntStatus =
PropertyHandler_BasicSupport
(
PropertyRequest,
KSPROPERTY_TYPE_BASICSUPPORT | KSPROPERTY_TYPE_GET,
VT_ILLEGAL
);
}
else
{
ULONG cbNeeded = sizeof(KSMULTIPLE_ITEM) + sizeof(KSJACK_DESCRIPTION2);
if (PropertyRequest->ValueSize == 0)
{
PropertyRequest->ValueSize = cbNeeded;
ntStatus = STATUS_BUFFER_OVERFLOW;
}
else if (PropertyRequest->ValueSize < cbNeeded)
{
ntStatus = STATUS_BUFFER_TOO_SMALL;
}
else
{
if (PropertyRequest->Verb & KSPROPERTY_TYPE_GET)
{
PKSMULTIPLE_ITEM pMI = (PKSMULTIPLE_ITEM)PropertyRequest->Value;
PKSJACK_DESCRIPTION2 pDesc = (PKSJACK_DESCRIPTION2)(pMI+1);
pMI->Size = cbNeeded;
pMI->Count = 1;
RtlZeroMemory(pDesc, sizeof(KSJACK_DESCRIPTION2));
//
// Specifies the lower 16 bits of the DWORD parameter. This parameter indicates whether
// the jack is currently active, streaming, idle, or hardware not ready.
//
pDesc->DeviceStateInfo = 0;
//
// From MSDN:
// "If an audio device lacks jack presence detection, the IsConnected member of
// the KSJACK_DESCRIPTION structure must always be set to TRUE. To remove the
// ambiguity that results from this dual meaning of the TRUE value for IsConnected,
// a client application can call IKsJackDescription2::GetJackDescription2 to read
// the JackCapabilities flag of the KSJACK_DESCRIPTION2 structure. If this flag has
// the JACKDESC2_PRESENCE_DETECT_CAPABILITY bit set, it indicates that the endpoint
// does in fact support jack presence detection. In that case, the return value of
// the IsConnected member can be interpreted to accurately reflect the insertion status
// of the jack."
//
// Bit definitions:
// 0x00000001 - JACKDESC2_PRESENCE_DETECT_CAPABILITY
// 0x00000002 - JACKDESC2_DYNAMIC_FORMAT_CHANGE_CAPABILITY
//
pDesc->JackCapabilities = JACKDESC2_PRESENCE_DETECT_CAPABILITY;
ntStatus = STATUS_SUCCESS;
}
}
}
}
}
return ntStatus;
}
//=============================================================================
#pragma code_seg("PAGE")
NTSTATUS
PropertyHandler_UsbHsJackContainerId
(
_In_ PPCPROPERTY_REQUEST PropertyRequest,
_In_ ULONG cJackDescriptions,
_In_reads_(cJackDescriptions) PKSJACK_DESCRIPTION * JackDescriptions
)
/*++
Routine Description:
Handles ( KSPROPSETID_Jack, KSPROPERTY_JACK_CONTAINERID )
Arguments:
PropertyRequest -
cJackDescriptions -
JackDescriptions -
Return Value:
NT status code.
--*/
{
PAGED_CODE();
ASSERT(PropertyRequest);
DPF_ENTER(("[%!FUNC!]"));
NTSTATUS ntStatus = STATUS_INVALID_DEVICE_REQUEST;
PCMiniportTopology miniport = (PCMiniportTopology)PropertyRequest->MajorTarget;
ULONG nPinId = (ULONG)-1;
if (PropertyRequest->InstanceSize >= sizeof(ULONG))
{
nPinId = *(PULONG(PropertyRequest->Instance));
// This property is only valid on bridge pins.
if ((nPinId < cJackDescriptions) && (JackDescriptions[nPinId] != NULL))
{
if (PropertyRequest->Verb & KSPROPERTY_TYPE_BASICSUPPORT)
{
ntStatus =
PropertyHandler_BasicSupport
(
PropertyRequest,
KSPROPERTY_TYPE_BASICSUPPORT | KSPROPERTY_TYPE_GET,
VT_ILLEGAL
);
}
else
{
ULONG cbNeeded = sizeof(GUID);
if (PropertyRequest->ValueSize == 0)
{
PropertyRequest->ValueSize = cbNeeded;
ntStatus = STATUS_BUFFER_OVERFLOW;
}
else if (PropertyRequest->ValueSize < cbNeeded)
{
ntStatus = STATUS_BUFFER_TOO_SMALL;
}
else
{
if (PropertyRequest->Verb & KSPROPERTY_TYPE_GET)
{
PSIDEBANDDEVICECOMMON usbHsDevice = NULL;
GUID* guid = (GUID *)PropertyRequest->Value;
usbHsDevice = miniport->GetSidebandDevice(); // weak ref.
ASSERT(usbHsDevice != NULL);
*guid = usbHsDevice->GetContainerId(miniport->m_DeviceType);
ntStatus = STATUS_SUCCESS;
}
}
}
}
}
return ntStatus;
}
//=============================================================================
#pragma code_seg()
NTSTATUS
PropertyHandler_UsbHsTopoNodeEvent
(
_In_ PPCEVENT_REQUEST EventRequest
)
{
ASSERT(EventRequest);
DPF_ENTER(("[%!FUNC!]"));
// The major target is the object pointer to the topology miniport.
PCMiniportTopology pMiniport = (PCMiniportTopology)EventRequest->MajorTarget;
ASSERT (pMiniport);
switch (EventRequest->Verb)
{
// Do we support event handling?!?
case PCEVENT_VERB_SUPPORT:
DPF(D_VERBOSE, ("BasicSupport Query for event."));
break;
// We should add the event now!
case PCEVENT_VERB_ADD:
DPF(D_VERBOSE, ("Adding event."));
// If we have the interface and EventEntry is defined ...
if (EventRequest->EventEntry)
{
pMiniport->AddEventToEventList(EventRequest->EventEntry);
}
else
{
return STATUS_UNSUCCESSFUL;
}
break;
case PCEVENT_VERB_REMOVE:
// We cannot remove the event but we can stop generating the
// events. However, it also doesn't hurt to always generate them ...
DPF(D_VERBOSE, ("Removing event."));
break;
default:
return STATUS_INVALID_PARAMETER;
}
return STATUS_SUCCESS;
}
#pragma code_seg()
#endif //SYSVAD_USB_SIDEBAND
|
