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

Artigo
08/07/2023

A função de retorno de chamada de evento EvtSerCx2PioTransmitCancelReadyNotification é chamada pela versão 2 da extensão da 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 EvtSerCx2PioTransmitEnableReadyNotification .

Sintaxe

EVT_SERCX2_PIO_TRANSMIT_CANCEL_READY_NOTIFICATION EvtSercx2PioTransmitCancelReadyNotification;

BOOLEAN EvtSercx2PioTransmitCancelReadyNotification(
  [in] SERCX2PIOTRANSMIT PioTransmit
)
{...}

Parâmetros

[in] PioTransmit

Um identificador de SERCX2PIOTRANSMIT para um objeto de transmissão de PIO. O driver do controlador serial anteriormente chamou o método SerCx2PioTransmitCreate para criar esse objeto.

Retornar valor

A função EvtSerCx2PioTransmitCancelReadyNotification 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 SerCx2PioTransmitReady seja chamado.

A função retornará FALSE se o driver já tiver chamado SerCx2PioTransmitReady 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 SerCx2PioTransmitCreate que cria o objeto PIO-transmit.

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

Para cancelar uma notificação pronta habilitada anteriormente, a função EvtSerCx2PioTransmitCancelReadyNotification normalmente desabilita a interrupção no controlador serial que indica que o FIFO de transmissão está pronto para aceitar mais dados. O SerCx2 habilitou essa interrupção em uma chamada anterior para a função EvtSerCx2PioTransmitEnableReadyNotification .

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

Exemplos

Para definir uma função de retorno de chamada EvtSerCx2PioTransmitCancelReadyNotification , 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 EvtSerCx2PioTransmitCancelReadyNotification chamada MyPioTransmitCancelReadyNotification, use o tipo de função EVT_SERCX2_PIO_TRANSMIT_CANCEL_READY_NOTIFICATION , conforme mostrado neste exemplo de código:

EVT_SERCX2_PIO_TRANSMIT_CANCEL_READY_NOTIFICATION  MyPioTransmitCancelReadyNotification;

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

_Use_decl_annotations_
BOOLEAN
  MyPioTransmitCancelReadyNotification(
    SERCX2PIOTRANSMIT  PioTransmit
    )
  {...}

O tipo de função EVT_SERCX2_PIO_TRANSMIT_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_TRANSMIT_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.