ucxendpoint.h ヘッダー

[アーティクル]
08/07/2023

このヘッダーは usbref によって使用されます。詳細については、次を参照してください。

ユニバーサルシリアルバス (USB)

ucxendpoint.h には、次のプログラミングインターフェイスが含まれています。

関数


UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS_INIT クライアントドライバーのコールバック関数を使用してUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS構造体を初期化します。クライアントドライバーは、UcxEndpointCreate メソッドを呼び出す前にこの関数を呼び出してエンドポイントを作成し、そのコールバック関数を UCX に登録します。
UCX_ENDPOINT_EVENT_CALLBACKS_INIT クライアントドライバーのコールバック関数を使用して、UCX_ENDPOINT_EVENT_CALLBACKS構造体を初期化します。クライアントドライバーは、UcxEndpointCreate メソッドを呼び出す前にこの関数を呼び出してエンドポイントを作成し、そのコールバック関数を UCX に登録します。
UcxDefaultEndpointInitSetEventCallbacks 既定のエンドポイントに関連するクライアントドライバーのイベントコールバック関数を使用して、UCXENDPOINT_INIT構造体を初期化します。
UcxEndpointAbortComplete 指定したエンドポイントオブジェクトで転送中止操作が完了したことを UCX に通知します。
UcxEndpointCreate 指定した USB デバイスオブジェクトにエンドポイントを作成します。
UcxEndpointGetStaticStreamsReferenced 指定したエンドポイントの参照先の静的ストリームオブジェクトを返します。
UcxEndpointInitSetEventCallbacks デバイス上のエンドポイントに関連するクライアントドライバーのイベントコールバック関数を使用して、UCXENDPOINT_INIT構造体を初期化します。
UcxEndpointNeedToCancelTransfers クライアントドライバーは、ネットワーク上の転送をキャンセルする前に、このメソッドを呼び出します。
UcxEndpointNoPingResponseError 指定したエンドポイントオブジェクトでの転送に関する "Ping 応答なし" エラーについて UCX に通知します。
UcxEndpointPurgeComplete 指定したエンドポイントオブジェクトで消去操作が完了したことを UCX に通知します。
UcxEndpointSetWdfIoQueue 指定したエンドポイントオブジェクトにフレームワークキューを設定します。

コールバック関数


EVT_UCX_DEFAULT_ENDPOINT_UPDATE UCX が既定のエンドポイントに関する情報を使用して呼び出すクライアントドライバーの実装。
EVT_UCX_ENDPOINT_ABORT UCX がエンドポイントに関連付けられているキューを中止するために呼び出すクライアントドライバーの実装。
EVT_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS UCX は、このコールバック関数を呼び出して、等時性エンドポイントの転送パスの遅延に関する情報を取得します。
EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS UCX が呼び出すクライアントドライバーの実装は、エンドポイントで取り消された転送を完了できることをコントローラードライバーに通知します。
EVT_UCX_ENDPOINT_PURGE エンドポイントで未処理のすべての I/O 要求を完了するクライアントドライバーの実装。
EVT_UCX_ENDPOINT_RESET UCX がエンドポイントのコントローラーのプログラミングをリセットするために呼び出すクライアントドライバーの実装。
EVT_UCX_ENDPOINT_SET_CHARACTERISTIC UCX はこのコールバック関数を呼び出して、エンドポイントの優先度を設定します。
EVT_UCX_ENDPOINT_START UCX がエンドポイントに関連付けられているキューを開始するために呼び出すクライアントドライバーの実装。
EVT_UCX_ENDPOINT_STATIC_STREAMS_ADD UCX が静的ストリームを作成するために呼び出すクライアントドライバーの実装。
EVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE UCX が呼び出すクライアントドライバーの実装は、エンドポイントのすべてのストリームのコントローラーリソースを解放します。
EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE UCX が静的ストリームを有効にするために呼び出すクライアントドライバーの実装。

構造


DEFAULT_ENDPOINT_UPDATE コールバック関数を呼び出すときに UCX によって渡されるフレームワーク要求で更新する既定のエンドポイントへのハンドルEVT_UCX_DEFAULT_ENDPOINT_UPDATE格納されます。
ENDPOINT_RESET エンドポイントをリセットするために必要な情報について説明します。この構造体は、EVT_UCX_ENDPOINT_RESET コールバック関数で UCX によって渡されます。
ENDPOINTS_CONFIGURE エンドポイントを有効または無効にするエンドポイントについて説明します。この構造体は、EVT_UCX_USBDEVICE_ENDPOINTS_CONFIGURE コールバック関数で UCX によって渡されます。
ENDPOINTS_CONFIGURE_FAILURE_FLAGS この構造体は、EVT_UCX_USBDEVICE_ENDPOINTS_CONFIGUREコールバック関数への要求中に発生した可能性があるエラーを示すエラーフラグを提供します。
UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS この構造体は、UCX の既定のエンドポイントイベントコールバック関数の一覧を提供します。
UCX_ENDPOINT_CHARACTERISTIC エンドポイントの特性を格納します。
UCX_ENDPOINT_EVENT_CALLBACKS この構造体は、UCX エンドポイントイベントコールバック関数へのポインターの一覧を提供します。
UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS 等時性転送パス遅延値を格納します。

列挙


ENDPOINT_RESET_FLAGS エンドポイントをリセットする要求のパラメーターを定義します。
UCX_CONTROLLER_ENDPOINT_CHARACTERISTIC_PRIORITY エンドポイントの優先度を示します。
UCX_ENDPOINT_CHARACTERISTIC_TYPE エンドポイント特性の種類を示す値を定義します。