In this topic you'll use the USB User-Mode Driver template provided with Microsoft Visual Studio 2019 to write a user-mode driver framework (UMDF)-based client driver. After building and installing the client driver, you'll view the client driver in Device Manager and view the driver output in a debugger.
UMDF (referred to as the framework in this topic) is based on the component object model (COM). Every framework object must implement IUnknown and its methods, QueryInterface, AddRef, and Release, by default. The AddRef and Release methods manage the object's lifetime, so the client driver does not need to maintain the reference count. The QueryInterface method enables the client driver to get interface pointers to other framework objects in the Windows Driver Frameworks (WDF) object model. Framework objects perform complicated driver tasks and interact with Windows. Certain framework objects expose interfaces that enable a client driver to interact with the framework.
SMI USB DISK USB Device - Driver Download. Vendor:. Product: SMI USB DISK USB Device. Hardware Class: DiskDrive. Search For More Drivers.: Go! Windows 10 32-Bit Driver. To install, open Device Manager Universal Serial Bus controllers right-click USB Root Hub (USB 3.0) Uninstall Device reboot PC. To re-install a specific device, navigate to the above but select Properties Driver Update Driver to install from your PC. Need a Bluetooth Driver for your accessory? If you are having Bluetooth trouble, updates should be available through Microsoft's Windows Update service. If drivers were not downloaded automatically by Windows Update, use Device Manager to refresh the driver from Windows Update, or contact the device manufacturer.
A UMDF-based client driver is implemented as an in-process COM server (DLL), and C++ is the preferred language for writing a client driver for a USB device. Typically, the client driver implements several interfaces exposed by the framework. This topic refers to a client driver-defined class that implements framework interfaces as a callback class. After these classes are instantiated, the resulting callback objects are partnered with particular framework objects. This partnership gives the client driver the opportunity to respond to device or system-related events that are reported by the framework. Whenever Windows notifies the framework about certain events, the framework invokes the client driver's callback, if one is available. Otherwise the framework proceeds with the default processing of the event. The template code defines driver, device, and queue callback classes.
For an explanation about the source code generated by the template, see Understanding the UMDF template code for USB client driver.
For developing, debugging, and installing a user-mode driver, you need two computers:
In some cases, where the host and target computers are running the same version of Windows, you can have just one computer running Windows 7 or a later version of the Windows. This topic assumes that you are using two computers for developing, debugging, and installing your user mode driver.
Before you begin, make sure that you meet the following requirements:
Your host computer has Visual Studio 2019.
Your host computer has the latest Windows Driver Kit (WDK) for Windows 10, version 1903.
The kit include headers, libraries, tools, documentation, and the debugging tools required to develop, build, and debug a USB client driver. You can get the latest version of the WDK from How to Get the WDK.
Your host computer has the latest version of debugging tools for Windows. You can get the latest version from the WDK or you can Download and Install Debugging Tools for Windows.
If you are using two computers, you must configure the host and target computers for user-mode debugging. For more information, see Setting Up User-Mode Debugging in Visual Studio.
Get a USB device for which you will be writing the client driver. In most cases, you are provided with a USB device and its hardware specification. The specification describes device capabilities and the supported vendor commands. Use the specification to determine the functionality of the USB driver and the related design decisions.
If you are new to USB driver development, use the OSR USB FX2 learning kit to study USB samples included with the WDK. It contains the USB FX2 device and all the required hardware specifications to implement a client driver.


For instructions about generating UMDF driver code, see Writing a UMDF driver based on a template.
The following screen shots show the New Project dialog box for the USB User-Mode Driver template.
This topic assumes that the name of the project is 'MyUSBDriver_UMDF_'. It contains the following files:
| Files | Description |
|---|---|
| Driver.h; Driver.c | Declares and defines a callback class that implements the IDriverEntry interface. The class defines methods that are invoked by the framework driver object. The main purpose of this class is to create a device object for the client driver. |
| Device.h; Device.c | Declares and defines a callback class that implements the IPnpCallbackHardware interface. The class defines methods that are invoked by the framework device object. The main purpose of this class is to handle events occurring as a result of Plug and Play (PnP) state changes. The class also allocates and initializes resources required by the client driver as long as it is loaded in the system. |
| IoQueue.h; IoQueue.c | Declares and defines a callback class that implements the IQueueCallbackDeviceIoControl interface. The class defines methods that are invoked by the framework queue object. The purpose of this class is to retrieve I/O requests that are queued in the framework. |
| Internal.h | Provides common declarations shared by the client driver and user applications that communicate with the USB device. It also declares tracing functions and macros. |
| Dllsup.cpp | Contains the implementation of the driver module's entry point. |
| <Project name>.inf | INF file that is required to install the client driver on the target computer. |
| Exports.def | DEF file that exports the entry point function name of the driver module. |
Before you build the driver, you must modify the template INF file with information about your device, specifically the hardware ID string.
Attach your USB device to your host computer and let Windows enumerate the device.
Open Device Manager and open properties for your device.
On the Details tab, select Hardward Ids under Property.
The hardware ID for the device is displayed in the list box. Select and hold (or right-click) and copy the hardware ID string.
In Solution Explorer, expand Driver Files, and open the INF.
Replace the following your hardware ID string.
[Standard.NT$ARCH$]
%DeviceName%=MyDevice_Install, USBVID_vvvv&PID_pppp
Notice the AddReg entries in the driver's information (INF) file.

[CoInstallers_AddReg] ;
HKR,CoInstallers32,0x00010008,'WudfCoinstaller.dll'
HKR,CoInstallers32,0x00010008,'WudfUpdate_01011.dll'
HKR,CoInstallers32,0x00010008,'WdfCoInstaller01011.dll,WdfCoInstaller'
HKR,CoInstallers32,0x00010008,'WinUsbCoinstaller2.dll'
If your INF AddReg directive references the UMDF redistributable co-installer (WUDFUpdate_<version>.dll ), you must not make a reference to the configuration co-installer (WUDFCoInstaller.dll). Referencing both co-installers in the INF will lead to installation errors.
All UMDF-based USB client drivers require two Microsoft-provided drivers: the reflector and WinUSB.
Reflector—If your driver gets loaded successfully, the reflector is loaded as the top-most driver in the kernel-mode stack. The reflector must be the top driver in the kernel mode stack. To meet this requirement, the template's INF file specifies the reflector as a service and WinUSB as a lower-filter driver in the INF:
[MyDevice_Install.NT.Services]
AddService=WUDFRd,0x000001fa,WUDFRD_ServiceInstall ; flag 0x2 sets this as the service for the device
AddService=WinUsb,0x000001f8,WinUsb_ServiceInstall ; this service is installed because its a filter.
WinUSB—The installation package must contain coinstallers for Winusb.sys because for the client driver, WinUSB is the gateway to the kernel-mode USB driver stack. Another component that gets loaded is a user-mode DLL, named WinUsb.dll, in the client driver's host process (Wudfhost.exe). Winusb.dll exposes WinUSB Functions that simplify the communication process between the client driver and WinUSB.
To build your driver
MyUSBDriverUMDFCreateDevice in Device.c. When you create your project with the name 'MyUSBDriver_UMDF_', Visual Studio 2019 defines the device interface GUID with the name GUID_DEVINTERFACE_MyUSBDriver_UMDF_ but calls WdfDeviceCreateDeviceInterface with the incorrect parameter 'GUID_DEVINTERFACE_MyUSBDriverUMDF'. Replace the incorrect parameter with the name defined in Trace.h to ensure that the driver builds properly.For more information, see Building a Driver.
To test and debug a driver, you run the debugger on the host computer and the driver on the target computer. So far, you have used Visual Studio on the host computer to build a driver. Next you need to configure a target computer. To configure a target computer, follow the instructions in Provision a computer for driver deployment and testing.
The template code contains several trace messages (TraceEvents) that can help you track function calls. All functions in the source code contain trace messages that mark the entry and exit of a routine. For errors, the trace message contains the error code and a meaningful string. Because WPP tracing is enabled for your driver project, the PDB symbol file created during the build process contains trace message formatting instructions. If you configure the host and target computers for WPP tracing, your driver can send trace messages to a file or the debugger.
Create trace message format (TMF) files by extracting trace message formatting instructions from the PDB symbol file.
You can use Tracepdb.exe to create TMF files. The tool is located in the <install folder>Windows Kits10bin<architecture> folder of the WDK. The following command creates TMF files for the driver project.
tracepdb -f [PDBFiles] -p [TMFDirectory]
The -f option specifies the location and the name of the PDB symbol file. The -p option specifies the location for the TMF files that are created by Tracepdb. For more information, see Tracepdb Commands.
At the specified location you'll see three files (one per .c file in the project). They are given GUID file names.
In the debugger, type the following commands:
These commands:
The output resembles this:
The command starts a trace session named MyTrace.
The guid argument specifies the GUID of the trace provider, which is the client driver. You can get the GUID from Trace.h in the Visual Studio 2019 project. As another option, you can type the following command and specify the GUID in a .guid file. The file contains the GUID in hyphen format:

You can stop the trace session by typing the following command:
Note
Do not specify the hardware ID of your device under Hardware ID Driver Update. The hardware ID must be specified only in your driver's information (INF) file.
Enter the following command to open Device Manager.
devmgmt
Verify that Device Manager shows the following node.
USB Device
MyUSBDriver_UMDF_Device
Verify that trace messages appear in the Debugger Immediate Window on the host computer.
The output should be similar to the following:
Let’s take a look at how the framework and the client driver work together to interact with Windows and handle requests sent to the USB device. This illustration shows the modules loaded in the system for a UMDF -based USB client driver.
The purpose of each module is described here:
Whenever an application makes a request for the USB driver stack, the Windows I/O manager sends the request to the reflector, which directs it to client driver in user mode. The client driver handles the request by calling specific UMDF methods, which internally call WinUSB Functions to send the request to WinUSB. Upon receiving the request, WinUSB either processes the request or forwards it to the USB driver stack.
Understanding the UMDF template code for USB client driver
How to enable USB selective suspend and system wake in the UMDF driver for a USB device
Getting started with USB client driver development
Features | Documentation | Knowledge Base | Discussion Forums
The following sections describe how to use USB devices in a virtual machine:
VMware Workstation 4 provides a two-port USB 1.1 controller. You can use up to two USB devices in your virtual machine if both your host operating system and your guest operating system support USB. If your host computer supports USB 2.0 devices, you can use those devices in the virtual machine.
Note: Windows NT and Linux kernels older than 2.2.17 do not support USB.
Although your host operating system must support USB, you do not need to install device-specific drivers for your USB devices in the host operating system if you want to use those devices only in the virtual machine.
On a Windows 2000 host computer with USB 2.0 support, be sure you are using the Microsoft USB 2.0 driver for the USB controller. Third-party USB 2.0 drivers, such as those provided by some motherboard manufacturers, are not supported. For notes on replacing the third-party drivers, see Replacing USB 2.0 Drivers on a Windows 2000 Host.
We have tested a variety of USB devices with this release. In general, if the guest operating system has appropriate drivers, you should be able to use PDAs, printers, storage (disk) devices, scanners, MP3 players, digital cameras and memory card readers.
Modems and certain streaming data devices, such as speakers and Web cams, do not work properly.
The virtual machine's USB ports are enabled by default. If you will not be using USB devices in a virtual machine, you can disable its USB controller using the virtual machine settings editor.
When a virtual machine is running, its window is the active window and a USB device is plugged into the host computer, the device automatically connects to the guest instead of the host. This autoconnect feature can be disabled in the USB Controller panel of the virtual machine settings editor (VM > Settings). If all of the virtual machine's USB ports are already occupied when it is trying to connect automatically to a new device, a dialog box gives you a choice: you can either disconnect one of the existing USB devices to free its port or ignore the new device, allowing the device to connect to the host.
Choose VM > Removable Devices to connect specific USB devices to your virtual machine. You can connect up to two USB devices at a time. If the physical USB devices are connected to the host computer through a hub, the virtual machine sees only the USB devices, not the hub.
There is a menu item for each of the USB ports. Move the mouse over one of these items to see a cascading menu of devices that are plugged into your host computer and available for use. To connect a device to the virtual machine, click its name.
If a device is already connected to that port, click the name of a new device to release the first device and connect the new one.
To release a connected device, click None on the cascading menu for the port to which it is connected.
If you physically plug a new device into the host computer and the autoconnect feature does not connect it to a virtual machine, the device is initially connected to the host. Its name is also added to the VM > Removable Devices menu so you can connect it to the virtual machine manually.
Windows 2000, Windows XP and Windows Server 2003 hosts: When a particular USB device is connected to a virtual machine for the first time, the host detects it as a new device named VMware USB Device and installs the appropriate VMware driver.
Windows XP and Windows Server 2003 hosts: User confirmation is required in the Found New Hardware Wizard. Select the default action — Install the software automatically. Once the software is installed, the guest operating system detects the USB device and searches for a suitable driver.
When you are synchronizing a PDA, such as a Palm handheld or Handspring Visor, to a virtual machine for the first time, the total time required to load the VMware USB device driver in the host and the PDA driver in the guest may exceed the device's connection timeout value. This causes the device to disconnect itself from the computer before the guest can synchronize with it. If this occurs, let the guest finish installing the PDA driver, dismiss any connection error warnings, then try synchronizing the PDA again. The second attempt should succeed.
To use VMware Workstation 4 on a Windows 2000 host that has USB 2.0 ports, you must use the Microsoft USB 2.0 drivers for the USB controller in the host operating system. If your host operating system is using a third-party driver — a driver supplied by your motherboard vendor, for example — you must replace it.
Take the following steps to check the provider of your driver:
If the driver provider is not Microsoft, download the latest USB driver for your host operating system from the Microsoft Web site and follow the Microsoft instructions to install it. Details are available in Microsoft knowledge base article 319973.
Any user on a Windows host can connect USB devices for use in a virtual machine. You no longer need administrative privileges on the host to connect a USB device to a virtual machine.
This functionality is not enabled by default. To enable it, you must use a text editor such as Notepad to add one line to the global configuration file. This file is
C:Documents and Settings<username>Application DataVMwareconfig.ini
Add the following line anywhere in the file:
usb.EnablePnpMgr = TRUE
Note: A user with administrative privileges on the host operating system must install a USB device on the host before it can be connected by users who do not have administrative privileges.
On Linux hosts, VMware Workstation uses the USB device file system to connect to USB devices. In most Linux systems that support USB, the USB device file system is at /proc/bus/usb. If your host operating system uses a different path to the USB device file system, you can change it in the virtual machine settings editor (VM > Settings > USB). Enter the correct path in the Path to usbdevfs field.

Only one computer — host or guest — can have control of a USB device at any one time.
When you connect a device to a virtual machine, it is 'unplugged' from the host or from the virtual machine that previously had control of the device. When you disconnect a device from a virtual machine, it is 'plugged in' to the host.
Caution: On Windows 2000, Windows XP and Windows Server 2003 hosts, you need to take a special step to disconnect USB network and storage devices from the host. There is a system tray icon called Eject Hardware on Windows 2000 and Safely Remove Hardware on Windows XP and Windows Server 2003. Use this icon to disconnect the device from the host before connecting it to a virtual machine.
Note: On Windows 2000, Windows XP and Windows Server 2003 hosts, when you connect a USB network or storage device in a virtual machine, you may see a message on your host that says the device can be removed safely. This is normal behavior, and you can simply dismiss the dialog box. However, do not remove the device from your physical computer. VMware Workstation automatically transfers control of the device to the virtual machine.
Under some circumstances, if a USB storage device is in use on the host (for example, one or more files stored on the device are open on the host), an error appears in the virtual machine when you try to connect to the device. You must let the host complete its operation or close any application connected to the device on the host, then connect to the device in the virtual machine again.
On Linux hosts, guest operating systems can use devices that are not already in use by the host — that is, devices that are not claimed by a host operating system driver.
If your device is in use by the host and you try to connect it to the guest using the VM > Removable Devices menu, a dialog box appears, informing you that there is a problem connecting to the device.
To disconnect the device from the host, you must unload the device driver. You can unload the driver manually as root (su) using the rmmod command. Or, if the driver was automatically loaded by hotplug, you can disable it in the hotplug configuration files in the /etc/hotplug directory. See your Linux distribution's documentation for details on editing these configuration files.
A related issue sometimes affects devices that rely on automatic connection (as PDAs often do).
If you have successfully used autoconnection to connect the device to your virtual machine, then experience problems with the connection to the device, take the following steps:
Before unplugging a USB device or using the VM > Removable Devices menu to disconnect it from a virtual machine, be sure it is in a safe state.
You should follow the procedures the device manufacturer specifies for unplugging the device from a physical computer. This is true whether you are physically unplugging it, moving it from host to virtual machine, moving it between virtual machines or moving it from virtual machine to host.
This is particularly important with data storage devices (a Zip drive, for example). If you move a data storage device too soon after saving a file and the operating system has not actually written the data to the disk, you can lose data.
USB human interface devices, such as the keyboard and mouse, are not handled though the virtual machine's USB controller. Instead, they appear in the virtual machine as a standard PS/2 keyboard and mouse, even though they are plugged into USB ports on the host.
