diff options
| author | Barry Golden <[email protected]> | 2015-07-30 16:03:24 -0700 |
|---|---|---|
| committer | Barry Golden <[email protected]> | 2015-07-30 16:03:24 -0700 |
| commit | 4dc90ad04d5e40851e2e370f487b7cc9a3be071b (patch) | |
| tree | c2e74dd18a743893c555d311f29ad9fba77b60c6 /storage | |
| parent | d3abcb10a801986a2956d6bbdfeb652bda1d9a74 (diff) | |
Update README.md
Diffstat (limited to 'storage')
| -rw-r--r-- | storage/class/cdrom/ReadMe.md | 4 | ||||
| -rw-r--r-- | storage/class/disk/ReadMe.md | 4 | ||||
| -rw-r--r-- | storage/ramdisk/ReadMe.md | 143 |
3 files changed, 28 insertions, 123 deletions
diff --git a/storage/class/cdrom/ReadMe.md b/storage/class/cdrom/ReadMe.md index fbdc3b53..187ca63b 100644 --- a/storage/class/cdrom/ReadMe.md +++ b/storage/class/cdrom/ReadMe.md @@ -7,7 +7,7 @@ Build the sample ---------------- You can build the sample in two ways: using Microsoft Visual Studio or the command line (*MSBuild*). -*Note:* When building in Visual Studio, INFVerifer will throw errors. This is intended. Fix those errors with your custom values to build successfully. +**Note:** When building in Visual Studio, INFVerifer will throw errors. This is intended. Fix those errors with your custom values to build successfully. Building a Driver Using Visual Studio ------------------------------------- @@ -20,7 +20,7 @@ The default Solution build configuration is Visual Studio Debug and Win32. 1. Open the driver project or solution in Visual Studio (find *samplename*.sln or *samplename*.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). Building a Driver Using the Command Line (MSBuild) diff --git a/storage/class/disk/ReadMe.md b/storage/class/disk/ReadMe.md index 4945350a..1acd4ed5 100644 --- a/storage/class/disk/ReadMe.md +++ b/storage/class/disk/ReadMe.md @@ -13,13 +13,13 @@ Building a Driver Using Visual Studio You build a driver the same way you build any project or solution in Visual Studio. When you create a new driver project using a Windows driver template, the template defines a default (active) project configuration and a default (active) solution build configuration. When you create a project from existing driver sources or convert existing driver code that was built with previous versions of the WDK, the conversion process preserves the target version information (operating systems and platform). -The default Solution build configuration is Windows 8.1 Debug and Win32. +The default Solution build configuration is Debug and Win32. ### To select a configuration and build a driver or an application 1. Open the driver project or solution in Visual Studio (find *samplename*.sln or *samplename*.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). Building a Driver Using the Command Line (MSBuild) diff --git a/storage/ramdisk/ReadMe.md b/storage/ramdisk/ReadMe.md index f1278157..1ef67580 100644 --- a/storage/ramdisk/ReadMe.md +++ b/storage/ramdisk/ReadMe.md @@ -3,102 +3,33 @@ RAMDisk Storage Driver Sample The RAMDisk storage driver sample demonstrates how to write a software only function driver using the Kernel Mode Driver Framework (KMDF). This driver creates a RAM disk drive.The RAM disk can be used like any other disk, but the contents of the disk will be lost when the computer is shut down. -**Note** - -To build this sample, you can use Microsoft Visual Studio 2013 (Express, Professional, or Ultimate) and Windows Driver Kit (WDK) 8.1 Update. You can get Visual Studio 2013 and WDK 8.1 Update [here](http://go.microsoft.com/fwlink/p/?LInkID=239721). - -You can also build this sample with Visual Studio 2013 (Professional or Ultimate) and [Windows Driver Kit (WDK) 8.1](http://go.microsoft.com/fwlink/p/?LInkID=391348). - -For Windows Driver Kit (WDK) 8 samples, download the [WDK 8 samples pack](%20http://go.microsoft.com/fwlink/?LinkId=317090). The samples in the WDK 8 samples pack will build only with Microsoft Visual Studio Professional 2012 (Professional or Ultimate) and WDK 8. - -Operating system requirements ------------------------------ - -Client - -Windows 7 - -Server - -Windows Server 2008 R2 - Build the sample ---------------- -Download and extract the sample -------------------------------- - -Click the download button on this page. Click **Save**, and then click **Open Folder**. Right click ramdisk.zip, and choose **Extract All**. Specify or browse to a folder for the extracted files. For example, you could extract to c:\\RamDiskStorageDriver. - -Open the driver solution in Visual Studio ------------------------------------------ +### Open the driver solution in Visual Studio ### Navigate to the folder that has the extracted sample. Double click the solution file, ramdisk.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 has two projects. There is a driver project named **WdfRamdisk** and a package project named **package** (lower case). -Set the configuration and platform in Visual Studio ---------------------------------------------------- +### Set the configuration and platform in Visual Studio In Visual Studio, in Solution Explorer, right click **Solution ‘ramdisk’ (2 projects)**, and choose **Configuration Manager**. Set the configuration and the platform. Make sure that the configuration and platform are the same for both the driver project and the package project. Do not check the **Deploy** boxes. Here are some examples of configuration and platform settings. -<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.</td> -</tr> -</tbody> -</table> - -Build the sample using Visual Studio ------------------------------------- +### Build the sample using Visual Studio ### In Visual Studio, on the **Build** menu, choose **Build Solution**. For more information about using Visual Studio to build a driver package, see [Building a Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554644). -Locate the built driver package -------------------------------- - -In File Explorer, navigate to the folder that contains your built driver package. The location of this folder varies depending on what you set for configuration and platform. For example, if your settings are Win7 Debug and x64, the package is your solution folder under x64\\Win7Debug\\Package. +### Locate the built driver package ### -The package contains these files: +In File Explorer, navigate to the folder that contains your built driver package. The location of this folder varies depending on what you set for configuration and platform. The package contains 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">Kmdfsamples.cat -A signed catalog file, which serves as the signature for the entire package.</td> -<td align="left">Ramdisk.inf -An information (INF) file that contains information needed to install the driver.</td> -</tr> -</tbody> -</table> +File | Description +-----| ----------- +Kmdfsamples.cat | A signed catalog file, which serves as the signature for the entire package. +Ramdisk.inf | An information (INF) file that contains information needed to install the driver. +WdfCoinstaller010xx.dll | The coinstaller for version 1.xx of KMDF. +WdfRamdisk.sys | The driver file. Run the sample -------------- @@ -107,8 +38,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 RAMDisk sample driver automatically or manually. -Automatic deployment --------------------- +###Automatic deployment ### Before you automatically deploy a driver, you must provision the target computer. For instructions, see [Configuring a Computer for Driver Deployment, Testing, and Debugging](http://msdn.microsoft.com/en-us/library/windows/hardware/). @@ -116,8 +46,7 @@ Before you automatically deploy a driver, you must provision the target computer 2. Check **Enable deployment**, and check **Remove previous driver versions before deployment**. For **Target Computer Name**, select the name of a target computer that you provisioned previously. Select **Hardware ID Driver Update**, and enter **Ramdisk** for the hardware ID. Click **OK**. 3. On the **Build** menu, choose **Deploy Package** or **Build Solution**. -Manual deployment ------------------ +### Manual deployment ### Before you manually deploy a driver, you must turn on test signing and install a certificate on the target computer. You also need to copy the [DevCon](http://msdn.microsoft.com/en-us/library/windows/hardware/ff544707) tool to the target computer. For instructions, see [Preparing a Computer for Manual Driver Deployment](http://msdn.microsoft.com/en-us/library/windows/hardware/dn265571). @@ -126,20 +55,18 @@ Before you manually deploy a driver, you must turn on test signing and install a **Devcon install ramdisk.inf Ramdisk** -View the installed driver in Device Manager -------------------------------------------- +### View the installed driver in Device Manager ### 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 **WDF Sample RAM disk Driver** (for example, this might be under the **Sample Device** node). The RAM disk sample is a root enumerated software driver. To see this in Device Manager, choose **Devices by connection** from the **View** menu. Locate **WDF Sample RAM disk Driver** as a child of the root node of the device tree. -Save a file on the RAM disk ---------------------------- +### Save a file on the RAM disk ### On the target computer, open a Command Prompt window as Administrator. Enter **R:** to switch to the RAM disk drive. In your Command Prompt window, enter **notepad** to open Notepad. Type some text in your notepad document, and then save the document on the R drive. In your Command Prompt window, enter **dir** to verify that the file was saved. -View Ramdisk entries in the Registry ------------------------------------- +### View Ramdisk entries in the Registry ### + The INF file in the RAM disk driver package specifies parameters that get saved in the registry. On the target computer, open the registry editor (Regedit.exe). In the registry editor, locate the Parameters key for the Ramdisk service. For example, @@ -147,42 +74,20 @@ The INF file in the RAM disk driver package specifies parameters that get saved The registry key has these entries: -<table> -<colgroup> -<col width="33%" /> -<col width="33%" /> -<col width="33%" /> -</colgroup> -<thead> -<tr class="header"> -<th align="left">Parameter -Value -Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left">DiskSize -0x100000 -The size, in bytes, of the RAM disk drive.</td> -<td align="left">DriveLetter -R: -The driver letter associated with the RAM disk drive.</td> -<td align="left">RootDirEntries -0x200 -The number of entries in the root directory.</td> -</tr> -</tbody> -</table> +Parameter | Value | Description +----------------|---------|------------ +DiskSize |0x100000 |The size, in bytes, of the RAM disk drive. +DriveLetter |R: |The driver letter associated with the RAM disk drive. +RootDirEntries |0x200 |The number of entries in the root directory.</td> Using MSBuild ------------- As an alternative to building the RAMDisk Storage 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, ramdisk.sln. Use the [MSBuild](http://go.microsoft.com/fwlink/p/?linkID=262804) command to build the solution. Here are some examples: -**msbuild /p:configuration=”Win7 Debug” /p:platform=”x64” ramdisk.sln** +**msbuild /p:configuration="Debug" /p:platform="x64" ramdisk.sln** -**msbuild /p:configuration=”Win8 Release” /p:platform=”win32” ramdisk.sln** +**msbuild /p:configuration="Release" /p:platform="Win32" ramdisk.sln** For more information about using [MSBuild](http://go.microsoft.com/fwlink/p/?linkID=262804) to build a driver package, see [Building a Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554644). |
