How to write your first USB client driver (KMDF)

In this topic you’ll use the USB Kernel-Mode Driver template provided with Microsoft Visual Studio ProfessionalВ 2019 to write a simple kernel-mode driver framework (KMDF)-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.

For an explanation about the source code generated by the template, see Understanding the KMDF template code for a USB client driver.

Prerequisites

For developing, debugging, and installing a kernel-mode driver, you need two computers:

• A host computer running WindowsВ 7 or a later version of the Windows operating system. The host computer is your development environment, where you write and debug your driver.
• A target computer running WindowsВ Vista or a later version of Windows. The target computer has the kernel-mode driver that you want to debug.

Before you begin, make sure that you meet the following requirements:

Software requirements

• Your host computer hosts your development environment and has Visual Studio ProfessionalВ 2019.
• Your host computer has the latest Windows Driver Kit (WDK) for WindowsВ 8. The kit include headers, libraries, tools, documentation, and the debugging tools required to develop, build, and debug a KMDF driver. To get the latest version of the WDK, see Download the Windows Driver Kit (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.
• Your target computer is running WindowsВ Vista or a later version of Windows.
• Your host and target computers are configured for kernel debugging. For more information, see Setting Up a Network Connection in Visual Studio.

Hardware requirements

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. You can get the learning kit from OSR Online. It contains the USB FX2 device and all the required hardware specifications to implement a client driver.

You can also get a 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.

Recommended reading

Instructions

Step 1: Generate the KMDF driver code by using the Visual Studio ProfessionalВ 2019 USB driver template

For instructions about generating KMDF driver code, see the steps in Writing a KMDF driver based on a template.

For USB-specific code, select the following options in Visual Studio ProfessionalВ 2019

1. In the New Project dialog box, in the search box at the top, type USB.
2. In the middle pane, select Kernel Mode Driver, USB (KMDF).
3. Select Next.
4. Enter a project name, choose a save location, and select Create.

The following screen shots show the New Project dialog box for the USB Kernel-Mode Driver template.

This topic assumes that the name of the Visual Studio project is «MyUSBDriver_». It contains the following files:

Files	Description
Public.h	Provides common declarations shared by the client driver and user applications that communicate with the USB device.
.inf	Contains information required to install the client driver on the target computer.
Trace.h	Declares tracing functions and macros.
Driver.h; Driver.c	Declares and defines driver entry points and event callback routines.
Device.h; Device.c	Declares and defines event callback routine for the prepare-hardware event.
Queue.h; Queue.c	Declares and defines an event callback routine for the event raised by the framework’s queue object.

Step 2: Modify the INF file to add information about your device

Before you build the driver, you must modify the template INF file with information about your device, specifically the hardware ID string.

In Solution Explorer, under Driver Files, double-click the INF file.

In the INF file you can provide information such as the manufacturer and provider name, the device setup class, and so on. One piece of information that you must provide is the hardware identifier of your device.

To provide 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.

Replace USB\VID_vvvv&PID_pppp in the following line with your hardware ID string.

[Standard.NT$ARCH$] %MyUSBDriver_.DeviceDesc%=MyUSBDriver__Device, USB\VID_vvvv&PID_pppp

Step 3: Build the USB client driver code

To build your driver

1. Open the driver project or solution in Visual Studio ProfessionalВ 2019
2. Select and hold (or right-click) the solution in the Solution Explorer and select Configuration Manager.
3. From the Configuration Manager, select the Active Solution Configuration (for example, WindowsВ 8 Debug or WindowsВ 8 Release) and the Active Solution Platform (for example, Win32) that correspond to the type of build you’re interested in.
4. From the Build menu, select Build Solution.

For more information, see Building a Driver.

Step 4: Configure a computer for testing and debugging

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.

Step 5: Enable tracing for kernel debugging

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.

To configure your host computer for WPP tracing

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 Windows Kits\8.0\bin\ 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:

.load Wmitrace

Loads the Wmitrace.dll extension.

.chain

Verify that the debugger extension is loaded.

!wmitrace.searchpath +

Add the location of the TMF files to the debugger extension’s search path.

The output resembles this:

Trace Format search path is: ‘C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE;c:\drivers\tmf’

To configure your target computer for WPP tracing

Make sure you have the Tracelog tool on your target computer. The tool is located in the Windows Kits\8.0\Tools\ folder of the WDK. For more information, see Tracelog Command Syntax.

Open a Command Window and run as administrator.

Type the following command:

tracelog -start MyTrace -guid #c918ee71-68c7-4140-8f7d-c907abbcb05d -flag 0xFFFF -level 7-rt -kd

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 Professional 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:

tracelog -start MyTrace -guid c:\drivers\Provider.guid -flag 0xFFFF -level 7-rt -kd

You can stop the trace session by typing the following command:

tracelog -stop MyTrace

Step 6: Deploy the driver on the target computer

In the Solution Explorer window, select and hold (or right-click) the

Package , and choose Properties.

In the left pane, navigate to Configuration Properties > Driver Install > Deployment.

Check Enable deployment, and check Import into driver store.

For Remote Computer Name, specify the name of the target computer.

Select Install and Verify.

Select Ok.

On the Debug menu, choose Start Debugging, or press F5 on the keyboard.

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.

For more information about deploying the driver to the target system in Visual Studio ProfessionalВ 2019, see Deploying a Driver to a Test Computer.

You can also manually install the driver on the target computer by using Device Manager. If you want to install the driver from a command prompt, these utilities are available:

This tool comes with the Windows. It is in Windows\System32. You can use this utility to add the driver to the driver store.

For more information, see PnPUtil Examples.

This tool comes with the WDK. You can use it to install and update drivers.

Step 7: View the driver in Device Manager

Enter the following command to open Device Manager:

devmgmt

Verify that Device Manager shows a node for the following node:

Samples

MyUSBDriver_Device

Step 8: View the output in the debugger

Visual Studio first displays progress in the Output window. Then it opens the Debugger Immediate Window. Verify that trace messages appear in the debugger on the host computer. The output should look like this, where «MyUSBDriver_» is the name of the driver module:

Find a PC that fits

Do your best learning, working, and playing with a Windows 10 PC. Find one that fits your style and budget.

Discover the benefits of a new PC

When it comes to a PC with an SSD vs. one with an HDD, some things are just better.

Up to 4x faster Up to 4x faster

1 «>Redefine your sense of speed. PCs with SSDs: 4x faster on average than HDDs. 1 Redefine your sense of speed. PCs with SSDs: 4x faster on average than HDDs. 1

Get up to 34% longer battery life¹ ² Get up to 34% longer battery life¹ ²

2 «>Because SSDs consume less power, you get longer battery life—on average, eight-plus hours of video playback. 2 Because SSDs consume less power, you get longer battery life—on average, eight-plus hours of video playback. 2

Transfer files 37.9% faster with USB 3.0 Transfer files 37.9% faster with USB 3.0

1 «>Share moments in moments. Copy large files like home videos from USB 3.0 drives 37.9% faster on average with a solid-state drive. 1 Share moments in moments. Copy large files like home videos from USB 3.0 drives 37.9% faster on average with a solid-state drive. 1

Install Windows Updates 3x faster Install Windows Updates 3x faster

1 «>Windows Updates: Install them 3x faster (on average) with a solid-state drive. 1 Windows Updates: Install them 3x faster (on average) with a solid-state drive. 1

Get started with PC hardware basics

Learn about key PC hardware components so that you can make informed decisions when shopping for a new device.

What is it?

SSD is a type of storage drive similar to a traditional hard disk drive (HDD).

Why does it matter?

Without moving parts, SSDs are thinner, faster, and more durable than HDDs, allowing for smaller PCs with greater battery life. 2

What is it?

RAM is your PC’s “working” memory.

Why does it matter?

It helps with performance when doing things like running apps and browser tabs. More RAM means you can do more things at the same time.

What is it?

The brain of your PC. It tells the other components in it what to do.

Why does it matter?

It performs the instructions the operating system tells it to. Without it, your PC doesn’t run.

What is it?

It helps your PC do graphics-intensive tasks, like photo or video editing and games.

Why does it matter?

It frees your CPU for other tasks, allowing for better performance.

Discover the latest PC innovations

From powerful productivity and security to thinner devices with stunning touch screen displays, Windows 10 PCs provide what you need to get the job done. 3

ASUS ZenBook Pro Duo

HP Spectre x360 15

Lenovo Yoga C940

Browse by PC type

If you’re still unsure on where to begin, starting with the PC type will give you a wide range to choose from.

Thin, light laptops

It’s everything you love and more—portability, power, and the latest in processors.

Desktops & All-in-Ones

Get the muscle you need for demanding tasks without sacrificing style.

Versatile 2-in-1s

2-in-1s provide power and flexibility. Touch, type, click, or pen—choose whatever fits your style.

Gaming PCs

A Windows 10 gaming PC gives you more power, more features and more games.