/
enum.c
3366 lines (2853 loc) · 99.2 KB
/
enum.c
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
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*++
Copyright (c) 1997-2011 Microsoft Corporation
Module Name:
ENUM.C
Abstract:
This source file contains the routines which enumerate the USB bus
and populate the TreeView control.
The enumeration process goes like this:
(1) Enumerate Host Controllers and Root Hubs
EnumerateHostControllers()
EnumerateHostController()
Host controllers currently have symbolic link names of the form HCDx,
where x starts at 0. Use CreateFile() to open each host controller
symbolic link. Create a node in the TreeView to represent each host
controller.
GetRootHubName()
After a host controller has been opened, send the host controller an
IOCTL_USB_GET_ROOT_HUB_NAME request to get the symbolic link name of
the root hub that is part of the host controller.
(2) Enumerate Hubs (Root Hubs and External Hubs)
EnumerateHub()
Given the name of a hub, use CreateFile() to map the hub. Send the
hub an IOCTL_USB_GET_NODE_INFORMATION request to get info about the
hub, such as the number of downstream ports. Create a node in the
TreeView to represent each hub.
(3) Enumerate Downstream Ports
EnumerateHubPorts()
Given an handle to an open hub and the number of downstream ports on
the hub, send the hub an IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX
request for each downstream port of the hub to get info about the
device (if any) attached to each port. If there is a device attached
to a port, send the hub an IOCTL_USB_GET_NODE_CONNECTION_NAME request
to get the symbolic link name of the hub attached to the downstream
port. If there is a hub attached to the downstream port, recurse to
step (2).
GetAllStringDescriptors()
GetConfigDescriptor()
Create a node in the TreeView to represent each hub port
and attached device.
Environment:
user mode
Revision History:
04-25-97 : created
--*/
//*****************************************************************************
// I N C L U D E S
//*****************************************************************************
#include "uvcview.h"
//*****************************************************************************
// D E F I N E S
//*****************************************************************************
#define NUM_STRING_DESC_TO_GET 32
//*****************************************************************************
// L O C A L F U N C T I O N P R O T O T Y P E S
//*****************************************************************************
VOID
EnumerateHostControllers (
HTREEITEM hTreeParent,
ULONG *DevicesConnected
);
VOID
EnumerateHostController (
HTREEITEM hTreeParent,
HANDLE hHCDev,
_Inout_ PCHAR leafName,
_In_ HANDLE deviceInfo,
_In_ PSP_DEVINFO_DATA deviceInfoData
);
VOID
EnumerateHub (
HTREEITEM hTreeParent,
_In_reads_(cbHubName) PCHAR HubName,
_In_ size_t cbHubName,
_In_opt_ PUSB_NODE_CONNECTION_INFORMATION_EX ConnectionInfo,
_In_opt_ PUSB_NODE_CONNECTION_INFORMATION_EX_V2 ConnectionInfoV2,
_In_opt_ PUSB_PORT_CONNECTOR_PROPERTIES PortConnectorProps,
_In_opt_ PUSB_DESCRIPTOR_REQUEST ConfigDesc,
_In_opt_ PUSB_DESCRIPTOR_REQUEST BosDesc,
_In_opt_ PSTRING_DESCRIPTOR_NODE StringDescs,
_In_opt_ PUSB_DEVICE_PNP_STRINGS DevProps
);
VOID
EnumerateHubPorts (
HTREEITEM hTreeParent,
HANDLE hHubDevice,
ULONG NumPorts
);
PCHAR GetRootHubName (
HANDLE HostController
);
PCHAR GetExternalHubName (
HANDLE Hub,
ULONG ConnectionIndex
);
PCHAR GetHCDDriverKeyName (
HANDLE HCD
);
PCHAR GetDriverKeyName (
HANDLE Hub,
ULONG ConnectionIndex
);
PUSB_DESCRIPTOR_REQUEST
GetConfigDescriptor (
HANDLE hHubDevice,
ULONG ConnectionIndex,
UCHAR DescriptorIndex
);
PUSB_DESCRIPTOR_REQUEST
GetBOSDescriptor (
HANDLE hHubDevice,
ULONG ConnectionIndex
);
DWORD
GetHostControllerPowerMap(
HANDLE hHCDev,
PUSBHOSTCONTROLLERINFO hcInfo);
DWORD
GetHostControllerInfo(
HANDLE hHCDev,
PUSBHOSTCONTROLLERINFO hcInfo);
PCHAR WideStrToMultiStr (
_In_reads_bytes_(cbWideStr) PWCHAR WideStr,
_In_ size_t cbWideStr
);
BOOL
AreThereStringDescriptors (
PUSB_DEVICE_DESCRIPTOR DeviceDesc,
PUSB_CONFIGURATION_DESCRIPTOR ConfigDesc
);
PSTRING_DESCRIPTOR_NODE
GetAllStringDescriptors (
HANDLE hHubDevice,
ULONG ConnectionIndex,
PUSB_DEVICE_DESCRIPTOR DeviceDesc,
PUSB_CONFIGURATION_DESCRIPTOR ConfigDesc
);
PSTRING_DESCRIPTOR_NODE
GetStringDescriptor (
HANDLE hHubDevice,
ULONG ConnectionIndex,
UCHAR DescriptorIndex,
USHORT LanguageID
);
HRESULT
GetStringDescriptors (
_In_ HANDLE hHubDevice,
_In_ ULONG ConnectionIndex,
_In_ UCHAR DescriptorIndex,
_In_ ULONG NumLanguageIDs,
_In_reads_(NumLanguageIDs) USHORT *LanguageIDs,
_In_ PSTRING_DESCRIPTOR_NODE StringDescNodeHead
);
void
EnumerateAllDevices();
void
EnumerateAllDevicesWithGuid(
PDEVICE_GUID_LIST DeviceList,
LPGUID Guid
);
void
FreeDeviceInfoNode(
_In_ PDEVICE_INFO_NODE *ppNode
);
PDEVICE_INFO_NODE
FindMatchingDeviceNodeForDriverName(
_In_ PSTR DriverKeyName,
_In_ BOOLEAN IsHub
);
//*****************************************************************************
// G L O B A L S
//*****************************************************************************
// List of enumerated host controllers.
//
LIST_ENTRY EnumeratedHCListHead =
{
&EnumeratedHCListHead,
&EnumeratedHCListHead
};
DEVICE_GUID_LIST gHubList;
DEVICE_GUID_LIST gDeviceList;
//*****************************************************************************
// G L O B A L S P R I V A T E T O T H I S F I L E
//*****************************************************************************
PCHAR ConnectionStatuses[] =
{
"", // 0 - NoDeviceConnected
"", // 1 - DeviceConnected
"FailedEnumeration", // 2 - DeviceFailedEnumeration
"GeneralFailure", // 3 - DeviceGeneralFailure
"Overcurrent", // 4 - DeviceCausedOvercurrent
"NotEnoughPower", // 5 - DeviceNotEnoughPower
"NotEnoughBandwidth", // 6 - DeviceNotEnoughBandwidth
"HubNestedTooDeeply", // 7 - DeviceHubNestedTooDeeply
"InLegacyHub", // 8 - DeviceInLegacyHub
"Enumerating", // 9 - DeviceEnumerating
"Reset" // 10 - DeviceReset
};
ULONG TotalDevicesConnected;
//*****************************************************************************
//
// EnumerateHostControllers()
//
// hTreeParent - Handle of the TreeView item under which host controllers
// should be added.
//
//*****************************************************************************
VOID
EnumerateHostControllers (
HTREEITEM hTreeParent,
ULONG *DevicesConnected
)
{
HANDLE hHCDev = NULL;
HDEVINFO deviceInfo = NULL;
SP_DEVINFO_DATA deviceInfoData;
SP_DEVICE_INTERFACE_DATA deviceInterfaceData;
PSP_DEVICE_INTERFACE_DETAIL_DATA deviceDetailData = NULL;
ULONG index = 0;
ULONG requiredLength = 0;
BOOL success;
TotalDevicesConnected = 0;
TotalHubs = 0;
EnumerateAllDevices();
// Iterate over host controllers using the new GUID based interface
//
deviceInfo = SetupDiGetClassDevs((LPGUID)&GUID_CLASS_USB_HOST_CONTROLLER,
NULL,
NULL,
(DIGCF_PRESENT | DIGCF_DEVICEINTERFACE));
deviceInfoData.cbSize = sizeof(SP_DEVINFO_DATA);
for (index=0;
SetupDiEnumDeviceInfo(deviceInfo,
index,
&deviceInfoData);
index++)
{
deviceInterfaceData.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
success = SetupDiEnumDeviceInterfaces(deviceInfo,
0,
(LPGUID)&GUID_CLASS_USB_HOST_CONTROLLER,
index,
&deviceInterfaceData);
if (!success)
{
OOPS();
break;
}
success = SetupDiGetDeviceInterfaceDetail(deviceInfo,
&deviceInterfaceData,
NULL,
0,
&requiredLength,
NULL);
if (!success && GetLastError() != ERROR_INSUFFICIENT_BUFFER)
{
OOPS();
break;
}
deviceDetailData = ALLOC(requiredLength);
if (deviceDetailData == NULL)
{
OOPS();
break;
}
deviceDetailData->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA);
success = SetupDiGetDeviceInterfaceDetail(deviceInfo,
&deviceInterfaceData,
deviceDetailData,
requiredLength,
&requiredLength,
NULL);
if (!success)
{
OOPS();
break;
}
hHCDev = CreateFile(deviceDetailData->DevicePath,
GENERIC_WRITE,
FILE_SHARE_WRITE,
NULL,
OPEN_EXISTING,
0,
NULL);
// If the handle is valid, then we've successfully opened a Host
// Controller. Display some info about the Host Controller itself,
// then enumerate the Root Hub attached to the Host Controller.
//
if (hHCDev != INVALID_HANDLE_VALUE)
{
EnumerateHostController(hTreeParent,
hHCDev,
deviceDetailData->DevicePath,
deviceInfo,
&deviceInfoData);
CloseHandle(hHCDev);
}
FREE(deviceDetailData);
}
SetupDiDestroyDeviceInfoList(deviceInfo);
*DevicesConnected = TotalDevicesConnected;
return;
}
//*****************************************************************************
//
// EnumerateHostController()
//
// hTreeParent - Handle of the TreeView item under which host controllers
// should be added.
//
//*****************************************************************************
VOID
EnumerateHostController (
HTREEITEM hTreeParent,
HANDLE hHCDev, _Inout_ PCHAR leafName,
_In_ HANDLE deviceInfo,
_In_ PSP_DEVINFO_DATA deviceInfoData
)
{
PCHAR driverKeyName = NULL;
HTREEITEM hHCItem = NULL;
PCHAR rootHubName = NULL;
PLIST_ENTRY listEntry = NULL;
PUSBHOSTCONTROLLERINFO hcInfo = NULL;
PUSBHOSTCONTROLLERINFO hcInfoInList = NULL;
DWORD dwSuccess;
BOOL success = FALSE;
ULONG deviceAndFunction = 0;
PUSB_DEVICE_PNP_STRINGS DevProps = NULL;
// Allocate a structure to hold information about this host controller.
//
hcInfo = (PUSBHOSTCONTROLLERINFO)ALLOC(sizeof(USBHOSTCONTROLLERINFO));
// just return if could not alloc memory
if (NULL == hcInfo)
return;
hcInfo->DeviceInfoType = HostControllerInfo;
// Obtain the driver key name for this host controller.
//
driverKeyName = GetHCDDriverKeyName(hHCDev);
if (NULL == driverKeyName)
{
// Failure obtaining driver key name.
OOPS();
FREE(hcInfo);
return;
}
// Don't enumerate this host controller again if it already
// on the list of enumerated host controllers.
//
listEntry = EnumeratedHCListHead.Flink;
while (listEntry != &EnumeratedHCListHead)
{
hcInfoInList = CONTAINING_RECORD(listEntry,
USBHOSTCONTROLLERINFO,
ListEntry);
if (strcmp(driverKeyName, hcInfoInList->DriverKey) == 0)
{
// Already on the list, exit
//
FREE(driverKeyName);
FREE(hcInfo);
return;
}
listEntry = listEntry->Flink;
}
// Obtain host controller device properties
{
size_t cbDriverName = 0;
HRESULT hr = S_OK;
hr = StringCbLength(driverKeyName, MAX_DRIVER_KEY_NAME, &cbDriverName);
if (SUCCEEDED(hr))
{
DevProps = DriverNameToDeviceProperties(driverKeyName, cbDriverName);
}
}
hcInfo->DriverKey = driverKeyName;
if (DevProps)
{
ULONG ven, dev, subsys, rev;
ven = dev = subsys = rev = 0;
if (sscanf_s(DevProps->DeviceId,
"PCI\\VEN_%x&DEV_%x&SUBSYS_%x&REV_%x",
&ven, &dev, &subsys, &rev) != 4)
{
OOPS();
}
hcInfo->VendorID = ven;
hcInfo->DeviceID = dev;
hcInfo->SubSysID = subsys;
hcInfo->Revision = rev;
hcInfo->UsbDeviceProperties = DevProps;
}
else
{
OOPS();
}
if (DevProps != NULL && DevProps->DeviceDesc != NULL)
{
leafName = DevProps->DeviceDesc;
}
else
{
OOPS();
}
// Get the USB Host Controller power map
dwSuccess = GetHostControllerPowerMap(hHCDev, hcInfo);
if (ERROR_SUCCESS != dwSuccess)
{
OOPS();
}
// Get bus, device, and function
//
hcInfo->BusDeviceFunctionValid = FALSE;
success = SetupDiGetDeviceRegistryProperty(deviceInfo,
deviceInfoData,
SPDRP_BUSNUMBER,
NULL,
(PBYTE)&hcInfo->BusNumber,
sizeof(hcInfo->BusNumber),
NULL);
if (success)
{
success = SetupDiGetDeviceRegistryProperty(deviceInfo,
deviceInfoData,
SPDRP_ADDRESS,
NULL,
(PBYTE)&deviceAndFunction,
sizeof(deviceAndFunction),
NULL);
}
if (success)
{
hcInfo->BusDevice = deviceAndFunction >> 16;
hcInfo->BusFunction = deviceAndFunction & 0xffff;
hcInfo->BusDeviceFunctionValid = TRUE;
}
// Get the USB Host Controller info
dwSuccess = GetHostControllerInfo(hHCDev, hcInfo);
if (ERROR_SUCCESS != dwSuccess)
{
OOPS();
}
// Add this host controller to the USB device tree view.
//
hHCItem = AddLeaf(hTreeParent,
(LPARAM)hcInfo,
leafName,
hcInfo->Revision == UsbSuperSpeed ? GoodSsDeviceIcon : GoodDeviceIcon);
if (NULL == hHCItem)
{
// Failure adding host controller to USB device tree
// view.
OOPS();
FREE(driverKeyName);
FREE(hcInfo);
return;
}
// Add this host controller to the list of enumerated
// host controllers.
//
InsertTailList(&EnumeratedHCListHead,
&hcInfo->ListEntry);
// Get the name of the root hub for this host
// controller and then enumerate the root hub.
//
rootHubName = GetRootHubName(hHCDev);
if (rootHubName != NULL)
{
size_t cbHubName = 0;
HRESULT hr = S_OK;
hr = StringCbLength(rootHubName, MAX_DRIVER_KEY_NAME, &cbHubName);
if (SUCCEEDED(hr))
{
EnumerateHub(hHCItem,
rootHubName,
cbHubName,
NULL, // ConnectionInfo
NULL, // ConnectionInfoV2
NULL, // PortConnectorProps
NULL, // ConfigDesc
NULL, // BosDesc
NULL, // StringDescs
NULL); // We do not pass DevProps for RootHub
}
}
else
{
// Failure obtaining root hub name.
OOPS();
}
return;
}
//*****************************************************************************
//
// EnumerateHub()
//
// hTreeParent - Handle of the TreeView item under which this hub should be
// added.
//
// HubName - Name of this hub. This pointer is kept so the caller can neither
// free nor reuse this memory.
//
// ConnectionInfo - NULL if this is a root hub, else this is the connection
// info for an external hub. This pointer is kept so the caller can neither
// free nor reuse this memory.
//
// ConfigDesc - NULL if this is a root hub, else this is the Configuration
// Descriptor for an external hub. This pointer is kept so the caller can
// neither free nor reuse this memory.
//
// StringDescs - NULL if this is a root hub.
//
// DevProps - Device properties of the hub
//
//*****************************************************************************
VOID
EnumerateHub (
HTREEITEM hTreeParent,
_In_reads_(cbHubName) PCHAR HubName,
_In_ size_t cbHubName,
_In_opt_ PUSB_NODE_CONNECTION_INFORMATION_EX ConnectionInfo,
_In_opt_ PUSB_NODE_CONNECTION_INFORMATION_EX_V2 ConnectionInfoV2,
_In_opt_ PUSB_PORT_CONNECTOR_PROPERTIES PortConnectorProps,
_In_opt_ PUSB_DESCRIPTOR_REQUEST ConfigDesc,
_In_opt_ PUSB_DESCRIPTOR_REQUEST BosDesc,
_In_opt_ PSTRING_DESCRIPTOR_NODE StringDescs,
_In_opt_ PUSB_DEVICE_PNP_STRINGS DevProps
)
{
// Initialize locals to not allocated state so the error cleanup routine
// only tries to cleanup things that were successfully allocated.
//
PUSB_NODE_INFORMATION hubInfo = NULL;
PUSB_HUB_INFORMATION_EX hubInfoEx = NULL;
PUSB_HUB_CAPABILITIES_EX hubCapabilityEx = NULL;
HANDLE hHubDevice = INVALID_HANDLE_VALUE;
HTREEITEM hItem = NULL;
PVOID info = NULL;
PCHAR deviceName = NULL;
ULONG nBytes = 0;
BOOL success = 0;
DWORD dwSizeOfLeafName = 0;
CHAR leafName[512] = {0};
HRESULT hr = S_OK;
size_t cchHeader = 0;
size_t cchFullHubName = 0;
// Allocate some space for a USBDEVICEINFO structure to hold the
// hub info, hub name, and connection info pointers. GPTR zero
// initializes the structure for us.
//
info = ALLOC(sizeof(USBEXTERNALHUBINFO));
if (info == NULL)
{
OOPS();
goto EnumerateHubError;
}
// Allocate some space for a USB_NODE_INFORMATION structure for this Hub
//
hubInfo = (PUSB_NODE_INFORMATION)ALLOC(sizeof(USB_NODE_INFORMATION));
if (hubInfo == NULL)
{
OOPS();
goto EnumerateHubError;
}
hubInfoEx = (PUSB_HUB_INFORMATION_EX)ALLOC(sizeof(USB_HUB_INFORMATION_EX));
if (hubInfoEx == NULL)
{
OOPS();
goto EnumerateHubError;
}
hubCapabilityEx = (PUSB_HUB_CAPABILITIES_EX)ALLOC(sizeof(USB_HUB_CAPABILITIES_EX));
if(hubCapabilityEx == NULL)
{
OOPS();
goto EnumerateHubError;
}
// Keep copies of the Hub Name, Connection Info, and Configuration
// Descriptor pointers
//
((PUSBROOTHUBINFO)info)->HubInfo = hubInfo;
((PUSBROOTHUBINFO)info)->HubName = HubName;
if (ConnectionInfo != NULL)
{
((PUSBEXTERNALHUBINFO)info)->DeviceInfoType = ExternalHubInfo;
((PUSBEXTERNALHUBINFO)info)->ConnectionInfo = ConnectionInfo;
((PUSBEXTERNALHUBINFO)info)->ConfigDesc = ConfigDesc;
((PUSBEXTERNALHUBINFO)info)->StringDescs = StringDescs;
((PUSBEXTERNALHUBINFO)info)->PortConnectorProps = PortConnectorProps;
((PUSBEXTERNALHUBINFO)info)->HubInfoEx = hubInfoEx;
((PUSBEXTERNALHUBINFO)info)->HubCapabilityEx = hubCapabilityEx;
((PUSBEXTERNALHUBINFO)info)->BosDesc = BosDesc;
((PUSBEXTERNALHUBINFO)info)->ConnectionInfoV2 = ConnectionInfoV2;
((PUSBEXTERNALHUBINFO)info)->UsbDeviceProperties = DevProps;
}
else
{
((PUSBROOTHUBINFO)info)->DeviceInfoType = RootHubInfo;
((PUSBROOTHUBINFO)info)->HubInfoEx = hubInfoEx;
((PUSBROOTHUBINFO)info)->HubCapabilityEx = hubCapabilityEx;
((PUSBROOTHUBINFO)info)->PortConnectorProps = PortConnectorProps;
((PUSBROOTHUBINFO)info)->UsbDeviceProperties = DevProps;
}
// Allocate a temp buffer for the full hub device name.
//
hr = StringCbLength("\\\\.\\", MAX_DEVICE_PROP, &cchHeader);
if (FAILED(hr))
{
goto EnumerateHubError;
}
cchFullHubName = cchHeader + cbHubName + 1;
deviceName = (PCHAR)ALLOC((DWORD) cchFullHubName);
if (deviceName == NULL)
{
OOPS();
goto EnumerateHubError;
}
// Create the full hub device name
//
hr = StringCchCopyN(deviceName, cchFullHubName, "\\\\.\\", cchHeader);
if (FAILED(hr))
{
goto EnumerateHubError;
}
hr = StringCchCatN(deviceName, cchFullHubName, HubName, cbHubName);
if (FAILED(hr))
{
goto EnumerateHubError;
}
// Try to hub the open device
//
hHubDevice = CreateFile(deviceName,
GENERIC_WRITE,
FILE_SHARE_WRITE,
NULL,
OPEN_EXISTING,
0,
NULL);
// Done with temp buffer for full hub device name
//
FREE(deviceName);
if (hHubDevice == INVALID_HANDLE_VALUE)
{
OOPS();
goto EnumerateHubError;
}
//
// Now query USBHUB for the USB_NODE_INFORMATION structure for this hub.
// This will tell us the number of downstream ports to enumerate, among
// other things.
//
success = DeviceIoControl(hHubDevice,
IOCTL_USB_GET_NODE_INFORMATION,
hubInfo,
sizeof(USB_NODE_INFORMATION),
hubInfo,
sizeof(USB_NODE_INFORMATION),
&nBytes,
NULL);
if (!success)
{
OOPS();
goto EnumerateHubError;
}
success = DeviceIoControl(hHubDevice,
IOCTL_USB_GET_HUB_INFORMATION_EX,
hubInfoEx,
sizeof(USB_HUB_INFORMATION_EX),
hubInfoEx,
sizeof(USB_HUB_INFORMATION_EX),
&nBytes,
NULL);
//
// Fail gracefully for downlevel OS's from Win8
//
if (!success || nBytes < sizeof(USB_HUB_INFORMATION_EX))
{
FREE(hubInfoEx);
hubInfoEx = NULL;
if (ConnectionInfo != NULL)
{
((PUSBEXTERNALHUBINFO)info)->HubInfoEx = NULL;
}
else
{
((PUSBROOTHUBINFO)info)->HubInfoEx = NULL;
}
}
//
// Obtain Hub Capabilities
//
success = DeviceIoControl(hHubDevice,
IOCTL_USB_GET_HUB_CAPABILITIES_EX,
hubCapabilityEx,
sizeof(USB_HUB_CAPABILITIES_EX),
hubCapabilityEx,
sizeof(USB_HUB_CAPABILITIES_EX),
&nBytes,
NULL);
//
// Fail gracefully
//
if (!success || nBytes < sizeof(USB_HUB_CAPABILITIES_EX))
{
FREE(hubCapabilityEx);
hubCapabilityEx = NULL;
if (ConnectionInfo != NULL)
{
((PUSBEXTERNALHUBINFO)info)->HubCapabilityEx = NULL;
}
else
{
((PUSBROOTHUBINFO)info)->HubCapabilityEx = NULL;
}
}
// Build the leaf name from the port number and the device description
//
dwSizeOfLeafName = sizeof(leafName);
if (ConnectionInfo)
{
StringCchPrintf(leafName, dwSizeOfLeafName, "[Port%d] ", ConnectionInfo->ConnectionIndex);
StringCchCat(leafName,
dwSizeOfLeafName,
ConnectionStatuses[ConnectionInfo->ConnectionStatus]);
StringCchCatN(leafName,
dwSizeOfLeafName,
" : ",
sizeof(" : "));
}
if (DevProps)
{
size_t cbDeviceDesc = 0;
hr = StringCbLength(DevProps->DeviceDesc, MAX_DRIVER_KEY_NAME, &cbDeviceDesc);
if(SUCCEEDED(hr))
{
StringCchCatN(leafName,
dwSizeOfLeafName,
DevProps->DeviceDesc,
cbDeviceDesc);
}
}
else
{
if(ConnectionInfo != NULL)
{
// External hub
StringCchCatN(leafName,
dwSizeOfLeafName,
HubName,
cbHubName);
}
else
{
// Root hub
StringCchCatN(leafName,
dwSizeOfLeafName,
"RootHub",
sizeof("RootHub"));
}
}
// Now add an item to the TreeView with the PUSBDEVICEINFO pointer info
// as the LPARAM reference value containing everything we know about the
// hub.
//
hItem = AddLeaf(hTreeParent,
(LPARAM)info,
leafName,
HubIcon);
if (hItem == NULL)
{
OOPS();
goto EnumerateHubError;
}
// Now recursively enumerate the ports of this hub.
//
EnumerateHubPorts(
hItem,
hHubDevice,
hubInfo->u.HubInformation.HubDescriptor.bNumberOfPorts
);
CloseHandle(hHubDevice);
return;
EnumerateHubError:
//
// Clean up any stuff that got allocated
//
if (hHubDevice != INVALID_HANDLE_VALUE)
{
CloseHandle(hHubDevice);
hHubDevice = INVALID_HANDLE_VALUE;
}
if (hubInfo)
{
FREE(hubInfo);
}
if (hubInfoEx)
{
FREE(hubInfoEx);
}
if (info)
{
FREE(info);
}
if (HubName)
{
FREE(HubName);
}
if (ConnectionInfo)
{
FREE(ConnectionInfo);
}
if (ConfigDesc)
{
FREE(ConfigDesc);
}
if (BosDesc)
{
FREE(BosDesc);
}
if (StringDescs != NULL)
{
PSTRING_DESCRIPTOR_NODE Next;
do {
Next = StringDescs->Next;
FREE(StringDescs);
StringDescs = Next;
} while (StringDescs != NULL);
}
}
//*****************************************************************************
//
// EnumerateHubPorts()
//
// hTreeParent - Handle of the TreeView item under which the hub port should
// be added.
//
// hHubDevice - Handle of the hub device to enumerate.
//
// NumPorts - Number of ports on the hub.
//
//*****************************************************************************
VOID
EnumerateHubPorts (
HTREEITEM hTreeParent,
HANDLE hHubDevice,
ULONG NumPorts
)
{