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

Artigo
08/07/2023

A função de retorno de chamada de evento EvtSerCx2PioReceiveEnableReadyNotification é chamada pela versão 2 da extensão da estrutura serial (SerCx2) para permitir que o driver do controlador serial notifique o SerCx2 quando o controlador serial receber novos dados.

Sintaxe

EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION EvtSercx2PioReceiveEnableReadyNotification;

void EvtSercx2PioReceiveEnableReadyNotification(
  [in] SERCX2PIORECEIVE PioReceive
)
{...}

Parâmetros

[in] PioReceive

Um identificador SERCX2PIORECEIVE para um objeto de recebimento de PIO. O driver do controlador serial anteriormente chamou o método SerCx2PioReceiveCreate para criar esse objeto.

Retornar valor

Nenhum

Comentários

O driver do controlador serial deve implementar essa função. O driver registra a função na chamada SerCx2PioReceiveCreate que cria o objeto pio-receive.

Depois que a função EvtSerCx2PioReceiveEnableReadyNotification for chamada para habilitar uma notificação pronta para uma transação de recebimento de PIO, o driver do controlador serial deverá chamar o método SerCx2PioReceiveReady para notificar o SerCx2 quando o driver detectar que um ou mais bytes de dados estão disponíveis para serem lidos do FIFO de recebimento no hardware do controlador serial. Se os dados já estiverem disponíveis no FIFO de recebimento quando a notificação pronta estiver habilitada, o driver chamará imediatamente esse método para notificar o SerCx2.

A notificação pronta para uma transação de recebimento de PIO é uma notificação única. Depois de enviar uma notificação pronta para SerCx2, o driver do controlador serial não envia mais notificações até que o SerCx2 chame a função EvtSerCx2PioReceiveEnableReadyNotification para habilitar outra notificação.

Uma chamada de função de retorno de chamada de evento EvtSerCx2PioReceiveReadBuffer só pode concluir parcialmente uma transação de recebimento de PIO porque não há mais dados disponíveis imediatamente para serem lidos do FIFO de recebimento. Nesse caso, SerCx2 chama a função EvtSerCx2PioReceiveEnableReadyNotification para habilitar uma notificação pronta. Nesse caso, o driver do controlador serial deve notificar o SerCx2 quando o FIFO de recebimento contiver mais dados. Em resposta a essa notificação, o SerCx2 retoma a transação de recebimento parcialmente concluída chamando a função EvtSerCx2PioReceiveReadBuffer novamente.

Normalmente, uma função EvtSerCx2PioReceiveEnableReadyNotification permite uma interrupção que ocorre quando o controlador serial tem mais dados disponíveis para leitura. Em resposta a essa interrupção, o driver do controlador serial chama SerCx2PioReceiveReady.

Não mais do que uma notificação pronta pode estar pendente por vez. Depois que o SerCx2 chama a função EvtSerCx2PioReceiveEnableReadyNotification para habilitar uma notificação pronta, o SerCx2 não chama essa função novamente até que o driver do controlador chame SerCx2PioReceiveReady.

O SerCx2 nunca chama a função EvtSerCx2PioReceiveReadBuffer quando a notificação pronta está habilitada.

Uma notificação pronta pendente poderá ser cancelada se a solicitação de leitura associada atingir o tempo limite ou for cancelada. Para cancelar uma notificação pronta para uma transação de recebimento de PIO, o SerCx2 chama a função de retorno de chamada de evento EvtSerCx2PioReceiveCancelReadyNotification .

O SerCx2 usa notificações prontas para gerenciar com eficiência tempos limite de intervalo que ocorrem durante o tratamento de solicitações de leitura processadas como transações de recebimento de PIO.

Para obter mais informações, consulte SerCx2 PIO-Receive Transactions.

Exemplos

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

EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION  MyPioReceiveEnableReadyNotification;

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

_Use_decl_annotations_
VOID
  MyPioReceiveEnableReadyNotification(
    SERCX2PIORECEIVE  PioReceive
    )
  {...}

O tipo de função EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION é 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_RECEIVE_ENABLE_READY_NOTIFICATION 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.