静的ドライバー検証ツールでの KMDF 関数の宣言

SDV で KMDF ドライバーを検証できるようにするには、コールバック関数ロール型を使用して、各コール バック関数を宣言する必要があります。 コールバック関数ロール型は、さまざまな WDF ヘッダー ファイルで定義され、Wdf.h ヘッダー ファイルを使用してドライバーをビルドする場合に含まれます。 次の表は、関数ロール型と、それらが関連付けられているイベント コールバック関数を示しています。

コールバック関数の定義の前に、ドライバーのコールバック関数を宣言する必要があります。 次の例は、EvtDriverDeviceAdd コールバック関数の関数ロール型宣言を示しています。 この例では、コールバック関数は EvtDriverDeviceAdd と呼ばれています。

#include <NTDDK.h>  
#include <wdf.h>
EVT_WDF_DRIVER_DEVICE_ADD EvtDriverDeviceAdd

コールバック関数に関数プロトタイプ宣言がある場合は、関数プロトタイプを関数ロール型宣言に置き換える必要があります。 関数ロール型宣言の詳細については、「関数ロール型宣言の使用」を参照してください。

次の表は、コールバック関数型と、それらが関連付けられているイベント コールバック関数を示しています。

関数ロール型	イベント コールバック関数
EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP	EvtChildListAddressDescriptionCleanup
EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY	EvtChildListAddressDescriptionCopy
EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE	EvtChildListIdentificationDescriptionDuplicate
EVT_WDF_CHILD_LIST_CREATE_DEVICE	EvtChildListCreateDevice
EVT_WDF_CHILD_LIST_DEVICE_REENUMERATED	EvtChildListDeviceReenumerated
EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP	EvtChildListIdentificationDescriptionCleanup
EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE	EvtChildListIdentificationDescriptionCompare
EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY	EvtChildListIdentificationDescriptionCopy
EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE	EvtChildListIdentificationDescriptionDuplicate
EVT_WDF_CHILD_LIST_SCAN_FOR_CHILDREN	EvtChildListScanForChildren
EVT_WDF_DEVICE_ARM_WAKE_FROM_S0	EvtDeviceArmWakeFromS0
EVT_WDF_DEVICE_ARM_WAKE_FROM_SX	EvtDeviceArmWakeFromSx
EVT_WDF_DEVICE_CONTEXT_CLEANUP	EvtCleanupCallback
EVT_WDF_DEVICE_CONTEXT_DESTROY	EvtDestroyCallback
EVT_WDF_DEVICE_D0_ENTRY	EvtDeviceD0Entry
EVT_WDF_DEVICE_D0_ENTRY_POST_INTERRUPTS_ENABLED	EvtDeviceD0EntryPostInterruptsEnabled
EVT_WDF_DEVICE_D0_EXIT	EvtDeviceD0Exit
EVT_WDF_DEVICE_D0_EXIT_PRE_INTERRUPTS_DISABLED	EvtDeviceD0ExitPreInterruptsDisabled
EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS	EvtDeviceDisableWakeAtBus
EVT_WDF_DEVICE_DISARM_WAKE_FROM_S0	EvtDeviceDisarmWakeFromS0
EVT_WDF_DEVICE_DISARM_WAKE_FROM_SX	EvtDeviceDisarmWakeFromSx
EVT_WDF_DEVICE_EJECT	EvtDeviceEject
EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS	EvtDeviceEnableWakeAtBus
EVT_WDF_DEVICE_FILE_CREATE	EvtDeviceFileCreate
EVT_WDF_DEVICE_FILTER_RESOURCE_REQUIREMENTS	EvtDeviceFilterAddResourceRequirements
EVT_WDF_DEVICE_PNP_STATE_CHANGE_NOTIFICATION	EvtDevicePnpStateChange
EVT_WDF_DEVICE_POWER_POLICY_STATE_CHANGE_NOTIFICATION	EvtDevicePnpStateChange
EVT_WDF_DEVICE_POWER_STATE_CHANGE_NOTIFICATION	EvtDevicePowerStateChange
EVT_WDF_DEVICE_PREPARE_HARDWARE	EvtDevicePrepareHardware
EVT_WDF_DEVICE_PROCESS_QUERY_INTERFACE_REQUEST	EvtDeviceProcessQueryInterfaceRequest
EVT_WDF_DEVICE_QUERY_REMOVE	EvtDeviceQueryRemove
EVT_WDF_DEVICE_QUERY_STOP	EvtDeviceQueryStop
EVT_WDF_DEVICE_RELATIONS_QUERY	EvtDeviceRelationsQuery
EVT_WDF_DEVICE_RELEASE_HARDWARE	EvtDeviceReleaseHardware
EVT_WDF_DEVICE_REMOVE_ADDED_RESOURCES	EvtDeviceRemoveAddedResources
EVT_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY	EvtDeviceResourceRequirementsQuery
EVT_WDF_DEVICE_RESOURCES_QUERY	EvtDeviceResourcesQuery
EVT_WDF_DEVICE_SELF_MANAGED_IO_CLEANUP	EvtDeviceSelfManagedIoCleanup
EVT_WDF_DEVICE_SELF_MANAGED_IO_FLUSH	EvtDeviceSelfManagedIoFlush
EVT_WDF_DEVICE_SELF_MANAGED_IO_INIT	EvtDeviceSelfManagedIoInit
EVT_WDF_DEVICE_SELF_MANAGED_IO_RESTART	EvtDeviceSelfManagedIoRestart
EVT_WDF_DEVICE_SELF_MANAGED_IO_SUSPEND	EvtDeviceSelfManagedIoSuspend
EVT_WDF_DEVICE_SET_LOCK	EvtDeviceSetLock
EVT_WDF_DEVICE_SHUTDOWN_NOTIFICATION	EvtDeviceShutdownNotification
EVT_WDF_DEVICE_SURPRISE_REMOVAL	EvtDeviceSurpriseRemoval
EVT_WDF_DEVICE_USAGE_NOTIFICATION	EvtDeviceUsageNotification
EVT_WDF_DEVICE_WAKE_FROM_S0_TRIGGERED	EvtDeviceWakeFromS0Triggered
EVT_WDF_DEVICE_WAKE_FROM_SX_TRIGGERED	EvtDeviceWakeFromSxTriggered
EVT_WDF_DMA_ENABLER_DISABLE	EvtDmaEnablerDisable
EVT_WDF_DMA_ENABLER_ENABLE	EvtDmaEnablerEnable
EVT_WDF_DMA_ENABLER_FILL	EvtDmaEnablerFill
EVT_WDF_DMA_ENABLER_FLUSH	EvtDmaEnablerFlush
EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_START	EvtDmaEnablerSelfManagedIoStart
EVT_WDF_DMA_ENABLER_SELFMANAGED_IO_STOP	EvtDmaEnablerSelfManagedIoStop
EVT_WDF_DPC	EvtDpcFunc
EVT_WDF_DRIVER_DEVICE_ADD	EvtDriverDeviceAdd
EVT_WDF_DRIVER_UNLOAD	EvtDriverUnload
EVT_WDF_FILE_CLEANUP	EvtFileCleanup
EVT_WDF_FILE_CLOSE	EvtFileClose
EVT_WDF_FILE_CONTEXT_CLEANUP_CALLBACK	EvtCleanupCallback
EVT_WDF_FILE_CONTEXT_DESTROY_CALLBACK	EvtDestroyCallback
EVT_WDF_INTERRUPT_DISABLE	EvtInterruptDisable
EVT_WDF_INTERRUPT_DPC	EvtInterruptDpc
EVT_WDF_INTERRUPT_ENABLE	EvtInterruptEnable
EVT_WDF_INTERRUPT_ISR	EvtInterruptIsr
EVT_WDF_INTERRUPT_SYNCHRONIZE	EvtInterruptSynchronize
EVT_WDF_IO_IN_CALLER_CONTEXT	EvtIoInCallerContext
EVT_WDF_IO_QUEUE_CONTEXT_CLEANUP_CALLBACK	EvtCleanupCallback
EVT_WDF_IO_QUEUE_CONTEXT_DESTROY_CALLBACK	EvtDestroyCallback
EVT_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE	EvtIoCanceledOnQueue
EVT_WDF_IO_QUEUE_IO_DEFAULT	EvtIoDefault
EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL	EvtIoDeviceControl
EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL	EvtIoInternalDeviceControl
EVT_WDF_IO_QUEUE_IO_READ	EvtIoRead
EVT_WDF_IO_QUEUE_IO_RESUME	EvtIoResume
EVT_WDF_IO_QUEUE_IO_STOP	EvtIoStop
EVT_WDF_IO_QUEUE_IO_WRITE	EvtIoWrite
EVT_WDF_IO_QUEUE_STATE	EvtIoQueueState
EVT_WDF_IO_TARGET_QUERY_REMOVE	EvtIoTargetQueryRemove
EVT_WDF_IO_TARGET_REMOVE_CANCELED	EvtIoTargetRemoveCanceled
EVT_WDF_IO_TARGET_REMOVE_COMPLETE	EvtIoTargetRemoveComplete
EVT_WDF_OBJECT_CONTEXT_CLEANUP	EvtCleanupCallback
EVT_WDF_OBJECT_CONTEXT_DESTROY
EVT_WDF_PROGRAM_DMA	EvtProgramDma
EVT_WDF_REQUEST_CANCEL	EvtRequestCancel
EVT_WDF_REQUEST_COMPLETION_ROUTINE	CompletionRoutine
EVT_WDF_TIMER	EvtTimerFunc
EVT_WDF_TRACE_CALLBACK
EVT_WDF_WMI_INSTANCE_EXECUTE_METHOD	EvtWmiInstanceExecuteMethod
EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE	EvtWmiInstanceQueryInstance
EVT_WDF_WMI_INSTANCE_SET_INSTANCE	EvtWmiInstanceSetInstance
EVT_WDF_WMI_INSTANCE_SET_ITEM	EvtWmiInstanceSetItem
EVT_WDF_WMI_PROVIDER_FUNCTION_CONTROL	EvtWmiProviderFunctionControl
EVT_WDF_WORKITEM	EvtWorkItem
EVT_WDFDEVICE_WDM_IRP_PREPROCESS	EvtDeviceWdmIrpPreprocess

複数のコールバック関数を許可する関数ロール型

一部の関数ロール型は、複数のイベント コールバック関数を関連付けることができます。 たとえば、ドライバーに EvtTimerFunc や EvtDpcFunc の複数のコールバック関数を持つ場合があります。 次の表は、SDV が各関数ロール型でサポートするコールバックの最大数を示しています。 ドライバーが表に記載されている最大数を超えるコールバック関数を持つことは誤りではありませんが、SDV を使用する際の検証プロセスが複雑になります。 追加のコールバック関数に対応するため、Sdv-map.h ファイルに対して必要な変更については、「関数ロール型の重複エントリ ポイント」を参照してください。

関数ロール型	コールバック関数の最大数
EVT_WDF_DPC	7
EVT_WDF_INTERRUPT_SYNCHRONIZE	11
EVT_WDF_TIMER	6
EVT_WDF_WMI_INSTANCE_EXECUTE_METHOD	5
EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE	5
EVT_WDF_WMI_INSTANCE_SET_INSTANCE	5
EVT_WDF_WMI_INSTANCE_SET_ITEM	5

関数ロール型と I/O キュー

KMDF フレームワークに依存して I/O 要求をドライバーに配信する 要求ハンドラー とコールバック関数を宣言する場合は、次の関数ロール型を使用します (順次ディスパッチまたは並列ディスパッチの場合)。 デフォルトのキューから他のキューに要求を手動で転送する関数には、これらの関数ロール型を使用しないでください (手動ディスパッチ) 。 SDV では、あるキューから別のキューへの要求を追跡できるメモリ モデルはサポートされていません。

I/O キューの詳細については、「I/O キューの作成」を参照してください。

手動ディスパッチ用に構成された I/O キューに使用される関数ロール型
EVT_WDF_IO_QUEUE_CONTEXT_CLEANUP_CALLBACK
EVT_WDF_IO_QUEUE_CONTEXT_DESTROY_CALLBACK
EVT_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE
EVT_WDF_IO_QUEUE_IO_DEFAULT
EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL
EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL
EVT_WDF_IO_QUEUE_IO_READ
EVT_WDF_IO_QUEUE_IO_RESUME
EVT_WDF_IO_QUEUE_IO_STOP
EVT_WDF_IO_QUEUE_IO_WRITE
EVT_WDF_IO_QUEUE_STATE

EvtCleanupCallback 関数と EvtDestroyCallback 関数の関数ロール型

オブジェクト固有の関数ロール型で EvtCleanupCallback および EvtDestroyCallback 関数を宣言する必要があります。 SDV では、ドライバーがコールバック関数を適切に使用しているかどうかを判断するために、これらのオブジェクト固有のロール型が必要です。 次の表を使用して、使用する関数型を決定します。

アセチルサリチル酸アクロレイン	EvtCleanupCallback の関数ロール型
Device オブジェクト	EVT_WDF_DEVICE_CONTEXT_CLEANUP
I/O キュー オブジェクト	EVT_WDF_IO_QUEUE_CONTEXT_CLEANUP_CALLBACK
File オブジェクト	EVT_WDF_FILE_CONTEXT_CLEANUP_CALLBACK
他のすべてのオブジェクト	EVT_WDF_OBJECT_CONTEXT_CLEANUP

アセチルサリチル酸アクロレイン	EvDestroyCallback の関数ロール型
Device オブジェクト	EVT_WDF_DEVICE_CONTEXT_DESTROY
I/O キュー オブジェクト	EVT_WDF_IO_QUEUE_CONTEXT_DESTROY_CALLBACK
File オブジェクト	EVT_WDF_FILE_CONTEXT_DESTROY_CALLBACK
他のすべてのオブジェクト	EVT_WDF_OBJECT_CONTEXT_DESTROY