Funzione WdfIoTargetSendIoctlSynchronously (wdfiotarget.h)

Articolo
02/29/2024

[Si applica a KMDF e UMDF]

Il metodo WdfIoTargetSendIoctlSynchronously compila una richiesta di controllo del dispositivo e la invia in modo sincrono a una destinazione di I/O.

Sintassi

NTSTATUS WdfIoTargetSendIoctlSynchronously(
  [in]            WDFIOTARGET               IoTarget,
  [in, optional]  WDFREQUEST                Request,
  [in]            ULONG                     IoctlCode,
  [in, optional]  PWDF_MEMORY_DESCRIPTOR    InputBuffer,
  [in, optional]  PWDF_MEMORY_DESCRIPTOR    OutputBuffer,
  [in, optional]  PWDF_REQUEST_SEND_OPTIONS RequestOptions,
  [out, optional] PULONG_PTR                BytesReturned
);

Parametri

[in] IoTarget

Handle a un oggetto di destinazione I/O locale o remoto ottenuto da una chiamata precedente a WdfDeviceGetIoTarget o WdfIoTargetCreate o da un metodo fornito da una destinazione I/O specializzata.

[in, optional] Request

Handle per un oggetto richiesta framework. Questo parametro è facoltativo e può essere NULL. Per ulteriori informazioni, vedere la sezione Osservazioni successiva.

[in] IoctlCode

Codice di controllo I/O (IOCTL) supportato dalla destinazione I/O.

[in, optional] InputBuffer

Puntatore a una struttura WDF_MEMORY_DESCRIPTOR allocata dal chiamante che descrive un buffer che verrà scritto nella destinazione di I/O. Per ulteriori informazioni, vedere la sezione Osservazioni successiva. Questo parametro è facoltativo e può essere NULL se la richiesta non invia dati.

[in, optional] OutputBuffer

Puntatore a una struttura di WDF_MEMORY_DESCRIPTOR allocata dal chiamante che descrive un buffer che riceverà i dati dalla destinazione di I/O. Per ulteriori informazioni, vedere la sezione Osservazioni successiva. Questo parametro è facoltativo e può essere NULL se la richiesta non riceve dati.

[in, optional] RequestOptions

Puntatore a una struttura WDF_REQUEST_SEND_OPTIONS allocata dal chiamante che specifica le opzioni per la richiesta. Questo puntatore è facoltativo e può essere NULL. Per ulteriori informazioni, vedere la sezione Osservazioni successiva.

[out, optional] BytesReturned

Puntatore a una posizione che riceve informazioni(ad esempio il numero di byte trasferiti) che un altro driver fornisce quando completa la richiesta chiamando WdfRequestCompleteWithInformation. Questo puntatore è facoltativo e può essere NULL.

Valore restituito

Se l'operazione ha esito positivo, WdfIoTargetSendIoctlSynchronously restituisce dopo il completamento della richiesta di controllo del dispositivo e il valore restituito è il valore di stato di completamento della richiesta. In caso contrario, questo metodo potrebbe restituire uno dei valori seguenti:

Codice restituito	Descrizione
STATUS_INVALID_PARAMETER	È stato rilevato un parametro non valido.
STATUS_INFO_LENGTH_MISMATCH	Dimensioni della struttura WDF_REQUEST_SEND_OPTIONS a cui il parametro RequestOptions puntava non è corretto.
STATUS_INVALID_DEVICE_REQUEST	La richiesta è già stata accodata a una destinazione di I/O.
STATUS_INSUFFICIENT_RESOURCES	Il framework non può allocare le risorse di sistema (in genere memoria).
STATUS_REQUEST_NOT_ACCEPTED	Il pacchetto di richiesta I/O (IRP) che il parametro Request rappresenta non fornisce strutture IO_STACK_LOCATION sufficienti per consentire al driver di inoltrare la richiesta.

Questo metodo potrebbe restituire anche altri valori NTSTATUS.

Un controllo di bug si verifica se il driver fornisce un handle di oggetti non valido.

Commenti

Usare il metodo WdfIoTargetSendIoctlSynchronously per inviare richieste di controllo dispositivo in modo sincrono. Per inviare richieste di controllo del dispositivo in modo asincrono, usare il metodo WdfIoTargetFormatRequestForIoctl , seguito dal metodo WdfRequestSend .

Per altre informazioni sulle richieste di controllo del dispositivo, vedere Uso dei codici di controllo I/O.

Il metodo WdfIoTargetSendIoctlSynchronously non restituisce finché la richiesta non viene completata, a meno che il driver non fornisca un valore di timeout nella struttura WDF_REQUEST_SEND_OPTIONS del parametro RequestOptions o a meno che non venga rilevato un errore.

È possibile inoltrare una richiesta di controllo del dispositivo ricevuta dal driver in una coda di I/O oppure creare e inviare una nuova richiesta. In entrambi i casi, il framework richiede un oggetto request e uno spazio buffer.

Per inoltrare una richiesta di controllo del dispositivo ricevuta dal driver in una coda di I/O:

Specificare l'handle della richiesta ricevuta per il parametro Request del metodo WdfIoTargetSendIoctlSynchronously.
Usare il buffer di input della richiesta ricevuta per il parametro InputBuffer del metodo WdfIoTargetSendIoctlSynchronously.
Il driver deve chiamare WdfRequestRetrieveInputMemory per ottenere un handle a un oggetto di memoria del framework che rappresenta il buffer di input della richiesta. Il driver deve quindi posizionare tale handle nella struttura WDF_MEMORY_DESCRIPTOR fornita dal driver per il parametro InputBuffer di WdfIoTargetSendIoctlSynchronously.
Usare il buffer di output della richiesta ricevuta per il parametro OutputBuffer del metodo WdfIoTargetSendIoctlSynchronously.
Il driver deve chiamare WdfRequestRetrieveOutputMemory per ottenere un handle a un oggetto memoria del framework che rappresenta il buffer di output della richiesta. Il driver deve quindi posizionare tale handle nella struttura WDF_MEMORY_DESCRIPTOR fornita dal driver per il parametro OutputBuffer di WdfIoTargetSendIoctlSynchronously.

Per altre informazioni sull'inoltro di una richiesta di I/O, vedere Inoltro di richieste di I/O.

I driver spesso dividono le richieste di I/O ricevute in richieste più piccole inviate a una destinazione di I/O, in modo che il driver possa creare nuove richieste.

Per creare una nuova richiesta di I/O:

Specificare un handle di richiesta NULL per il parametro Request del metodo WdfIoTargetSendIoctlSynchronously, oppure creare un nuovo oggetto request e fornire il relativo handle:
- Se si specifica un handle di richiesta NULL , il framework usa un oggetto request interno. Questa tecnica è semplice da usare, ma il driver non può annullare la richiesta.
- Se si chiama WdfRequestCreate per creare uno o più oggetti richiesta, è possibile riutilizzare questi oggetti richiesta chiamando WdfRequestReuse. Questa tecnica consente all'evtDriverDevice del driverAggiungi la funzione di callback per preallocare gli oggetti di richiesta per un dispositivo. Inoltre, un altro thread driver può chiamare WdfRequestCancelSentRequest per annullare la richiesta, se necessario.
Il driver può specificare un parametroRequestOptions diverso da NULL, indipendentemente dal fatto che il driver fornisca un parametro non NULL o null Request. È possibile, ad esempio, usare il parametro RequestOptions per specificare un valore di timeout.
Fornire spazio buffer per i parametri InputBuffer e OutputBuffer del metodo WdfIoTargetSendIoctlSynchronously, se la richiesta richiede.
Il driver può specificare questo spazio buffer come buffer allocato in locale, come handle WDFMEMORY o come descrittore di memoria (MDLs). È possibile usare il metodo più pratico.

Se necessario, il framework converte le descrizioni del buffer in modo che siano corrette per il tipo di trasferimento di IOCTL. Per altre informazioni sui tipi di trasferimento IOCTL, vedere Definizione dei codici di controllo I/O.

Sono disponibili le tecniche seguenti per specificare lo spazio del buffer:
- Fornire buffer locali.
  Poiché WdfIoTargetSendIoctlSynchronously gestisce le richieste di I/O in modo sincrono, il driver può creare buffer di richiesta locali per la routine chiamante, come illustrato nell'esempio di codice seguente.
```
WDF_MEMORY_DESCRIPTOR  MemoryDescriptor;
MY_BUFFER_TYPE  MyBuffer;
WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(&MemoryDescriptor,
                                  (PVOID) &MyBuffer,
                                  sizeof(MyBuffer));
```
- Specificare handle WDFMEMORY.
  Chiamare WdfMemoryCreate o WdfMemoryCreatePreallocated per ottenere un handle per la memoria gestita dal framework, come illustrato nell'esempio di codice seguente.
```
WDF_MEMORY_DESCRIPTOR  MemoryDescriptor;
WDFMEMORY  MemoryHandle = NULL;
status = WdfMemoryCreate(NULL,
                         NonPagedPool,
                         POOL_TAG,
                         MY_BUFFER_SIZE,
                         &MemoryHandle,
                         NULL);
WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(&MemoryDescriptor,
                                  MemoryHandle,
                                  NULL);
```
  In alternativa, il driver può chiamare WdfRequestRetrieveInputMemory o WdfRequestRetrieveOutputMemory per ottenere un handle a un oggetto memoria del framework che rappresenta il buffer della richiesta di I/O ricevuto, se si vuole che il driver passi il contenuto del buffer alla destinazione I/O. Il driver non deve completare la richiesta di I/O ricevuta fino alla nuova richiesta che WdfIoTargetSendIoctlSynchronously invia alla destinazione di I/O è stata eliminata, riutilizzata o riformattata. (WdfIoTargetSendIoctlSynchronously incrementa il numero di riferimenti dell'oggetto memoria. Eliminazione, riutilizzo o riformattamento di un oggetto request decrementa il numero di riferimenti dell'oggetto memoria.
- Specificare GLI MDL.
  I driver possono ottenere mdls associati a una richiesta di I/O ricevuta chiamando WdfRequestRetrieveInputWdmMdl e WdfRequestRetrieveOutputWdmMdl.

Per informazioni sull'acquisizione di informazioni sullo stato dopo il completamento di una richiesta di I/O, vedere Recupero delle informazioni di completamento.

Per altre informazioni su WdfIoTargetSendIoctlSynchronously, vedere Invio di richieste di I/O a destinazioni di I/O generali.

Per altre informazioni sulle destinazioni di I/O, vedere Uso delle destinazioni di I/O.

Esempio

L'esempio di codice seguente definisce un buffer locale, inizializza una struttura WDF_MEMORY_DESCRIPTOR e chiama WdfIoTargetSendIoctlSynchronously. In questo esempio viene specificato NULL per l'handle dell'oggetto richiesta, pertanto il framework creerà un nuovo oggetto request per la destinazione di I/O.

WDF_MEMORY_DESCRIPTOR  outputDescriptor;
NTSTATUS  status;
HID_COLLECTION_INFORMATION  collectionInformation;

WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(
                                  &outputDescriptor,
                                  (PVOID) &collectionInformation,
                                  sizeof(HID_COLLECTION_INFORMATION)
                                  );

status = WdfIoTargetSendIoctlSynchronously(
                                           hidTarget,
                                           NULL,
                                           IOCTL_HID_GET_COLLECTION_INFORMATION,
                                           NULL,
                                           &outputDescriptor,
                                           NULL,
                                           NULL
                                           );

Requisiti

Requisito	Valore
Piattaforma di destinazione	Universale
Versione KMDF minima	1.0
Versione UMDF minima	2,0
Intestazione	wdfiotarget.h (include Wdf.h)
Libreria	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
Regole di conformità DDI	DeferredRequestCompleted(kmdf), DriverCreate(kmdf), InternalIoctlReqs(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), ReadReqs(kmdf), RequestCompleted(kmdf), RequestCompletedLocal(kmdf), SyncReqSend(kmdf), WriteReqs(kmdf)