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

Artigo
10/30/2024

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

Valor de retorno

A função EvtSerCx2PioTransmitCancelDrainFifo retorna verdadeiro se cancelar com êxito a solicitação de dreno pendente, e o driver do controlador serial pode 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á ligou ou está prestes a chamar SerCx2PioTransmitDrainFifoComplete.

Observações

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 de transmissão de PIO.

O 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 o EvtSerCx2PioTransmitDrainFifo e EvtSerCx2PioTransmitPurgeFifo funções de retorno de chamada de evento.

O SerCx2 chama a função de retorno de chamada de evento EvtSerCx2PioTransmitDrainFifo para solicitar que o driver do controlador serial escorra o FIFO de transmissão e, em seguida, aguarda o driver do controlador serial chamar SerCx2PioTransmitDrainFifoComplete. Uma operação de drenagem 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 drenagem estiver em andamento, o SerCx2 chamará o EvtSerCx2PioTransmitCancelDrainFifo função para cancelar a operação de drenagem pendente antes de ser concluída.

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

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 encontram erros e é um requisito para gravar drivers para o sistema operacional Windows.

Por exemplo, para definir uma função de retorno de chamada EvtSerCx2PioTransmitCancelDrainFifo denominada 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 sua 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
de cliente com suporte mínimo	Disponível a partir do Windows 8.1.
da Plataforma de Destino	Área de trabalho
cabeçalho	sercx.h
IRQL	Chamado no <DO IRQL = DISPATCH_LEVEL.