223 lines
		
	
	
		
			8.0 KiB
		
	
	
	
		
			HTML
		
	
	
	
			
		
		
	
	
			223 lines
		
	
	
		
			8.0 KiB
		
	
	
	
		
			HTML
		
	
	
	
| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 | |
| <html>
 | |
|   <head>
 | |
|     <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 | |
|     <title>File Index</title>
 | |
|     <link href="doxygen.css" rel="stylesheet" type="text/css">
 | |
|   </head>
 | |
|   <body>
 | |
| <!-- Generated by Doxygen 1.3.4 -->
 | |
| <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
 | |
| <h1>usb-common.c File Reference</h1><code>#include "<a class="el" href="usb-private_8h-source.html">usb-private.h</a>"</code><br>
 | |
| <code>#include "<a class="el" href="usb-mouse_8h-source.html">usb-mouse.h</a>"</code><br>
 | |
| <table border=0 cellpadding=0 cellspacing=0>
 | |
| <tr><td></td></tr>
 | |
| <tr><td colspan=2><br><h2>Functions</h2></td></tr>
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="usb-common_8c.html#a21">usbRead</a> (DevicePtr pDev, MOTIONPROC motion, ENQUEUEPROC enqueue, int minButton, BLOCK block)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="usb-common_8c.html#a23">usbInit</a> (DevicePtr pDev, usbType type)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="usb-common_8c.html#a24">usbOff</a> (DevicePtr pDev)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>pointer </td><td class="memItemRight" valign=bottom><a class="el" href="usb-common_8c.html#a25">usbCreatePrivate</a> (DeviceIntPtr pDevice)</td></tr>
 | |
| 
 | |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="usb-common_8c.html#a26">usbDestroyPrivate</a> (pointer priv)</td></tr>
 | |
| 
 | |
| </table>
 | |
| <hr><a name="_details"></a><h2>Detailed Description</h2>
 | |
| Routines that are common between #usb-keyboard.c, #usb-mouse.c, and #usb-other.c<hr><h2>Function Documentation</h2>
 | |
| <a class="anchor" name="a25" doxytag="usb-common.c::usbCreatePrivate" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> pointer usbCreatePrivate </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top">DeviceIntPtr </td>
 | |
|           <td class="mdname1" valign="top" nowrap> <em>pDevice</em>          </td>
 | |
|           <td class="md" valign="top"> ) </td>
 | |
|           <td class="md" nowrap></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Create a private structure for use within this file.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a26" doxytag="usb-common.c::usbDestroyPrivate" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> void usbDestroyPrivate </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top">pointer </td>
 | |
|           <td class="mdname1" valign="top" nowrap> <em>priv</em>          </td>
 | |
|           <td class="md" valign="top"> ) </td>
 | |
|           <td class="md" nowrap></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Destroy a private structure.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a23" doxytag="usb-common.c::usbInit" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> void usbInit </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top">DevicePtr </td>
 | |
|           <td class="mdname" nowrap> <em>pDev</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td></td>
 | |
|           <td class="md" nowrap>usbType </td>
 | |
|           <td class="mdname" nowrap> <em>type</em></td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td class="md">) </td>
 | |
|           <td class="md" colspan="2"></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Initialized <em>pDev</em> as a <em>usbMouse</em>, <em>usbKeyboard</em>, or <em>usbOther</em> device.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a24" doxytag="usb-common.c::usbOff" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> void usbOff </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top">DevicePtr </td>
 | |
|           <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 | |
|           <td class="md" valign="top"> ) </td>
 | |
|           <td class="md" nowrap></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Turn <em>pDev</em> off (i.e., stop taking input from <em>pDev</em>).     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <a class="anchor" name="a21" doxytag="usb-common.c::usbRead" ></a><p>
 | |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 | |
|   <tr>
 | |
|     <td class="mdRow">
 | |
|       <table cellpadding="0" cellspacing="0" border="0">
 | |
|         <tr>
 | |
|           <td class="md" nowrap valign="top"> void usbRead </td>
 | |
|           <td class="md" valign="top">( </td>
 | |
|           <td class="md" nowrap valign="top">DevicePtr </td>
 | |
|           <td class="mdname" nowrap> <em>pDev</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td></td>
 | |
|           <td class="md" nowrap>MOTIONPROC </td>
 | |
|           <td class="mdname" nowrap> <em>motion</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td></td>
 | |
|           <td class="md" nowrap>ENQUEUEPROC </td>
 | |
|           <td class="mdname" nowrap> <em>enqueue</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td></td>
 | |
|           <td class="md" nowrap>int </td>
 | |
|           <td class="mdname" nowrap> <em>minButton</em>, </td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td></td>
 | |
|           <td class="md" nowrap>BLOCK </td>
 | |
|           <td class="mdname" nowrap> <em>block</em></td>
 | |
|         </tr>
 | |
|         <tr>
 | |
|           <td></td>
 | |
|           <td class="md">) </td>
 | |
|           <td class="md" colspan="2"></td>
 | |
|         </tr>
 | |
| 
 | |
|       </table>
 | |
|     </td>
 | |
|   </tr>
 | |
| </table>
 | |
| <table cellspacing=5 cellpadding=0 border=0>
 | |
|   <tr>
 | |
|     <td>
 | |
|        
 | |
|     </td>
 | |
|     <td>
 | |
| 
 | |
| <p>
 | |
| Read an event from the <em>pDev</em> device. If the event is a motion event, enqueue it with the <em>motion</em> function. Otherwise, enqueue the event with the <em>enqueue</em> function. The <em>block</em> type is passed to the functions so that they may block SIGIO handling as appropriate to the caller of this function.<p>
 | |
| Since USB devices return EV_KEY events for buttons and keys, <em>minButton</em> is used to decide if a Button or Key event should be queued.     </td>
 | |
|   </tr>
 | |
| </table>
 | |
|     <hr>
 | |
|     <address>
 | |
|       <small>
 | |
|         Generated June 29, 2004 for <a
 | |
|         href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 | |
|         <a href="http://www.doxygen.org/index.html">doxygen</a>
 | |
|         1.3.4.
 | |
|       </small>
 | |
|     </addres>
 | |
|     </hr>
 | |
|   </body>
 | |
| </html>
 |