The windows 2000 device driver book

The Windows 2000 Device Driver Book, A Guide for Programmers, Second Edition, Art Baker, Jerry Lozano, 2000.

    Drivers are the most fundamental and technically difficult part of operating system development. As a reader of this book, you are probably well aware of the complexities involved. Even for the most seasoned software engineer the task can be daunting. Writing device drivers under Windows 2000 is a big challenge to learn. The most comprehensive, authoritative guide to Windows NT driver development, The Windows NT Device Driver Book by Art Baker is now a classic. I can not think of anyone better qualified to write the second edition of Art’s outstanding book than Jerry Lozano. Jerry combines the qualities of strong technologist, excellent writer, and gifted educator. These qualities have translated into book form very well. Reading this book I felt I was taking one of Jerry’s classes.

Дата публикации: 22.02.2014 07:50 UTC

Теги:

учебник по информатике :: информатика :: компьютеры :: Art Baker :: Jerry Lozano

Annotation Preface This book explains how to write, install, and debug device drivers for Windows 2000. It is intended to be a companion to the Microsoft DDK documentation and software. Windows 2000 represents a major improvement to previous versions of Windows NT. Device drivers for Windows 2000 may be designed for the new Windows Driver Model (WDM) architecture. If so, the driver will be source compatible with Windows 98. This book covers the new WDM specification. This book will also prove useful to those studying the internals of Windows 2000, particularly the I/O subsystem and related components. What You Should Already Know All instruction assumes a base knowledge level. First, the reader should be familiar with Windows 2000 administration—security and setup, for example. Since experimentation with kernel-mode code can (and will) cause system problems, the reader should be prepared and able to restore a chaotic OS. Second, the reader should be competent in the C programming language and somewhat familiar with C++. Only a little C++ is used in this book, and then only for the purpose of simplifying tedious code. Third, experience with Win32 user-mode programming is useful. Knowing how user-mode code drives I/O devices is useful in designing and testing device driver code. The test code for the examples in this book rely on the console subsystem model for Windows. To review this topic, the reader is referred to the Win32 Programmers Reference , particularly the chapters on I/O primitives (CreateFile, ReadFile, WriteFile, and DeviceIoControl). The bibliography lists other references for this topic. Finally, while no specific prior knowledge of hardware or device driver software design is assumed, it would be useful if the reader had experience with some aspect of low-level device interfacing. For example, knowledge of writing device drivers for a Unix system will prove quite useful when reading this book. What’s Covered The focus of this book is to first explain the architecture of the hardware, environment, and device driver, and then to explain the details of writing code. Chapters are grouped within this book as follows:

• Chapters 1-5: The first five chapters of this book cover the foundation of what’s needed to write a device driver. This includes coverage of the Windows 2000 architecture, hardware terminology and bus basics, and an in-depth view of the Windows 2000 I/O Manager and related services.
• Chapters 6-13: The next eight chapters form the nucleus of this book. The chapters cover everything from the mechanics of building a driver to the specifics of instrumenting a driver to log errors and other events.
• Chapters 14-15: These two chapters deal with somewhat more advanced topics within device driver construction. This includes the use of system threads, layering, filtering, and utilizing driver classes.
• Chapters 16-17: The final chapters deal with the practical but necessary details of driver installation and debugging. The use of Windows 2000 INF files for «automatic» installation of a plug and play device driver is covered (as well as manual installation for legacy devices). The use of WinDbg is covered in sufficient detail so that the programmer can actually perform interactive debugging.
• Appendices: The appendices cover reference information needed for driver development. The mechanics of Windows 2000 symbol file installation, bugcheck codes, and so on are listed.

What’s Not Since the purpose of this book is to cover driver development from «the ground up,» some specific topics fall outside its scope. Specifically, the list of topics not covered includes File system driversCurrently, the construction of a full Windows 2000 Installable File System requires the acquisition of the Microsoft IFS kit. The bibliography of this book points to one source for more information on this topic. Potential users of the IFS kit will benefit greatly from this book, as the material covered is essential prerequisite knowledge. Device-specific driver informationThe construction of NIC (Network Interface Card), SCSI, video (including capture devices), printers, and multimedia drivers is not specifically covered in this book. Chapter 1 discusses the architectural implications of such drivers, but even individual chapters on each of these driver types would seriously shortchange the requisite knowledge. Virtual DOS device driversThe current wave of driver development is toward the WDM 32-bit model. Legacy 16-bit VDDs are no longer of interest.About the Sample Code Most chapters in this book include one or more sample drivers. All code is included on the accompanying CD. Samples for each chapter are in separate subdirectories on the CD, so installation of individual projects is straightforward. The CD also includes a device driver application wizard for Microsoft Visual C++ version 6. This wizard configures the build environment so that code can be written, compiled, and linked within Visual Studio. Platform dependencies:The sample code included with this book has been targeted and tested on Intel platforms only. Since it appears that the last non-Intel platform (Alpha) was dropped from the final release of Windows 2000, this should come as no surprise. Be advised, however, that Windows 2000 is intrinsically a platform-independent OS. It is a straightforward process to port the OS to many modern hardware sets. Driver writers should consider designs that take advantage of the Windows 2000 abstractions that permit source compatibility with non-Intel platforms. To build and run the examples:Besides the Microsoft DDK (Device Driver Kit) (which is available on an MSDN subscription or, at present, free for download from the Microsoft web site atwww.microsoft.com/DDK), the sample code assumes that Microsoft Visual C++ is installed. The device driver application wizard was built for Visual Studio version 6. Obviously, with some effort the sample code can be built using other vendors’ compilers. Of course, an installed version of Windows 2000 (Professional, Server, or Enterprise) is required. For interactive debugging using WinDbg, a second host platform is required. History of this Book The first version of this book was written by Art Baker, entitled The Windows NT Device Driver Book . By any account, the book was required reading for any NT driver author. The Microsoft driver model is a continuously moving target. As such, recently introduced books on this subject provided more and up-to-date information. The goal of this revision of the book is to carry forward the goals, style, and clarity of Art’s original work while updating the material with the very latest information available from Microsoft. If you are a previous reader of the original version of this book, I hope you will find this version just as useful. I have attempted to provide accurate, concise, and clear information on the subject of Windows 2000 device drivers. While I have relied heavily on Art’s original work, any errors present in this book are entirely mine. Training and Consulting Services The material in this book is based on training and consulting performed for various companies within the industry. The subject matter of this book is presented exclusively by UCI in the format of a five-day instructor-lead lecture/lab course. The course is available as public or on site classes. UCI provides comprehensive training in high-end programming, web development and administration, databases, and system technologies. For more information please visit the UCI web site atwww.ucitraining.comor use the address information below: UCI Corporation
4 Constitution Way
Suite G
Woburn, MA 01801

1-800-884-1772 The revision author, Jerry Lozano, provides seminars and workshops on the topic of device drivers and other related subjects. For more information visit the web site:www.StarJourney.com.

Preface
   What You Should Already Know
   What’s Covered
   What’s Not
   About the Sample Code
   History of this Book
   Training and Consulting Services

Acknowledgments

1. Introduction to Windows 2000 Drivers
   Overall System Architecture
   Kernel-Mode I/O Components
   Special Driver Architectures
   Summary

2. The Hardware Environment
   Hardware Basics
   Buses and Windows 2000
   Hints for Working with Hardware
   Summary

3. Kernel-Mode I/O Processing
   How Kernel-Mode Code Executes
   Use of Interrupt Priorities by Windows 2000
   Deferred Procedure Calls (DPCs)
   Access to User Buffers
   Structure of a Kernel-Mode Driver
   I/O Processing Sequence
   Summary

4. Drivers and Kernel-Mode Objects
   Data Objects and Windows 2000
   I/O Request Packets (IRPs)
   Driver Objects
   Device Objects and Device Extensions
   Controller Objects and Controller Extensions
   Adapter Objects
   Interrupt Objects
   Summary

5. General Development Issues
   Driver Design Strategies
   Coding Conventions and Techniques
   Driver Memory Allocation
   Unicode Strings
   Interrupt Synchronization
   Synchronizing Multiple CPUs
   Linked Lists
   Summary

6. Initialization and Cleanup Routines
   Writing a DriverEntry Routine
   Code Example: Driver Initialization
   Writing Reinitialize Routines
   Writing an Unload Routine
   Code Example: Driver Unload
   Writing Shutdown Routines
   Testing the Driver
   Summary

7. Driver Dispatch Routines
   Announcing Driver Dispatch Routines
   Writing Driver Dispatch Routines
   Processing Read and Write Requests
   Code Example: A Loopback Device
   Extending the Dispatch Interface
   Testing Driver Dispatch Routines
   Summary

8. Interrupt-Driven I/O
   How Programmed I/O Works
   Driver Initialization and Cleanup
   Writing a Start I/O Routine
   Writing an Interrupt Service Routine (ISR)
   Writing a DpcForIsr Routine
   Some Hardware: The Parallel Port
   Code Example: Parallel Port Loopback Driver
   Testing the Parallel Port Loopback Driver
   Summary

9. Hardware Initialization
   The Plug and Play Architecture: A Brief History
   The Role of the Registry for Legacy Drivers
   Detecting Devices with Plug and Play
   The Role of Driver Layers in Plug and Play
   The New WDM IRP Dispatch Functions
   Device Enumeration
   Device Interfaces
   Code Example: A Simple Plug and Play Driver
   Summary

10. Power Management
   Hot Plug Devices
   OnNow Initiative
   Wake Requests
   Power Management Issues
   Summary

11. Timers
   Handling Device Timeouts
   Code Example: Catching Device Timeouts
   Managing Devices without Interrupts
   Code Example: A Timer-Based Driver
   Summary

12. DMA Drivers
   How DMA Works under Windows 2000
   Working with Adapter Objects
   Writing a Packet-Based Slave DMA Driver
   Code Example: A Packet-Based Slave DMA Driver
   Writing a Packet-Based Bus Master DMA Driver
   Writing a Common Buffer Slave DMA Driver
   Writing a Common Buffer Bus Master DMA Driver
   Summary

13. Windows Management and Instrumentation
   WMI: The Industry Picture
   The WMI Architecture
   WMI Summary
   Conventional Driver Event Logging
   Summary

14. System Threads
   Definition and Use of System Threads
   Thread Synchronization
   Using Dispatcher Objects
   Code Example: A Thread-Based Driver
   Summary

15. Layered Drivers
   An Overview of Intermediate Drivers
   Writing Layered Drivers
   Writing I/O Completion Routines
   Allocating Additional IRPs
   Writing Filter Drivers
   Code Example: A Filter Driver
   Writing Tightly Coupled Drivers
   Summary

16. Driver Installation
   Installation of a Driver
   Auto-Install Using INF Files
   Using a Driver INF File
   Controlling Driver Load Sequence
   Digital Signing of a Driver
   Summary

17. Testing and Debugging Drivers
   Guidelines for Driver Testing
   Why Drivers Fail
   Reading Crash Screens
   An Overview of WinDbg
   Analyzing a Crash Dump
   Interactive Debugging
   Writing WinDbg Extensions
   Code Example: A WinDbg Extension
   Miscellaneous Debugging Techniques
   Summary

A. The Driver Debug Environment
   Hardware and Software Requirements
   Debug Symbol Files
   Enabling Crash Dumps on the Target System
   Enabling the Target System’s Debug Client

B. Bugcheck Codes

C. Building Drivers
   The Build Utility
   Using Visual Studio to Build Drivers

Bibliography

Preface

This book explains how to write, install, and debug device drivers for Windows 2000. It is intended to be a companion to the Microsoft DDK documentation and software.

Windows 2000 represents a major improvement to previous versions of Windows NT. Device drivers for Windows 2000 may be designed for the new Windows Driver Model (WDM) architecture. If so, the driver will be source compatible with Windows 98. This book covers the new WDM specification.

This book will also prove useful to those studying the internals of Windows 2000, particularly the I/O subsystem and related components.What You Should Already Know

All instruction assumes a base knowledge level. First, the reader should be familiar with Windows 2000 administration—security and setup, for example. Since experimentation with kernel-mode code can (and will) cause system problems, the reader should be prepared and able to restore a chaotic OS.

Second, the reader should be competent in the C programming language and somewhat familiar with C++. Only a little C++ is used in this book, and then only for the purpose of simplifying tedious code.

Third, experience with Win32 user-mode programming is useful. Knowing how user-mode code drives I/O devices is useful in designing and testing device driver code. The test code for the examples in this book rely on the console subsystem model for Windows. To review this topic, the reader is referred to the Win32 Programmers Reference, particularly the chapters on I/O primitives (CreateFile, ReadFile, WriteFile, and DeviceIoControl). The bibliography lists other references for this topic.

Finally, while no specific prior knowledge of hardware or device driver software design is assumed, it would be useful if the reader had experience with some aspect of low-level device interfacing. For example, knowledge of writing device drivers for a Unix system will prove quite useful when reading this book.What’s Covered

The focus of this book is to first explain the architecture of the hardware, environment, and device driver, and then to explain the details of writing code.

Chapters are grouped within this book as follows:

Chapters 1-5: The first five chapters of this book cover the foundation of what’s needed to write a device driver. This includes coverage of the Windows 2000 architecture, hardware terminology and bus basics, and an in-depth view of the Windows 2000 I/O Manager and related services.

Chapters 6-13: The next eight chapters form the nucleus of this book. The chapters cover everything from the mechanics of building a driver to the specifics of instrumenting a driver to log errors and other events.

Chapters 14-15: These two chapters deal with somewhat more advanced topics within device driver construction. This includes the use of system threads, layering, filtering, and utilizing driver classes.

Chapters 16-17: The final chapters deal with the practical but necessary details of driver installation and debugging. The use of Windows 2000 INF files for «automatic» installation of a plug and play device driver is covered (as well as manual installation for legacy devices). The use of WinDbg is covered in sufficient detail so that the programmer can actually perform interactive debugging.

Appendices: The appendices cover reference information needed for driver development. The mechanics of Windows 2000 symbol file installation, bugcheck codes, and so on are listed. What’s Not

Since the purpose of this book is to cover driver development from «the ground up,» some specific topics fall outside its scope. Specifically, the list of topics not covered includes

File system drivers

Currently, the construction of a full Windows 2000 Installable File System requires the acquisition of the Microsoft IFS kit. The bibliography of this book points to one source for more information on this topic. Potential users of the IFS kit will benefit greatly from this book, as the material covered is essential prerequisite knowledge.

Device-specific driver information

The construction of NIC (Network Interface Card), SCSI, video (including capture devices), printers, and multimedia drivers is not specifically covered in this book. Chapter 1 discusses the architectural implications of such drivers, but even individual chapters on each of these driver types would seriously shortchange the requisite knowledge.

Virtual DOS device drivers

The current wave of driver development is toward the WDM 32-bit model. Legacy 16-bit VDDs are no longer of interest.About the Sample Code

Most chapters in this book include one or more sample drivers. All code is included on the accompanying CD. Samples for each chapter are in separate subdirectories on the CD, so installation of individual projects is straightforward.

The CD also includes a device driver application wizard for Microsoft Visual C++ version 6. This wizard configures the build environment so that code can be written, compiled, and linked within Visual Studio.

Platform dependencies:

The sample code included with this book has been targeted and tested on Intel platforms only. Since it appears that the last non-Intel platform (Alpha) was dropped from the final release of Windows 2000, this should come as no surprise. Be advised, however, that Windows 2000 is intrinsically a platform-independent OS. It is a straightforward process to port the OS to many modern hardware sets. Driver writers should consider designs that take advantage of the Windows 2000 abstractions that permit source compatibility with non-Intel platforms.

To build and run the examples:

Besides the Microsoft DDK (Device Driver Kit) (which is available on an MSDN subscription or, at present, free for download from the Microsoft web site at microsoft/DDK), the sample code assumes that Microsoft Visual C++ is installed. The device driver application wizard was built for Visual Studio version 6. Obviously, with some effort the sample code can be built using other vendors’ compilers.

Of course, an installed version of Windows 2000 (Professional, Server, or Enterprise) is required. For interactive debugging using WinDbg, a second host platform is required.History of this Book

The first version of this book was written by Art Baker, entitled The Windows NT Device Driver Book. By any account, the book was required reading for any NT driver author. The Microsoft driver model is a continuously moving target. As such, recently introduced books on this subject provided more and up-to-date information. The goal of this revision of the book is to carry forward the goals, style, and clarity of Art’s original work while updating the material with the very latest information available from Microsoft.

If you are a previous reader of the original version of this book, I hope you will find this version just as useful. I have attempted to provide accurate, concise, and clear information on the subject of Windows 2000 device drivers. While I have relied heavily on Art’s original work, any errors present in this book are entirely mine.Training and Consulting Services

The material in this book is based on training and consulting performed for various companies within the industry.

The subject matter of this book is presented exclusively by UCI in the format of a five-day instructor-lead lecture/lab course. The course is available as public or on site classes. UCI provides comprehensive training in high-end programming, web development and administration, databases, and system technologies.

For more information please visit the UCI web site at ucitraining or use the address information below:

UCI Corporation
4 Constitution Way
Suite G
Woburn, MA 01801

1-800-884-1772

The revision author, Jerry Lozano, provides seminars and workshops on the topic of device drivers and other related subjects. For more information visit the web site: StarJourney

• The #1 Windows device driver book—fully updated for Windows 2000!
• Step-by-step planning, implementation, testing, debugging, installation, and distribution
• Complete coverage of the new Windows Driver Model (WDM)
• Practical debugging and interactive troubleshooting
• CD-ROM: Exclusive tools for streamlining driver development, plus extensive C/C++ sample driver library!
• Windows Driver Model (WDM) for Windows 2000 and 98—in depth!
• Building drivers that support Plug-and-Play and Power Management
• Windows Management Instrumentation: logging device errors and events—and interpreting them
• Constructing safe reentrant driver code
• Handling time-out conditions safely and effectively
• Advanced techniques: kernel-mode threads, layered drivers, and more
• Start-to-finish debugging and troubleshooting techniques

Foreword by Andrew Scoppa, UCI Corporation

The #1 book on Windows driver development—totally updated for Windows 2000!

With The Windows 2000 Device Driver Book, any experienced Windows programmer can master driver development start to finish: planning, implementation, testing, debugging, installation, and distribution. Totally updated to reflect Microsoft’s Windows Driver Model (WDM) for Windows 2000 and 98, this programming bestseller covers everything from architecture to tools, and includes a powerhouse library of exclusive tools and code for streamlining any driver development project.

You’ll start with a high-level overview of WDM components and then move quickly into the details of the development environment and driver installation. Next, master the Windows 2000 I/O Manager, its data structures, and its interaction with drivers. Using extensive practical examples, you’ll implement Plug-and-Play and Power Management; construct safe reentrant driver code; use Windows Management Instrumentation to log errors and events, and more.

The book covers today’s most advanced Windows driver development techniques and provides extensive debugging guidance, including crash dump analysis using WinDbg; lists of common bugcheck codes, meanings, and probable causes; and much more.

About the CD-ROM

Bonus CD-ROM contains powerful resources for streamlining device driver development!

• An exclusive Device Driver AppWizard that works with Visual Studio to instantly create your driver’s framework
• A library of complete sample drivers
• C++ classes to jumpstart any project-including a Unicode string handling class that eliminates tedious, repetitive code
• An exclusive Driver Installation Utility to simplify initial testing

UCI

UCI Software Training Centers specializes in high-end developer, systems, and Internet Training on Microsoft products and technologies. For more information about training in this topic and others, UCI can be reached at 800-884-1772, or on the Web at www.ucitraining.com

Author: Art Baker, Jerry Lozano

Format: CHM

Category: Technical

Tag: Windows

Posted on 2007-06-22, updated at 2009-01-20. By anonymous.

Search More…

The Windows 2000 Device Driver Book: A Guide for Programmers

Related Archive Books

Archive Books related to «The Windows 2000 Device Driver Book: A Guide for Programmers»:

Links

Download this book

Related Books

Comments

No comments for «The Windows 2000 Device Driver Book: A Guide for Programmers».

Add Your Comments