高性能 USB スタック USBX ホストスタック ユーザガイド Express Logic Toll Free 888.THREADX FAX

Transcription

1 高性能 USB スタック USBX ホストスタック ユーザガイド Express Logic Toll Free 888.THREADX FAX

2 by Express Logic, Inc. All rights reserved.this document and the associated USBX software are the sole property of Express Logic, Inc. Each contains proprietary information of Express Logic, Inc. Reproduction or duplication by any means of any portion of this document without the prior written consent of Express Logic, Inc. is expressly forbidden. Express Logic, Inc. は USBX の設計または信頼性を向上するために 随時に予告なく 本書に記載する仕様を変更する権利を留保します 本書の内容については万全を期していますが 本書の正確性について Express Logic, Inc. が保証するものではありません 商標 FileX および ThreadX は Express Logic, Inc. の登録商標であり USBX NetX picokernel preemption-threshold event-chaining は Express Logic, Inc. の商標です 保証の制限 Express Logic, Inc. は USBX 製品が使用者の要件を満たすもしくは使用者により指定されたとおりに動作すること USBX 製品が中断もしくは欠陥なしに動作すること または USBX 製品に見つかるいかなる欠陥も保障期間後に補正されることにつき 一切保証するものではありません Express Logic, Inc. は USBX 製品に関し 市場性および特定の目的への適合性を含めて 明示あるいは黙示を問わず一切責任を負わないものとします Express Logic, Inc. そのディーラ 販売店 代理店または従業員から口頭もしくは書面で情報または助言が与えられた場合 それにより 他の保証が生じるものでもなく またこの保証の範囲がいかなる形であれ拡大するものでもありません また ライセンス取得者はそのような情報または助言に依拠してはなりません パート番号 : 改訂 5.7 版

3 目次 目次... 3 本書について... 6 第 1 章 USBX の概要... 7 USBX の機能... 7 製品ハイライト... 8 USBX の強力なサービス... 8 複数ホストコントローラのサポート... 8 USB ソフトウェアスケジューラ... 8 USB デバイスフレームワークの完全なサポート... 8 使いやすい API... 8 第 2 章 USBX のインストール ホストについて コンピュータの種類 ダウンロード用インタフェース デバッグツール 必要なハードディスク容量 ターゲットについて コンフィギュレーションオプション ソースコードツリー USBX リソースの初期化 USB ホストコントローラの定義 ホストクラスの定義 トラブルシューティング USBX バージョン ID 第 3 章 USBX ホストスタックのファンクションコンポーネント 実行概要 初期化 アプリケーションインタフェースコール USB ホストスタック API USB ホストクラス API ルートハブ ハブクラス USB ホストスタック... 23

4 トポロジマネージャ USB クラスのバインド USBX API ホストコントローラ ルートハブ 電力管理 エンドポイント 転送 USB デバイスのフレームワーク デバイス記述子 コンフィギュレーション記述子 インタフェース記述子 エンドポイント記述子 ストリング記述子 ファンクショナル記述子 メモリ内の USBX デバイス記述子フレームワーク 第 4 章 USBX ホストサービスの説明 ux_host_stack_initialize ux_host_stack_endpoint_transfer_abort ux_host_stack_class_get ux_host_stack_class_register ux_host_stack_class_instance_create ux_host_stack_class_instance_destroy ux_host_stack_class_instance_get ux_host_stack_device_configuration_get ux_host_stack_device_configuration_select ux_host_stack_device_get ux_host_stack_interface_endpoint_get ux_host_stack_hcd_register ux_host_stack_configuration_interface_get ux_host_stack_interface_setting_select ux_host_stack_transfer_request_abort ux_host_stack_transfer_request 第 5 章 USBX ホストクラスの API ux_host_class_printer_read ux_host_class_printer_write ux_host_class_printer_soft_reset ux_host_class_printer_status_get ux_host_class_audio_read ux_host_class_audio_write ux_host_class_audio_control_get ux_host_class_audio_control_value_set ux_host_class_audio_streaming_sampling_set ux_host_class_audio_streaming_sampling_get ux_host_class_hid_client_register ux_host_class_hid_report_callback_register... 77

5 ux_host_class_hid_periodic_report_start ux_host_class_hid_periodic_report_stop ux_host_class_hid_report_get ux_host_class_hid_report_set ux_host_class_asix_read ux_host_class_asix_write ux_host_class_cdc_acm_read ux_host_class_cdc_acm _write ux_host_class_cdc_acm_ioctl ux_host_class_pima_session_open ux_host_class_pima_session_close ux_host_class_pima_storage_ids_get ux_host_class_pima_storage_info_get ux_host_class_pima_num_objects_get ux_host_class_pima_object_handles_get ux_host_class_pima_object_info_get ux_host_class_pima_object_info_send ux_host_class_pima_object_open ux_host_class_pima_object_get ux_host_class_pima_object_send ux_host_class_pima_thumb_get ux_host_class_pima_object_delete ux_host_class_pima_object_close ux_host_class_gser_read ux_host_class_gser_write ux_host_class_gser_ioctl ux_host_class_gser_reception_start ux_host_class_gser_reception_stop 第 6 章 USBX DPUMP クラスについて USBX DPUMP ホストクラス USBX DPUMP デバイスクラス 第 7 章ピクトブリッジの実装 ピクトブリッジクライアントの実装 ux_pictbridge_jobinfo_object_data_read ピクトブリッジホストの実装 ux_pictbridge_application_object_data_write 第 8 章 USBX OTG インデックス

6 本書について 本書では Express Logic, Inc. の高性能 USB ファウンデーションソフトウェア USBX について包括的に説明します 本書は 組み込み式リアルタイムソフトウェアの開発者を対象にしています 開発者は 標準的なリアルタイムオペレーティングシステムファンクション USB 仕様 および C プログラミング言語に精通していることとします USB 関連の技術的な情報については から USB 仕様書および USB クラス仕様書をダウンロードして参照してください 本書の構成 第 1 章では USB について紹介します 第 2 章では ThreadX アプリケーションに USBX をインストールして使用するための基本手順を説明します 第 3 章では USBX の機能の概要と USB の基本事項を説明します 第 4 章では ホストモードの USBX へのアプリケーションのインタフェースについて詳述します 第 5 章は USBX DPUMP クラスについて と題しています 第 6 章は USBX Pictbridge の実装 と題しています 第 7 章は USBX OTG と題しています

7 第 1 章 USBX の概要 USBX は 組み込みアプリケーション対応の本格的 USB スタックです この章では USBX の概要を紹介し その用途と利点を説明します USBX の機能 USBX は 現行の USB Specification および OTG をサポートします スケーラブルに設計してあるため 1 つだけのデバイスを接続する簡易 USB テクノロジから 複数のデバイスとカスケードハブを備えた複雑なテクノロジまで対応します USB プロトコルで可能な制御転送 バルク転送 インタラプト転送 アイソクロナス転送をすべて USBX でサポートします USBX はホスト側 デバイス側の両方をサポートします いずれの側も 次の 3 つのレイヤで構成されます 制御レイヤ スタックレイヤ クラスレイヤ USB 各相の関係は次のようになっています クラスドライバ クラスドライバ ホストスタック デバイススタック ホストコントローラドライバ ホストコントローラドライバ ホストコントローラ デバイスコントローラ ホスト側 デバイス側

8 製品ハイライト ThreadX プロセッサの完全なサポートロイヤルティなし完全な ANSI C ソースコードリアルタイムパフォーマンス迅速なテクニカルサポート複数のクラスサポート複数のクラスインスタンス ThreadX FileX NetX とのクラス統合複数コンフィギュレーション対応の USB デバイスのサポート USB 複合デバイスのサポートカスケードハブのサポート USB 電力管理のサポート USB OTG のサポート TraceX のトレースイベントのエクスポート USBX の強力なサービス 複数ホストコントローラのサポート USBX は 並列実行される複数の USB ホストコントローラをサポートできます これにより 市販されている USB 2.0 ホストコントローラの大半で採用している下位互換方式の USB 2.0 規格を USBX でサポートできます USB ソフトウェアスケジューラ ハードウェアリスト処理機能のない USB コントローラをサポートするには USB ソフトウェアスケジューラが必要ですが そのスケジューラを USBX に内蔵しています USBX のソフトウェアスケジューラは 各 USB 転送を所定の頻度と優先度に応じて編成し USB コントローラに命令して転送をそれぞれ実行します USB デバイスフレームワークの完全なサポート 複数コンフィギュレーション 複数インタフェース 複数代替設定などをともなう 最高度の USB デバイスをサポートすることができます 使いやすい API USBX は 最高の組み込み USB スタックを わかりやすく簡単に使える形で提供します USBX の API により 直感的かつ一貫したサービスが得られます 付属の USBX クラス API を使用すれば ユーザアプリケーション側で複雑な USB プロトコルを理解する必要がありません

9

10 第 2 章 USBX のインストール ホストについて コンピュータの種類 組み込み開発は通常 IBM-PC または Unix のホストコンピュータ上で実行されます ホスト側でアプリケーションをコンパイル リンク 配置した後 ターゲットハードウェアにアプリケーションをダウンロードして実行します ダウンロード用インタフェース ターゲットへのダウンロードは通常 RS-232 シリアルインタフェースを介して行いますが パラレルインタフェースや USB Ethernet を使用する例も増えています 対応するオプションに関する開発ツールドキュメントを参照してください デバッグツール デバッグは一般に プログラムイメージダウンロード用と同じリンクで実行されます デバッガには BDM(Background Debug Monitor) や ICE(In-Circuit Emulator) ツールを介してターゲット上で実行する小型のモニタプログラムを初め 各種があります このうち 実際のターゲットハードウェアを最も強力にデバッグできるのは もちろん ICE ツールです 必要なハードディスク容量 USBX のソースコードは ASCII 形式で提供され コンピュータのハードディスクに約 500KB の空き容量が必要です その他のホストシステム要件とオプションについては 付属の readme_usbx.txt ファイルで確認してください ターゲットについて USBX は ホストモードのターゲット上に 24KB~64KB の読み取り専用メモリ (ROM) が必要です 必要なメモリ容量は 使用するコントローラ および USBX にリンクする USB クラスにより異なります さらに USBX グローバルデータ構造とグローバルメモリプール用には ターゲットに 32KB のランダムアクセスメモリ (RAM) が必要になります このメモリプールは USB で実行するデバイス数 および USB コントローラの種類に応じて調整することも可能です USBX デバイス側では デバイスコントローラの種類に応じて約 10~12K の ROM が必要です RAM メモリの使用量は デバイスでエミュレートするクラスの種類により異なります さらに USBX では マルチスレッド保護のために ThreadX のセマフォ ミューテックス スレッドを必要とし また USB バストポロジの監視のために I/O の中断と周期処理を必要とします

11 製品の配布 USBX パッケージには 標準とプレミアムの 2 種類があります 標準パッケージでは最小限のソースコードを備えているの対し プレミアムパッケージには USBX ソースコードを一式完備しています いずれのパッケージも 1 枚の CD で出荷されます 配布 CD の内容は ターゲットプロセッサ 開発ツール USBX パッケージにより異なります 以下は ほとんどの製品配布に共通する重要ファイルのリストです readme_usbx.txt ux_api.h ux_port.h ux.lib demo_usbx.c USBX ポートに関するファイルで ターゲットプロセッサ 開発ツールなどが含まれています すべてのシステム equate データ構造 サービスプロトタイプを記述した C ヘッダファイルです 開発ツール向けのデータ定義と構造をすべて記述した C ヘッダファイルです USBX C ライブラリのバイナリバージョンです 標準パッケージで配布されます 簡単な USBX デモを記述した C ファイルです ファイル名はすべて小文字で表します これにより コマンドを Unix 開発プラットフォームに簡単に変換することができます USBX のインストールは簡単明快です 以下に示す全般的な方法は ほぼすべてのインストールに適用されます ただし 実際の開発ツール環境に応じた変更点については readme_usbx_generic.txt で確認してください ステップ 1 ステップ 2 ステップ 3 ステップ 4 ステップ 5 ステップ 6 ステップ 7 USBX 配布ディスクをバックアップし 安全な場所に保管しておきます ホストハードドライブ上で以前に ThreadX をインストールしたのと同じディレクトリを使用します USBX 名はすべて一意となっているため 以前にインストールした USBX と干渉することはありません tx_application_define またはその先頭付近に ux_system_initialize のコールを追加します tx_application_define. 追加した場所で USBX リソースが初期化されます ux_host_stack_initialize へのコールを追加します 必要な USBX を初期化するためのコールを 1 つ以上追加します システム内で使用可能なホストコントローラを初期化するためのコールを 1 つ以上追加します 低レベルのハードウェア初期化と割り込みベクトルのルーティングを追加するために tx_low_level_initialize.c ファイルの修正が必要になる場合があります ハードウェアプラットフォームごとに異なるステップとなるため ここでは説明しません

12 ステップ 8 アプリケーションソースコードをコンパイルし それを USBX と ThreadX のランタイムライブラリとリンクし (USB ストレージクラスや USB ネットワーククラスをコンパイルするときは FileX や Netx も必要になる場合があります ) また ux.a( または ux.lib) と tx.a( または tx.lib) にもリンクします 結果をターゲットにダウンロードすれば実行できます

13 コンフィギュレーションオプション USBX ライブラリの構築用にいくつかのコンフィギュレーションオプションがあります オプションはすべて ux_port.h に置かれています 各コンフィギュレーションオプションについて 以下に詳述します 配布ディスクで提供される readme_usbx.txt ファイルに その他の開発ツールオプションが記述されています UX_PERIODIC_RATE 個々のハードウェアプラットフォームにおける秒あたりのティック数です デフォルトは 1000 すなわちミリ秒あたり 1 ティックです UX_MAX_CLASS_DRIVER USBX でロード可能なクラスの最大数です クラスコンテナを表す値であり 1 クラスのインスタンス数ではありません 例えば USBX の実装にハブクラス プリンタクラス およびストレージクラスが必要な場合 これらのクラスに属するデバイス数とは無関係に UX_MAX_CLASS_DRIVER 値を 3 に設定できます UX_MAX_HCD システムで使用可能なホストコントローラの数です USB 1.1 対応には この値は通常 1 に設定され USB 2.0 対応には 2 以上に設定できます この値は 同時に実行する並列ホストコントローラの数を表すものです 例えば 実行する OHCI のインスタンスが 2 つある場合 または EHCI コントローラ 1 つと OHCI コントローラが 1 つを実行する場合は UX_MAX_HCD を 2 に設定します UX_MAX_DEVICES USB にアタッチ可能なデバイスの最大数を表します 1 つの USB に対する理論上の最大数は 通常 127 個です メモリ節約のためにこの値を下げることが可能です システム内の USB バス数とはかかわりなく デバイスの合計数を表す値であるので留意してください

14 UX_MAX_ED コントローラプール内の ED の最大数を表します この値は 1 つのコントローラにみに割り当てられます 複数のコントローラのインスタンスがある場合は 各々のコントローラにこの値が使用されます UX_MAX_TD および UX_MAX_ISO_TD コントローラプール内の正規 TD とアイソクロナス TD の最大数を表します この値は 1 つのコントローラにみに割り当てられます 複数のコントローラのインスタンスがある場合は 各々のコントローラにこの値が使用されます UX_THREAD_STACK_SIZE USBX スレッドに関するスタックサイズ ( 単位 : バイト ) です 通常は 使用するプロセッサとホストコントローラに応じて 1024~2048 バイトが可能です UX_THREAD_PRIORITY_ENUM バストポロジをモニタする USBX 列挙スレッドの ThreadX 優先度値です UX_THREAD_PRIORITY_CLASS 標準 USBX スレッドの ThreadX 優先度値です UX_THREAD_PRIORITY_KEYBOARD USBX HID キーボードクラスの ThreadX 優先度値です UX_THREAD_PRIORITY_HCD ホストコントローラスレッドの ThreadX 優先度値です UX_NO_TIME_SLICE 1 を指定した場合 ThreadX ターゲットポートはタイムスライスを使用しません UX_MAX_HOST_LUN ホストストレージクラスドライバに表される SCSI 論理ユニットの最大数を表します

15 ソースコードツリー USBX の各ファイルは いくつかのディレクトリで提供されます USBX コア USBX デバイススタック USBX ホストスタック USBX ネットワーク USBX の例 Windows ホストファイル USBX デバイスコントローラ USBX ホストコントローラ USBX OTG USBX デバイスクラス USBX ホストクラス

16 各ファイルを名前で識別できるように 以下の表記法を採用しています ファイル接尾名 ux_host_stack ux_host_class ux_hcd ux_device_stack ux_device_class ux_dcd ux_otg ux_pictbridge ux_utility demo_usbx ファイルの説明 USBX ホストスタックのコアファイル USBX ホストスタックのクラスファイル USBX ホストスタックのコントローラドライバファイル USBX デバイススタックのコアファイル USBX デバイススタックのクラスファイル USBX デバイススタックのコントローラドライバファイル USBX OTG コントローラドライバ関連ファイル USBX ピクトブリッジファイル USBX ユーティリティファンクション USBX のデモファイル USBX リソースの初期化 USBX は 自身のメモリマネージャを備えています 先に USBX にメモリを割り当てておかないと USBX のホスト側やデバイス側を初期化することができません メモリキャッシュが可能なシステムにも USBX メモリマネージャは対応します 次のファンクションは USBX メモリリソースを 128K の正規メモリで かつキャッシュセーフメモリ用プールを別途に設けずに初期化します /* Initialize USBX Memory */ ux_system_initialize(memory_pointer,(128*1024),ux_null,0); ux_system_initialize のプロトタイプは次の通りです UINT ux_system_initialize(void *regular_memory_pool_start, ULONG regular_memory_size, VOID *cache_safe_memory_pool_start, ULONG cache_safe_memory_size) 入力パラメータ : VOID *regular_memory_pool_start 正規メモリプールの先頭 ULONG regular_memory_size 正規メモリプールのサイズ VOID *cache_safe_memory_pool_start キャッシュセーフメモリプールの先頭 ULONG cache_safe_memory_size キャッシュセーフメモリプールのサイズ すべてのシステムでキャッシュセーフメモリの定義が必要なわけではありません そのようなシステムでは メモリポインタの初期化時に渡される値は UX_NULL に プールの値は 0 にそれぞれ設定されます その場合 USBX はキャッシュセーフメモリに代えて正規メモリプールを使用します

17 正規メモリがキャッシュセーフではなく またコントローラが DMA メモリを実行する必要がある場合 (OHCI EHCI などのコントローラの場合 ) キャッシュセーフメモリにメモリプールを定義することが必要です USB ホストコントローラの定義 USBX がホストモードで動作するためには USB ホストコントローラを 1 つ以上定義する必要があります この定義は アプリケーション初期化ファイルに記述します 下の例では OHCI USB デバイスコントローラを指しています EHCI などその他のコントローラでは そのコントローラの名前とファンクションエントリ定義を適宜変更しなければなりません 次の行は OHCI コントローラの定義を実行します ux_host_stack_hcd_register("ux_hcd_ohci", ux_hcd_ohci_initialize, 0xd0000, 0x0a); ux_host_stack_hcd_register のプロトタイプは次の通りです UINT_ux_host_stack_hcd_register(CHAR_PTR hcd_name, UINT (*hcd_initialize_function)(struct UX_HCD_STRUCT *), ULONG hcd_param1, ULONG hcd_param2); ux_host_stack_hcd_register ファンクションは次のパラメータを使用します hcd_name: hcd_initialize_function: hcd_param1: hcd_param2: コントローラ名のストリングコントローラの初期化ファンクション通常は コントローラで使用する IO 値またはメモリ通常は コントローラで使用する IRQ 前の例では次のようになります ux_hcd_ohci が OHCI コントローラの名前 ux_hcd_ohci_initialize が OHCI コントローラの初期化ルーチン 0xd0000 が OHCI コントローラレジスタがメモリ上で可視となっているアドレス そして 0x0a が OHCI で使用する IRQ です USBX では 現在 以下のコントローラをサポートしています 他のコントローラのサポートも予定されています ホストコントローラ名商標およびプロセッサ ( 参考 ) EHCI OHCI ISP1161 ISP1362 PIC32 RX SH2A Generic 2.0 USB ホストコントローラ Generic 1.1 USB ホストコントローラ NXP 1.1 組み込み離散ホストコントローラ NXP 2.0 組み込み離散ホストコントローラ Microchip 組み込み 1.1 ホストコントローラ Renesas RX62 組み込みホストコントローラ Renesas SH2A ベースの組み込みホストコントローラ

18 STM32 MUSB ST Micro STM32 F1/F2/F4 組み込みホストコントローラ Mentor ジェネリックホストコントローラ 以下は 1 つの OHCI コントローラといくつかのクラスを用いて USBX をホストモードで初期化するときの例です UINT status; /* Initialize USBX.*/ ux_system_initialize(memory_ptr, (128*1024),0,0); /* The code below is required for installing the USBX host stack.*/ status = ux_host_stack_initialize(ux_null); /* If status equals UX_SUCCESS, host stack has been initialized.*/ /* Register all the host classes for this USBX implementation.*/ status = ux_host_class_register("ux_host_class_hub", ux_host_class_hub_entry); /* If status equals UX_SUCCESS, host class has been registered.*/ status = ux_host_class_register("ux_host_class_storage", ux_host_class_storage_entry); /* If status equals UX_SUCCESS, host class has been registered.*/ status = ux_host_class_register("ux_host_class_printer", ux_host_class_printer_entry); /* If status equals UX_SUCCESS, host class has been registered.*/ status = ux_host_class_register("ux_host_class_audio", ux_host_class_audio_entry); /* If status equals UX_SUCCESS, host class has been registered.*/ /* Register all the USB host controllers available in this system.*/ status = ux_host_stack_hcd_register("ux_hcd_ohci", ux_hcd_ohci_initialize, 0x300000, 0x0a); /* If status equals UX_SUCCESS, USB host controllers have been registered.*/ ホストクラスの定義 1 つ以上のホストクラスを USBX で定義する必要があります USB スタックで USB デバイスをコンフィギュレーションした後に USB デバイスを駆動するために USB クラスが必要になります USB クラスは USB デバイスに特化しています

19 USB デバイス記述子に含まれるインタフェース数に応じ 1 つの USB デバイスを駆動するために 1 つまたは複数のクラスが必要になることがあります 以下は HUB クラスの登録例です status = ux_host_stack_class_register("ux_host_class_hub", ux_host_class_hub_entry); ux_host_class_register のプロトタイプは次の通りです UINT ux_host_staack_class_register(char_ptr class_name, UINT (*class_entry_address) (struct UX_HOST_CLASS_COMMAND_STRUCT *)) class_name はクラス名 class_entry_address はクラスのエンドポイントです HUB クラスの初期化例において : ux_host_class_hub はハブの名前です ux_host_class_hub_entry は HUB クラスのエンドポイントです

20 トラブルシューティング USBX には デモファイルとシミュレーション環境が付属しています 最初に ターゲットハードウェアまたは特定のデモプラットフォームでデモプラットフォームを実行してみるのがよいでしょう デモシステムが機能しない場合 以下の方法で問題を絞り込んでください USBX バージョン ID USBX の現在のバージョンは 実行時にユーザからもアプリケーションソフトウェアからも確認できます プログラマは usbx.txt ファイルを調べて USB バージョンを取得できます このファイルには 対応するポートのバージョン履歴も記載されています アプリケーションソフトウェアでは ux_port.h に定義されているグローバルストリング _ux_version_id を調べて USBX バージョンを取得できます

21 第 3 章 USBX ホストスタックのファンクションコンポーネント この章では USBX の高性能埋め込み USB ホストスタックについて ファンクションの観点から説明します 実行概要 USBX は 次のコンポーネントから構成されます 初期化アプリケーションインタフェースコールルートハブハブクラスホストクラス USB ホストスタックホストコントローラ USBX ホストスタックを下の図に示します キーボードクライアント マウスクライアント リモートコントロールクライアント ハブクラス アイソクロナスクラス 非同期クラス HID クラス USB スタック OHCI EHCI ソフトウェアスケジューラ コントローラドライバ

22 初期化 USBX をアクティブ化するには ファンクション ux_system_initialize をコールする必要があります このファンクションは USBX のメモリリソースを初期化します USBX ホスト機能をアクティブ化するには ファンクション ux_host_stack_initialize をコールする必要があります ThreadX スレッド ミューテックス セマフォなど USBX ホストスタックで使用するすべてのリソースがこのファンクションで初期化されます 1 つ以上の USB ホストコントローラと 1 つ以上の USB クラスをアクティブ化するのは アプリケーション初期化での処理になります スタックにクラスが登録され ホストコントローラ初期化ファンクションがコールされたら バスがアクティブになり デバイス発見が開始できます ホストコントローラのルートハブが アタッチされているデバイスを検出した場合 USB トポロジを担当する USB 列挙スレッドがウェイクアップし デバイスの列挙処理に進みます ルートハブおよび下流ハブの性質上 ホストコントローラ初期化ファンクションが返ったときに アタッチされているすべての USB デバイスがまだ完全にコンフィギュレーションされていない可能性があります USB ハブの列挙に際し 特にルートハブと USB デバイスの間に 1 つ以上のハブがある場合 すべてが列挙されるまでに数秒かかることがあります アプリケーションインタフェースコール USBX の API には 次の 2 つのレベルがあります USB ホストスタック API USB ホストクラス API 通常 USBX アプリケーションではどの USB ホストスタック API もコールする必要がありません ほとんどのアプリケーションは USB クラス API にのみアクセスします USB ホストスタック API ホストスタック API は USBX コンポーネント ( ホストクラスとホストコントローラ ) の登録 デバイスのコンフィギュレーション および使用可能なデバイスエンドポイントの転送要求を担当します USB ホストクラス API クラス API は USB クラスごとに特化しています USB クラス用の一般的な API のほとんどは デバイスのオープン / クローズ デバイスとの読み書きなどのサービスを提供します

23 ルートハブ ホストコントローラの各インスタンスには 1 つ以上の USB ルートハブがあります ルートハブの数は コントローラの性質によって決まるか またはコントローラから特定のレジスタを読み出すことで取得できます ハブクラス ハブクラスは USB ハブの駆動を担当します USB ハブは スタンドアロンハブのほか キーボード モニタなど複合デバイスの一部とすることも可能です ハブには 自己電力形とバス電力形があります バス電力ハブでは 最大 4 つまでの下流ポートを搭載でき また使用電力が 100mA 未満の自己電力またはバス電力のデバイスのみが接続可能です 各ハブのカスケード化が可能です 最大 5 つのハブを相互に接続できます USB ホストスタック USB ホストスタックは USBX の中核部分です 次の 3 つの主要機能を持ちます USB のトポロジの管理 1 つ以上のクラスへの USB デバイスのバインド デバイス記述子問い合わせと USB 転送を実行するための API をクラスに提供 トポロジマネージャ 新しいデバイスが接続されるまたはデバイスの接続が外されると USB スタックトポロジスレッドがウェイクアップされます ルートハブでも正規ハブでも デバイスの接続を受け付けることができます USB にデバイスが接続されると トポロジマネージャがデバイス記述子を取得します この記述子には そのデバイスで可能なコンフィギュレーションの数が示されています ほとんどのデバイスは 1 つのコンフィギュレーションのみを備えています 接続先ポートでの使用可能電力に従って 異なる動作が可能なデバイスもあります そのようなデバイスには 使用可能電力に応じて複数のコンフィギュレーションがあり 選択できるようにしてあります トポロジマネージャによりコンフィギュレーションされたデバイスには コンフィギュレーション記述子に指定されている電力が供給できるようになります USB クラスのバインド デバイスがコンフィギュレーションされたらトポロジマネージャは クラスマネージャがデバイスインタフェース記述子を見ながらデバイス発見を続行するようにさせます 各デバイスには 1 つ以上のインタフェース記述子を持つことができます インタフェースとは デバイスに含まれるファンクションです 例えば USB スピーカには オーディオストリーミング用 オーディオコントロール用 各種スピーカボタンの管理用のインタフェースが各 1 個 合計 3 個のインタフェースがあります

24 クラスマネージャには デバイスインタフェースを 1 つ以上のクラスに結合するメカニズムが 2 つあります すなわち インタフェース記述子に含まれている PID/VID( 製品 ID とベンダ ID) の組み合わせを使用するメカニズムと クラス / サブクラス / プロトコルの組合せを使用するメカニズムがあります PID/VID の組み合わせは ジェネリッククラスによる駆動ができないインタフェースに対して有効です クラス / サブクラス / プロトコルの組合せは USB-IF 認定のクラス ( プリンタ ハブ ストレージ オーディオ HID など ) に属するインタフェースで使用されます クラスマネージャには USBX の初期化で登録されたクラスのリストがあります クラスマネージャは クラスを 1 つずつコールしていき そのデバイスのインタフェースの管理をいずれかのクラスが引き受けるようになるまでコールを続けます 1 つのクラスでは 1 つのインタフェースのみを管理できます USB オーディオスピーカの例では インタフェースの各々に対してクラスマネージャがすべてのクラスをコールします あるクラスがインタフェースを引き受けたら そのクラスの新しいインスタンスが作成されます 次にクラスマネージャは そのインタフェースのデフォルトの代替設定を探します 各デバイスでは 個々のインタフェースごとに 1 つ以上の代替設定を設けることができます クラスで他の代替設定への変更が決定されるまでは デフォルトの代替設定 0 が使用されます デフォルトの代替設定時には クラスマネージャは代替設定に含まれるすべてのエンドポイントをマウントします 各エンドポイントのマウントに成功すると クラスマネージャは最後にそのクラスに返り インタフェースの初期化が完成します USBX API USB スタックから 一定数の API がエクスポートされます これらは USB クラスがデバイスでの問い合わせおよび特定のエンドポイントでの USB 転送を実行するための API です これら API については リフェレンスマニュアルに詳述されています ホストコントローラ ホストコントローラドライバは 特定の種類の USB コントローラを駆動する任にあたります USB ホストコントローラは複数のコントローラを内蔵できます 例えば ある種のインテル PC チップセットは 2 つの UHCI コントローラを搭載しています また 一部の USB 2.0 コントローラには EHCI コントローラのインスタンス 1 つに加え OHCI コントローラのインスタンスを複数搭載しているものがあります ホストコントローラでは 同一のコントローラのみの複数のインスタンスを管理します ほとんどの USB 2.0 ホストコントローラを駆動するためには USBX の初期化時に OCHI コントローラと EHCI コントローラの両方を初期化することが必要になります ホストコントローラは 以下のものを管理の対象とします ルートハブ Power Management Endpoints Transfers

25 ルートハブ ルートハブ管理では 各コントローラポートに電源を投入し 挿入されているデバイスがあるかどうかを判定します この機能を USBX ジェネリックルートハブが使用し コントローラの下流ポートに問い合わせを行います 電力管理 電力管理処理は 中断 / 再開信号を扱うための機能です ギャングモードにしてコントローラのすべての下流ポートに同時に影響するようにするか または ( コントローラ側で対応している場合は ) 各ポートに対して個別に使用します エンドポイント エンドポイント管理では コントローラへの物理エンドポイントを作成または破壊することができます 物理エンドポイントとはメモリエンティティのことで マスター DMA をサポートするコントローラで解析される場合と コントローラに書き込まれている場合があります 物理エンドポイントには コントローラにより実行されるトランザクション情報が含まれています 転送 転送管理とは 作成した各エンドポイントでクラスがトランザクションを実行するためのものです 各論理エンドポイントには USB 転送要求用の TRANSFER REQUEST というコンポーネントが含まれています TRANSFER REQUEST は トランザクションを記述するためにスタックで使用されます この TRANSFER REQUEST がスタックとコントローラに渡され コントローラではその能力に応じていくつかのサブトランザクションに分割することができます

26 USB デバイスのフレームワーク USB デバイスは 記述子のツリーで表されます 記述子は次の 6 種類に大別されます デバイス記述子コンフィギュレーション記述子インタフェース記述子エンドポイント記述子ストリング記述子ファンクショナル記述子 USB デバイスは ごく簡潔に記述することが可能で その場合は次のようになります デバイス記述子 ストリング記述子 コンフィギュレーション記述子 インタフェース記述子 エンドポイント記述子 上の図では デバイスに含まれるコンフィギュレーションは 1 つだけです このコンフィギュレーションに 1 つのインタフェースがアタッチされています すなわち このデバイスではファンクションが 1 つだけ エンドポイントも 1 つだけです デバイス記述子にストリング記述子をアタッチして デバイスの識別を可視化しています

27 逆に もっと複雑なデバイスも可能で その場合は次のようになります デバイス記述子 ストリング記述子 コンフィギュレーション記述子 コンフィギュレーション記述子 インタフェース記述子 インタフェース記述子 インタフェース記述子 エンドポイント記述子 エンドポイント記述子 エンドポイント記述子 エンドポイント記述子 エンドポイント記述子 エンドポイント記述子 エンドポイント記述子 ファンクショナル記述子 ファンクショナル記述子 ファンクショナル記述子 上の図では デバイス記述子にコンフィギュレーション記述子が 2 つアタッチされています このデバイスでは 電力モードが 2 つある場合や 標準クラスや各社独自のクラスで駆動される場合などがあります 最初のコンフィギュレーションには 2 つのインタフェースがアタッチされている すなわち 2 つの論理ファンクションを持っています 最初のファンクションには エンドポイント記述子が 3 つ ファンクショナル記述子が 1 つあります ファンクショナル記述子は 例えばインタフェースの駆動を担うクラスが使用し このインタフェースに関してジェネリック記述子には含まれていないような追加情報を取得したりします

28 デバイス記述子 各 USB デバイスには デバイス記述子が 1 つあります この記述子には デバイス識別子 サポートしているコンフィギュレーションの数 およびデバイスのコンフィギュレーションに使用するデフォルトの制御エンドポイントの特性が記述されます オフセット フィールド サイズ 値 説明 0 BLength 1 数値 この記述子のサイズ ( 単位 バイト ) 1 bdescriptortype 1 定数 デバイス記述子の型 2 bcdusb 2 BCD USB 仕様リリース番号 (2 進化 10 進数 ) 例例 : 2.10 は 0x210 と等しい このフィールドには デバイスとその記述子が準拠する USB 仕様のリリース番号を示します 4 bdeviceclass 1 クラス クラスコード (USB-IF により割り当てられる ) このフィールドを 0 にリセットすると コンフィギュレーション内の各インタフェースが自身のクラス情報を指定し それぞれのインタフェースが独立して動作します このフィールドを 1~0xFE の値に設定すると デバイスはインタフェースごとに異なるクラス仕様をサポートすることになり 各インタフェースは独立して動作しない場合があります この値は インタフェースの集合に使用されるクラス定義を特定します このフィールドを 0xFF に設定すると ベンダ固有のデバイスクラスになります 5 bdevicesubclass 1 サブクラスサブクラスコード (USB-IF により割り当てられる ) これらのコードは bdeviceclass フィールドの値に修飾されます bdeviceclass フィールドが 0 にリセットされた場合は このフィールドも 0 にリセットする必要があります bdeviceclass フィールドが 0xFF に設定されない場合 すべての値が USB による割り当て用に予約されます 6 bdeviceprotocol 1 プロトコルプロトコルコード (USB-IF により割り当てられる ) これらのコードは bdeviceclass フィールドと bdevicesubclass フィールドの値に修飾されます インタフェースベースではなくクラスベースのクラス固有プロトコルをサポートするデバイスでは デバイスが使用するプロトコルを デバイスクラスの仕様の定義に従ってこのコードで識別します このフィールドを 0 にリセットすると デバイスはクラス固有プロトコルをデバイスベースで使用しません ただし インタフェースベースでクラス固有プロトコルを使用することはできます このフィールドを 0xFF に設定すると デバイスはベンダ固有プロトコルをデバイスベースで使用します 7 bmaxpacketsize0 1 数値 エンドポイント 0 の最大パケットサイズ ( バイトサイズ または 64 のみが有効 ) 8 idvendor 2 ID ベンダ ID(USB-IF により割り当てられる )

29 10 idproduct 2 ID 製品 ID( メーカーにより割り当てられる ) 12 bcddevice 2 BCD デバイスリリース番号 (2 進化 10 進数 ) 14 imanufacturer 1 インデックスメーカーを記述するストリング記述子のインデックス 15 iproduct 1 インデックス製品を記述するストリング記述子のインデックス 16 iserialnumber 1 インデックスデバイスのシリアル番号を記述するストリング記述子のインデックス 17 bnumconfiguration s 1 数値 可能なコンフィギュレーションの数 USBX では USB デバイス記述子を次のように定義します typedef struct UX_DEVICE_DESCRIPTOR_STRUCT { UINT blength; UINT bdescriptortype; USHORT bcdusb; UINT bdeviceclass; UINT bdevicesubclass; UINT bdeviceprotocol; UINT bmaxpacketsize0; USHORT idvendor; USHORT idproduct; USHORT bcddevice; UINT imanufacturer; UINT iproduct; UINT iserialnumber; UINT bnumconfigurations; } UX_DEVICE_DESCRIPTOR; USB デバイス記述子は 以下のデバイスコンテナの一部となっています typedef struct UX_DEVICE_STRUCT { ULONG ux_device_handle; ULONG ux_device_type; ULONG ux_device_state; ULONG ux_device_address; ULONG ux_device_speed; ULONG ux_device_port_location; ULONG ux_device_max_power; ULONG ux_device_power_source; UINT ux_device_current_configuration; TX_SEMAPHORE ux_device_protection_semaphore; struct UX_DEVICE_STRUCT *ux_device_parent; struct UX_HOST_CLASS_STRUCT *ux_device_class; VOID *ux_device_class_instance; struct UX_HCD_STRUCT *ux_device_hcd; struct UX_CONFIGURATION_STRUCT *ux_device_first_configuration; struct UX_DEVICE_STRUCT *ux_device_next_device; struct UX_DEVICE_DESCRIPTOR_STRUCT ux_device_descriptor;

30 struct UX_ENDPOINT_STRUCT ux_device_control_endpoint; struct UX_HUB_TT_STRUCT ux_device_hub_tt[ux_max_tt]; } UX_DEVICE; 変数名 ux_device_handle ux_device_type ux_device_state ux_device_address ux_device_speed ux_device_port_location ux_device_max_power ux_device_power_source ux_device_current_configuration ux_device_parent 変数の説明デバイスのハンドル 通常は デバイスのこの構造のインスタンスのアドレスです 廃止された値 不使用 デバイスステート 次のいずれかの値を設定できます UX_DEVICE_RESET 0 UX_DEVICE_ATTACHED 1 UX_DEVICE_ADDRESSED 2 UX_DEVICE_CONFIGURED 3 UX_DEVICE_SUSPENDED 4 UX_DEVICE_RESUMED 5 UX_DEVICE_SELF_POWERED_STATE 6 UX_DEVICE_SELF_POWERED_STATE 7 UX_DEVICE_REMOTE_WAKEUP 8 UX_DEVICE_BUS_RESET_COMPLETED 9 UX_DEVICE_REMOVED 10 UX_DEVICE_FORCE_DISCONNECT 11 SET_ADDRESS コマンドが受け付けられた後のデバイスのアドレス (1~127) デバイスの速度 UX_LOW_SPEED_DEVICE 0 UX_FULL_SPEED_DEVICE 1 UX_HIGH_SPEED_DEVICE 2 親デバイス ( ルートハブまたはハブ ) のポートのインデックス 選択されたコンフィギュレーションにおいてデバイスに取り込める最大電力 ( 単位 ma) 次の 2 つのいずれかの値が可能です UX_DEVICE_BUS_POWERED 1 UX_DEVICE_SELF_POWERED 2 このデバイスで現在使用しているコンフィギュレーションのインデックス このデバイスの親のデバイスコンテナポインタ ポインタが NULL なら コントローラのルートハブが親です

31 ux_device_class ux_device_class_instance ux_device_hcd ux_device_first_configuration ux_device_next_device ux_device_descriptor ux_device_control_endpoint ux_device_hub_tt このデバイスを所有するクラス型へのポインタ このデバイスを所有するクラスのインスタンスへのポインタ このデバイスがアタッチされる USB ホストコントローラインスタンス このデバイスの 1 番目のコンフィギュレーションコンテナへのポインタ USBX により検出されるいずれかのバスにあるデバイスのうち デバイスリストに含まれる次のデバイスへのポインタ USB device descriptor. このデバイスで使用するデフォルトの制御エンドポイントの記述子 デバイスのハブ TT の配列 コンフィギュレーション記述子 コンフィギュレーション記述子には 特定のデバイスコンフィギュレーションに関する情報を記述します USB デバイスには 1 つ以上のコンフィギュレーション記述子を含めることができます デバイス記述子の bnumconfigurations フィールドに コンフィギュレーション記述子の数が示されます コンフィギュレーション記述子の bconfigurationvalue フィールドの値は それが Set Configuration 要求へのパラメータとして使用された場合 その値に対応するコンフィギュレーションをデバイスが取るようになります コンフィギュレーション記述子には コンフィギュレーションで提供されるインタフェースの数を記述します 各インタフェースは デバイス内での論理ファンクションを表すもので それぞれ独立して動作することが可能です 例えば USB オーディオスピーカでは オーディオストリーミングインタフェース オーディオコントロールインタフェース 各種スピーカボタンの管理用の HID インタフェースが各 1 個 合計 3 個のインタフェースを設けることができます ホストがコンフィギュレーション記述子に対して GET_DESCRIPTOR 要求を発行すると 関連するインタフェース記述子とエンドポイント記述子がすべて返されます

32 オフセットフィールドサイズ値説明 0 blength 1 数値この記述子のサイズ ( 単位 バイト ) 1 bdescriptortype 1 定数コンフィギュレーション 2 wtotallength 2 数値 このコンフィギュレーションに対して返されるデータの合計長さ このコンフィギュレーションに対して返されるすべての記述子 ( コンフィギュレーション インタフェース エンドポイント およびクラス固有またはベンダ固有 ) を組合わせた長さが含まれます 4 bnuminterfaces 1 数値 このコンフィギュレーションでサポートされるインタフェースの合計数 5 bconfigurationvalue 1 数値 このコンフィギュレーションを選択するために Set Configuration の引数として使用する値 6 iconfiguration 1 インデックスこのコンフィギュレーションを記述するストリング記述子のインデックス 7 bmattributes 1 ビットマップ コンフィギュレーション特性 D7 バス電力 D6 自己電力 D5 リモートウェイクアップ D4..0 予約済み (0 にリセット ) バスからの電力およびローカル電源を使用するデバイスコンフィギュレーションでは D7 と D6 の両方をセットします 実行時の実際の電源は Get Status デバイス要求を使用して決定することも可能です デバイスコンフィギュレーションがリモートウェイクアップをサポートする場合は D5 を 1 に設定します 8 MaxPower 1 ma デバイスが完全に機能するときに このコンフィギュレーションにおいてバスから供給される電力に対する USB デバイスの最大消費電力 2mA 単位で表します ( 例 : 50 = 100mA) 注 : コンフィギュレーションがバス電力か自己電力かは デバイスコンフィギュレーションで報告します デバイスは現在自己電力で動作しているかどうかは デバイスステータスで報告します デバイスの外部電源から接続が切断したときは デバイスがデバイスステータスを更新し 自己 電力ではなくなっていることを示します

33 USBX では USB コンフィギュレーション記述子を次のように定義します typedef struct UX_CONFIGURATION_DESCRIPTOR_STRUCT { UINT blength; UINT bdescriptortype; USHORT wtotallength; UINT bnuminterfaces; UINT bconfigurationvalue; UINT iconfiguration; UINT bmattributes; UINT MaxPower; } UX_CONFIGURATION_DESCRIPTOR; USB コンフィギュレーション記述子は 以下のコンフィギュレーションコンテナの一部となっています typedef struct UX_CONFIGURATION_STRUCT { ULONG ux_configuration_handle; ULONG ux_configuration_state; struct UX_CONFIGURATION_DESCRIPTOR_STRUCT ux_configuration_descriptor; struct UX_INTERFACE_STRUCT *ux_configuration_first_interface; struct UX_CONFIGURATION_STRUCT *ux_configuration_next_configuration; struct UX_DEVICE_STRUCT *ux_configuration_device; } UX_CONFIGURATION; 変数名 変数の説明 ux_configuration_handle コンフィギュレーションのハンドル 通常は コンフィギュ レーションのこの構造のインスタンスのアドレスです ux_configuration_state コンフィギュレーションのステート ux_configuration_descriptor USB device descriptor. ux_configuration_first_interface このコンフィギュレーションの 1 番目のインタフェースへの ポインタ ux_configuration_next_configuration 同じデバイスの次のコンフィギュレーションへのポインタ ux_configuration_device このコンフィギュレーションのデバイス所有者へのポインタ インタフェース記述子 インタフェース記述子には コンフィギュレーション内の特定のインタフェースについて記述します インタフェースとは USB デバイス内の論理ファンクションです コンフィギュレーションには 1 つ以上のインタフェースを備えています 各インタフェースには コンフィギュレーションに含まれるエンドポイントの一意のセットを記述する エンドポイント記述子が 0 個以上含まれます 2 つ以上のインタフェースをサポートするコンフィギュレーションでは 指定されたコンフィギュレーションについて GET_DESCRIPTOR 要求から返されるデータに含まれるインタフェース記述子に 各インタフェースのエンドポイント記述子が従います

34 インタフェース記述子は 必ずコンフィギュレーション記述子の一部として返されます GET_DESCRIPTOR 要求からインタフェース記述子に直接アクセスすることはできません デバイスをコンフィギュレーションした後にエンドポイントやその特性を変更できるように 代替設定をインタフェースに含めることができます インタフェースのデフォルト設定では 常に代替設定が 0 です 現在の代替設定をクラスから変更することで インタフェースの挙動および関連するエンドポイントの特性を変更することができます 代替設定の選択やデフォルト設定への復帰には SET_INTERFACE 要求を使用します 代替設定を使用することで 他のインタフェースを作動させたままでデバイスのコンフィギュレーションを一部変更することができます 1 つまたは複数のインタフェースに対して代替設定を備えているコンフィギュレーションでは 別のインタフェース記述子とその関連エンドポイントが代替設定ごとに含まれます 2 つの代替設定を持つ 1 つのインタフェースを記述したデバイスコンフィギュレーションの場合 このコンフィギュレーションに GET_DESCRIPTOR 要求を発行すると コンフィギュレーション記述子が返され 次に binterfacenumber フィールドと balternatesetting フィールドが共に 0 に設定されたインタフェース記述子が返され その次にその設定のエンドポイント記述子が返されます その後に もう 1 つのインタフェース記述子およびそれに関連するエンドポイント記述子が返されてきます 2 番目のインタフェース記述子では binterfacenumber フィールドは 0 に設定されていますが balternatesetting フィールドは 1 に設定されています つまり この代替設定は 1 番目のインタフェースに属するものです 関連するエンドポイントを持たないインタフェースもありますが その場合は デフォルトの制御エンドポイントのみが有効なインターフェイスとなっています 代替設定は主に インタフェースに関連する周期的エンドポイントへの要求帯域幅を変更するために使用されます 例えば USB スピーカのストリーミングインタフェースの場合 1 番目の代替設定には アイソクロナスエンドポイントでの帯域幅需要として 0 を設定します その他の代替設定では オーディオストリーミング周波数に応じて異なる帯域幅要件が選択できます インタフェースの USB 記述子は次のようになっています オフ フィールド サイズ 値 記述子 セット 0 blength 1 数値 この記述子のサイズ ( 単位 バイト ) 1 bdescriptortype 1 定数 インタフェース記述子の型 2 binterfacenumber 1 数値 インタフェースの番号 このコンフィギュレーションでサポートされる並列インタフェースの配列内のインデックスを示す ゼロベースの値 3 baltenatesetting 1 数値 前のフィールドで示したインタフェースに対する代替設定を選択するための値 4 bnumendpoints 1 数値 この値を 0 に設定すると このインタフェースはエンドポイント 0 のみを使用します

35 5 binterfaceclass 1 クラス クラスコード (USB により割り当てられる ) この値を 0 にリセットすると インタフェースは USB 指定のどのデバイスクラスにも属さなくなります このフィールドを 0xFF に設定すると インタフェースクラスはベンダ固有になります その他の値はすべて USB による割り当て用に予約されています 6 binterfacesubclas s 1 サブクラスサブクラスコード (USB により割り当てられる ) これらのコードは binterfaceclass フィールドの値に修飾されます binterfaceclass フィールドが 0 にリセットされた場合は このフィールドも 0 にリセットする必要があります binterfaceclass フィールドが 0xFF に設定されない場合 すべての値が USB による割り当て用に予約されます 7 binterfaceprotocol 1 プロトコルプロトコルコード (USB により割り当てられる ) これらのコードは binterfaceclass フィールドと binterfacesubclass フィールドの値に修飾されます クラス固有要求をインタフェースでサポートする場合 デバイスクラスの仕様に従ってデバイスが使用するプロトコルを このコードで特定します このフィールドを 0 にリセットすると デバイスはこのインタフェースにクラス固有プロトコルを使用しません このフィールドを 0xFF に設定すると デバイスはこのインタフェースにベンダ固有プロトコルを使用します 8 iinterface 1 インデックスこのインタフェースを記述するストリング記述子のインデックス USBX では USB インタフェース記述子を次のように定義します typedef struct UX_INTERFACE_DESCRIPTOR_STRUCT { UINT blength; UINT bdescriptortype; UINT binterfacenumber; UINT balternatesetting; UINT bnumendpoints; UINT binterfaceclass; UINT binterfacesubclass; UINT binterfaceprotocol; UINT iinterface; } UX_INTERFACE_DESCRIPTOR;

36 USB インタフェース記述子は 以下のインタフェースコンテナの一部となっています typedef struct UX_INTERFACE_STRUCT { ULONG ux_interface_handle; ULONG ux_interface_state; ULONG ux_interface_current_alternate_setting; struct UX_INTERFACE_DESCRIPTOR_STRUCT ux_interface_descriptor; struct UX_HOST_CLASS_STRUCT *ux_interface_class; VOID *ux_interface_class_instance; struct UX_ENDPOINT_STRUCT *ux_interface_first_endpoint; struct UX_INTERFACE_STRUCT *ux_interface_next_interface; struct UX_CONFIGURATION_STRUCT *ux_interface_configuration; } UX_INTERFACE; 変数名 ux_interface_handle ux_interface_state ux_interface_descriptor ux_interface_class ux_interface_class_instance ux_interface_first_endpoint ux_interface_next_interface ux_interface_configuration 変数の説明インタフェースのハンドル 通常は インタフェースのこの構造のインスタンスのアドレスです インタフェースのステート USB インタフェース記述子このインタフェースを所有するクラス型へのポインタこのインタフェースを所有するクラスのインスタンスへのポインタこのインタフェースで登録される 1 番目のエンドポイントへのポインタこのコンフィギュレーションに関連する次のインタフェースへのポインタこのインタフェースのコンフィギュレーション所有者へのポインタ エンドポイント記述子 インタフェースに関連するエンドポイントには それぞれ自身のエンドポイント記述子があります この記述子には 各エンドポイントに関し その帯域幅要件 関連する最大ペイロード 周期性 および方向を それぞれホストスタックで決定するのに必要な情報を記述します エンドポイント記述子は常に コンフィギュレーションに対する GET_DESCRIPTOR コマンドによって返されます デバイス記述子に関連するデフォルトの制御エンドポイントは インタフェースに関連するエンドポイントの一部とはカウントされないため この記述子では返されません インタフェースの代替設定の切り替えをホストソフトウェアが要求するときは 関連するすべてのエンドポイントとその USB リソースが新しい代替設定に従って修正されます デフォルトの制御エンドポイントを除き エンドポイントをインタフェース間で共有することはできません

37 オフセットフィールドサイズ値説明 0 blength 1 数値この記述子のサイズ ( 単位 バイト ) 1 bdescriptortype 1 定数エンドポイント記述子の型 2 bendpointaddress 1 エンドポイントこの記述子に記述される USB デバイス上のエンドポイ ントのアドレス アドレスは次のようにエンコードされま す ビット 3~0: エンドポイント番号ビット 6~4: 予約 (0 にリセット ) ビット 7: 方向 ( 制御エンドポイントの場合は無視 ) 0 = OUT エンドポイント 1 = IN エンドポイント 3 bmattributes 1 ビットマップ このフィールドには bconfigurationvalue を用いてエンドポイントをコンフィギュレーションするときの エンドポイントの属性を記述します ビット 1~0: 転送の種類 00 = 制御 01 = アイソクロナス 10 = バルク 11 = インタラプト アイソクロナスエンドポイントでない場合は ビット 5~ 2 は予約されていて 0 に設定する必要があります アイソクロナスの場合は 次のように定義されます ビット 3~2: 同期の種類 00 = 同期なし 01 = 非同期 10 = 適応 11 = 同期 ビット 5~4: 使用法の種類 00 = データエンドポイント 01 = フィードバックエンドポイント 10 = インプリシット フィードバックデータエンドポイント 4 wmaxpacketsize 2 数値 このコンフィギュレーションを選択したときにこのエンドポイントで送受信可能な最大パケットサイズ アイソクロナスエンドポイントの場合は ( マイクロ ) フレームあたりのデータペイロードに必要となるバス時間を この値でスケジュールに予約します パイプで実際に使用される帯域幅 ( 継続ベース ) は 予約した帯域幅より少ない場合があります 実際に使用した帯域幅は デバイスから通常の非 USB 定義のメカニズムを介して必要に応じて報告されます すべてのエンドポイントについて ビット 10~0 で最大パケットサイズを指定します

38 高速アイソクロナスおよびインタラプトのエンドポイントの場合は : ビット 12~11 では マイクロフレームあたりの追加トランザクション機会数を指定します 00 = なし (1 トランザクション / マイクロフレーム ) 01 = 1 additional (2 per microframe) 10 = 2 つ追加 (3/ マイクロフレーム ) 11 = 予約ビット 15~13 は予約済みで 0 に設定する必要があります 6 binterval 1 数値 データ転送用にエンドポイントをポーリングする間隔数値 デバイスの動作速度に応じてフレーム数またはマイクロフレーム数で表します (1 ミリ秒または 125 マイクロ秒単位 ) 全速 / 高速アイソクロナスエンドポイントでは この値を 1~16 の範囲に設定する必要があります binterva 値は 2 x binterval - 1 の値の指数として使用されます 例えば binterval を 4 にすると 8 (24-1) の周期になります 全速 / 低速インタラプトエンドポイントでは このフィールドの値は 1~255 が可能です 高速インタラプトエンドポイントでは binterva 値は 2 binterval - 1 の値の指数として使用されます 例えば binterval を 4 にすると 8 (24-1) の周期になります この値は 1~16 とします 高速バルク / 制御 OUT エンドポイントでは binterval でエンドポイントの最大 NAK 率を指定する必要があります 0 は NAK が絶対に発生しないことを示します その他の値では binterval マイクロ秒ごとに NAK 数が高々 1 となります この値は 0~255 の範囲内である必要があります USBX では USB エンドポイント記述子を次のように定義します typedef struct UX_ENDPOINT_DESCRIPTOR_STRUCT { UINT blength; UINT bdescriptortype; UINT bendpointaddress; UINT bmattributes; USHORT wmaxpacketsize; UINT binterval; } UX_ENDPOINT_DESCRIPTOR;

39 USB エンドポイント記述子は 以下のエンドポイントコンテナの一部となっています typedef struct UX_ENDPOINT_STRUCT { ULONG ULONG VOID struct UX_ENDPOINT_DESCRIPTOR_STRUCT struct UX_ENDPOINT_STRUCT struct UX_INTERFACE_STRUCT struct UX_DEVICE_STRUCT struct UX_TRANSFER REQUEST_STRUCT } UX_ENDPOINT; ux_endpoint_handle; ux_endpoint_state; *ux_endpoint_ed; ux_endpoint_descriptor; *ux_endpoint_next_endpoint; *ux_endpoint_interface; *ux_endpoint_device; ux_endpoint_transfer request; Variable Name ux_endpoint_handle ux_endpoint_state ux_endpoint_ed ux_endpoint_descriptor ux_endpoint_next_endpoint ux_endpoint_interface ux_endpoint_device ux_endpoint_transfer request 変数の説明エンドポイントのハンドル 通常は エンドポイントのこの構造のインスタンスのアドレスです エンドポイントのステートホストコントローラレイヤでの物理エンドポイントへのポインタ USB エンドポイント記述子同じインタフェースに属する次のエンドポイントへのポインタこのエンドポイントインタフェースを所有するインタフェースへのポインタ親デバイスコンテナへのポインタデバイスとの間でデータを送受信するための USB 転送要求 ストリング記述子 ストリング記述子はオプションです デバイスでストリング記述子をサポートしていない場合は デバイス記述子 コンフィギュレーション記述子 インタフェース記述子にそれぞれ含まれるストリング記述子への参照は すべて 0 にリセットする必要があります ストリング記述子では UNICODE エンコーディングを使用します これにより いくつかの文字セットをサポートすることができます USB デバイス内のストリングは 複数の言語のサポートが可能です ストリング記述子を要求するときにリクエスタは USB-IF で定義されている言語を使用して目的の言語を指定します 現在定義されている USB LANGID のリストを USBX の附属書?? に載せてあります すべての言語に対してストリングインデックスをゼロにすると デバイスでサポートしている 2 バイトの LANGID コードの配列を含むストリング記述子が返ります なお UNICODE ストリングは 0 では終わりません 代わりに 記述子の先頭バイトに含まれる配列のサイズから 2 を差し引いてストリング配列のサイズが計算されます

40 USB ストリング記述子 0 は 次のようにエンコードされます オフセットフィールドサイズ値説明 0 blength 1 N+2 この記述子のサイズ ( 単位 バイト ) 1 bdescriptortype 1 定数ストリング記述子の型 2 wlangid[0] 2 数値 LANGID コード 0.. ].. N wlangid[n] 2 数値 LANGID コード n

41 その他の USB ストリング記述子は 次のようにエンコードされます オフセット フィールド サイズ 値 説明 0 blength 1 数値 この記述子のサイズ ( 単位 バイト ) 1 bdescriptortype 1 定数 ストリング記述子の型 2 bstring N 数値 UNICODE エンコードストリング USBX では 非ゼロ長の USB ストリング記述子を次のように定義します typedef struct UX_STRING_DESCRIPTOR_STRUCT { UINT blength; UINT bdescriptortype; USHORT bstring[1]; } UX_STRING_DESCRIPTOR; ファンクショナル記述子 ファンクション記述子は クラス固有記述子とも呼ばれます この記述子は通常 ジェネリック記述子と同じ基本構造を用い 追加の情報がクラスで使用できるようになります 例えば USB オーディオスピーカの場合では オーディオクラスがクラス固有記述子を使用することで サポートされるオーディオ周波数の種類を代替設定ごとに取得することができます メモリ内の USBX デバイス記述子フレームワーク USBX では ほとんどのデバイス記述子 すなわちストリング記述子とファンクション記述子を除くすべての記述子が メモリに保持されます 次の図に 各記述子がどのように保存され 互いにどのように関係するかを示します

42 デバイスデバイス記述子コンフィギュレーションコンフィギュレーション述デバイスコンテナデバイス記述子コンフィギュレーションコンテナコンフィギュレーション記述子インタフェースコンテナ ( 代替設定 0) インタフェースインタフェースコンテナ ( 代替設定 1) インタフェース述インタフェース記述子エンドポイントコンテナエンドポイントコンテナエンドポイントコンテナエンドポイントコンテナエンドポイント記述子エンドポイント記述子エンドポイント記述子エンドポイント記述子デバイスコンテナコンフィギュレーションコンテナデバイス記述子コンフィギュレーション記述子インタフェースコンテナインタフェース記述子

43 第 4 章 USBX ホストサービスの説明

44 ux_host_stack_initialize ホスト操作用に USBX を初期化 プロトタイプ UINT ux_host_stack_initialize(uint (*system_change_function) (ULONG, UX_HOST_CLASS *)) 説明 USB ホストスタックを初期化するファンクションです 与えられたメモリ領域が USBX 内部での使用用にセットアップされます UX_SUCCESS が返されたら USBX はホストコントローラとクラスの登録が可能になります 入力パラメータ system_change_function アプリケーションにデバイスの変更を通知するためのオプションのコールバックルーチンへのポインタ 返却値 Example UX_SUCCESS (0x00) 初期化成功 UINT status; /* Initialize USBX for host operation, without notification. */ status = ux_host_stack_initialize(ux_null); /* If status equals UX_SUCCESS, USBX has been successfully initialized for host operation.*/

45 ux_host_stack_endpoint_transfer_abort エンドポイントへの転送要求にアタッチされているすべてのトランザクションをアボートプロトタイプ UINT ux_host_stack_endpoint_transfer_abort(ux_endpoint *endpoint) 説明 エンドポイントにアタッチされている特定の転送要求に関し すべてのトランザクションを ( アクティブか保留中かにかかわりなく ) 取り消すファンクションです 転送要求にコールバックファンクションがアタッチされているときは UX_TRANSACTION_ABORTED ステータスでコールバックファンクションがコールされます 入力パラメータ endpoint エンドポイントへのポインタ 返却値 例 UX_SUCCESS (0x00) エラーなし UX_ENDPOINT_HANDLE_UNKNOWN (0x53) UX_HOST_CLASS_PRINTER *printer; UINT status; エンドポイントハンドルが無効です /* Get the instance for this class.*/ printer = (UX_HOST_CLASS_PRINTER *) command -> ux_host_class_command_instance; /* The printer is being shut down.*/ printer -> printer_state = UX_HOST_CLASS_INSTANCE_SHUTDOWN; /* We need to abort transactions on the bulk out pipe.*/ status = ux_host_stack_endpoint_transfer_abort (printer -> printer_bulk_out_endpoint); /* If status equals UX_SUCCESS, the operation was successful */

46 ux_host_stack_class_get クラスコンテナへのポインタを取得 プロトタイプ UINT ux_host_stack_class_get(uchar *class_name, UX_HOST_CLASS **class) 説明 パラメータ クラスコンテナへのポインタを返すファンクションです クラスまたはアプリケーションでデバイスをオープンしようとするときに クラスでは インスタンスを検索するために USB スタックからクラスのコンテナを取得する必要があります class_name class Pointer to the class name. クラスの名前に関し クラスコンテナを記述したファンクションコールにより更新されたポインタ 返却値 UX_SUCCESS (0x00) エラーなし 返却時に クラスフィールドが クラスコンテナへのポインタとともにファイ ル化されます UX_HOST_CLASS_UNKNOWN (0x59) スタックにとって不明のクラスです 例 UX_HOST_CLASS UINT *printer_container; status; /* Get the container for this class. */ status = ux_host_stack_class_get("ux_host_class_printer", &printer_container); /* If status equals UX_SUCCESS, the operation was successful */

47 ux_host_stack_class_register USB スタックに USB クラスを登録 プロトタイプ UINT ux_host_stack_class_register(char_ptr class_name, UINT (*class_entry_address) (struct UX_HOST_CLASS_COMMAND_STRUCT *)) 説明 パラメータ USB スタックに USB クラスを登録するファンクションです 以下のようなコマンドを送信するためには クラスは USB スタックへのエントリポイントを指定する必要があります UX_HOST_CLASS_COMMAND_QUERY UX_HOST_CLASS_COMMAND_ACTIVATE UX_HOST_CLASS_COMMAND_DESTROY class_name class_entry_address クラス名へのポインタについては USBX の USB クラスの下にあるファイル ux_system_initialize.c に有効なエントリが見つかります クラスのエントリファンクションのアドレス 返却値 例 UX_SUCCESS UX_MEMORY_INSUFFICIENT (0x00) クラスが正常にインストールされました (0x12) このクラスを保存するためのメモリが不足しています UX_HOST_CLASS_ALREADY_INSTALLED (0x58) ホストクラスは既にインストールされています UINT status; /* Register all the classes for this implementation.*/ status = ux_host_stack_class_register("ux_host_class_hub", ux_host_class_hub_entry); /* If status equals UX_SUCCESS, class was successfully installed.*/

48 ux_host_stack_class_instance_create プロトタイプ クラスコンテナに新しいクラスインスタンスを作成 UINT ux_host_stack_class_instance_create(ux_host_class *class, VOID *class_instance) 説明 パラメータ クラスコンテナに新しいクラスインスタンスを作成するファンクションです クラスの複雑さを軽減するために クラスのインスタンスはクラスコードには含まていません 代わりに メインスタックにあるクラスコンテナに各クラスがアタッチされています class class_instance クラスコンテナへのポインタ 作成するクラスインスタンスへのポインタ 返却値 Example UX_SUCCESS (0x00) クラスインスタンスがクラスコンテナにアタッチされま した UINT UX_HOST_CLASS_PRINTER status; *printer; /* Obtain memory for this class instance.*/ printer = ux_memory_allocate(ux_no_align, sizeof(ux_host_class_printer)); if (printer == UX_NULL) return(ux_memory_insufficient); /* Store the class container into this instance.*/ printer -> printer_class = command -> ux_host_class; /* Create this class instance. */ status = ux_host_stack_class_instance_create(printer -> printer_class, (VOID *)printer); /* If status equals UX_SUCCESS, the class instance was successfully created and attached to the class container.*/

49 ux_host_stack_class_instance_destroy プロトタイプ クラスコンテナのクラスインスタンスを破棄 UINT ux_host_stack_class_instance_destroy(ux_host_class *class, VOID *class_instance); 説明 パラメータ クラスコンテナのクラスインスタンスを破棄するファンクションです class class_instance クラスコンテナへのポインタ 破棄するインスタンスへのポインタ 返却値 UX_SUCCESS (0x00) クラスインスタンスが破棄されま した. UX_HOST_CLASS_INSTANCE_UNKNOWN (0x5b) クラスインスタンスがクラスコンテナにアタッチされていません 例 UINT UX_HOST_CLASS_PRINTER status; *printer; /* Get the instance for this class. */ printer = (UX_HOST_CLASS_PRINTER *) command -> ux_host_class_command_instance; /* The printer is being shut down. */ printer -> printer_state = UX_HOST_CLASS_INSTANCE_SHUTDOWN; /* Destroy the instance.*/ status = ux_host_stack_class_instance_destroy(printer -> printer_class, (VOID *) printer); /* If status equals UX_SUCCESS, the class instance was successfully destroyed.*/

50 ux_host_stack_class_instance_get プロトタイプ 特定のクラスへのクラスインスタンスポインタを取得 UINT ux_host_stack_class_instance_get(ux_host_class *class, UINT class_index, VOID **class_instance) 説明 パラメータ 特定のクラスへのクラスインスタンスポインタを返すファンクションです クラスの複雑さを軽減するために クラスのインスタンスはクラスコードには含まていません 代わりに クラスコンテナに各クラスがアタッチされています このファンクションは クラスコンテナ内でクラスインスタンスを検索するために使用されます class class_index class_instance クラスコンテナへのポインタ コンテナにアタッチされているクラスのリスト内で ファンクションコールが使用するインデックス ファンクションコールにより返されるインスタンスへのポインタ 返却値 例 UX_SUCCESS (0x00) クラスインスタンスが見つかりま した UX_HOST_CLASS_INSTANCE_UNKNOWN (0x5b) これ以上のクラスインスタンスはクラスコンテナにアタッチされていません UINT UX_HOST_CLASS_PRINTER status; *printer; /* Obtain memory for this class instance.*/ printer = ux_memory_allocate(ux_no_align, sizeof(ux_host_class_printer)); if (printer == UX_NULL) return(ux_memory_insufficient); /* Search for instance index 2.*/ status = ux_host_stack_class_instance_get(class, 2, (VOID *) printer); /* If status equals UX_SUCCESS, the class instance was found.*/

51 ux_host_stack_device_configuration_get プロトタイプ コンフィギュレーションコンテナへのポインタを取得 UINT ux_host_device_stack_configuration_get(ux_device *device, UINT configuration_index, UX_CONFIGURATION **configuration) 説明 パラメータ デバイスハンドルとコンフィギュレーションインデックスに基づいて コンフィギュレーションコンテナを返すファンクションです device configuration_index configuration 要求されたコンフィギュレーションを所有するデバイスコンテナへのポインタ 検索対象のコンフィギュレーションのインデックス 返却対象のコンフィギュレーションコンテナへのポインタのアドレス 返却値 例 UX_SUCCESS (0x00) コンフィギュレーションが見つか りました UX_DEVICE_HANDLE_UNKNOWN (0x50) デバイスコンテナが存在しません UX_CONFIGURATION_HANDLE_UNKNOWN (0x51) インデックスのコンフィギュレーションハンドルが存在しません UINT UX_HOST_CLASS_PRINTER status; *printer; /* If the device has been configured already, we don't need to do it again.*/ if (printer -> printer_device -> ux_device_state == UX_DEVICE_CONFIGURED) return(ux_success); /* A printer normally has one configuration, retrieve 1st configuration only.*/ status = ux_host_stack_device_configuration_get(printer -> printer_device, 0, configuration); /* If status equals UX_SUCCESS, the configuration was found.*/

52 ux_host_stack_device_configuration_select プロトタイプ デバイスに特定のコンフィギュレーションを選択 UINT ux_host_stack_device_configuration_select (UX_CONFIGURATION *configuration) 説明 パラメータ デバイスに特定のコンフィギュレーションを選択するファンクションです このコンフィギュレーションをデバイスに設定すると デフォルトでは 各デバイスインタフェースとそれに関連する代替設定 0 がデバイス上でアクティブになります 特定のインタフェースの設定をデバイスクラスやインタフェースクラスで変更しようとする場合は ux_host_stack_interface_setting_select サービスコールを発行する必要があります configuration このサービスに対して有効にすべきコンフィギュレーションコンテナへのポインタ 返却値 例 UX_SUCCESS (0x00) コンフィギュレーションの選択に成功しました UX_CONFIGURATION_HANDLE_UNKNOWN (0x51) コンフィギュレーションハンドルが存在しません UX_OVER_CURRENT_CONDITION (0x43) このコンフィギュレーションに対してバス上に過電流状態が存在します UINT UX_HOST_CLASS_PRINTER status; *printer; /* If the device has been configured already, we don't need to do it again.*/ if (printer -> printer_device -> ux_device_state == UX_DEVICE_CONFIGURED) return(ux_success); /* A printer normally has one configuration - retrieve 1 st configuration only.*/ status = ux_host_stack_device_configuration_get(printer -> printer_device, 0,configuration); /* If status equals UX_SUCCESS, the configuration selection was successful.*/

53 /* If valid configuration, ask USBX to set this configuration.*/ status = ux_host_stack_device_configuration_select(configuration); /* If status equals UX_SUCCESS, the operation was successful.*/

54 ux_host_stack_device_get デバイスコンテナへのポインタを取得 プロトタイプ UINT ux_host_stack_device_get(ulong device_index, UX_DEVICE **device) 説明 パラメータ デバイスコンテナを デバイスのインデックスに基づいて返すファンクションです デバイスインデックスは 0 で始まります 複数のコントローラを備えることも可能で しかもバイトインデックスでは不十分なため インデックスが ULONG 型であることに注意してください また デバイスインデックスは バス固有のデバイスアドレスとは異なります device_index device デバイスのインデックス 返却対象のデバイスコンテナへのポインタのアドレス 返却値 UX_SUCCESS (0x00) デバイスコンテナが存在し 返されました UX_DEVICE_HANDLE_UNKNOWN (0x50) デバイスが不明です 例 UINT status; /* Locate the first device in USBX.*/ status = ux_host_stack_device_get(0, device); /* If status equals UX_SUCCESS, the operation was successful.*/

55 ux_host_stack_interface_endpoint_get エンドポイントコンテナを取得 プロトタイプ UINT ux_host_stack_interface_endpoint_get(ux_interface *interface, UINT endpoint_index, UX_ENDPOINT **endpoint) 説明 パラメータ インタフェースハンドルとエンドポイントインデックスに基づいて エンドポイントコンテナを返すファンクションです エンドポイントの検索に先立ち インタフェースの代替設定が選択されているか またはデフォルト設定が使用されているものとします interface Endpoint_index endpoint 要求されたエンドポイントを含むインタフェースコンテナへのポインタ このインタフェースに入っているエンドポイントのインデックス 返却対象のエンドポイントコンテナのアドレス 返却値 例 UX_SUCCESS (0x00) エンドポイントコンテナが存在し 返されました UX_INTERFACE_HANDLE_UNKNOWN (0x52) 指定されたインタフェースが存在 しません UX_ENDPOINT_HANDLE_UNKNOWN (0x53) エンドポイントインデックスが存 在しません UINT UX_HOST_CLASS_PRINTER status; *printer; for (endpoint_index = 0; endpoint_index < printer -> printer_interface -> ux_interface_descriptor.bnumendpoints; endpoint_index++) { status = ux_host_stack_interface_endpoint_get (printer ->printer_interface, endpoint_index, &endpoint); if (status == UX_SUCCESS) {

56 } } /* Check if endpoint is bulk and OUT.*/ if (((endpoint -> ux_endpoint_descriptor.bendpointaddress & UX_ENDPOINT_DIRECTION) == UX_ENDPOINT_OUT) && ((endpoint -> ux_endpoint_descriptor.bmattributes & UX_MASK_ENDPOINT_TYPE) == UX_BULK_ENDPOINT)) return(ux_success)

57 ux_host_stack_hcd_register USB スタックに USB コントローラを登録 プロトタイプ UINT ux_host_stack_hcd_register(char_ptr hcd_name, UINT (*hcd_function)(struct UX_HCD_STRUCT *), ULONG hcd_param1, ULONG hcd_param2) 説明 パラメータ 返却値 USB スタックに USB コントローラを登録するファンクションです このファンクションは主に このコントローラで使用しているメモリを割り当て コントローラに初期化コマンドを渡します hcd_name hcd_function hcd_param1 ホストコントローラの名前使用可能なコントローラとして 次のものがあります "ux_hcd_ohci" "ux_hcd_ehci" "ux_hcd_isp1161" ホストコントローラに含まれていて 初期化を担うファンクション 使用可能なコントローラエントリファンクションとして 次のものがあります ux_hcd_ehci_initialize ux_hcd_ohci_initialize ux_hcd_isp1161_initialize hcd で使用している IO またはメモリリソース hcd_param2 ホストコントローラで使用している IRQ UX_SUCCESS (0x00) コントローラが正しく初期化されました UX_MEMORY_INSUFFICIENT (0x12) このコントローラのためのメモリが不足し ています UX_PORT_RESET_FAILED (0x31) コントローラのリセットに失敗しました UX_CONTROLLER_INIT_FAILED (0x32) コントローラが正しく初期化されませんで した

58 例 UINT status; /* Initialize an OHCI controller mapped at address 0xd0000 and using IRQ 10.*/ status = ux_host_stack_hcd_register("ux_hcd_ohci", ux_hcd_ohci_initialize, 0xd0000, 0x0a); /* If status equals UX_SUCCESS, the controller was initialized properly.*/ /* Note that the application must also setup a call to the interrupt handler for the OHCI controller.the function for OHCI is called _ux_hch_ohci_interrupt_handler.*/

59 ux_host_stack_configuration_interface_get プロトタイプ インタフェースコンテナポインタを取得 UINT ux_host_stack_configuration_interface_get (UX_CONFIGURATION *configuration, UINT interface_index, UINT alternate_setting_index, UX_INTERFACE **interface) 説明 パラメータ コンフィギュレーションハンドル インタフェースインデックス および代替設定インデックスに基づいて インタフェースコンテナを返すファンクションです configuration interface_index alternate_setting_index interface インタフェースを所有するコンフィギュレーションコンテナへのポインタ 検索対象のインデックス インタフェースに含まれている 検索対象の代替設定 返却対象のインタフェースコンテナポインタのアドレス 返却値 例 UX_SUCCESS (0x00) インタフェースインデックスと代替設定に対応するインタフェースコンテナが見つかり 返されました UX_CONFIGURATION_HANDLE_UNKNOWN (0x51) コンフィギュレーションが存在しません UX_INTERFACE_HANDLE_UNKNOWN (0x52) インタフェースが存在しません UINT status; /* Search for the default alternate setting on the first interface for the printer.*/ status = ux_host_stack_configuration_interface_get(configuration, 0, 0, &printer -> printer_interface); /* If status equals UX_SUCCESS, the operation was successful.*/

60 ux_host_stack_interface_setting_select インタフェースの代替設定を選択 プロトタイプ UINT ux_host_stack_interface_setting_select(ux_interface *interface) 説明 選択したコンフィギュレーションに属するあるインタフェースについて 特定の代替設定を選択するファンクションです このファンクションは デフォルトの代替設定から新しい設定に変更するため またはデフォルトの代替設定に戻すために使用します 新しい代替設定を選択したときは 以前のエンドポイント特性が無効になるため リロードが必要になります 入力パラメータ interface 選択対象の代替設定が入っているインタフェースコンテナへのポインタ 返却値 Example UX_SUCCESS (0x00) このインタフェースの代替設定が正 常に選択されました UX_INTERFACE_HANDLE_UNKNOWN (0x52) インタフェースが存在しません UINT status; /* Select a new alternate setting for this interface.*/ status = ux_host_stack_interface_setting_select(interface); /* If status equals UX_SUCCESS, the operation was successful.*/

61 ux_host_stack_transfer_request_abort 保留中の転送要求をアボート プロトタイプ UINT ux_host_stack_transfer_request_abort(ux_transfer REQUEST *transfer request) 説明 パラメータ 以前に提出されて保留中の転送要求をアボートするファンクションです 特定の転送要求のみが取り消されます このファンクションのコールバックには UX_TRANSFER REQUEST_STATUS_ABORT ステータスが含まれます transfer request アボート対象の転送要求へのポインタ 返却値 例 UX_SUCCESS (0x00) この転送要求に対する USB 転送が取り消されまし た UINT status; /* The following example illustrates this service.*/ status = ux_host_stack_transfer_request_abort(transfer request); /* If status equals UX_SUCCESS, the operation was successful.*/

62 ux_host_stack_transfer_request USB 転送を要求 プロトタイプ UINT ux_host_stack_transfer_request(ux_transfer REQUEST *transfer request) 説明 USB トランザクションを実行するファンクションです 転送要求の入力時に このトランザクション用に選択されたエンドポイントパイプと 転送に関連するパラメータ ( データペイロード トランザクション長 ) が指定されます 制御パイプでは トランザクションはブロッキングになります 制御転送の 3 つのフェーズが完了したとき または以前のエラーがある場合に限り トランザクションが返ります その他のパイプでは USB スタックが USB 上でのトランザクションをスケジュールしますが そのトランザクションの完了を待つことはありません 非ブロッキングパイプでの転送要求では 各々に完了ルーチンハンドラを指定しなければなりません ファンクションコールが返るときに 転送要求のステータスにトランザクションの結果が含まれているため このステータスを調べることが望まれます 入力パラメータ transfer_request 転送要求へのポインタ 転送要求には 転送に必要なすべての情報が含まれます 返却値 例 UX_SUCCESS (0x00) この転送要求に対する USB 転送が正しくスケジュールされました 転送要求が完了するときに 転送要求のステータスコードを調べることが望まれます UX_MEMORY_INSUFFICIENT (0x12) 必要なコントローラリソースを割り当てる ためのメモリが不足しています UINT status; /* Create a transfer request for the SET_CONFIGURATION request. No data for this request.*/ transfer_request -> ux_transfer_endpoint_handle = control_endpoint; transfer_request -> ux_transfer_requested_length = 0; transfer_request -> ux_transfer_request_function = UX_SET_CONFIGURATION;

63 transfer_request -> ux_transfer_request_type = UX_REQUEST_OUT UX_REQUEST_TYPE_STANDARD UX_REQUEST_TARGET_DEVICE; transfer_request -> ux_transfer_request_value = (USHORT) configuration -> ux_configuration_descriptor.bconfigurationvalue; transfer_request -> ux_transfer_request_index = 0; /* Send request to HCD layer.*/ status = ux_host_stack_transfer_request(transfer_request); /* If status equals UX_SUCCESS, the operation was successful.*/