27#include <winpr/cmdline.h>
28#include <winpr/collections.h>
30#include <freerdp/addin.h>
32#include "urbdrc_types.h"
33#include "urbdrc_main.h"
35#include "libusb_udevice.h"
39#if !defined(LIBUSB_HOTPLUG_NO_FLAGS)
40#define LIBUSB_HOTPLUG_NO_FLAGS 0
43#define BASIC_STATE_FUNC_DEFINED(_arg, _type) \
44 static _type udevman_get_##_arg(IUDEVMAN* idevman) \
46 UDEVMAN* udevman = (UDEVMAN*)idevman; \
47 return udevman->_arg; \
49 static void udevman_set_##_arg(IUDEVMAN* idevman, _type _t) \
51 UDEVMAN* udevman = (UDEVMAN*)idevman; \
55#define BASIC_STATE_FUNC_REGISTER(_arg, _man) \
56 _man->iface.get_##_arg = udevman_get_##_arg; \
57 (_man)->iface.set_##_arg = udevman_set_##_arg
73 LPCSTR devices_vid_pid;
75 wArrayList* hotplug_vid_pids;
78 UINT32 next_device_id;
81 HANDLE devman_loading;
82 libusb_context* context;
86typedef UDEVMAN* PUDEVMAN;
88static BOOL poll_libusb_events(UDEVMAN* udevman);
90static void udevman_rewind(IUDEVMAN* idevman)
92 UDEVMAN* udevman = (UDEVMAN*)idevman;
93 udevman->idev = udevman->head;
96static BOOL udevman_has_next(IUDEVMAN* idevman)
98 UDEVMAN* udevman = (UDEVMAN*)idevman;
100 return !(!udevman || !udevman->idev);
103static IUDEVICE* udevman_get_next(IUDEVMAN* idevman)
105 UDEVMAN* udevman = (UDEVMAN*)idevman;
106 IUDEVICE* pdev =
nullptr;
107 pdev = udevman->idev;
108 udevman->idev = (IUDEVICE*)((
UDEVICE*)udevman->idev)->next;
112static IUDEVICE* udevman_get_udevice_by_addr(IUDEVMAN* idevman, BYTE bus_number, BYTE dev_number)
114 IUDEVICE* dev =
nullptr;
119 idevman->loading_lock(idevman);
120 idevman->rewind(idevman);
122 while (idevman->has_next(idevman))
124 IUDEVICE* pdev = idevman->get_next(idevman);
126 if ((pdev->get_bus_number(pdev) == bus_number) &&
127 (pdev->get_dev_number(pdev) == dev_number))
134 idevman->loading_unlock(idevman);
138static size_t udevman_register_udevice(IUDEVMAN* idevman, BYTE bus_number, BYTE dev_number,
139 UINT16 idVendor, UINT16 idProduct, UINT32 flag)
141 UDEVMAN* udevman = (UDEVMAN*)idevman;
142 IUDEVICE* pdev =
nullptr;
143 IUDEVICE** devArray =
nullptr;
148 if (!idevman || !idevman->plugin)
152 pdev = udevman_get_udevice_by_addr(idevman, bus_number, dev_number);
157 if (flag & UDEVMAN_FLAG_ADD_BY_ADDR)
160 IUDEVICE* tdev = udev_new_by_addr(urbdrc, udevman->context, bus_number, dev_number);
165 id = idevman->get_next_device_id(idevman);
166 tdev->set_UsbDevice(tdev,
id);
167 idevman->loading_lock(idevman);
169 if (udevman->head ==
nullptr)
172 udevman->head = tdev;
173 udevman->tail = tdev;
178 udevman->tail->set_p_next(udevman->tail, tdev);
179 tdev->set_p_prev(tdev, udevman->tail);
180 udevman->tail = tdev;
183 udevman->device_num += 1;
184 idevman->loading_unlock(idevman);
186 else if (flag & UDEVMAN_FLAG_ADD_BY_VID_PID)
190 num = udev_new_by_id(urbdrc, udevman->context, idVendor, idProduct, &devArray);
194 WLog_Print(urbdrc->log, WLOG_WARN,
195 "Could not find or redirect any usb devices by id %04x:%04x", idVendor,
199 for (
size_t i = 0; i < num; i++)
202 IUDEVICE* tdev = devArray[i];
204 if (udevman_get_udevice_by_addr(idevman, tdev->get_bus_number(tdev),
205 tdev->get_dev_number(tdev)) !=
nullptr)
208 devArray[i] =
nullptr;
212 id = idevman->get_next_device_id(idevman);
213 tdev->set_UsbDevice(tdev,
id);
214 idevman->loading_lock(idevman);
216 if (udevman->head ==
nullptr)
219 udevman->head = tdev;
220 udevman->tail = tdev;
225 udevman->tail->set_p_next(udevman->tail, tdev);
226 tdev->set_p_prev(tdev, udevman->tail);
227 udevman->tail = tdev;
230 udevman->device_num += 1;
231 idevman->loading_unlock(idevman);
235 free((
void*)devArray);
240 WLog_Print(urbdrc->log, WLOG_ERROR,
"udevman_register_udevice: Invalid flag=%08" PRIx32,
248static BOOL udevman_unregister_udevice(IUDEVMAN* idevman, BYTE bus_number, BYTE dev_number)
250 UDEVMAN* udevman = (UDEVMAN*)idevman;
252 UDEVICE* dev = (
UDEVICE*)udevman_get_udevice_by_addr(idevman, bus_number, dev_number);
254 if (!dev || !idevman)
257 idevman->loading_lock(idevman);
258 idevman->rewind(idevman);
260 while (idevman->has_next(idevman))
262 pdev = (
UDEVICE*)idevman->get_next(idevman);
267 if (dev->prev !=
nullptr)
271 pdev->next = dev->next;
276 udevman->head = (IUDEVICE*)dev->next;
281 if (dev->next !=
nullptr)
285 pdev->prev = dev->prev;
290 udevman->tail = (IUDEVICE*)dev->prev;
293 udevman->device_num--;
298 idevman->loading_unlock(idevman);
302 dev->iface.free(&dev->iface);
310static BOOL udevman_unregister_all_udevices(IUDEVMAN* idevman)
312 UDEVMAN* udevman = (UDEVMAN*)idevman;
320 idevman->loading_lock(idevman);
321 idevman->rewind(idevman);
323 while (idevman->has_next(idevman))
331 if (dev->prev !=
nullptr)
335 pdev->next = dev->next;
340 udevman->head = (IUDEVICE*)dev->next;
345 if (dev->next !=
nullptr)
349 pdev->prev = dev->prev;
354 udevman->tail = (IUDEVICE*)dev->prev;
357 dev->iface.free(&dev->iface);
358 udevman->device_num--;
361 idevman->loading_unlock(idevman);
366static int udevman_is_auto_add(IUDEVMAN* idevman)
368 UDEVMAN* udevman = (UDEVMAN*)idevman;
369 return (udevman->flags & UDEVMAN_FLAG_ADD_BY_AUTO) ? 1 : 0;
372static IUDEVICE* udevman_get_udevice_by_UsbDevice(IUDEVMAN* idevman, UINT32 UsbDevice)
377 if (!idevman || !idevman->plugin)
381 UsbDevice = UsbDevice & INTERFACE_ID_MASK;
383 idevman->loading_lock(idevman);
384 idevman->rewind(idevman);
386 while (idevman->has_next(idevman))
388 pdev = (
UDEVICE*)idevman->get_next(idevman);
390 if (pdev->UsbDevice == UsbDevice)
392 idevman->loading_unlock(idevman);
393 return (IUDEVICE*)pdev;
397 idevman->loading_unlock(idevman);
398 WLog_Print(urbdrc->log, WLOG_WARN,
"Failed to find a USB device mapped to deviceId=%08" PRIx32,
403static IUDEVICE* udevman_get_udevice_by_ChannelID(IUDEVMAN* idevman, UINT32 channelID)
408 if (!idevman || !idevman->plugin)
413 idevman->loading_lock(idevman);
414 idevman->rewind(idevman);
416 while (idevman->has_next(idevman))
418 pdev = (
UDEVICE*)idevman->get_next(idevman);
420 if (pdev->channelID == channelID)
422 idevman->loading_unlock(idevman);
423 return (IUDEVICE*)pdev;
427 idevman->loading_unlock(idevman);
428 WLog_Print(urbdrc->log, WLOG_WARN,
"Failed to find a USB device mapped to channelID=%08" PRIx32,
433static void udevman_loading_lock(IUDEVMAN* idevman)
435 UDEVMAN* udevman = (UDEVMAN*)idevman;
436 (void)WaitForSingleObject(udevman->devman_loading, INFINITE);
439static void udevman_loading_unlock(IUDEVMAN* idevman)
441 UDEVMAN* udevman = (UDEVMAN*)idevman;
442 (void)ReleaseMutex(udevman->devman_loading);
445BASIC_STATE_FUNC_DEFINED(device_num, UINT32)
447static UINT32 udevman_get_next_device_id(IUDEVMAN* idevman)
449 UDEVMAN* udevman = (UDEVMAN*)idevman;
450 return udevman->next_device_id++;
453static void udevman_set_next_device_id(IUDEVMAN* idevman, UINT32 _t)
455 UDEVMAN* udevman = (UDEVMAN*)idevman;
456 udevman->next_device_id = _t;
459static void udevman_free(IUDEVMAN* idevman)
461 UDEVMAN* udevman = (UDEVMAN*)idevman;
466 udevman->running = FALSE;
469 (void)WaitForSingleObject(udevman->thread, INFINITE);
470 (void)CloseHandle(udevman->thread);
473 udevman_unregister_all_udevices(idevman);
475 if (udevman->devman_loading)
476 (void)CloseHandle(udevman->devman_loading);
478 libusb_exit(udevman->context);
480 ArrayList_Free(udevman->hotplug_vid_pids);
484static BOOL filter_by_class(uint8_t bDeviceClass, uint8_t bDeviceSubClass)
486 switch (bDeviceClass)
488 case LIBUSB_CLASS_AUDIO:
489 case LIBUSB_CLASS_HID:
490 case LIBUSB_CLASS_MASS_STORAGE:
491 case LIBUSB_CLASS_HUB:
492 case LIBUSB_CLASS_SMART_CARD:
498 switch (bDeviceSubClass)
507static BOOL append(
char* dst,
size_t length,
const char* src)
509 return winpr_str_append(src, dst, length,
nullptr);
512static BOOL device_is_filtered(
struct libusb_device* dev,
513 const struct libusb_device_descriptor* desc,
514 libusb_hotplug_event event)
516 char buffer[8192] = WINPR_C_ARRAY_INIT;
517 char* what =
nullptr;
518 BOOL filtered = FALSE;
519 append(buffer,
sizeof(buffer), usb_interface_class_to_string(desc->bDeviceClass));
520 if (filter_by_class(desc->bDeviceClass, desc->bDeviceSubClass))
523 switch (desc->bDeviceClass)
525 case LIBUSB_CLASS_PER_INTERFACE:
527 struct libusb_config_descriptor* config =
nullptr;
528 int rc = libusb_get_active_config_descriptor(dev, &config);
529 if (rc == LIBUSB_SUCCESS)
531 for (uint8_t x = 0; x < config->bNumInterfaces; x++)
533 const struct libusb_interface* ifc = &config->interface[x];
534 for (
int y = 0; y < ifc->num_altsetting; y++)
536 const struct libusb_interface_descriptor*
const alt = &ifc->altsetting[y];
537 if (filter_by_class(alt->bInterfaceClass, alt->bInterfaceSubClass))
540 append(buffer,
sizeof(buffer),
"|");
541 append(buffer,
sizeof(buffer),
542 usb_interface_class_to_string(alt->bInterfaceClass));
546 libusb_free_config_descriptor(config);
559 case LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT:
560 what =
"Hotplug remove";
562 case LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED:
563 what =
"Hotplug add";
566 what =
"Hotplug unknown";
571 WLog_DBG(TAG,
"%s device VID=0x%04X,PID=0x%04X class %s", what, desc->idVendor, desc->idProduct,
576static int LIBUSB_CALL hotplug_callback(
struct libusb_context* ctx,
struct libusb_device* dev,
577 libusb_hotplug_event event,
void* user_data)
580 struct libusb_device_descriptor desc;
581 UDEVMAN* udevman = (UDEVMAN*)user_data;
582 const uint8_t bus = libusb_get_bus_number(dev);
583 const uint8_t addr = libusb_get_device_address(dev);
584 int rc = libusb_get_device_descriptor(dev, &desc);
588 if (rc != LIBUSB_SUCCESS)
593 case LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED:
594 pair.vid = desc.idVendor;
595 pair.pid = desc.idProduct;
596 if ((ArrayList_Contains(udevman->hotplug_vid_pids, &pair)) ||
597 (udevman->iface.isAutoAdd(&udevman->iface) &&
598 !device_is_filtered(dev, &desc, event)))
600 add_device(&udevman->iface, DEVICE_ADD_FLAG_ALL, bus, addr, desc.idVendor,
605 case LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT:
606 del_device(&udevman->iface, DEVICE_ADD_FLAG_ALL, bus, addr, desc.idVendor,
617static BOOL udevman_initialize(IUDEVMAN* idevman, UINT32 channelId)
619 UDEVMAN* udevman = (UDEVMAN*)idevman;
624 idevman->status &= (uint32_t)~URBDRC_DEVICE_CHANNEL_CLOSED;
625 idevman->controlChannelId = channelId;
629static BOOL udevman_vid_pid_pair_equals(
const void* objA,
const void* objB)
631 const VID_PID_PAIR* a = objA;
632 const VID_PID_PAIR* b = objB;
634 return (a->vid == b->vid) && (a->pid == b->pid);
637static BOOL udevman_parse_device_id_addr(
const char** str, UINT16* id1, UINT16* id2, UINT16 max,
638 char split_sign,
char delimiter)
642 unsigned long rc = 0;
644 rc = strtoul(*str, &mid, 16);
646 if ((mid == *str) || (*mid != split_sign) || (rc > max))
650 rc = strtoul(++mid, &end, 16);
652 if ((end == mid) || (rc > max))
660 if (*end == delimiter)
669static UINT urbdrc_udevman_register_devices(UDEVMAN* udevman,
const char* devices, BOOL add_by_addr)
671 const char* pos = devices;
677 if (!udevman_parse_device_id_addr(&pos, &id1, &id2, (add_by_addr) ? UINT8_MAX : UINT16_MAX,
680 WLog_ERR(TAG,
"Invalid device argument: \"%s\"", devices);
681 return CHANNEL_RC_INITIALIZATION_ERROR;
686 if (!add_device(&udevman->iface, DEVICE_ADD_FLAG_BUS | DEVICE_ADD_FLAG_DEV, (UINT8)id1,
688 return CHANNEL_RC_INITIALIZATION_ERROR;
692 VID_PID_PAIR* idpair = calloc(1,
sizeof(VID_PID_PAIR));
694 return CHANNEL_RC_NO_MEMORY;
697 if (!ArrayList_Append(udevman->hotplug_vid_pids, idpair))
700 return CHANNEL_RC_NO_MEMORY;
704 if (!add_device(&udevman->iface, DEVICE_ADD_FLAG_VENDOR | DEVICE_ADD_FLAG_PRODUCT, 0, 0,
708 return CHANNEL_RC_INITIALIZATION_ERROR;
714 return CHANNEL_RC_OK;
717static UINT urbdrc_udevman_parse_addin_args(UDEVMAN* udevman,
const ADDIN_ARGV* args)
719 LPCSTR devices =
nullptr;
721 for (
int x = 0; x < args->argc; x++)
723 const char* arg = args->argv[x];
724 if (strcmp(arg,
"dbg") == 0)
726 WLog_SetLogLevel(WLog_Get(TAG), WLOG_TRACE);
728 else if (_strnicmp(arg,
"device:", 7) == 0)
731 const char* val = &arg[7];
732 const size_t len = strlen(val);
733 if (strcmp(val,
"*") == 0)
735 udevman->flags |= UDEVMAN_FLAG_ADD_BY_AUTO;
737 else if (_strnicmp(arg,
"USBInstanceID:", 14) == 0)
741 else if ((val[0] ==
'{') && (val[len - 1] ==
'}'))
746 else if (_strnicmp(arg,
"dev:", 4) == 0)
750 else if (_strnicmp(arg,
"id", 2) == 0)
752 const char* p = strchr(arg,
':');
754 udevman->devices_vid_pid = p + 1;
756 udevman->flags = UDEVMAN_FLAG_ADD_BY_VID_PID;
758 else if (_strnicmp(arg,
"addr", 4) == 0)
760 const char* p = strchr(arg,
':');
762 udevman->devices_addr = p + 1;
764 udevman->flags = UDEVMAN_FLAG_ADD_BY_ADDR;
766 else if (strcmp(arg,
"auto") == 0)
768 udevman->flags |= UDEVMAN_FLAG_ADD_BY_AUTO;
772 const size_t len = strlen(arg);
773 if ((arg[0] ==
'{') && (arg[len - 1] ==
'}'))
781 if (udevman->flags & UDEVMAN_FLAG_ADD_BY_VID_PID)
782 udevman->devices_vid_pid = devices;
783 else if (udevman->flags & UDEVMAN_FLAG_ADD_BY_ADDR)
784 udevman->devices_addr = devices;
787 return CHANNEL_RC_OK;
790static UINT udevman_listener_created_callback(IUDEVMAN* iudevman)
792 UDEVMAN* udevman = (UDEVMAN*)iudevman;
793 WINPR_ASSERT(udevman);
795 if (udevman->devices_vid_pid)
796 return urbdrc_udevman_register_devices(udevman, udevman->devices_vid_pid, FALSE);
798 if (udevman->devices_addr)
799 return urbdrc_udevman_register_devices(udevman, udevman->devices_addr, TRUE);
801 return CHANNEL_RC_OK;
804static void udevman_load_interface(UDEVMAN* udevman)
807 udevman->iface.free = udevman_free;
809 udevman->iface.rewind = udevman_rewind;
810 udevman->iface.get_next = udevman_get_next;
811 udevman->iface.has_next = udevman_has_next;
812 udevman->iface.register_udevice = udevman_register_udevice;
813 udevman->iface.unregister_udevice = udevman_unregister_udevice;
814 udevman->iface.get_udevice_by_UsbDevice = udevman_get_udevice_by_UsbDevice;
815 udevman->iface.get_udevice_by_ChannelID = udevman_get_udevice_by_ChannelID;
817 udevman->iface.isAutoAdd = udevman_is_auto_add;
819 BASIC_STATE_FUNC_REGISTER(device_num, udevman);
820 BASIC_STATE_FUNC_REGISTER(next_device_id, udevman);
823 udevman->iface.loading_lock = udevman_loading_lock;
824 udevman->iface.loading_unlock = udevman_loading_unlock;
825 udevman->iface.initialize = udevman_initialize;
826 udevman->iface.listener_created_callback = udevman_listener_created_callback;
829static BOOL poll_libusb_events(UDEVMAN* udevman)
831 int rc = LIBUSB_SUCCESS;
832 struct timeval tv = { 0, 500 };
833 if (libusb_try_lock_events(udevman->context) == 0)
835 if (libusb_event_handling_ok(udevman->context))
837 rc = libusb_handle_events_locked(udevman->context, &tv);
838 if (rc != LIBUSB_SUCCESS)
839 WLog_WARN(TAG,
"libusb_handle_events_locked %d", rc);
841 libusb_unlock_events(udevman->context);
845 libusb_lock_event_waiters(udevman->context);
846 if (libusb_event_handler_active(udevman->context))
848 rc = libusb_wait_for_event(udevman->context, &tv);
849 if (rc < LIBUSB_SUCCESS)
850 WLog_WARN(TAG,
"libusb_wait_for_event %d", rc);
852 libusb_unlock_event_waiters(udevman->context);
858static DWORD WINAPI poll_thread(LPVOID lpThreadParameter)
860 libusb_hotplug_callback_handle handle = 0;
861 UDEVMAN* udevman = (UDEVMAN*)lpThreadParameter;
862 BOOL hasHotplug = libusb_has_capability(LIBUSB_CAP_HAS_HOTPLUG);
866 int rc = libusb_hotplug_register_callback(
868 LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED | LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT,
869 LIBUSB_HOTPLUG_NO_FLAGS, LIBUSB_HOTPLUG_MATCH_ANY, LIBUSB_HOTPLUG_MATCH_ANY,
870 LIBUSB_HOTPLUG_MATCH_ANY, hotplug_callback, udevman, &handle);
872 if (rc != LIBUSB_SUCCESS)
873 udevman->running = FALSE;
876 WLog_WARN(TAG,
"Platform does not support libusb hotplug. USB devices plugged in later "
877 "will not be detected.");
879 while (udevman->running)
881 poll_libusb_events(udevman);
885 libusb_hotplug_deregister_callback(udevman->context, handle);
888 while (poll_libusb_events(udevman))
895FREERDP_ENTRY_POINT(UINT VCAPITYPE libusb_freerdp_urbdrc_client_subsystem_entry(
900 UDEVMAN* udevman =
nullptr;
902 udevman = (PUDEVMAN)calloc(1,
sizeof(UDEVMAN));
907 udevman->hotplug_vid_pids = ArrayList_New(TRUE);
908 if (!udevman->hotplug_vid_pids)
910 obj = ArrayList_Object(udevman->hotplug_vid_pids);
914 udevman->next_device_id = BASE_USBDEVICE_NUM;
915 udevman->iface.plugin = pEntryPoints->plugin;
918 const int res = libusb_init(&udevman->context);
919 if (res != LIBUSB_SUCCESS)
924#if LIBUSB_API_VERSION >= 0x01000106
926 const int rc = libusb_set_option(udevman->context, LIBUSB_OPTION_USE_USBDK);
931 case LIBUSB_ERROR_NOT_FOUND:
932 case LIBUSB_ERROR_NOT_SUPPORTED:
933 WLog_WARN(TAG,
"LIBUSB_OPTION_USE_USBDK %s [%d]", libusb_strerror(rc), rc);
936 WLog_ERR(TAG,
"LIBUSB_OPTION_USE_USBDK %s [%d]", libusb_strerror(rc), rc);
942 udevman->flags = UDEVMAN_FLAG_ADD_BY_VID_PID;
943 udevman->devman_loading = CreateMutexA(
nullptr, FALSE,
"devman_loading");
945 if (!udevman->devman_loading)
949 udevman_load_interface(udevman);
950 status = urbdrc_udevman_parse_addin_args(udevman, args);
952 if (status != CHANNEL_RC_OK)
955 udevman->running = TRUE;
956 udevman->thread = CreateThread(
nullptr, 0, poll_thread, udevman, 0,
nullptr);
958 if (!udevman->thread)
961 if (!pEntryPoints->pRegisterUDEVMAN(pEntryPoints->plugin, (IUDEVMAN*)udevman))
964 WLog_DBG(TAG,
"UDEVMAN device registered.");
967 udevman_free(&udevman->iface);
968 return ERROR_INTERNAL_ERROR;
This struct contains function pointer to initialize/free objects.
OBJECT_FREE_FN fnObjectFree
OBJECT_EQUALS_FN fnObjectEquals