Fungsi WdfIoTargetFormatRequestForInternalIoctl (wdfiotarget.h)
[Hanya berlaku untuk KMDF]
Metode WdfIoTargetFormatRequestForInternalIoctl membangun permintaan kontrol perangkat internal untuk target I/O tetapi tidak mengirim permintaan.
Sintaks
NTSTATUS WdfIoTargetFormatRequestForInternalIoctl(
[in] WDFIOTARGET IoTarget,
[in] WDFREQUEST Request,
[in] ULONG IoctlCode,
[in, optional] WDFMEMORY InputBuffer,
[in, optional] PWDFMEMORY_OFFSET InputBufferOffset,
[in, optional] WDFMEMORY OutputBuffer,
[in, optional] PWDFMEMORY_OFFSET OutputBufferOffset
);
Parameter
[in] IoTarget
Handel ke objek target I/O lokal atau jarak jauh yang diperoleh dari panggilan sebelumnya ke WdfDeviceGetIoTarget atau WdfIoTargetCreate, atau dari metode yang disediakan target I/O khusus.
[in] Request
Handel ke objek permintaan kerangka kerja. Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.
[in] IoctlCode
Kode kontrol I/O (IOCTL) yang didukung target I/O.
[in, optional] InputBuffer
Handel ke objek memori kerangka kerja. Objek ini mewakili buffer yang berisi data yang akan dikirim ke target I/O. Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.
[in, optional] InputBufferOffset
Penunjuk ke struktur WDFMEMORY_OFFSET yang dialokasikan penelepon yang memasok nilai offset dan panjang byte opsional. Kerangka kerja menggunakan nilai-nilai ini untuk menentukan alamat dan panjang awal, dalam buffer input, untuk transfer data. Jika pointer ini NULL, transfer data dimulai di awal buffer input, dan ukuran transfer adalah ukuran buffer.
[in, optional] OutputBuffer
Handel ke objek memori kerangka kerja. Objek ini mewakili buffer yang akan menerima data dari target I/O. Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.
[in, optional] OutputBufferOffset
Penunjuk ke struktur WDFMEMORY_OFFSET yang dialokasikan penelepon yang memasok nilai offset dan panjang byte opsional. Kerangka kerja menggunakan nilai-nilai ini untuk menentukan alamat dan panjang awal, dalam buffer output, untuk transfer data. Jika pointer ini ADALAH NULL, transfer data dimulai di awal buffer output, dan ukuran transfer adalah ukuran buffer.
Nilai kembali
WdfIoTargetFormatRequestForInternalIoctl mengembalikan STATUS_SUCCESS jika operasi berhasil. Jika tidak, metode ini mungkin mengembalikan salah satu nilai berikut:
| Menampilkan kode | Deskripsi |
|---|---|
|
Parameter yang tidak valid terdeteksi. |
|
Panjang transfer lebih besar dari panjang buffer, atau permintaan I/O sudah diantrekan ke target I/O. |
|
Kerangka kerja tidak dapat mengalokasikan sumber daya sistem (biasanya memori). |
|
Paket permintaan I/O (IRP) yang diwakili parameter Permintaan tidak menyediakan struktur IO_STACK_LOCATION yang cukup untuk memungkinkan driver meneruskan permintaan. |
Metode ini juga dapat mengembalikan nilai NTSTATUS lainnya.
Pemeriksaan bug terjadi jika driver menyediakan handel objek yang tidak valid.
Keterangan
Gunakan metode WdfIoTargetFormatRequestForInternalIoctl , diikuti dengan metode WdfRequestSend , untuk mengirim permintaan kontrol perangkat internal baik secara sinkron atau asinkron. Atau, gunakan metode WdfIoTargetSendInternalIoctlSynchronously untuk mengirim permintaan kontrol perangkat internal secara sinkron.
Untuk informasi selengkapnya tentang permintaan kontrol perangkat internal, lihat Menggunakan Kode Kontrol I/O.
Anda dapat meneruskan permintaan kontrol perangkat internal yang diterima driver Anda dalam antrean I/O, atau Anda dapat membuat dan mengirim permintaan baru. Dalam kedua kasus, kerangka kerja memerlukan objek permintaan dan beberapa ruang buffer.
Untuk meneruskan permintaan kontrol perangkat internal yang diterima driver Anda dalam antrean I/O:
- Tentukan handel permintaan yang diterima untuk parameter Permintaan metode WdfIoTargetFormatRequestForInternalIoctl.
-
Gunakan buffer input permintaan yang diterima untuk parameter InputBuffer metode WdfIoTargetFormatRequestForInternalIoctl.
Driver harus memanggil WdfRequestRetrieveInputMemory untuk mendapatkan handel ke buffer input permintaan, dan harus menggunakan handel tersebut sebagai nilai untuk InputBuffer.
-
Gunakan buffer output permintaan yang diterima untuk parameter OutputBuffer metode WdfIoTargetFormatRequestForInternalIoctl.
Driver harus memanggil WdfRequestRetrieveOutputMemory untuk mendapatkan handel ke buffer output permintaan, dan harus menggunakan handel tersebut sebagai nilai untuk OutputBuffer.
Driver sering membagi permintaan I/O yang diterima menjadi permintaan yang lebih kecil yang mereka kirim ke target I/O, sehingga driver Anda mungkin membuat permintaan baru.
Untuk membuat permintaan I/O baru:
-
Buat objek permintaan baru dan berikan handelnya untuk parameter Permintaan metode WdfIoTargetFormatRequestForInternalIoctl.
Panggil WdfRequestCreate untuk melakukan pra-alokasi satu atau beberapa objek permintaan. Anda dapat menggunakan kembali objek permintaan ini dengan memanggil WdfRequestReuse. Fungsi panggilan balik EvtDriverDeviceAdd driver Anda dapat melakukan pra-alokasi objek permintaan untuk perangkat.
-
Sediakan ruang buffer, dan berikan handel buffer untuk parameter InputBuffer dan OutputBuffer metode WdfIoTargetFormatRequestForInternalIoctl.
Driver Anda harus menentukan ruang buffer ini sebagai handel WDFMEMORY ke memori yang dikelola kerangka kerja. Driver Anda dapat melakukan salah satu hal berikut:
- Panggil WdfMemoryCreate atau WdfMemoryCreatePreallocated untuk membuat buffer memori baru, jika Anda ingin driver meneruskan buffer baru ke target I/O.
- Panggil WdfRequestRetrieveInputMemory atau WdfRequestRetrieveOutputMemory untuk mendapatkan handel ke objek memori yang mewakili buffer permintaan I/O yang diterima, jika Anda ingin driver meneruskan konten buffer tersebut ke target I/O.
Beberapa panggilan ke WdfIoTargetFormatRequestForInternalIoctl yang menggunakan permintaan yang sama tidak menyebabkan alokasi sumber daya tambahan. Oleh karena itu, untuk mengurangi kemungkinan WdfRequestCreate akan mengembalikan STATUS_INSUFFICIENT_RESOURCES, fungsi panggilan balik EvtDriverDeviceAdd driver Anda dapat memanggil WdfRequestCreate untuk melakukan pra-alokasi satu atau beberapa objek permintaan untuk perangkat. Driver kemudian dapat menggunakan kembali (panggil WdfRequestReuse), reformat (panggil WdfIoTargetFormatRequestForInternalIoctl), dan mengirim ulang (panggil WdfRequestSend) setiap objek permintaan tanpa mempertaruhkan nilai pengembalian STATUS_INSUFFICIENT_RESOURCES dari panggilan selanjutnya ke WdfRequestCreate. Semua panggilan berikutnya ke WdfIoTargetFormatRequestForInternalIoctl untuk objek permintaan yang digunakan kembali akan mengembalikan STATUS_SUCCESS, jika nilai parameter tidak berubah. (Namun, jika driver tidak memanggil metode pemformatan permintaan yang sama setiap kali, sumber daya tambahan mungkin dialokasikan. Selain itu, jika kode kontrol I/O menentukan jenis transfer METHOD_BUFFERED, kerangka kerja harus mengalokasikan buffer sistem untuk setiap permintaan, dan alokasi tersebut dapat gagal karena sumber daya memori yang tidak mencukupi.)
Untuk informasi tentang mendapatkan informasi status setelah permintaan I/O selesai, lihat Mendapatkan Informasi Penyelesaian.
Untuk informasi selengkapnya tentang WdfIoTargetFormatRequestForInternalIoctl, lihat Mengirim Permintaan I/O ke Target I/O Umum.
Untuk informasi selengkapnya tentang target I/O, lihat Menggunakan Target I/O.
Contoh
Contoh kode berikut membuat objek memori kerangka kerja yang merupakan anak dari objek permintaan. Selanjutnya, contoh mendapatkan buffer yang dikandung objek memori dan menginisialisasi buffer. Kemudian, contoh memformat permintaan, menetapkan fungsi panggilan balik CompletionRoutine , dan mengirim permintaan ke target I/O.
WDF_OBJECT_ATTRIBUTES memoryObjAttr;
WDFMEMORY memory;
NTSTATUS status;
IOCTL_DATA *pIoctlData;
WDF_OBJECT_ATTRIBUTES_INIT(&memoryObjAttr);
memoryObjAttr.ParentObject = Request;
status = WdfMemoryCreate(
&memoryObjAttr,
NonPagedPool,
0,
sizeof(IOCTL_DATA),
&memory,
NULL
);
if (!NT_SUCCESS(status)) {
goto Done;
}
pIoctlData = WdfMemoryGetBuffer(
memory,
NULL
);
RtlZeroMemory(
pIoctlData,
sizeof(IOCTL_DATA)
);
pIoctlData->Member1 = MY_DATA;
status = WdfIoTargetFormatRequestForInternalIoctl(
IoTarget,
Request,
IOCTL_INTERNAL_GET_MY_DATA,
memory,
NULL,
WDF_NO_HANDLE,
NULL
);
if (!NT_SUCCESS(status)) {
goto Done;
}
WdfRequestSetCompletionRoutine(
Request,
MyRequestCompletion,
NULL
);
if (WdfRequestSend(
Request,
IoTarget,
NULL
) == FALSE) {
status = WdfRequestGetStatus(Request);
}
else {
status = STATUS_SUCCESS;
}
Persyaratan
| Persyaratan | Nilai |
|---|---|
| Target Platform | Universal |
| Versi KMDF minimum | 1,0 |
| Header | wdfiotarget.h (termasuk Wdf.h) |
| Pustaka | Wdf01000.sys (lihat Penerapan Versi Pustaka Kerangka Kerja.) |
| IRQL | <=DISPATCH_LEVEL |
| Aturan kepatuhan DDI | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestFormattedValid(kmdf), RequestSendAndForgetNoFormatting(kmdf), RequestSendAndForgetNoFormatting2(kmdf) |
Lihat juga
WdfIoTargetFormatRequestForIoctl
WdfIoTargetSendInternalIoctlSynchronously
WdfIoTargetSendIoctlSynchronously