Getting Started

Getting Started

The Microsoft^® Windows^® 2000 Driver Development Kit (DDK) provides a development environment for the creation of Windows 2000 and WDM drivers. The DDK provides additional driver-specific headers, libraries, sources, tools, and documentation that are used to develop drivers for Windows 2000.

Note: This release of the Windows 2000 DDK must be used to develop drivers for corresponding release of the Windows 2000 operating system, and WDM drivers. You cannot use this DDK to create drivers for earlier versions of Windows 2000 or for Windows NT^® 4.0. In addition, driver development requires Microsoft Visual C++^® 5.x or 6.x, Professional or Enterprise edition. Microsoft Visual C++ Academic or Standard editions are not supported.

Legal Information

This document is for informational purposes only. MICROSOFT MAKES NO WARRANTIES, EXPRESS OR IMPLIED, IN THIS DOCUMENT.

Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.

Information in this document is subject to change without notice and is provided for informational purposes only. The entire risk of the use or results of the use of this document remains with the user, and Microsoft Corporation makes no warranties, either express or implied. The names of companies, products, people, characters, and/or data mentioned herein are fictitious and are in no way intended to represent any real individual, company, product, or event, unless otherwise noted. Complying with all applicable copyright laws is the responsibility of the user. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Microsoft Corporation.

ActiveSync, ActiveX, BackOffice, Direct3D, DirectAnimation, DirectDraw, DirectInput, DirectMusic, DirectPlay, DirectShow, DirectSound, DirectX, MSDN, Microsoft, MS-DOS, Outlook, Visual C++, Win32, Windows, and Windows NT are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Other product and company names mentioned herein may be the trademarks of their respective owners.

This document presents an overview of the DDK and provides essential installation information for this driver development kit. Before installing the DDK, read through this document to determine whether to install optional DDK components and how to set up your systems for a trouble-free installation. This document contains the following topics:

Installing the DDK

To install the Microsoft^® Windows^® 2000 DDK, you must be able to access a CD-ROM drive from Windows 2000, either locally or through a network, or you must have Internet access to the Driver Development Kits Web site.

System Requirements

To use this DDK on your driver-development machine, you will need:

Microsoft^® Windows NT^® 4.0, Windows 2000, or Windows^® 98.

Microsoft Visual C++^® 5.0 or 6.0, Professional or Enterprise edition. Microsoft Visual C++ Academic or Standard editions are not supported. Additionally, you must install the latest Visual C++ service pack that is available for the version you are using. See the Release Notes for more information. Setup.exe will copy the Release Notes file from the CD to the root directory of the DDK installation. Please see the root directory of the CD, or the installation, for Release Notes (relnote.htm) and late-breaking news.

CD-ROM drive or Internet access.
This DDK is available on CD-ROM from MSDN™ or by download from the Driver Development Kits Web page. For a list of CD-ROM drives, computer systems, SCSI adapters, and other peripherals that are compatible with Windows 2000, see the Hardware Compatibility List, available on the Web at http://www.microsoft.com/hwtest.

At least 64MB RAM. 128MB of RAM or more is recommended.

Up to 200MB hard-disk space for a full installation. Significantly more space may be required to compile all samples; up to 750MB may be required.

To use this DDK on your driver-testing machine, you will need:

Microsoft Windows 2000.
At least 64MB RAM if you are running a free or retail build of Windows 2000; 64MB RAM if running a checked build. In some cases, checked builds may require 128MB of RAM, depending on the particular drivers loaded on the machine.
A second machine that is capable of running Windows 2000 for kernel debugging of your under-development drivers. This machine can be your driver-development system if desired.

If you are developing WDM Drivers for the Win9x platform, you will need to consult the Windows 98 DDK for information on debugging on that platform.

DDK Installation

The Windows^® 2000 DDK Setup program installs the DDK tools, headers, libraries, and source files that are necessary for driver development.

To install this DDK, you must be able to access the CD-ROM drive from your Windows 2000 installation, either locally or over a network, or you must have access to the Driver Development Kits Web page.

Note: You must have Administrator privileges to correctly install the 2000 DDK.

Note: Do not install this DDK over previous versions of this or any other DDK. Improper installation of the DDK can cause the use of old and incorrect files, which will lead to unreliable results in any drivers you develop.

Perform the following steps:

Execute the setup.exe file from the CD-ROM or execute ntddk.exe after downloading it from the Driver Development Kits Web page.
Click the Next button to install the Windows 2000 DDK.
Read and accept the Software License Agreement.
Choose the components that you would like to install.

The setenv.bat batch file sets the necessary environment variables to build free or checked driver versions. To run setenv.bat, start either a free or checked console window from the Programs/Development Kits/Windows 2000 DDK menu. Drivers can then be built by running the BUILD utility. Invoking build -cZ at the command-line prompt compiles and links all drivers in the source tree of the current subdirectory.

Note: The build environment is set from the icons for a free or checked build. If the build environment is not created correctly, you can manually set the build environment by going to the %NTDDK%\bin directory and typing setenv.bat DDK_DIRECTORY free/checked, where DDK_DIRECTORY is the full path of the location of the Windows 2000 DDK.

Note: The Windows 2000 DDK uses the current VCVars.bat to create part of the build environment. This includes setting your current path to include the installation source of Visual C++. You may want to delete the line vcsource=<Install Path> from %DDKRoot%\Bin\DDKVars.bat if you installed the DDK over a network. Doing so may reduce the time required to build the drivers.

Verifying DDK Installation

Start either the free or checked build environment by choosing the appropriate icon from the Windows® 2000 DDK menu.

Verify your installation of the Windows 2000 DDK by running build -cZ from the \destination\src directory to build the complete set of installed driver sources. This can take more than 30 minutes to complete, depending on which DDK components are installed.

For more detailed information about the BUILD utility and the DDK environments, see the Driver Writer's Guide in the DDK online Help.

Compiling Your Driver for Win64

Also included in this release of the DDK is a partial 64-bit build environment for the upcoming Microsoft^® Win64™ systems.

To compile your driver with the 64-bit compiler, choose the Checked 64 Bit Build Environment icon in Programs\Development Kits\Windows 2000 DDK. This will open the correct environment for the 64-bit compiler.

Please see Getting Ready for 64-bit Windows for more detailed information on required code changes for 64-bit compilation.

Note: The compiler is included so that you can evaluate your 64-bit code syntax.

Note: In this release, the compiler back-end and linker are not included.

Driver Logo and Distribution Program

Windows Hardware Quality Labs (WHQL) provides fee-based compatibility testing services for driver and hardware developers. WHQL testing is extensive and comprehensive to assure a high level of compatibility between tested hardware, drivers, and Microsoft® operating systems, including both Windows^® 2000 and Windows^® 98.

WHQL customers benefit in the following ways:

Devices approved by WHQL are included in the Hardware Compatibility List, which is periodically updated on the Web at http://www.microsoft.com/hwtest.
- This list is used by many Microsoft customers to make purchasing decisions. It also is used by Microsoft support engineers while assisting customers with compatibility issues.
If your device and its drivers pass WHQL testing for compatibility with specific Windows operating systems, you are eligible to use the appropriate logos in promotional materials for that device. For example, WHQL logos include "Windows 2000 Compatible" and "Windows 98 Compatible."

Information on the Microsoft® Web Site

The Microsoft Driver Development Kit Web site at http://www.microsoft.com/ddk. This Web site provides information and resources for driver development, including:

The latest version of the Windows® 2000 DDK available for public download.
The latest documentation for the DDK, available for browsing online and for download.
News on new DDK developments.
NEW! Give us feedback on the DDK. On the Web page for each DDK, you'll find a link to the feedback form for that DDK. Please tell us what you think: use this to report bugs, request new features, and rate the DDK.
The latest information, updates, FAQ, and extended release notes available.

The Hardware Development Web Site at http://www.microsoft.com/hwdev provides connections to information from Microsoft to help with hardware and driver development. This Web site provides the following:

Driver development information for Plug and Play, power management, manageability, NDIS 5.0, WDM, and specific device classes such as audio and imaging.
Third-party driver development and training resources.
Advice from "Dr. Iver" on special driver topics such as Plug and Play, power management, and WDM.
Specifications for Plug and Play, power management, and other special topics.

MSDN™, the Microsoft Developers Network at http://www.microsoft.com/msdn, provides tools and information from Microsoft to help with software development. This information includes:

Downloads for service packs or patches for Microsoft development tools.
Up-to-date Platform SDK releases.
Access to user groups, chats, event information, the MSDN Library Online, and a host of products and technologies for developers.

The Microsoft^® DirectX^® Web site at http://www.microsoft.com/directx provides information for DirectX hardware and software developers, including:

Microsoft DirectX SDK download.
Connections to technical articles, support information, and news groups.

Late-Breaking News

For release notes and late-breaking news, please see the Release Notes file (relnote.htm). Setup.exe will copy the Release Notes file from the CD to the root directory of the DDK installation. Updates and information will continue to be posted to the Microsoft Driver Development Kit Web site at http://www.microsoft.com/ddk

Note:	You must have Administrator privileges to correctly install the 2000 DDK.
Note:	Do not install this DDK over previous versions of this or any other DDK. Improper installation of the DDK can cause the use of old and incorrect files, which will lead to unreliable results in any drivers you develop.