WdfIoTargetSendIoctlSynchronously 함수(wdfiotarget.h)

[KMDF 및 UMDF에 적용]

WdfIoTargetSendIoctlSynchronously 메서드는 디바이스 제어 요청을 빌드하고 I/O 대상에 동기적으로 보냅니다.

구문

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
);

매개 변수

[in] IoTarget

WdfDeviceGetIoTarget 또는 WdfIoTargetCreate에 대한 이전 호출 또는 특수 I/O 대상에서 제공하는 메서드에서 가져온 로컬 또는 원격 I/O 대상 개체에 대한 핸들입니다.

[in, optional] Request

프레임워크 요청 개체에 대한 핸들입니다. 이 매개 변수는 선택 사항이며 NULL일 수 있습니다. 자세한 내용은 아래 설명 부분을 참조하십시오.

[in] IoctlCode

I/O 대상에서 지원하는 IOCTL(I/O 제어 코드)입니다.

[in, optional] InputBuffer

I/O 대상에 기록될 버퍼를 설명하는 호출자가 할당한 WDF_MEMORY_DESCRIPTOR 구조체에 대한 포인터입니다. 자세한 내용은 아래 설명 부분을 참조하십시오. 이 매개 변수는 선택 사항이며 요청이 데이터를 보내지 않는 경우 NULL 일 수 있습니다.

[in, optional] OutputBuffer

I/O 대상에서 데이터를 수신할 버퍼를 설명하는 호출자가 할당한 WDF_MEMORY_DESCRIPTOR 구조체에 대한 포인터입니다. 자세한 내용은 아래 설명 부분을 참조하십시오. 이 매개 변수는 선택 사항이며 요청이 데이터를 수신하지 않는 경우 NULL 일 수 있습니다.

[in, optional] RequestOptions

요청에 대한 옵션을 지정하는 호출자가 할당한 WDF_REQUEST_SEND_OPTIONS 구조체에 대한 포인터입니다. 이 포인터는 선택 사항이며 NULL일 수 있습니다. 자세한 내용은 아래 설명 부분을 참조하십시오.

[out, optional] BytesReturned

WdfRequestCompleteWithInformation을 호출하여 요청을 완료할 때 다른 드라이버가 제공하는 정보(예: 전송된 바이트 수)를 수신하는 위치에 대한 포인터입니다. 이 포인터는 선택 사항이며 NULL일 수 있습니다.

반환 값

작업이 성공하면 WdfIoTargetSendIoctlSynchronously 는 디바이스 제어 요청이 완료된 후 반환되며 반환 값은 요청의 완료 상태 값입니다. 그렇지 않으면 이 메서드는 다음 값 중 하나를 반환할 수 있습니다.

반환 코드 설명
STATUS_INVALID_PARAMETER
잘못된 매개 변수가 감지되었습니다.
STATUS_INFO_LENGTH_MISMATCH
RequestOptions 매개 변수가 가리키는 WDF_REQUEST_SEND_OPTIONS 구조체의 크기가 잘못되었습니다.
STATUS_INVALID_DEVICE_REQUEST
요청이 이미 I/O 대상에 큐에 대기되었습니다.
STATUS_INSUFFICIENT_RESOURCES
프레임워크는 시스템 리소스(일반적으로 메모리)를 할당할 수 없습니다.
STATUS_REQUEST_NOT_ACCEPTED
Request 매개 변수가 나타내는 IRP(I/O 요청 패킷)는 드라이버가 요청을 전달할 수 있는 충분한 IO_STACK_LOCATION 구조를 제공하지 않습니다.
 

이 메서드는 다른 NTSTATUS 값을 반환할 수도 있습니다.

드라이버에서 잘못된 개체 핸들을 제공하는 경우 버그 검사가 발생합니다.

설명

WdfIoTargetSendIoctlSynchronously 메서드를 사용하여 디바이스 제어 요청을 동기적으로 보냅니다. 디바이스 제어 요청을 비동기적으로 보내려면 WdfIoTargetFormatRequestForIoctl 메서드와 WdfRequestSend 메서드를 사용합니다.

디바이스 제어 요청에 대한 자세한 내용은 I/O 제어 코드 사용을 참조하세요.

드라이버가 RequestOptions 매개 변수의 WDF_REQUEST_SEND_OPTIONS 구조에 시간 제한 값을 제공하지 않거나 오류가 검색되지 않는 한 WdfIoTargetSendIoctlSynchronously 메서드는 요청이 완료될 때까지 반환되지 않습니다.

드라이버가 I/O 큐에서 받은 디바이스 제어 요청을 전달하거나 새 요청을 만들고 보낼 수 있습니다. 두 경우 모두 프레임워크에는 요청 개체와 일부 버퍼 공간이 필요합니다.

드라이버가 I/O 큐에서 받은 디바이스 제어 요청을 전달하려면 다음을 수행합니다.

  1. WdfIoTargetSendIoctlSynchronously 메서드의 Request 매개 변수에 대해 수신된 요청의 핸들을 지정합니다.
  2. 받은 요청의 입력 버퍼 를 WdfIoTargetSendIoctlSynchronously 메서드의 InputBuffer 매개 변수에 사용합니다.

    드라이버는 WdfRequestRetrieveInputMemory 를 호출하여 요청의 입력 버퍼를 나타내는 프레임워크 메모리 개체에 대한 핸들을 가져와야 합니다. 그런 다음 드라이버가 WdfIoTargetSendIoctlSynchronouslyInputBuffer 매개 변수에 대해 제공하는 WDF_MEMORY_DESCRIPTOR 구조에 해당 핸들을 배치해야 합니다.

  3. WdfIoTargetSendIoctlSynchronously 메서드의 OutputBuffer 매개 변수에 대해 수신된 요청의 출력 버퍼를 사용합니다.

    드라이버는 WdfRequestRetrieveOutputMemory 를 호출하여 요청의 출력 버퍼를 나타내는 프레임워크 메모리 개체에 대한 핸들을 가져와야 합니다. 그런 다음 드라이버가 WdfIoTargetSendIoctlSynchronouslyOutputBuffer 매개 변수에 대해 제공하는 WDF_MEMORY_DESCRIPTOR 구조에 해당 핸들을 배치해야 합니다.

I/O 요청을 전달하는 방법에 대한 자세한 내용은 I/O 요청 전달을 참조하세요.

드라이버는 수신된 I/O 요청을 I/O 대상으로 보내는 더 작은 요청으로 나누는 경우가 많으므로 드라이버는 새 요청을 만들 수 있습니다.

새 I/O 요청을 만들려면 다음을 수행합니다.

  1. WdfIoTargetSendIoctlSynchronously 메서드의 Request 매개 변수에 대한 NULL 요청 핸들을 제공하거나 새 요청 개체를 만들고 해당 핸들을 제공합니다.
    • NULL 요청 핸들을 제공하는 경우 프레임워크는 내부 요청 개체를 사용합니다. 이 기술은 사용하기는 간단하지만 드라이버는 요청을 취소할 수 없습니다.
    • WdfRequestCreate를 호출하여 하나 이상의 요청 개체를 만드는 경우 WdfRequestReuse를 호출하여 이러한 요청 개체를 다시 사용할 수 있습니다. 이 기술을 사용하면 드라이버의 EvtDriverDeviceAdd 콜백 함수가 디바이스에 대한 요청 개체를 미리 할당할 수 있습니다. 또한 필요한 경우 다른 드라이버 스레드 가 WdfRequestCancelSentRequest 를 호출하여 요청을 취소할 수 있습니다.

    드라이버가 NULL이 아닌 요청 매개 변수를 제공하는지 또는 NULL 요청 매개 변수를 제공하는지 여부에 관계없이 드라이버는 NULL이 아닌 RequestOptions 매개 변수를 지정할 수 있습니다. 예를 들어 RequestOptions 매개 변수를 사용하여 제한 시간 값을 지정할 수 있습니다.

  2. 요청에 필요한 경우 WdfIoTargetSendIoctlSynchronously 메서드의 InputBufferOutputBuffer 매개 변수에 대한 버퍼 공간을 제공합니다.

    드라이버는 이 버퍼 공간을 로컬로 할당된 버퍼, WDFMEMORY 핸들 또는 MDL(메모리 설명자 목록)으로 지정할 수 있습니다. 가장 편리한 방법을 사용할 수 있습니다.

    필요한 경우 프레임워크는 IOCTL의 전송 유형에 맞도록 버퍼 설명을 변환합니다. IOCTL 전송 형식에 대한 자세한 내용은 I/O 제어 코드 정의를 참조하세요.

    버퍼 공간을 지정하는 다음 기술을 사용할 수 있습니다.

    • 로컬 버퍼를 제공합니다.

      WdfIoTargetSendIoctlSynchronously I/O 요청을 동기적으로 처리하기 때문에 드라이버는 다음 코드 예제와 같이 호출 루틴에 로컬인 요청 버퍼를 만들 수 있습니다.

      WDF_MEMORY_DESCRIPTOR  MemoryDescriptor;
      MY_BUFFER_TYPE  MyBuffer;
      WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(&MemoryDescriptor,
                                        (PVOID) &MyBuffer,
                                        sizeof(MyBuffer));
      
    • WDFMEMORY 핸들을 제공합니다.

      다음 코드 예제와 같이 WdfMemoryCreate 또는 WdfMemoryCreatePreallocated 를 호출하여 프레임워크 관리 메모리에 대한 핸들을 가져옵니다.

      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);
      

      또는 드라이버가 해당 버퍼의 콘텐츠를 I/O 대상에 전달하도록 하려면 WdfRequestRetrieveInputMemory 또는 WdfRequestRetrieveOutputMemory 를 호출하여 수신된 I/O 요청의 버퍼를 나타내는 프레임워크 메모리 개체에 대한 핸들을 가져올 수 있습니다. WdfIoTargetSendIoctlSynchronously I/O 대상에 보내는 새 요청이 삭제, 재사용 또는 다시 포맷될 때까지 드라이버는 수신된 I/O 요청을 완료하지 않아야 합니다. (WdfIoTargetSendIoctlSynchronously 증가 메모리 개체의 참조 횟수입니다. 요청 개체를 삭제, 재사용 또는 다시 포맷하면 메모리 개체의 참조 수가 감소합니다.)

    • MDL을 제공합니다.

      드라이버는 WdfRequestRetrieveInputWdmdl 및 WdfRequestRetrieveOutputWdmdl 을 호출하여 수신된 I/O 요청과 연결된 MDL을 가져올 수 있습니다.

I/O 요청이 완료된 후 상태 정보를 가져오는 방법에 대한 자세한 내용은 완료 정보 가져오기를 참조하세요.

WdfIoTargetSendIoctlSynchronously에 대한 자세한 내용은 일반 I/O 대상에 I/O 요청 보내기를 참조하세요.

I/O 대상에 대한 자세한 내용은 I/O 대상 사용을 참조하세요.

예제

다음 코드 예제에서는 로컬 버퍼를 정의하고, WDF_MEMORY_DESCRIPTOR 구조를 초기화하고, WdfIoTargetSendIoctlSynchronously를 호출합니다. 이 예제에서는 요청 개체 핸들에 대해 NULL 을 지정하므로 프레임워크는 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
                                           );

요구 사항

   
대상 플랫폼 유니버설
최소 KMDF 버전 1.0
최소 UMDF 버전 2.0
헤더 wdfiotarget.h(Wdf.h 포함)
라이브러리 Wdf01000.sys(KMDF); WUDFx02000.dll(UMDF)
IRQL PASSIVE_LEVEL
DDI 규정 준수 규칙 DeferredRequestCompleted(kmdf), DriverCreate(kmdf), InternalIoctlReqs(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), ReadReqs(kmdf), RequestCompleted(kmdf), RequestCompletedLocal(kmdf), SyncReqSend(kmdf), WriteReqs(kmdf)

참고 항목

EvtDriverDeviceAdd

WDF_MEMORY_DESCRIPTOR

WDF_MEMORY_DESCRIPTOR_INIT_BUFFER

WDF_REQUEST_SEND_OPTIONS

WdfDeviceGetIoTarget

WdfIoTargetCreate

WdfIoTargetFormatRequestForIoctl

WdfIoTargetSendInternalIoctlSynchronously

WdfMemoryCreate

WdfMemoryCreatePreallocated

WdfRequestCancelSentRequest

WdfRequestCompleteWithInformation

WdfRequestCreate

WdfRequestRetrieveInputMemory

WdfRequestRetrieveInputWdmmdl

WdfRequestRetrieveOutputMemory

WdfRequestRetrieveOutputWdmMdl

WdfRequestReuse