summaryrefslogtreecommitdiff
path: root/input
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2019-09-05 20:18:16 -0700
committerGitHub <[email protected]>2019-09-05 20:18:16 -0700
commit22af24719daf72029a70119cc6653d2a3b940549 (patch)
tree6677b85dbdae81db047b97a51533ea356abb13e3 /input
parent516d94ce47bd535dc813d654297ace02c61d46f6 (diff)
* Update README.md * Update README.md
Diffstat (limited to 'input')
-rw-r--r--input/kbfiltr/README.md65
-rw-r--r--input/layout/README.md53
-rw-r--r--input/moufiltr/README.md10
3 files changed, 48 insertions, 80 deletions
diff --git a/input/kbfiltr/README.md b/input/kbfiltr/README.md
index 90b59f79..6bbbe933 100644
--- a/input/kbfiltr/README.md
+++ b/input/kbfiltr/README.md
@@ -8,16 +8,6 @@ products:
- windows-wdk
---
-
-<!---
- name: Keyboard Input WDF Filter Driver (Kbfiltr)
- platform: KMDF
- language: cpp
- category: HID WDF
- description: A WDF example of a keyboard input filter driver.
- samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=620194
---->
-
# Keyboard Input WDF Filter Driver (Kbfiltr)
The Kbdfltr sample is an example of a keyboard input filter driver.
@@ -35,20 +25,18 @@ This driver filters input for a particular keyboard on the system. If you want t
This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
-Set the hardware ID in the inx file
------------------------------------
+## Set the hardware ID in the inx file
This step is required for automatic deployment (described later) to work properly. In the kbfiltr.inx file (located with the driver source files), find the [DDK\_Ex.Mfg.NT\$ARCH\$] section. Change the hardware ID in the %DDK\_Ex% entry from the dummy value to the hardware ID of the PS/2 keyboard on the target computer. The following example shows the hardware ID change.
-```
+```INF
; For XP and above
[DDK_Ex.Mfg.NT$ARCH$]
;%DDK_Ex% = kbfiltr, *PNP0BAAD
%DDK_Ex% = kbfiltr, ACPI\VEN_PNP&DEV_0303
```
-Build the sample using Visual Studio
-------------------------------------
+## Build the sample using Visual Studio
In Visual Studio, on the **Build** menu, choose **Build Solution**.
@@ -56,33 +44,30 @@ For more information about using Visual Studio to build a driver package, see [B
The test application, *kbftest.exe* is also built as part of the solution under the 'exe' folder.
-Locate the built driver package
--------------------------------
+## 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 **Debug** and **x64**, the package is your solution folder under \\Debug\\Package.
The package contains these files:
-File | Description
------|------------
-Kmdfsamples.cat | A signed catalog file, which serves as the signature for the entire package.
-kbfiltr.inf | An information (INF) file that contains information needed to install the driver.
-WdfCoinstaller010xx.dll | The coinstaller for version 1.xx of KMDF.
-kbfiltr.sys | The driver file.
+| File | Description |
+| --- | --- |
+| Kmdfsamples.cat | A signed catalog file, which serves as the signature for the entire package. |
+| kbfiltr.inf | An information (INF) file that contains information needed to install the driver. |
+| WdfCoinstaller010xx.dll | The coinstaller for version 1.xx of KMDF. |
+| kbfiltr.sys | The driver file. |
-Using MSBuild
--------------
+## Using MSBuild
As an alternative to building the Kbfiltr Filter 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, kbfiltr.sln. Use the [MSBuild](http://go.microsoft.com/fwlink/p/?linkID=262804) command to build the solution. Here are some examples:
-**msbuild /p:configuration="Debug" /p:platform="x64" kbfiltr.sln**
+- **msbuild /p:configuration="Debug" /p:platform="x64" kbfiltr.sln**
-**msbuild /p:configuration="Release" /p:platform="Win32" kbfiltr.sln**
+- **msbuild /p:configuration="Release" /p:platform="Win32" kbfiltr.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).
-Run the sample
---------------
+## Run the sample
The computer where you install the driver is called the *target computer* or the *test computer*. Typically this is a separate computer from where you develop and build the driver package. The computer where you develop and build the driver is called the *host computer*.
@@ -92,16 +77,19 @@ The process of moving the driver package to the target computer and installing t
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/).
-1. On the host computer, in Visual Studio, in Solution Explorer, right click **package** (lower case), and choose **Properties**. Navigate to **Configuration Properties \> Driver Install \> Deployment**.
-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 **Install and Verify**, and choose **Default Driver Package Installation Task** in the list. Click **OK**.
-3. On the **Build** menu, choose **Deploy Package** or **Build Solution**.
+1. On the host computer, in Visual Studio, in Solution Explorer, right click **package** (lower case), and choose **Properties**. Navigate to **Configuration Properties \> Driver Install \> Deployment**.
+
+1. 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 **Install and Verify**, and choose **Default Driver Package Installation Task** in the list. Click **OK**.
+
+1. On the **Build** menu, choose **Deploy Package** or **Build Solution**.
### 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](https://docs.microsoft.com/en-us/windows-hardware/drivers/develop/preparing-a-computer-for-manual-driver-deployment).
-1. Copy all of the files in your driver package to a folder on the target computer (for example, c:\\KbfiltrDriverPackage).
-2. On the target computer, open a Command Prompt window as Administrator. Navigate to your driver package folder, and enter the Devcon command with the correct hardware ID, such as:
+1. Copy all of the files in your driver package to a folder on the target computer (for example, c:\\KbfiltrDriverPackage).
+
+1. On the target computer, open a Command Prompt window as Administrator. Navigate to your driver package folder, and enter the Devcon command with the correct hardware ID, such as:
**Devcon install kbfiltr.inf ACPI\\VEN\_PNP&DEV\_0303**
@@ -109,14 +97,13 @@ Before you manually deploy a driver, you must turn on test signing and install a
Using Device Manager, update the driver for the PS/2 Keyboard by manually selecting kbfiltr.inf from the location where you copied the driver files.
-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 **DDK Example Device that needs filtering** under the **Keyboards** node.
-Testing
--------
+## Testing
To use the test application provided with the sample, it must be copied to the target computer manually. Save the kbftest.exe file from the folder where the build result is placed (for example, exe\\Debug). This file is copied somewhere on the target, possibly where the driver package files are located. The test application is the executed on the target computer in a Command Prompt using **kbftest** as the command.
-**Tip** To avoid DLL dependencies for kbftext.exe, and the need to copy additional files, select the statically linked run-time library when building.
+> [!TIP]
+> Optional information to help a user be more successfulTo avoid DLL dependencies for kbftext.exe, and the need to copy additional files, select the statically linked run-time library when building.
diff --git a/input/layout/README.md b/input/layout/README.md
index 32fb84c6..eb654d31 100644
--- a/input/layout/README.md
+++ b/input/layout/README.md
@@ -8,66 +8,59 @@ products:
- windows-wdk
---
-
-<!---
- name: Keyboard Layout Samples
- platform: Application
- language: cpp
- category: HID
- description: Demonstrates how to generate layouts for various keyboards and locales.
- samplefwlink: https://aka.ms/rapjms
---->
-
# Keyboard Layout Samples
The keyboard layout samples demonstrate how to generate layouts for various keyboards and locales.
-Build the sample
-----------------
+## Build the sample
Starting in the WDK, you can build the sample in two ways: using the Visual Studio Integrated Development Environment (IDE) or from the command line using the Visual Studio Command Prompt window and the Microsoft Build Engine (MSBuild.exe).
### Building the sample using Visual Studio
-1. Open Visual Studio. From the **File** menu, select **Open Project/Solution**. Within your WDK installation, navigate to src\\input\\layout and open the kbd.sln project file.
-2. Right-click the solution in the **Solution 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.
-4. From the **Build** menu, click **Build Solution** (Ctrl+Shift+B).
+1. Open Visual Studio. From the **File** menu, select **Open Project/Solution**. Within your WDK installation, navigate to src\\input\\layout and open the kbd.sln project file.
+
+1. Right-click the solution in the **Solution Explorer** and select **Configuration Manager**.
+
+1. 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.
+
+1. From the **Build** menu, click **Build Solution** (Ctrl+Shift+B).
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. Starting in the WDK, you can use the Visual Studio Command Prompt window for all build configurations.
### Building the sample using the command line (MSBuild)
-1. Open a Visual Studio Command Prompt window. Click **Start** and search for **Developer Command Prompt**. If your project is under %PROGRAMFILES%, you need to open the command prompt window using elevated permissions (**Run as administrator**). 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 kbdus.vcxproj, navigate to the project directory and enter the following MSBuild command: **msbuild /t:clean /t:build .\\kbdus.vcxproj**.
-3. If the build succeeds, you will find the driver (kbdus.dll) in the binary output directory corresponding to the target platform, for example src\\input\\layout\\kbdus\\Windows 8.1 Debug.
+1. Open a Visual Studio Command Prompt window. Click **Start** and search for **Developer Command Prompt**. If your project is under %PROGRAMFILES%, you need to open the command prompt window using elevated permissions (**Run as administrator**). 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 kbdus.vcxproj, navigate to the project directory and enter the following MSBuild command: **msbuild /t:clean /t:build .\\kbdus.vcxproj**.
+
+1. If the build succeeds, you will find the driver (kbdus.dll) in the binary output directory corresponding to the target platform, for example src\\input\\layout\\kbdus\\Windows 8.1 Debug.
-Design and Operation
---------------------
+## Design and Operation
-### Keyboard Layout Samples
+### Keyboard Layout Samples details
The layout DLL is loaded by the window manager when needed. One of the examples is the logon. The default set of the input locales is set in the HKCU registry, according to user's preference, which can be customized by the Regional and Language Options application in Control Panel. The window manager reads the HKCU registry and loads the keyboard layouts accordingly.
The samples under input/layout include the following keyboard layouts:
-- kbdus
+- kbdus
US-English keyboard layout
-- kbdfr
+- kbdfr
French keyboard layout
-- kbdgr
+- kbdgr
German keyboard layout
-- kbd101
+- kbd101
Japanese 101 keyboard layout
-- kbd106
+- kbd106
Japanese 106 keyboard layout
@@ -87,13 +80,11 @@ The layout DLLs export one or more entry points, which are called by the window
For the East Asian keyboard layouts, the keyboard layout DLL has to provide language-specific entry points. Those additional entries expose the language-specific information, such as the kana conversion table, or the special conversion rule, including the VK\_KANJI generation.
-Installation
-------------
+## Installation
To install a customized version of a layout DLL, it is recommended to substitute the existing DLL installed by the operating system with the customized DLL. The layout DLLs should be installed in the %windir%\\system32 directory (exceptions may apply on 64-bit platforms). You may need to disable the System File Protection (SFP) before replacing the layout DLLs. After the layout DLLs are installed, you may need to reboot the system to ensure the new layouts are used..
-Loading the Sample
-------------------
+## Loading the Sample
In order to load the layout DLLs, you may need to turn to the Regional and Language Options application in Control Panel and add input locales that use the keyboard layouts you installed.
diff --git a/input/moufiltr/README.md b/input/moufiltr/README.md
index d25da692..210a7198 100644
--- a/input/moufiltr/README.md
+++ b/input/moufiltr/README.md
@@ -8,16 +8,6 @@ products:
- windows-wdk
---
-
-<!---
- name: Mouse Input WDF Filter Driver (Moufiltr)
- platform: KMDF
- language: cpp
- category: HID WDF
- description: A WDF example of a mouse input filter driver.
- samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=620195
---->
-
# Mouse Input WDF Filter Driver (Moufiltr)
The Moufiltr sample is an example of a mouse input filter driver.