summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2019-03-12 14:02:43 -0700
committerAdonais Romero González <[email protected]>2019-03-12 14:02:43 -0700
commitef7ec4ec9ff7ce3c53d60e1c8906915966e17e01 (patch)
tree3017523a73c6552c27947d402afa6062f4df2706 /tools
parent35bff356ac249057f4d673d39c7f28ed348cbf0f (diff)
Update README.md for samples portal (#358)
* Update README.md for samples portal * Update README.md for samples portal * Removed installwdf * Update fork (#2) * Fix typo ture -> true * Remove InstallWdf sample * Fix typo (#340) ture -> true * Readme typo fix (#349) * Update langid
Diffstat (limited to 'tools')
-rw-r--r--tools/dv/samples/DV-FailDriver-WDM/README.md32
-rw-r--r--tools/dv/samples/DV-FailDriver-WDM/tools-dv-samples-dv-faildriver-wdm.yml12
-rw-r--r--tools/sdv/samples/SDV-FailDriver-KMDF/README.md45
-rw-r--r--tools/sdv/samples/SDV-FailDriver-KMDF/tools-sdv-samples-sdv-faildriver-kmdf.yml12
-rw-r--r--tools/sdv/samples/SDV-FailDriver-NDIS/README.md37
-rw-r--r--tools/sdv/samples/SDV-FailDriver-NDIS/tools-sdv-samples-sdv-faildriver-ndis.yml12
-rw-r--r--tools/sdv/samples/SDV-FailDriver-STORPORT/README.md43
-rw-r--r--tools/sdv/samples/SDV-FailDriver-STORPORT/tools-sdv-samples-sdv-faildriver-storport.yml12
-rw-r--r--tools/sdv/samples/SDV-FailDriver-WDM/README.md37
-rw-r--r--tools/sdv/samples/SDV-FailDriver-WDM/tools-sdv-samples-sdv-faildriver-wdm.yml12
10 files changed, 111 insertions, 143 deletions
diff --git a/tools/dv/samples/DV-FailDriver-WDM/README.md b/tools/dv/samples/DV-FailDriver-WDM/README.md
index 9851ff31..f8675419 100644
--- a/tools/dv/samples/DV-FailDriver-WDM/README.md
+++ b/tools/dv/samples/DV-FailDriver-WDM/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: DV-FailDriver-WDM
+description: Demonstrates how Driver Verifier (DV) can find errors in a WDM driver.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: DV-FailDriver-WDM
platform: WDM
@@ -7,26 +17,24 @@
samplefwlink: https://go.microsoft.com/fwlink/p/?linkid=856743
--->
-
-DV-FailDriver-WDM
-=================
+# DV-FailDriver-WDM
The DV-FailDriver-WDM sample driver contains intentional code errors that are designed to show the capabilities and features of [Driver Verifier](https://msdn.microsoft.com/en-us/library/windows/hardware/ff545448) (DV) and the [Device Fundamentals tests](https://msdn.microsoft.com/en-us/library/windows/hardware/jj673011). Driver Verifier is a component of the Windows kernel designed to detect drivers that are behaving poorly and stop their execution via a bugcheck; the Device Fundamentals tests are a series of tests provided in the Windows Driver Kit (WDK) designed to provide a good basic set of tests against a driver.
**Caution** This sample driver contains intentional code errors that are designed to show the capabilities and features of DV and SDV. This sample driver is not intended as an example for real driver development projects.
-Build the sample for desktop
---------------
-1. In the **Solutions Explorer** window, select the driver solution (DV-FailDriver-WDM).
+## Build the sample for desktop
+
+1. In the **Solutions Explorer** window, select the driver solution (DV-FailDriver-WDM).
-2. From the **Build** menu, select **Build Solution**.
+1. From the **Build** menu, select **Build Solution**.
+
+## Deploy the sample
-Deploy the sample
---------------
See [Deploying a Driver to a Test Computer](https://msdn.microsoft.com/en-us/library/windows/hardware/hh454834) for details on how to deploy the sample.
-Test the sample
---------------
+## Test the sample
+
See [How to test a driver at runtime](https://msdn.microsoft.com/en-us/library/windows/hardware/ff554820) for details on how to run tests on the Toastmon driver.
-To observe the injected defect being caught by DV, you should enable DV on the Toastmon driver, and then run the "DF - PNP Surprise Remove (Development and Integration)" test on the Toastmon sample driver and device. \ No newline at end of file
+To observe the injected defect being caught by DV, you should enable DV on the Toastmon driver, and then run the "DF - PNP Surprise Remove (Development and Integration)" test on the Toastmon sample driver and device.
diff --git a/tools/dv/samples/DV-FailDriver-WDM/tools-dv-samples-dv-faildriver-wdm.yml b/tools/dv/samples/DV-FailDriver-WDM/tools-dv-samples-dv-faildriver-wdm.yml
deleted file mode 100644
index 86c935f6..00000000
--- a/tools/dv/samples/DV-FailDriver-WDM/tools-dv-samples-dv-faildriver-wdm.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: DV-FailDriver-WDM
- description: Demonstrates how Driver Verifier (DV) can find errors in a WDM driver.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /tools/dv/samples/DV-FailDriver-WDM/driver/DV-FailDriver-WDM.sln
diff --git a/tools/sdv/samples/SDV-FailDriver-KMDF/README.md b/tools/sdv/samples/SDV-FailDriver-KMDF/README.md
index 6d4d71cd..cdabde42 100644
--- a/tools/sdv/samples/SDV-FailDriver-KMDF/README.md
+++ b/tools/sdv/samples/SDV-FailDriver-KMDF/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: SDV-FailDriver-KMDF
+description: Demonstrates how Static Driver Verifier (SDV) can find errors in a KMDF driver.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: SDV-FailDriver-KMDF
platform: KMDF
@@ -7,50 +17,45 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617993
--->
-
-SDV-FailDriver-KMDF
-===================
+# SDV-FailDriver-KMDF
The SDV-FailDriver-KMDF sample driver contains intentional code errors that are designed to show the capabilities and features of [Static Driver Verifier](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552808) (SDV). SDV is a static verification tool that systematically analyzes the source code of Windows kernel-mode drivers. SDV is included in the Windows Driver Kit (WDK) and can be run from Microsoft Visual Studio. The sample demonstrates how SDV can find errors in a KMDF driver.
**Caution** These sample drivers contain intentional code errors that are designed to show the capabilities and features of SDV. These sample drivers are not functional and are not intended as examples for real driver development projects.
-Run the sample
---------------
+## Run the sample
-1. In the **Solutions Explorer** window, select the driver project (fail\_driver1).
+1. In the **Solutions Explorer** window, select the driver project (fail\_driver1).
From the **Driver** menu, click **Launch Static Driver Verifier...**.
This opens the Static Driver Verifier application, where you can control, configure, and schedule when Static Driver Verifier performs an analysis.
-2. The fail\_driver1 sample driver includes a library. To add the library, click the **Libraries** tab and click **Add Library**.
+1. The fail\_driver1 sample driver includes a library. To add the library, click the **Libraries** tab and click **Add Library**.
Browse to the sample library directory and select the library project file (fail\_library1.vcxProj). The library must be added before SDV analyzes the driver. For more information, see [Library Processing in Static Driver Verifier](http://msdn.microsoft.com/en-us/library/windows/hardware/ff548182).
-3. Click the **Rules** tab to select which driver DDI usage rules to verify when you start the analysis.
+1. Click the **Rules** tab to select which driver DDI usage rules to verify when you start the analysis.
Static Driver Verifier detects the type of driver you are analyzing (WDF, WDM, NDIS, or Storport) and selects the default set of rules for your driver type. If this is the first time you are running SDV on your driver, you should run the default rule set. To shorten the amount of time it takes to analyze the fail\_driver1 driver sample, you can select the **Custom rule selection**.
Use the default rule set, or select **Custom rule selection**, click **Clear All**, and then select the following rules for the KMDF fail\_driver1 sample:
- - [DriverCreate](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544957)
- - [DeviceInitAPI](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544843)
- - [CtlDeviceFinishInitDeviceAdd](http://msdn.microsoft.com/en-us/library/windows/hardware/ff543607)
- - [MdlAfterReqCompletedIoctl](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549047)
- - [MemAfterReqCompletedIntIoctlA](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549090)
- - [MdlAfterReqCompletedIntIoctlA](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549042)
- - [MarkCancOnCancReqLocal](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549011)
- - [StopAckWithinEvtIoStop](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552846)
+ - [DriverCreate](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544957)
+ - [DeviceInitAPI](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544843)
+ - [CtlDeviceFinishInitDeviceAdd](http://msdn.microsoft.com/en-us/library/windows/hardware/ff543607)
+ - [MdlAfterReqCompletedIoctl](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549047)
+ - [MemAfterReqCompletedIntIoctlA](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549090)
+ - [MdlAfterReqCompletedIntIoctlA](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549042)
+ - [MarkCancOnCancReqLocal](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549011)
+ - [StopAckWithinEvtIoStop](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552846)
For information about the rules, see [DDI Compliance Rules](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552840).
-4. Start the static analysis. Click the **Main** tab, and then click **Start**. When you click **Start**, a message is displayed to let you know that static analysis is scheduled and that the analysis can take a long time to run. Click **OK** to continue.
+1. Start the static analysis. Click the **Main** tab, and then click **Start**. When you click **Start**, a message is displayed to let you know that static analysis is scheduled and that the analysis can take a long time to run. Click **OK** to continue.
-View and analyze the results
-----------------------------
+## View and analyze the results
As the static analysis proceeds, SDV reports the status of the analysis. When the analysis is complete, SDV reports the results and statistics. If the driver fails to satisfy a DDI usage rule, the result is reported as a defect. SDV finds 8 defects in this sample.
On the **Main** tab, under **Results**, click the **Rules** tab. This tab displays the name of each rule that was verified in the last run and the results of the analysis. To view the reported defects, click the **Defect** link in the **Results** column. This opens the [Static Driver Verifier Report Page](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552834) and the [Trace Viewer](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544659), which displays a trace of the code path to the rule violation. For more information, see [Interpreting Static Driver Verifier Results](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547228).
-
diff --git a/tools/sdv/samples/SDV-FailDriver-KMDF/tools-sdv-samples-sdv-faildriver-kmdf.yml b/tools/sdv/samples/SDV-FailDriver-KMDF/tools-sdv-samples-sdv-faildriver-kmdf.yml
deleted file mode 100644
index 2c6d9197..00000000
--- a/tools/sdv/samples/SDV-FailDriver-KMDF/tools-sdv-samples-sdv-faildriver-kmdf.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: SDV-FailDriver-KMDF
- description: Demonstrates how Static Driver Verifier (SDV) can find errors in a KMDF driver.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /tools/sdv/samples/SDV-FailDriver-KMDF/SDV-FailDriver-KMDF.sln
diff --git a/tools/sdv/samples/SDV-FailDriver-NDIS/README.md b/tools/sdv/samples/SDV-FailDriver-NDIS/README.md
index eaf5dc56..8d34e009 100644
--- a/tools/sdv/samples/SDV-FailDriver-NDIS/README.md
+++ b/tools/sdv/samples/SDV-FailDriver-NDIS/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: SDV-FailDriver-NDIS
+description: Demonstrates how Static Driver Verifier (SDV) can find errors in a NDIS driver.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: SDV-FailDriver-NDIS
platform: WDM
@@ -7,43 +17,38 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617995
--->
-
-SDV-FailDriver-NDIS
-===================
+# SDV-FailDriver-NDIS
The SDV-FailDriver-NDIS sample driver contains intentional code errors that are designed to show the capabilities and features of [Static Driver Verifier](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552808) (SDV). SDV is a static verification tool that systematically analyzes the source code of Windows kernel-mode drivers. SDV is included in the Windows Driver Kit (WDK) and can be run from Microsoft Visual Studio. The sample demonstrates how SDV can find errors in an NDIS driver.
**Caution** These sample drivers contain intentional code errors that are designed to show the capabilities and features of SDV. These sample drivers are not functional and are not intended as examples for real driver development projects.
-Run the sample
---------------
+## Run the sample
-1. In the **Solutions Explorer** window, select the driver project (sdvmp.vcxProj).
+1. In the **Solutions Explorer** window, select the driver project (sdvmp.vcxProj).
From the **Driver** menu, click **Launch Static Driver Verifier...**.
This opens the Static Driver Verifier application, where you can control, configure, and schedule when Static Driver Verifier performs an analysis.
-2. Click the **Rules** tab to select which driver DDI usage rules to verify when you start the analysis.
+1. Click the **Rules** tab to select which driver DDI usage rules to verify when you start the analysis.
Static Driver Verifier detects the type of driver you are analyzing (WDF, WDM, NDIS, or Storport) and selects the default set of rules for your driver type. If this is the first time you are running SDV on your driver, you should run the default rule set. To shorten the amount of time it takes to analyze the sample driver, you can select the **Custom rule selection**.
Use the default rule set, or select **Custom rule selection**, click **Clear All**, and then select the following rules for the NDIS sdvmp sample:
- - [NdisAllocateMemoryWithTagPriority](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549326)
- - [Init\_RegisterSG](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547153)
- - [NdisStallExecution\_Delay](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549332)
- - [Flags\_Irql](http://msdn.microsoft.com/en-us/library/windows/hardware/ff546123)
- - [Irql\_Synch\_Function](http://msdn.microsoft.com/en-us/library/windows/hardware/ff548015)
+ - [NdisAllocateMemoryWithTagPriority](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549326)
+ - [Init\_RegisterSG](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547153)
+ - [NdisStallExecution\_Delay](http://msdn.microsoft.com/en-us/library/windows/hardware/ff549332)
+ - [Flags\_Irql](http://msdn.microsoft.com/en-us/library/windows/hardware/ff546123)
+ - [Irql\_Synch\_Function](http://msdn.microsoft.com/en-us/library/windows/hardware/ff548015)
For information about the rules, see [DDI Compliance Rules](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552840).
-3. Start the static analysis. Click the **Main** tab, and click **Start**. When you click **Start**, a message is displayed to let you know that static analysis is scheduled and that the analysis can take a long time to run. Click **OK** to continue.
+1. Start the static analysis. Click the **Main** tab, and click **Start**. When you click **Start**, a message is displayed to let you know that static analysis is scheduled and that the analysis can take a long time to run. Click **OK** to continue.
-View and analyze the results
-----------------------------
+## View and analyze the results
As the static analysis proceeds, SDV reports the status of the analysis. When the analysis is complete, SDV reports the results and statistics. If the driver fails to satisfy a DDI usage rule, the result is reported as a defect. SDV finds 5 defects in this sample.
On the **Main** tab, under **Results**, click the **Rules** tab. This tab displays the name of each rule that was verified in the last run and the results of the analysis. To view the reported defects, click the **Defect** link in the **Results** column. This opens the [Static Driver Verifier Report Page](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552834) and the [Trace Viewer](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544659), which displays a trace of the code path to the rule violation. For more information, see [Interpreting Static Driver Verifier Results](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547228).
-
diff --git a/tools/sdv/samples/SDV-FailDriver-NDIS/tools-sdv-samples-sdv-faildriver-ndis.yml b/tools/sdv/samples/SDV-FailDriver-NDIS/tools-sdv-samples-sdv-faildriver-ndis.yml
deleted file mode 100644
index 13804411..00000000
--- a/tools/sdv/samples/SDV-FailDriver-NDIS/tools-sdv-samples-sdv-faildriver-ndis.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: SDV-FailDriver-NDIS
- description: Demonstrates how Static Driver Verifier (SDV) can find errors in a NDIS driver.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /tools/sdv/samples/SDV-FailDriver-NDIS/SDV-FailDriver-NDIS.sln
diff --git a/tools/sdv/samples/SDV-FailDriver-STORPORT/README.md b/tools/sdv/samples/SDV-FailDriver-STORPORT/README.md
index 600b0023..e8792507 100644
--- a/tools/sdv/samples/SDV-FailDriver-STORPORT/README.md
+++ b/tools/sdv/samples/SDV-FailDriver-STORPORT/README.md
@@ -1,51 +1,56 @@
+---
+topic: sample
+name: SDV-FailDriver-STORPORT
+description: Demonstrates how Static Driver Verifier (SDV) can find errors in a Storport driver.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: SDV-FailDriver-STORPORT
platform: KMDF
language: cpp
- category: StaticDriverVerifier
+ category: StaticDriverVerifier
description: Demonstrates how Static Driver Verifier (SDV) can find errors in a Storport driver.
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617997
--->
-
-SDV-FailDriver-STORPORT
-=======================
+# SDV-FailDriver-STORPORT
The SDV-FailDriver-Storport sample driver contains intentional code errors that are designed to show the capabilities and features of [Static Driver Verifier](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552808) (SDV). SDV is a static verification tool that systematically analyzes the source code of Windows kernel-mode drivers. SDV is included in the Windows Driver Kit (WDK) and can be run from Microsoft Visual Studio. The sample demonstrates how SDV can find errors in a Storport driver.
**Caution** These sample drivers contain intentional code errors that are designed to show the capabilities and features of SDV. These sample drivers are not functional and are not intended as examples for real driver development projects.
-Run the sample
---------------
+## Run the sample
-1. In the **Solutions Explorer** window, select the driver project (lsi\_u3.vcxProj).
+1. In the **Solutions Explorer** window, select the driver project (lsi\_u3.vcxProj).
From the **Driver** menu, click **Launch Static Driver Verifier...**.
This opens the Static Driver Verifier application, where you can control, configure, and schedule when Static Driver Verifier performs an analysis.
-2. Click the **Rules** tab to select which driver DDI usage rules to verify when you start the analysis.
+1. Click the **Rules** tab to select which driver DDI usage rules to verify when you start the analysis.
Static Driver Verifier detects the type of driver you are analyzing (WDF, WDM, NDIS, or Storport) and selects the default set of rules for your driver type. If this is the first time you are running SDV on your driver, you should run the default rule set. To shorten the amount of time it takes to analyze the sample driver, you can select the **Custom rule selection**.
Use the default rule set, or select **Custom rule selection**, click **Clear All**, and then select the following rules for the Storport sample:
- - [StorPortAllocatePool2 Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454259)
- - [StorPortDeprecated Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454263)
- - [StorPortEnablePassive Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454264)
- - [StorPortNotification2 Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454268)
- - [StorPortSpinLock Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454273)
- - [StorPortStartIo Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454274)
- - [StorPortStatusPending Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454275)
+ - [StorPortAllocatePool2 Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454259)
+ - [StorPortDeprecated Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454263)
+ - [StorPortEnablePassive Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454264)
+ - [StorPortNotification2 Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454268)
+ - [StorPortSpinLock Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454273)
+ - [StorPortStartIo Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454274)
+ - [StorPortStatusPending Rule (Storport)](http://msdn.microsoft.com/en-us/library/windows/hardware/hh454275)
For information about the rules, see [DDI Compliance Rules](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552840).
-3. Start the static analysis. Click the **Main** tab, and click **Start**. When you click **Start**, a message is displayed to let you know that static analysis is scheduled and that the analysis can take a long time to run. Click **OK** to continue.
+1. Start the static analysis. Click the **Main** tab, and click **Start**. When you click **Start**, a message is displayed to let you know that static analysis is scheduled and that the analysis can take a long time to run. Click **OK** to continue.
-View and analyze the results
-----------------------------
+## View and analyze the results
As the static analysis proceeds, SDV reports the status of the analysis. When the analysis is complete, SDV reports the results and statistics. If the driver fails to satisfy a DDI usage rule, the result is reported as a defect. SDV finds 7 defects in this sample.
On the **Main** tab, under **Results**, click the **Rules** tab. This tab displays the name of each rule that was verified in the last run and the results of the analysis. To view the reported defects, click the **Defect** link in the **Results** column. This opens the [Static Driver Verifier Report Page](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552834) and the [Trace Viewer](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544659), which displays a trace of the code path to the rule violation. For more information, see [Interpreting Static Driver Verifier Results](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547228).
-
diff --git a/tools/sdv/samples/SDV-FailDriver-STORPORT/tools-sdv-samples-sdv-faildriver-storport.yml b/tools/sdv/samples/SDV-FailDriver-STORPORT/tools-sdv-samples-sdv-faildriver-storport.yml
deleted file mode 100644
index 81734590..00000000
--- a/tools/sdv/samples/SDV-FailDriver-STORPORT/tools-sdv-samples-sdv-faildriver-storport.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: SDV-FailDriver-STORPORT
- description: Demonstrates how Static Driver Verifier (SDV) can find errors in a Storport driver.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /tools/sdv/samples/SDV-FailDriver-STORPORT/SDV-FailDriver-STORPORT.sln
diff --git a/tools/sdv/samples/SDV-FailDriver-WDM/README.md b/tools/sdv/samples/SDV-FailDriver-WDM/README.md
index a32fbcf5..00bf64ee 100644
--- a/tools/sdv/samples/SDV-FailDriver-WDM/README.md
+++ b/tools/sdv/samples/SDV-FailDriver-WDM/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: SDV-FailDriver-WDM
+description: Demonstrates how Static Driver Verifier (SDV) can find errors in a WDM driver.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: SDV-FailDriver-WDM
platform: WDM
@@ -7,43 +17,38 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617999
--->
-
-SDV-FailDriver-WDM
-==================
+# SDV-FailDriver-WDM
The SDV-FailDriver-WDM sample driver contains intentional code errors that are designed to show the capabilities and features of [Static Driver Verifier](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552808) (SDV). SDV is a static verification tool that systematically analyzes the source code of Windows kernel-mode drivers. SDV is included in the Windows Driver Kit (WDK) and can be run from Microsoft Visual Studio. The sample demonstrates how SDV can find errors in a WDM driver.
**Caution** These sample drivers contain intentional code errors that are designed to show the capabilities and features of SDV. These sample drivers are not functional and are not intended as examples for real driver development projects.
-Run the sample
---------------
+## Run the sample
-1. In the **Solutions Explorer** window, select the driver project (fail\_driver1).
+1. In the **Solutions Explorer** window, select the driver project (fail\_driver1).
From the **Driver** menu, click **Launch Static Driver Verifier...**.
This opens the Static Driver Verifier application, where you can control, configure, and schedule when Static Driver Verifier performs an analysis.
-2. Click the **Rules** tab to select which driver DDI usage rules to verify when you start the analysis.
+1. Click the **Rules** tab to select which driver DDI usage rules to verify when you start the analysis.
Static Driver Verifier detects the type of driver you are analyzing (WDF, WDM, NDIS, or Storport) and selects the default set of rules for your driver type. If this is the first time you are running SDV on your driver, you should run the default rule set. To shorten the amount of time it takes to analyze the fail\_driver1 driver sample, you can select the **Custom rule selection**.
Use the default rule set, or select **Custom rule selection**, click **Clear All**, and then select the following rules for the WDM fail\_driver1 sample:
- - [CancelSpinLock](http://msdn.microsoft.com/en-us/library/windows/hardware/ff542478)
- - [IrqlIoApcLte](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547759)
- - [IrqlKeSetEvent](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547835)
- - [LowerDriverReturn](http://msdn.microsoft.com/en-us/library/windows/hardware/ff548273)
- - [SpinLock (WDM)](http://msdn.microsoft.com/en-us/library/windows/hardware/ff551861)
+ - [CancelSpinLock](http://msdn.microsoft.com/en-us/library/windows/hardware/ff542478)
+ - [IrqlIoApcLte](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547759)
+ - [IrqlKeSetEvent](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547835)
+ - [LowerDriverReturn](http://msdn.microsoft.com/en-us/library/windows/hardware/ff548273)
+ - [SpinLock (WDM)](http://msdn.microsoft.com/en-us/library/windows/hardware/ff551861)
For information about the rules, see [DDI Compliance Rules](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552840).
-3. Start the static analysis. Click the **Main** tab, and click **Start**. When you click **Start**, a message is displayed to let you know that static analysis is scheduled and that the analysis can take a long time to run. Click **OK** to continue.
+1. Start the static analysis. Click the **Main** tab, and click **Start**. When you click **Start**, a message is displayed to let you know that static analysis is scheduled and that the analysis can take a long time to run. Click **OK** to continue.
-View and analyze the results
-----------------------------
+## View and analyze the results
As the static analysis proceeds, SDV reports the status of the analysis. When the analysis is complete, SDV reports the results and statistics. If the driver fails to satisfy a DDI usage rule, the result is reported as a defect. SDV finds 5 defects in this sample.
To view specific defects in the [Static Driver Verifier Report](http://msdn.microsoft.com/en-us/library/windows/hardware/ff552834), click the Defect in the **Results** pane. This opens the [Trace Viewer](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544659), which displays a trace of the code path to the rule violation. For more information, see [Interpreting Static Driver Verifier Results](http://msdn.microsoft.com/en-us/library/windows/hardware/ff547228).
-
diff --git a/tools/sdv/samples/SDV-FailDriver-WDM/tools-sdv-samples-sdv-faildriver-wdm.yml b/tools/sdv/samples/SDV-FailDriver-WDM/tools-sdv-samples-sdv-faildriver-wdm.yml
deleted file mode 100644
index a746c40c..00000000
--- a/tools/sdv/samples/SDV-FailDriver-WDM/tools-sdv-samples-sdv-faildriver-wdm.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: SDV-FailDriver-WDM
- description: Demonstrates how Static Driver Verifier (SDV) can find errors in a WDM driver.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /tools/sdv/samples/SDV-FailDriver-WDM/SDV-FailDriver-WDM.sln