1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
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">
9
<!-- Generated by Doxygen 1.3.4 -->
10
<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>
11
<h1>lnx-keyboard.c File Reference</h1><code>#include "<a class="el" href="dmxinputinit_8h-source.html">dmxinputinit.h</a>"</code><br>
12
<code>#include "<a class="el" href="lnx-keyboard_8h-source.html">lnx-keyboard.h</a>"</code><br>
13
<code>#include "inputstr.h"</code><br>
14
<code>#include "Xos.h"</code><br>
15
<code>#include <sys/ioctl.h></code><br>
16
<code>#include <errno.h></code><br>
17
<code>#include <signal.h></code><br>
18
<code>#include <sys/vt.h></code><br>
19
<code>#include <sys/kd.h></code><br>
20
<code>#include <termios.h></code><br>
21
<code>#include "atKeynames.h"</code><br>
22
<code>#include "xf86Keymap.h"</code><br>
23
<code>#include <linux/keyboard.h></code><br>
24
<table border=0 cellpadding=0 cellspacing=0>
26
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
27
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="struct__myPrivate.html">_myPrivate</a></td></tr>
29
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
30
<tr><td class="memItemLeft" nowrap align=right valign=top>pointer </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a24">kbdLinuxCreatePrivate</a> (DeviceIntPtr pKeyboard)</td></tr>
32
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a25">kbdLinuxDestroyPrivate</a> (pointer priv)</td></tr>
34
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a26">kbdLinuxBell</a> (DevicePtr pDev, int percent, int volume, int pitch, int duration)</td></tr>
36
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a27">kbdLinuxCtrl</a> (DevicePtr pDev, KeybdCtrl *ctrl)</td></tr>
38
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a32">kbdLinuxVTPreSwitch</a> (pointer p)</td></tr>
40
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a33">kbdLinuxVTPostSwitch</a> (pointer p)</td></tr>
42
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a34">kbdLinuxVTSwitch</a> (pointer p, int vt, void(*switch_return)(pointer), pointer switch_return_data)</td></tr>
44
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a38">kbdLinuxInit</a> (DevicePtr pDev)</td></tr>
46
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a42">kbdLinuxRead</a> (DevicePtr pDev, MOTIONPROC motion, ENQUEUEPROC enqueue, CHECKPROC checkspecial, BLOCK block)</td></tr>
48
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a43">kbdLinuxOn</a> (DevicePtr pDev)</td></tr>
50
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a44">kbdLinuxOff</a> (DevicePtr pDev)</td></tr>
52
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="lnx-keyboard_8c.html#a47">kbdLinuxGetInfo</a> (DevicePtr pDev, <a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> info)</td></tr>
55
<hr><a name="_details"></a><h2>Detailed Description</h2>
56
This code implements a low-level device driver for the Linux keyboard. The code is derived from code by Thomas Roell, Orest Zborowski, and David Dawes (see the source code for complete references).<hr><h2>Function Documentation</h2>
57
<a class="anchor" name="a26" doxytag="lnx-keyboard.c::kbdLinuxBell" ></a><p>
58
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
61
<table cellpadding="0" cellspacing="0" border="0">
63
<td class="md" nowrap valign="top"> void kbdLinuxBell </td>
64
<td class="md" valign="top">( </td>
65
<td class="md" nowrap valign="top">DevicePtr </td>
66
<td class="mdname" nowrap> <em>pDev</em>, </td>
71
<td class="md" nowrap>int </td>
72
<td class="mdname" nowrap> <em>percent</em>, </td>
77
<td class="md" nowrap>int </td>
78
<td class="mdname" nowrap> <em>volume</em>, </td>
83
<td class="md" nowrap>int </td>
84
<td class="mdname" nowrap> <em>pitch</em>, </td>
89
<td class="md" nowrap>int </td>
90
<td class="mdname" nowrap> <em>duration</em></td>
94
<td class="md">) </td>
95
<td class="md" colspan="2"></td>
102
<table cellspacing=5 cellpadding=0 border=0>
111
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>
112
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>
115
<a class="anchor" name="a24" doxytag="lnx-keyboard.c::kbdLinuxCreatePrivate" ></a><p>
116
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
119
<table cellpadding="0" cellspacing="0" border="0">
121
<td class="md" nowrap valign="top"> pointer kbdLinuxCreatePrivate </td>
122
<td class="md" valign="top">( </td>
123
<td class="md" nowrap valign="top">DeviceIntPtr </td>
124
<td class="mdname1" valign="top" nowrap> <em>pKeyboard</em> </td>
125
<td class="md" valign="top"> ) </td>
126
<td class="md" nowrap></td>
133
<table cellspacing=5 cellpadding=0 border=0>
141
Create a private structure for use within this file. </td>
144
<a class="anchor" name="a27" doxytag="lnx-keyboard.c::kbdLinuxCtrl" ></a><p>
145
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
148
<table cellpadding="0" cellspacing="0" border="0">
150
<td class="md" nowrap valign="top"> void kbdLinuxCtrl </td>
151
<td class="md" valign="top">( </td>
152
<td class="md" nowrap valign="top">DevicePtr </td>
153
<td class="mdname" nowrap> <em>pDev</em>, </td>
158
<td class="md" nowrap>KeybdCtrl * </td>
159
<td class="mdname" nowrap> <em>ctrl</em></td>
163
<td class="md">) </td>
164
<td class="md" colspan="2"></td>
171
<table cellspacing=5 cellpadding=0 border=0>
182
<a class="anchor" name="a25" doxytag="lnx-keyboard.c::kbdLinuxDestroyPrivate" ></a><p>
183
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
186
<table cellpadding="0" cellspacing="0" border="0">
188
<td class="md" nowrap valign="top"> void kbdLinuxDestroyPrivate </td>
189
<td class="md" valign="top">( </td>
190
<td class="md" nowrap valign="top">pointer </td>
191
<td class="mdname1" valign="top" nowrap> <em>priv</em> </td>
192
<td class="md" valign="top"> ) </td>
193
<td class="md" nowrap></td>
200
<table cellspacing=5 cellpadding=0 border=0>
208
Destroy a private structure. </td>
211
<a class="anchor" name="a47" doxytag="lnx-keyboard.c::kbdLinuxGetInfo" ></a><p>
212
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
215
<table cellpadding="0" cellspacing="0" border="0">
217
<td class="md" nowrap valign="top"> void kbdLinuxGetInfo </td>
218
<td class="md" valign="top">( </td>
219
<td class="md" nowrap valign="top">DevicePtr </td>
220
<td class="mdname" nowrap> <em>pDev</em>, </td>
225
<td class="md" nowrap><a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> </td>
226
<td class="mdname" nowrap> <em>info</em></td>
230
<td class="md">) </td>
231
<td class="md" colspan="2"></td>
238
<table cellspacing=5 cellpadding=0 border=0>
246
Fill the <em>info</em> structure with information needed to initialize <em>pDev</em>. </td>
249
<a class="anchor" name="a38" doxytag="lnx-keyboard.c::kbdLinuxInit" ></a><p>
250
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
253
<table cellpadding="0" cellspacing="0" border="0">
255
<td class="md" nowrap valign="top"> void kbdLinuxInit </td>
256
<td class="md" valign="top">( </td>
257
<td class="md" nowrap valign="top">DevicePtr </td>
258
<td class="mdname1" valign="top" nowrap> <em>pDev</em> </td>
259
<td class="md" valign="top"> ) </td>
260
<td class="md" nowrap></td>
267
<table cellspacing=5 cellpadding=0 border=0>
275
Initialize the <em>pDev</em> as a Linux keyboard. </td>
278
<a class="anchor" name="a44" doxytag="lnx-keyboard.c::kbdLinuxOff" ></a><p>
279
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
282
<table cellpadding="0" cellspacing="0" border="0">
284
<td class="md" nowrap valign="top"> void kbdLinuxOff </td>
285
<td class="md" valign="top">( </td>
286
<td class="md" nowrap valign="top">DevicePtr </td>
287
<td class="mdname1" valign="top" nowrap> <em>pDev</em> </td>
288
<td class="md" valign="top"> ) </td>
289
<td class="md" nowrap></td>
296
<table cellspacing=5 cellpadding=0 border=0>
304
Turn <em>pDev</em> off (i.e., stop taking input from <em>pDev</em>). </td>
307
<a class="anchor" name="a43" doxytag="lnx-keyboard.c::kbdLinuxOn" ></a><p>
308
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
311
<table cellpadding="0" cellspacing="0" border="0">
313
<td class="md" nowrap valign="top"> int kbdLinuxOn </td>
314
<td class="md" valign="top">( </td>
315
<td class="md" nowrap valign="top">DevicePtr </td>
316
<td class="mdname1" valign="top" nowrap> <em>pDev</em> </td>
317
<td class="md" valign="top"> ) </td>
318
<td class="md" nowrap></td>
325
<table cellspacing=5 cellpadding=0 border=0>
333
Turn <em>pDev</em> on (i.e., take input from <em>pDev</em>). </td>
336
<a class="anchor" name="a42" doxytag="lnx-keyboard.c::kbdLinuxRead" ></a><p>
337
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
340
<table cellpadding="0" cellspacing="0" border="0">
342
<td class="md" nowrap valign="top"> void kbdLinuxRead </td>
343
<td class="md" valign="top">( </td>
344
<td class="md" nowrap valign="top">DevicePtr </td>
345
<td class="mdname" nowrap> <em>pDev</em>, </td>
350
<td class="md" nowrap>MOTIONPROC </td>
351
<td class="mdname" nowrap> <em>motion</em>, </td>
356
<td class="md" nowrap>ENQUEUEPROC </td>
357
<td class="mdname" nowrap> <em>enqueue</em>, </td>
362
<td class="md" nowrap>CHECKPROC </td>
363
<td class="mdname" nowrap> <em>checkspecial</em>, </td>
368
<td class="md" nowrap>BLOCK </td>
369
<td class="mdname" nowrap> <em>block</em></td>
373
<td class="md">) </td>
374
<td class="md" colspan="2"></td>
381
<table cellspacing=5 cellpadding=0 border=0>
389
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, check for special keys with the <em>checkspecial</em> function and 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. </td>
392
<a class="anchor" name="a33" doxytag="lnx-keyboard.c::kbdLinuxVTPostSwitch" ></a><p>
393
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
396
<table cellpadding="0" cellspacing="0" border="0">
398
<td class="md" nowrap valign="top"> void kbdLinuxVTPostSwitch </td>
399
<td class="md" valign="top">( </td>
400
<td class="md" nowrap valign="top">pointer </td>
401
<td class="mdname1" valign="top" nowrap> <em>p</em> </td>
402
<td class="md" valign="top"> ) </td>
403
<td class="md" nowrap></td>
410
<table cellspacing=5 cellpadding=0 border=0>
418
Currently unused hook called after returning from a VT switch. </td>
421
<a class="anchor" name="a32" doxytag="lnx-keyboard.c::kbdLinuxVTPreSwitch" ></a><p>
422
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
425
<table cellpadding="0" cellspacing="0" border="0">
427
<td class="md" nowrap valign="top"> void kbdLinuxVTPreSwitch </td>
428
<td class="md" valign="top">( </td>
429
<td class="md" nowrap valign="top">pointer </td>
430
<td class="mdname1" valign="top" nowrap> <em>p</em> </td>
431
<td class="md" valign="top"> ) </td>
432
<td class="md" nowrap></td>
439
<table cellspacing=5 cellpadding=0 border=0>
447
Currently unused hook called prior to an VT switch. </td>
450
<a class="anchor" name="a34" doxytag="lnx-keyboard.c::kbdLinuxVTSwitch" ></a><p>
451
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
454
<table cellpadding="0" cellspacing="0" border="0">
456
<td class="md" nowrap valign="top"> int kbdLinuxVTSwitch </td>
457
<td class="md" valign="top">( </td>
458
<td class="md" nowrap valign="top">pointer </td>
459
<td class="mdname" nowrap> <em>p</em>, </td>
464
<td class="md" nowrap>int </td>
465
<td class="mdname" nowrap> <em>vt</em>, </td>
470
<td class="md" nowrap>void(* </td>
471
<td class="mdname" nowrap> <em>switch_return</em>)(pointer), </td>
476
<td class="md" nowrap>pointer </td>
477
<td class="mdname" nowrap> <em>switch_return_data</em></td>
481
<td class="md">) </td>
482
<td class="md" colspan="2"></td>
489
<table cellspacing=5 cellpadding=0 border=0>
497
Tell the operating system to switch to <em>vt</em>. The <em>switch_return</em> function is called with the <em>switch_return_data</em> when the VT is switched back to the pre-switch VT (i.e., the user returns to the DMX session). </td>
503
Generated June 29, 2004 for <a
504
href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
505
<a href="http://www.doxygen.org/index.html">doxygen</a>
added
removed
hw/dmx/doc/html/lnx-keyboard_8c.html
