ユニバーサル Windows ドライバーの概要

[アーティクル]
11/06/2015

[一部の情報はリリース前の製品に関することであり、正式版がリリースされるまでに大幅に変更される可能性があります。本書に記載された情報について、Microsoft は明示または黙示を問わずいかなる保証をするものでもありません。]

ユニバーサル Windows ドライバーは、Windows ドライバーで利用可能なインターフェイスのサブセットを使用します。このトピックでは、Windows 10 のユニバーサル Windows ドライバーをビルド、インストール、展開、およびデバッグする方法について説明します。

ユニバーサル Windows ドライバーについて

Windows 10 は、Windows の複数のエディションに共通する一連の API と DDI のインターフェイスを備えています。この一連のインターフェイスは、ユニバーサル Windows プラットフォーム (UWP) と呼ばれます。

ユニバーサル Windows ドライバーは、UWP ベースのエディションの Windows 10 にインストールして実行できる、カーネルモードドライバーまたはユーザーモードドライバーのバイナリです。該当するエディションとして、Windows 10 デスクトップエディション (Home、Pro、Enterprise) や Windows 10 Mobile があります。

ユニバーサル Windows ドライバーは、UWP の一部であるデバイスドライバーインターフェイス (DDI) のみを呼び出します。このような DDI には、MSDN のリファレンスページで "ユニバーサル" というマークが付いています。

既存のドライバーが UWP 以外のインターフェイスを呼び出すかどうかを確認するには、ドライバーをユニバーサル Windows ドライバーとして再コンパイルします。UWP の一部ではないインターフェイスをドライバーが呼び出すと、コンパイラから ApiValidator エラーが表示されます。このような呼び出しは、MSDN のデスクトップ用 DDI のリファレンスページに記載されている代替 DDI への置き換えが可能な場合があります。適切な代替インターフェイスが見つからない場合は、フィードバックを送信してお知らせください。

適切な代替インターフェイスが存在しない場合は、回避策のコーディングが必要になることがあります。必要に応じて、統合された WDK のドライバーテンプレートから新しいユニバーサル Windows ドライバーを作成してください。

ユニバーサル INF ファイルを使用していない場合は、コンパイラから INF 検証エラーが表示されることもあります。

ユニバーサル Windows ドライバーでは、KMDF、UMDF 2、または Windows Driver Model (WDM) を使うことができます。

ユニバーサル Windows ドライバーのビルド

Microsoft Visual Studio 2015 と Windows Driver Kit (WDK) 10 を使用すると、デスクトップ、モバイル、またはユニバーサルのドライバーをビルドできます。キットとツールは、Windows ハードウェアデベロッパーセンターからダウンロードできます。

多くの場合、Windows 8.1 で動作する既存のカーネルモードドライバーは、そのドライバーでユーザーモードコンポーネントを使用していない限り、ユニバーサル Windows ドライバーとして再コンパイルできます。 Windows 8.1 で動作する WDM ドライバーと KMDF ドライバーは、Windows 10 をターゲットとするユニバーサル Windows ドライバーとして再コンパイルでき、変換の必要はありません。

これに対し、既存のユーザーモードドライバーをユニバーサル Windows ドライバーとしてコンパイルするには、変更が必要になることがあります。つまり、ドライバーパッケージには UWP の外部の依存関係が存在しないようにする必要があります。たとえば、Win32 API は、一部のみが UWP の内部に存在します。

Dn941241.wedge(ja-jp,VS.85).gif 既存のドライバープロジェクトのユニバーサル Windows ドライバープロジェクトへの変換

Visual Studio 2015 で、既存のドライバープロジェクトを開きます。
[ソリューションエクスプローラー] ウィンドウで、ソリューションを右クリックし、[構成マネージャー] をクリックします。ターゲットオペレーティングシステムを Windows 10 に設定します。
ドライバープロジェクトを右クリックし、[プロパティ] をクリックします。 [構成プロパティ] の [ドライバー] で、[ターゲットプラットフォーム] が [ユニバーサル] に設定されていることを確認します。その他のオプションとして、デスクトップエディションの Windows 10 でのみ動作するドライバーをビルドする [デスクトップ] や、Windows 10 Mobile でのみ動作するドライバーをビルドする [モバイル] があります。
ドライバーをビルドします。リンカーのエラーが発生する場合があります。
エラーログを調べてエラーを 1 つずつ修正します。可能な代替 API については、マニュアルの個別のリファレンスページを参照してください。代替 API を使用できない場合は、ドライバーの設計を変更することが必要になる場合があります。

Dn941241.wedge(ja-jp,VS.85).gif Microsoft Visual Studio での新しいユニバーサル Windows ドライバープロジェクトの作成

テンプレート ([ファイル]、[新しいプロジェクト]、[テンプレート]、[Visual C++]、[Windows Driver] (Windows ドライバー)、[WDF] の順にクリック) から新しいドライバーを作成し、[User Mode Driver (UMDF V2)] (ユーザーモードドライバー (UMDF V2)) または [Kernel Mode Driver (KMDF)] (カーネルモードドライバー (KMDF)) を選択します。
[ソリューションエクスプローラー] ウィンドウでプロジェクトを作成したら、ソリューションを右クリックして [構成マネージャー] をクリックします。 [アクティブソリューション構成] を目的のターゲット Windows バージョンに設定し、[アクティブソリューションプラットフォーム] を [Win32] または [x64] に設定します。一覧に [ARM] が表示されない場合に ARM 用にビルドするには、[<新規作成>] を選択します。

Windows 10 を選ぶと、ドライバーモデルの既定値は [ユニバーサル] になります。

手動でドライバーモデルを変更するには、ドライバープロジェクトを右クリックし、[プロパティ] をクリックします。 [構成プロパティ]、[ドライバーの設定]、[全般] の順にクリックし、[ターゲットプラットフォーム] のエントリを検索します。[ユニバーサル]、[デスクトップ]、または [モバイル] をクリックします。Visual Studio はこの設定を使用して、リンクするライブラリを決定します。

注 Windows 10 より前のバージョンの Windows 用のユニバーサル Windows ドライバーをビルドすることはできません。
必要に応じて .inf ファイルを変更して、INF ファイルの Strings セクションにプロバイダーを指定します。%ManufacturerName% トークンとして指定されたプロバイダーは、後でこのセクションの定義に従って展開されます。次に例を示します。
```
Provider="Contoso"
```
これで、ソリューションをビルドできるようになりました。 Visual Studio は、必要なライブラリに対してリンクし、.cat ファイル、.inf ファイル、およびドライバーのバイナリを生成します。

ドライバーのビルド時に Visual Studio で使用できる構成設定については、「WDK を使ったドライバーのビルド」をご覧ください。

ユニバーサル Windows ドライバーのインストール

注 SetupAPI コンポーネントは UWP に含まれていないため、この API セットの関数をユニバーサル Windows ドライバーで呼び出すことはできません。

デスクトップエディションの Windows 10 を実行しているデバイスにユニバーサル Windows ドライバーをインストールする場合は、引き続き INF ファイルを使用できますが、いくつかの注意事項があります。ユニバーサル Windows ドライバーの INF ファイルには、次のいずれも含めることはできません。

Coinstallers
クラスインストーラー
RegisterDLL、DelFile、または DelReg ディレクティブ
HKR 以外の AddReg ディレクティブ

詳しくは、「ユニバーサル INF ファイルの使用」をご覧ください。

Windows 10 Mobile にユニバーサル Windows ドライバーをインストールする場合は、.spkg ファイルを使用できます。.spkg ("パッケージファイル") は、ドライバーパッケージを含むスタンドアロンモジュールです。 Windows 10 Mobile に展開しない場合は、パッケージファイルを生成する必要はありません。ユニバーサル Windows ドライバーは、パッケージファイルがなくても、(ドライバーのソースコードの定義に従って) コンパイルできます。

WDK 10 には、パッケージファイルを生成する PkgGen というツールが付属しています。ドライバーをビルドする場合は、次の手順に従って Visual Studio で PkgGen を実行します。

Dn941241.wedge(ja-jp,VS.85).gif PkgGen を使用したパッケージファイルの生成

ドライバープロジェクトを右クリックし、[追加]、[新しい項目] の順にクリックします。次に、[Visual C++]、[Windows Driver] (Windows ドライバー) の順にクリックし、[パッケージマニフェスト] をクリックします。[追加] をクリックします。
ドライバープロジェクトに Package.pkg.xml という名前のファイルが追加されます。ファイルを右クリックしてプロパティを選択すると、項目の種類が PkgGen であることを確認できます (このプロパティページで [ビルドから除外] を [はい] に設定すると、後でこのドライバープロジェクトをビルドするときにパッケージファイルを生成しないようにすることができます)。 [OK] をクリックします。
ドライバープロジェクトを右クリックし、[プロパティ] をクリックします。[構成プロパティ] で、PackageGen ノードを開き、[バージョン] を任意のバージョンに変更します。
作業内容を保存し、管理者として Visual Studio を再起動します。
ドライバーをビルドします。必要なライブラリがリンクされ、.cat ファイル、.inf ファイル、ドライバーのバイナリ、および .spkg ファイルが生成されます。

パッケージファイルの内容を確認するには、ファイル名に .cab というサフィックスを追加して、その cab ファイルをエクスプローラーで開きます。

Visual Studio の外部での PkgGen の実行については、パッケージの作成に関するページをご覧ください。

モバイルドライバーパッケージ (.spkg ファイル) をインストールするには、2 つのオプションがあります。

ターゲットシステムの既存のパッケージを更新する場合、または新しいパッケージをターゲットに追加する場合は、IUTool.exe を使用して、.spkg ドライバーパッケージをインストールします。
モバイル OS イメージにパッケージを組み合わせる場合は、ImgGen を使用して、Full Flash Update (FFU) イメージに .spkg ドライバーパッケージを追加し、モバイルデバイスにフラッシュできるようにします。

Dn941241.wedge(ja-jp,VS.85).gif IUTool を使用した、モバイルドライバーパッケージ (.spkg) の実行中のデバイスへの追加

IUTool.exe は、WDK 10 の \tools\bin\<architecture> サブディレクトリにあります。

モバイルデバイスを PC に接続します。その後、管理者特権のコマンドプロンプトで次のコマンドを実行します。
```
IUTool -p MyKmdfDriver.spkg
```
詳しくは、電話上のパッケージを更新する IUTool.exe に関するページと「テストイメージへのドライバーの追加」をご覧ください。

Dn941241.wedge(ja-jp,VS.85).gif ImgGen を使用した、ドライバーパッケージ (.spkg) のモバイル OS イメージ (.ffu) への追加

Visual Studio をインストールしたら、スタート画面で [Visual Studio 2015] フォルダーをクリックします。[開発者コマンドプロンプト for VS2015] を右クリックし、[管理者として実行] をクリックします。
ImgGen について詳しくは、ImgGen.cmd を使用した phone イメージのビルドに関するページをご覧ください。

モバイル OS イメージ (.ffu) のフラッシュ

デバイスにイメージをフラッシュするには、Microsoft から提供された FFUTool を使うか、カスタム OEM フラッシュツールを開発します。詳しくは、.FFU イメージファイルのパッケージの更新に関するページをご覧ください。

ユニバーサル Windows ドライバーのデバッグ

Windows 10 以降では、KMDF ドライバーまたは UMDF ドライバーをビルドするときに、インフライトトレースレコーダーを通じて追加のドライバーデバッグ情報を取得するように設定できます。この機能をユニバーサル Windows ドライバーで利用できます。

さらに、Visual Studio の KMDF テンプレートを使用すると、ドライバーは Windows ソフトウェアトレースプリプロセッサ (WPP) を使ってトレースメッセージを書き込みます。ドライバーは、プロバイダー GUID を持つ ETW プロバイダーです。

ドライバーからトレースメッセージを送信するには、次のコードを使用します。

TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DRIVER, "%!FUNC! Entry");

ETW ログにアクセスするには、TShell ツールで Tracelog を使うか、デバッガーセッションで ! wmitrace を使います。

電話で Tracelog を使うには

ホストコンピューターと電話間のカーネルモードデバッグセッションを確立します。

ホストコンピューター上の TShell で、次のコマンドを入力します。

exec-device tracelog -addautologger MyLogger05 -guid c:\SteveGuid.txt -level 4 -flag 0xF –kd

電話を再起動し、デバッガーでトレースメッセージを監視します。

既存のすべてのカーネルモードデバッグトランスポートは、デスクトップエディションの Windows 10 であれば引き続き動作します。ただし、Windows 10 Mobile をテストするには、ユーザーモードドライバーとカーネルモードドライバーのどちらでも、KDNET 経由でリモートデバッガーセッションを使う必要があります。詳しくは、Visual Studio のネットワークケーブル経由でのカーネルモードデバッグの手動設定に関するページをご覧ください。