Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Windows desktop app for a USB device

In this topic you'll learn about how an application can call WinUSB Functions to communicate with a USB device. For such an application, WinUSB (Winusb.sys) must be installed as the device's function driver. WinUSB in the device's kernel-mode stack. This driver is included in Windows in the \Windows\System32\drivers folder.

If you are using Winusb.sys as a USB device's function driver, you can call WinUSB Functions from an application to communicate with the device. These functions, exposed by the user-mode DLL Winusb.dll, simplify the communication process. Instead of constructing device I/O control requests to perform standard USB operations (such as configuring the device, sending control requests, and transferring data to or from the device), applications call the equivalent WinUSB function.

Winusb.dll uses the application-supplied data to construct the appropriate device I/O control request, and then sends the request to Winusb.sys for processing. To communicate with the USB stack, the WinUSB function calls the DeviceIoControl function with the appropriate IOCTL that correlates to the application's request. When the request is complete, the WinUSB function passes any information returned by Winusb.sys (such as data from a read request) back to the calling process. If the call to DeviceIoControl is successful, it returns a nonzero value. If the call fails or is pending (not processed immediately), DeviceIoControl returns a zero value. In case of an error, the application can call GetLastError for a more detailed error message.

It is simpler to use WinUSB functions to communicate with a device than it is to implement a driver. However, note the following limitations:

  • WinUSB functions allow one application at a time to communicate with the device. If you require more than one application to communicate concurrently with a device, you must implement a function driver.
  • Before Windows 8.1, WinUSB functions do not support streaming data to or from isochronous endpoints.
  • WinUSB functions do not support devices that already have kernel-mode support. Examples of such devices include modems and network adapters, which are supported by the telephony API (TAPI) and NDIS, respectively.
  • For multifunction devices, you can use the device's INF file to specify either an in-box kernel-mode driver or Winusb.sys for each USB function separately. However, you can specify only one of these options for a particular function, not both.

Note  WinUSB functions require Windows XP or later. You can use these functions in your C/C++ application to communicate with your USB device. To write a Windows Store app that uses WinUSB APIs, see Windows Store app for a USB device.

Getting started...

StepDescription

Step 1—Get the tools you need to write a Windows desktop app for devices.

Note  Visual Studio must be installed before installing the WDK 8.1.
 

Step 2—Obtain a test USB device and its hardware specification. Use the specification to determine the functionality of the app and the related design decisions.

For learning purposes, popular choices are:

  • OSR USB FX2 learning kit. The kit is the most suitable to study USB samples included in this documentation set. You can get the learning kit from OSR Online.
  • Microsoft USB Test Tool (MUTT) devices. MUTT hardware can be purchased from JJG Technologies. The device does not have installed firmware installed. To install firmware, download the MUTT software package from this Web site and run MUTTUtil.exe. For more information, see the documentation included with the package.

Step 3—Write a skeleton app that obtains a handle to the device.

You can write your first app in one of two ways:

Step 6—Install Winusb.sys for your device.

Install Winusb.sys for your device.

Step 4—Get information about your device and view its descriptors. For conceptual information, see Concepts for all USB developers.

Get information about your device capabilities by reading the configuration descriptor, interface descriptors for each supported alternate settings, and their endpoint descriptors.

For information, see Query the Device for USB Descriptors.

Step 5—Send a USB control transfer from your app.

Send standard control requests and vendor commands to your device. For more information, see Send Control Transfer to the Default Endpoint.

Step 6—Send bulk or interrupt transfers from your app.

Perform read and write operations to and from the bulk, interrupt, and isochronous endpoints supported by your device. For more information, see Issue I/O Requests.

Step 7—Send isochronous transfers from your app.

Send isochronous read and write requests, mostly used for streaming data. This feature is only available on Windows 8.1. For more information, see Sending USB isochronous transfers from a WinUSB desktop app.

 

Related topics

Developing Windows applications for USB devices
Universal Serial Bus (USB)

 

 

Send comments about this topic to Microsoft

Show: