summaryrefslogtreecommitdiff
path: root/storage
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 /storage
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 'storage')
-rw-r--r--storage/class/cdrom/README.md70
-rw-r--r--storage/class/cdrom/storage-class-cdrom.yml12
-rw-r--r--storage/class/classpnp/README.md21
-rw-r--r--storage/class/classpnp/storage-class-classpnp.yml12
-rw-r--r--storage/class/disk/README.md46
-rw-r--r--storage/class/disk/storage-class-disk.yml12
-rw-r--r--storage/filters/addfilter/README.md20
-rw-r--r--storage/filters/addfilter/storage-filters-addfilter.yml12
-rw-r--r--storage/iscsi/README.md22
-rw-r--r--storage/iscsi/storage-iscsi.yml12
-rw-r--r--storage/miniports/lsi_u3/README.md23
-rw-r--r--storage/miniports/lsi_u3/storage-miniports-lsi-u3.yml12
-rw-r--r--storage/miniports/storahci/README.md18
-rw-r--r--storage/miniports/storahci/storage-miniports-storahci.yml12
-rw-r--r--storage/msdsm/README.md69
-rw-r--r--storage/msdsm/storage-msdsm.yml12
-rw-r--r--storage/sfloppy/README.md21
-rw-r--r--storage/sfloppy/storage-sfloppy.yml12
-rw-r--r--storage/tools/spti/README.md18
-rw-r--r--storage/tools/spti/storage-tools-spti.yml12
20 files changed, 183 insertions, 265 deletions
diff --git a/storage/class/cdrom/README.md b/storage/class/cdrom/README.md
index 92ddf79b..c299e01b 100644
--- a/storage/class/cdrom/README.md
+++ b/storage/class/cdrom/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: CDROM Storage Class Driver
+description: Provide access to CD, DVD and Blu-ray drives, supports Plug and Play, Power Management, and AutoRun (media change notification).
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: CDROM Storage Class Driver
platform: KMDF
@@ -7,62 +17,50 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617971
--->
-
-CDROM Storage Class Driver
-==========================
+# CDROM Storage Class Driver
The CD ROM driver is used to provide access to CD, DVD and Blu-ray drives. It supports Plug and Play, Power Management, and AutoRun (media change notification).
-Build the sample
-----------------
+## 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.
-Building a Driver Using Visual Studio
--------------------------------------
+## 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 Visual Studio 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, 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).
+1. Open the driver project or solution in Visual Studio (find *samplename*.sln or *samplename*.vcxproj).
+1. Right-click the solution in the **Solutions Explorer** and select **Configuration Manager**.
+1. 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.
+1. From the Build menu, click **Build Solution** (Ctrl+Shift+B).
-Building a Driver Using the Command Line (MSBuild)
---------------------------------------------------
+## Building a Driver Using the Command Line (MSBuild)
You can build a driver from the command line using the Visual Studio Command Prompt window and the Microsoft Build Engine (MSBuild.exe) Previous versions of the WDK used the Windows Build utility (Build.exe) and provided separate build environment windows for each of the supported build configurations. You can now use the Visual Studio Command Prompt window for all build configurations.
-### To select a configuration and build a driver or an application
+1. Open a Visual Studio Command Prompt window at the **Start** screen. From this window you can use MsBuild.exe to build any Visual Studio project by specifying the project (.VcxProj) or solutions (.Sln) file.
+1. Navigate to the project directory and enter the **MSbuild** command for your target. For example, to perform a clean build of a Visual Studio driver project called *filtername*.vcxproj, navigate to the project directory and enter the following MSBuild command:
-1. Open a Visual Studio Command Prompt window at the **Start** screen. From this window you can use MsBuild.exe to build any Visual Studio project by specifying the project (.VcxProj) or solutions (.Sln) file.
-2. Navigate to the project directory and enter the **MSbuild** command for your target. For example, to perform a clean build of a Visual Studio driver project called *filtername*.vcxproj, navigate to the project directory and enter the following MSBuild command: **msbuild /t:clean /t:build .\\***samplename***.vcxproj**.
+ **msbuild /t:clean /t:build .\\***samplename***.vcxproj**.
-Run the sample
---------------
-
-Installation and Operation
---------------------------
+## Installation and Operation
The in-box CD ROM driver is protected by the system, and thus a normal device driver update attempt through the Device Manager will fail. Users are not encouraged to replace the in-box CD ROM driver. The following work-around is provided in case there is a need, but the users are warned that this may harm the system.
-1. Locate the "cdrom.inf" file in the binary output directory, and update the file by replacing all "cdrom.sys" occurrences with "mycdrom.sys".
-2. Rename the "cdrom.inf" file to "mycdrom.inf".
-3. Copy "mycdrom.sys" and "mycdrom.inf" from the binary output directory to the test machine, if applicable.
-4. Launch the Device Manager
-5. Select the appropriate device under the "DVD/CD-ROM drives" category.
-6. On the right-click menu, select "Update Driver Software...".
-7. Select "Browse my computer for driver software".
-8. Select "Let me pick from a list of device drivers on my computer".
-9. Click "Have Disk...", and point to the directory that contains "mycdrom.inf" and "mycdrom.sys".
-10. Click "Next". If you get a warning dialog about installing unsigned driver, click "Yes".
-11. Click "Next" to complete the driver upgrade.
-12. After installation completes successfully, "mycdrom.sys" will be the effective driver for the device, "cdrom.sys" will no longer be used.
+1. Locate the "cdrom.inf" file in the binary output directory, and update the file by replacing all "cdrom.sys" occurrences with "mycdrom.sys".
+1. Rename the "cdrom.inf" file to "mycdrom.inf".
+1. Copy "mycdrom.sys" and "mycdrom.inf" from the binary output directory to the test machine, if applicable.
+1. Launch the Device Manager
+1. Select the appropriate device under the "DVD/CD-ROM drives" category.
+1. On the right-click menu, select "Update Driver Software...".
+1. Select "Browse my computer for driver software".
+1. Select "Let me pick from a list of device drivers on my computer".
+1. Click "Have Disk...", and point to the directory that contains "mycdrom.inf" and "mycdrom.sys".
+1. Click "Next". If you get a warning dialog about installing unsigned driver, click "Yes".
+1. Click "Next" to complete the driver upgrade.
+1. After installation completes successfully, "mycdrom.sys" will be the effective driver for the device, "cdrom.sys" will no longer be used.
For more information, see [CD-ROM Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff551391) in the storage technologies design guide.
-
diff --git a/storage/class/cdrom/storage-class-cdrom.yml b/storage/class/cdrom/storage-class-cdrom.yml
deleted file mode 100644
index 9a18eaa4..00000000
--- a/storage/class/cdrom/storage-class-cdrom.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: CDROM Storage Class Driver
- description: Provide access to CD, DVD and Blu-ray drives, supports Plug and Play, Power Management, and AutoRun (media change notification).
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/class/cdrom/cdrom.sln
diff --git a/storage/class/classpnp/README.md b/storage/class/classpnp/README.md
index ec3c0e9b..69df73f3 100644
--- a/storage/class/classpnp/README.md
+++ b/storage/class/classpnp/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: ClassPnP Class Driver Library
+description: A library storage class driver used by disk, CDROM, and the tape class drivers.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: ClassPnP Class Driver Library
platform: WDM
@@ -7,19 +17,16 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617978
--->
+# ClassPnP Storage Class Driver Library
-ClassPnP Storage Class Driver Library
-=====================================
-
-This library is the library for all storage drivers. It simplifies writing a storage class driver by implementing 90 percent of the code that you need to support Plug and Play (PnP), power management, and so on. This library is used by disk, CDROM, and the tape class drivers.
+This is the library for all storage drivers. It simplifies writing a storage class driver by implementing 90 percent of the code that you need to support Plug and Play (PnP), power management, and so on. This library is used by disk, CDROM, and the tape class drivers.
## Universal Windows Driver Compliant
+
This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
-Installation and Operation
---------------------------
+## Installation and Operation
The storage class drivers are used to interact with mass storage devices along with appropriate port driver. The class drivers are layered above the port drivers and manage mass storage devices of a specific class, regardless of their bus type. The classpnp sample contains the common routines that are required for all storage class drivers such as PnP and power management. It also provides I/O and error handling support.
For more information, see [Introduction to Storage Class Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff559215) in the storage technologies design guide.
-
diff --git a/storage/class/classpnp/storage-class-classpnp.yml b/storage/class/classpnp/storage-class-classpnp.yml
deleted file mode 100644
index 727fcb7b..00000000
--- a/storage/class/classpnp/storage-class-classpnp.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: ClassPnP Class Driver Library
- description: A library storage class driver used by disk, CDROM, and the tape class drivers.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/class/classpnp/classpnp.sln
diff --git a/storage/class/disk/README.md b/storage/class/disk/README.md
index c4032547..bc3de773 100644
--- a/storage/class/disk/README.md
+++ b/storage/class/disk/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: Disk Class Driver
+description: A class driver for disk devices.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: Disk Class Driver
platform: WDM
@@ -7,48 +17,32 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617979
--->
-
-Disk Class Driver
-=================
+# Disk Class Driver
The disk class driver sample is used for managing disk devices
-Build the sample
-----------------
-
You can build the sample in two ways: using Microsoft Visual Studio or the command line (*MSBuild*).
-Building a Driver Using Visual Studio
--------------------------------------
+## 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 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, 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).
+1. Open the driver project or solution in Visual Studio (find *samplename*.sln or *samplename*.vcxproj).
+1. Right-click the solution in the **Solutions Explorer** and select **Configuration Manager**.
+1. 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.
+1. From the Build menu, click **Build Solution** (Ctrl+Shift+B).
-Building a Driver Using the Command Line (MSBuild)
---------------------------------------------------
+## Building a Driver Using the Command Line (MSBuild)
You can build a driver from the command line using the Visual Studio Command Prompt window and the Microsoft Build Engine (MSBuild.exe) Previous versions of the WDK used the Windows Build utility (Build.exe) and provided separate build environment windows for each of the supported build configurations. You can now use the Visual Studio Command Prompt window for all build configurations.
-### To select a configuration and build a driver or an application
+1. Open a Visual Studio Command Prompt window at the **Start** screen. From this window you can use MsBuild.exe to build any Visual Studio project by specifying the project (.VcxProj) or solutions (.Sln) file.
+1. Navigate to the project directory and enter the **MSbuild** command for your target. For example, to perform a clean build of a Visual Studio driver project called *filtername*.vcxproj, navigate to the project directory and enter the following MSBuild command: **msbuild /t:clean /t:build .\\***samplename***.vcxproj**.
-1. Open a Visual Studio Command Prompt window at the **Start** screen. From this window you can use MsBuild.exe to build any Visual Studio project by specifying the project (.VcxProj) or solutions (.Sln) file.
-2. Navigate to the project directory and enter the **MSbuild** command for your target. For example, to perform a clean build of a Visual Studio driver project called *filtername*.vcxproj, navigate to the project directory and enter the following MSBuild command: **msbuild /t:clean /t:build .\\***samplename***.vcxproj**.
-
-Run the sample
---------------
-
-Installation and Operation
---------------------------
+## Installation and Operation
The disk class driver is used to interact with disk devices along with the appropriate port driver. The disk class driver is layered above the port driver and manages disk devices regardless of their bus type. This driver attaches to the disk devices that are enumerated by all of the storage port drivers. This driver exposes the required functionality to the file system drivers to access the disk devices.
For more information, see [Introduction to Storage Class Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff559215) in the storage technologies design guide.
-
diff --git a/storage/class/disk/storage-class-disk.yml b/storage/class/disk/storage-class-disk.yml
deleted file mode 100644
index 5b97a768..00000000
--- a/storage/class/disk/storage-class-disk.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: Disk Class Driver
- description: A class driver for disk devices.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/class/disk/disk.sln
diff --git a/storage/filters/addfilter/README.md b/storage/filters/addfilter/README.md
index 8d3084c4..df1aabe7 100644
--- a/storage/filters/addfilter/README.md
+++ b/storage/filters/addfilter/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: AddFilter Storage Filter Tool
+description: A command-line application that adds and removes filter drivers for a given drive or volume.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: AddFilter Storage Filter Tool
platform: Application
@@ -7,14 +17,11 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617980
--->
-
-AddFilter Storage Filter Tool
-=============================
+# AddFilter Storage Filter Tool
Addfilter is a command-line application that adds and removes filter drivers for a given drive or volume. This application demonstrates how to insert a filter driver into the driver stack of a device. The sample illustrates how to insert such a filter driver by using the SetupDi API.
-Installation and Operation
---------------------------
+## Installation and Operation
This initial sample does not check the filter for validity before it is added to the driver stack. If an invalid filter is added, the specified device might no longer be accessible.
@@ -30,7 +37,6 @@ Because the sample currently enumerates only disk devices, the sample can operat
The following is the command line usage for addfilter:
-**addfilter [/listdevices] [/device device\_name] [/add filter] [/remove filter]**
+ **addfilter [/listdevices] [/device device\_name] [/add filter] [/remove filter]**
If the device name is not supplied, settings will apply to all devices. If there is no /add or /remove argument, a list of currently installed drivers will be printed.
-
diff --git a/storage/filters/addfilter/storage-filters-addfilter.yml b/storage/filters/addfilter/storage-filters-addfilter.yml
deleted file mode 100644
index 4b23ef39..00000000
--- a/storage/filters/addfilter/storage-filters-addfilter.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: AddFilter Storage Filter Tool
- description: A command-line application that adds and removes filter drivers for a given drive or volume.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/filters/addfilter/addfilter.sln
diff --git a/storage/iscsi/README.md b/storage/iscsi/README.md
index 320e1206..bcaf036e 100644
--- a/storage/iscsi/README.md
+++ b/storage/iscsi/README.md
@@ -1,20 +1,26 @@
+---
+topic: sample
+name: iSCSI WMI Client
+description: A WMI iSCSI miniport that can be tested using the iSCSICLI.exe tool, the iSCSI Initiator Properties page, the WBEMTEST.exe tool, and customized WMI scripts.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
- name: iSCSI WMI Client
+ name: iSCSI WMI Client
platform: WDM
language: cpp
category: Storage
- description: A WMI iSCSI miniport that can be tested using the iSCSICLI.exe tool, the iSCSI Initiator Properties page, the WBEMTEST.exe tool, and customized WMI scripts.
+ description: A WMI iSCSI miniport that can be tested using the iSCSICLI.exe tool, the iSCSI Initiator Properties page, the WBEMTEST.exe tool, and customized WMI scripts.
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617981
--->
-
-iSCSI WMI Client
-================
+# iSCSI WMI Client
WMI Implementation in an iSCSI miniport can be tested using the iSCSICLI.exe tool, the iSCSI Initiator Properties page, the WBEMTEST.exe tool, and customized WMI scripts
-Installation and Operation
---------------------------
+## Installation and Operation
The iSCSI WMI sample uses the iSCSI WMI Class, and MOF definitions described at [iSCSI WMI Classes](http://msdn.microsoft.com/en-us/library/windows/hardware/ff561578) in the storage WMI classes reference. Their corresponding class structure details are described at [iSCSI Structures](http://msdn.microsoft.com/en-us/library/windows/hardware/ff561569).
-
diff --git a/storage/iscsi/storage-iscsi.yml b/storage/iscsi/storage-iscsi.yml
deleted file mode 100644
index e9759d59..00000000
--- a/storage/iscsi/storage-iscsi.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: iSCSI WMI Client
- description: A WMI iSCSI miniport that can be tested using the iSCSICLI.exe tool, the iSCSI Initiator Properties page, the WBEMTEST.exe tool, and customized WMI scripts.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/iscsi/iscsi.sln
diff --git a/storage/miniports/lsi_u3/README.md b/storage/miniports/lsi_u3/README.md
index 2ca91c64..c9ba64ab 100644
--- a/storage/miniports/lsi_u3/README.md
+++ b/storage/miniports/lsi_u3/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: LSI_U3 StorPort Miniport Driver
+description: An adapter driver for use with Parallel SCSI Host Bus Adapters or on-motherboard solutions that use the LSI 53C1010 SCSI ASIC.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: LSI_U3 StorPort Miniport Driver
platform: WDM
@@ -7,22 +17,19 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617982
--->
-
-LSI\_U3 StorPort Miniport Driver
-================================
+# LSI\_U3 StorPort Miniport Driver
The LSI\_U3 sample is an adapter driver for use with Parallel SCSI Host Bus Adapters or on-motherboard solutions that use the LSI 53C1010 SCSI ASIC.These sources are presented for your education and use with these generally available LSI SCSI-class adapters. The intended use of this sample driver is for this purpose only.
## Universal Windows Driver Compliant
+
This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
-Installation and Operation
---------------------------
+## Installation and Operation
The operation of this sample requires one of the following hardware items:
-- Parallel SCSI Host Bus Adapter
-- On-motherboard solution that uses the LSI 53C1010 SCSI ASIC
+- Parallel SCSI Host Bus Adapter
+- On-motherboard solution that uses the LSI 53C1010 SCSI ASIC
For more information, see [Storport Miniport Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff567562) in the storage technologies design guide.
-
diff --git a/storage/miniports/lsi_u3/storage-miniports-lsi-u3.yml b/storage/miniports/lsi_u3/storage-miniports-lsi-u3.yml
deleted file mode 100644
index 94391734..00000000
--- a/storage/miniports/lsi_u3/storage-miniports-lsi-u3.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: LSI_U3 StorPort Miniport Driver
- description: An adapter driver for use with Parallel SCSI Host Bus Adapters or on-motherboard solutions that use the LSI 53C1010 SCSI ASIC.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/miniports/lsi_u3/lsi_u3.sln
diff --git a/storage/miniports/storahci/README.md b/storage/miniports/storahci/README.md
index ed65a9ff..f5df95e7 100644
--- a/storage/miniports/storahci/README.md
+++ b/storage/miniports/storahci/README.md
@@ -1,5 +1,15 @@
+---
+topic: sample
+name: StorAHCI StorPort Miniport
+description: A sample Storport ACHI miniport driver.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
- name: StorAHCI StorPort Miniport
+ name: StorAHCI StorPort Miniport
platform: WDM
language: cpp
category: Storage
@@ -7,12 +17,10 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617983
--->
-
-StorAhci StorPort Miniport Driver
-=================================
+# StorAhci StorPort Miniport Driver
The StorAhci sample is a Storport ACHI miniport driver.
## Universal Windows Driver Compliant
-This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
+This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
diff --git a/storage/miniports/storahci/storage-miniports-storahci.yml b/storage/miniports/storahci/storage-miniports-storahci.yml
deleted file mode 100644
index de494421..00000000
--- a/storage/miniports/storahci/storage-miniports-storahci.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: StorAHCI StorPort Miniport
- description: A sample Storport ACHI miniport driver.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/miniports/storahci/storahci.sln
diff --git a/storage/msdsm/README.md b/storage/msdsm/README.md
index 599dc963..b2ccd0a8 100644
--- a/storage/msdsm/README.md
+++ b/storage/msdsm/README.md
@@ -1,5 +1,15 @@
+---
+topic: sample
+name: Multipath I/O (MPIO) DSM Sample
+description: Provides a sample for building vendor-specific device-specific modules (DSM), supports iSCSI and Fibre Channel devices.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
- name: Multipath I/O (MPIO) DSM Sample
+ name: Multipath I/O (MPIO) DSM Sample
platform: WDM
language: cpp
category: Storage
@@ -7,46 +17,33 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=620203
--->
-
-Multipath I/O (MPIO) DSM Sample
-===============================
+# Multipath I/O (MPIO) DSM Sample
The MPIO DSM Sample is intended to serve as an example to follow when building your own vendor specific device specific modules (DSM). This sample DSM supports iSCSI and Fibre Channel devices.
-
-Build the sample
-----------------
-
You can build the sample in two ways: using Microsoft Visual Studio or the command line (*MSBuild*).
-Building a Driver Using Visual Studio
--------------------------------------
+## 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 **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, 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).
+1. Open the driver project or solution in Visual Studio (find *samplename*.sln or *samplename*.vcxproj).
+1. Right-click the solution in the **Solutions Explorer** and select **Configuration Manager**.
+1. 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.
+1. From the Build menu, click **Build Solution** (Ctrl+Shift+B).
-Building a Driver Using the Command Line (MSBuild)
---------------------------------------------------
+## Building a Driver Using the Command Line (MSBuild)
You can build a driver from the command line using the Visual Studio Command Prompt window and the Microsoft Build Engine (MSBuild.exe) Previous versions of the WDK used the Windows Build utility (Build.exe) and provided separate build environment windows for each of the supported build configurations. You can now use the Visual Studio Command Prompt window for all build configurations.
-### To select a configuration and build a driver or an application
+1. Open a Visual Studio Command Prompt window at the **Start** screen. From this window you can use MsBuild.exe to build any Visual Studio project by specifying the project (.VcxProj) or solutions (.Sln) file.
+1. Navigate to the project directory and enter the **MSbuild** command for your target. For example, to perform a clean build of a Visual Studio driver project called *filtername*.vcxproj, navigate to the project directory and enter the following MSBuild command:
-1. Open a Visual Studio Command Prompt window at the **Start** screen. From this window you can use MsBuild.exe to build any Visual Studio project by specifying the project (.VcxProj) or solutions (.Sln) file.
-2. Navigate to the project directory and enter the **MSbuild** command for your target. For example, to perform a clean build of a Visual Studio driver project called *filtername*.vcxproj, navigate to the project directory and enter the following MSBuild command:
-
**msbuild /t:clean /t:build .\\<*samplename*>.vcxproj**.
-Installation and Operation
---------------------------
+## Installation and Operation
The installation process depends on proper construction of your DSM's INF as well as an installation program provided by you. These are important aspects of complying with the Designed for Windows logo program. The installation was designed to allow for multiple vendors to easily add DSMs and to eliminate rebooting as much as possible. The installation process will require you to update your installation routines and to use the new .INF files. With the new process, you can only modify your DSM's INF file.
@@ -54,7 +51,7 @@ The installer sample only needs to be called one time with the INF/driver source
The following annotated DSM INF file illustrates the correct format for your DSM. Replace only those items that are in bold italics. Remember, you must not use "GENDSM" or "MSISCDSM" or "MSDSM" as the name of your DSM. Therefore, you must replace any instances of those strings with the proper name of your DSM.
-```
+```inf
;
; Copyright (c) <YOUR COMPANY NAME HERE>. All rights reserved.
;
@@ -62,7 +59,7 @@ The following annotated DSM INF file illustrates the correct format for your DSM
In the Version section, make sure the DriverVer is correct for your DSM. Ideally it should match the version in the .rc file. You must specify a different catalog file since the MPIO core drivers now come pre-signed:
-```
+```inf
[Version]
Signature = "$WINDOWS NT$"
Class = System
@@ -84,7 +81,7 @@ DefaultDestDir = 12
Substitute all instances of "gendsm" with the proper name for your DSM. For example, "mydsm":
-```
+```inf
[std_mfg]
%mydsm_devicedesc% = mydsm_install, Root\MYDSM
@@ -110,7 +107,7 @@ This next section contains the Hardware ID strings for your devices. You can hav
In this sample, there are two different strings:
-```
+```inf
;
; The following cannot be grouped (as above)
;
@@ -121,7 +118,7 @@ HKLM, "SYSTEM\CurrentControlSet\Control\MPDEV", "MPIOSupportedDeviceList", %REG_
These are valid samples:
-```
+```inf
HKLM, "SYSTEM\CurrentControlSet\Control\MPDEV", "MPIOSupportedDeviceList", %REG_MULTI_SZ_APPEND%, "MAXTOR ATLASU320_18_WLS"
HKLM, "SYSTEM\CurrentControlSet\Control\MPDEV", "MPIOSupportedDeviceList", %REG_MULTI_SZ_APPEND%, "VENDOR3 PROD_PREFIX"
@@ -135,7 +132,7 @@ It is advisable to use this format if your storage devices generate product IDs
Add one entry for each WMI GUID that you use in your DSM. This is required:
-```
+```inf
HKLM, "SYSTEM\CurrentControlSet\Control\WMI\Security", "04517f7e-92bb-4ebe-aed0-54339fa5f544",\%REG_BINARY_NOCLOBBER%,\
01,00,04,80,14,00,00,00,24,00,00,00,00,00,00,00,\
34,00,00,00,01,02,00,00,00,00,00,05,20,00,00,00,\
@@ -169,14 +166,16 @@ HKLM, "SYSTEM\CurrentControlSet\Control\WMI\Security", "d6dc1bf0-95fa-4246-afd7-
Finally, modify the following strings:
-```
+```inf
[Strings]
VNDR = "Your Company Name Here"
std_mfg = "(Standard system devices)"
mydsm_devicedesc = "<Your product> Multi-Path Device Specific Module"
```
+
The following string is displayed as the friendly name of your DSM:
-```
+
+```inf
mydsm_desc = "<Your product name> Multi-Path DSM"
;
@@ -201,15 +200,15 @@ REG_EXPAND_SZ = 0x00020000
REG_DWORD = 0x00010001
REG_BINARY_NOCLOBBER = 0x00030003
```
+
You should be aware of the following when you install the MPIO DSM sample:
-1. The install sample assumes that all necessary files have already been copied over to a vendor specific directory (preferably a folder under Program Files) and takes that path as one of the parameters. This eliminates requests for the original media when new devices appear.
+1. The install sample assumes that all necessary files have already been copied over to a vendor specific directory (preferably a folder under Program Files) and takes that path as one of the parameters. This eliminates requests for the original media when new devices appear.
-2. As the port filter needs to go on top of every adapter that hosts (or might host) a path to the disk, all SCSI adapters are restarted at the end of the install
+1. As the port filter needs to go on top of every adapter that hosts (or might host) a path to the disk, all SCSI adapters are restarted at the end of the install
It is expected that the adapter that hosts the system volumes (boot/paging) will not restart, but that should not be problem if you are not multipathing the boot volume. However, if you are multipathing the boot volume, you will need to restart the system.
**Note** Other filter drivers installed as port filters may interfere with the proper operation of the MPIO port filter. Microsoft does not recommend the use of such filter drivers which may be supplied by HBA miniport vendors.
**Note** Since your DSM binary is not signed, you will get Unsigned Driver Pop-Ups. Ignore these and accept the installation of the new driver. Once your package has been successfully qualified by WHQL, your binaries will get signed and your customers will not get unsigned driver popups.
-
diff --git a/storage/msdsm/storage-msdsm.yml b/storage/msdsm/storage-msdsm.yml
deleted file mode 100644
index 24db8baf..00000000
--- a/storage/msdsm/storage-msdsm.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: Multipath I/O (MPIO) DSM Sample
- description: Provides a sample for building vendor-specific device-specific modules (DSM), supports iSCSI and Fibre Channel devices.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/msdsm/msdsm.sln
diff --git a/storage/sfloppy/README.md b/storage/sfloppy/README.md
index f5006d90..051c7e35 100644
--- a/storage/sfloppy/README.md
+++ b/storage/sfloppy/README.md
@@ -1,25 +1,32 @@
+---
+topic: sample
+name: Super Floppy (sfloppy) Storage Class Driver
+description: A sample class driver for Super Floppy disk drives.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: Super Floppy (sfloppy) Storage Class Driver
platform: WDM
language: cpp
category: Storage
- description: A sample class driver for Super Floppy disk drives.
+ description: A sample class driver for Super Floppy disk drives.
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617989
--->
-
-Super Floppy (sfloppy) Storage Class Driver
-===========================================
+# Super Floppy (sfloppy) Storage Class Driver
The sfloppy sample is a super floppy driver. This driver is a class driver for Super Floppy disk drives.
## Universal Windows Driver Compliant
+
This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
-Installation and Operation
---------------------------
+## Installation and Operation
This sample sits a level above the port driver (ATAPI, USB, and so on) in the driver stack and controls communication between the application level and the port driver. The floppy driver takes requests from file system drivers and then sends the appropriate [**SCSI\_REQUEST\_BLOCK**](http://msdn.microsoft.com/en-us/library/windows/hardware/ff565393) (SRB) to the port driver.
For more information, see [Introduction to Storage Class Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff559215) in the storage technologies design guide.
-
diff --git a/storage/sfloppy/storage-sfloppy.yml b/storage/sfloppy/storage-sfloppy.yml
deleted file mode 100644
index 8945a3c8..00000000
--- a/storage/sfloppy/storage-sfloppy.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: Super Floppy (sfloppy) Storage Class Driver
- description: A sample class driver for Super Floppy disk drives.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/sfloppy/sfloppy.sln
diff --git a/storage/tools/spti/README.md b/storage/tools/spti/README.md
index 10037d01..7744177c 100644
--- a/storage/tools/spti/README.md
+++ b/storage/tools/spti/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: SCSI Pass-Through Interface Tool
+description: Demonstrates how to communicate with a SCSI device using pass-through IOCTLs in an application using DeviceIoControl API.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: SCSI Pass-Through Interface Tool
platform: Application
@@ -7,16 +17,12 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617990
--->
-
-SCSI Pass-Through Interface Tool
-================================
+# SCSI Pass-Through Interface Tool
The SCSI Pass Through Interface sample demonstrates how to communicate with a SCSI device from Microsoft Win32 applications by using the **DeviceIoControl** API.
-Installation and Operation
---------------------------
+## Installation and Operation
The storage port drivers provide an interface for Win32 applications to send SCSI CBDs (Command Descriptor Block) to SCSI devices. The interfaces are [**IOCTL\_SCSI\_PASS\_THROUGH**](http://msdn.microsoft.com/en-us/library/windows/hardware/ff560519) and [**IOCTL\_SCSI\_PASS\_THROUGH\_DIRECT**](http://msdn.microsoft.com/en-us/library/windows/hardware/ff560521). Applications can build a pass-through request and send it to the device by using this IOCTL.
Two command line parameters can be used with *SPTI.EXE*. The first parameter is mandatory. It is the name of the device to be opened. Typical values for this are drive letters such as "C:", or device names as defined by a class driver such as Scanner0, or the SCSI port driver name, ScsiN:, where N = 0, 1, 2, etc. The second parameter is optional and is used to set the share mode (note that access mode and share mode are different things) and sector size. The default share mode is (FILE\_SHARE\_READ | FILE\_SHARE\_WRITE) and the default sector size is 512. A parameter of "r" changes the share mode to only FILE\_SHARE\_READ. A parameter of "w" changes the share mode to only FILE\_SHARE\_WRITE. A parameter of "c" changes the share mode to only FILE\_SHARE\_READ and also changes the sector size to 2048. Typically, a CD-ROM device would use the "c" parameter.
-
diff --git a/storage/tools/spti/storage-tools-spti.yml b/storage/tools/spti/storage-tools-spti.yml
deleted file mode 100644
index c8cc5267..00000000
--- a/storage/tools/spti/storage-tools-spti.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: SCSI Pass-Through Interface Tool
- description: Demonstrates how to communicate with a SCSI device using pass-through IOCTLs in an application using DeviceIoControl API.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /storage/tools/spti/spti.sln