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

Artigo
08/07/2023

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

Sintaxe

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO EvtSercx2SystemDmaTransmitDrainFifo;

void EvtSercx2SystemDmaTransmitDrainFifo(
  [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

Nenhum

Comentários

O driver do controlador serial pode, como uma opção, implementar essa função. Se o driver implementar essa função, ele também deverá implementar as funções de retorno de chamada de evento EvtSerCx2SystemDmaTransmitCancelDrainFifo e EvtSerCx2SystemDmaTransmitPurgeFifo . Um driver que implementa essas funções registra-as na chamada SerCx2SystemDmaTransmitCreate que cria o objeto system-DMA-transmit.

O SerCx2 chama a função EvtSerCx2SystemDmaTransmitDrainFifo , se implementada, para drenar o FIFO de transmissão no hardware do controlador serial no final de uma transação system-DMA-transmit. Essa função garante que todos os bytes de dados que permanecem no FIFO sejam transmitidos para o dispositivo periférico conectado serialmente. Depois que o último byte é transmitido do FIFO, a função EvtSerCx2SystemDmaTransmitDrainFifo chama o método SerCx2SystemDmaTransmitDrainFifoComplete para notificar o SerCx2.

Se o driver do controlador serial implementar uma função EvtSerCx2SystemDmaTransmitDrainFifo , o SerCx2 não concluirá uma solicitação de gravação pendente (IRP_MJ_WRITE) até que o driver chame SerCx2SystemDmaTransmitDrainFifoComplete.

Se o controlador serial tiver um FIFO de hardware (ou mecanismo de buffer semelhante) para armazenar dados de transmissão, o driver deverá implementar uma função EvtSerCx2SystemDmaTransmitDrainFifo . Caso contrário, o SerCx2 não poderá confirmar se o FIFO de transmissão foi esvaziado antes que a solicitação de gravação pendente seja concluída. Em vez disso, o SerCx2 conclui essa solicitação depois que o último byte no buffer de gravação é gravado no FIFO de transmissão. Não pode haver nenhuma garantia de que os dados gravados no FIFO de transmissão serão transmitidos sem um atraso significativo. Todos os dados que permanecerem no FIFO após a conclusão da solicitação de gravação poderão ser perdidos antes que possam ser transmitidos para o dispositivo periférico conectado em série. Essa perda inesperada de dados em uma solicitação de gravação concluída com êxito pode criar problemas de confiabilidade para o driver periférico.

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

Exemplos

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO  MySystemDmaTransmitDrainFifo;

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

_Use_decl_annotations_
VOID
  MySystemDmaTransmitDrainFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit
    )
  {...}

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