Função SerCx2CustomReceiveCreate (sercx.h)

Artigo
10/30/2024

O método SerCx2CustomReceiveCreate cria um objeto de recebimento personalizado, que a versão 2 da extensão da estrutura serial (SerCx2) usa para ler os dados recebidos do controlador serial por meio de um mecanismo de transferência de dados personalizado.

Sintaxe

NTSTATUS SerCx2CustomReceiveCreate(
  [in]  WDFDEVICE                     Device,
  [in]  PSERCX2_CUSTOM_RECEIVE_CONFIG CustomReceiveConfig,
  [in]  PWDF_OBJECT_ATTRIBUTES        Attributes,
  [out] SERCX2CUSTOMRECEIVE           *CustomReceive
);

Parâmetros

[in] Device

Um identificador WDFDEVICE para o objeto de dispositivo da estrutura que representa o controlador serial. O driver do controlador serial criou esse objeto em sua função de retorno de chamada EvtDriverDeviceAdd. Para obter mais informações, consulte SerCx2InitializeDevice.

[in] CustomReceiveConfig

Um ponteiro para uma estrutura SERCX2_CUSTOM_RECEIVE_CONFIG. Antes de chamar esse método, o chamador deve chamar a função SERCX2_CUSTOM_RECEIVE_CONFIG_INIT para inicializar a estrutura. Essa estrutura contém ponteiros para um conjunto de rotinas de retorno de chamada de evento que são implementadas pelo driver do controlador serial. O SerCx2 chama essas funções para executar transações de recebimento personalizado.

[in] Attributes

Um ponteiro para uma estrutura de WDF_OBJECT_ATTRIBUTES que descreve os atributos a serem atribuídos ao novo objeto de recebimento personalizado. Antes de chamar esse método, o chamador deve chamar a função WDF_OBJECT_ATTRIBUTES_INIT para inicializar a estrutura. Esse parâmetro é opcional e pode ser especificado como WDF_NO_OBJECT_ATTRIBUTES se o driver do controlador serial não precisar atribuir atributos ao objeto. Para obter mais informações, consulte Comentários.

[out] CustomReceive

Um ponteiro para um local no qual esse método grava um identificador de SERCX2CUSTOMRECEIVE no objeto de recebimento personalizado recém-criado. O SerCx2 e o driver do controlador serial usam esse identificador em chamadas subsequentes para fazer referência a esse objeto.

Valor de retorno

Esse método retornará STATUS_SUCCESS se a chamada for bem-sucedida. Os valores de retorno de erro possíveis incluem os seguintes códigos de status.

Código de retorno	Descrição
STATUS_INVALID_DEVICE_REQUEST	Já existe um objeto de recebimento personalizado de uma chamada SerCx2CustomReceiveCreate anterior; ou existe um objeto system-DMA-receive de uma chamada serCx2CustomReceiveCreate anterior; ou existe um objeto system-DMA-transmit de uma chamada serCx2CustomTransmitCreate anterior; ou SerCx2PioReceiveCreate ainda não foi chamado para criar um objeto de recebimento de PIO.
STATUS_INVALID_PARAMETER	Um valor de parâmetro não é válido.
STATUS_INFO_LENGTH_MISMATCH	O valor tamanho dede configuração não é igual tamanhos de(SERCX2_CUSTOM_RECEIVE_CONFIG).
STATUS_INSUFFICIENT_RESOURCES	Recursos insuficientes estão disponíveis para criar o objeto de recebimento personalizado.

Observações

Esse método é chamado pelo driver do controlador serial para criar um objeto de recebimento personalizado. O SerCx2 usa esse objeto para fazer transações de recebimento personalizado, que são transações que usam um mecanismo de transferência de dados personalizado para ler os dados recebidos pelo controlador serial.

Um driver de controlador serial deve chamar com êxito os métodos SerCx2InitializeDevice e SerCx2PioReceiveCreate antes de chamar SerCx2CustomReceiveCreate.

Antes de chamar SerCx2CustomReceiveCreate, o driver do controlador serial deve chamar a função SERCX2_CUSTOM_RECEIVE_CONFIG_INIT para inicializar a estrutura de SERCX2_CUSTOM_RECEIVE_CONFIG apontada por CustomReceiveConfig. Essa função define os seguintes membros da estrutura como zero:

de Alinhamento
MinimumTransactionLength
MaximumTransactionLength
MinimumTransferUnit
Exclusivo

Se necessário, o driver do controlador serial pode definir qualquer um desses membros como valores não zero após o retorno da função de inicialização. No entanto, por conveniência, SerCx2CustomReceiveCreate usará os seguintes valores padrão se esses membros forem zero:

Se Alinhamento for zero, o SerCx2 definirá o valor de alinhamento de dados como um, o que significa que o buffer de leitura pode iniciar em um limite de bytes arbitrário na memória.
Se MinimumTransactionLength for zero, o SerCx2 definirá o comprimento mínimo da transação como um byte.
Se MaximumTransactionLength for zero, SerCx2 definirá o comprimento máximo da transação como ((ULONG)-1).
Se MinimumTransferUnit for zero, o SerCx2 definirá a unidade de transferência mínima como um byte.
Se Exclusiva for zero (FALSE), o modo exclusivo será desabilitado.

Se o driver de chamada definir Exclusivo para TRUE, os membros MinimumTransferUnit, Alignmente MinimumTransactionLength devem ser zero. Para obter mais informações, consulte SERCX2_CUSTOM_RECEIVE_CONFIG.

Como opção, um driver de controlador serial pode usar o parâmetro Attributes para criar um contexto para o objeto de recebimento personalizado e fornecer ponteiros para EvtCleanupCallback e funções EvtDestroyCallback que são chamadas para preparar o objeto para exclusão. Para obter mais informações, consulte WDF_OBJECT_ATTRIBUTES.

Se o parâmetro Attributes apontar para uma estrutura WDF_OBJECT_ATTRIBUTES, o chamador não deverá substituir os valores que a função de inicialização WDF_OBJECT_ATTRIBUTES_INIT grava no ParentObject, ExecutionLevele SynchronizationScope membros dessa estrutura.

Para obter mais informações sobre como criar objetos de recebimento personalizado, consulte SERCX2CUSTOMRECEIVE. Para obter mais informações sobre transações de recebimento personalizado, consulte transações de Custom-Receive SerCx2.