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

Artigo
10/30/2024

A função de retorno de chamada de evento EvtSerCx2PioTransmitPurgeFifo é chamada pela versão 2 da extensão da estrutura serial (SerCx2) para descartar quaisquer bytes de dados não armazenados que permanecem no FIFO de transmissão no controlador serial.

Sintaxe

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO EvtSercx2PioTransmitPurgeFifo;

void EvtSercx2PioTransmitPurgeFifo(
  [in] SERCX2PIOTRANSMIT PioTransmit,
  [in] ULONG BytesAlreadyTransmittedToHardware
)
{...}

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.

[in] BytesAlreadyTransmittedToHardware

O número de bytes que já foram carregados no FIFO de transmissão durante a transação de transmissão de PIO atual. Esse parâmetro é a soma de todos os bytes transferidos em chamadas anteriores para o EvtSerCx2PioTransmitWriteBuffer função de retorno de chamada de evento que fazem parte dessa transação.

Valor de retorno

Nenhum

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 EvtSerCx2PioTransmitPurgeFifo 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 EvtSerCx2PioTransmitCancelDrainFifo funções de retorno de chamada de evento.

O SerCx2 inicia uma transação de transmissão de PIO em resposta a uma solicitação de gravação (IRP_MJ_WRITE) de um cliente. Se essa solicitação atingir o tempo limite ou for cancelada antes de ser concluída, o SerCx2 chamará a função EvtSerCx2PioTransmitPurgeFifo, se ela for implementada, para limpar quaisquer dadosnãois que possam continuar sendo o FIFO de transmissão.

Depois que o FIFO de transmissão for limpo, a função EvtSerCx2PioTransmitPurgeFifo deve chamar o método SerCx2PioTransmitPurgeFifoComplete para notificar o SerCx2 de que o FIFO foi limpo e SerCx2, em seguida, conclui a solicitação de gravação.

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

Exemplos

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

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO  MyPioTransmitPurgeFifo;

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

_Use_decl_annotations_
VOID
  MyPioTransmitPurgeFifo(
    SERCX2PIOTRANSMIT  PioTransmit,
    ULONG  BytesAlreadyTransmittedToHardware

    )
  {...}

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