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

Artigo
08/07/2023

A função de retorno de chamada de evento EvtSerCx2PioTransmitCancelDrainFifo é chamada pela versão 2 da extensão de estrutura serial (SerCx2) para cancelar uma solicitação anterior para esvaziar o FIFO de transmissão no hardware do controlador serial.

Sintaxe

EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2PioTransmitCancelDrainFifo;

BOOLEAN EvtSercx2PioTransmitCancelDrainFifo(
  [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 EvtSerCx2PioTransmitCancelDrainFifo retornará TRUE se cancelar com êxito a solicitação de esvaziamento pendente, e o driver do controlador serial poderá garantir que ele não chamará o método SerCx2PioTransmitDrainFifoComplete para notificar o SerCx2 de que o FIFO está drenado. Caso contrário, essa função retornará FALSE para indicar que o driver já chamou ou está prestes a chamar SerCx2PioTransmitDrainFifoComplete.

Comentários

O driver do controlador serial pode, como opção, implementar essa função. Se implementado, o driver registra a função na chamada SerCx2PioTransmitCreate que cria o objeto PIO-transmit.

Seu driver deve implementar uma função EvtSerCx2PioTransmitCancelDrainFifo se o controlador serial tiver um FIFO de hardware (ou mecanismo de buffer semelhante) para armazenar dados de transmissão. Se o driver implementar essa função, ele também deverá implementar as funções de retorno de chamada de evento EvtSerCx2PioTransmitDrainFifo e EvtSerCx2PioTransmitPurgeFifo .

O SerCx2 chama a função de retorno de chamada de evento EvtSerCx2PioTransmitDrainFifo para pedir ao driver do controlador serial para esvaziar o FIFO de transmissão e aguarda o driver do controlador serial chamar SerCx2PioTransmitDrainFifoComplete. Uma operação de esvaziamento pode levar um tempo indefinido para ser concluída. Portanto, se a solicitação de gravação atingir o tempo limite ou for cancelada enquanto a operação de esvaziamento estiver em andamento, o SerCx2 chamará a função EvtSerCx2PioTransmitCancelDrainFifo para cancelar a operação de esvaziamento pendente antes de ser concluída.

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

Exemplos

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

EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO  MyPioTransmitCancelDrainFifo;

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

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

O tipo de função EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO é 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_DRAIN_FIFO 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.