← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/xserver-xgl/intrepid

« back to all changes in this revision

Viewing changes to hw/dmx/doc/html/usb-common_8c.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthew Garrett
  • Date: 2006-02-13 14:21:43 UTC
  • Revision ID: james.westby@ubuntu.com-20060213142143-mad6z9xzem7hzxz9
Tags: upstream-7.0.0
Import upstream version 7.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
hw/dmx/doc/html/usb-common_8c.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>usb-common.c File Reference</h1><code>#include "<a class="el" href="usb-private_8h-source.html">usb-private.h</a>"</code><br>
 
12
<code>#include "<a class="el" href="usb-mouse_8h-source.html">usb-mouse.h</a>"</code><br>
 
13
<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>void&nbsp;</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>
 
17
 
 
18
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="usb-common_8c.html#a23">usbInit</a> (DevicePtr pDev, usbType type)</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="usb-common_8c.html#a24">usbOff</a> (DevicePtr pDev)</td></tr>
 
21
 
 
22
<tr><td class="memItemLeft" nowrap align=right valign=top>pointer&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="usb-common_8c.html#a25">usbCreatePrivate</a> (DeviceIntPtr pDevice)</td></tr>
 
23
 
 
24
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="usb-common_8c.html#a26">usbDestroyPrivate</a> (pointer priv)</td></tr>
 
25
 
 
26
</table>
 
27
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
28
Routines that are common between #usb-keyboard.c, #usb-mouse.c, and #usb-other.c<hr><h2>Function Documentation</h2>
 
29
<a class="anchor" name="a25" doxytag="usb-common.c::usbCreatePrivate" ></a><p>
 
30
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
31
  <tr>
 
32
    <td class="mdRow">
 
33
      <table cellpadding="0" cellspacing="0" border="0">
 
34
        <tr>
 
35
          <td class="md" nowrap valign="top"> pointer usbCreatePrivate </td>
 
36
          <td class="md" valign="top">(&nbsp;</td>
 
37
          <td class="md" nowrap valign="top">DeviceIntPtr&nbsp;</td>
 
38
          <td class="mdname1" valign="top" nowrap> <em>pDevice</em>          </td>
 
39
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
40
          <td class="md" nowrap></td>
 
41
        </tr>
 
42
 
 
43
      </table>
 
44
    </td>
 
45
  </tr>
 
46
</table>
 
47
<table cellspacing=5 cellpadding=0 border=0>
 
48
  <tr>
 
49
    <td>
 
50
      &nbsp;
 
51
    </td>
 
52
    <td>
 
53
 
 
54
<p>
 
55
Create a private structure for use within this file.     </td>
 
56
  </tr>
 
57
</table>
 
58
<a class="anchor" name="a26" doxytag="usb-common.c::usbDestroyPrivate" ></a><p>
 
59
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
60
  <tr>
 
61
    <td class="mdRow">
 
62
      <table cellpadding="0" cellspacing="0" border="0">
 
63
        <tr>
 
64
          <td class="md" nowrap valign="top"> void usbDestroyPrivate </td>
 
65
          <td class="md" valign="top">(&nbsp;</td>
 
66
          <td class="md" nowrap valign="top">pointer&nbsp;</td>
 
67
          <td class="mdname1" valign="top" nowrap> <em>priv</em>          </td>
 
68
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
69
          <td class="md" nowrap></td>
 
70
        </tr>
 
71
 
 
72
      </table>
 
73
    </td>
 
74
  </tr>
 
75
</table>
 
76
<table cellspacing=5 cellpadding=0 border=0>
 
77
  <tr>
 
78
    <td>
 
79
      &nbsp;
 
80
    </td>
 
81
    <td>
 
82
 
 
83
<p>
 
84
Destroy a private structure.     </td>
 
85
  </tr>
 
86
</table>
 
87
<a class="anchor" name="a23" doxytag="usb-common.c::usbInit" ></a><p>
 
88
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
89
  <tr>
 
90
    <td class="mdRow">
 
91
      <table cellpadding="0" cellspacing="0" border="0">
 
92
        <tr>
 
93
          <td class="md" nowrap valign="top"> void usbInit </td>
 
94
          <td class="md" valign="top">(&nbsp;</td>
 
95
          <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 
96
          <td class="mdname" nowrap> <em>pDev</em>, </td>
 
97
        </tr>
 
98
        <tr>
 
99
          <td></td>
 
100
          <td></td>
 
101
          <td class="md" nowrap>usbType&nbsp;</td>
 
102
          <td class="mdname" nowrap> <em>type</em></td>
 
103
        </tr>
 
104
        <tr>
 
105
          <td></td>
 
106
          <td class="md">)&nbsp;</td>
 
107
          <td class="md" colspan="2"></td>
 
108
        </tr>
 
109
 
 
110
      </table>
 
111
    </td>
 
112
  </tr>
 
113
</table>
 
114
<table cellspacing=5 cellpadding=0 border=0>
 
115
  <tr>
 
116
    <td>
 
117
      &nbsp;
 
118
    </td>
 
119
    <td>
 
120
 
 
121
<p>
 
122
Initialized <em>pDev</em> as a <em>usbMouse</em>, <em>usbKeyboard</em>, or <em>usbOther</em> device.     </td>
 
123
  </tr>
 
124
</table>
 
125
<a class="anchor" name="a24" doxytag="usb-common.c::usbOff" ></a><p>
 
126
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
127
  <tr>
 
128
    <td class="mdRow">
 
129
      <table cellpadding="0" cellspacing="0" border="0">
 
130
        <tr>
 
131
          <td class="md" nowrap valign="top"> void usbOff </td>
 
132
          <td class="md" valign="top">(&nbsp;</td>
 
133
          <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 
134
          <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 
135
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
136
          <td class="md" nowrap></td>
 
137
        </tr>
 
138
 
 
139
      </table>
 
140
    </td>
 
141
  </tr>
 
142
</table>
 
143
<table cellspacing=5 cellpadding=0 border=0>
 
144
  <tr>
 
145
    <td>
 
146
      &nbsp;
 
147
    </td>
 
148
    <td>
 
149
 
 
150
<p>
 
151
Turn <em>pDev</em> off (i.e., stop taking input from <em>pDev</em>).     </td>
 
152
  </tr>
 
153
</table>
 
154
<a class="anchor" name="a21" doxytag="usb-common.c::usbRead" ></a><p>
 
155
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
156
  <tr>
 
157
    <td class="mdRow">
 
158
      <table cellpadding="0" cellspacing="0" border="0">
 
159
        <tr>
 
160
          <td class="md" nowrap valign="top"> void usbRead </td>
 
161
          <td class="md" valign="top">(&nbsp;</td>
 
162
          <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 
163
          <td class="mdname" nowrap> <em>pDev</em>, </td>
 
164
        </tr>
 
165
        <tr>
 
166
          <td></td>
 
167
          <td></td>
 
168
          <td class="md" nowrap>MOTIONPROC&nbsp;</td>
 
169
          <td class="mdname" nowrap> <em>motion</em>, </td>
 
170
        </tr>
 
171
        <tr>
 
172
          <td></td>
 
173
          <td></td>
 
174
          <td class="md" nowrap>ENQUEUEPROC&nbsp;</td>
 
175
          <td class="mdname" nowrap> <em>enqueue</em>, </td>
 
176
        </tr>
 
177
        <tr>
 
178
          <td></td>
 
179
          <td></td>
 
180
          <td class="md" nowrap>int&nbsp;</td>
 
181
          <td class="mdname" nowrap> <em>minButton</em>, </td>
 
182
        </tr>
 
183
        <tr>
 
184
          <td></td>
 
185
          <td></td>
 
186
          <td class="md" nowrap>BLOCK&nbsp;</td>
 
187
          <td class="mdname" nowrap> <em>block</em></td>
 
188
        </tr>
 
189
        <tr>
 
190
          <td></td>
 
191
          <td class="md">)&nbsp;</td>
 
192
          <td class="md" colspan="2"></td>
 
193
        </tr>
 
194
 
 
195
      </table>
 
196
    </td>
 
197
  </tr>
 
198
</table>
 
199
<table cellspacing=5 cellpadding=0 border=0>
 
200
  <tr>
 
201
    <td>
 
202
      &nbsp;
 
203
    </td>
 
204
    <td>
 
205
 
 
206
<p>
 
207
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>
 
208
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>
 
209
  </tr>
 
210
</table>
 
211
    <hr>
 
212
    <address>
 
213
      <small>
 
214
        Generated June 29, 2004 for <a
 
215
        href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 
216
        <a href="http://www.doxygen.org/index.html">doxygen</a>
 
217
        1.3.4.
 
218
      </small>
 
219
    </addres>
 
220
    </hr>
 
221
  </body>
 
222
</html>