Merge pull request microsoft#834 - Update WDF samples to use DIRID=13…

… (Driver Store) ## Why is this change being made? [Driver package isolation](https://learn.microsoft.com/en-us/windows-hardware/drivers/develop/driver-isolation) is a requirement for Windows Drivers that makes driver packages more resilient to external changes, easier to update, and more straightforward to install. One of such requirements is to for driver to [run from the driver store](https://learn.microsoft.com/en-us/windows-hardware/drivers/develop/run-from-driver-store), which means to use `DIRID = 13` in INF file, `DestinationDirs` section and `ServiceBinary` directive. ## What changed? Update generic WDF samples to use DIRID = 13. Specifically, it touches the following sample folders: - general, toaster, usb, hid, input, serial, pofx, spb, wmi Note it does not touch areas that are owned by individual driver classes, e.g., network, storage, file system. This change does mean that the sample **won't work on older OS** (prior to Win10 version 1809) where DIRID 13 is not fully supported. To find the original sample, please look at https://github.com/microsoft/Windows-driver-samples/tree/win11-22h2.
NateD-MSFT · Jan 15, 2023 · 13092c6 · 13092c6
2 parents 8ff2c86 + 217e46c
commit 13092c6
Show file tree

Hide file tree

Showing 44 changed files with 50 additions and 39 deletions.
diff --git a/general/PLX9x5x/sys/pci9x5x.inx b/general/PLX9x5x/sys/pci9x5x.inx
diff --git a/general/echo/kmdf/driver/AutoSync/echo.inx b/general/echo/kmdf/driver/AutoSync/echo.inx
diff --git a/general/echo/kmdf/driver/DriverSync/echo_2.inx b/general/echo/kmdf/driver/DriverSync/echo_2.inx
diff --git a/general/echo/umdf2/driver/AutoSync/echoum.inx b/general/echo/umdf2/driver/AutoSync/echoum.inx
diff --git a/general/pcidrv/kmdf/genpci.inx b/general/pcidrv/kmdf/genpci.inx
diff --git a/general/toaster/toastDrv/kmdf/bus/dynamic/dynambus.inx b/general/toaster/toastDrv/kmdf/bus/dynamic/dynambus.inx
diff --git a/general/toaster/toastDrv/kmdf/bus/static/statbus.inx b/general/toaster/toastDrv/kmdf/bus/static/statbus.inx
diff --git a/general/toaster/toastDrv/kmdf/filter/filter.inx b/general/toaster/toastDrv/kmdf/filter/filter.inx
diff --git a/general/toaster/toastDrv/kmdf/func/featured/wdffeatured.inx b/general/toaster/toastDrv/kmdf/func/featured/wdffeatured.inx
diff --git a/general/toaster/toastDrv/kmdf/func/simple/wdfsimple.inx b/general/toaster/toastDrv/kmdf/func/simple/wdfsimple.inx
diff --git a/general/toaster/toastDrv/kmdf/toastmon/wdftoastmon.inx b/general/toaster/toastDrv/kmdf/toastmon/wdftoastmon.inx
diff --git a/general/toaster/toastpkg/inf/toastpkg.inf b/general/toaster/toastpkg/inf/toastpkg.inf
@@ -18,6 +18,9 @@
 ;    This is a mutlios INF file. Same INF file cab be used on
 ;    x86, ia64 and amd64 platforms.
 ;
+; Important:
+;    This INF depends on features for the Driver Store DIRIDs which are available starting Windows 10 1809
+;
 ;--*/
 [Version]
 Signature="$WINDOWS NT$"
@@ -28,15 +31,29 @@ DriverVer=09/21/2006,6.0.5736.1
 CatalogFile.NTx86  = tostx86.cat
 CatalogFile.NTIA64 = tostia64.cat
 CatalogFile.NTAMD64 = tstamd64.cat
+PnpLockdown = 1
 
 [DestinationDirs]
-DefaultDestDir = 12
+DefaultDestDir = 13
 CoInstaller_CopyFiles = 11
 
+[SourceDisksNames.x86]
+1 = %DiskId1%, toastpkg.tag,,\i386
+
+[SourceDisksNames.ia64]
+1 = %DiskId1%, toastpkg.tag,,\ia64
+
+[SourceDisksNames.amd64]
+1 = %DiskId1%, toastpkg.tag,,\amd64
+
+[SourceDisksFiles]
+toaster.sys  = 1,,
+tostrco2.dll = 1,,
+
 ; ================= Class section =====================
 
 [ClassInstall32]
-Addreg=ToasterClassReg     
+Addreg=ToasterClassReg
 CopyFiles=ToasterClassInstallerCopyFiles
 
 [ToasterClassReg]
@@ -82,9 +99,9 @@ AddService = toaster, %SPSVCINST_ASSOCSERVICE%, toaster_Service_Inst
 [toaster_Service_Inst]
 DisplayName    = %toaster.SVCDESC%
 ServiceType    = 1               ; SERVICE_KERNEL_DRIVER
-StartType      = 3               ; SERVICE_DEMAND_START 
+StartType      = 3               ; SERVICE_DEMAND_START
 ErrorControl   = 1               ; SERVICE_ERROR_NORMAL
-ServiceBinary  = %12%\toaster.sys
+ServiceBinary  = %13%\toaster.sys
 
 ;-------------- Coinstaller installation
 
@@ -103,19 +120,6 @@ HKR,,CoInstallers32,0x00010000,"tostrco2.dll,ToasterCoInstaller"
 ; located (so it can launch value-added setup programs).
 OriginalInfSourcePath = %1%
 
-[SourceDisksNames.x86]
-1 = %DiskId1%, toastpkg.tag,,\i386
-
-[SourceDisksNames.ia64]
-1 = %DiskId1%, toastpkg.tag,,\ia64
-
-[SourceDisksNames.amd64]
-1 = %DiskId1%, toastpkg.tag,,\amd64
-
-[SourceDisksFiles]
-toaster.sys  = 1,,
-tostrco2.dll = 1,,
-
 [Strings]
 SPSVCINST_ASSOCSERVICE= 0x00000002
 ProviderName = "TODO-Set-Provider"

diff --git a/general/toaster/toastpkg/toastcd/toastpkg.inf b/general/toaster/toastpkg/toastcd/toastpkg.inf
@@ -18,6 +18,9 @@
 ;    This is a mutlios INF file. Same INF file cab be used on
 ;    x86, ia64 and amd64 platforms.
 ;
+; Important:
+;    This INF depends on features for the Driver Store DIRIDs which are available starting Windows 10 1809
+;
 ;--*/
 [Version]
 Signature="$WINDOWS NT$"
@@ -28,15 +31,29 @@ DriverVer=09/21/2006,6.0.5736.1
 CatalogFile.NTx86  = tostx86.cat
 CatalogFile.NTIA64 = tostia64.cat
 CatalogFile.NTAMD64 = tstamd64.cat
+PnpLockdown = 1
 
 [DestinationDirs]
-DefaultDestDir = 12
+DefaultDestDir = 13
 CoInstaller_CopyFiles = 11
 
+[SourceDisksNames.x86]
+1 = %DiskId1%, toastpkg.tag,,\i386
+
+[SourceDisksNames.ia64]
+1 = %DiskId1%, toastpkg.tag,,\ia64
+
+[SourceDisksNames.amd64]
+1 = %DiskId1%, toastpkg.tag,,\amd64
+
+[SourceDisksFiles]
+toaster.sys  = 1,,
+tostrco2.dll = 1,,
+
 ; ================= Class section =====================
 
 [ClassInstall32]
-Addreg=ToasterClassReg     
+Addreg=ToasterClassReg
 CopyFiles=ToasterClassInstallerCopyFiles
 
 [ToasterClassReg]
@@ -82,9 +99,9 @@ AddService = toaster, %SPSVCINST_ASSOCSERVICE%, toaster_Service_Inst
 [toaster_Service_Inst]
 DisplayName    = %toaster.SVCDESC%
 ServiceType    = 1               ; SERVICE_KERNEL_DRIVER
-StartType      = 3               ; SERVICE_DEMAND_START 
+StartType      = 3               ; SERVICE_DEMAND_START
 ErrorControl   = 1               ; SERVICE_ERROR_NORMAL
-ServiceBinary  = %12%\toaster.sys
+ServiceBinary  = %13%\toaster.sys
 
 ;-------------- Coinstaller installation
 
@@ -103,19 +120,6 @@ HKR,,CoInstallers32,0x00010000,"tostrco2.dll,ToasterCoInstaller"
 ; located (so it can launch value-added setup programs).
 OriginalInfSourcePath = %1%
 
-[SourceDisksNames.x86]
-1 = %DiskId1%, toastpkg.tag,,\i386
-
-[SourceDisksNames.ia64]
-1 = %DiskId1%, toastpkg.tag,,\ia64
-
-[SourceDisksNames.amd64]
-1 = %DiskId1%, toastpkg.tag,,\amd64
-
-[SourceDisksFiles]
-toaster.sys  = 1,,
-tostrco2.dll = 1,,
-
 [Strings]
 SPSVCINST_ASSOCSERVICE= 0x00000002
 ProviderName = "TODO-Set-Provider"

diff --git a/general/toaster/umdf2/filter/generic/filterum.inx b/general/toaster/umdf2/filter/generic/filterum.inx
diff --git a/general/toaster/umdf2/func/featured/wdffeaturedum.inx b/general/toaster/umdf2/func/featured/wdffeaturedum.inx
diff --git a/general/toaster/umdf2/func/simple/wdfsimpleum.inx b/general/toaster/umdf2/func/simple/wdfsimpleum.inx
diff --git a/hid/firefly/driver/firefly.inx b/hid/firefly/driver/firefly.inx
diff --git a/hid/hidusbfx2/sys/hidusbfx2.inx b/hid/hidusbfx2/sys/hidusbfx2.inx
diff --git a/hid/vhidmini2/driver/kmdf/vhidmini.inx b/hid/vhidmini2/driver/kmdf/vhidmini.inx
diff --git a/hid/vhidmini2/driver/umdf2/VhidminiUm.inx b/hid/vhidmini2/driver/umdf2/VhidminiUm.inx
diff --git a/input/kbfiltr/sys/kbfiltr.inx b/input/kbfiltr/sys/kbfiltr.inx
diff --git a/input/moufiltr/moufiltr.inx b/input/moufiltr/moufiltr.inx
diff --git a/pofx/UMDF2/Driver/SingleComp/SingleComponentSingleStateUm.inx b/pofx/UMDF2/Driver/SingleComp/SingleComponentSingleStateUm.inx
diff --git a/pofx/WDF/Driver/MultiComp/driver/WdfMultiComp.inx b/pofx/WDF/Driver/MultiComp/driver/WdfMultiComp.inx
diff --git a/pofx/WDF/Driver/SingleComp/SingleComponentFStateSample.inx b/pofx/WDF/Driver/SingleComp/SingleComponentFStateSample.inx
diff --git a/serial/VirtualSerial2/ComPort/virtualserial2um.inx b/serial/VirtualSerial2/ComPort/virtualserial2um.inx
diff --git a/serial/VirtualSerial2/FakeModem/fakemodem2um.inx b/serial/VirtualSerial2/FakeModem/fakemodem2um.inx
diff --git a/serial/serial/serial.inx b/serial/serial/serial.inx
diff --git a/spb/SkeletonI2C/skeletoni2c.inx b/spb/SkeletonI2C/skeletoni2c.inx
diff --git a/spb/SpbTestTool/sys/spbtesttool.inx b/spb/SpbTestTool/sys/spbtesttool.inx
diff --git a/usb/UcmCxUcsi/UcmCxUcsi.inf b/usb/UcmCxUcsi/UcmCxUcsi.inf
diff --git a/usb/UcmTcpciCxClientSample/UcmTcpciCxClientSample.inf b/usb/UcmTcpciCxClientSample/UcmTcpciCxClientSample.inf
diff --git a/usb/UcmUcsiAcpiSample/UcmUcsiAcpiSample/UcmUcsiAcpiSample.inf b/usb/UcmUcsiAcpiSample/UcmUcsiAcpiSample/UcmUcsiAcpiSample.inf
@@ -9,25 +9,28 @@
 ;
 ;     INF for installing the UCM-UCSI ACPI client driver.
 ;
+; Important:
+;    This INF depends on features for the Driver Store DIRIDs which are available starting Windows 10 1809
+;
 
 [Version]
 Signature = "$WINDOWS NT$"
 Class = UCM
 ClassGuid = {e6f1aa1c-7f3b-4473-b2e8-c97d8ac71d53}
 Provider = %ProviderName%
-PnpLockdown = 1
 DriverVer = 06/21/2006,10.0.17741.1000
 CatalogFile = UcmUcsiAcpiSample.cat
+PnpLockdown = 1
+
+[DestinationDirs]
+DefaultDestDir = 13
 
 [SourceDisksNames]
 3426 = windows cd
 
 [SourceDisksFiles]
 UcmUcsiAcpiSample.sys = 3426
 
-[DestinationDirs]
-DefaultDestDir = 12
-
 [Manufacturer]
 %ProviderName% = UcmUcsiAcpiSample, NT$ARCH$
 
@@ -49,7 +52,7 @@ DisplayName = %UcmUcsiAcpiSample.ServiceName%
 ServiceType = 1
 StartType = 3
 ErrorControl = 1
-ServiceBinary = %12%\UcmUcsiAcpiSample.sys
+ServiceBinary = %13%\UcmUcsiAcpiSample.sys
 Dependencies = UcmUcsiCx
 
 [Strings]

diff --git a/usb/kmdf_enumswitches/sys/kmdf_enumswitches.inx b/usb/kmdf_enumswitches/sys/kmdf_enumswitches.inx
diff --git a/usb/kmdf_fx2/driver/osrusbfx2.inx b/usb/kmdf_fx2/driver/osrusbfx2.inx
diff --git a/usb/ufxclientsample/UfxClientSample.inx b/usb/ufxclientsample/UfxClientSample.inx
diff --git a/usb/umdf2_fx2/driver/osrusbfx2um.inx b/usb/umdf2_fx2/driver/osrusbfx2um.inx
diff --git a/usb/usbsamp/sys/driver/usbsamp.inx b/usb/usbsamp/sys/driver/usbsamp.inx
diff --git a/usb/wdf_osrfx2_lab/kmdf/step1/osrusbfx2.inx b/usb/wdf_osrfx2_lab/kmdf/step1/osrusbfx2.inx
diff --git a/usb/wdf_osrfx2_lab/kmdf/step2/osrusbfx2.inx b/usb/wdf_osrfx2_lab/kmdf/step2/osrusbfx2.inx
diff --git a/usb/wdf_osrfx2_lab/kmdf/step3/osrusbfx2.inx b/usb/wdf_osrfx2_lab/kmdf/step3/osrusbfx2.inx
diff --git a/usb/wdf_osrfx2_lab/kmdf/step4/osrusbfx2.inx b/usb/wdf_osrfx2_lab/kmdf/step4/osrusbfx2.inx
diff --git a/usb/wdf_osrfx2_lab/kmdf/step5/osrusbfx2.inx b/usb/wdf_osrfx2_lab/kmdf/step5/osrusbfx2.inx
diff --git a/wmi/wmisamp/wmisamp.inx b/wmi/wmisamp/wmisamp.inx