EVT_SERCX2_SYSTEM_DMA_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 EvtSerCx2SystemDmaTransmitCancelDrainFifo é 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_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2SystemDmaTransmitCancelDrainFifo;

BOOLEAN EvtSercx2SystemDmaTransmitCancelDrainFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit
)
{...}

Parâmetros

[in] SystemDmaTransmit

Um identificador SERCX2SYSTEMDMATRANSMIT para um objeto de transmissão de DMA do sistema. O driver do controlador serial anteriormente chamou o método SerCx2SystemDmaTransmitCreate para criar esse objeto.

Valor de retorno

A função EvtSerCx2SystemDmaTransmitCancelDrainFifo 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 SerCx2SystemDmaTransmitDrainFifoComplete 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 SerCx2SystemDmaTransmitDrainFifoComplete.

Observações

O driver do controlador serial pode, como opção, implementar essa função. Se implementado, o driver registrará a função no serCx2SystemDmaTransmitCreate chamada que cria o objeto system-DMA-transmit.

O driver deve implementar uma função EvtSerCx2SystemDmaTransmitCancelDrainFifo 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 EvtSerCx2SystemDmaTransmitDrainFifo e funções de retorno de chamada de evento EvtSerCx2SystemDmaTransmitPurgeFifo.

Depois que o SerCx2 chamar a função de retorno de chamada de evento EvtSerCx2SystemDmaTransmitDrainFi fo para solicitar que o driver do controlador serial escorra o FIFO de transmissão, o SerCx2 pode chamar o EvtSerCx2SystemDmaTransmitCancelDrainFifo para cancelar a solicitação de drenagem pendente antes que o FIFO conclua a drenagem. Por exemplo, SerCx2 pode chamar a função EvtSerCx2SystemDmaTransmitCancelDrainFifo se o cliente cancelar a solicitação de gravação pendente (IRP_MJ_WRITE) ou se a solicitação de gravação atingir o tempo limite.

Para obter mais informações, consulte de TransaçõesDMA-Transmit do Sistema SerCx2.

Exemplos

Para definir uma função de retorno de chamada EvtSerCx2SystemDmaTransmitCancelDrainFifo, 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 um EvtSerCx2SystemDmaTransmitCancelDrainFifo função de retorno de chamada denominada MySystemDmaTransmitCancelDrainFifo, use o tipo de função EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO, conforme mostrado neste exemplo de código:

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO  MySystemDmaTransmitCancelDrainFifo;

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

_Use_decl_annotations_
BOOLEAN
  MySystemDmaTransmitCancelDrainFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit
    )
  {...}

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