Coming to a Seminar? Don’t Forget Your Laptop!
Last updated: 18 October 2018 (to reflect WDK 1809 and VS 15.8)
When you attend an OSR seminar that includes lab exercises involving driver development, you’ll need to bring a pre-configured laptop with you to do the labs.
The laptop setup requirements can vary depending on the particular class you’ll be attending. So please make sure to check with the OSR Seminar Team to determine the setup requirements that apply to your specific seminar.
This page describes the general laptop setup requirements, and are primarily designed for our WDF Core Concepts seminar. If you’ll be attending a different seminar, the requirements might be different. Check with the OSR Seminar Team well before the start of your seminar so you know what you’ll need.
We’re also not as strict about requirements for more advanced seminars as we are for the more introductory level seminars. For example, if you’re attending our WDF II (Advanced Implementation Concepts) seminar we still recommend you use the standard setup. But given that if you’re attending this seminar you’re an experienced WDF developer, we assume you know what you’re doing and we’re happy to have you use whatever development environment and tools you prefer. The only caveat (and it’s a significant one) is that our instructional team will not be able to help with anything other than our standard setup. So, if you need help debugging a problem and you’re using the Windows Enterprise WDK, building from the command line, editing with vim, and trying to debug your driver running on VirtualBox… you’re basically on your own to make all that stuff work during class.
Standard Laptop Setup Requirements
Each student must bring a laptop running Windows 7 SP1 or later (any recent, supported, version of Windows 10 is preferred) with the latest Windows Updates and with working Internet access (either WiFi or hardwired is fine) and at least one available USB 2.0 port (for the USB exercise). We recommend a system with at least 4GB of memory and 60GB of free disk space.
While almost everyone’s laptop configurations work without any problem, we’ve occasionally seen laptops configured by Corporate IT departments with “security” software (network proxies, remote management agents, document management and tracking, access control, and the like) that have a variety of problems during the seminar. Some network proxies, for example, can make it impossible for the debugger (WinDbg) to download symbols that you’ll need from the Microsoft symbol server. Bottom line: If you have a choice, keep it simple. A laptop that’s not domain joined and is not “managed” by your employer’s IT department is usually best.
In addition to the base Windows installation, you will need the following software installed and tested on your system:
- Microsoft Visual Studio 2017 with Update 8 or later, the Windows 10 Software Development Kit, and the WDK for Windows 10 Version 1809. The links and complete installation instructions can be found at https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit. They look like this:
Please, read and follow the instructions carefully, especially noting the fact that the Software Development Kit (SDK) needs to be installed as part of VS installation. You must use Visual Studio 2017 Update 8 — the Visual Studio version number is V15.8.x — or later with the 1809 WDK for driver development. If you’re installing Visual Studio specifically for this class, we recommend you install Visual Studio Professional. If you already have VS 2017 Update 8 or later installed on your laptop and working with the WDK for Windows Version 1809… that will work just fine. You don’t need to reinstall anything just for the class.
- VMware Workstation Player 12.0 (or later) – This software is available from http://www.vmware.com/products/player. If you or your company doesn’t already have a license and you don’t qualify for the “free trial” of this product, you’re responsible for the retail license cost of $149 for this product (which is not included in the cost of your seminar). The VMware installation on your laptop will host a Windows 10 x64 virtual machine provided by OSR that will be used as the target system on which to test your drivers during class. VMware Workstation Pro 12.0 (or later) may be used in place of the VMware Workstation Player. In fact, if you’ll continue to do driver development using VMware after your seminar, OSR recommends you select Workstation Pro due to its increased functionality and flexibility over Player. But either version will work equally well during your seminar. The VMware VM that OSR provides for this class is simply a client VM image running Windows 10 – nothing else is installed in this VM. Please be aware that the names of the VMware products (that is “Player” and “Workstation Pro”) have changed several times over the past few years. The terminology above reflects the names that were current as of VMware V12. Contact the OSR seminar team if you have any questions about which VMware product you need to install.
Please be sure to test your installation of Visual Studio 2017 Update 8 or later and the Windows 10 WDK V1809, and the VMware product of your choice thoroughly before class begins. Detailed instructions for testing are provided below.
If it is not possible for you to provide a suitable laptop, or you have ANY questions regarding the required configuration, please contact our seminar team: seminars at osr.com.
Have Your Laptop Ready and Tested Before Class Starts
We know you’ll be super-busy at work before you leave for your seminar. But, do yourself a favor: Reserve an afternoon before you leave for your seminar to install the required software on your laptop, and to test that software.
If you leave the installation, configuration, and testing until you get to your seminar location, the chances are greater that something will go wrong that will be hard to fix. Internet connections at hotels aren’t always the greatest, right? Not to mention that we promise you that you’ll be tired after the first day of your seminar (the first day is almost always 100% lecture).
How to Test Your Laptop Setup
If you’re already familiar with Windows driver development using Visual Studio and VMware, you know what to do to test your installation to make sure everything is properly configured and working. If you’re new to Windows driver development, here are some steps that you can take to test your installation to be sure you’re ready to go for your seminar’s first lab session:
- Basic Validation: Start Visual Studio. From the VS “File” menu select “New” and then “Project”. A “New Project” dialog should appear and under “Installed” and “Visual C++” should be an entry named “Windows Drivers” with several types of sub projects under it. If this is what you see, “Cancel” out of the dialog and proceed to Step 2. Otherwise check and re-check your VS and WDK installation before you do anything else. If you continue to have problems, contact the seminar team by email.
- Check the Debugger: Ensure that the Windows Debugger (WinDbg) is installed on your development system and that you can start it. You should find windbg.exe in the directory %ProgramFiles%\Windows Kits\10\Debuggers\x86\ — You might want to put a short-cut in your tool tray to the file in this directory. Note that depending on how you installed the SDK, you may also have an entry for WinDbg in your Start screen. This will point to the version installed by the SDK.
- Build a Test Driver: The final test for Visual Studio is to build a sample driver using the WDK. For this test, you’ll build one of the starter “template” WDF driver projects. If you won’t be attending a WDF seminar, don’t worry. The goal here is just to test that Visual Studio and the WDK are installed and working. If you can build one type of driver, you’ll be able to build any type of driver we’ll be creating in class.For this test once again start Visual Studio. And, once again, from the VS “File” menu select “New” and then “Project”. A “New Project” dialog should appear and under “Templates” and “Visual C++” should be an entry named “Windows Driver” with several types of sub projects under it. Select “Windows Driver” on the left, and then “Kernel Mode Driver (WDF)” in the center pane, like you see below:Ensure that you have access to the path in the “Location:” box (if not, adjust properly). Click the “OK” button. Wait for the template project to be generated, as shown by the lower left side of the Visual Studio status bar:Once the project has been successfully created, ensure “Debug” and “x64” are selected as the Solution Configuration and Solution Platform, respectively. Then, right click the solution and select “Build Solution” from the pop-up dialog:Within a few seconds, the build should complete and the Visual Studio output window should indicate that the build is successful:If the build succeeds, you know that your laptop configuration of Visual Studio and the Windows Driver kit is ready for your seminar! Next, test your VMware installation. One problem that can arise is you can get “unresolved external symbol” errors when you build your driver. If you do, this is almost certain due to a bug in the interactions between VS 2017 15.8.x and the WDK that we wrote about most recently here. Follow the work-around shown in that link and you should be good to go.
- Test Your VMware Installation: If VMware installed without any errors, that only indicates that the installation is correct. You still have to make sure you can successfully start and run a virtual machine (VM). To test this, download and start a small VM of any operating system. We recommend something like the Tiny Core Linux VM that you can download from this link. Download the VM image (it’s a 12MB ZIP archive). Unzip the download (it’ll still be 12MB), and you’ll get a .OVA file. Then start the VMware product you’ll be using (either Player or Workstation), and open the downloaded OVA file the VMware “File… Open” dialog. This will decompress the OVA file and start it. The Tiny Core Linux VM boots in less than 5 seconds, even on a slow laptop.
VMware is particularly good about diagnosing incompatibilities and letting you know about any problems it finds. So, if you can successfully start the virtual machine, VMware works and you’re ready for your seminar!
If you have problems, check the steps carefully. If you can’t diagnose the problem on your own, contact the OSR Seminar Team and one of our engineers will try to help you.
Having Trouble? Can’t Run VMware? Other?
To make your life simple, we recommend you using a laptop that’s not domain joined and not subject to your employer’s remote management scheme (if there is one). By far, the majority of problems we see in class with people setting up laptops are due to their trying to do stuff to managed laptops that their employers make difficult. So, if you’re everyday laptop is company managed, you might consider bringing a separate, non domain-joined, test laptop.
If you’re running Windows 10 Creators Update (or later) on your laptop, or your laptop is connected to and managed by a domain, you might get a dialog box like the following when you try to start the test VM within VMware:
You will get a similar message even if you don’t have Device or Credential Guard enabled, but you have Hyper-V installed. VMware and Hyper-V cannot co-exist.
To use VMware, you’re going to have to disable Hyper-V on your system. The easiest way to do this is to just turn the Hyper-V feature OFF on your system. Don’t worry, you can enable it again at any time if you want to. Go to the “Turn Windows Features On or Off” dialog, and uncheck Hyper-V. The dialog is shown at the left.
Click OK and follow the instructions. You’ll have to reboot. When you do, Hyper-V will be disabled and you should be able to use VMware.
Note that instead of turning Hyper-V off as described here, it is sometimes possible to disable Hyper-V use using bcdedit. We do not recommend this approach, however, because (depending on your system configuration) Windows may just turn it on again.
Another reason folks have trouble running VMware is because Device Guard or Credential Guard are enabled on their laptops. Manually enabling and disabling these features can be challenging… but there’s an easy solution. To disable Windows Defender Credential Guard and Windows Defender Device Guard, download the the Windows Defender Device Guard and Credential Guard Hardware Readiness Tool. And run it as follows:
DG_Readiness.ps1 -Disable -AutoReboot
Whenever seminar attendees have had Device Guard or Credential Guard issues, we have been 100% successful in getting these features disabled with the above procedure.