xorg-server-1.4/hw/dmx/doc/html/lnx-keyboard_8h.html

   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.3.4 -->
  10 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
  11 <h1>lnx-keyboard.h File Reference</h1>
  12 <p>
  13 <a href="lnx-keyboard_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  14 <tr><td></td></tr>
  15 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  16 <tr><td class="memItemLeft" nowrap align=right valign=top>pointer&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a0">kbdLinuxCreatePrivate</a> (DeviceIntPtr pKeyboard)</td></tr>
  17
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a1">kbdLinuxDestroyPrivate</a> (pointer private)</td></tr>
  19
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a2">kbdLinuxInit</a> (DevicePtr pDev)</td></tr>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a3">kbdLinuxGetInfo</a> (DevicePtr pDev, <a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> info)</td></tr>
  23
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a4">kbdLinuxOn</a> (DevicePtr pDev)</td></tr>
  25
  26 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a5">kbdLinuxOff</a> (DevicePtr pDev)</td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a6">kbdLinuxVTPreSwitch</a> (pointer p)</td></tr>
  29
  30 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a7">kbdLinuxVTPostSwitch</a> (pointer p)</td></tr>
  31
  32 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a10">kbdLinuxCtrl</a> (DevicePtr pDev, KeybdCtrl *ctrl)</td></tr>
  33
  34 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8h.html#a11">kbdLinuxBell</a> (DevicePtr pDev, int percent, int volume, int pitch, int duration)</td></tr>
  35
  36 </table>
  37 <hr><a name="_details"></a><h2>Detailed Description</h2>
  38 Interface to Linux keyboard driver. <dl compact><dt><b>See also:</b></dt><dd>lnx-keyboard.c</dd></dl>
  39 <hr><h2>Function Documentation</h2>
  40 <a class="anchor" name="a11" doxytag="lnx-keyboard.h::kbdLinuxBell" ></a><p>
  41 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  42   <tr>
  43     <td class="mdRow">
  44       <table cellpadding="0" cellspacing="0" border="0">
  45         <tr>
  46           <td class="md" nowrap valign="top"> void kbdLinuxBell </td>
  47           <td class="md" valign="top">(&nbsp;</td>
  48           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
  49           <td class="mdname" nowrap> <em>pDev</em>, </td>
  50         </tr>
  51         <tr>
  52           <td></td>
  53           <td></td>
  54           <td class="md" nowrap>int&nbsp;</td>
  55           <td class="mdname" nowrap> <em>percent</em>, </td>
  56         </tr>
  57         <tr>
  58           <td></td>
  59           <td></td>
  60           <td class="md" nowrap>int&nbsp;</td>
  61           <td class="mdname" nowrap> <em>volume</em>, </td>
  62         </tr>
  63         <tr>
  64           <td></td>
  65           <td></td>
  66           <td class="md" nowrap>int&nbsp;</td>
  67           <td class="mdname" nowrap> <em>pitch</em>, </td>
  68         </tr>
  69         <tr>
  70           <td></td>
  71           <td></td>
  72           <td class="md" nowrap>int&nbsp;</td>
  73           <td class="mdname" nowrap> <em>duration</em></td>
  74         </tr>
  75         <tr>
  76           <td></td>
  77           <td class="md">)&nbsp;</td>
  78           <td class="md" colspan="2"></td>
  79         </tr>
  80
  81       </table>
  82     </td>
  83   </tr>
  84 </table>
  85 <table cellspacing=5 cellpadding=0 border=0>
  86   <tr>
  87     <td>
  88       &nbsp;
  89     </td>
  90     <td>
  91
  92 <p>
  93 Ring the bell.<p>
  94 Note: we completely ignore the <em>volume</em>, since Linux's ioctl() interface does not provide a way to control it. If it did, the XBell manpage tells how the actual volume is a function of the percent and the (base) volume.<p>
  95 Note that most of the other PC-based bell drivers compute the duration for KDMKTONE as a function of the volume and the duration. For some drivers, the duration is only measured in mS if the volume is 50, and is scaled by the volume for other values. This seems confusing and possibly incorrect (the xset man page says that the bell will be "as closely as it can to the user's specifications" -- if we ignore the volume and set the duration correctly, then we'll get one parameter "wrong" -- but if we use the volume to scale the duration, then we'll get both parameters "wrong").     </td>
  96   </tr>
  97 </table>
  98 <a class="anchor" name="a0" doxytag="lnx-keyboard.h::kbdLinuxCreatePrivate" ></a><p>
  99 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 100   <tr>
 101     <td class="mdRow">
 102       <table cellpadding="0" cellspacing="0" border="0">
 103         <tr>
 104           <td class="md" nowrap valign="top"> pointer kbdLinuxCreatePrivate </td>
 105           <td class="md" valign="top">(&nbsp;</td>
 106           <td class="md" nowrap valign="top">DeviceIntPtr&nbsp;</td>
 107           <td class="mdname1" valign="top" nowrap> <em>pKeyboard</em>          </td>
 108           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 109           <td class="md" nowrap></td>
 110         </tr>
 111
 112       </table>
 113     </td>
 114   </tr>
 115 </table>
 116 <table cellspacing=5 cellpadding=0 border=0>
 117   <tr>
 118     <td>
 119       &nbsp;
 120     </td>
 121     <td>
 122
 123 <p>
 124 Create a private structure for use within this file.     </td>
 125   </tr>
 126 </table>
 127 <a class="anchor" name="a10" doxytag="lnx-keyboard.h::kbdLinuxCtrl" ></a><p>
 128 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 129   <tr>
 130     <td class="mdRow">
 131       <table cellpadding="0" cellspacing="0" border="0">
 132         <tr>
 133           <td class="md" nowrap valign="top"> void kbdLinuxCtrl </td>
 134           <td class="md" valign="top">(&nbsp;</td>
 135           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 136           <td class="mdname" nowrap> <em>pDev</em>, </td>
 137         </tr>
 138         <tr>
 139           <td></td>
 140           <td></td>
 141           <td class="md" nowrap>KeybdCtrl *&nbsp;</td>
 142           <td class="mdname" nowrap> <em>ctrl</em></td>
 143         </tr>
 144         <tr>
 145           <td></td>
 146           <td class="md">)&nbsp;</td>
 147           <td class="md" colspan="2"></td>
 148         </tr>
 149
 150       </table>
 151     </td>
 152   </tr>
 153 </table>
 154 <table cellspacing=5 cellpadding=0 border=0>
 155   <tr>
 156     <td>
 157       &nbsp;
 158     </td>
 159     <td>
 160
 161 <p>
 162 Set the LEDs.     </td>
 163   </tr>
 164 </table>
 165 <a class="anchor" name="a1" doxytag="lnx-keyboard.h::kbdLinuxDestroyPrivate" ></a><p>
 166 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 167   <tr>
 168     <td class="mdRow">
 169       <table cellpadding="0" cellspacing="0" border="0">
 170         <tr>
 171           <td class="md" nowrap valign="top"> void kbdLinuxDestroyPrivate </td>
 172           <td class="md" valign="top">(&nbsp;</td>
 173           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 174           <td class="mdname1" valign="top" nowrap> <em>priv</em>          </td>
 175           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 176           <td class="md" nowrap></td>
 177         </tr>
 178
 179       </table>
 180     </td>
 181   </tr>
 182 </table>
 183 <table cellspacing=5 cellpadding=0 border=0>
 184   <tr>
 185     <td>
 186       &nbsp;
 187     </td>
 188     <td>
 189
 190 <p>
 191 Destroy a private structure.     </td>
 192   </tr>
 193 </table>
 194 <a class="anchor" name="a3" doxytag="lnx-keyboard.h::kbdLinuxGetInfo" ></a><p>
 195 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 196   <tr>
 197     <td class="mdRow">
 198       <table cellpadding="0" cellspacing="0" border="0">
 199         <tr>
 200           <td class="md" nowrap valign="top"> void kbdLinuxGetInfo </td>
 201           <td class="md" valign="top">(&nbsp;</td>
 202           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 203           <td class="mdname" nowrap> <em>pDev</em>, </td>
 204         </tr>
 205         <tr>
 206           <td></td>
 207           <td></td>
 208           <td class="md" nowrap><a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a>&nbsp;</td>
 209           <td class="mdname" nowrap> <em>info</em></td>
 210         </tr>
 211         <tr>
 212           <td></td>
 213           <td class="md">)&nbsp;</td>
 214           <td class="md" colspan="2"></td>
 215         </tr>
 216
 217       </table>
 218     </td>
 219   </tr>
 220 </table>
 221 <table cellspacing=5 cellpadding=0 border=0>
 222   <tr>
 223     <td>
 224       &nbsp;
 225     </td>
 226     <td>
 227
 228 <p>
 229 Fill the <em>info</em> structure with information needed to initialize <em>pDev</em>.     </td>
 230   </tr>
 231 </table>
 232 <a class="anchor" name="a2" doxytag="lnx-keyboard.h::kbdLinuxInit" ></a><p>
 233 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 234   <tr>
 235     <td class="mdRow">
 236       <table cellpadding="0" cellspacing="0" border="0">
 237         <tr>
 238           <td class="md" nowrap valign="top"> void kbdLinuxInit </td>
 239           <td class="md" valign="top">(&nbsp;</td>
 240           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 241           <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 242           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 243           <td class="md" nowrap></td>
 244         </tr>
 245
 246       </table>
 247     </td>
 248   </tr>
 249 </table>
 250 <table cellspacing=5 cellpadding=0 border=0>
 251   <tr>
 252     <td>
 253       &nbsp;
 254     </td>
 255     <td>
 256
 257 <p>
 258 Initialize the <em>pDev</em> as a Linux keyboard.     </td>
 259   </tr>
 260 </table>
 261 <a class="anchor" name="a5" doxytag="lnx-keyboard.h::kbdLinuxOff" ></a><p>
 262 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 263   <tr>
 264     <td class="mdRow">
 265       <table cellpadding="0" cellspacing="0" border="0">
 266         <tr>
 267           <td class="md" nowrap valign="top"> void kbdLinuxOff </td>
 268           <td class="md" valign="top">(&nbsp;</td>
 269           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 270           <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 271           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 272           <td class="md" nowrap></td>
 273         </tr>
 274
 275       </table>
 276     </td>
 277   </tr>
 278 </table>
 279 <table cellspacing=5 cellpadding=0 border=0>
 280   <tr>
 281     <td>
 282       &nbsp;
 283     </td>
 284     <td>
 285
 286 <p>
 287 Turn <em>pDev</em> off (i.e., stop taking input from <em>pDev</em>).     </td>
 288   </tr>
 289 </table>
 290 <a class="anchor" name="a4" doxytag="lnx-keyboard.h::kbdLinuxOn" ></a><p>
 291 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 292   <tr>
 293     <td class="mdRow">
 294       <table cellpadding="0" cellspacing="0" border="0">
 295         <tr>
 296           <td class="md" nowrap valign="top"> int kbdLinuxOn </td>
 297           <td class="md" valign="top">(&nbsp;</td>
 298           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 299           <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 300           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 301           <td class="md" nowrap></td>
 302         </tr>
 303
 304       </table>
 305     </td>
 306   </tr>
 307 </table>
 308 <table cellspacing=5 cellpadding=0 border=0>
 309   <tr>
 310     <td>
 311       &nbsp;
 312     </td>
 313     <td>
 314
 315 <p>
 316 Turn <em>pDev</em> on (i.e., take input from <em>pDev</em>).     </td>
 317   </tr>
 318 </table>
 319 <a class="anchor" name="a7" doxytag="lnx-keyboard.h::kbdLinuxVTPostSwitch" ></a><p>
 320 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 321   <tr>
 322     <td class="mdRow">
 323       <table cellpadding="0" cellspacing="0" border="0">
 324         <tr>
 325           <td class="md" nowrap valign="top"> void kbdLinuxVTPostSwitch </td>
 326           <td class="md" valign="top">(&nbsp;</td>
 327           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 328           <td class="mdname1" valign="top" nowrap> <em>p</em>          </td>
 329           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 330           <td class="md" nowrap></td>
 331         </tr>
 332
 333       </table>
 334     </td>
 335   </tr>
 336 </table>
 337 <table cellspacing=5 cellpadding=0 border=0>
 338   <tr>
 339     <td>
 340       &nbsp;
 341     </td>
 342     <td>
 343
 344 <p>
 345 Currently unused hook called after returning from a VT switch.     </td>
 346   </tr>
 347 </table>
 348 <a class="anchor" name="a6" doxytag="lnx-keyboard.h::kbdLinuxVTPreSwitch" ></a><p>
 349 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 350   <tr>
 351     <td class="mdRow">
 352       <table cellpadding="0" cellspacing="0" border="0">
 353         <tr>
 354           <td class="md" nowrap valign="top"> void kbdLinuxVTPreSwitch </td>
 355           <td class="md" valign="top">(&nbsp;</td>
 356           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 357           <td class="mdname1" valign="top" nowrap> <em>p</em>          </td>
 358           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 359           <td class="md" nowrap></td>
 360         </tr>
 361
 362       </table>
 363     </td>
 364   </tr>
 365 </table>
 366 <table cellspacing=5 cellpadding=0 border=0>
 367   <tr>
 368     <td>
 369       &nbsp;
 370     </td>
 371     <td>
 372
 373 <p>
 374 Currently unused hook called prior to an VT switch.     </td>
 375   </tr>
 376 </table>
 377     <hr>
 378     <address>
 379       <small>
 380         Generated June 29, 2004 for <a
 381         href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 382         <a href="http://www.doxygen.org/index.html">doxygen</a>
 383         1.3.4.
 384       </small>
 385     </addres>
 386     </hr>
 387   </body>
 388 </html>