2 * This file is part of the libserialport project.
4 * Copyright (C) 2013-2014 Martin Ling <martin-libserialport@earth.li>
5 * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "libserialport.h"
23 #include "libserialport_internal.h"
25 /* USB path is a string of at most 8 decimal numbers < 128 separated by dots. */
26 #define MAX_USB_PATH ((8 * 3) + (7 * 1) + 1)
28 static void enumerate_hub(struct sp_port *port, const char *hub_name,
29 const char *parent_path);
31 static char *wc_to_utf8(PWCHAR wc_buffer, ULONG size)
33 WCHAR wc_str[(size / sizeof(WCHAR)) + 1];
36 /* Zero-terminate the wide char string. */
37 memcpy(wc_str, wc_buffer, size);
38 wc_str[sizeof(wc_str) - 1] = 0;
40 /* Compute the size of the UTF-8 converted string. */
41 if (!(size = WideCharToMultiByte(CP_ACP, WC_NO_BEST_FIT_CHARS, wc_str, -1,
42 NULL, 0, NULL, NULL)))
45 /* Allocate UTF-8 output buffer. */
46 if (!(utf8_str = malloc(size)))
49 /* Actually converted to UTF-8. */
50 if (!WideCharToMultiByte(CP_ACP, WC_NO_BEST_FIT_CHARS, wc_str, -1,
51 utf8_str, size, NULL, NULL)) {
59 static char *get_root_hub_name(HANDLE host_controller)
61 USB_ROOT_HUB_NAME root_hub_name;
62 PUSB_ROOT_HUB_NAME root_hub_name_wc;
63 char *root_hub_name_utf8;
66 /* Compute the size of the root hub name string. */
67 if (!DeviceIoControl(host_controller, IOCTL_USB_GET_ROOT_HUB_NAME, 0, 0,
68 &root_hub_name, sizeof(root_hub_name), &size, NULL))
71 /* Allocate wide char root hub name string. */
72 size = root_hub_name.ActualLength;
73 if (!(root_hub_name_wc = malloc(size)))
76 /* Actually get the root hub name string. */
77 if (!DeviceIoControl(host_controller, IOCTL_USB_GET_ROOT_HUB_NAME,
78 NULL, 0, root_hub_name_wc, size, &size, NULL)) {
79 free(root_hub_name_wc);
83 /* Convert the root hub name string to UTF-8. */
84 root_hub_name_utf8 = wc_to_utf8(root_hub_name_wc->RootHubName, size);
85 free(root_hub_name_wc);
86 return root_hub_name_utf8;
89 static char *get_external_hub_name(HANDLE hub, ULONG connection_index)
91 USB_NODE_CONNECTION_NAME ext_hub_name;
92 PUSB_NODE_CONNECTION_NAME ext_hub_name_wc;
93 char *ext_hub_name_utf8;
96 /* Compute the size of the external hub name string. */
97 ext_hub_name.ConnectionIndex = connection_index;
98 if (!DeviceIoControl(hub, IOCTL_USB_GET_NODE_CONNECTION_NAME,
99 &ext_hub_name, sizeof(ext_hub_name),
100 &ext_hub_name, sizeof(ext_hub_name), &size, NULL))
103 /* Allocate wide char external hub name string. */
104 size = ext_hub_name.ActualLength;
105 if (size <= sizeof(ext_hub_name)
106 || !(ext_hub_name_wc = malloc(size)))
109 /* Get the name of the external hub attached to the specified port. */
110 ext_hub_name_wc->ConnectionIndex = connection_index;
111 if (!DeviceIoControl(hub, IOCTL_USB_GET_NODE_CONNECTION_NAME,
112 ext_hub_name_wc, size,
113 ext_hub_name_wc, size, &size, NULL)) {
114 free(ext_hub_name_wc);
118 /* Convert the external hub name string to UTF-8. */
119 ext_hub_name_utf8 = wc_to_utf8(ext_hub_name_wc->NodeName, size);
120 free(ext_hub_name_wc);
121 return ext_hub_name_utf8;
124 static char *get_string_descriptor(HANDLE hub_device, ULONG connection_index,
125 UCHAR descriptor_index)
127 char desc_req_buf[sizeof(USB_DESCRIPTOR_REQUEST) +
128 MAXIMUM_USB_STRING_LENGTH] = { 0 };
129 PUSB_DESCRIPTOR_REQUEST desc_req = (void *)desc_req_buf;
130 PUSB_STRING_DESCRIPTOR desc = (void *)(desc_req + 1);
131 ULONG size = sizeof(desc_req_buf);
133 desc_req->ConnectionIndex = connection_index;
134 desc_req->SetupPacket.wValue = (USB_STRING_DESCRIPTOR_TYPE << 8)
136 desc_req->SetupPacket.wIndex = 0;
137 desc_req->SetupPacket.wLength = size - sizeof(*desc_req);
139 if (!DeviceIoControl(hub_device,
140 IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION,
141 desc_req, size, desc_req, size, &size, NULL)
143 || desc->bDescriptorType != USB_STRING_DESCRIPTOR_TYPE
144 || desc->bLength != size - sizeof(*desc_req)
145 || desc->bLength % 2)
148 return wc_to_utf8(desc->bString, desc->bLength);
151 static void enumerate_hub_ports(struct sp_port *port, HANDLE hub_device,
152 ULONG nb_ports, const char *parent_path)
154 char path[MAX_USB_PATH];
157 for (index = 1; index <= nb_ports; index++) {
158 PUSB_NODE_CONNECTION_INFORMATION_EX connection_info_ex;
159 ULONG size = sizeof(*connection_info_ex) + (30 * sizeof(USB_PIPE_INFO));
161 if (!(connection_info_ex = malloc(size)))
164 connection_info_ex->ConnectionIndex = index;
165 if (!DeviceIoControl(hub_device,
166 IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX,
167 connection_info_ex, size,
168 connection_info_ex, size, &size, NULL)) {
170 * Try to get CONNECTION_INFORMATION if
171 * CONNECTION_INFORMATION_EX did not work.
173 PUSB_NODE_CONNECTION_INFORMATION connection_info;
175 size = sizeof(*connection_info) + (30 * sizeof(USB_PIPE_INFO));
176 if (!(connection_info = malloc(size))) {
177 free(connection_info_ex);
180 connection_info->ConnectionIndex = index;
181 if (!DeviceIoControl(hub_device,
182 IOCTL_USB_GET_NODE_CONNECTION_INFORMATION,
183 connection_info, size,
184 connection_info, size, &size, NULL)) {
185 free(connection_info);
186 free(connection_info_ex);
190 connection_info_ex->ConnectionIndex = connection_info->ConnectionIndex;
191 connection_info_ex->DeviceDescriptor = connection_info->DeviceDescriptor;
192 connection_info_ex->DeviceIsHub = connection_info->DeviceIsHub;
193 connection_info_ex->DeviceAddress = connection_info->DeviceAddress;
194 free(connection_info);
197 if (connection_info_ex->DeviceIsHub) {
198 /* Recursively enumerate external hub. */
200 if ((ext_hub_name = get_external_hub_name(hub_device, index))) {
201 snprintf(path, sizeof(path), "%s%ld.",
202 parent_path, connection_info_ex->ConnectionIndex);
203 enumerate_hub(port, ext_hub_name, path);
205 free(connection_info_ex);
207 snprintf(path, sizeof(path), "%s%ld",
208 parent_path, connection_info_ex->ConnectionIndex);
210 /* Check if this device is the one we search for. */
211 if (strcmp(path, port->usb_path)) {
212 free(connection_info_ex);
216 /* Finally grab detailed information regarding the device. */
217 port->usb_address = connection_info_ex->DeviceAddress + 1;
218 port->usb_vid = connection_info_ex->DeviceDescriptor.idVendor;
219 port->usb_pid = connection_info_ex->DeviceDescriptor.idProduct;
221 if (connection_info_ex->DeviceDescriptor.iManufacturer)
222 port->usb_manufacturer = get_string_descriptor(hub_device,index,
223 connection_info_ex->DeviceDescriptor.iManufacturer);
224 if (connection_info_ex->DeviceDescriptor.iProduct)
225 port->usb_product = get_string_descriptor(hub_device, index,
226 connection_info_ex->DeviceDescriptor.iProduct);
227 if (connection_info_ex->DeviceDescriptor.iSerialNumber)
228 port->usb_serial = get_string_descriptor(hub_device, index,
229 connection_info_ex->DeviceDescriptor.iSerialNumber);
231 free(connection_info_ex);
237 static void enumerate_hub(struct sp_port *port, const char *hub_name,
238 const char *parent_path)
240 USB_NODE_INFORMATION hub_info;
242 ULONG size = sizeof(hub_info);
245 /* Open the hub with its full name. */
246 if (!(device_name = malloc(strlen("\\\\.\\") + strlen(hub_name) + 1)))
248 strcpy(device_name, "\\\\.\\");
249 strcat(device_name, hub_name);
250 hub_device = CreateFile(device_name, GENERIC_WRITE, FILE_SHARE_WRITE,
251 NULL, OPEN_EXISTING, 0, NULL);
253 if (hub_device == INVALID_HANDLE_VALUE)
256 /* Get the number of ports of the hub. */
257 if (DeviceIoControl(hub_device, IOCTL_USB_GET_NODE_INFORMATION,
258 &hub_info, size, &hub_info, size, &size, NULL))
259 /* Enumerate the ports of the hub. */
260 enumerate_hub_ports(port, hub_device,
261 hub_info.u.HubInformation.HubDescriptor.bNumberOfPorts, parent_path);
263 CloseHandle(hub_device);
266 static void enumerate_host_controller(struct sp_port *port,
267 HANDLE host_controller_device)
271 if ((root_hub_name = get_root_hub_name(host_controller_device))) {
272 enumerate_hub(port, root_hub_name, "");
277 static void get_usb_details(struct sp_port *port, DEVINST dev_inst_match)
279 HDEVINFO device_info;
280 SP_DEVINFO_DATA device_info_data;
283 device_info = SetupDiGetClassDevs(&GUID_CLASS_USB_HOST_CONTROLLER, NULL, NULL,
284 DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
285 device_info_data.cbSize = sizeof(device_info_data);
287 for (i = 0; SetupDiEnumDeviceInfo(device_info, i, &device_info_data); i++) {
288 SP_DEVICE_INTERFACE_DATA device_interface_data;
289 PSP_DEVICE_INTERFACE_DETAIL_DATA device_detail_data;
290 DEVINST dev_inst = dev_inst_match;
291 HANDLE host_controller_device;
293 device_interface_data.cbSize = sizeof(device_interface_data);
294 if (!SetupDiEnumDeviceInterfaces(device_info, 0,
295 &GUID_CLASS_USB_HOST_CONTROLLER,
296 i, &device_interface_data))
299 if (!SetupDiGetDeviceInterfaceDetail(device_info,&device_interface_data,
300 NULL, 0, &size, NULL)
301 && GetLastError() != ERROR_INSUFFICIENT_BUFFER)
304 if (!(device_detail_data = malloc(size)))
306 device_detail_data->cbSize = sizeof(*device_detail_data);
307 if (!SetupDiGetDeviceInterfaceDetail(device_info,&device_interface_data,
308 device_detail_data, size, &size,
310 free(device_detail_data);
314 while (CM_Get_Parent(&dev_inst, dev_inst, 0) == CR_SUCCESS
315 && dev_inst != device_info_data.DevInst) { }
316 if (dev_inst != device_info_data.DevInst) {
317 free(device_detail_data);
321 port->usb_bus = i + 1;
323 host_controller_device = CreateFile(device_detail_data->DevicePath,
324 GENERIC_WRITE, FILE_SHARE_WRITE,
325 NULL, OPEN_EXISTING, 0, NULL);
326 if (host_controller_device != INVALID_HANDLE_VALUE) {
327 enumerate_host_controller(port, host_controller_device);
328 CloseHandle(host_controller_device);
330 free(device_detail_data);
333 SetupDiDestroyDeviceInfoList(device_info);
337 SP_PRIV enum sp_return get_port_details(struct sp_port *port)
340 * Description limited to 127 char, anything longer
341 * would not be user friendly anyway.
343 char description[128];
344 SP_DEVINFO_DATA device_info_data = { .cbSize = sizeof(device_info_data) };
345 HDEVINFO device_info;
348 device_info = SetupDiGetClassDevs(NULL, 0, 0,
349 DIGCF_PRESENT | DIGCF_ALLCLASSES);
350 if (device_info == INVALID_HANDLE_VALUE)
351 RETURN_FAIL("SetupDiGetClassDevs() failed");
353 for (i = 0; SetupDiEnumDeviceInfo(device_info, i, &device_info_data); i++) {
356 char value[8], class[16];
360 /* Check if this is the device we are looking for. */
361 device_key = SetupDiOpenDevRegKey(device_info, &device_info_data,
363 DIREG_DEV, KEY_QUERY_VALUE);
364 if (device_key == INVALID_HANDLE_VALUE)
366 size = sizeof(value);
367 if (RegQueryValueExA(device_key, "PortName", NULL, &type, (LPBYTE)value,
368 &size) != ERROR_SUCCESS || type != REG_SZ) {
369 RegCloseKey(device_key);
372 RegCloseKey(device_key);
373 value[sizeof(value)-1] = 0;
374 if (strcmp(value, port->name))
377 /* Check port transport type. */
378 dev_inst = device_info_data.DevInst;
379 size = sizeof(class);
381 while (CM_Get_Parent(&dev_inst, dev_inst, 0) == CR_SUCCESS &&
382 (cr = CM_Get_DevNode_Registry_PropertyA(dev_inst,
383 CM_DRP_CLASS, 0, class, &size, 0)) != CR_SUCCESS) { }
384 if (cr == CR_SUCCESS) {
385 if (!strcmp(class, "USB"))
386 port->transport = SP_TRANSPORT_USB;
389 /* Get port description (friendly name). */
390 dev_inst = device_info_data.DevInst;
391 size = sizeof(description);
392 while ((cr = CM_Get_DevNode_Registry_PropertyA(dev_inst,
393 CM_DRP_FRIENDLYNAME, 0, description, &size, 0)) != CR_SUCCESS
394 && CM_Get_Parent(&dev_inst, dev_inst, 0) == CR_SUCCESS) { }
395 if (cr == CR_SUCCESS)
396 port->description = strdup(description);
398 /* Get more informations for USB connected ports. */
399 if (port->transport == SP_TRANSPORT_USB) {
400 char usb_path[MAX_USB_PATH] = "", tmp[MAX_USB_PATH];
401 char device_id[MAX_DEVICE_ID_LEN];
403 /* Recurse over parents to build the USB device path. */
404 dev_inst = device_info_data.DevInst;
406 /* Verify that this layer of the tree is USB related. */
407 if (CM_Get_Device_IDA(dev_inst, device_id,
408 sizeof(device_id), 0) != CR_SUCCESS
409 || strncmp(device_id, "USB\\", 4))
412 /* Discard one layer for composite devices. */
413 char compat_ids[512], *p = compat_ids;
414 size = sizeof(compat_ids);
415 if (CM_Get_DevNode_Registry_PropertyA(dev_inst,
416 CM_DRP_COMPATIBLEIDS, 0,
418 &size, 0) == CR_SUCCESS) {
420 if (!strncmp(p, "USB\\COMPOSITE", 13))
428 /* Stop the recursion when reaching the USB root. */
429 if (!strncmp(device_id, "USB\\ROOT", 8))
432 /* Prepend the address of current USB layer to the USB path. */
434 size = sizeof(address);
435 if (CM_Get_DevNode_Registry_PropertyA(dev_inst, CM_DRP_ADDRESS,
436 0, &address, &size, 0) == CR_SUCCESS) {
437 strcpy(tmp, usb_path);
438 snprintf(usb_path, sizeof(usb_path), "%d%s%s",
439 (int)address, *tmp ? "." : "", tmp);
441 } while (CM_Get_Parent(&dev_inst, dev_inst, 0) == CR_SUCCESS);
443 port->usb_path = strdup(usb_path);
445 /* Wake up the USB device to be able to read string descriptor. */
446 char *escaped_port_name;
448 if (!(escaped_port_name = malloc(strlen(port->name) + 5)))
449 RETURN_ERROR(SP_ERR_MEM, "Escaped port name malloc failed");
450 sprintf(escaped_port_name, "\\\\.\\%s", port->name);
451 handle = CreateFile(escaped_port_name, GENERIC_READ, 0, 0,
453 FILE_ATTRIBUTE_NORMAL|FILE_FLAG_OVERLAPPED, 0);
454 free(escaped_port_name);
457 /* Retrieve USB device details from the device descriptor. */
458 get_usb_details(port, device_info_data.DevInst);
463 SetupDiDestroyDeviceInfoList(device_info);
468 SP_PRIV enum sp_return list_ports(struct sp_port ***list)
472 DWORD max_value_len, max_data_size, max_data_len;
473 DWORD value_len, data_size, data_len;
474 DWORD type, index = 0;
479 DEBUG("Opening registry key");
480 if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
481 0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) {
482 SET_FAIL(ret, "RegOpenKeyEx() failed");
485 DEBUG("Querying registry key value and data sizes");
486 if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
487 &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) {
488 SET_FAIL(ret, "RegQueryInfoKey() failed");
491 max_data_len = max_data_size / sizeof(TCHAR);
492 if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) {
493 SET_ERROR(ret, SP_ERR_MEM, "Registry value malloc failed");
496 if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) {
497 SET_ERROR(ret, SP_ERR_MEM, "Registry data malloc failed");
500 DEBUG("Iterating over values");
502 value_len = max_value_len + 1,
503 data_size = max_data_size,
504 RegEnumValue(key, index, value, &value_len,
505 NULL, &type, (LPBYTE)data, &data_size) == ERROR_SUCCESS)
507 if (type == REG_SZ) {
508 data_len = data_size / sizeof(TCHAR);
509 data[data_len] = '\0';
511 name_len = WideCharToMultiByte(CP_ACP, 0, data, -1, NULL, 0, NULL, NULL);
513 name_len = data_len + 1;
515 if (!(name = malloc(name_len))) {
516 SET_ERROR(ret, SP_ERR_MEM, "Registry port name malloc failed");
520 WideCharToMultiByte(CP_ACP, 0, data, -1, name, name_len, NULL, NULL);
524 DEBUG_FMT("Found port %s", name);
525 if (!(*list = list_append(*list, name))) {
526 SET_ERROR(ret, SP_ERR_MEM, "List append failed");