Universal Windows Driver Development with WDF UMDF 2.0 and KMDF for IoT, Desktop and Server

Size: px

Start display at page:

Download "Universal Windows Driver Development with WDF UMDF 2.0 and KMDF for IoT, Desktop and Server"

Edward Harrell
6 years ago
Views:

1 KMDF - Version: January 2018 Universal Windows Driver Development with WDF UMDF 2.0 and KMDF for IoT, Desktop and Server

2 Universal Windows Driver Development with WDF UMDF 2.0 and KMDF for IoT, Desktop and Server KMDF - Version: days Course Description: In this 5 day course students will learn the basics for device driver development on Microsoft Windows platforms 8.1 and Windows 10. This workshop is packed with hands on labs and practical samples. The students gain a thorough knowledge about the device driver architecture of the Microsoft Windows operating systems and their kernel mode components. In addition to this they learn concepts and backgrounds of device driver development using the WDK and lots of practical tips and tricks. Intended audience: Experienced application programmers, system software and driver developers, who need a thorough introduction to low level and hardware related software development on Microsoft Windows Platforms. Prerequisites: Very good knowledge of the programming language C/and or C++ Basic knowledge of Microsoft Visual Studio Basic knowledge of Windows system programming Basic knowledge of Windows system administration Basic knowledge of virtual machine administration (VMWare Player or Microsoft HyperV).

3 Objectives: Students learn the fundamentals of WDF Kernel Mode Driver Framework (KMDF). They gain knowledge about WDM device driver architecture of the Microsoft Windows operating systems and their kernel mode components. In addition they learn concepts and backgrounds of device driver development using the WDK and lots of practical tips and tricks. Students learn the fundamentals of Windows Driver Frameworks UMDF 2.0 (User Mode Driver Framework) and KMDF (Kernel Mode Driver Framework). They gain knowledge about the Plug'n'Play device driver architecture of contemporary Microsoft Windows operating systems. Topics: Operating System Overview Operating system concepts º Multitasking, Privilege Levels and Virtual Memory Operating system architecture º Monolithic, layered and Microkernel Windows history and architecture º History of different Windows operating systems º Contemporary Windows based on modified Microkernel architecture Windows architecture overview Windows components in User Mode º Applications, Services and System Processes Windows system call interface º Windows API and Subsystem layer º Native API Windows traps, exceptions, system calls and interrupts Windows Kernel Mode components º Kernel Mode Managers º Windows Kernel º Hardware Abstraction Layer (HAL) º Kernel Mode drivers

4 Driver Models Devices buses and driver software Driver software Categories of devices and drivers Plug'n'Play driver architecture fundamentals º File based, packet based, layered dynamic load and unload º When a Plug'n'Play driver is called. Collaboration of multiple drivers controlling one device º Bus Driver and Function Driver º System supplied drivers and vendor supplied drivers Plug'n'Play driver roles and Device Stacks Windows Plug'n'Play driver development º Generic operating system drivers, Miniport drivers and full Plug'n'Play drivers Windows Driver Foundation (WDF) WDF design goals WDF UMDF overview User Mode Driver Framework (UMDF) WDF KMDF overview WDF KMDF Miniport driver development HANDS ON LAB - STEP BY STEP (6.1) º Building and deploying a WDF driver Object Models Overview WDF object model WDF object model WDFDRIVER, WDFDEVICE and WDFFILEOBJECT Native object model for Plug'n'Play drivers Operating system DRIVER_OBJECT and WDFDRIVER Operating system DEVICE_OBJECT and WDFDEVICE DEVICE_OBJECT layering as groundwork for Device Stacks Basic structure of a WDF Function Driver HANDS ON LAB - STEP BY STEP (6.1) º Debugging a WDF driver and inspecting its fundamental structure

5 Driver Interaction with Windows Applications (Top Layer) File based driver model Application device enumeration º Plug'n'Play device interfaces vs. non Plug'n'Play symbolic links Plug'n'Play device interface Device interface classes vs. device setup classes Device Object security descriptor HANDS ON LAB - STEP BY STEP (6.1) º Driver interaction with applications - Device Interface Framework Request objects º Packet based driver model º IO Request types handled by the driver º Request types handled by the framework (not presented to the driver Accessing IO Requests º Retrieving buffer information upon receipt of Request º Setting status information upon return of Request Request processing º Three fundamental options: Complete immediately, delegate or capture º Request ownership and completion Framework IO Request presentation º Framework default implementation for Create, Cleanup and Close º Presentation of Read, Write and DeviceIoControl for driver handling Framework Queue objects for Request presentation º Request type assignment and default Queue º Fundamental Queue methods and events Queue object Request presentation models º Pull model (method calls) and push model (event callbacks) Queue dispatch types º Sequential, manual and parallel dispatching Framework File objects and Request presentation º Optional presentation (due to default implementation) º Presentation by Device object using EvtDeviceFileCreate º Presentation by File object using EvtFileCleanup and EvtFileClose HANDS ON LAB - STEP BY STEP (6.1.1) º Driver interaction with applications - Hello World

6 Driver Interaction with other Drivers (Intermediate Layer) Driver layering and Device Stacks (overview) Driver Roles º Function Drivers, Filter Drivers and Bus Drivers Device Stacks º Attachment and Request processing º Device Stacks and WDF Reasons for a layered driver model º Standard hooking capabilities through filter drivers º Layered driver model as groundwork for Plug'n'Play and Power Management º Division of labor between function driver and bus driver º Routing Plug'n'Play and Power events through the whole device stack WDF IO Targets for inter driver communication º Remote IO Targets, Default IO Targets, General IO Targets and Specialized IO Targets Request preparation and formatting for IO Targets Asynchronous and synchronous Request forwarding Driver Defined Interfaces HANDS ON LAB - STEP BY STEP (6.2) º Sending Requests to IO Targets (simple sample) º Sending Requests to Windows COM port driver of virtual machine Filter driver categories and setup º Device filters and class filters º Upper filters and lower filters º Filter driver setup WDF Plug'n'Play filter drivers º Implicit attachment by KMDF º Filter driver default action upon unknown or unhandled filtered requests Filter driver request processing º Forwarding requests to next lower device object º Processing requests after completion by lower driver º Sideband communication with control application via separate device object HANDS ON LAB - STEP BY STEP (6.3) º WDF USB mouse filter driver implementation (simple sample)

7 Driver Interaction with Hardware (Bottom Layer) Windows boot and power up sequence Plug'n'Play Device Tree º Ordered by bootup and power up sequence º Composed by layered drivers and device stacks Device detection and identification by ACPI Firmware Device detection and identification by Plug n Play bus hardware Plug'n'Play hardware and firmware components Plug'n'Play operating system and software components º Windows Plug'n'Play Manger, bus drivers and function drivers Scenario Pluging a new device Core Plug n Play states and transitions º Device discovery, startup, rebalance and removal WDF Plug n Play related events WDF Plug n Play capabilities (WDF_DEVICE_PNP_CAPABILITIES) Plug n Play hardware resources º Assignment upon EvtDevicePrepareHardware Plug'n'Play hardware resources description º Configuration Manager data structure CM_RESOURCE_LIST º WDF utility functions for managing CM_RESOURCE_LIST HANDS ON LAB - STEP BY STEP (6.4) º WDF driver Plug'n'Play event implementation (simple sample) Power Management (Bottom Layer) Power management operating system and software components ACPI power state classes and power states º Hardware power state classes Global, System, CPU, Bus and Device System power states S0-S5 Device power states D0-D3 Device Power Policy º Device Power Policy Owner mapping system power states to device power states º Policy Owner optional idle and wake functionality

8 WDF power policy and events º No delivery of WdfRequestTypePower º Power Policy Owner default implementation in function drivers º EvtDeviceD0Entry and EvtDeviceD0Exit HANDS ON LAB - STEP BY STEP (6.5) º WDF driver Power event implementation (simple sample) Idle power down Wake from S0, wake from SX WDF power capabilities (WDF_DEVICE_POWER_CAPABILITIES) Component Power Management Interrupts (Bottom Layer) Interrupt processing sequence Interrupt signaling mechanisms º Signaling mechanisms line based and MSI Interrupt priorities and IRQL º PASSIVE_LEVEL, DISPATCH LEVEL and DIRQL WDF Interrupt object º Interrupt object creation and connection of EvtInterruptIsr (Interrupt Service Routine) º Interrupt enabling and disabling Servicing an interrupt in EvtInterruptIsr DIRQL interrupt processing (KMDF only) º Minimization of CPU cycles spent on elevated IRQ º DIRQL interrupt processing º DISPATCH_LEVEL interrupt post processing º Deferred Procedure Call (DPC). Framework DPC objects º Per processor DPC queues º DPC execution at DISPATCH_LEVEL PASSIVE_LEVEL interrupt processing º GPIO secondary interrupt ISRs need to access device at PASSIVE_LEVEL º UMDF driver ISRs can only access their device at PASSIVE_LEVEL Function drivers without hardware resources

9 Software-only WDM Function Drivers º Enumeration by system supplied Root Bus Driver OS supplied bus drivers for data transfer to and from device º SD bus driver and SD driver stack º USB bus driver and USB driver stack SDIO drivers (TBD) USB fundamentals USB bus driver interface WDF USB support º Specialized USB IO Targets, ContinuousReader, etc HANDS ON LAB - STEP BY STEP (6.6.1) º USB Interrupt Transfers º WDF USB Continuous Reader º WDF driver reading from USB mouse hardware (simple sample) º USB selective suspend power management S0 idle settings Function drivers with hardware resources PC hardware architecture overview º CPU and frontside bus, north bridge, physical memory,system bus, Interrupt controller Device register initialization º Mapping memory mapped registers to virtual address space Device register access by HAL macros HANDS ON LAB - STEP BY STEP (6.7.1) º Receiving hardware resources from Plug'n'Play Manager º Accessing device registers º Handle interrupts and queue DPCs (Deferred Procedure Calls) º WDF driver reading from serial COM port hardware (simple sample) Busmaster DMA (KMDF only) º Packet based DMA º Common Buffer DMA Peripheral Drivers for Devices on Low Power Bus Low Power Buses Overview

10 º GPIO, SPB (SPI, I2C) and HSUART º Controller Drivers and Peripheral Drivers º WDF extension libraries for Controller Drivers (e.g. GpioClx and SpbCx) SPB device stacks º SPB peripheral device enumeration by ACPI driver º SPB Hardware Resources º IO Target interface to controller driver(s) Peripheral Drivers using GPIO Pins º Controller driver IO Request Interface for data input and output º Interrupt resources for interrupt input Multifunctional devices and bus drivers Operating system supplied bus drivers and multifunction drivers º Bus drivers (PCI, USB, etc.) º PCI multifunction bus extender driver mf.sys º USB generic composite device driver usbccgp.sys WDF multifunction drivers and bus drivers (KMDF only) º Reporting child devices to Plug'n'Play manager º Static enumeration vs. dynamic enumeration Multifunction driver vs. Device Object name space Others Miniport drivers º WDF and miniport model coexistence Drivers without WDF support º Bus filter drivers (no WDF support) º Legacy drivers (non-wdf and non-wdm) Virtual memory Virtual Memory fundamentals º Virtual addresses, physical addresses and logical addresses KMDF memory management º Paged pool and non-paged pool memory

11 º Kernel stack º WDF Lookaside Lists Threads, scheduling and timers Thread Scheduling, Thread Priorities and IRQLS º Round robin scheduling at priorities from 0 to 15 (variable range) º Fifo scheduling at priorities from 16 to 31 (real time range) º No scheduling at IRQL DISPATCH_LEVEL and above Thread Execution Context º User mode application upon IO request handling (known context) º System worker thread created by driver or OS (known context) º Arbitrary unknown context (e.g. on elevated IRQL) Framework Timer Objects Framework Work-Item Objects Synchronization Fundamentals and standard synchronization problems º Concurrent readers and writers º Single writer multiple readers º Consumer / producer º Sleeping barber º Lock free circular buffer The dining philosophers Elevated IRQLs and synchronization º Elevating IRQL only does not synchronize º Different multiprocessor safe synchronization at elevated IRQLs º Interlocked operations on all IRQLs WDF locks º Wait locks º Spin locks º Interrupt locks HANDS ON LAB - STEP BY STEP (6.7.2) º Synchronization of EvtInterruptIsr vs DPCs Framework object presentation lock

12 WDF automatic synchronization of IO º WDF Synchronization scope º Object related execution level WDF automatic synchronization of PnP and Power Management WDM advanced performance synchronization on IRQL APC_LEVEL º Fast Mutex º ERESOURCE Locks Memory considerations upon IO processing Buffered IO vs Direct IO Transfer method for specific Requests º Read and Write transfer method determined by Device Object º IOCTL transfer method determined by IOCTL control code WDF Request Memory Methods IO cancellation Application IO cancellation scenarios Canceling Requests sent to other drivers Making Requests cancellable IO processing with hardware Two common fundamental scenarios º Push-Queues (sequential or parallel) for software triggered hardware activity º Pull-Queues (manual) for hardware triggered activity at random rate Power Managed IO Queues HANDS ON LAB - STEP BY STEP (6.6.2) º Simple sample IO with USB device / mouse º Completing Requests depending on USB Interrupt Transfers º Transferring data from USB Interrupt Transfers to Console Application HANDS ON LAB - STEP BY STEP (6.7.3) º Simple sample IO with serial COM port of virtual machine º Completing Requests depending on hardware interrupts º Synchronization of driver IO and hardware action across different IRQLs

13 º Transferring data from Interrupt Service Routine to Console Application Advanced IO processing Request pre-processing in caller context Self managed IO Application IO processing with full Plug'n'Play support Handling Plug'n'Play notifications in Windows Applications and Services º Plug n Play Device Interface Notifications for device arrival º Plug n Play Device Handle Notifications for device removal HANDS ON LAB - STEP BY STEP (6.8) º Simple sample Windows GUI application accessing device º Plug'n'Play notification handling for device arrival and device removal Driver Deployment Driver Package / Setup Disk INF Files Device Categorization and Setup Classes Co-Installer and Class-Installer DLLs Driver setup and digital signature Driver Setup Scenarios º Hardware first, software first and software only Driver Store Driver registry entries: Services key, hardware key, software key Driver Install Framework DIFx. Setup API and devcon sample Windows Management Instrumentation (WMI) WMI overview WMI introduction Application access to WMI data

14 WMI data providers and data blocks º Data items, methods and events º Managed Object Format (MOF) WMI class descriptions WMI methods and events WMI tools HANDS ON LAB - STEP BY STEP (6.9) º Simple sample WMI implementation º WMI provider for diagnostic data (e.g. driver interrupt count) º WMI consumer in Visual Basic Script (VBS)

Ausgewählte Betriebssysteme - Mark Russinovich & David Solomon (used with permission of authors)

Ausgewählte Betriebssysteme - Mark Russinovich & David Solomon (used with permission of authors) Outline Windows 2000 - The I/O Structure Ausgewählte Betriebssysteme Institut Betriebssysteme Fakultät Informatik Components of I/O System Plug n Play Management Power Management I/O Data Structures File