aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2017-04-27 21:07:39 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2017-04-27 21:07:39 +0300
commit7dc998207ba0b3c4a05504a191904137c6f1536e (patch)
tree05994f2bcbf993d6be63cbb00e383bb15d28db9a
parentREADME update (diff)
downloadwindows7-drivers-7dc998207ba0b3c4a05504a191904137c6f1536e.tar.gz
windows7-drivers-7dc998207ba0b3c4a05504a191904137c6f1536e.zip
move WDK-version-specific stuff out of root README
-rw-r--r--README.md73
-rw-r--r--km/build/wdk7.1/README.md81
-rw-r--r--km/build/wdk8.1update/README.md11
3 files changed, 99 insertions, 66 deletions
diff --git a/README.md b/README.md
index d9c9d3c..874c52b 100644
--- a/README.md
+++ b/README.md
@@ -9,70 +9,11 @@ running in the kernel mode.
Development
-----------
-### Prerequisites
+* [Using WDK 7.1.0]
+* [Using WDK 8.1 Update]
-The drivers are compiled using [Windows Driver Kit 7.1.0].
-Install the "Build Environments" distributed with the kit, launch the Command
-Prompt, and execute (to target x86):
-
- C:\WinDDK\7600.16385.1\bin\setenv.bat C:\WinDDK\7600.16385.1 fre WIN7 no_oacr
-
-or (to target x86-64):
-
- C:\WinDDK\7600.16385.1\bin\setenv.bat C:\WinDDK\7600.16385.1 fre x64 WIN7 no_oacr
-
-Then `cd` to the project's root directory and execute `setenv.bat`:
-
- setenv.bat
-
-[Windows Driver Kit 7.1.0]: https://www.microsoft.com/en-us/download/details.aspx?id=11800
-
-### Code signing
-
-The binaries are signed using the self-signed certificate issued by
-"windows7_drivers".
-The certificate must be stored in the current user's ROOT ("Trusted Root
-Certification Authorities") store.
-To generate such a certificate, execute `add_cert.bat`:
-
- add_cert.bat
-
-To verify it's there, you can use the `certmgr.msc` utility.
-
-The binaries are signed automatically after they are built, but you can also
-sign manually by passing the path to a .sys file to `sign.bat`:
-
- sign.bat C:\workspace\personal\windows7-drivers\bin\x64\Release\simple.sys
-
-### Building the drivers
-
-To build every driver under the "km/src/" directory, execute
-`build_drivers.bat`:
-
- build_drivers.bat
-
-To build a particular driver, pass the path to the driver's source directory to
-`build_driver.bat`:
-
- build_driver.bat C:\workspace\personal\windows7-drivers\km\src\simple
-
-Driver binaries are copied to the "bin/" directory under the project's root.
-
-### Cleaning up
-
-Cleaning up after building a driver includes deleting the log and object files
-produced during the build as well as purging the binaries from the "bin/"
-directory.
-
-To clean up after building every driver in the "km/src/" directory, execute
-`clean_drivers.bat`:
-
- clean_drivers.bat
-
-To clean up after building a particular driver, pass the path to the driver's
-source directory to `clean_driver.bat`:
-
- clean_driver.bat C:\workspace\personal\windows7-drivers\km\src\simple
+[Using WDK 7.1.0]: km/build/wdk7.1/README.md
+[Using WDK 8.1 Update]: km/build/wdk8.1update/README.md
Installation
------------
@@ -81,7 +22,7 @@ To install a driver as a Windows service, you can use the `sc` utility.
For example, to install `simple.sys` as a service with the name `simple`,
execute:
- sc create simple type= kernel binPath= C:\workspace\personal\windows7-drivers\bin\x64\Release\simple.sys
+ sc create simple type= kernel binPath= C:\workspace\personal\windows7-drivers\km\build\wdk7.1\bin\x64\Release\simple.sys
You can then load/unload the driver by starting/stopping the corresponding
service using the `net` utility.
@@ -117,8 +58,8 @@ To enable kernel debugging, you can use the `msconfig` utility (navigate to
Then restart your computer for the new settings to take effect.
If a driver is loaded on a physical machine, you can connect to the COM port
-specified in kernel debugging settings (#1 by default) with a proper cable
-and enter the kernel debugging mode in WinDbg via "File" -> "Kernel Debug...".
+specified in kernel debugging settings (#1 by default) with an actual cable and
+enter the kernel debugging mode in WinDbg via "File" -> "Kernel Debug...".
You might need to restart the debuggee machine a couple of times in order to
enter the kernel debugging mode.
diff --git a/km/build/wdk7.1/README.md b/km/build/wdk7.1/README.md
new file mode 100644
index 0000000..80ae6ee
--- /dev/null
+++ b/km/build/wdk7.1/README.md
@@ -0,0 +1,81 @@
+Building drivers
+================
+
+The drivers can be built using [Windows Driver Kit 7.1.0].
+
+[Windows Driver Kit 7.1.0]: https://www.microsoft.com/en-us/download/details.aspx?id=11800
+
+Prerequisites
+-------------
+
+Install the "Build Environments" distributed with the kit, fire up `cmd`, and
+execute (to target Windows 7/x86):
+
+ C:\WinDDK\7600.16385.1\bin\setenv.bat C:\WinDDK\7600.16385.1 fre WIN7 no_oacr
+
+or (to target Windows 7/x86-64):
+
+ C:\WinDDK\7600.16385.1\bin\setenv.bat C:\WinDDK\7600.16385.1 fre x64 WIN7 no_oacr
+
+Manually
+--------
+
+Navigate to "km/src/" and execute:
+
+ build.exe /cegwZ
+
+This should build every driver, generating the .sys files somewhere in the
+obj*something* directories in the respective drivers' directories.
+They are not signed though.
+
+Automatically
+-------------
+
+I developed a bunch of batch scripts to automatically build, sign and copy the
+.sys files to a predefined directory.
+To use them, execute `setenv.bat` (can be found in this directory).
+
+### Code signing
+
+The binaries are signed using a self-signed certificate issued by
+"windows7_drivers".
+This certificate must be stored in the current user's ROOT ("Trusted Root
+Certification Authorities") store.
+To generate such a certificate, execute `add_cert.bat`:
+
+ add_cert.bat
+
+To verify it's there, you can use the `certmgr.msc` utility.
+
+The binaries are signed automatically after they are built, but you can also
+sign manually by passing the path to a .sys file to `sign.bat`:
+
+ sign.bat C:\workspace\personal\windows7-drivers\km\build\wdk7.1\bin\x64\Release\simple.sys
+
+### Building the drivers
+
+To build every driver, execute `build_drivers.bat`:
+
+ build_drivers.bat
+
+To build a particular driver, pass the path to the driver's source directory to
+`build_driver.bat`:
+
+ build_driver.bat C:\workspace\personal\windows7-drivers\km\src\simple
+
+The binaries are copied to "bin/" (under this directory).
+
+### Cleaning up
+
+Cleaning up after building a driver includes deleting the log and object files
+produced during the build as well as purging the binaries from the "bin/"
+directory.
+
+To clean up after `build_drivers.bat`, execute `clean_drivers.bat`:
+
+ clean_drivers.bat
+
+To clean up after building a particular driver, pass the driver's source
+directory to `clean_driver.bat`:
+
+ clean_driver.bat C:\workspace\personal\windows7-drivers\km\src\simple
diff --git a/km/build/wdk8.1update/README.md b/km/build/wdk8.1update/README.md
new file mode 100644
index 0000000..4938dad
--- /dev/null
+++ b/km/build/wdk8.1update/README.md
@@ -0,0 +1,11 @@
+Building drivers
+================
+
+The drivers can be built using WDK 8.1.
+
+You can find the Visual Studio 2013 solution & project files required to build
+the drivers in this directory.
+Build the projects as if you were building regular Windows applications.
+
+These files were generated by Visual Studio 2013 Update 5 w/ Windows Driver Kit
+8.1 Update.