SerCx2SystemDmaTransmitCreate 関数 (sercx.h)
SerCx2SystemDmaTransmitCreate メソッドは、SerCx2 システム DMA 送信オブジェクトを作成します。このオブジェクトは、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 がシステム DMA 送信トランザクションの実行に使用します。
構文
NTSTATUS SerCx2SystemDmaTransmitCreate(
[in] WDFDEVICE Device,
[in] PSERCX2_SYSTEM_DMA_TRANSMIT_CONFIG SystemDmaTransmitConfig,
[in, optional] PWDF_OBJECT_ATTRIBUTES Attributes,
[out] SERCX2SYSTEMDMATRANSMIT *SystemDmaTransmit
);
パラメーター
[in] Device
シリアル コントローラーを表すフレームワーク デバイス オブジェクトへの WDFDEVICE ハンドル。 シリアル コントローラー ドライバーは、EvtDriverDeviceAdd コールバック関数でこのオブジェクトを作成しました。 詳細については、「SerCx2InitializeDevice」を参照してください。
[in] SystemDmaTransmitConfig
SERCX2_SYSTEM_DMA_TRANSMIT_CONFIG 構造体へのポインター。 このメソッドを呼び出す前に、呼び出し元は SERCX2_SYSTEM_DMA_TRANSMIT_CONFIG_INIT 関数を呼び出して構造体を初期化する必要があります。 この構造体には、シリアル コントローラー ドライバーによって実装されるイベント コールバック ルーチンのセットへのポインターが含まれています。 SerCx2 はこれらの関数を呼び出して、システム DMA 送信トランザクションを実行します。
[in, optional] Attributes
新しい system-DMA-transmit オブジェクトに割り当てる属性を記述する WDF_OBJECT_ATTRIBUTES 構造体へのポインター。 このメソッドを呼び出す前に、呼び出し元は WDF_OBJECT_ATTRIBUTES_INIT 関数を呼び出して構造体を初期化する必要があります。 このパラメーターは省略可能であり、シリアル コントローラー ドライバーがオブジェクトに属性を割り当てる必要がない場合は、WDF_NO_OBJECT_ATTRIBUTESとして指定できます。 詳細については、「解説」を参照してください。
[out] SystemDmaTransmit
このメソッドが新しく作成した system-DMA-transmit オブジェクトに SERCX2SYSTEMDMATRANSMIT ハンドルを書き込む場所へのポインター。 SerCx2 とシリアル コントローラー ドライバーは、このオブジェクトを参照する後続の呼び出しでこのハンドルを使用します。
戻り値
このメソッドは、呼び出しが成功した場合にSTATUS_SUCCESSを返します。 考えられるエラー戻り値には、次の状態コードが含まれます。
リターン コード | 形容 |
---|---|
|
システム DMA 送信オブジェクトは、前の |
|
|
|
パラメーター値が無効です。 |
|
システム DMA 送信オブジェクトを作成するために使用できるリソースが不足しています。 |
備考
シリアル コントローラー ドライバーでは、このメソッドを使用して、システム DMA 送信オブジェクトを作成できます。 SerCx2 は、このオブジェクトを使用してシステム DMA 送信トランザクションを実行します。これは、システム DMA コントローラーを使用して、送信するシリアル コントローラーにデータを書き込むトランザクションです。
通常、シリアル コントローラー ドライバーは、
シリアル コントローラー ドライバーは、SerCx2SystemDmaTransmitCreateを呼び出す前に、SerCx2InitializeDevice
SerCx2SystemDmaTransmitCreate
- MaximumScatterGatherFragments の
- MinimumTransferUnitOverride の
- DmaAlignment
- MinimumTransactionLength
- 排他
- MaximumScatterGatherFragments
が 0 の場合、SerCx2 は散布図/収集リスト内の要素の最大数を ((ULONG)-1) に設定します。 - MinimumTransferUnitOverride
が 0 の場合、SerCx2 は最小転送単位を既定値に設定します。これは、システム DMA コントローラーの DMA_ADAPTER 構造体で指定されます。 この構造体の詳細については、「WdfDmaEnablerWdmGetDmaAdapterを参照してください。 -
DmaAlignment が 0 の場合、SerCx2 はアラインメント値を最小転送単位に設定します。 MinimumTransferUnitOverride
が 0 の場合、既定の最小転送単位が使用されます。 - MinimumTransactionLength
が 0 の場合、SerCx2 は最小トランザクション長を 1 バイトに設定します。 - 排他
ゼロ (FALSE ) の場合、排他モードは無効になります。
実装されたコールバック関数の指定された組み合わせが無効な場合、SerCx2SystemDmaTransmitCreate
オプションとして、シリアル コントローラー ドライバーは、
属性 パラメーターが WDF_OBJECT_ATTRIBUTES 構造体を指している場合、呼び出し元は、WDF_OBJECT_ATTRIBUTES_INIT 初期化関数が ParentObject、ExecutionLevel、およびこの構造体の SynchronizationScope メンバーに書き込む値を上書きしてはなりません。
システム DMA 送信オブジェクトの作成の詳細については、SERCX2SYSTEMDMATRANSMITを参照してください。 システム DMA 送信トランザクションの詳細については、「SerCx2 System-DMA-Transmit Transactions」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 8.1以降で使用できます。 |
ターゲット プラットフォーム の |
万国 |
ヘッダー | sercx.h |
IRQL | PASSIVE_LEVEL |
関連項目
EvtCleanupCallback を
EvtDestroyCallback の
EvtDevicePrepareHardware の
EvtDriverDeviceAdd の
EvtSerCx2SystemDmaTransmitCancelDrainFifo の
EvtSerCx2SystemDmaTransmitCleanupTransaction の
EvtSerCx2SystemDmaTransmitDrainFifo の
EvtSerCx2SystemDmaTransmitInitializeTransaction の
EvtSerCx2SystemDmaTransmitPurgeFifo の
SERCX2_SYSTEM_DMA_TRANSMIT_CONFIG
SERCX2_SYSTEM_DMA_TRANSMIT_CONFIG_INIT
SerCx2InitializeDevice の
SerCx2PioTransmitCreate を