aboutsummaryrefslogtreecommitdiff
path: root/doc/src/km/device_object.rs.html
diff options
context:
space:
mode:
authorpravic <[email protected]>2016-04-12 18:12:52 +0300
committerpravic <[email protected]>2016-04-12 18:12:52 +0300
commit24af17846d14b290aa1d90e37e98c4cbe9e173e1 (patch)
treed68362060a430c72f19a46ec382f070cf0cbefe5 /doc/src/km/device_object.rs.html
parentadd index (diff)
downloadwinapi-kmd-rs-24af17846d14b290aa1d90e37e98c4cbe9e173e1.tar.xz
winapi-kmd-rs-24af17846d14b290aa1d90e37e98c4cbe9e173e1.zip
add winapi-km-rs docs
Diffstat (limited to 'doc/src/km/device_object.rs.html')
-rw-r--r--doc/src/km/device_object.rs.html306
1 files changed, 306 insertions, 0 deletions
diff --git a/doc/src/km/device_object.rs.html b/doc/src/km/device_object.rs.html
new file mode 100644
index 0000000..4d46be6
--- /dev/null
+++ b/doc/src/km/device_object.rs.html
@@ -0,0 +1,306 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="generator" content="rustdoc">
+ <meta name="description" content="Source to the Rust file `device_object.rs`.">
+ <meta name="keywords" content="rust, rustlang, rust-lang">
+
+ <title>device_object.rs.html -- source</title>
+
+ <link rel="stylesheet" type="text/css" href="../../rustdoc.css">
+ <link rel="stylesheet" type="text/css" href="../../main.css">
+
+
+
+
+</head>
+<body class="rustdoc">
+ <!--[if lte IE 8]>
+ <div class="warning">
+ This old browser is unsupported and will most likely display funky
+ things.
+ </div>
+ <![endif]-->
+
+
+
+ <nav class="sidebar">
+
+
+ </nav>
+
+ <nav class="sub">
+ <form class="search-form js-only">
+ <div class="search-container">
+ <input class="search-input" name="search"
+ autocomplete="off"
+ placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
+ type="search">
+ </div>
+ </form>
+ </nav>
+
+ <section id='main' class="content source"><pre class="line-numbers"><span id="1"> 1</span>
+<span id="2"> 2</span>
+<span id="3"> 3</span>
+<span id="4"> 4</span>
+<span id="5"> 5</span>
+<span id="6"> 6</span>
+<span id="7"> 7</span>
+<span id="8"> 8</span>
+<span id="9"> 9</span>
+<span id="10">10</span>
+<span id="11">11</span>
+<span id="12">12</span>
+<span id="13">13</span>
+<span id="14">14</span>
+<span id="15">15</span>
+<span id="16">16</span>
+<span id="17">17</span>
+<span id="18">18</span>
+<span id="19">19</span>
+<span id="20">20</span>
+<span id="21">21</span>
+<span id="22">22</span>
+<span id="23">23</span>
+<span id="24">24</span>
+<span id="25">25</span>
+<span id="26">26</span>
+<span id="27">27</span>
+<span id="28">28</span>
+<span id="29">29</span>
+<span id="30">30</span>
+<span id="31">31</span>
+<span id="32">32</span>
+<span id="33">33</span>
+<span id="34">34</span>
+<span id="35">35</span>
+<span id="36">36</span>
+<span id="37">37</span>
+<span id="38">38</span>
+<span id="39">39</span>
+<span id="40">40</span>
+<span id="41">41</span>
+<span id="42">42</span>
+<span id="43">43</span>
+<span id="44">44</span>
+<span id="45">45</span>
+<span id="46">46</span>
+<span id="47">47</span>
+<span id="48">48</span>
+<span id="49">49</span>
+<span id="50">50</span>
+<span id="51">51</span>
+<span id="52">52</span>
+<span id="53">53</span>
+<span id="54">54</span>
+<span id="55">55</span>
+<span id="56">56</span>
+<span id="57">57</span>
+<span id="58">58</span>
+<span id="59">59</span>
+<span id="60">60</span>
+<span id="61">61</span>
+<span id="62">62</span>
+<span id="63">63</span>
+<span id="64">64</span>
+<span id="65">65</span>
+<span id="66">66</span>
+<span id="67">67</span>
+<span id="68">68</span>
+<span id="69">69</span>
+<span id="70">70</span>
+<span id="71">71</span>
+<span id="72">72</span>
+<span id="73">73</span>
+<span id="74">74</span>
+<span id="75">75</span>
+<span id="76">76</span>
+<span id="77">77</span>
+<span id="78">78</span>
+<span id="79">79</span>
+<span id="80">80</span>
+<span id="81">81</span>
+<span id="82">82</span>
+<span id="83">83</span>
+<span id="84">84</span>
+<span id="85">85</span>
+<span id="86">86</span>
+<span id="87">87</span>
+<span id="88">88</span>
+<span id="89">89</span>
+<span id="90">90</span>
+<span id="91">91</span>
+<span id="92">92</span>
+<span id="93">93</span>
+<span id="94">94</span>
+<span id="95">95</span>
+<span id="96">96</span>
+<span id="97">97</span>
+<span id="98">98</span>
+<span id="99">99</span>
+</pre><pre class='rust '>
+<span class='doccomment'>//! Device Object.</span>
+
+<span class='kw'>use</span> ::{<span class='ident'>NTSTATUS</span>, <span class='ident'>UNICODE_STRING</span>};
+<span class='kw'>use</span> ::<span class='ident'>driver_object</span>::<span class='ident'>DRIVER_OBJECT</span>;
+<span class='kw'>use</span> ::<span class='ident'>irp</span>::{<span class='ident'>IRP</span>, <span class='ident'>PIRP</span>};
+<span class='kw'>use</span> ::<span class='ident'>dpc</span>::<span class='ident'>KDPC</span>;
+<span class='kw'>use</span> ::<span class='ident'>event</span>::<span class='ident'>KEVENT</span>;
+<span class='kw'>use</span> ::<span class='ident'>object</span>::<span class='op'>*</span>;
+<span class='kw'>use</span> ::<span class='ident'>PVOID</span>;
+
+<span class='kw'>extern</span> <span class='string'>&quot;system&quot;</span>
+{
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>IoCreateDevice</span>(<span class='ident'>DriverObject</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>DRIVER_OBJECT</span>, <span class='ident'>DeviceExtensionSize</span>: <span class='ident'>u32</span>, <span class='ident'>DeviceName</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>UNICODE_STRING</span>,
+ <span class='ident'>DeviceType</span>: <span class='ident'>u32</span>, <span class='ident'>DeviceCharacteristics</span>: <span class='ident'>u32</span>, <span class='ident'>Exclusive</span>: <span class='ident'>bool</span>, <span class='ident'>DeviceObject</span>: <span class='op'>*</span><span class='kw-2'>mut</span><span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>IoDeleteDevice</span>(<span class='ident'>DeviceObject</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>IoCreateSymbolicLink</span>(<span class='ident'>SymbolicLinkName</span>: <span class='kw-2'>&amp;</span><span class='ident'>UNICODE_STRING</span>, <span class='ident'>DeviceName</span>: <span class='kw-2'>&amp;</span><span class='ident'>UNICODE_STRING</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>IoDeleteSymbolicLink</span>(<span class='ident'>SymbolicLinkName</span>: <span class='kw-2'>&amp;</span><span class='ident'>UNICODE_STRING</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+}
+
+<span class='doccomment'>/// Device object flags.</span>
+<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span>
+<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>DEVICE_FLAGS</span> {
+ <span class='ident'>NONE</span> <span class='op'>=</span> <span class='number'>0</span>,
+ <span class='ident'>DO_VERIFY_VOLUME</span> <span class='op'>=</span> <span class='number'>0x00000002</span>,
+ <span class='ident'>DO_BUFFERED_IO</span> <span class='op'>=</span> <span class='number'>0x00000004</span>,
+ <span class='ident'>DO_EXCLUSIVE</span> <span class='op'>=</span> <span class='number'>0x00000008</span>,
+ <span class='ident'>DO_DIRECT_IO</span> <span class='op'>=</span> <span class='number'>0x00000010</span>,
+ <span class='ident'>DO_MAP_IO_BUFFER</span> <span class='op'>=</span> <span class='number'>0x00000020</span>,
+ <span class='ident'>DO_DEVICE_HAS_NAME</span> <span class='op'>=</span> <span class='number'>0x00000040</span>,
+ <span class='ident'>DO_DEVICE_INITIALIZING</span> <span class='op'>=</span> <span class='number'>0x00000080</span>,
+ <span class='ident'>DO_SYSTEM_BOOT_PARTITION</span> <span class='op'>=</span> <span class='number'>0x00000100</span>,
+ <span class='ident'>DO_LONG_TERM_REQUESTS</span> <span class='op'>=</span> <span class='number'>0x00000200</span>,
+ <span class='ident'>DO_NEVER_LAST_DEVICE</span> <span class='op'>=</span> <span class='number'>0x00000400</span>,
+ <span class='ident'>DO_SHUTDOWN_REGISTERED</span> <span class='op'>=</span> <span class='number'>0x00000800</span>,
+ <span class='ident'>DO_BUS_ENUMERATED_DEVICE</span> <span class='op'>=</span> <span class='number'>0x00001000</span>,
+ <span class='ident'>DO_POWER_PAGABLE</span> <span class='op'>=</span> <span class='number'>0x00002000</span>,
+ <span class='ident'>DO_POWER_INRUSH</span> <span class='op'>=</span> <span class='number'>0x00004000</span>,
+ <span class='ident'>DO_POWER_NOOP</span> <span class='op'>=</span> <span class='number'>0x00008000</span>,
+ <span class='ident'>DO_LOW_PRIORITY_FILESYSTEM</span> <span class='op'>=</span> <span class='number'>0x00010000</span>,
+ <span class='ident'>DO_XIP</span> <span class='op'>=</span> <span class='number'>0x00020000</span>
+}
+
+<span class='doccomment'>/// The `DEVICE_OBJECT` structure is used by the operating system to represent a device object.</span>
+<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span>
+<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>DEVICE_OBJECT</span>
+{
+ <span class='kw'>pub</span> <span class='ident'>Type</span>: <span class='ident'>u16</span>,
+ <span class='kw'>pub</span> <span class='ident'>Size</span>: <span class='ident'>u16</span>,
+ <span class='kw'>pub</span> <span class='ident'>ReferenceCount</span>: <span class='ident'>i32</span>,
+ <span class='kw'>pub</span> <span class='ident'>DriverObject</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>DRIVER_OBJECT</span>,
+ <span class='kw'>pub</span> <span class='ident'>NextDevice</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>,
+ <span class='kw'>pub</span> <span class='ident'>AttachedDevice</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>,
+ <span class='kw'>pub</span> <span class='ident'>CurrentIrp</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>IRP</span>,
+ <span class='kw'>pub</span> <span class='ident'>Timer</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>,
+ <span class='kw'>pub</span> <span class='ident'>Flags</span>: <span class='ident'>u32</span>,
+ <span class='kw'>pub</span> <span class='ident'>Characteristics</span>: <span class='ident'>u32</span>,
+ <span class='kw'>pub</span> <span class='ident'>Vpb</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>,
+ <span class='kw'>pub</span> <span class='ident'>DeviceExtension</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>,
+ <span class='kw'>pub</span> <span class='ident'>DeviceType</span>: <span class='ident'>u32</span>,
+ <span class='kw'>pub</span> <span class='ident'>StackSize</span>: <span class='ident'>u8</span>,
+ <span class='kw'>pub</span> <span class='ident'>Queue</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>WAIT_CONTEXT_BLOCK</span>,
+ <span class='kw'>pub</span> <span class='ident'>AlignmentRequirement</span>: <span class='ident'>u32</span>,
+ <span class='kw'>pub</span> <span class='ident'>DeviceQueue</span>: <span class='ident'>KDEVICE_QUEUE</span>,
+ <span class='kw'>pub</span> <span class='ident'>Dpc</span>: <span class='ident'>KDPC</span>,
+ <span class='kw'>pub</span> <span class='ident'>ActiveThreadCount</span>: <span class='ident'>u32</span>,
+ <span class='kw'>pub</span> <span class='ident'>SecurityDescriptor</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>,
+ <span class='kw'>pub</span> <span class='ident'>DeviceLock</span>: <span class='ident'>KEVENT</span>,
+ <span class='kw'>pub</span> <span class='ident'>SectorSize</span>: <span class='ident'>u16</span>,
+ <span class='kw'>pub</span> <span class='ident'>Spare1</span>: <span class='ident'>u16</span>,
+ <span class='kw'>pub</span> <span class='ident'>DeviceObjectExtension</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVOBJ_EXTENSION</span>,
+ <span class='kw'>pub</span> <span class='ident'>Reserved</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>,
+}
+
+<span class='doccomment'>/// Device object extension structure.</span>
+<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span>
+<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>DEVOBJ_EXTENSION</span>
+{
+ <span class='ident'>Type</span>: <span class='ident'>u16</span>,
+ <span class='ident'>Size</span>: <span class='ident'>u16</span>,
+ <span class='ident'>DeviceObject</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>,
+ <span class='ident'>PowerFlags</span>: <span class='ident'>u32</span>,
+ <span class='ident'>Dope</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>,
+ <span class='ident'>ExtensionFlags</span>: <span class='ident'>u32</span>,
+ <span class='ident'>DeviceNode</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>,
+ <span class='ident'>AttachedTo</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>,
+ <span class='ident'>StartIoCount</span>: <span class='ident'>i32</span>,
+ <span class='ident'>StartIoKey</span>: <span class='ident'>i32</span>,
+ <span class='ident'>StartIoFlags</span>: <span class='ident'>u32</span>,
+ <span class='ident'>Vpb</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>,
+}
+
+<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDEVICE_OBJECT</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>;
+
+<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDRIVER_CANCEL</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'>&lt;</span><span class='kw'>extern</span> <span class='string'>&quot;system&quot;</span> <span class='kw'>fn</span> (<span class='ident'>DeviceObject</span>: <span class='ident'>PDEVICE_OBJECT</span>, <span class='ident'>Irp</span>: <span class='ident'>PIRP</span>)<span class='op'>&gt;</span>;
+
+<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDRIVER_DISPATCH</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'>&lt;</span><span class='kw'>extern</span> <span class='string'>&quot;system&quot;</span> <span class='kw'>fn</span> (<span class='ident'>DeviceObject</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>, <span class='ident'>Irp</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>IRP</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span><span class='op'>&gt;</span>;
+
+<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PIO_COMPLETION_ROUTINE</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'>&lt;</span><span class='kw'>extern</span> <span class='string'>&quot;system&quot;</span> <span class='kw'>fn</span> (<span class='ident'>DeviceObject</span>: <span class='ident'>PDEVICE_OBJECT</span>, <span class='ident'>Irp</span>: <span class='ident'>PIRP</span>, <span class='ident'>Context</span>: <span class='ident'>PVOID</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span><span class='op'>&gt;</span>;
+</pre>
+</section>
+ <section id='search' class="content hidden"></section>
+
+ <section class="footer"></section>
+
+ <aside id="help" class="hidden">
+ <div>
+ <h1 class="hidden">Help</h1>
+
+ <div class="shortcuts">
+ <h2>Keyboard Shortcuts</h2>
+
+ <dl>
+ <dt>?</dt>
+ <dd>Show this help dialog</dd>
+ <dt>S</dt>
+ <dd>Focus the search field</dd>
+ <dt>&larrb;</dt>
+ <dd>Move up in search results</dd>
+ <dt>&rarrb;</dt>
+ <dd>Move down in search results</dd>
+ <dt>&#9166;</dt>
+ <dd>Go to active search result</dd>
+ </dl>
+ </div>
+
+ <div class="infos">
+ <h2>Search Tricks</h2>
+
+ <p>
+ Prefix searches with a type followed by a colon (e.g.
+ <code>fn:</code>) to restrict the search to a given type.
+ </p>
+
+ <p>
+ Accepted types are: <code>fn</code>, <code>mod</code>,
+ <code>struct</code>, <code>enum</code>,
+ <code>trait</code>, <code>type</code>, <code>macro</code>,
+ and <code>const</code>.
+ </p>
+
+ <p>
+ Search functions by type signature (e.g.
+ <code>vec -> usize</code> or <code>* -> vec</code>)
+ </p>
+ </div>
+ </div>
+ </aside>
+
+
+
+ <script>
+ window.rootPath = "../../";
+ window.currentCrate = "km";
+ window.playgroundUrl = "";
+ </script>
+ <script src="../../jquery.js"></script>
+ <script src="../../main.js"></script>
+
+ <script defer src="../../search-index.js"></script>
+</body>
+</html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.25.1) at 2026-05-01 06:57:29 +0000