KMDF

**核心模式驅動程式架構**（**Kernel-Mode Driver Framework**，縮寫 **KMDF**）是微軟公司推出的 Windows 驅動程式基礎（Windows Driver Foundation）之一，建構 Windows XP 與 Windows Server 2003 的核心模式（Kernel-Mode）驅動程式所需的基本功能，包括對隨插即用（PNP）、電源管理（Power Manager）、I/O 佇列、直接記憶體存取（DMA）、Windows Management Instrumentation（WMI）和同步處理等的完整支援。KMDF 的設計並不能用來取代 WDM，它提供「Skeletal WDM」建置來替代 WDM；目前，KMDF 並不支援匯流排篩選驅動程式（Bus Filter Driver）。

Kernel-Mode Driver Framework 目前支援下列類型的核心模式（kernel mode）驅動程式之建立了：

* 隨插即用（PNP）裝置所使用的 Function Driver。
* 隨插即用（PNP）裝置所使用的 Filter Driver。
* 隨插即用（PNP）裝置堆疊（Stack）所使用的 Bus Driver。
* Windows NT 4.0 型態裝置所使用的 Control 裝置驅動程式。

KMDF 是可重新進入程式庫（Reentrant Library）。

## 與 WDM 的關係

自 Windows 2000 開始，開發驅動程式必以 WDM 為基礎的，但開發難度太大，無法像使用者模式應用程式開發那樣容易。KMDF 支援驅動程式在 Windows Driver Model 環境中撰寫驅動程式，簡化其中的過程，但是 KMDF 的設計並不能用來取代 WDM，它提供「Skeletal WDM」建置來替代 WDM。早期的 WDM 可支援 Windows 98、Windows Me、Windows 2000 和 Windows XP；至於 WDF 計劃支援 Windows XP，以及更新的版本。

KMDF 係以物件為基底建立於 WDM 架構之上。不同的功能有不同的物件，KMDF 在實作上包含了：

* 隨插即用和電源管理
* I/O 佇列
* 直接記憶體存取（DMA）
* Windows Management Instrumentation（WMI）
* 同步

### 驅動程式進入點

在 Windows 作業系統中驅動程式的起始點都是在 DriverEntry 函式，DriveryEntry 是驅動程式的進入點（entry point）。在 DriverEntry 函式的實作裡，你需要具現化（instantiate）你的 WDFDRIVER 物件，並且告知 WDF framework 要去哪裡呼叫你的系統。

```
NTSTATUS DriverEntry(
   IN PDRIVER_OBJECT  DriverObject,
   IN PUNICODE_STRING  RegistryPath
   )
{
 **WDF\_DRIVER\_CONFIG** config;
 NTSTATUS status = _S\_OK_;
```

```
 KdPrint((__DRIVER_NAME "DriverEntry Begin\n"));
```

```
 WDF_DRIVER_CONFIG_INIT(&config, EvtDeviceAdd);
 status = WdfDriverCreate(
                     DriverObject,
                     RegistryPath,
                     _WDF\_NO\_OBJECT\_ATTRIBUTES_,
                     &config, // Pointer to config structure
                     _WDF\_NO\_HANDLE_); // or NULL, Pointer to get WDFDRIVER handle
 if(T_SUCCESS(status))
 {
   KdPrint((__DRIVER_NAME "WdfDriverCreate failed with status 0x%08x\n", status));
 }
```

```
 KdPrint((__DRIVER_NAME "DriverEntry End\n"));
```

```
 return status;
}
```

### Add Device

EvtDeviceAdd 函式，在系統發現新硬體插入時被呼叫。這個函式將挑起 WDF 驅動程式架構的大部份工作，EvtDeviceAdd 事件被喚起之餘一定會帶出一個 WDFDRIVER 物件，並且指向一個 WDFDEVICE\_INIT 結構。在裝置產生（device crated）之前，必先進行初始化的動作。如果 EvtDeviceAdd 執行成功，那麼 EvtDevicePrepareHardware 是架構下一個被執行的函式，用以保證驅動程式能夠存取硬體。

```
WDFSTATUS DioEvtDeviceAdd(WDFDRIVER Driver, PWDFDEVICE_INIT DeviceInit)
{
 WDFSTATUS status = STATUS_SUCCESS;
 WDF_PNPPOWER_EVENT_CALLBACKS pnpPowerCallbacks;
 WDF_OBJECT_ATTRIBUTES objAttributes;
 WDFDEVICE device;
 PDIO_DEVICE_CONTEXT devContext;
 WDF_IO_QUEUE_CONFIG ioCallbacks;
 WDF_INTERRUPT_CONFIG interruptConfig;
 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS idleSettings;
```

```
 WDF_PNPPOWER_EVENT_CALLBACKS_INIT(&pnpPowerCallbacks);
 pnpPowerCallbacks.EvtDevicePrepareHardware = DioEvtPrepareHardware;
 pnpPowerCallbacks.EvtDeviceReleaseHardware = DioEvtReleaseHardware;
 pnpPowerCallbacks.EvtDeviceD0Entry= DioEvtDeviceD0Entry;
 pnpPowerCallbacks.EvtDeviceD0Exit = DioEvtDeviceD0Exit;
```

```
 WdfDeviceInitSetPnpPowerEventCallbacks(DeviceInit, pnpPowerCallbacks);
```

```
 WDF_OBJECT_ATTRIBUTES_INIT(&objAttributes);
```

```
 WDF_OBJECT_ATTRIBUTES_SET_CONTEXT_TYPE(&objAttributes, DIO_DEVICE_CONTEXT);
```

```
 status = WdfDeviceInitUpdateName(DeviceInit, L"\\device\\WDFDIO");
```

```
 status = WdfDeviceCreate(&DeviceInit,    // Device Init structure
                          &objAttributes, // Attributes for WDF Device
                          &device);       // return new WDF Device pointer,
```

```
 devContext = DioGetContextFromDevice(device); // Get device extension
```

```
 devContext->WdfDevice = device;
```

```
 // Create a symbolic link for the control object
 status = WdfDeviceCreateSymbolicLink(device, L"\\DosDevices\\WDFDIO");
```

```
 WDF_IO_QUEUE_CONFIG_INIT(&ioCallbacks,
                            WdfIoQueueDispatchSerial,
                            WDF_NO_EVENT_CALLBACK,     // StartIo
                            WDF_NO_EVENT_CALLBACK);    // CancelRoutine
```

```
 ioCallbacks.EvtIoDeviceControl = DioEvtDeviceControlIoctl;
 status = WdfDeviceCreateDefaultQueue(device,
                                       &ioCallbacks,
                                       _WDF\_NO\_OBJECT\_ATTRIBUTES_,
                                       NULL); // pointer to default queue
```

```
 WDF_INTERRUPT_CONFIG_INIT(&interruptConfig,       // Configure the Interrupt object
                             FALSE,                // auto-queue DPC?
                             DioIsr,               // ISR
                             DioDpc);              // Defered Procedule Call
```

```
 interruptConfig.EvtInterruptEnable = DioEvtInterruptEnable;
 interruptConfig.EvtInterruptDisable = DioEvtInterruptDisable;
```

```
 status = WdfInterruptCreate(device,
                             &interruptConfig,
                             &objAttributes,
                             &devContext->WdfInterrupt);
```

```
 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT(&idleSettings,  // Initialize idle policy
                                             IdleCannotWakeFromS0);
```

```
 status = WdfDeviceUpdateS0IdleSettings(device, &idleSettings);
```

```
 return status;
}
```

### Prepare Hardware

如果 EvtDeviceAdd 順利執行成功，那麼 EvtDevicePrepareHardware 是架構下一個被執行的函式，用以保證驅動程式能夠存取硬體。

```
NTSTATUS EvtDevicePrepareHardware(
   IN WDFDEVICE    Device,
   IN WDFCMRESLIST ResourceList,
   IN WDFCMRESLIST ResourceListTranslated
   )
{
 NTSTATUS status = STATUS_SUCCESS;
```

```
 UNREFERENCED_PARAMETER(Device);
 UNREFERENCED_PARAMETER(ResourceList);
 UNREFERENCED_PARAMETER(ResourceListTranslated);
```

```
 return status;
}
```

```
NTSTATUS EvtDeviceD0Entry(
   IN WDFDEVICE  Device,
   IN WDF_POWER_DEVICE_STATE  PreviousState
   )
{
 NTSTATUS status = STATUS_SUCCESS;
```

```
 return status;
}
```

```
NTSTATUS EvtDeviceD0Exit(
   IN WDFDEVICE  Device,
   IN WDF_POWER_DEVICE_STATE  TargetState
   )
{
 NTSTATUS status = STATUS_SUCCESS;
```

```
 return status;
}
```

### IO requests

```
VOID EvtDeviceIoDefault(
   IN WDFQUEUE  Queue,
   IN WDFREQUEST  Request
   )
{
 WdfRequestComplete(Request, STATUS_NOT_IMPLEMENTED);
}
```

## 外部連結

* Windows Driver Kit （頁面存檔備份，存於網際網路檔案館）
* Kernel-Mode Driver Framework Homepage （頁面存檔備份，存於網際網路檔案館）
* Microsoft KMDF Paper （頁面存檔備份，存於網際網路檔案館）