EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION função de retorno de chamada (sercx.h)

Artigo
08/07/2023

A função de retorno de chamada de evento EvtSerCx2PioReceiveCancelReadyNotification é chamada pela versão 2 da extensão de estrutura serial (SerCx2) para cancelar uma notificação pronta que o SerCx2 habilitou em uma chamada anterior para a função de retorno de chamada de evento EvtSerCx2PioReceiveEnableReadyNotification .

Sintaxe

EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION EvtSercx2PioReceiveCancelReadyNotification;

BOOLEAN EvtSercx2PioReceiveCancelReadyNotification(
  [in] SERCX2PIORECEIVE PioReceive
)
{...}

Parâmetros

[in] PioReceive

Um identificador SERCX2PIORECEIVE para um objeto de recebimento de PIO. O driver do controlador serial anteriormente chamou o método SerCx2PioReceiveCreate para criar esse objeto.

Retornar valor

A função EvtSerCx2PioReceiveCancelReadyNotification retornará TRUE se a notificação pronta tiver sido desabilitada com êxito e o driver do controlador serial puder garantir que essa notificação não fará com que o método SerCx2PioReceiveReady seja chamado. A função retornará FALSE se o driver já tiver chamado SerCx2PioReceiveReady ou estiver prestes a chamar esse método.

Comentários

O driver do controlador serial deve implementar essa função. O driver registra a função na chamada SerCx2PioReceiveCreate que cria o objeto pio-receive.

Se a solicitação de leitura associada atingir o tempo limite ou for cancelada enquanto uma notificação pronta estiver habilitada, o SerCx2 chamará a função EvtSerCx2PioReceiveCancelReadyNotification para cancelar a notificação pendente. Se essa chamada retornar FALSE, SerCx2 espera que o driver do controlador serial chame SerCx2PioReceiveReady; somente após essa chamada o SerCx2 chamar a função de retorno de chamada de evento EvtSerCx2PioReceiveCleanupTransaction , se ela for implementada e concluir a solicitação.

Para cancelar a notificação pronta, a função EvtSerCx2PioReceiveCancelReadyNotification normalmente desabilita a interrupção no controlador serial que indica que mais dados estão disponíveis para leitura do FIFO de recebimento. Essa interrupção foi habilitada por uma chamada anterior para a função EvtSerCx2PioReceiveEnableReadyNotification .

Para obter mais informações, consulte SerCx2 PIO-Receive Transactions.

Exemplos

Para definir uma função de retorno de chamada EvtSerCx2PioReceiveCancelReadyNotification , primeiro você deve fornecer uma declaração de função que identifique o tipo de função de retorno de chamada que você está definindo. O Windows fornece um conjunto de tipos de função de retorno de chamada para drivers. Declarar uma função usando os tipos de função de retorno de chamada ajuda a Análise de Código para Drivers, SDV ( Verificador de Driver Estático ) e outras ferramentas de verificação a encontrar erros e é um requisito para gravar drivers para o sistema operacional Windows.

Por exemplo, para definir uma função de retorno de chamada EvtSerCx2PioReceiveCancelReadyNotification chamada MyPioReceiveCancelReadyNotification, use o tipo de função EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION , conforme mostrado neste exemplo de código:

EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION  MyPioReceiveCancelReadyNotification;

Em seguida, implemente a função de retorno de chamada da seguinte maneira:

_Use_decl_annotations_
BOOLEAN
  MyPioReceiveCancelReadyNotification(
    SERCX2PIORECEIVE  PioReceive
    )
  {...}

O tipo de função EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION é definido no arquivo de cabeçalho Sercx.h. Para identificar erros com mais precisão ao executar as ferramentas de análise de código, adicione a anotação Use_decl_annotations à sua definição de função. A anotação Use_decl_annotations garante que as anotações aplicadas ao tipo de função EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION no arquivo de cabeçalho sejam usadas. Para obter mais informações sobre os requisitos para declarações de função, consulte Declarando funções usando tipos de função de função para drivers KMDF. Para obter mais informações sobre Use_decl_annotations, consulte Anotando o comportamento da função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Disponível a partir do Windows 8.1.
Plataforma de Destino	Área de Trabalho
Cabeçalho	sercx.h
IRQL	Chamado em IRQL <= DISPATCH_LEVEL.