summaryrefslogtreecommitdiff
path: root/general/SystemDma
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 /general/SystemDma
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 'general/SystemDma')
-rw-r--r--general/SystemDma/wdm/README.md18
-rw-r--r--general/SystemDma/wdm/general-systemdma-wdm.yml12
2 files changed, 12 insertions, 18 deletions
diff --git a/general/SystemDma/wdm/README.md b/general/SystemDma/wdm/README.md
index ad7d9dbc..979f0ab4 100644
--- a/general/SystemDma/wdm/README.md
+++ b/general/SystemDma/wdm/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: System DMA sample
+description: Demonstrates how a driver could use a system DMA controller to write data to a hardware location using V3 System DMA.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: System DMA sample
platform: WDM
@@ -7,9 +17,7 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617722
--->
-
-System DMA
-==========
+# System DMA
This sample demonstrates the usage of V3 System DMA. It shows how a driver could use a system DMA controller supported by Windows to write data to a hardware location using DMA.
@@ -17,8 +25,6 @@ The sample consists of a legacy device driver and a Win32 console mode test appl
**Note** This sample driver is not a PnP driver. This is a minimal driver meant to demonstrate an OS feature. Neither it nor its sample programs are intended for use in a production environment. Rather, they are intended for educational purposes and as a skeleton driver.
-Run the sample
---------------
+## Run the sample
To test this driver, copy the test app, SystemDmaApp.exe, and the driver to the same directory, and run the application. The application will automatically load the driver if it's not already loaded and interact with the driver. When you exit the app, the driver will be stopped, unloaded and removed. Because no system DMA controller exists for Windows which uses the advertised DRQ, the sample driver will not proceed any further than failing to acquire a system DMA adapter.
-
diff --git a/general/SystemDma/wdm/general-systemdma-wdm.yml b/general/SystemDma/wdm/general-systemdma-wdm.yml
deleted file mode 100644
index aed5b8f2..00000000
--- a/general/SystemDma/wdm/general-systemdma-wdm.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: System DMA sample
- description: Demonstrates how a driver could use a system DMA controller to write data to a hardware location using V3 System DMA.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /general/SystemDma/wdm/SystemDma.sln