summaryrefslogtreecommitdiff
path: root/general
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2015-08-06 20:07:53 -0700
committerBarry Golden <[email protected]>2015-08-06 20:07:53 -0700
commit7c089b4b332b8a8bd2e29672bbf4f6ee430b3e77 (patch)
tree8a7e461efc0c2e77b9cd82b3968e38fd5efef7b4 /general
parent9026073a419b5ef68fb46d4f7fae52dbef09dbe1 (diff)
Update README.md
Diffstat (limited to 'general')
-rw-r--r--general/SystemDma/wdm/ReadMe.md2
-rw-r--r--general/cancel/ReadMe.md2
-rw-r--r--general/echo/umdf2/ReadMe.md9
-rw-r--r--general/echo/umdfSocketEcho/ReadMe.md2
-rw-r--r--general/event/ReadMe.md2
-rw-r--r--general/ioctl/kmdf/ReadMe.md6
-rw-r--r--general/ioctl/wdm/ReadMe.md2
-rw-r--r--general/obcallback/ReadMe.md6
-rw-r--r--general/pcidrv/ReadMe.md2
-rw-r--r--general/toaster/toastDrv/ReadMe.md4
-rw-r--r--general/toaster/umdf2/ReadMe.md2
-rw-r--r--general/tracing/evntdrv/ReadMe.md4
-rw-r--r--general/tracing/tracedriver/ReadMe.md2
13 files changed, 19 insertions, 26 deletions
diff --git a/general/SystemDma/wdm/ReadMe.md b/general/SystemDma/wdm/ReadMe.md
index 6b15c480..a077fe8d 100644
--- a/general/SystemDma/wdm/ReadMe.md
+++ b/general/SystemDma/wdm/ReadMe.md
@@ -5,7 +5,7 @@ This sample demonstrates the usage of V3 System DMA. It shows how a driver could
The sample consists of a legacy device driver and a Win32 console mode test application. The test application opens a handle to the device exposed by the driver and makes a DeviceIoControl call to initiate the example system DMA. To understand how the V3 system DMA calls are invoked please study SDmaWrite() in SDma.c.
-**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.
+**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
--------------
diff --git a/general/cancel/ReadMe.md b/general/cancel/ReadMe.md
index c2b09ead..2a1be648 100644
--- a/general/cancel/ReadMe.md
+++ b/general/cancel/ReadMe.md
@@ -21,5 +21,5 @@ To test this driver, run Testapp.exe, which is a simple Win32 multithreaded cons
`Usage: testapp <NumberOfThreads>`
-**Note**  The `NumberOfThreads` command-line parameter is limited to a maximum of 10 threads; the default value if no parameter is specified is 1. The main thread waits for user input. If you press Q, the application exits gracefully; otherwise, it exits the process abruptly and forces all the threads to be terminated and all pending I/O operations to be canceled. Other threads perform I/O asynchronously in a loop. After every overlapped read, the thread goes into an alertable sleep and wakes as soon as the completion routine runs, which occurs when the driver completes the read IRP. You should run multiple instances of the application to stress test the driver.
+**Note** The `NumberOfThreads` command-line parameter is limited to a maximum of 10 threads; the default value if no parameter is specified is 1. The main thread waits for user input. If you press Q, the application exits gracefully; otherwise, it exits the process abruptly and forces all the threads to be terminated and all pending I/O operations to be canceled. Other threads perform I/O asynchronously in a loop. After every overlapped read, the thread goes into an alertable sleep and wakes as soon as the completion routine runs, which occurs when the driver completes the read IRP. You should run multiple instances of the application to stress test the driver.
diff --git a/general/echo/umdf2/ReadMe.md b/general/echo/umdf2/ReadMe.md
index bb45c52a..ba3ffa36 100644
--- a/general/echo/umdf2/ReadMe.md
+++ b/general/echo/umdf2/ReadMe.md
@@ -14,15 +14,10 @@ Related technologies
[User-Mode Driver Framework](http://msdn.microsoft.com/en-us/library/windows/hardware/ff560456)
-Download and extract the sample
--------------------------------
-
-Click the download button on this page. Click **Save**, and then click **Open Folder**. Right click the zip file, and choose **Extract All**. Specify or browse to a folder for the extracted files. For example, you could extract to c:\\umdf2echo.
-
Open the driver solution in Visual Studio
-----------------------------------------
-Navigate to the folder that has the extracted sample. Double click the solution file (umdf2echo.sln). In Microsoft Visual Studio, locate Solution Explorer. (If this is not already open, choose **Solution Explorer** from the **View** menu.) In Solution Explorer, you can see one solution that contains three projects. There is a driver project (Driver-\>AutoSync-\>echo), an application project (Exe-\>echoapp), and a package project named **package** (lower case).
+In Microsoft Visual Studio, open the solution file (umdf2echo.sln). Choose **Solution Explorer** from the **View** menu. In Solution Explorer, you can see one solution that contains three projects. There is a driver project (Driver-\>AutoSync-\>echo), an application project (Exe-\>echoapp), and a package project named **package** (lower case).
Set the configuration and platform in Visual Studio
---------------------------------------------------
@@ -70,7 +65,7 @@ Build the sample using MSBuild
As an alternative to building the driver sample in Visual Studio, you can build it in a Visual Studio Command Prompt window. In Visual Studio, on the **Tools** menu, choose **Visual Studio Command Prompt**. In the Visual Studio Command Prompt window, navigate to the folder that has the solution file, umdf2echo.sln. Use the MSBuild command to build the solution. Here is an example:
-**msbuild /p:configuration="Release" /p:platform="Win32" umdf2echo.sln
+**msbuild /p:configuration="Release" /p:platform="Win32" umdf2echo.sln**
For more information about using MSBuild to build a driver package, see [Building a Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554644).
diff --git a/general/echo/umdfSocketEcho/ReadMe.md b/general/echo/umdfSocketEcho/ReadMe.md
index ed4ce05f..8015044b 100644
--- a/general/echo/umdfSocketEcho/ReadMe.md
+++ b/general/echo/umdfSocketEcho/ReadMe.md
@@ -32,7 +32,7 @@ To install the UMDF Echo sample driver from the command line, do the following:
2. Copy the UMDF coinstaller, WUDFUpdate\_*MMmmmm*.dll, from the \\redist\\wdf\\\<architecture\> directory to the same directory (for example, C:\\socketechoSample).
- **Note**: You can obtain redistributable framework updates by downloading the *wdfcoinstaller.msi* package from [WDK 8 Redistributable Components](http://go.microsoft.com/fwlink/p/?LinkID=226396). This package performs a silent install into the directory of your Windows Driver Kit (WDK) installation. You will see no confirmation that the installation has completed. You can verify that the redistributables have been installed on top of the WDK by ensuring there is a redist\\wdf directory under the root directory of the WDK, %ProgramFiles(x86)%\\Windows Kits\\8.0.
+ **Note** You can obtain redistributable framework updates by downloading the *wdfcoinstaller.msi* package from [WDK 8 Redistributable Components](http://go.microsoft.com/fwlink/p/?LinkID=226396). This package performs a silent install into the directory of your Windows Driver Kit (WDK) installation. You will see no confirmation that the installation has completed. You can verify that the redistributables have been installed on top of the WDK by ensuring there is a redist\\wdf directory under the root directory of the WDK, %ProgramFiles(x86)%\\Windows Kits\\8.0.
3. Navigate to the directory that contains the INF file and binaries (for example, cd /d c:\\socketechoSample), and run DevCon.exe as follows:
diff --git a/general/event/ReadMe.md b/general/event/ReadMe.md
index 8b8bebaa..c091af5a 100644
--- a/general/event/ReadMe.md
+++ b/general/event/ReadMe.md
@@ -9,7 +9,7 @@ This sample demonstrates two different ways a Windows kernel-mode driver can not
There are two advantages of IRP-based approach over the event-based approach. First, the driver can send a message to the application along with the event notification. Second, the driver routines don't have to run in the context of the process that made the request. Instead, the application can send a synchronous or asynchronous (overlapped) I/O control request to the driver.
-**Note**  This sample driver is not a Plug and Play driver. This is a minimal driver meant to demonstrate a feature of the operating system. Neither this driver nor its sample programs are intended for use in a production environment. Rather, they are intended for educational purposes and as a skeleton driver.
+**Note** This sample driver is not a Plug and Play driver. This is a minimal driver meant to demonstrate a feature of the operating system. Neither this driver 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
diff --git a/general/ioctl/kmdf/ReadMe.md b/general/ioctl/kmdf/ReadMe.md
index 4cdee4d4..848acd06 100644
--- a/general/ioctl/kmdf/ReadMe.md
+++ b/general/ioctl/kmdf/ReadMe.md
@@ -37,15 +37,13 @@ If the build succeeds, you will find the driver, nonpnp.sys, and the test applic
To test this driver, copy the nonpnp.inf into the same folder as the nonpnpapp.exe and the wdfcoinstaller\<version\>.dll .
-**Note**  
-
-You can obtain redistributable framework updates by downloading the *wdfcoinstaller.msi* package from [WDK 8 Redistributable Components](http://go.microsoft.com/fwlink/p/?LinkID=226396). This package performs a silent install into the directory of your Windows Driver Kit (WDK) installation. You will see no confirmation that the installation has completed. You can verify that the redistributables have been installed on top of the WDK by ensuring there is a redist\\wdf directory under the root directory of the WDK, %ProgramFiles(x86)%\\Windows Kits\\8.0.
+**Note** You can obtain redistributable framework updates by downloading the *wdfcoinstaller.msi* package from [WDK 8 Redistributable Components](http://go.microsoft.com/fwlink/p/?LinkID=226396). This package performs a silent install into the directory of your Windows Driver Kit (WDK) installation. You will see no confirmation that the installation has completed. You can verify that the redistributables have been installed on top of the WDK by ensuring there is a redist\\wdf directory under the root directory of the WDK, %ProgramFiles(x86)%\\Windows Kits\\8.0.
Next, run nonpnpapp.exe, a simple Win32 multithreaded console mode application. The driver will be automatically loaded and started. When you exit the app, the driver will be stopped and removed.
Usage: nonpnpapp.exe (-l) (-v version)
-**Note**: This application first tries to open the device (\\Device\\FileIo). If the device doesn't exist, it takes that as a hint that the driver is not loaded and tries to load the driver using service control manager API. If the service is loaded successfully, it tries to open the device again. If successful, it makes all four different types of DeviceControl calls to the driver. After that it makes a WriteFile call with an arbitrary size buffer. The driver, in response, writes that buffer to a file opened in the Create request. The name of the file was provided by the application as part of the device name and the directory path is hardcoded to %WINDIR%\\temp. When the WriteFile returns, the application makes a ReadFile call to read the file through the driver, and then compares the data returned by the driver with the one it originally wrote. If you specify -l option in command line, the application does this Write and Read operation in an infinite loop. The -v command line option is used to specify the version of the KMDF coinstaller (wdfcoinstaller\<version\>.dll) to load. If none is specified then it loads the coinstaller for v1.0 (wdfcoinstaller01000.dll)
+**Note** This application first tries to open the device (\\Device\\FileIo). If the device doesn't exist, it takes that as a hint that the driver is not loaded and tries to load the driver using service control manager API. If the service is loaded successfully, it tries to open the device again. If successful, it makes all four different types of DeviceControl calls to the driver. After that it makes a WriteFile call with an arbitrary size buffer. The driver, in response, writes that buffer to a file opened in the Create request. The name of the file was provided by the application as part of the device name and the directory path is hardcoded to %WINDIR%\\temp. When the WriteFile returns, the application makes a ReadFile call to read the file through the driver, and then compares the data returned by the driver with the one it originally wrote. If you specify -l option in command line, the application does this Write and Read operation in an infinite loop. The -v command line option is used to specify the version of the KMDF coinstaller (wdfcoinstaller\<version\>.dll) to load. If none is specified then it loads the coinstaller for v1.0 (wdfcoinstaller01000.dll)
### WDF SECTION
diff --git a/general/ioctl/wdm/ReadMe.md b/general/ioctl/wdm/ReadMe.md
index 94191a33..fcbf71f2 100644
--- a/general/ioctl/wdm/ReadMe.md
+++ b/general/ioctl/wdm/ReadMe.md
@@ -7,7 +7,7 @@ The sample shows how the user input and output buffers specified in the **Device
The sample consists of a legacy device driver and a Win32 console test application. The test application opens a handle to the device exposed by the driver and makes all four different **DeviceIoControl** calls, one after another. To understand how the IRP fields are set the I/O manager, you should run the checked build version of the driver and look at the debug output.
-**Note**  This sample driver is not a Plug and Play driver. This is a minimal driver meant to demonstrate a feature of the operating system. Neither this driver nor its sample programs are intended for use in a production environment. Instead, they are intended for educational purposes and as a skeleton driver.
+**Note** This sample driver is not a Plug and Play driver. This is a minimal driver meant to demonstrate a feature of the operating system. Neither this driver nor its sample programs are intended for use in a production environment. Instead, they are intended for educational purposes and as a skeleton driver.
Run the sample
diff --git a/general/obcallback/ReadMe.md b/general/obcallback/ReadMe.md
index 7efc2741..d91a209d 100644
--- a/general/obcallback/ReadMe.md
+++ b/general/obcallback/ReadMe.md
@@ -20,12 +20,12 @@ C:\> notepad
C:\> tlist (locate the process ID of notepad.exe)
-C:\> kill –f 2329 (attempt to kill off the notepad.exe with a PID of 2329)
-process notepad.exe (2329) – ‘Untitled – Notepad’ could not be killed
+C:\> kill -f 2329 (attempt to kill off the notepad.exe with a PID of 2329)
+process notepad.exe (2329) - 'Untitled – Notepad' could not be killed
C:\> obcallbacktestctrl.exe -deprotect (remove the protections on the notepad process)
-C:\> kill –f 2329 (attempt to kill off the process – which will succeed)
+C:\> kill -f 2329 (attempt to kill off the process – which will succeed)
C:\> obcallbacktestctrl.exe -uninstall (uninstall the kernel driver)
```
diff --git a/general/pcidrv/ReadMe.md b/general/pcidrv/ReadMe.md
index 39d4a2d6..fcd56df2 100644
--- a/general/pcidrv/ReadMe.md
+++ b/general/pcidrv/ReadMe.md
@@ -141,7 +141,7 @@ Other menu options of myping applications are:
- Exit: Terminate the application.
-**Note**  You can use this application only on a device installed in the standalone configuration. If you run it on a device that's installed as a miniport, you will get an error message. For such devices, you can use the system provided ping.exe.
+**Note** You can use this application only on a device installed in the standalone configuration. If you run it on a device that's installed as a miniport, you will get an error message. For such devices, you can use the system provided ping.exe.
RESOURCES
---------
diff --git a/general/toaster/toastDrv/ReadMe.md b/general/toaster/toastDrv/ReadMe.md
index 108811a4..326d40a9 100644
--- a/general/toaster/toastDrv/ReadMe.md
+++ b/general/toaster/toastDrv/ReadMe.md
@@ -56,9 +56,9 @@ Build the sample using MSBuild
As an alternative to building the Toaster sample in Visual Studio, you can build it in a Visual Studio Command Prompt window. In Visual Studio, on the **Tools** menu, choose **Visual Studio Command Prompt**. In the Visual Studio Command Prompt window, navigate to the folder that has the solution file, Toaster.sln. Use the MSBuild command to build the solution. Here are some examples:
-**msbuild /p:configuration=”Win7 Debug” /p:platform=”x64” Toaster.sln**
+**msbuild /p:configuration="Debug" /p:platform="x64" Toaster.sln**
-**msbuild /p:configuration=”Win8 Release” /p:platform=”Win32” Toaster.sln**
+**msbuild /p:configuration="Release" /p:platform="Win32" Toaster.sln**
For more information about using MSBuild to build a driver package, see [Building a Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554644).
diff --git a/general/toaster/umdf2/ReadMe.md b/general/toaster/umdf2/ReadMe.md
index 7f2b6a56..9dcdd158 100644
--- a/general/toaster/umdf2/ReadMe.md
+++ b/general/toaster/umdf2/ReadMe.md
@@ -45,7 +45,7 @@ Build the sample using MSBuild
------------------------------
As an alternative to building the driver sample in Visual Studio, you can build it in a Visual Studio Command Prompt window. In Visual Studio, on the **Tools** menu, choose **Visual Studio Command Prompt**. In the Visual Studio Command Prompt window, navigate to the folder that has the solution file, Umdf2toaster.sln. Use the MSBuild command to build the solution. Here is an example:
-**msbuild /p:configuration=”Win8 Release” /p:platform=”Win32” Umdf2toaster.sln**
+**msbuild /p:configuration="Release" /p:platform="Win32" Umdf2toaster.sln**
For more information about using MSBuild to build a driver package, see [Building a Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554644).
diff --git a/general/tracing/evntdrv/ReadMe.md b/general/tracing/evntdrv/ReadMe.md
index a560a0a4..4e64ecae 100644
--- a/general/tracing/evntdrv/ReadMe.md
+++ b/general/tracing/evntdrv/ReadMe.md
@@ -5,7 +5,7 @@ Eventdrv is a sample kernel-mode trace provider and driver. The driver does not
Evntdrv registers as a provider by calling the [**EtwRegister**](http://msdn.microsoft.com/en-us/library/windows/hardware/ff545603) API. If the registration is successful, it logs a StartEvent with the device's name, the length of the name, and the status code. Then, when the sample receives a DeviceIOControl call, it logs a SampleEventA event. Finally, when the driver gets unloaded, it logs an UnloadEvent event with a pointer to the device object
-**Note**  The Windows Pre-Processor (WPP) Tracing tools such as TraceView.exe cannot be used to start, stop, or view traces.
+**Note** The Windows Pre-Processor (WPP) Tracing tools such as TraceView.exe cannot be used to start, stop, or view traces.
Run the sample
@@ -19,7 +19,7 @@ Run the sample
Installing the manifest creates registry keys that enable tools to find the resource and message files that contain event provider information. For further details about the WevtUtil.exe tool, see the MSDN Library.
- **Note**  Using a Visual Studio Command windows sets up the environment variables you need to run the tracing tools for this sample.
+ **Note** Using a Visual Studio Command windows sets up the environment variables you need to run the tracing tools for this sample.
2. Make a folder in the system directory called ETWDriverSample (for example, C:\\ETWDriverSample).
diff --git a/general/tracing/tracedriver/ReadMe.md b/general/tracing/tracedriver/ReadMe.md
index 3e95d383..064fb133 100644
--- a/general/tracing/tracedriver/ReadMe.md
+++ b/general/tracing/tracedriver/ReadMe.md
@@ -29,7 +29,7 @@ To test the Tracedrv event tracing provider, use the following procedure.
tracelog -start TestTracedrv -guid tracedrv.ctl -f tracedrv.etl -flag 1
```
- **Note**  Note: Without the -flag parameter, Tracedrv will not generate any trace messages.
+ **Note** Without the -flag parameter, Tracedrv will not generate any trace messages.
5. To generate trace messages, run Tracectl.exe. This executable file is built when you build the solution. Each time you type a character, other than **Q** or **q**, Tracectl sends an IOCTL to the driver that signals it to generate trace messages. To stop Tracectl, type **Q** or **q**.
6. To stop the trace session, use the following Tracelog command.