1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2<html> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 5 <title>File Index</title> 6 <link href="doxygen.css" rel="stylesheet" type="text/css"> 7 </head> 8 <body> 9<!-- Generated by Doxygen 1.7.4 --> 10 <div id="navrow1" class="tabs"> 11 <ul class="tablist"> 12 <li><a href="index.html"><span>Main Page</span></a></li> 13 <li><a href="annotated.html"><span>Data Structures</span></a></li> 14 <li class="current"><a href="files.html"><span>Files</span></a></li> 15 </ul> 16 </div> 17 <div id="navrow2" class="tabs2"> 18 <ul class="tablist"> 19 <li><a href="files.html"><span>File List</span></a></li> 20 <li><a href="globals.html"><span>Globals</span></a></li> 21 </ul> 22 </div> 23</div> 24<div id="side-nav" class="ui-resizable side-nav-resizable"> 25 <div id="nav-tree"> 26 <div id="nav-tree-contents"> 27 </div> 28 </div> 29 <div id="splitbar" style="-moz-user-select:none;" 30 class="ui-resizable-handle"> 31 </div> 32</div> 33<script type="text/javascript"> 34 initNavTree('usb-common_8h.html',''); 35</script> 36<div id="doc-content"> 37<div class="header"> 38 <div class="summary"> 39<a href="#enum-members">Enumerations</a> | 40<a href="#func-members">Functions</a> </div> 41 <div class="headertitle"> 42<div class="title">usb-common.h File Reference</div> </div> 43</div> 44<div class="contents"> 45 46<p><a href="usb-common_8h_source.html">Go to the source code of this file.</a></p> 47<table class="memberdecls"> 48<tr><td colspan="2"><h2><a name="enum-members"></a> 49Enumerations</h2></td></tr> 50<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0">usbType</a> { <a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0a6bd9e53b1b5835e304e54ba13a227de7">usbMouse</a>, 51<a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0ac0ee79f0c48b61dfd08fff502a2752a3">usbKeyboard</a>, 52<a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0acf68ef2e5cae37647c412e73c93960fb">usbOther</a> 53 }</td></tr> 54<tr><td colspan="2"><h2><a name="func-members"></a> 55Functions</h2></td></tr> 56<tr><td class="memItemLeft" align="right" valign="top">pointer </td><td class="memItemRight" valign="bottom"><a class="el" href="usb-common_8h.html#a580f9f4ac56071b925cbf63d8b9dc706">usbCreatePrivate</a> (DeviceIntPtr pDevice)</td></tr> 57<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usb-common_8h.html#a0eca0051ed4a3a117d504d6a82c65313">usbDestroyPrivate</a> (pointer priv)</td></tr> 58<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usb-common_8h.html#aea8c9cef438c8851ef7f47d7167152cb">usbRead</a> (DevicePtr pDev, <a class="el" href="dmxinputinit_8h.html#a1279820425966adabf5c77357e4a289c">dmxMotionProcPtr</a> motion, <a class="el" href="dmxinputinit_8h.html#adbd955b9ddbc5ffe38ff65e3f068f205">dmxEnqueueProcPtr</a> enqueue, int minButton, <a class="el" href="dmxinput_8h.html#a3a7195ab3516c5354bac4ca80b2eedb7">DMXBlockType</a> block)</td></tr> 59<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usb-common_8h.html#a7f9b3a6d320a9ddbed689f4e12acb443">usbInit</a> (DevicePtr pDev, <a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0">usbType</a> type)</td></tr> 60<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="usb-common_8h.html#aa86d87cabbc0971c51452970b7dc879f">usbOff</a> (DevicePtr pDev)</td></tr> 61</table> 62<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 63<div class="textblock"><p>Interface to common USB support. </p> 64<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="usb-common_8c.html">usb-common.c</a> </dd> 65<dd> 66<a class="el" href="usb-mouse_8c.html">usb-mouse.c</a> </dd> 67<dd> 68<a class="el" href="usb-keyboard_8c.html">usb-keyboard.c</a> </dd> 69<dd> 70<a class="el" href="usb-other_8c.html">usb-other.c</a> </dd></dl> 71</div><hr/><h2>Enumeration Type Documentation</h2> 72<a class="anchor" id="a5e4410bf95babe73bcecc612691fc2d0"></a><!-- doxytag: member="usb-common.h::usbType" ref="a5e4410bf95babe73bcecc612691fc2d0" args="" --> 73<div class="memitem"> 74<div class="memproto"> 75 <table class="memname"> 76 <tr> 77 <td class="memname">enum <a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0">usbType</a></td> 78 </tr> 79 </table> 80</div> 81<div class="memdoc"> 82<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 83<tr><td valign="top"><em><a class="anchor" id="a5e4410bf95babe73bcecc612691fc2d0a6bd9e53b1b5835e304e54ba13a227de7"></a><!-- doxytag: member="usbMouse" ref="a5e4410bf95babe73bcecc612691fc2d0a6bd9e53b1b5835e304e54ba13a227de7" args="" -->usbMouse</em> </td><td> 84</td></tr> 85<tr><td valign="top"><em><a class="anchor" id="a5e4410bf95babe73bcecc612691fc2d0ac0ee79f0c48b61dfd08fff502a2752a3"></a><!-- doxytag: member="usbKeyboard" ref="a5e4410bf95babe73bcecc612691fc2d0ac0ee79f0c48b61dfd08fff502a2752a3" args="" -->usbKeyboard</em> </td><td> 86</td></tr> 87<tr><td valign="top"><em><a class="anchor" id="a5e4410bf95babe73bcecc612691fc2d0acf68ef2e5cae37647c412e73c93960fb"></a><!-- doxytag: member="usbOther" ref="a5e4410bf95babe73bcecc612691fc2d0acf68ef2e5cae37647c412e73c93960fb" args="" -->usbOther</em> </td><td> 88</td></tr> 89</table> 90</dd> 91</dl> 92 93</div> 94</div> 95<hr/><h2>Function Documentation</h2> 96<a class="anchor" id="a580f9f4ac56071b925cbf63d8b9dc706"></a><!-- doxytag: member="usb-common.h::usbCreatePrivate" ref="a580f9f4ac56071b925cbf63d8b9dc706" args="(DeviceIntPtr pDevice)" --> 97<div class="memitem"> 98<div class="memproto"> 99 <table class="memname"> 100 <tr> 101 <td class="memname">pointer usbCreatePrivate </td> 102 <td>(</td> 103 <td class="paramtype">DeviceIntPtr </td> 104 <td class="paramname"><em>pDevice</em></td><td>)</td> 105 <td></td> 106 </tr> 107 </table> 108</div> 109<div class="memdoc"> 110<p>Create a private structure for use within this file. </p> 111 112<p>References <a class="el" href="struct__myPrivate.html#a6b26eb0acc0b932c8dee8277501e6273">_myPrivate::fd</a>, and <a class="el" href="struct__myPrivate.html#ae08ddb2f15fe104faf25f51f05c26033">_myPrivate::pDevice</a>.</p> 113 114</div> 115</div> 116<a class="anchor" id="a0eca0051ed4a3a117d504d6a82c65313"></a><!-- doxytag: member="usb-common.h::usbDestroyPrivate" ref="a0eca0051ed4a3a117d504d6a82c65313" args="(pointer priv)" --> 117<div class="memitem"> 118<div class="memproto"> 119 <table class="memname"> 120 <tr> 121 <td class="memname">void usbDestroyPrivate </td> 122 <td>(</td> 123 <td class="paramtype">pointer </td> 124 <td class="paramname"><em>priv</em></td><td>)</td> 125 <td></td> 126 </tr> 127 </table> 128</div> 129<div class="memdoc"> 130<p>Destroy a private structure. </p> 131 132</div> 133</div> 134<a class="anchor" id="a7f9b3a6d320a9ddbed689f4e12acb443"></a><!-- doxytag: member="usb-common.h::usbInit" ref="a7f9b3a6d320a9ddbed689f4e12acb443" args="(DevicePtr pDev, usbType type)" --> 135<div class="memitem"> 136<div class="memproto"> 137 <table class="memname"> 138 <tr> 139 <td class="memname">void usbInit </td> 140 <td>(</td> 141 <td class="paramtype">DevicePtr </td> 142 <td class="paramname"><em>pDev</em>, </td> 143 </tr> 144 <tr> 145 <td class="paramkey"></td> 146 <td></td> 147 <td class="paramtype"><a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0">usbType</a> </td> 148 <td class="paramname"><em>type</em> </td> 149 </tr> 150 <tr> 151 <td></td> 152 <td>)</td> 153 <td></td><td></td> 154 </tr> 155 </table> 156</div> 157<div class="memdoc"> 158<p>Initialized <em>pDev</em> as a <em>usbMouse</em>, <em>usbKeyboard</em>, or <em>usbOther</em> device. </p> 159 160<p>References <a class="el" href="usb-common_8c.html#a11bcea7c6bc7dbe400a3855f5b8676ce">FATAL1</a>, <a class="el" href="usb-common_8c.html#aacf069d346230dd96812d5395728eef2">GETPRIV</a>, <a class="el" href="dmxsigio_8c.html#a39d33ce33804efd4d52606d59071c6d8">O_NONBLOCK</a>, <a class="el" href="usb-common_8c.html#a36b621e66020a8ee4641d56c73c4226b">test_bit</a>, <a class="el" href="usb-common_8c.html#a228e7b7d6adf81ad78bc848896044085">test_bits</a>, <a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0ac0ee79f0c48b61dfd08fff502a2752a3">usbKeyboard</a>, <a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0a6bd9e53b1b5835e304e54ba13a227de7">usbMouse</a>, <a class="el" href="usb-common_8h.html#a5e4410bf95babe73bcecc612691fc2d0acf68ef2e5cae37647c412e73c93960fb">usbOther</a>, and <a class="el" href="usb-common_8c.html#a01c83154e667f74a79fac7b951208646">usbPrint()</a>.</p> 161 162<p>Referenced by <a class="el" href="usb-keyboard_8h.html#a294cdaa0f31f5f463562c72107b569f2">kbdUSBInit()</a>, <a class="el" href="usb-mouse_8h.html#a6c0a19ce4ec02df96f781152a8cc5d36">mouUSBInit()</a>, and <a class="el" href="usb-other_8h.html#ad1b551c84928693ea1b2edebf6c4fcff">othUSBInit()</a>.</p> 163 164</div> 165</div> 166<a class="anchor" id="aa86d87cabbc0971c51452970b7dc879f"></a><!-- doxytag: member="usb-common.h::usbOff" ref="aa86d87cabbc0971c51452970b7dc879f" args="(DevicePtr pDev)" --> 167<div class="memitem"> 168<div class="memproto"> 169 <table class="memname"> 170 <tr> 171 <td class="memname">void usbOff </td> 172 <td>(</td> 173 <td class="paramtype">DevicePtr </td> 174 <td class="paramname"><em>pDev</em></td><td>)</td> 175 <td></td> 176 </tr> 177 </table> 178</div> 179<div class="memdoc"> 180<p>Turn <em>pDev</em> off (i.e., stop taking input from <em>pDev</em>). </p> 181 182<p>References <a class="el" href="usb-common_8c.html#aacf069d346230dd96812d5395728eef2">GETPRIV</a>.</p> 183 184</div> 185</div> 186<a class="anchor" id="aea8c9cef438c8851ef7f47d7167152cb"></a><!-- doxytag: member="usb-common.h::usbRead" ref="aea8c9cef438c8851ef7f47d7167152cb" args="(DevicePtr pDev, dmxMotionProcPtr motion, dmxEnqueueProcPtr enqueue, int minButton, DMXBlockType block)" --> 187<div class="memitem"> 188<div class="memproto"> 189 <table class="memname"> 190 <tr> 191 <td class="memname">void usbRead </td> 192 <td>(</td> 193 <td class="paramtype">DevicePtr </td> 194 <td class="paramname"><em>pDev</em>, </td> 195 </tr> 196 <tr> 197 <td class="paramkey"></td> 198 <td></td> 199 <td class="paramtype"><a class="el" href="dmxinputinit_8h.html#a1279820425966adabf5c77357e4a289c">dmxMotionProcPtr</a> </td> 200 <td class="paramname"><em>motion</em>, </td> 201 </tr> 202 <tr> 203 <td class="paramkey"></td> 204 <td></td> 205 <td class="paramtype"><a class="el" href="dmxinputinit_8h.html#adbd955b9ddbc5ffe38ff65e3f068f205">dmxEnqueueProcPtr</a> </td> 206 <td class="paramname"><em>enqueue</em>, </td> 207 </tr> 208 <tr> 209 <td class="paramkey"></td> 210 <td></td> 211 <td class="paramtype">int </td> 212 <td class="paramname"><em>minButton</em>, </td> 213 </tr> 214 <tr> 215 <td class="paramkey"></td> 216 <td></td> 217 <td class="paramtype"><a class="el" href="dmxinput_8h.html#a3a7195ab3516c5354bac4ca80b2eedb7">DMXBlockType</a> </td> 218 <td class="paramname"><em>block</em> </td> 219 </tr> 220 <tr> 221 <td></td> 222 <td>)</td> 223 <td></td><td></td> 224 </tr> 225 </table> 226</div> 227<div class="memdoc"> 228 229</div> 230</div> 231</div> 232</div> 233 <div id="nav-path" class="navpath"> 234 <ul> 235 <li class="navelem"><a class="el" href="usb-common_8h.html">usb-common.h</a> </li> 236 <hr> 237 <address> 238 <small> 239 Generated June 29, 2004 for <a 240 href="http://dmx.sourceforge.net">Distributed Multihead X</a> by 241 <a href="http://www.doxygen.org/index.html">doxygen</a> 242 1.3.4. 243 </small> 244 </addres> 245 </hr> 246 </body> 247</html> 248