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

Artigo
02/26/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 system-DMA-transmit. O driver do controlador serial anteriormente chamou o método SerCx2SystemDmaTransmitCreate para criar esse objeto.

Retornar valor

A função EvtSerCx2SystemDmaTransmitCancelDrainFifo 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 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á chamou ou está prestes a chamar SerCx2SystemDmaTransmitDrainFifoComplete.

Comentários

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

Seu 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 as funções de retorno de chamada de evento EvtSerCx2SystemDmaTransmitDrainFifo e EvtSerCx2SystemDmaTransmitPurgeFifo .

Depois que SerCx2 chamar a função de retorno de chamada de evento EvtSerCx2SystemDmaTransmitDrainFifo para solicitar que o driver do controlador serial escorra o FIFO de transmissão, SerCx2 pode chamar a função EvtSerCx2SystemDmaTransmitCancelDrainFifo para cancelar a solicitação de drenagem pendente antes que o FIFO termine de esvaziar. Por exemplo, SerCx2 poderá 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 SerCx2 System-DMA-Transmit Transactions.

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

Por exemplo, para definir uma função de retorno de chamada EvtSerCx2SystemDmaTransmitCancelDrainFifo chamada 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 a 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 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.