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

A função de retorno de chamada de evento EvtSerCx2SetWaitMask é chamada pela versão 2 da extensão da estrutura serial (SerCx2) para configurar o controlador serial para monitorar um conjunto de eventos de hardware especificados por uma máscara de espera.

Sintaxe

EVT_SERCX2_SET_WAIT_MASK EvtSercx2SetWaitMask;

void EvtSercx2SetWaitMask(
  [in] WDFDEVICE Device,
  [in] WDFREQUEST Request,
  [in] ULONG WaitMask
)
{...}

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] Request

Um identificador WDFREQUEST para o objeto de solicitação da estrutura que representa a solicitação IOCTL_SERIAL_SET_WAIT_MASK.

[in] WaitMask

A nova máscara de espera. Para obter mais informações, consulte Comentários.

Valor de retorno

Nenhum

Observações

O driver do controlador serial pode, como opção, implementar essa função. Se implementado, o driver registrará a função na chamada para o método SerCx2InitializeDevice que conclui a inicialização do objeto de dispositivo da estrutura para o controlador serial.

Quando o SerCx recebe uma solicitação IOCTL_SERIAL_SET_WAIT_MASK de um cliente, o manipulador de solicitações no SerCx2 chama a função EvtSerCx2SetWaitMask, se ela for implementada, para notificar o driver de que a máscara de espera foi alterada. Se a máscara de espera não for zero, o driver começará imediatamente a monitorar os eventos na nova máscara de espera e descartará qualquer máscara de espera antiga que possa ter sido fornecida em uma chamada EvtSerCx2SetWaitMask anterior. Se a nova máscara de espera for zero, o driver simplesmente descartará a máscara de espera antiga e deixará de monitorar os eventos de máscara de espera. Para obter mais informações sobre os tipos de eventos que podem ser especificados por uma máscara de espera, consulte SERIAL_EV_XXX.

Se o driver não implementar essa função, o SerCx2 falhará em todas as solicitações IOCTL_SERIAL_SET_WAIT_MASK com o código de status de erro STATUS_NOT_SUPPORTED.

Para monitorar os eventos na máscara de espera, a função EvtSerCx2SetWaitMask normalmente permite interrupções para esses eventos. Posteriormente, quando um evento na máscara de espera é detectado, o driver do controlador serial chama o método SerCx2CompleteWait para notificar o SerCx2 do evento.

A função EvtSerCx2SetWaitMask é responsável por concluir a solicitação de IOCTL_SERIAL_SET_WAIT_MASK apontada pelo parâmetro de Solicitação . Depois que o driver do controlador serial habilitar as interrupções necessárias, ele chama o método WdfRequestComplete e fornece, como parâmetros de entrada, o valor do parâmetro Request e um valor de status para indicar se a solicitação foi bem-sucedida.

Antes que o driver do controlador serial chame WdfRequestComplete para concluir a solicitação, o driver deve concluir todas as chamadas para SerCx2CompleteWait que ainda podem estar pendentes devido a eventos na máscara de espera antiga.

Inicialmente, depois que um cliente abre uma conexão lógica com a porta serial e antes da primeira chamada EvtSerCx2SetWaitMask, a máscara de espera é efetivamente zero e o driver do controlador serial não está monitorando nenhum SERIAL_EV_XXX eventos.

O SerCx2 falha em uma solicitação de IOCTL_SERIAL_SET_WAIT_MASK que tem uma máscara de espera que inclui qualquer um dos seguintes sinalizadores de evento SERIAL_EV_XXX:

• SERIAL_EV_PERR
• SERIAL_EV_RING
• SERIAL_EV_RXFLAG

Se implementada, sua função EvtSerCx2SetWaitMask deverá dar suporte aos seguintes sinalizadores de evento:

• SERIAL_EV_CTS
• SERIAL_EV_BREAK
• SERIAL_EV_ERR

EVT_SERCX2_SET_WAIT_MASK  MySetWaitmask;

_Use_decl_annotations_
VOID
  MySetWaitmask(
    WDFDEVICE  Device,
    WDFREQUEST Request,
    ULONG WaitMask
    )
  {...}