diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 20 | ||||
| -rw-r--r-- | utils/README.md | 43 | ||||
| -rw-r--r-- | utils/libnt_path_converter/README.md | 22 | ||||
| -rw-r--r-- | utils/libservice/README.md | 20 | ||||
| -rw-r--r-- | utils/libtest/README.md | 18 |
5 files changed, 52 insertions, 71 deletions
@@ -24,12 +24,14 @@ 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 "Trusted Root Certification Authorities" -store. +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 @@ -41,7 +43,7 @@ sign manually by passing the path to a .sys file to `sign.bat`: sign.bat C:\workspace\personal\windows7-drivers\bin\x64\Release\test.sys -### Building +### Building the drivers To build every driver under the "src/" directory, execute `build_drivers.bat`: @@ -72,8 +74,8 @@ source directory to `clean_driver.bat`: ## Installation -To install a driver as a Windows service, you can use the `sc` utility (`test` -is the name of the service): +To install a driver as a Windows service, you can use the `sc` utility. +For example, to install `test.sys` as a service with the name `test`, execute: sc create test type= kernel binPath= C:\workspace\personal\windows7-drivers\bin\x64\Release\test.sys @@ -123,17 +125,15 @@ Refer to your virtualization software's documentation for details. ## Utilities -A couple of usages examples are provided along with the drivers themselves. +A couple of usages examples are included along with the drivers. For details, see [Utilities]. +[Utilities]: utils/README.md + ## License This project, including all of the files and their contents, is licensed under the terms of the MIT License. See [LICENSE.txt] for details. - - -[Windows Driver Kit 7.1.0]: https://www.microsoft.com/en-us/download/details.aspx?id=11800 [LICENSE.txt]: LICENSE.txt -[Utilities]: utils/README.md diff --git a/utils/README.md b/utils/README.md index 7dcf890..eed64ab 100644 --- a/utils/README.md +++ b/utils/README.md @@ -1,30 +1,35 @@ # Driver utilities -A few usage examples are provided along with the drivers. -Those include: +A couple of usage examples are included along with the drivers. -* [libservice]: utilities to easily install/start/stop/uninstall drivers - (using Windows services), -* [libtest]: [test] driver usage examples, -* [libnt_path_converter]: [nt_path_converter] usage examples. +* [libservice]: Utilities to load/unload the drivers. +* [libtest]: [test] driver usage examples. +* [libnt_path_converter]: [nt_path_converter] driver usage examples. -## Building +[libservice]: libservice/README.md +[libtest]: libtest/README.md +[test]: ../src/test +[libnt_path_converter]: libnt_path_converter/README.md +[nt_path_converter]: ../src/nt_path_converter -To build the utilities: +## Building the utilities -1. generate the solution windows7_drivers_utils.sln using CMake, -2. build the solution using Visual Studio. +Create the build files using CMake and build using Visual Studio. -## License +For example, using Visual Studio 2013 Update 4 for Windows Desktop (targetting +x86): -This project is licensed under the terms of the MIT License. -See [License] for details. + > cd + C:\workspace\personal\build\windows7-drivers\utils + > cmake -G "Visual Studio 12 2013" C:\workspace\personal\windows7-drivers\utils + ... + > msbuild windows7_drivers_utils.sln + ... -[license]: ../README.md#license -[libservice]: libservice/README.md -[libtest]: libtest/README.md -[test]: ../src/test -[libnt_path_converter]: libnt_path_converter/README.md -[nt_path_converter]: ../src/nt_path_converter +## License + +See [License]. + +[License]: ../README.md#license diff --git a/utils/libnt_path_converter/README.md b/utils/libnt_path_converter/README.md index 43375e0..b3cde53 100644 --- a/utils/libnt_path_converter/README.md +++ b/utils/libnt_path_converter/README.md @@ -2,14 +2,9 @@ [nt_path_converter] driver usage examples. -## Library - -[nt_path_converter] driver's virtual device is wrapped into a separate library -`libnt_path_converter` using [libservice]. -`#include <libnt_path_converter/all.hpp>` and link with -`libnt_path_converter.lib` to use the library. +[nt_path_converter]: ../../src/nt_path_converter -## Utilities +## Usage ### convert_nt_path.exe @@ -22,15 +17,12 @@ For example: > convert_nt_path.exe \Device\HarddiskVolume2\Windows C:\Windows +[WinObj]: https://technet.microsoft.com/en-us/library/bb896657.aspx + ## See also -* [Building] +* [Building the utilities] * [License] - - -[building]: ../README.md#building -[license]: ../../README.md#license -[nt_path_converter]: ../../src/nt_path_converter -[libservice]: ../libservice/README.md -[WinObj]: https://technet.microsoft.com/en-us/library/bb896657.aspx +[Building the utilities]: ../README.md#building-the-utilities +[License]: ../../README.md#license diff --git a/utils/libservice/README.md b/utils/libservice/README.md index 22c9388..2727f31 100644 --- a/utils/libservice/README.md +++ b/utils/libservice/README.md @@ -1,14 +1,8 @@ -# Service management utilities +# Driver management utilities -Utilities to easily install/start/stop/uninstall drivers using Windows -services. +Utilities to load/unload the drivers. -## Library - -`#include <libservice/all.hpp>` and link with `libservice.lib` to use the -library. - -## Utilities +## Usage ### install_service.exe @@ -49,10 +43,8 @@ The same as ## See also -* [Building] +* [Building the utilities] * [License] - - -[building]: ../README.md#building -[license]: ../../README.md#license +[Building the utilities]: ../README.md#building-the-utilities +[License]: ../../README.md#license diff --git a/utils/libtest/README.md b/utils/libtest/README.md index 4992849..ddab9ce 100644 --- a/utils/libtest/README.md +++ b/utils/libtest/README.md @@ -2,13 +2,9 @@ [test] driver usage examples. -## Library - -[test] driver's virtual device is wrapped into a separate library `libtest` -using [libservice]. -`#include <libtest/all.hpp>` and link with `libtest.lib` to use the library. +[test]: ../../src/test -## Utilities +## Usage ### exchange_ints.exe @@ -29,12 +25,8 @@ For example: ## See also -* [Building] +* [Building the utilities] * [License] - - -[building]: ../README.md#building -[license]: ../../README.md#license -[test]: ../../src/test -[libservice]: ../libservice/README.md +[Building the utilities]: ../README.md#building-the-utilities +[License]: ../../README.md#license |