キーボードおよびマウス HID クライアントドライバーの開発

注

この記事は、キーボードおよびマウス HID クライアント用のドライバーを作成する開発者向けです。マウスまたはキーボードを修正する場合は、次を参照してください。

この記事では、キーボードおよびマウス HID クライアントドライバーについて説明します。キーボードとマウスは、HID 使用法テーブルで標準化され、Windows オペレーティングシステムに実装された HID クライアントの最初のセットを表します。

キーボードおよびマウス HID クライアントドライバーは、HID マッパードライバーの形式で実装されます。 HID マッパードライバーは、非 HID クラスドライバーと HID クラスドライバー間の I/O 要求の双方向インターフェイスを提供するカーネルモードフィルタードライバーです。マッパードライバーは、一方の I/O 要求とデータプロトコルを他方にマップします。

Windows には、HID キーボードと HID マウスデバイス用のシステム提供の HID マッパードライバーが用意されています。

アーキテクチャと概要

次の図は、USB キーボード、マウス、タッチパッドデバイス用のシステム提供のドライバースタックを示しています。

キーボードとマウスの HID クラスマッパードライバーを示すキーボードとマウスドライバースタックの図。

この図は、次のコンポーネントを示しています。

KBDHID.sys: キーボード用 HID クライアントマッパードライバー。 HID 使用法をスキャンコードに変換して、既存のキーボードクラスドライバーとインターフェイスします。
MOUHID.sys: マウス/タッチパッド用の HID クライアントマッパードライバー。 HID 使用法をマウスコマンド (X/Y、ボタン、ホイール) に変換して、既存のキーボードクラスドライバーとインターフェイスします。
KBDCLASS.sys: キーボードクラスドライバーは、システム上のすべてのキーボードとキーパッドに安全な方法で機能を提供します。
MOUCLASS.sys: マウスクラスドライバーは、システム上のすべてのマウスとタッチパッドの機能を提供します。ドライバーは、絶対および相対ポインティングデバイスの両方をサポートしています。 MOUCLASS.sys タッチスクリーン用の Windows ドライバーではありません。
HIDCLASS.sys: HID クラスドライバー。 HID クラスドライバーは、KBDHID.sys と MOUHID.sys HID クライアントとさまざまなトランスポート (USB、Bluetoothなど) の間の接着です。

システムは、次のようにドライバースタックをビルドします。

トランスポートスタックは、接続されている各 HID デバイスの物理デバイスオブジェクト (PDO) を作成し、適切な HID トランスポートドライバーを読み込みます。その後、HID クラスドライバーが読み込まれます。
HID クラスドライバーは、キーボードまたはマウスのトップレベルコレクション (TLC) ごとに PDO を作成します。複雑な HID デバイス (複数の TLC) は、HID クラスドライバーによって作成された複数の PDO として公開されます。たとえば、マウスが統合されたキーボードには、標準のキーボードコントロール用に 1 つのコレクションがあり、マウス用に別のコレクションがある場合があります。
キーボードまたはマウス HID クライアントマッパードライバーは、適切な機能デバイスオブジェクト (FDO) に読み込まれます。
HID マッパードライバーは、キーボードとマウスの FDO を作成し、クラスドライバーを読み込みます。

重要な注意事項

サポートされている HID 使用法と最上位のコレクションに準拠しているキーボードとマウスには、ベンダードライバーは必要ありません。
ベンダーは、必要に応じて、これらの特定の TLC の機能を変更または強化する HID スタックのフィルタードライバーを提供します。
ベンダーは、HID クライアントとデバイスの間で独自のデータを交換するために、個別のベンダー固有の TLC を作成する必要があります。重要でない限り、フィルタードライバーの使用は避けてください。
システムは、その排他的な使用のためにすべてのキーボードとマウスのコレクションを開きます。
システムは、キーボードの無効化/有効化を禁止します。
システムは滑らかなスクロール機能の水平/垂直車輪のサポートを提供する。

ドライバーのガイダンス

Microsoft では、独立系ハードウェアベンダー (IHV) がドライバーを作成するためのこのガイダンスを提供しています。

ドライバー開発者は、フィルタードライバーまたは新しい HID クライアントドライバーの形式でドライバーを追加できます。
1. ドライバー開発者は、付加機能を持つドライバーが、フィルタードライバーとして動作し、入力スタック内の既存の Windows HID ドライバーを置き換えない（またはその代わりに使用されない）ことを確保する必要があります。
  - フィルタードライバーは、次のシナリオで許可されます。
    - kbdhid/mouhid への上位フィルターとして
    - kbdclass/mouclass の上位フィルターとして
  - HIDCLASS と HID トランスポートミニドライバーの間にフィルターとしてフィルタードライバーを使用することは推奨されていません。
2. 関数ドライバー: ベンダーは、(フィルタードライバーではなく) 関数ドライバーを作成することもできますが、ベンダー固有の HID PDO (必要に応じてユーザーモードサービスを使用) に対してのみ作成できます。
  
  関数ドライバーは、次のシナリオで使用できます。
  - 特定のベンダーのハードウェアにのみ読み込む
3. トランスポートドライバー: Windows チームは、書き込みと保守が複雑な HID トランスポートミニドライバーをさらに作成することはお勧めしません。パートナーが新しい HID トランスポートミニドライバー (特に SoC システム) を作成している場合は、理由を理解し、ドライバーが正しく開発されていることを確認するために、詳細なアーキテクチャレビューをお勧めします。
ドライバー開発者は、ドライバーフレームワーク (KMDF または UMDF) を使用し、フィルタードライバーに WDM に依存しないようにする必要があります。
ドライバー開発者は、サービスとドライバースタック間のカーネルユーザー遷移の数を減らす必要があります。
ドライバー開発者は、キーボードとタッチパッドの両方の機能 (エンドユーザー (デバイスマネージャー) または PC の製造元によって調整可能) を介してシステムをスリープ解除する機能を確保する必要があります。 SoC システムに加えて、これらのデバイスは、システムが動作している S0 状態にある間に、低電力状態から復帰できる必要があります。
ドライバー開発者は、ハードウェアが効率的に電源管理されていることを確認する必要があります。
- デバイスがアイドル状態になると、デバイスは最小の電源状態になることがあります。
- システムが低電力状態 (スタンバイ (S3) やコネクトスタンバイなど) の場合、デバイスは最も低い電力状態になります。

キーボードレイアウト

キーボードレイアウトには、Microsoft Windows 2000 以降のバージョンのキーボードの入力特性が完全に記述されています。たとえば、キーボードレイアウトでは、言語、キーボードの種類とバージョン、修飾子、スキャンコードなどを指定します。

キーボードレイアウトの詳細については、次のリソースを参照してください。

キーボードレイアウトに関する一般的な情報を文書化する Windows Driver Development Kit (DDK) のキーボードヘッダーファイル kdb.h。
キーボードレイアウトのサンプル。

特定のキーボードのレイアウトを視覚化するには、「 Windows キーボードレイアウト」を参照してください。

キーボードレイアウトの詳細については、「コントロールパネル\Clock、Language、Region\Language」を参照してください。

マウスでサポートされているボタンとホイール

次の一覧は、Windows でサポートされているマウス機能を示しています。

ボタン 1 から 5
垂直スクロールホイール
水平スクロールホイール
スムーズスクロールホイールサポート(水平および垂直)

PS/2 マウスでボタン 4 ~ 5 とホイールをアクティブ化する

Windows で新しい 4 ボタンと 5 つのボタンとホイールモードをアクティブ化するために使用されるメソッドは、IntelliMouse 互換マウスで 3 番目のボタンとホイールをアクティブ化するために使用されるメソッドの拡張です。

マウスを 3 ボタンホイールモードに設定するには、レポートレートを 1 秒あたり 200 レポート、1 秒あたり 100 レポート、1 秒あたり 80 レポートに設定します。次に、マウスから ID を読み取る。このシーケンスが完了すると、マウスは 3 の ID を報告する必要があります。
その後、レポートレートを1秒あたり200レポートに設定し、次に再び1秒あたり200レポートに設定し、その後1秒あたり80レポートに設定することで、マウスを5ボタンホイールモードにします。次に、マウスから ID を読み取る。シーケンスが完了すると、5 ボタンホイールマウスは ID 4 を報告する必要があります (IntelliMouse 互換の 3 ボタンホイールマウスでは ID が 3 のまま報告されます)。

この方法は、HIDマウスではなくPS/2マウスにのみ適用できる。 HID マウスは、レポート記述子で正確な使用状況を報告する必要があります。

標準 PS/2 互換マウスデータパケット形式 (2 つのボタン)

バイト	D7	D6	D5	D4	D3	D2	D1	D0	コメント
1	Yover	Xover	ワイサイン	Xsign	タグ	エム	R	L	X/Y オーバーフローと記号、ボタン
2	X7	X6	X5	X4	X3	X2	X1	X0	Xバイトのデータ
3	Y7	Y6	Y5	Y4	Y3	Y2	Y1	Y0	Y データバイト数

注

Windows マウスドライバーはオーバーフロービットをチェックしません。オーバーフローがある場合、マウスは最大符号付き変位値を送信する必要があります。

標準 PS/2 互換マウスデータパケット形式 (3 つのボタン + 垂直ホイール)

バイト	D7	D6	D5	D4	D3	D2	D1	D0	コメント
1	0	0	ワイサイン	Xsign	1	エム	R	L	X/Y 記号と R/L/M ボタン
2	X7	X6	X5	X4	X3	X2	X1	X0	Xバイトのデータ
3	Y7	Y6	Y5	Y4	Y3	Y2	Y1	Y0	Y データバイト
4	Z7	Z6	Z5	Z4	Z3	Z2	Z1	Z0	Z/wheel データバイト

標準 PS/2 互換マウスデータパケット形式 (5 つのボタン + 垂直ホイール)

バイト	D7	D6	D5	D4	D3	D2	D1	D0	コメント
1	0	0	ワイサイン	Xsign	1	エム	R	L	X/Y 記号と R/L/M ボタン
2	X7	X6	X5	X4	X3	X2	X1	X0	Xバイトのデータ
3	Y7	Y6	Y5	Y4	Y3	Y2	Y1	Y0	Y データバイト
4	0	0	B5	B4	Z3	Z2	Z1	Z0	Z/ホイールのデータとボタン 4 および 5

Von Bedeutung

5 ボタンホイールマウスの Z/ホイールデータは、IntelliMouse 互換の 3 ボタンホイールモードで使用される 8 ビットではなく、4 ビットに縮小されます。この削減は、ホイールが通常、特定の割り込み期間中に +7/-8 の範囲を超える値を生成できないという事実によって可能になります。 Windows マウスドライバーは、マウスが 5 ボタンホイールモードのときに 4 つの Z/ホイールデータビットの符号拡張を行います。マウスが3ボタンホイールモードで動作するとき、彼らはZ/ホイールデータバイト全体を符号拡張します。

ボタン 4 と 5 は、WM_APPCOMMAND メッセージにマップされ、App_BackとApp_Forwardに対応します。

ベンダードライバーを必要としないデバイス

ベンダードライバーは、次のデバイスでは必要ありません。

HID Standard に準拠しているデバイス。
システム提供の非 HIDClass ドライバーによって動作するキーボード、マウス、またはゲームポートデバイス。

Kbfiltr サンプル

Kbfiltr は、キーボードデバイス用のシステムクラスドライバーである Kbdclass と、PS/2 スタイルキーボードのファンクションドライバーである I8042prt と共に使用されます。 Kbfiltr では、I/O 要求をフィルター処理する方法と、Kbdclass と I8042prt の操作を変更するコールバックルーチンを追加する方法を示します。

Kbfiltr 操作の詳細については、以下を参照してください。

ntddkbd.h WDK ヘッダーファイル。
サンプルの Kbfiltr ソースコード。

Kbfiltr IO 制御コード

Kbfiltr では、次の IOCTL が使用されます。

IOCTL_INTERNAL_I8042_HOOK_KEYBOARD

IOCTL_INTERNAL_I8042_HOOK_KEYBOARD要求:

I8042prt キーボード初期化ルーチンに初期化コールバックルーチンを追加します。
I8042prt キーボード ISR に ISR コールバックルーチンを追加します。

初期化コールバックと ISR コールバックは省略可能であり、PS/2 スタイルのキーボードデバイスの上位レベルのフィルタードライバーによって提供されます。

I8042prt は 、IOCTL_INTERNAL_KEYBOARD_CONNECT 要求を受信すると、同期 IOCTL_INTERNAL_I8042_HOOK_KEYBOARD 要求をキーボードデバイススタックの先頭に送信します。

Kbfiltr がフックキーボード要求を受け取った後、Kbfiltr は次のように要求をフィルター処理します。

Kbfiltr に渡される上位レベルの情報を保存します。これには、上位レベルのデバイスオブジェクトのコンテキスト、初期化コールバックへのポインター、ISR コールバックへのポインターが含まれます。
上位レベルの情報を独自の情報に置き換えます。
I8042prt のコンテキストと、Kbfiltr ISR コールバックで使用できるコールバックへのポインターを保存します。

IOCTL_INTERNAL_KEYBOARD_CONNECT (内部キーボード接続)

IOCTL_INTERNAL_KEYBOARD_CONNECT要求は、Kbdclass サービスをキーボードデバイスに接続します。 Kbdclass は、キーボードデバイスを開く前に、この要求をキーボードデバイススタックに送信します。

Kbfiltr がキーボード接続要求を受信した後、Kbfiltr は次のように接続要求をフィルター処理します。

Kbdclass によってフィルタードライバーに渡される Kbdclass のCONNECT_DATA (Kbdclass) 構造体のコピーを保存します。
クラスドライバーの接続情報を、独自の接続情報に置き換える。
IOCTL_INTERNAL_KEYBOARD_CONNECT要求をデバイススタックの下に送信します。

要求が成功しなかった場合、Kbfiltr は適切なエラー状態で要求を完了します。

Kbfiltr には、Kbdclass クラスサービスコールバックルーチンである KeyboardClassServiceCallback の操作補足できるフィルターサービスコールバックルーチンのテンプレートが用意されています。フィルターサービスコールバックは、デバイス入力バッファーからクラスデータキューに転送される入力データをフィルター処理できます。

IOCTL_INTERNAL_KEYBOARD_DISCONNECT

IOCTL_INTERNAL_KEYBOARD_DISCONNECT要求は、STATUS_NOT_IMPLEMENTEDの状態で完了します。プラグアンドプレイマネージャーは、プラグアンドプレイキーボードを追加または削除できます。

他のすべてのデバイス制御要求の場合、Kbfiltr は現在の IRP スタックをスキップし、それ以上処理せずにデバイススタックに要求を送信します。

Kbfiltr によって実装されるコールバックルーチン

Kbfiltr は、次のコールバックルーチンを実装します。

KbFilter_InitializationRoutine

PI8042_KEYBOARD_INITIALIZATION_ROUTINEを参照してください

キーボードの I8042prt の既定の初期化で十分な場合、 KbFilter_InitializationRoutine は必要ありません。

I8042prt は、キーボードを初期化するときに KbFilter_InitializationRoutine を呼び出します。既定のキーボード初期化には、次の操作が含まれます。

キーボードをリセットする
型指定レートと遅延を設定する
発光ダイオード(LED)の設定

/*
Parameters
DeviceObject [in]
Pointer to the device object that is the context for this callback.

SynchFuncContext [in]
Pointer to the context for the routines pointed to by ReadPort and Writeport.

ReadPort [in]
Pointer to the system-supplied PI8042_SYNCH_READ_PORT callback that reads from the port.

WritePort [in]
Pointer to the system-supplied PI8042_SYNCH_WRITE_PORT callback that writes to the port.

TurnTranslationOn [out]
Specifies, if TRUE, to turn translation on. Otherwise, translation is turned off.

Return value
KbFilter_InitializationRoutine returns an appropriate NTSTATUS code.
*/

NTSTATUS KbFilter_InitializationRoutine(
  In  PDEVICE_OBJECT          DeviceObject,
  In  PVOID                   SynchFuncContext,
  In  PI8042_SYNCH_READ_PORT  ReadPort,
  In  PI8042_SYNCH_WRITE_PORT WritePort,
  Out PBOOLEAN                TurnTranslationOn
);

KbFilter_IsrHook

PI8042_KEYBOARD_ISRを参照してください。 I8042prt の既定の操作で十分な場合、このコールバックは必要ありません。

I8042prt キーボード ISR は、割り込みを検証してスキャンコードを読み取った後、 KbFilter_IsrHook を呼び出します。

KbFilter_IsrHook は、I8042prt キーボードの IRQL でカーネルモードで実行されます。

/*
Parameters
DeviceObject [in]
Pointer to the filter device object of the driver that supplies this callback.

CurrentInput [in]
Pointer to the input KEYBOARD_INPUT_DATA structure that is being constructed by the ISR.

CurrentOutput [in]
Pointer to an OUTPUT_PACKET structure that specifies the bytes that are being written to the hardware device.

StatusByte [in, out]
Specifies the status byte that is read from I/O port 60 when an interrupt occurs.

DataByte [in]
Specifies the data byte that is read from I/O port 64 when an interrupt occurs.

ContinueProcessing [out]
Specifies, if TRUE, to continue processing in the I8042prt keyboard ISR after this callback returns; otherwise, processing is not continued.

ScanState [in]
Pointer to a KEYBOARD_SCAN_STATE structure that specifies the keyboard scan state.

Return value
KbFilter_IsrHook returns TRUE if the interrupt service routine should continue; otherwise it returns FALSE.
*/

KbFilter_IsrHook KbFilter_IsrHook(
  In    PDEVICE_OBJECT       DeviceObject,
  In    PKEYBOARD_INPUT_DATA CurrentInput,
  In    POUTPUT_PACKET       CurrentOutput,
  Inout UCHAR                StatusByte,
  In    PUCHAR               DataByte,
  Out   PBOOLEAN             ContinueProcessing,
  In    PKEYBOARD_SCAN_STATE ScanState
);

KbFilter_ServiceCallback

PSERVICE_CALLBACK_ROUTINEを参照してください。

関数ドライバーの ISR ディスパッチ完了ルーチンは 、KbFilter_ServiceCallbackを呼び出し、キーボードクラスドライバーの PSERVICE_CALLBACK_ROUTINEの実装を呼び出します。ベンダーは、フィルターサービスコールバックを実装して、デバイスの入力バッファーからクラスデータキューに転送される入力データを変更できます。たとえば、コールバックはデータを削除、変換、または挿入できます。

/*
Parameters
DeviceObject [in]
Pointer to the class device object.

InputDataStart [in]
Pointer to the first keyboard input data packet in the input data buffer of the port device.

InputDataEnd [in]
Pointer to the keyboard input data packet that immediately follows the last data packet in the input data buffer of the port device.

InputDataConsumed [in, out]
Pointer to the number of keyboard input data packets that are transferred by the routine.

Return value
None
*/

VOID KbFilter_ServiceCallback(
  In    PDEVICE_OBJECT       DeviceObject,
  In    PKEYBOARD_INPUT_DATA InputDataStart,
  In    PKEYBOARD_INPUT_DATA InputDataEnd,
  Inout PULONG               InputDataConsumed
);

Moufiltr サンプル

Moufiltr は、マウスデバイス用のシステムクラスドライバーである Mouclass と連携します。また、PS/2 スタイルのマウスのファンクションドライバーである I8042prt でも動作します。どちらのドライバーも Windows 2000 以降のバージョンで使用されます。 Moufiltr では、I/O 要求をフィルター処理し、Mouclass と I8042prt の操作を変更するコールバックルーチンを追加する方法を示します。

Moufiltr 操作の詳細については、次のリソースを参照してください。

ntddmou.h WDK ヘッダーファイル。
サンプルの Moufiltr ソースコード。

Moufiltr IO 制御コード

Moufiltr では、次の IOCTL が使用されます。

IOCTL_INTERNAL_I8042_HOOK_MOUSE

IOCTL_INTERNAL_I8042_HOOK_MOUSE要求は、I8042prt マウス ISR に ISR コールバックルーチンを追加します。 ISR コールバックは省略可能であり、上位レベルのマウスフィルタードライバーによって提供されます。

I8042prt は、IOCTL_INTERNAL_MOUSE_CONNECT 要求を受信した後にこの要求を送信します。 I8042prt は、同期 IOCTL_INTERNAL_I8042_HOOK_MOUSE 要求をマウスデバイススタックの先頭に送信します。

Moufiltr はフックマウス要求を受け取った後、次のように要求をフィルター処理します。

Moufiltr に渡される上位レベルの情報を保存します。これには、上位レベルのデバイスオブジェクトのコンテキストと ISR コールバックへのポインターが含まれます。
上位レベルの情報を独自の情報に置き換えます。
I8042prt のコンテキストと、Moufiltr ISR コールバックで使用できるコールバックへのポインターを保存します。

IOCTL_INTERNAL_MOUSE_CONNECT

IOCTL_INTERNAL_MOUSE_CONNECT要求は、マウスデバイスに Mouclass サービスを接続します。

IOCTL_INTERNAL_MOUSE_DISCONNECT (マウスの内部接続解除)

Moufiltr は、IOCTL_INTERNAL_MOUSE_DISCONNECT 要求を STATUS_NOT_IMPLEMENTED のエラーステータスとして改訂します。

その他のすべての要求について、Moufiltr は現在の IRP スタックをスキップし、追加の処理を行わずにデバイススタックに要求を送信します。

Moufiltr コールバックルーチン

MouFiltr は、次のコールバックルーチンを実装します。

MouFilter_IsrHook

PI8042_MOUSE_ISRを参照してください。

/*
Parameters
DeviceObject
Pointer to the filter device object of the driver that supplies this callback.

CurrentInput
Pointer to the input MOUSE_INPUT_DATA structure being constructed by the ISR.

CurrentOutput
Pointer to the OUTPUT_PACKET structure that specifies the bytes being written to the hardware device.

StatusByte
Specifies a status byte that is read from I/O port 60 when the interrupt occurs.

DataByte
Specifies a data byte that is read from I/O port 64 when the interrupt occurs.

ContinueProcessing
Specifies, if TRUE, that the I8042prt mouse ISR continues processing after this callback returns. Otherwise, processing is not continued.

MouseState
Pointer to a MOUSE_STATE enumeration value, which identifies the state of mouse input.

ResetSubState
Pointer to MOUSE_RESET_SUBSTATE enumeration value, which identifies the mouse reset substate. See the Remarks section.

Return value
MouFilter_IsrHook returns TRUE if the interrupt service routine should continue; otherwise it returns FALSE.
*/

BOOLEAN MouFilter_IsrHook(
   PDEVICE_OBJECT        DeviceObject,
   PMOUSE_INPUT_DATA     CurrentInput,
   POUTPUT_PACKET        CurrentOutput,
   UCHAR                 StatusByte,
   PUCHAR                DataByte,
   PBOOLEAN              ContinueProcessing,
   PMOUSE_STATE          MouseState,
   PMOUSE_RESET_SUBSTATE ResetSubState
);

I8042prt の既定の操作で十分な場合、 MouFilter_IsrHook コールバックは必要ありません。

I8042prt マウス ISR は、割り込みを検証した後、MouFilter_IsrHook を呼び出します。

マウスをリセットするために、I8042prt は一連の操作サブステートを通過します。 MOUSE_RESET_SUBSTATE列挙値は、各サブ状態を識別します。 I8042prt がマウスをリセットする方法と、対応するマウスリセットサブ状態の詳細については、ntdd8042.h のMOUSE_RESET_SUBSTATEのドキュメントを参照してください。

MouFilter_IsrHook は、I8042prt マウス ISR の IRQL でカーネルモードで実行されます。

MouFilter_ServiceCallback

PSERVICE_CALLBACK_ROUTINEを参照してください

/*
Parameters
DeviceObject [in]
Pointer to the class device object.

InputDataStart [in]
Pointer to the first mouse input data packet in the input data buffer of the port device.

InputDataEnd [in]
Pointer to the mouse input data packet immediately following the last data packet in the port device's input data buffer.

InputDataConsumed [in, out]
Pointer to the number of mouse input data packets that are transferred by the routine.

Return value
None
*/

VOID MouFilter_ServiceCallback(
  _In_    PDEVICE_OBJECT    DeviceObject,
  _In_    PMOUSE_INPUT_DATA InputDataStart,
  _In_    PMOUSE_INPUT_DATA InputDataEnd,
  _Inout_ PULONG            InputDataConsumed
);

I8042prt の ISR DPC はMouFilter_ServiceCallbackを呼び出し、その後 MouseClassServiceCallback を呼び出します。フィルターサービスコールバックは、デバイスの入力バッファーからクラスデータキューに転送される入力データを変更するように構成できます。たとえば、コールバックはデータを削除、変換、または挿入できます。

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-07-18