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

Artigo
08/07/2023

A função de retorno de chamada de evento EvtSerCx2SystemDmaTransmitPurgeFifo é chamada pela versão 2 da extensão da estrutura serial (SerCx2) para descartar todos os bytes de dados não existentes que permanecem no FIFO de transmissão no hardware do controlador serial.

Sintaxe

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO EvtSercx2SystemDmaTransmitPurgeFifo;

void EvtSercx2SystemDmaTransmitPurgeFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit,
  [in] ULONG BytesAlreadyTransmittedToHardware
)
{...}

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.

[in] BytesAlreadyTransmittedToHardware

O número de bytes que já foram carregados no FIFO de transmissão durante a transação atual system-DMA-transmit.

Retornar valor

Nenhum

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 EvtSerCx2SystemDmaTransmitPurgeFifo 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 EvtSerCx2SystemDmaTransmitCancelDrainFifo .

Se uma solicitação de gravação (IRP_MJ_WRITE) pendente atingir o tempo limite ou for cancelada, o SerCx2 poderá precisar encerrar a transação atual de DMA do sistema antes de ser concluída. Depois que a transação for encerrada, SerCx2 chamará a função EvtSerCx2SystemDmaTransmitPurgeFifo , se ela for implementada.

A função EvtSerCx2SystemDmaTransmitPurgeFifo interrompe a transferência de dados do buffer de gravação para o FIFO de transmissão e descarta todos os dados transferidos anteriormente que permanecem no FIFO. Depois que a transação de transmissão for encerrada, o driver deverá chamar o método SerCx2SystemDmaTransmitPurgeFifoComplete para notificar o SerCx2 de que o FIFO foi limpo e SerCx2 concluirá a solicitação de gravação.

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

Exemplos

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO  MySystemDmaTransmitPurgeFifo;

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

_Use_decl_annotations_
VOID
  MySystemDmaTransmitPurgeFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit,
    ULONG BytesAlreadyTransmittedToHardware
    )
  {...}

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