<!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 `/home/mrh/.cargo/registry/src/github.com-1ecc6299db9ec823/nix-0.14.1/src/sys/ioctl/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../../light.css" id="themeStyle"><script src="../../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../../nix/index.html'><div class='logo-container'><img src='../../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../../settings.html"><img src="../../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><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>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
<span id="676">676</span>
<span id="677">677</span>
<span id="678">678</span>
<span id="679">679</span>
<span id="680">680</span>
<span id="681">681</span>
<span id="682">682</span>
<span id="683">683</span>
<span id="684">684</span>
<span id="685">685</span>
<span id="686">686</span>
<span id="687">687</span>
<span id="688">688</span>
<span id="689">689</span>
<span id="690">690</span>
<span id="691">691</span>
<span id="692">692</span>
<span id="693">693</span>
<span id="694">694</span>
<span id="695">695</span>
<span id="696">696</span>
<span id="697">697</span>
<span id="698">698</span>
<span id="699">699</span>
<span id="700">700</span>
<span id="701">701</span>
<span id="702">702</span>
<span id="703">703</span>
<span id="704">704</span>
<span id="705">705</span>
<span id="706">706</span>
<span id="707">707</span>
<span id="708">708</span>
<span id="709">709</span>
<span id="710">710</span>
<span id="711">711</span>
<span id="712">712</span>
<span id="713">713</span>
<span id="714">714</span>
<span id="715">715</span>
<span id="716">716</span>
<span id="717">717</span>
<span id="718">718</span>
<span id="719">719</span>
<span id="720">720</span>
<span id="721">721</span>
<span id="722">722</span>
<span id="723">723</span>
<span id="724">724</span>
<span id="725">725</span>
<span id="726">726</span>
<span id="727">727</span>
<span id="728">728</span>
<span id="729">729</span>
<span id="730">730</span>
<span id="731">731</span>
<span id="732">732</span>
<span id="733">733</span>
<span id="734">734</span>
<span id="735">735</span>
<span id="736">736</span>
<span id="737">737</span>
<span id="738">738</span>
<span id="739">739</span>
<span id="740">740</span>
<span id="741">741</span>
<span id="742">742</span>
<span id="743">743</span>
<span id="744">744</span>
<span id="745">745</span>
<span id="746">746</span>
<span id="747">747</span>
<span id="748">748</span>
<span id="749">749</span>
<span id="750">750</span>
<span id="751">751</span>
<span id="752">752</span>
<span id="753">753</span>
<span id="754">754</span>
<span id="755">755</span>
<span id="756">756</span>
<span id="757">757</span>
<span id="758">758</span>
<span id="759">759</span>
<span id="760">760</span>
<span id="761">761</span>
<span id="762">762</span>
<span id="763">763</span>
<span id="764">764</span>
<span id="765">765</span>
<span id="766">766</span>
<span id="767">767</span>
<span id="768">768</span>
<span id="769">769</span>
<span id="770">770</span>
<span id="771">771</span>
<span id="772">772</span>
<span id="773">773</span>
<span id="774">774</span>
<span id="775">775</span>
<span id="776">776</span>
<span id="777">777</span>
<span id="778">778</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! Provide helpers for making ioctl system calls.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This library is pretty low-level and messy. `ioctl` is not fun.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! What is an `ioctl`?</span>
<span class="doccomment">//! ===================</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The `ioctl` syscall is the grab-bag syscall on POSIX systems. Don't want to add a new</span>
<span class="doccomment">//! syscall? Make it an `ioctl`! `ioctl` refers to both the syscall, and the commands that can be</span>
<span class="doccomment">//! sent with it. `ioctl` stands for "IO control", and the commands are always sent to a file</span>
<span class="doccomment">//! descriptor.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! It is common to see `ioctl`s used for the following purposes:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! * Provide read/write access to out-of-band data related to a device such as configuration</span>
<span class="doccomment">//! (for instance, setting serial port options)</span>
<span class="doccomment">//! * Provide a mechanism for performing full-duplex data transfers (for instance, xfer on SPI</span>
<span class="doccomment">//! devices).</span>
<span class="doccomment">//! * Provide access to control functions on a device (for example, on Linux you can send</span>
<span class="doccomment">//! commands like pause, resume, and eject to the CDROM device.</span>
<span class="doccomment">//! * Do whatever else the device driver creator thought made most sense.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! `ioctl`s are synchronous system calls and are similar to read and write calls in that regard.</span>
<span class="doccomment">//! They operate on file descriptors and have an identifier that specifies what the ioctl is.</span>
<span class="doccomment">//! Additionally they may read or write data and therefore need to pass along a data pointer.</span>
<span class="doccomment">//! Besides the semantics of the ioctls being confusing, the generation of this identifer can also</span>
<span class="doccomment">//! be difficult.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Historically `ioctl` numbers were arbitrary hard-coded values. In Linux (before 2.6) and some</span>
<span class="doccomment">//! unices this has changed to a more-ordered system where the ioctl numbers are partitioned into</span>
<span class="doccomment">//! subcomponents (For linux this is documented in</span>
<span class="doccomment">//! [`Documentation/ioctl/ioctl-number.txt`](http://elixir.free-electrons.com/linux/latest/source/Documentation/ioctl/ioctl-number.txt)):</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! * Number: The actual ioctl ID</span>
<span class="doccomment">//! * Type: A grouping of ioctls for a common purpose or driver</span>
<span class="doccomment">//! * Size: The size in bytes of the data that will be transferred</span>
<span class="doccomment">//! * Direction: Whether there is any data and if it's read, write, or both</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Newer drivers should not generate complete integer identifiers for their `ioctl`s instead</span>
<span class="doccomment">//! preferring to use the 4 components above to generate the final ioctl identifier. Because of</span>
<span class="doccomment">//! how old `ioctl`s are, however, there are many hard-coded `ioctl` identifiers. These are</span>
<span class="doccomment">//! commonly referred to as "bad" in `ioctl` documentation.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Defining `ioctl`s</span>
<span class="doccomment">//! =================</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This library provides several `ioctl_*!` macros for binding `ioctl`s. These generate public</span>
<span class="doccomment">//! unsafe functions that can then be used for calling the ioctl. This macro has a few different</span>
<span class="doccomment">//! ways it can be used depending on the specific ioctl you're working with.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! A simple `ioctl` is `SPI_IOC_RD_MODE`. This ioctl works with the SPI interface on Linux. This</span>
<span class="doccomment">//! specific `ioctl` reads the mode of the SPI device as a `u8`. It's declared in</span>
<span class="doccomment">//! `/include/uapi/linux/spi/spidev.h` as `_IOR(SPI_IOC_MAGIC, 1, __u8)`. Since it uses the `_IOR`</span>
<span class="doccomment">//! macro, we know it's a `read` ioctl and can use the `ioctl_read!` macro as follows:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! # #[macro_use] extern crate nix;</span>
<span class="doccomment">//! const SPI_IOC_MAGIC: u8 = b'k'; // Defined in linux/spi/spidev.h</span>
<span class="doccomment">//! const SPI_IOC_TYPE_MODE: u8 = 1;</span>
<span class="doccomment">//! ioctl_read!(spi_read_mode, SPI_IOC_MAGIC, SPI_IOC_TYPE_MODE, u8);</span>
<span class="doccomment">//! # fn main() {}</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This generates the function:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! # #[macro_use] extern crate nix;</span>
<span class="doccomment">//! # use std::mem;</span>
<span class="doccomment">//! # use nix::{libc, Result};</span>
<span class="doccomment">//! # use nix::errno::Errno;</span>
<span class="doccomment">//! # use nix::libc::c_int as c_int;</span>
<span class="doccomment">//! # const SPI_IOC_MAGIC: u8 = b'k'; // Defined in linux/spi/spidev.h</span>
<span class="doccomment">//! # const SPI_IOC_TYPE_MODE: u8 = 1;</span>
<span class="doccomment">//! pub unsafe fn spi_read_mode(fd: c_int, data: *mut u8) -> Result<c_int> {</span>
<span class="doccomment">//! let res = libc::ioctl(fd, request_code_read!(SPI_IOC_MAGIC, SPI_IOC_TYPE_MODE, mem::size_of::<u8>()), data);</span>
<span class="doccomment">//! Errno::result(res)</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! # fn main() {}</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The return value for the wrapper functions generated by the `ioctl_*!` macros are `nix::Error`s.</span>
<span class="doccomment">//! These are generated by assuming the return value of the ioctl is `-1` on error and everything</span>
<span class="doccomment">//! else is a valid return value. If this is not the case, `Result::map` can be used to map some</span>
<span class="doccomment">//! of the range of "good" values (-Inf..-2, 0..Inf) into a smaller range in a helper function.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Writing `ioctl`s generally use pointers as their data source and these should use the</span>
<span class="doccomment">//! `ioctl_write_ptr!`. But in some cases an `int` is passed directly. For these `ioctl`s use the</span>
<span class="doccomment">//! `ioctl_write_int!` macro. This variant does not take a type as the last argument:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! # #[macro_use] extern crate nix;</span>
<span class="doccomment">//! const HCI_IOC_MAGIC: u8 = b'k';</span>
<span class="doccomment">//! const HCI_IOC_HCIDEVUP: u8 = 1;</span>
<span class="doccomment">//! ioctl_write_int!(hci_dev_up, HCI_IOC_MAGIC, HCI_IOC_HCIDEVUP);</span>
<span class="doccomment">//! # fn main() {}</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Some `ioctl`s don't transfer any data, and those should use `ioctl_none!`. This macro</span>
<span class="doccomment">//! doesn't take a type and so it is declared similar to the `write_int` variant shown above.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The mode for a given `ioctl` should be clear from the documentation if it has good</span>
<span class="doccomment">//! documentation. Otherwise it will be clear based on the macro used to generate the `ioctl`</span>
<span class="doccomment">//! number where `_IO`, `_IOR`, `_IOW`, and `_IOWR` map to "none", "read", "write_*", and "readwrite"</span>
<span class="doccomment">//! respectively. To determine the specific `write_` variant to use you'll need to find</span>
<span class="doccomment">//! what the argument type is supposed to be. If it's an `int`, then `write_int` should be used,</span>
<span class="doccomment">//! otherwise it should be a pointer and `write_ptr` should be used. On Linux the</span>
<span class="doccomment">//! [`ioctl_list` man page](http://man7.org/linux/man-pages/man2/ioctl_list.2.html) describes a</span>
<span class="doccomment">//! large number of `ioctl`s and describes their argument data type.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Using "bad" `ioctl`s</span>
<span class="doccomment">//! --------------------</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! As mentioned earlier, there are many old `ioctl`s that do not use the newer method of</span>
<span class="doccomment">//! generating `ioctl` numbers and instead use hardcoded values. These can be used with the</span>
<span class="doccomment">//! `ioctl_*_bad!` macros. This naming comes from the Linux kernel which refers to these</span>
<span class="doccomment">//! `ioctl`s as "bad". These are a different variant as they bypass calling the macro that generates</span>
<span class="doccomment">//! the ioctl number and instead use the defined value directly.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! For example the `TCGETS` `ioctl` reads a `termios` data structure for a given file descriptor.</span>
<span class="doccomment">//! It's defined as `0x5401` in `ioctls.h` on Linux and can be implemented as:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! # #[macro_use] extern crate nix;</span>
<span class="doccomment">//! # #[cfg(any(target_os = "android", target_os = "linux"))]</span>
<span class="doccomment">//! # use nix::libc::TCGETS as TCGETS;</span>
<span class="doccomment">//! # #[cfg(any(target_os = "android", target_os = "linux"))]</span>
<span class="doccomment">//! # use nix::libc::termios as termios;</span>
<span class="doccomment">//! # #[cfg(any(target_os = "android", target_os = "linux"))]</span>
<span class="doccomment">//! ioctl_read_bad!(tcgets, TCGETS, termios);</span>
<span class="doccomment">//! # fn main() {}</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The generated function has the same form as that generated by `ioctl_read!`:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```text</span>
<span class="doccomment">//! pub unsafe fn tcgets(fd: c_int, data: *mut termios) -> Result<c_int>;</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Working with Arrays</span>
<span class="doccomment">//! -------------------</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Some `ioctl`s work with entire arrays of elements. These are supported by the `ioctl_*_buf`</span>
<span class="doccomment">//! family of macros: `ioctl_read_buf`, `ioctl_write_buf`, and `ioctl_readwrite_buf`. Note that</span>
<span class="doccomment">//! there are no "bad" versions for working with buffers. The generated functions include a `len`</span>
<span class="doccomment">//! argument to specify the number of elements (where the type of each element is specified in the</span>
<span class="doccomment">//! macro).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Again looking to the SPI `ioctl`s on Linux for an example, there is a `SPI_IOC_MESSAGE` `ioctl`</span>
<span class="doccomment">//! that queues up multiple SPI messages by writing an entire array of `spi_ioc_transfer` structs.</span>
<span class="doccomment">//! `linux/spi/spidev.h` defines a macro to calculate the `ioctl` number like:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```C</span>
<span class="doccomment">//! #define SPI_IOC_MAGIC 'k'</span>
<span class="doccomment">//! #define SPI_MSGSIZE(N) ...</span>
<span class="doccomment">//! #define SPI_IOC_MESSAGE(N) _IOW(SPI_IOC_MAGIC, 0, char[SPI_MSGSIZE(N)])</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The `SPI_MSGSIZE(N)` calculation is already handled by the `ioctl_*!` macros, so all that's</span>
<span class="doccomment">//! needed to define this `ioctl` is:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! # #[macro_use] extern crate nix;</span>
<span class="doccomment">//! const SPI_IOC_MAGIC: u8 = b'k'; // Defined in linux/spi/spidev.h</span>
<span class="doccomment">//! const SPI_IOC_TYPE_MESSAGE: u8 = 0;</span>
<span class="doccomment">//! # pub struct spi_ioc_transfer(u64);</span>
<span class="doccomment">//! ioctl_write_buf!(spi_transfer, SPI_IOC_MAGIC, SPI_IOC_TYPE_MESSAGE, spi_ioc_transfer);</span>
<span class="doccomment">//! # fn main() {}</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This generates a function like:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! # #[macro_use] extern crate nix;</span>
<span class="doccomment">//! # use std::mem;</span>
<span class="doccomment">//! # use nix::{libc, Result};</span>
<span class="doccomment">//! # use nix::errno::Errno;</span>
<span class="doccomment">//! # use nix::libc::c_int as c_int;</span>
<span class="doccomment">//! # const SPI_IOC_MAGIC: u8 = b'k';</span>
<span class="doccomment">//! # const SPI_IOC_TYPE_MESSAGE: u8 = 0;</span>
<span class="doccomment">//! # pub struct spi_ioc_transfer(u64);</span>
<span class="doccomment">//! pub unsafe fn spi_message(fd: c_int, data: &mut [spi_ioc_transfer]) -> Result<c_int> {</span>
<span class="doccomment">//! let res = libc::ioctl(fd,</span>
<span class="doccomment">//! request_code_write!(SPI_IOC_MAGIC, SPI_IOC_TYPE_MESSAGE, data.len() * mem::size_of::<spi_ioc_transfer>()),</span>
<span class="doccomment">//! data);</span>
<span class="doccomment">//! Errno::result(res)</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! # fn main() {}</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Finding `ioctl` Documentation</span>
<span class="doccomment">//! -----------------------------</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! For Linux, look at your system's headers. For example, `/usr/include/linux/input.h` has a lot</span>
<span class="doccomment">//! of lines defining macros which use `_IO`, `_IOR`, `_IOW`, `_IOC`, and `_IOWR`. Some `ioctl`s are</span>
<span class="doccomment">//! documented directly in the headers defining their constants, but others have more extensive</span>
<span class="doccomment">//! documentation in man pages (like termios' `ioctl`s which are in `tty_ioctl(4)`).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Documenting the Generated Functions</span>
<span class="doccomment">//! ===================================</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! In many cases, users will wish for the functions generated by the `ioctl`</span>
<span class="doccomment">//! macro to be public and documented. For this reason, the generated functions</span>
<span class="doccomment">//! are public by default. If you wish to hide the ioctl, you will need to put</span>
<span class="doccomment">//! them in a private module.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! For documentation, it is possible to use doc comments inside the `ioctl_*!` macros. Here is an</span>
<span class="doccomment">//! example :</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! # #[macro_use] extern crate nix;</span>
<span class="doccomment">//! # use nix::libc::c_int;</span>
<span class="doccomment">//! ioctl_read! {</span>
<span class="doccomment">//! /// Make the given terminal the controlling terminal of the calling process. The calling</span>
<span class="doccomment">//! /// process must be a session leader and not have a controlling terminal already. If the</span>
<span class="doccomment">//! /// terminal is already the controlling terminal of a different session group then the</span>
<span class="doccomment">//! /// ioctl will fail with **EPERM**, unless the caller is root (more precisely: has the</span>
<span class="doccomment">//! /// **CAP_SYS_ADMIN** capability) and arg equals 1, in which case the terminal is stolen</span>
<span class="doccomment">//! /// and all processes that had it as controlling terminal lose it.</span>
<span class="doccomment">//! tiocsctty, b't', 19, c_int</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # fn main() {}</span>
<span class="doccomment">//! ```</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>))]</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">mod</span> <span class="ident">linux</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>))]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">linux</span>::<span class="kw-2">*</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"dragonfly"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"openbsd"</span>))]</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">mod</span> <span class="ident">bsd</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"dragonfly"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"openbsd"</span>))]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">bsd</span>::<span class="kw-2">*</span>;
<span class="doccomment">/// Convert raw ioctl return value to a Nix result</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">convert_ioctl_res</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">w</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> (
{
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">errno</span>::<span class="ident">Errno</span>::<span class="ident">result</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">w</span>)
}
);
}
<span class="doccomment">/// Generates a wrapper function for an ioctl that passes no data to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `videodev2` driver on Linux defines the `log_status` `ioctl` as:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```C</span>
<span class="doccomment">/// #define VIDIOC_LOG_STATUS _IO('V', 70)</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This can be implemented in Rust like:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// ioctl_none!(log_status, b'V', 70);</span>
<span class="doccomment">/// fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_none</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_none</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for a "bad" ioctl that passes no data to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl request code</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// # extern crate libc;</span>
<span class="doccomment">/// # use libc::TIOCNXCL;</span>
<span class="doccomment">/// # use std::fs::File;</span>
<span class="doccomment">/// # use std::os::unix::io::AsRawFd;</span>
<span class="doccomment">/// ioctl_none_bad!(tiocnxcl, TIOCNXCL);</span>
<span class="doccomment">/// fn main() {</span>
<span class="doccomment">/// let file = File::open("/dev/ttyUSB0").unwrap();</span>
<span class="doccomment">/// unsafe { tiocnxcl(file.as_raw_fd()) }.unwrap();</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="comment">// TODO: add an example using request_code_*!()</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_none_bad</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span> <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for an ioctl that reads data from the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *mut DATA_TYPE) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// const SPI_IOC_MAGIC: u8 = b'k'; // Defined in linux/spi/spidev.h</span>
<span class="doccomment">/// const SPI_IOC_TYPE_MODE: u8 = 1;</span>
<span class="doccomment">/// ioctl_read!(spi_read_mode, SPI_IOC_MAGIC, SPI_IOC_TYPE_MODE, u8);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_read</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_read</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for a "bad" ioctl that reads data from the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl request code</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *mut DATA_TYPE) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # extern crate libc;</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// # #[cfg(any(target_os = "android", target_os = "linux"))]</span>
<span class="doccomment">/// ioctl_read_bad!(tcgets, libc::TCGETS, libc::termios);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_read_bad</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span> <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for an ioctl that writes data through a pointer to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *const DATA_TYPE) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// # pub struct v4l2_audio {}</span>
<span class="doccomment">/// ioctl_write_ptr!(s_audio, b'V', 34, v4l2_audio);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_write_ptr</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_write</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for a "bad" ioctl that writes data through a pointer to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl request code</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *const DATA_TYPE) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # extern crate libc;</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// # #[cfg(any(target_os = "android", target_os = "linux"))]</span>
<span class="doccomment">/// ioctl_write_ptr_bad!(tcsets, libc::TCSETS, libc::termios);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_write_ptr_bad</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span> <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="macro">cfg_if</span><span class="macro">!</span>{
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"dragonfly"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>))]</span> {
<span class="doccomment">/// Generates a wrapper function for a ioctl that writes an integer to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: nix::sys::ioctl::ioctl_param_type) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `nix::sys::ioctl::ioctl_param_type` depends on the OS:</span>
<span class="doccomment">/// * BSD - `libc::c_int`</span>
<span class="doccomment">/// * Linux - `libc::c_ulong`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// ioctl_write_int!(vt_activate, b'v', 4);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_write_int</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_param_type</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_write_int</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
} <span class="kw">else</span> {
<span class="doccomment">/// Generates a wrapper function for a ioctl that writes an integer to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: nix::sys::ioctl::ioctl_param_type) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `nix::sys::ioctl::ioctl_param_type` depends on the OS:</span>
<span class="doccomment">/// * BSD - `libc::c_int`</span>
<span class="doccomment">/// * Linux - `libc::c_ulong`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// const HCI_IOC_MAGIC: u8 = b'k';</span>
<span class="doccomment">/// const HCI_IOC_HCIDEVUP: u8 = 1;</span>
<span class="doccomment">/// ioctl_write_int!(hci_dev_up, HCI_IOC_MAGIC, HCI_IOC_HCIDEVUP);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_write_int</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_param_type</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_write</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
}
}
<span class="doccomment">/// Generates a wrapper function for a "bad" ioctl that writes an integer to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl request code</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: libc::c_int) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # extern crate libc;</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// # #[cfg(any(target_os = "android", target_os = "linux"))]</span>
<span class="doccomment">/// ioctl_write_int_bad!(tcsbrk, libc::TCSBRK);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// const KVMIO: u8 = 0xAE;</span>
<span class="doccomment">/// ioctl_write_int_bad!(kvm_create_vm, request_code_none!(KVMIO, 0x03));</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_write_int_bad</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span> <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for an ioctl that reads and writes data to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *mut DATA_TYPE) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// # pub struct v4l2_audio {}</span>
<span class="doccomment">/// ioctl_readwrite!(enum_audio, b'V', 65, v4l2_audio);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_readwrite</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_readwrite</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for a "bad" ioctl that reads and writes data to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl request code</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *mut DATA_TYPE) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="comment">// TODO: Find an example for ioctl_readwrite_bad</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_readwrite_bad</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>)
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span> <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for an ioctl that reads an array of elements from the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: &mut [DATA_TYPE]) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="comment">// TODO: Find an example for ioctl_read_buf</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_read_buf</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>])
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_read</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, <span class="ident">data</span>.<span class="ident">len</span>() <span class="op">*</span> ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for an ioctl that writes an array of elements to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: &[DATA_TYPE]) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # #[macro_use] extern crate nix;</span>
<span class="doccomment">/// const SPI_IOC_MAGIC: u8 = b'k'; // Defined in linux/spi/spidev.h</span>
<span class="doccomment">/// const SPI_IOC_TYPE_MESSAGE: u8 = 0;</span>
<span class="doccomment">/// # pub struct spi_ioc_transfer(u64);</span>
<span class="doccomment">/// ioctl_write_buf!(spi_transfer, SPI_IOC_MAGIC, SPI_IOC_TYPE_MESSAGE, spi_ioc_transfer);</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_write_buf</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">&</span>[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>])
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_write</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, <span class="ident">data</span>.<span class="ident">len</span>() <span class="op">*</span> ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
<span class="doccomment">/// Generates a wrapper function for an ioctl that reads and writes an array of elements to the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The arguments to this macro are:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The function name</span>
<span class="doccomment">/// * The ioctl identifier</span>
<span class="doccomment">/// * The ioctl sequence number</span>
<span class="doccomment">/// * The data type passed by this ioctl</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The generated function has the following signature:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: &mut [DATA_TYPE]) -> Result<libc::c_int></span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).</span>
<span class="comment">// TODO: Find an example for readwrite_buf</span>
<span class="attribute">#[<span class="ident">macro_export</span>(<span class="ident">local_inner_macros</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">ioctl_readwrite_buf</span> {
($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> (
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>]</span>)<span class="op">*</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>(<span class="ident">fd</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span>,
<span class="ident">data</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>])
<span class="op">-</span><span class="op">></span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">c_int</span><span class="op">></span> {
<span class="macro">convert_ioctl_res</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">libc</span>::<span class="ident">ioctl</span>(<span class="ident">fd</span>, <span class="macro">request_code_readwrite</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ioty</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">nr</span>, <span class="ident">data</span>.<span class="ident">len</span>() <span class="op">*</span> ::<span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span><span class="op">></span>()) <span class="kw">as</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">sys</span>::<span class="ident">ioctl</span>::<span class="ident">ioctl_num_type</span>, <span class="ident">data</span>))
}
)
}
</pre></div>
</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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../../";window.currentCrate = "nix";</script><script src="../../../../aliases.js"></script><script src="../../../../main.js"></script><script src="../../../../source-script.js"></script><script src="../../../../source-files.js"></script><script defer src="../../../../search-index.js"></script></body></html>