feat(examples): lots of new examples

Thanks, StephanvanSchaik.

1 files changed, 98 insertions, 0 deletions

diff --git a/crates/windows-kernel-rs/examples/io_controls/src/lib.rs b/crates/windows-kernel-rs/examples/io_controls/src/lib.rs
new file mode 100644
index 0000000..15e59e9
--- /dev/null
+++ b/crates/windows-kernel-rs/examples/io_controls/src/lib.rs
@@ -0,0 +1,98 @@
+#![no_std]
+#![feature(lang_items, const_extern_fn)]
+#![deny(
+  warnings,
+  nonstandard_style,
+  unused,
+  future_incompatible,
+  rust_2018_idioms
+)]
+#![deny(clippy::all, clippy::nursery, clippy::pedantic)]
+
+use windows_kernel_rs::device::{
+  Completion, Device, DeviceDoFlags, DeviceFlags, DeviceOperations, DeviceType, RequestError};
+use windows_kernel_rs::request::IoControlRequest;
+use windows_kernel_rs::{kernel_module, println};
+use windows_kernel_rs::{Access, Driver, Error, KernelModule, RequiredAccess, SymbolicLink};
+
+struct MyDevice {
+  value: u32,
+}
+
+const IOCTL_PRINT_VALUE: u32 = 0x800;
+const IOCTL_READ_VALUE:  u32 = 0x801;
+const IOCTL_WRITE_VALUE: u32 = 0x802;
+
+impl MyDevice {
+  fn print_value(&mut self, _request: &IoControlRequest) -> Result<u32, Error> {
+    println!("value: {}", self.value);
+
+    Ok(0)
+  }
+
+  fn read_value(&mut self, request: &IoControlRequest) -> Result<u32, Error> {
+    let mut user_ptr = request.user_ptr();
+
+    user_ptr.write(&self.value)?;
+
+    Ok(core::mem::size_of::<u32>() as u32)
+  }
+
+  fn write_value(&mut self, request: &IoControlRequest) -> Result<u32, Error> {
+    let user_ptr = request.user_ptr();
+
+    self.value = user_ptr.read()?;
+
+    Ok(0)
+  }
+}
+
+impl DeviceOperations for MyDevice {
+  fn ioctl(&mut self, _device: &Device, request: IoControlRequest) -> Result<Completion, RequestError> {
+    let result = match request.function() {
+      (_, IOCTL_PRINT_VALUE) =>
+        self.print_value(&request),
+      (RequiredAccess::READ_DATA, IOCTL_READ_VALUE) =>
+        self.read_value(&request),
+      (RequiredAccess::WRITE_DATA, IOCTL_WRITE_VALUE) =>
+        self.write_value(&request),
+      _ => Err(Error::INVALID_PARAMETER),
+    };
+
+    match result {
+      Ok(size) => Ok(Completion::Complete(size, request.into())),
+      Err(e) => Err(RequestError(e, request.into())),
+    }
+  }
+}
+
+struct Module {
+  _device: Device,
+  _symbolic_link: SymbolicLink,
+}
+
+impl KernelModule for Module {
+  fn init(mut driver: Driver, _: &str) -> Result<Self, Error> {
+    let device = driver.create_device(
+      "\\Device\\Example",
+      DeviceType::Unknown,
+      DeviceFlags::SECURE_OPEN,
+      DeviceDoFlags::DO_BUFFERED_IO,
+      Access::NonExclusive,
+      MyDevice {
+        value: 0,
+      },
+    )?;
+    let symbolic_link = SymbolicLink::new("\\??\\Example", "\\Device\\Example")?;
+
+    Ok(Module {
+      _device: device,
+      _symbolic_link: symbolic_link,
+    })
+  }
+
+  fn cleanup(&mut self, _driver: Driver) {
+  }
+}
+
+kernel_module!(Module);