EVT_SERCX2_APPLY_CONFIG回呼函式 （sercx.h）

EvtSerCx2ApplyConfig 事件回呼函式是由序列架構延伸模組第 2 版 （SerCx2） 所呼叫，以提供序列控制器驅動程式的裝置特定組態設定清單，以套用至序列控制器硬體。

語法

EVT_SERCX2_APPLY_CONFIG EvtSercx2ApplyConfig;

NTSTATUS EvtSercx2ApplyConfig(
  [in] WDFDEVICE Device,
  [in] PVOID ConnectionParameters
)
{...}

參數

[in] Device

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

[in] ConnectionParameters

連接參數結構的指標。 此函式必須將指標轉換成適當的指標類型、剖析數據結構以取得組態設定，並將這些設定套用至序列控制器硬體。 聯機參數結構是由硬體平臺廠商所定義，而且對SerCx2和操作系統不透明。 如需詳細資訊，請參閱。

傳回值

EvtSerCx2ApplyConfig 函式會在呼叫成功時傳回STATUS_SUCCESS。 否則，它會傳回適當的錯誤狀態代碼。

言論

您的序列控制器驅動程序必須實作此函式。 驅動程式會在呼叫 SerCx2InitializeDevice 方法中註冊函式，以完成序列控制器的架構裝置物件初始化。

SerCx2 會在串行控制器初始化期間呼叫 EvtSerCx2ApplyConfig 函式，以確保硬體處於有效的初始狀態。 此外，每當用戶端將 IOCTL_SERIAL_APPLY_DEFAULT_CONFIGURATION 要求傳送至序列控制器時，就會呼叫此函式。

SerCx2 會從序列控制器裝置的 ACPI 資源描述元中，從廠商定義的數據欄位取得組態參數。 ACPI 韌體用來儲存這些組態設定的數據格式應該與序列控制器驅動程式預期的數據格式相同。 如需詳細資訊，請參閱 ACPI 5.0 規格中的 UART 序列總線連線描述 元的描述。

當用戶端將 IOCTL_SERIAL_APPLY_DEFAULT_CONFIGURATION 要求傳送至由 SerCx2 管理的序列埠時，SerCx2 會呼叫 EvtSerCx2ApplyConfig 函式，將組態參數傳遞至序列控制器驅動程式。 在此回呼傳回之後，SerCx2 會完成要求，並使用回呼的傳回值作為要求的狀態代碼。

例子

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

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

EVT_SERCX2_APPLY_CONFIG  MyApplyConfig;

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

_Use_decl_annotations_
NTSTATUS
  MyApplyConfig(
    WDFDEVICE  Device,
    PVOID  ConnectionParameters
    )
  {...}

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

下列程式代碼範例示範 UART EvtSerCx2ApplyConfig 函式的部分實作：

//
// Define the UART ACPI descriptor, plus any vendor-specific
// data that is needed by the serial controller (UART) driver.
//

#define ANYSIZE_ARRAY 1
#include <pshpack1.h>

//
// Common resource name descriptor
//
typedef struct _PNP_IO_DESCRIPTOR_RESOURCE_NAME {
    UCHAR ResourceIndex;
    UCHAR ResourceName[ANYSIZE_ARRAY];
} PNP_IO_DESCRIPTOR_RESOURCE_NAME, *PPNP_IO_DESCRIPTOR_RESOURCE_NAME;

//
// Bus descriptor for a UART
//
typedef struct _PNP_UART_SERIAL_BUS_DESCRIPTOR {
    PNP_SERIAL_BUS_DESCRIPTOR SerialBusDescriptor;
    ULONG BaudRate;
    USHORT RxBufferSize;
    USHORT TxBufferSize;
    UCHAR Parity;
    // Include any optional vendor data here:
    ...
    // Append the PNP_IO_DESCRIPTOR_RESOURCE_NAME here:
    ....
} PNP_UART_SERIAL_BUS_DESCRIPTOR, *PPNP_UART_SERIAL_BUS_DESCRIPTOR;

#include <poppack.h>

EVT_SERCX_APPLY_CONFIG MyApplyConfig;

//
// Implementation of an EvtSerCx2ApplyConfig callback function
//
_Use_decl_annotations_
VOID
  MyApplyConfig(
    WDFDEVICE Device,
    PVOID ConnectionParameters
    )
{
    NTSTATUS status = STATUS_SUCCESS; 
    PRH_QUERY_CONNECTION_PROPERTIES_OUTPUT_BUFFER connection;
    PPNP_SERIAL_BUS_DESCRIPTOR descriptor;
    PPNP_UART_SERIAL_BUS_DESCRIPTOR uartDescriptor;

    if (ConnectionParameters == NULL)
    {
        status = STATUS_INVALID_PARAMETER; 
    }

    if (NT_SUCCESS(status))
    {
        connection = (PRH_QUERY_CONNECTION_PROPERTIES_OUTPUT_BUFFER)ConnectionParameters;

        if (connection->PropertiesLength < sizeof(PNP_SERIAL_BUS_DESCRIPTOR))
        {
            status = STATUS_INVALID_PARAMETER;
        }
    }

    if (NT_SUCCESS(status))
    {
        descriptor = (PPNP_SERIAL_BUS_DESCRIPTOR)connection->ConnectionProperties;

        if (descriptor->SerialBusType != UART_SERIAL_BUS_TYPE)
        {
            status = STATUS_INVALID_PARAMETER;
        }
    }

    if (NT_SUCCESS(status))
    {
        uartDescriptor = (PPNP_UART_SERIAL_BUS_DESCRIPTOR)connection->ConnectionProperties; 

        // Apply the platform-specific configuration settings
        // from the UART descriptor here:
        ...
    }

    return status;
}

上述程式代碼範例中的 pshpack1.h 和 poppack.h 頭檔會控制編譯程式所使用的結構對齊模式。 PRH_QUERY_CONNECTION_PROPERTIES_OUTPUT_BUFFER和PPNP_SERIAL_BUS_DESCRIPTOR指標類型是 RH_QUERY_CONNECTION_PROPERTIES_OUTPUT_BUFFER 和 PNP_SERIAL_BUS_DESCRIPTOR 結構的指標。 如需 PNP_UART_SERIAL_BUS_DESCRIPTOR 結構成員的詳細資訊，請參閱 ACPI 5.0 規格中的表格 6-193。

要求

另請參閱

IOCTL_SERIAL_APPLY_DEFAULT_CONFIGURATION

PNP_SERIAL_BUS_DESCRIPTOR

RH_QUERY_CONNECTION_PROPERTIES_OUTPUT_BUFFER

SerCx2InitializeDevice