EVT_SERCX2_CONTROL回呼函式 (sercx.h)
EvtSerCx2Control 事件回呼函式是由序列架構延伸模組第 2 版呼叫,以處理序列 I/O 控件要求。
語法
EVT_SERCX2_CONTROL EvtSercx2Control;
NTSTATUS EvtSercx2Control(
[in] WDFDEVICE Device,
[in] WDFREQUEST Request,
[in] size_t OutputBufferLength,
[in] size_t InputBufferLength,
[in] ULONG IoControlCode
)
{...}
參數
[in] Device
代表序列控制器之架構裝置物件的WDFDEVICE句柄。 序列控制器驅動程式會在其 EvtDriverDeviceAdd 回呼函式中建立這個物件。 如需詳細資訊,請參閱 SerCx2InitializeDevice。
[in] Request
代表序列 I/O 控制件要求的架構要求物件的 WDFREQUEST 句柄。
[in] OutputBufferLength
Request 參數所指定之序列 I/O 控件要求的輸出緩衝區長度,以位元組為單位。
[in] InputBufferLength
Request 參數所指定之序列 I/O 控件要求的輸入緩衝區長度,以位元組為單位。
[in] IoControlCode
從 Request 參數所指定的序列 I/O 控件要求指定 I/O 控制項程式碼 (IOCTL)。 序列 I/O 控制件要求的 IOCTLs 定義於 Ntddser.h 頭檔中。 如需詳細資訊,請參閱。
傳回值
如果呼叫成功,EvtSerCx2Control 函式會傳回STATUS_SUCCESS。 否則,它會傳回適當的錯誤狀態代碼。
言論
您的序列控制器驅動程序必須實作此函式。 驅動程式會在呼叫 SerCx2InitializeDevice 方法中註冊函式,以完成序列控制器的架構裝置物件初始化。
EvtSerCx2Control 函式可讓您的驅動程式處理 SerCx2 無法處理的特定序列 I/O 控制件要求。 SerCx2 會處理 Ntddser.h 頭檔中所定義之序列 IOCTL 子集的所有處理。 不過,SerCx2 依賴驅動程式來處理序列 I/O 控制要求,以執行硬體相依作業。
當 SerCx2 收到只能由序列控制器驅動程式處理的序列 I/O 控件要求時,SerCx2 會呼叫 EvtSerCx2Control 函式,將 I/O 控件要求交給驅動程式。 驅動程式負責完成此要求。 未實作特定 I/O 控制件要求的驅動程式,應該使用STATUS_NOT_SUPPORTED錯誤狀態代碼來完成此 I/O 控制件要求。
為了完成 I/O 控制要求,驅動程式通常會呼叫 WdfRequestComplete 方法並提供輸入參數、要求 參數值和狀態值,以指出要求是否成功。 這個狀態值會寫入要求的狀態區塊。
EvtSerCx2Control 函式的傳回值應該一律符合此函式寫入 I/O 控件要求狀態區塊的狀態值。 SerCx2 的目前實作會忽略這個傳回值。
SerCx2 會呼叫 EvtSerCx2Control 函式來處理下表所示的 IOCTL。 數據表右側的數據行會指出是否需要 EvtSerCx2Control 函式,才能實作特定 IOCTL 的支援。
上表列出SerCx2向 EvtSerCx2Control 函式呈現的所有序列IOCTL。 對於不在這份清單中的任何 IOCTL,SerCx2 會處理 IOCTL,或立即失敗 IOCTL,並將要求狀態設定為STATUS_NOT_SUPPORTED。 SerCx2 會處理 IOCTL_SERIAL_APPLY_DEFAULT_CONFIGURATION 要求,但在處理這類要求時呼叫 EvtSerCx2ApplyConfig 事件回呼函式。 SerCx2 會處理 IOCTL_SERIAL_PURGE 要求,但在處理這類要求時,可能會呼叫 EvtSerCx2PurgeFifos 事件回呼函式。 SerCx 會初步處理 IOCTL_SERIAL_SET_WAIT_MASK 要求,但呼叫 EvtSerCx2SetWaitMask 事件回呼函式,如果實作,則完成處理這類要求。 如需序列 IOCTL 之 SerCx2 支援的詳細資訊,請參閱 序列 I/O 要求介面。
IOCTL_SERIAL_CLR_DTR和IOCTL_SERIAL_SET_DTR
如果序列控制器驅動程式中的 EvtSerCx2Control 函式支援 IOCTL_SERIAL_SET_DTR 要求,則此函式也應該支援 IOCTL_SERIAL_CLR_DTR 要求,反之亦然。 如果您的驅動程式不支援這兩個要求,則 IOCTL_SERIAL_GET_DTRRTS 要求的驅動程式處理程式應將此要求的輸出值中的SERIAL_DTR_STATE旗標位設定為零。
IOCTL_SERIAL_GET_DTRRTS
序列控制器驅動程式中的 EvtSerCx2Control 函式必須支援 IOCTL_SERIAL_GET_DTRRTS 要求,但此要求的驅動程式處理程式只需要支援此要求的輸出值中的SERIAL_RTS_STATE旗標位。 作為選項,驅動程式可以另外支援SERIAL_DTR_STATE旗標位。 如果不支援SERIAL_DTR_STATE旗標位,請將此位設定為零。
IOCTL_SERIAL_GET_COMMSTATUS
序列控制器驅動程式中的 EvtSerCx2Control 函式必須支援 IOCTL_SERIAL_GET_COMMSTATUS 要求,但此要求的驅動程式處理程式只需要支援此要求所使用的下列 SERIAL_STATUS 結構成員:
- 錯誤
- HoldReasons
IOCTL_SERIAL_GET_PROPERTIES
序列控制器驅動程式中的 EvtSerCerCx2Control 函式必須支援 IOCTL_SERIAL_GET_PROPERTIES 要求。 此要求的驅動程式處理程式應該將這個要求所使用的 SERIAL_COMMPROP 結構 MaxBaud 成員設定為支援的傳輸速率上限,以每秒位數表示(bps)。 例如,如果序列控制器支援最大傳輸速率為 115,200 bps,則驅動程式會將 MaxBaud = 115200。
IOCTL_SERIAL_GET_MODEMSTATUS
序列控制器驅動程式中的 EvtSerCerCx2Control 函式必須支援 IOCTL_SERIAL_GET_MODEMSTATUS 要求。 此要求的驅動程式處理程式應將要求的輸出值設定為從序列控制器硬體讀取的原始數據機狀態緩存器值。
IOCTL_SERIAL_GET_HANDFLOW和IOCTL_SERIAL_SET_HANDFLOW
序列控制器驅動程式中的 EvtSerCerCx2Control 函式必須支援 IOCTL_SERIAL_GET_HANDFLOW 和 IOCTL_SERIAL_SET_HANDFLOW 要求,但只需要支持針對這些要求定義的旗標位子集。 旗標位會針對這些要求所使用的 SERIAL_HANDFLOWControlHandShake 和 FlowReplace 成員定義。
您的驅動程式必須支援 ControlHandshake 成員中的下列旗標位:
- SERIAL_CTS_HANDSHAKE
您的驅動程式必須支援 FlowReplace 成員中的下列旗標位:
- SERIAL_RTS_CONTROL
- SERIAL_RTS_HANDSHAKE
ControlHandShake 或 FlowReplace 成員中不支援特定旗標位的驅動程式,應該在 IOCTL_SERIAL_GET_HANDFLOW 要求的輸出值中將此旗標位設定為零。 如果 IOCTL_SERIAL_SET_HANDFLOW 要求指定驅動程式不支援的 ControlHandshake 或 FlowReplace 旗標位,EvtSerCx2Control 函式應該會失敗要求並傳回STATUS_INVALID_PARAMETER。
作為選項,驅動程式可以支援 XonLimit,以及 XoffLimitSERIAL_HANDFLOW 結構的成員。 不過,這些成員很少,如有需要,而且Microsoft建議不支持它們。 不支援 XonLimit 和 XoffLimit 成員的驅動程式,應該將這些成員設定為 IOCTL_SERIAL_GET_HANDFLOW 要求的輸出值中的零。 如果 IOCTL_SERIAL_SET_HANDFLOW 要求指定非零 XonLimit 或 XoffLimit 成員,且驅動程式不支援這些成員,EvtSerCx2Control 函式應該會失敗要求並傳回STATUS_NOT_IMPLEMENTED。
例子
若要定義 EvtSerCx2Control 回呼函式,您必須先提供函式宣告,以識別您要定義的回呼函式類型。 Windows 提供一組驅動程式的回呼函式類型。 使用回呼函式類型宣告函式有助於 驅動程式的程式代碼分析、靜態驅動程式驗證器 (SDV)和其他驗證工具尋找錯誤,而且是撰寫 Windows 操作系統驅動程式的需求。
例如,若要定義名為 的 MyControl
回呼函式,請使用 EVT_SERCX2_CONTROL 函式類型,如下列程式代碼範例所示:
EVT_SERCX2_CONTROL MyControl;
然後,實作回呼函式,如下所示:
_Use_decl_annotations_
NTSTATUS
MyControl(
WDFDEVICE Device,
WDFREQUEST Request,
size_t OutputBufferLength,
size_t InputBufferLength,
ULONG IoControlCode
)
{...}
EVT_SERCX2_CONTROL 函式類型定義於 Sercx.h 頭檔中。 若要在執行程式代碼分析工具時更準確地識別錯誤,請務必將 Use_decl_annotations 批註新增至函式定義。 Use_decl_annotations 批注可確保在頭檔中套用至 EVT_SERCX2_CONTROL 函式類型的批注。 如需函式宣告需求的詳細資訊,請參閱 使用 KMDF 驅動程式的函式角色類型來宣告函式。 如需 Use_decl_annotations的詳細資訊,請參閱 批注函式行為。
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | 從 Windows 8.1 開始提供。 |
目標平臺 | 桌面 |
標頭 | sercx.h |
IRQL | 在 IRQL <= DISPATCH_LEVEL 呼叫。 |