summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2015-08-05 15:52:02 -0700
committerBarry Golden <[email protected]>2015-08-05 15:52:02 -0700
commitc1b6435d0629024acd3d3e6c7ef3a9822df8b3f7 (patch)
tree4eb66c69e95c2b1dd805ed46954840858f895422
parent3e4a88b4f645cab9b75f1e7ff6cf81c1b2fb21dc (diff)
Update README.md
-rw-r--r--README.md2
-rw-r--r--audio/sysvad/ReadMe.md95
-rw-r--r--avstream/avshws/ReadMe.md47
-rw-r--r--input/kbfiltr/ReadMe.md2
-rw-r--r--setup/devcon/ReadMe.md4
-rw-r--r--usb/kmdf_fx2/ReadMe.md204
-rw-r--r--usb/umdf_filter_kmdf/ReadMe.md34
7 files changed, 147 insertions, 241 deletions
diff --git a/README.md b/README.md
index a1e583e4..0ac20e55 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Use Visual Studio 2015 and Windows Driver Kit (WDK) 10 to build, test, and deplo
### Windows 10 Driver Kit (WDK)
Take a look at the compilation of the new and changed driver-related content for Windows 10. Areas of improvement include camera, print, display, Near Field Communication (NFC), WLAN, Bluetooth, and more.
-[Find out what’s new in the WDK](http://go.microsoft.com/fwlink/?LinkId=528349 "Find out what’s new in the WDK")
+[Find out what’s new in the WDK](http://go.microsoft.com/fwlink/p/?LinkId=528349 "Find out what's new in the WDK")
### Universal Windows drivers
Write one driver that runs on both Windows 10 for desktop editions and Windows 10 Mobile devices, as well as other Windows 10 editions that share a common set of interfaces.
diff --git a/audio/sysvad/ReadMe.md b/audio/sysvad/ReadMe.md
index ceaa2259..66650ead 100644
--- a/audio/sysvad/ReadMe.md
+++ b/audio/sysvad/ReadMe.md
@@ -24,79 +24,36 @@ If you simply want to Build this sample driver and don't intend to run or test i
Perform the following steps to build this sample driver.
-**1. Donwload and extract the sample**
+**1. Open the driver solution in Visual Studio**
-Click the download button on this page. Click **Save**, and then click **Open Folder**. Right click *Microsoft slate system virtual audio device driver sample.zip*, and choose **Extract All**. Specify a new folder, or browse to an existing one that will store the extracted files. For example, you could specify *c:\\SlateAudioSample* as the new folder into which the files will be extracted.
+In Microsoft Visual Studio, Click **File** \> **Open** \> **Project/Solution...** and navigate to the folder that contains the sample files (for example, *C:\Windows-driver-samples\audio\sysvad*). Double-click the *sysvad* solution file.
-**2. Open the driver solution in Visual Studio**
+In Visual Studio locate the Solution Explorer. (If this is not already open, choose **Solution Explorer** from the **View** menu.) In Solution Explorer, you can see one solution that has four projects. Note that the project titled SwapAPO is actually a folder that contains two projects - APO and PropPageExtensions.
-In Microsoft Visual Studio, Click **File** \> **Open** \> **Project/Solution...** and navigate to the folder that contains the extracted files (for example, *c:\\SlateAudioSample*). Double-click the *sysvad* solution file.
+**2. Set the sample's configuration and platform**
-In Visual Studio locate the Solution Explorer. (If this is not already open, choose **Solution Explorer** from the **View** menu.) In Solution Explorer, you can see one solution that has four (4) projects. Note that the project titled SwapAPO is actually a folder that contains two projects - APO and PropPageExtensions.
+In Solution Explorer, right-click **Solution 'sysvad' (4 projects)**, and choose **Configuration Manager**. Make sure that the configuration and platform settings are the same for the four projects. By default, the configuration is set to **Debug**, and the platform is set to **Win32** for all the projects. If you make any configuration and/or platform changes for one project, you must make the same changes for the remaining three projects.
-**3. Set the sample's configuration and platform**
-
-In Solution Explorer, right-click **Solution 'sysvad' (4 projects)**, and choose **Configuration Manager**. Make sure that the configuration and platform settings are the same for the four projects. By default, the configuration is set to "Win8.1 Debug", and the platform is set to "Win32" for all the projects. If you make any configuration and/or platform changes for one project, you must make the same changes for the remaining three projects.
-
-Here are the explanations for some of the configuration and platform options.
-
-<table>
-<colgroup>
-<col width="33%" />
-<col width="33%" />
-<col width="33%" />
-</colgroup>
-<thead>
-<tr class="header">
-<th align="left">Configuration
-Platform
-Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left">Win8.1 Debug
-x64
-The driver will run on an x64 hardware platform that is running Windows 8.1. The driver will not run on any earlier versions of Windows.</td>
-<td align="left">Win7 Debug
-x64
-The driver will run on an x64 hardware platform that is running Windows 7 or a later version of Windows. The driver will not run on any earlier versions of Windows.</td>
-</tr>
-</tbody>
-</table>
-
-**4. Build the sample using Visual Studio**
+**3. Build the sample using Visual Studio**
In Visual Studio, click **Build** \> **Build Solution**.
-**5. Locate the built driver package**
+**4. Locate the built driver package**
-In File Explorer, navigate to the folder that contains the extracted files for the sample. For example, you would navigate to *c:\\SlateAudioSample*, if that's the folder you specified in the preceding Step 1.
+In File Explorer, navigate to the folder that contains the files for the sample. For example, you would navigate to *C:\Windows-driver-samples\audio\sysvad*, if that's the folder you specified in the preceding Step 1.
-In the folder, the location of the driver package varies depending on the configuration and platform settings that you selected in the **Configuration Manager**. For example, if you left the default settings unchanged, then the built driver package will be saved to a folder named *Win8.1Debug* inside the same folder as the extracted files. Double-click the folder for the built driver package, and then double-click the folder named *package*.
+In the folder, the location of the driver package varies depending on the configuration and platform settings that you selected in the **Configuration Manager**. For example, if you left the default settings unchanged, then the built driver package will be saved to a folder named *Debug* inside the same folder as the extracted files. Double-click the folder for the built driver package, and then double-click the folder named *package*.
The package should contain these files:
-<table>
-<colgroup>
-<col width="50%" />
-<col width="50%" />
-</colgroup>
-<thead>
-<tr class="header">
-<th align="left">File
-Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left">PropPageExt.dll
-A sample driver extension for a property page.</td>
-<td align="left">SlateAudioSample.sys
-The driver file.</td>
-</tr>
-</tbody>
-</table>
+File | Description
+-----|------------
+PropPageExt.dll | A sample driver extension for a property page.
+SlateAudioSample.sys | The driver file.
+SwapAPO.dll | A sample driver extension for a UI to manage APOs.
+sysvad.cat | A signed catalog file, which serves as the signature for the entire package.
+sysvad.inf | An information (INF) file that contains information needed to install the driver.
+WdfCoinstaller01011.dll | The coinstaller for version 1.xx of KMDF.
Run the sample
--------------
@@ -105,7 +62,7 @@ The computer where you install the driver is called the *target computer* or the
The process of moving the driver package to the target computer and installing the driver is called *deploying* the driver. You can deploy the sample driver, SlateAudioSample, automatically or manually.
-**Automatic deployment**
+### Automatic deployment
Before you automatically deploy a driver, you must provision the target computer. Verify that the target computer has an ethernet cable connecting it to your local network, and that your host and target computers can ping each other. Then perform the following steps to prepare your host and target computers.
@@ -113,13 +70,13 @@ Before you automatically deploy a driver, you must provision the target computer
On the target computer install the latest [Windows Driver Kit](http://msdn.microsoft.com/en-us/windows/hardware/gg454513.aspx) (WDK), and then when the installation is completed, navigate to the following folder:
-\\Program Files (x86)\\Windows Kits\\8.1\\Remote\\\<architecture\>\\
+\\Program Files (x86)\\Windows Kits\\10\\Remote\\<*architecture*>\\
For example, if your target computer is an x64 machine, you would navigate to:
-\\Program Files (x86)\\Windows Kits\\8.1\\Remote\\x64\\
+\\Program Files (x86)\\Windows Kits\\10\\Remote\\x64\\
-Double-click the "*WDK Test Target Setup x64-x64\_en-us.msi*" file to run it. This program prepares the target computer for provisioning.
+Double-click the *WDK Test Target Setup x64-x64\_en-us.msi* file to run it. This program prepares the target computer for provisioning.
On the host computer, in Visual Studio click **Driver** \> **Test** \> **Configure Computers...**, and then click **Add a new computer**.
@@ -137,7 +94,7 @@ On the **Build** menu, choose **Deploy Package** or **Build Solution**. This wil
On the target computer, perform the steps in the **Test the sample** section to test the sample driver.
-**Manual deployment**
+### Manual deployment
Before you manually deploy a driver, you must prepare the target computer by turning on test signing and by installing a certificate. You also need to locate the DevCon tool in your WDK installation. After that you’re ready to run the built driver sample.
@@ -149,7 +106,7 @@ Open a Command Prompt window as Administrator. Then enter the following command:
Reboot the target computer. Then navigate to the Tools folder in your WDK installation and locate the DevCon tool. For example, look in the following folder:
-*C:\\Program Files (x86)\\Windows Kits\\8.1\\Tools\\x64\\devcon.exe*
+*C:\\Program Files (x86)\\Windows Kits\\10\\Tools\\x64\\devcon.exe*
Copy *devcon.exe* to a folder on the target computer where it is easier to find. For example, create a *C:\\Tools* folder and copy *devcon.exe* to that folder.
@@ -163,7 +120,7 @@ If you need more detailed instructions for setting up the target computer, see [
The SlateAudioSample driver package contains a sample driver and 2 driver extension samples. The following instructions show you how to install and test the sample driver. Here's the general syntax for the devcon tool that you will use to install the driver:
-*devcon install \<INF file\> \<hardware ID\>*
+**devcon install \<*INF file*>\<*hardware ID*\>**
The INF file required for installing this driver is *sysvad.inf*. Here's how to find the hardware ID for installing the *SlateAudioSample.sys* sample: On the target computer, navigate to the folder that contains the files for your driver (for example, *C:\\SysvadDriver*). Then right-click the INF file (*sysvad.inf*) and open it with Notepad. Use Ctrl+F to find the [MicrosoftDS] section. Note that there is a comma-separated element at the end of the row. The element after the comma shows the hardware ID. So for this sample, the hardware ID is \*SYSVAD\_SLATEAUDIO.
@@ -173,13 +130,13 @@ On the target computer, open a Command Prompt window as Administrator. Navigate
If you get an error message about *devcon* not being recognized, try adding the path to the *devcon* tool. For example, if you copied it to a folder called *C:\\Tools*, then try using the following command:
-**c:\\tools\\devcon install sysvad.inf \*SYSVAD\_SLATEAUDIO**
+**c:\\tools\\devcon install sysvad.inf \*SYSVAD\_SLATEAUDIO**
For more detailed instructions, see [Configuring a Computer for Driver Deployment, Testing, and Debugging](http://msdn.microsoft.com/en-us/library/windows/hardware/hh698272(v=vs.85).aspx).
After successfully installing the sample driver, you're now ready to test it.
-**Test the driver**
+### Test the driver
On the target computer, in a Command Prompt window, enter **devmgmt** to open Device Manager. In Device Manager, on the **View** menu, choose **Devices by type**. In the device tree, locate *Microsoft Virtual Audio Device (WDM) - Slate Sample*. This is typically under the **Sound, video and game controllers** node.
diff --git a/avstream/avshws/ReadMe.md b/avstream/avshws/ReadMe.md
index 276a7162..b15a4ea2 100644
--- a/avstream/avshws/ReadMe.md
+++ b/avstream/avshws/ReadMe.md
@@ -5,34 +5,21 @@ The AVStream simulated hardware sample driver (Avshws) provides a pin-centric [A
This sample features enhanced parameter validation and overflow detection.
-
-Build the sample
-----------------
-
-Install the sample files
-------------------------
-
-To install the sample files in preparation for building and running the sample, follow these steps:
-
-1. Click the blue **C++** Download button above.
-2. The files will be downloaded to a temporary folder. Move them to a convenient location on your hard drive.
-3. Unzip the files by right-clicking the folder, and then select **Extract All…** and select another folder location.
-
Provision a target computer
---------------------------
-After you’ve installed the sample on your host computer, run Visual Studio 2013, and from the **File** menu, select **Open**, then **Project/Solution…**, navigate to the directory where you’ve copied the Avshws sample, then to the C++ folder, and select **avshws.vcxproj** (the VC++ Project).
+After you've installed the sample on your host computer, run Visual Studio, and from the **File** menu, select **Open**, then **Project/Solution…**, navigate to the directory where you’ve copied the Avshws sample, then to the C++ folder, and select **avshws.vcxproj** (the VC++ Project).
In the **Solution Explorer** pane in Visual Studio, at the top is **Solution ‘avshws’**. Right-click this and select **Configuration Manager**. Follow the instructions in [Building a Driver with the WDK](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554644) to set the platform, operating system, and debug configuration you want to use, and to build the sample. This sample project will automatically sign the driver package.
-Provision your target computer using instructions in, for example, [Preparing a Computer for Provisioning (WDK 8.1)](http://msdn.microsoft.com/en-us/library/windows/hardware/dn265573). Ensure that in the **Network and Sharing Center** control panel your target computer has **Network Discovery** and **File and Printer Sharing** enabled.
+Provision your target computer using instructions in, for example, [Preparing a Computer for Provisioning](http://msdn.microsoft.com/en-us/library/windows/hardware/dn265573). Ensure that in the **Network and Sharing Center** control panel your target computer has **Network Discovery** and **File and Printer Sharing** enabled.
Deploy the driver to the target computer
----------------------------------------
Now you can deploy the Avshws driver that you’ve just built to the target computer, using guidance in [Deploying a Driver to a Test Computer](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454834). Specifically, find the package file under the **Package** folder in the Avshws solution. Right-click **package** and select **Properties**. Under Configuration Properties, click **Driver install** and then **Deployment**. Here you must click the check box for **Enable deployment**, and then click the button to the right of **\<Configure Computer…\>**. In the next dialog you enter the **Target Computer Name** and can let the host computer automatically provision the target computer and set up debugger options.
-Finally, in Visual Studio 2013, from the **Build** menu select **Deploy Solution** to deploy the sample to the target computer. On the target computer, you can see the deployed package in the **%Systemdrive%\\drivertest\\drivers** folder.
+Finally, in Visual Studio, from the **Build** menu select **Deploy Solution** to deploy the sample to the target computer. On the target computer, you can see the deployed package in the **%Systemdrive%\\drivertest\\drivers** folder.
Install the driver
------------------
@@ -81,27 +68,9 @@ In the upper-left corner of the image, a counter counts the number of frames tha
Code tour
---------
-**File manifest**
-
-<table>
-<colgroup>
-<col width="50%" />
-<col width="50%" />
-</colgroup>
-<thead>
-<tr class="header">
-<th align="left">File
-Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left">Avshws.h
-<p>Main header file for the sample</p></td>
-<td align="left">Avshws.inf
-<p>Sample installation file</p></td>
-</tr>
-</tbody>
-</table>
-
+### File Manifest
+File | Description
+-----|------------
+Avshws.h | Main header file for the sample
+Avshws.inf | Sample installation file
diff --git a/input/kbfiltr/ReadMe.md b/input/kbfiltr/ReadMe.md
index d902befe..9f5e2099 100644
--- a/input/kbfiltr/ReadMe.md
+++ b/input/kbfiltr/ReadMe.md
@@ -20,7 +20,7 @@ Set the hardware ID in the inx file
This step is required for automatic deployment (described later) to work properly. In the kbfiltr.inx file (located with the driver source files), find the [DDK\_Ex.Mfg.NT\$ARCH\$] section. Change the hardware ID in the %DDK\_Ex% entry from the dummy value to the hardware ID of the PS/2 keyboard on the target computer. The following example shows the hardware ID change.
-``` {.syntax xml:space="preserve"}
+```
; For XP and above
[DDK_Ex.Mfg.NT$ARCH$]
;%DDK_Ex% = kbfiltr, *PNP0BAAD
diff --git a/setup/devcon/ReadMe.md b/setup/devcon/ReadMe.md
index 8a7d70ca..20c2c6e7 100644
--- a/setup/devcon/ReadMe.md
+++ b/setup/devcon/ReadMe.md
@@ -7,11 +7,9 @@ This document explains the DevCon design, and how to use the SetupAPI and device
DevCon is provided in ready-to-run form in tools\\devcon. For usage, refer to the document provided with devcon.exe. DevCon is a command line utility with built-in documentation available by typing "devcon help".
-Download and extract the sample
+Build the sample
-------------------------------
-Download the C++ sample from this page, and extract its contents. For example, you could extract to c:\\DevConSample.
-
You can build the sample in two ways: using the Visual Studio Integrated Development Environment (IDE) or from the command line using the Visual Studio Command Prompt window and the Microsoft Build Engine (MSBuild.exe).
**Building the sample using Visual Studio**
diff --git a/usb/kmdf_fx2/ReadMe.md b/usb/kmdf_fx2/ReadMe.md
index 2e276ff0..b58a2a01 100644
--- a/usb/kmdf_fx2/ReadMe.md
+++ b/usb/kmdf_fx2/ReadMe.md
@@ -25,13 +25,13 @@ Related topics
Build the sample
----------------
-The default Solution build configuration is Windows 8.1 Debug and Win32. You can change the default configuration to build for Windows 7 or Windows Vista version of the operating system.
+The default Solution build configuration is **Debug** and **Win32**.
**To select a configuration and build a driver**
-1. Open the driver project or solution in Visual Studio 2013 (find *filtername*.sln or *filtername*.vcxproj).
+1. Open the driver project or solution in Visual Studio (find *filtername*.sln or *filtername*.vcxproj).
2. Right-click the solution in the **Solutions Explorer** and select **Configuration Manager**.
-3. From the **Configuration Manager**, select the **Active Solution Configuration** (for example, Windows 8.1 Debug or Windows 8.1 Release) and the **Active Solution Platform** (for example, Win32) that correspond to the type of build you are interested in.
+3. From the **Configuration Manager**, select the **Active Solution Configuration** (for example, Debug or Release) and the **Active Solution Platform** (for example, Win32) that correspond to the type of build you are interested in.
4. From the **Build** menu, click **Build Solution** (Ctrl+Shift+B).
Overview
@@ -62,14 +62,10 @@ Here is the overview of the device:
- Read/write start/stop events can be used to measure the time taken.
- For more information, see Unified Tracing later in this document.
-Sample Contents
+Code tour
---------------
-Folder
-
-Description
-
-usb\\kmdf\_fx2\\driver
+**usb\\kmdf\_fx2\\driver**
This directory contains driver code that demonstrates the following functionality:
@@ -88,11 +84,11 @@ This directory contains driver code that demonstrates the following functionalit
- Creates ETW provider to log two events to the event log, and read/write start stop events. (*\*kmdf\_fx2 only*)
- WPP tracing.
-usb\\kmdf\_fx2\\exe
+**usb\\kmdf\_fx2\\exe**
This directory contains a test application that can be used to drive the KMDF driver and FX2 device.
-usb\\kmdf\_fx2\\deviceMetadata
+**usb\\kmdf\_fx2\\deviceMetadata**
This directory contains the device metadata package for the sample. You must copy the device metadata to the system before installing the device. For information on how to update and deploy device metadata, see the [Custom driver access sample](http://go.microsoft.com/fwlink/p/?LinkID=248288).
@@ -117,6 +113,7 @@ Usage for Read/Write test:
Use the command, **osrusbfx2.exe -p** options 1-9, to set and clear bar graph display, set and get 7 segment state, and read the toggle switch states. The following shows the function options:
+```
1. Light bar
2. Clear bar
3. Light entire bar graph
@@ -129,9 +126,10 @@ Use the command, **osrusbfx2.exe -p** options 1-9, to set and clear bar graph di
10. Reset the device
11. Re-enumerate the device
-0. Exit
+12. Exit
Selection:
+```
**Reset and re-enumerate the device**
@@ -167,187 +165,189 @@ The following command displays all the descriptors and endpoint information.
If the device is operating in high speed mode, you will get the following information:
-`===================`
+```
+===================
-`USB_CONFIGURATION_DESCRIPTOR`
+USB_CONFIGURATION_DESCRIPTOR
-`bLength = 0x9, decimal 9`
+bLength = 0x9, decimal 9
-`bDescriptorType = 0x2 ( USB_CONFIGURATION_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x2 ( USB_CONFIGURATION_DESCRIPTOR_TYPE )
-`wTotalLength = 0x27, decimal 39`
+wTotalLength = 0x27, decimal 39
-`bNumInterfaces = 0x1, decimal 1`
+bNumInterfaces = 0x1, decimal 1
-`bConfigurationValue = 0x1, decimal 1`
+bConfigurationValue = 0x1, decimal 1
-`iConfiguration = 0x4, decimal 4`
+iConfiguration = 0x4, decimal 4
-`bmAttributes = 0xa0 ( USB_CONFIG_BUS_POWERED )`
+bmAttributes = 0xa0 ( USB_CONFIG_BUS_POWERED )
-`MaxPower = 0x32, decimal 50`
+MaxPower = 0x32, decimal 50
-`-----------------------------`
+-----------------------------
-`USB_INTERFACE_DESCRIPTOR #0`
+USB_INTERFACE_DESCRIPTOR #0
-`bLength = 0x9`
+bLength = 0x9
-`bDescriptorType = 0x4 ( USB_INTERFACE_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x4 ( USB_INTERFACE_DESCRIPTOR_TYPE )
-`bInterfaceNumber = 0x0`
+bInterfaceNumber = 0x0
-`bAlternateSetting = 0x0`
+bAlternateSetting = 0x0
-`bNumEndpoints = 0x3`
+bNumEndpoints = 0x3
-`bInterfaceClass = 0xff`
+bInterfaceClass = 0xff
-`bInterfaceSubClass = 0x0`
+bInterfaceSubClass = 0x0
-`bInterfaceProtocol = 0x0`
+bInterfaceProtocol = 0x0
-`bInterface = 0x0`
+bInterface = 0x0
-`------------------------------`
+------------------------------
-`USB_ENDPOINT_DESCRIPTOR for Pipe00`
+USB_ENDPOINT_DESCRIPTOR for Pipe00
-`bLength = 0x7`
+bLength = 0x7
-`bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )
-`bEndpointAddress= 0x81 ( INPUT )`
+bEndpointAddress= 0x81 ( INPUT )
-`bmAttributes= 0x3 ( USB_ENDPOINT_TYPE_INTERRUPT )`
+bmAttributes= 0x3 ( USB_ENDPOINT_TYPE_INTERRUPT )
-`wMaxPacketSize= 0x49, decimal 73`
+wMaxPacketSize= 0x49, decimal 73
-`bInterval = 0x1, decimal 1`
+bInterval = 0x1, decimal 1
-`------------------------------`
+------------------------------
-`USB_ENDPOINT_DESCRIPTOR for Pipe01`
+USB_ENDPOINT_DESCRIPTOR for Pipe01
-`bLength = 0x7`
+bLength = 0x7
-`bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )
-`bEndpointAddress= 0x6 ( OUTPUT )`
+bEndpointAddress= 0x6 ( OUTPUT )
-`bmAttributes= 0x2 ( USB_ENDPOINT_TYPE_BULK )`
+bmAttributes= 0x2 ( USB_ENDPOINT_TYPE_BULK )
-`wMaxPacketSize= 0x200, `
+wMaxPacketSize= 0x200,
-`decimal 512 bInterval = 0x0, `
+decimal 512 bInterval = 0x0,
-`decimal 0`
+decimal 0
-`------------------------------`
+------------------------------
-`USB_ENDPOINT_DESCRIPTOR for Pipe02`
+USB_ENDPOINT_DESCRIPTOR for Pipe02
-`bLength = 0x7`
+bLength = 0x7
-`bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )
-`bEndpointAddress= 0x88 ( INPUT )`
+bEndpointAddress= 0x88 ( INPUT )
-`bmAttributes= 0x2 ( USB_ENDPOINT_TYPE_BULK )`
+bmAttributes= 0x2 ( USB_ENDPOINT_TYPE_BULK )
-`wMaxPacketSize= 0x200, decimal 512`
+wMaxPacketSize= 0x200, decimal 512
-`bInterval = 0x0, decimal 0`
+bInterval = 0x0, decimal 0
If the device is operating in low speed mode, you will get the following information:
-`===================`
+===================
-`USB_CONFIGURATION_DESCRIPTOR`
+USB_CONFIGURATION_DESCRIPTOR
-`bLength = 0x9, decimal 9`
+bLength = 0x9, decimal 9
-`bDescriptorType = 0x2 ( USB_CONFIGURATION_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x2 ( USB_CONFIGURATION_DESCRIPTOR_TYPE )
-`wTotalLength = 0x27, decimal 39`
+wTotalLength = 0x27, decimal 39
-`bNumInterfaces = 0x1, decimal 1`
+bNumInterfaces = 0x1, decimal 1
-`bConfigurationValue = 0x1, decimal 1`
+bConfigurationValue = 0x1, decimal 1
-`iConfiguration = 0x3, decimal 3`
+iConfiguration = 0x3, decimal 3
-`bmAttributes = 0xa0 ( USB_CONFIG_BUS_POWERED )`
+bmAttributes = 0xa0 ( USB_CONFIG_BUS_POWERED )
-`MaxPower = 0x32, decimal 50 `
+MaxPower = 0x32, decimal 50
-`-----------------------------`
+-----------------------------
-`USB_INTERFACE_DESCRIPTOR #0`
+USB_INTERFACE_DESCRIPTOR #0
-`bLength = 0x9`
+bLength = 0x9
-`bDescriptorType = 0x4 ( USB_INTERFACE_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x4 ( USB_INTERFACE_DESCRIPTOR_TYPE )
-`bInterfaceNumber = 0x0 bAlternateSetting = 0x0`
+bInterfaceNumber = 0x0 bAlternateSetting = 0x0
-`bNumEndpoints = 0x3`
+bNumEndpoints = 0x3
-`bInterfaceClass = 0xff`
+bInterfaceClass = 0xff
-`bInterfaceSubClass = 0x0`
+bInterfaceSubClass = 0x0
-`bInterfaceProtocol = 0x0`
+bInterfaceProtocol = 0x0
-`bInterface = 0x0`
+bInterface = 0x0
-`------------------------------`
+------------------------------
-`USB_ENDPOINT_DESCRIPTOR for Pipe00`
+USB_ENDPOINT_DESCRIPTOR for Pipe00
-`bLength = 0x7`
+bLength = 0x7
-`bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )
-`bEndpointAddress= 0x81 ( INPUT )`
+bEndpointAddress= 0x81 ( INPUT )
-`bmAttributes= 0x3 ( USB_ENDPOINT_TYPE_INTERRUPT )`
+bmAttributes= 0x3 ( USB_ENDPOINT_TYPE_INTERRUPT )
-`wMaxPacketSize= 0x49, decimal 73`
+wMaxPacketSize= 0x49, decimal 73
-`bInterval = 0x1, decimal 1`
+bInterval = 0x1, decimal 1
-`------- -----------------------`
+------------------------------
-`USB_ENDPOINT_DESCRIPTOR for Pipe01`
+USB_ENDPOINT_DESCRIPTOR for Pipe01
-`bLength = 0x7`
+bLength = 0x7
-`bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )
-`bEndpointAddress= 0x6 ( OUTPUT )`
+bEndpointAddress= 0x6 ( OUTPUT )
-`bmAttributes= 0x2 ( USB_ENDPOINT_TYPE_BULK )`
+bmAttributes= 0x2 ( USB_ENDPOINT_TYPE_BULK )
-`wMaxPacketSize= 0x40, decimal 64`
+wMaxPacketSize= 0x40, decimal 64
-`bInterval = 0x0, decimal 0`
+bInterval = 0x0, decimal 0
-`------------------------------`
+------------------------------
-`USB_ENDPOINT_DESCRIPTOR for Pipe02`
+USB_ENDPOINT_DESCRIPTOR for Pipe02
-`bLength = 0x7`
+bLength = 0x7
-`bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )`
+bDescriptorType = 0x5 ( USB_ENDPOINT_DESCRIPTOR_TYPE )
-`bEndpointAddress= 0x88 ( INPUT )`
+bEndpointAddress= 0x88 ( INPUT )
-`bmAttributes= 0x2 ( USB_ENDPOINT_TYPE_BULK )`
+bmAttributes= 0x2 ( USB_ENDPOINT_TYPE_BULK )
-`wMaxPacketSize= 0x40, decimal 64`
+wMaxPacketSize= 0x40, decimal 64
-`bInterval = 0x0, decimal 0 `
+bInterval = 0x0, decimal 0
+```
Unified tracing
---------------
diff --git a/usb/umdf_filter_kmdf/ReadMe.md b/usb/umdf_filter_kmdf/ReadMe.md
index 3906d751..17f9e696 100644
--- a/usb/umdf_filter_kmdf/ReadMe.md
+++ b/usb/umdf_filter_kmdf/ReadMe.md
@@ -5,18 +5,16 @@ The umdf\_filter\_kmdf sample demonstrates how to load a UMDF filter driver as a
The sample includes Event Tracing for Windows (ETW) tracing support, and is written for the OSR USB-FX2 Learning Kit. The specification for the device is at <http://www.osronline.com/hardware/OSRFX2_32.pdf>.
-
-
Build the sample
----------------
-The default Solution build configuration is Windows 8.1 Debug and Win32. You can change the default configuration to build for Windows 8 or Windows 7 version of the operating system.
+The default Solution build configuration is **Debug** and **Win32**.
**To select a configuration and build a driver**
-1. Open the driver project or solution in Visual Studio 2013 (find *filtername*.sln or *filtername*.vcxproj).
+1. Open the driver project or solution in Visual Studio (find *filtername*.sln or *filtername*.vcxproj).
2. Right-click the solution in the **Solutions Explorer** and select **Configuration Manager**.
-3. From the **Configuration Manager**, select the **Active Solution Configuration** (for example, Windows 8.1 Debug or Windows 8.1 Release) and the **Active Solution Platform** (for example, Win32) that correspond to the type of build you are interested in.
+3. From the **Configuration Manager**, select the **Active Solution Configuration** (for example, Debug or Release) and the **Active Solution Platform** (for example, Win32) that correspond to the type of build you are interested in.
4. From the **Build** menu, click **Build Solution** (Ctrl+Shift+B).
Overview
@@ -51,28 +49,12 @@ Testing the driver
You can test this sample either by using the [Custom driver access](http://go.microsoft.com/fwlink/p/?LinkID=248288) sample application, or by using the osrusbfx2.exe test application. For information on how to build and use the osrusbfx2.exe application, see the test instructions for the [kmdf\_fx2](http://msdn.microsoft.com/en-us/library/windows/hardware/) sample.
-Sample Contents
+Code tour
---------------
-<table>
-<colgroup>
-<col width="50%" />
-<col width="50%" />
-</colgroup>
-<thead>
-<tr class="header">
-<th align="left">Folder
-Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left">usb\umdf_filter_kmdf\kmdf_driver
-This directory contains source code for the kmdf_fx2 sample driver.</td>
-<td align="left">usb\umdf_filter_kmdf\umdf_filter
-This directory contains the UMDF filter driver.</td>
-</tr>
-</tbody>
-</table>
+Folder | Description
+-----|------------
+usb\umdf_filter_kmdf\kmdf_driver | This directory contains source code for the kmdf_fx2 sample driver.
+usb\umdf_filter_kmdf\umdf_filter | This directory contains the UMDF filter driver.