virtio-win

Steps required for building

1. Download Windows 11 21H2 EWDK ISO (https://go.microsoft.com/fwlink/?linkid=2202360) and mount it (let’s say to E:\). You can download the ISO to the host and connect it to the VM as CD-ROM.
2. Download and install WinFSP (https://github.com/billziss-gh/winfsp/releases/tag/v1.10) with “Core”, “Developer” and “Kernel Developer” features enabled.
3. Download and install CPDK 8.0 (https://www.microsoft.com/en-us/download/details.aspx?id=30688).
4. Download and install .NET Framework version 4.8 (https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net48-web-installer). Windows Server 2022 and Windows 11 don’t need it.
5. Open command-line and run E:\LaunchBuilEnv.cmd.
6. Change directory to kvm-guest-drivers-windows.
7. Run build_AllNoSdv.bat [Win8|Win8.1|Win10] depending on your Windows version. Choose Win10 for Windows Server 2022 and Windows 11.
8. Run Tools\signAll.bat to sign drivers. Loading of test-signed drivers must be enabled on your system (https://docs.microsoft.com/en-us/windows-hardware/drivers/install/the-testsigning-boot-configuration-option).
9. Find drivers/services in folders named Install inside driver folders.

Additional steps for driver development

1. Copy EWDK to a local directory for convenience

• copy entire content to local directory (for example c:\ewdk11): mkdir c:\ewdk11 && xcopy /e e:\* c:\ewdk11
• unmount and delete Windows 11 21H2 EWDK ISO file
• set EWDK11_DIR=<Copy_Of_EWDK 11>

1. CodeQL Windows Setup
   • mkdir C:\codeql-home
   • Navigate to the Github CodeQL Download Page
   • Download version 2.4.6 of the zip file if you are certifying a driver for the Windows Hardware Compatibility Program in 2021. For example for 64 bit Windows “codeql-win64.zip”.
   • Unzip the codeql folder in the zip file to C:\codeql-home\codeql\ directory.
   • Confirm that the CodeQL command works by displaying the help. C:\codeql-home\codeql\>codeql --help
2. Clone the repository to access the driver-specific queries
   • Navigate to the Microsoft CodeQL GitHub repository.
   • Clone the repository to download all CodeQL queries and query suites with driver-specific queries.

     C:\codeql-home\>git clone https://github.com/microsoft/Windows-Driver-Developer-Supplemental-Tools.git --recursive -b RELEASE_BRANCH
     

Replace RELEASE_BRANCH with the appropriate branch depending on the OS you are certifying for, per the following table:

Release	Branch to use
Windows Server 2022	WHCP_21H2
Windows 11	WHCP_21H2

Notes on Windows 11 21H2 EWDK

Windows 11 21H2 EWDK is the recommended environment for drivers build.

• At the moment of transition to EWDK, the drivers will be built using Windows 11 EWDK.
• Currently usage of Windows 11 EWDK is blocked by the following issues: the need to separate SDV build (all the drivers should have SDV logs), CodeQL analysis errors, and ARM64 build error.

Notes on the build batch

The building of drivers for the following operating systems is not supported by the batch build procedure:

• Windows XP / Server 2003
• Windows Vista / Server 2008
• Windows 7 / Server 2008R2

Note: latest tag that supports the building of drivers for legacy operating systems:

• https://github.com/virtio-win/kvm-guest-drivers-windows/releases/tag/08.03.2021-last-buldable-point-XP
• https://github.com/virtio-win/kvm-guest-drivers-windows/releases/tag/02.12.2021-last-buildable-point-Win7

Run buildAll.bat for complete build including SDV. Note that a SDV build takes long time.

Set VIRTIO_WIN_SDV_2022=1 to build DVL for system device drivers.