EVT_SERCX2_SET_WAIT_MASK回呼函式（sercx.h）

發行項
10/30/2024

EvtSerCx2SetWaitMask 事件回呼函式是由序列架構延伸模組（SerCx2）第 2 版呼叫，以設定序列控制器來監視等候遮罩所指定的一組硬體事件。

語法

EVT_SERCX2_SET_WAIT_MASK EvtSercx2SetWaitMask;

void EvtSercx2SetWaitMask(
  [in] WDFDEVICE Device,
  [in] WDFREQUEST Request,
  [in] ULONG WaitMask
)
{...}

參數

[in] Device

代表序列控制器之架構裝置物件的WDFDEVICE句柄。序列控制器驅動程式會在其 EvtDriverDeviceAdd 回呼函式中建立這個物件。如需詳細資訊，請參閱 SerCx2InitializeDevice。

[in] Request

代表 IOCTL_SERIAL_SET_WAIT_MASK 要求的架構要求物件的 WDFREQUEST 句柄。

[in] WaitMask

新的等候遮罩。如需詳細資訊，請參閱。

傳回值

沒有

言論

您的序列控制器驅動程式可以視需要實作此函式。如果已實作，驅動程式會在呼叫 SerCx2InitializeDevice 方法中註冊函式，以完成串行控制器的架構裝置物件初始化。

當 SerCx 從用戶端收到 IOCTL_SERIAL_SET_WAIT_MASK 要求時，SerCx2 中的要求處理程式會呼叫 EvtSerCx2SetWaitMask 函式，如果實作，則會通知驅動程式等候遮罩已變更。如果等候遮罩為非零值，驅動程式會立即開始監視新等候掩碼中的事件，並捨棄先前 EvtSerCx2SetWaitMask 呼叫中可能提供的任何舊等候遮罩。如果新的等候遮罩為零，驅動程式只會捨棄舊的等候遮罩，並停止監視任何等候遮罩事件。如需等候遮罩可指定之事件類型的詳細資訊，請參閱 SERIAL_EV_XXX。

如果驅動程式未實作此函式，SerCx2 會失敗所有 IOCTL_SERIAL_SET_WAIT_MASK 要求，並STATUS_NOT_SUPPORTED錯誤狀態代碼。

若要監視等候掩碼中的事件，EvtSerCx2SetWaitMask 函式通常會啟用這些事件的中斷。稍後，當偵測到等候遮罩中的事件時，序列控制器驅動程式會呼叫 SerCx2CompleteWait 方法來通知 SerCx2 事件。

EvtSerCx2SetWaitMask 函式負責完成 Request 參數所指向的 IOCTL_SERIAL_SET_WAIT_MASK 要求。在序列控制器驅動程式啟用必要的中斷之後，它會呼叫 WdfRequestComplete 方法並提供輸入參數、Request 參數值和狀態值，以指出要求是否成功。

在序列控制器驅動程式呼叫 WdfRequestComplete 以完成要求之前，驅動程式必須完成對 SerCx2CompleteWait 的任何呼叫， 因為舊等候掩碼中的事件而可能仍在擱置中。

一開始，在用戶端開啟序列埠的邏輯連線，並在第一個 EvtSerCx2SetWaitMask 呼叫之前，等候遮罩實際上為零，而且序列控制器驅動程式不會監視任何 SERIAL_EV_XXX 事件。

SerCx2 失敗 IOCTL_SERIAL_SET_WAIT_MASK 要求，該要求具有包含下列任何 SERIAL_EV_XXX 事件旗標的等候遮罩：

SERIAL_EV_PERR
SERIAL_EV_RING
SERIAL_EV_RXFLAG

因此，提供給您 EvtSerCx2SetWaitMask 函式的等候遮罩絕不會包含上述清單中的任何事件旗標。

如果已實作，您的 EvtSerCx2SetWaitMask 函式應該支援下列事件旗標：

SERIAL_EV_CTS
SERIAL_EV_BREAK
SERIAL_EV_ERR

此外，如果序列控制器有 數據集就緒 （DSR）訊號線，則 EvtSerCx2SetWaitMask 函式應該支援SERIAL_EV_DSR。作為選項，驅動程式可以支援 SERIAL_EV_XXX中所述的任何其他事件旗標。如果等候遮罩指定驅動程式不支援的事件，則 EvtSerCx2SetWaitMask 函式應該會失敗要求，並將要求中的狀態值設定為STATUS_INVALID_PARAMETER。

例子

若要定義 EvtSerCx2SetWaitMask 回呼函式，您必須先提供函式宣告，以識別您要定義的回呼函式類型。 Windows 提供一組驅動程式的回呼函式類型。使用回呼函式類型宣告函式有助於驅動程式的程式代碼分析、靜態驅動程式驗證器（SDV）和其他驗證工具尋找錯誤，而且是撰寫 Windows 操作系統驅動程式的需求。

例如，若要定義名為的 MySetWaitmask 回呼函式，請使用 EVT_SERCX2_SET_WAIT_MASK 函式類型，如下列程式代碼範例所示：

EVT_SERCX2_SET_WAIT_MASK  MySetWaitmask;

然後，實作回呼函式，如下所示：

_Use_decl_annotations_
VOID
  MySetWaitmask(
    WDFDEVICE  Device,
    WDFREQUEST Request,
    ULONG WaitMask
    )
  {...}

EVT_SERCX2_SET_WAIT_MASK 函式類型定義於 Sercx.h 頭檔中。若要在執行程式代碼分析工具時更準確地識別錯誤，請務必將 Use_decl_annotations 批註新增至函式定義。 Use_decl_annotations 批注可確保會使用套用至頭檔中 EVT_SERCX2_SET_WAIT_MASK 函式類型的批注。如需函式宣告需求的詳細資訊，請參閱使用 KMDF 驅動程式的函式角色類型來宣告函式。如需 Use_decl_annotations的詳細資訊，請參閱批注函式行為。