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

Artigo
08/07/2023

A função de retorno de chamada de evento EvtSerCx2CustomReceiveTransactionInitialize é chamada pela versão 2 da extensão da estrutura serial (SerCx2) para preparar o hardware do controlador serial para executar uma nova transação de recebimento personalizado.

Sintaxe

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE EvtSercx2CustomReceiveTransactionInitialize;

void EvtSercx2CustomReceiveTransactionInitialize(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

Parâmetros

[in] CustomReceiveTransaction

Um identificador SERCX2CUSTOMRECEIVETRANSACTION para um objeto custom-receive-transaction. O driver do controlador serial anteriormente chamou o método SerCx2CustomReceiveTransactionCreate para criar esse objeto.

[in] Mdl

Um ponteiro para um MDL que descreve as páginas de memória que são estendidas pelo buffer de leitura para a transação de recebimento personalizado. A lista de dispersão/coleta para a transferência de DMA usará a região dessa memória especificada pelos parâmetros Offset e Length .

[in] Offset

O deslocamento inicial para a transferência de dados. Esse parâmetro é um deslocamento de bytes do início da região do buffer descrita pelo MDL. Se o MDL especificar um total de N bytes de espaço em buffer, os valores possíveis de Offset estarão no intervalo de 0 a N–1.

[in] Length

O tamanho, em bytes, da transferência de dados. Se o MDL especificar um total de N bytes de espaço em buffer, os valores possíveis de Length estarão no intervalo de 1 a N–Offset.

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 SerCx2CustomReceiveTransactionCreate que cria o objeto de recebimento personalizado.

Seu driver deve implementar uma função EvtSerCx2CustomReceiveTransactionInitialize se precisar inicializar o controlador serial e o hardware associado na preparação para uma nova transação de recebimento personalizado. O SerCx2 chama essa função, se ela for implementada, antes de iniciar a transação de recebimento personalizado. Em resposta a essa chamada, o driver do controlador serial deve chamar o método SerCx2CustomReceiveTransactionInitializeComplete para notificar o SerCx2 após a conclusão da inicialização.

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

Exemplos

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

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE  MyCustomReceiveTransactionInitialize;

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

_Use_decl_annotations_
VOID
  MyCustomReceiveTransactionInitialize(
    SERCX2CUSTOMRECEIVETRANSACTION  CustomReceiveTransaction,
    WDFREQUEST  Request,
    PMDL  Mdl,
    ULONG  Offset,
    ULONG  Length
    )
  {...}

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