• spice usbredir 调用 libusb
• libusb 调用usbdk

模块结构

结构图

classDiagram
CAllocatable --|> CWdmEvent
class CWdmEvent{
        m_Event
}
CIrpBase --|> CIoControlIrp
class CIrpBase{
        m_Event
}
class CUsbDkRedirection{
        m_RedirectionCreated
}
CUsbDkRedirection <|-- CWdmRefCountingObject
CUsbDkRedirection o-- CWdmEvent

• Device 系列继承关系

  classDiagram
  class CUsbDkFilterDevice{
        Create

}
class CWdfDevice{
Create
}
CUsbDkFilterDevice <|– CWdmRefCountingObject
CUsbDkFilterDevice <|– CWdfDevice
class CUsbDkControlDevice{
AddRedirect
RemoveRedirect
AddRedirectionToSet
NotifyRedirectorAttached
GetPDOByDeviceID
}
CUsbDkControlDevice <|– CWdfControlDevice
CUsbDkControlDevice o– RedirectionsSet
class CUsbDkControlDeviceQueue{
AddRedirect
}

• Strategy 系列继承关系

  classDiagram
  CUsbDkFilterStrategy --|> CUsbDkNullFilterStrategy
  CUsbDkNullFilterStrategy --|> CUsbDkHiderStrategy
  CUsbDkHiderStrategy --|> CUsbDkRedirectorStrategy
  CUsbDkRedirectorStrategy o-- CUsbDkFilterDevice
  CUsbDkRedirectorStrategy o-- CUsbDkControlDevice

• mEvent的修改点

flowchart LR
SendSynchronously --> ForwardAndWait
PostProcess --> ForwardAndWait
PostProcessOnSuccess --> PostProcess
PostProcessOnFailure --> PostProcess
CUsbDkHubFilterStrategy::PNPPreProcess --> PostProcessOnSuccess
CUsbDkHiderStrategy::PNPPreProcess --> PostProcessOnSuccess
CUsbDkHiderStrategy::PNPPreProcess --> PostProcessOnFailure
CWdmDeviceAccess::QueryForInterface --> SendSynchronously
CWdmDeviceAccess::QueryCapabilities --> SendSynchronously
CWdmDeviceAccess::QueryBusID --> SendSynchronously

应用层

LIBUSB 和USBDK的对接接口

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

static int load_usbdk_helper_dll(struct libusb_context *ctx)
{
        usbdk_helper.module = LoadLibraryA("UsbDkHelper");
        if (usbdk_helper.module == NULL) {
                usbi_err(ctx, "Failed to load UsbDkHelper.dll: %s", windows_error_str(0));
                return LIBUSB_ERROR_NOT_FOUND;
        }

        usbdk_helper.GetDevicesList = (USBDK_GET_DEVICES_LIST)get_usbdk_proc_addr(ctx, "UsbDk_GetDevicesList");
        if (usbdk_helper.GetDevicesList == NULL)
                goto error_unload;

        usbdk_helper.ReleaseDevicesList = (USBDK_RELEASE_DEVICES_LIST)get_usbdk_proc_addr(ctx, "UsbDk_ReleaseDevicesList");
        if (usbdk_helper.ReleaseDevicesList == NULL)
                goto error_unload;

        usbdk_helper.StartRedirect = (USBDK_START_REDIRECT)get_usbdk_proc_addr(ctx, "UsbDk_StartRedirect");
        if (usbdk_helper.StartRedirect == NULL)
                goto error_unload;

        usbdk_helper.StopRedirect = (USBDK_STOP_REDIRECT)get_usbdk_proc_addr(ctx, "UsbDk_StopRedirect");
        if (usbdk_helper.StopRedirect == NULL)
                goto error_unload;

        usbdk_helper.GetConfigurationDescriptor = (USBDK_GET_CONFIGURATION_DESCRIPTOR)get_usbdk_proc_addr(ctx, "UsbDk_GetConfigurationDescriptor");
        if (usbdk_helper.GetConfigurationDescriptor == NULL)
                goto error_unload;

        usbdk_helper.ReleaseConfigurationDescriptor = (USBDK_RELEASE_CONFIGURATION_DESCRIPTOR)get_usbdk_proc_addr(ctx, "UsbDk_ReleaseConfigurationDescriptor");
        if (usbdk_helper.ReleaseConfigurationDescriptor == NULL)
                goto error_unload;

        usbdk_helper.ReadPipe = (USBDK_READ_PIPE)get_usbdk_proc_addr(ctx, "UsbDk_ReadPipe");
        if (usbdk_helper.ReadPipe == NULL)
                goto error_unload;

        usbdk_helper.WritePipe = (USBDK_WRITE_PIPE)get_usbdk_proc_addr(ctx, "UsbDk_WritePipe");
        if (usbdk_helper.WritePipe == NULL)
                goto error_unload;

        usbdk_helper.AbortPipe = (USBDK_ABORT_PIPE)get_usbdk_proc_addr(ctx, "UsbDk_AbortPipe");
        if (usbdk_helper.AbortPipe == NULL)
                goto error_unload;

        usbdk_helper.ResetPipe = (USBDK_RESET_PIPE)get_usbdk_proc_addr(ctx, "UsbDk_ResetPipe");
        if (usbdk_helper.ResetPipe == NULL)
                goto error_unload;

UsbDk_StartRedirect

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

#UsbDkHelper/UsbDkHelper.cpp
HANDLE UsbDk_StartRedirect(PUSB_DK_DEVICE_ID DeviceID)
{
    try
    {
        unique_ptr<REDIRECTED_DEVICE_HANDLE> deviceHandle(new REDIRECTED_DEVICE_HANDLE);
        deviceHandle->DeviceID = *DeviceID;

        UsbDkDriverAccess driverAccess;
        deviceHandle->RedirectorAccess.reset(new UsbDkRedirectorAccess(driverAccess.AddRedirect(*DeviceID)));
        return reinterpret_cast<HANDLE>(deviceHandle.release());
    }
    catch (const exception &e)
    {
        printExceptionString(e.what());
        return INVALID_HANDLE_VALUE;
    }
}

• UsbDk_StartRedirect
  • new REDIRECTED_DEVICE_HANDLE
  • new UsbDkRedirectorAccess
  • UsbDkDriverAccess::AddRedirect
    • 发IOCTL_USBDK_ADD_REDIRECT消息给驱动层
  • UsbDkRedirectorAccess::reset

驱动层

入口函数

• CUsbDkControlDeviceQueue::DeviceControl

IOCTL_USBDK_ADD_REDIRECT

• CUsbDkControlDeviceQueue::AddRedirect
  • CUsbDkControlDevice::AddRedirect
    • CUsbDkControlDevice::ResetUsbDevice
      • CWdmUsbDeviceAccess::Reset
        • PoRequestPowerIrp IRP_MN_SET_POWER
        • CIoControlIrp::SendSynchronously IOCTL_INTERNAL_USB_CYCLE_PORT
      • CUsbDkRedirection::WaitForAttachment

CUsbDkFilterDeviceInit::Configure

在设备加载驱动阶段执行该函数，注册一些监听事件eg IRP_MJ_PNP

Hub的IRP_MJ_PNP 事件处理 CUsbDkHubFilterStrategy::PNPPreProcess

• hub设备，会监听其下设备的变动(有插入或者拔出时，回调其中注册的函数)
  调用如下函数
• CNonPagedDeviceRelations::Create
• CUsbDkHubFilterStrategy::DropRemovedDevices
• CUsbDkHubFilterStrategy::AddNewDevices

插入设备处理 CUsbDkHubFilterStrategy::AddNewDevices

• CUsbDkHubFilterStrategy::AddNewDevices
  • CUsbDkHubFilterStrategy::IsChildRegistered
  • CUsbDkHubFilterStrategy::RegisterNewChild
    • ::UsbDkGetWdmDeviceIdentity
      • CWdmDeviceAccess::GetDeviceID
      • CWdmDeviceAccess::GetInstanceID
    • CWdmUsbDeviceAccess::GetAddress
    • ::UsbDkWdmUsbDeviceGetSpeed
    • CWdmUsbDeviceAccess::GetDeviceDescriptor
    • new CUsbDkChildDevice
    • CWdmUsbDeviceAccess::Children().PushBack
    • CWdmUsbDeviceAccess::ApplyRedirectionPolicy
      • CUsbDkChildDevice::AttachToDeviceStack
        • WdfDriverWdmGetDriverObject::DriverExtension->AddDevice

对于Hub设备，调用到这里，就是对新插入的设备处理完毕，并且调用把新设备AddDevice

拔除设备处理 CUsbDkHubFilterStrategy::DropRemovedDevices

• CUsbDkHubFilterStrategy::DropRemovedDevices
  • CWdmUsbDeviceAccess::ToBeDeleted.PushBack
  • CUsbDkControlDevice::NotifyRedirectionRemoved
    • CUsbDkRedirection::NotifyRedirectionRemoved
      • 触发 m_RedirectionRemoved事件

设备的终止重定向 CUsbDkFilterStrategy::onClose

• CUsbDkFilterStrategy::onClose
  • CUsbDkControlDevice::RemoveRedirect

设备的 m_RedirectionRemoved事件

关于