diff options
Diffstat (limited to 'Documentation/input')
| -rw-r--r-- | Documentation/input/amijoy.txt | 4 | ||||
| -rw-r--r-- | Documentation/input/atarikbd.txt | 10 | ||||
| -rw-r--r-- | Documentation/input/cs461x.txt | 2 | ||||
| -rw-r--r-- | Documentation/input/ff.txt | 114 | ||||
| -rw-r--r-- | Documentation/input/gameport-programming.txt | 4 | ||||
| -rw-r--r-- | Documentation/input/input.txt | 31 | ||||
| -rw-r--r-- | Documentation/input/joystick-parport.txt | 8 | ||||
| -rw-r--r-- | Documentation/input/joystick.txt | 2 | ||||
| -rw-r--r-- | Documentation/input/yealink.txt | 4 |
9 files changed, 75 insertions, 104 deletions
diff --git a/Documentation/input/amijoy.txt b/Documentation/input/amijoy.txt index 3b8b2d43a68e6..4f0e89df5c519 100644 --- a/Documentation/input/amijoy.txt +++ b/Documentation/input/amijoy.txt @@ -79,10 +79,10 @@ JOY0DAT Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 X7 X6 X5 X4 X3 X2 X1 X0 JOY1DAT Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 X7 X6 X5 X4 X3 X2 X1 X0 0=LEFT CONTROLLER PAIR, 1=RIGHT CONTROLLER PAIR. - (4 counters total).The bit usage for both left and right + (4 counters total). The bit usage for both left and right addresses is shown below. Each 6 bit counter (Y7-Y2,X7-X2) is clocked by 2 of the signals input from the mouse serial - stream. Starting with first bit recived: + stream. Starting with first bit received: +-------------------+-----------------------------------------+ | Serial | Bit Name | Description | diff --git a/Documentation/input/atarikbd.txt b/Documentation/input/atarikbd.txt index 8fb896c74114a..1e7e5853ba4c7 100644 --- a/Documentation/input/atarikbd.txt +++ b/Documentation/input/atarikbd.txt @@ -10,7 +10,7 @@ provides a convenient connection point for a mouse and switch-type joysticks. The ikbd processor also maintains a time-of-day clock with one second resolution. The ikbd has been designed to be general enough that it can be used with a -ariety of new computer products. Product variations in a number of +variety of new computer products. Product variations in a number of keyswitches, mouse resolution, etc. can be accommodated. The ikbd communicates with the main processor over a high speed bi-directional serial interface. It can function in a variety of modes to facilitate @@ -30,7 +30,7 @@ is obtained by ORing 0x80 with the make code. The special codes 0xF6 through 0xFF are reserved for use as follows: 0xF6 status report 0xF7 absolute mouse position record - 0xF8-0xFB relative mouse position records(lsbs determind by + 0xF8-0xFB relative mouse position records (lsbs determined by mouse button states) 0xFC time-of-day 0xFD joystick report (both sticks) @@ -84,7 +84,7 @@ selected. 4.2 Absolute Position reporting The ikbd can also maintain absolute mouse position. Commands exist for -reseting the mouse position, setting X/Y scaling, and interrogating the +resetting the mouse position, setting X/Y scaling, and interrogating the current mouse position. 4.3 Mouse Cursor Key Mode @@ -406,7 +406,7 @@ INTERROGATION MODE. 9.18 SET JOYSTICK MONITORING 0x17 - rate ; time between samples in hundreths of a second + rate ; time between samples in hundredths of a second Returns: (in packets of two as long as in mode) %000000xy ; where y is JOYSTICK1 Fire button ; and x is JOYSTICK0 Fire button @@ -522,7 +522,7 @@ controller memory. The time between data bytes must be less than 20ms. 0x20 ; memory access { data } ; 6 data bytes starting at ADR -This comand permits the host to read from the ikbd controller memory. +This command permits the host to read from the ikbd controller memory. 9.26 CONTROLLER EXECUTE diff --git a/Documentation/input/cs461x.txt b/Documentation/input/cs461x.txt index 6181747a14d8a..afe0d6543e093 100644 --- a/Documentation/input/cs461x.txt +++ b/Documentation/input/cs461x.txt @@ -27,7 +27,7 @@ This driver have the basic support for PCI devices only; there is no ISA or PnP ISA cards supported. AFAIK the ns558 have support for Crystal ISA and PnP ISA series. -The driver works witn ALSA drivers simultaneously. For exmple, the xracer +The driver works with ALSA drivers simultaneously. For example, the xracer uses joystick as input device and PCM device as sound output in one time. There are no sound or input collisions detected. The source code have comments about them; but I've found the joystick can be initialized diff --git a/Documentation/input/ff.txt b/Documentation/input/ff.txt index c7e10eaff203c..085eb15b45b7c 100644 --- a/Documentation/input/ff.txt +++ b/Documentation/input/ff.txt @@ -1,78 +1,48 @@ Force feedback for Linux. By Johann Deneux <deneux@ifrance.com> on 2001/04/22. +Updated by Anssi Hannula <anssi.hannula@gmail.com> on 2006/04/09. You may redistribute this file. Please remember to include shape.fig and interactive.fig as well. ---------------------------------------------------------------------------- -0. Introduction +1. Introduction ~~~~~~~~~~~~~~~ This document describes how to use force feedback devices under Linux. The goal is not to support these devices as if they were simple input-only devices (as it is already the case), but to really enable the rendering of force effects. -At the moment, only I-Force devices are supported, and not officially. That -means I had to find out how the protocol works on my own. Of course, the -information I managed to grasp is far from being complete, and I can not -guarranty that this driver will work for you. -This document only describes the force feedback part of the driver for I-Force -devices. Please read joystick.txt before reading further this document. +This document only describes the force feedback part of the Linux input +interface. Please read joystick.txt and input.txt before reading further this +document. 2. Instructions to the user ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Here are instructions on how to compile and use the driver. In fact, this -driver is the normal iforce, input and evdev drivers written by Vojtech -Pavlik, plus additions to support force feedback. +To enable force feedback, you have to: + +1. have your kernel configured with evdev and a driver that supports your + device. +2. make sure evdev module is loaded and /dev/input/event* device files are + created. Before you start, let me WARN you that some devices shake violently during the initialisation phase. This happens for example with my "AVB Top Shot Pegasus". To stop this annoying behaviour, move you joystick to its limits. Anyway, you -should keep a hand on your device, in order to avoid it to brake down if +should keep a hand on your device, in order to avoid it to break down if something goes wrong. -At the kernel's compilation: - - Enable IForce/Serial - - Enable Event interface - -Compile the modules, install them. - -You also need inputattach. - -You then need to insert the modules into the following order: -% modprobe joydev -% modprobe serport # Only for serial -% modprobe iforce -% modprobe evdev -% ./inputattach -ifor $2 & # Only for serial -If you are using USB, you don't need the inputattach step. - -Please check that you have all the /dev/input entries needed: -cd /dev -rm js* -mkdir input -mknod input/js0 c 13 0 -mknod input/js1 c 13 1 -mknod input/js2 c 13 2 -mknod input/js3 c 13 3 -ln -s input/js0 js0 -ln -s input/js1 js1 -ln -s input/js2 js2 -ln -s input/js3 js3 - -mknod input/event0 c 13 64 -mknod input/event1 c 13 65 -mknod input/event2 c 13 66 -mknod input/event3 c 13 67 +If you have a serial iforce device, you need to start inputattach. See +joystick.txt for details. 2.1 Does it work ? ~~~~~~~~~~~~~~~~~~ There is an utility called fftest that will allow you to test the driver. % fftest /dev/input/eventXX -3. Instructions to the developper +3. Instructions to the developer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - All interactions are done using the event API. That is, you can use ioctl() +All interactions are done using the event API. That is, you can use ioctl() and write() on /dev/input/eventXX. - This information is subject to change. +This information is subject to change. 3.1 Querying device capabilities ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -86,18 +56,29 @@ int ioctl(int file_descriptor, int request, unsigned long *features); Returns the features supported by the device. features is a bitfield with the following bits: -- FF_X has an X axis (usually joysticks) -- FF_Y has an Y axis (usually joysticks) -- FF_WHEEL has a wheel (usually sterring wheels) - FF_CONSTANT can render constant force effects -- FF_PERIODIC can render periodic effects (sine, triangle, square...) +- FF_PERIODIC can render periodic effects with the following waveforms: + - FF_SQUARE square waveform + - FF_TRIANGLE triangle waveform + - FF_SINE sine waveform + - FF_SAW_UP sawtooth up waveform + - FF_SAW_DOWN sawtooth down waveform + - FF_CUSTOM custom waveform - FF_RAMP can render ramp effects - FF_SPRING can simulate the presence of a spring -- FF_FRICTION can simulate friction +- FF_FRICTION can simulate friction - FF_DAMPER can simulate damper effects -- FF_RUMBLE rumble effects (normally the only effect supported by rumble - pads) +- FF_RUMBLE rumble effects - FF_INERTIA can simulate inertia +- FF_GAIN gain is adjustable +- FF_AUTOCENTER autocenter is adjustable + +Note: In most cases you should use FF_PERIODIC instead of FF_RUMBLE. All + devices that support FF_RUMBLE support FF_PERIODIC (square, triangle, + sine) and the other way around. + +Note: The exact syntax FF_CUSTOM is undefined for the time being as no driver + supports it yet. int ioctl(int fd, EVIOCGEFFECTS, int *n); @@ -108,7 +89,7 @@ Returns the number of effects the device can keep in its memory. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ #include <linux/input.h> #include <sys/ioctl.h> - + int ioctl(int file_descriptor, int request, struct ff_effect *effect); "request" must be EVIOCSFF. @@ -120,6 +101,9 @@ to the unique id assigned by the driver. This data is required for performing some operations (removing an effect, controlling the playback). This if field must be set to -1 by the user in order to tell the driver to allocate a new effect. + +Effects are file descriptor specific. + See <linux/input.h> for a description of the ff_effect struct. You should also find help in a few sketches, contained in files shape.fig and interactive.fig. You need xfig to visualize these files. @@ -128,8 +112,8 @@ You need xfig to visualize these files. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ int ioctl(int fd, EVIOCRMFF, effect.id); -This makes room for new effects in the device's memory. Please note this won't -stop the effect if it was playing. +This makes room for new effects in the device's memory. Note that this also +stops the effect if it was playing. 3.4 Controlling the playback of effects ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -149,22 +133,21 @@ Control of playing is done with write(). Below is an example: play.type = EV_FF; play.code = effect.id; play.value = 3; - + write(fd, (const void*) &play, sizeof(play)); ... /* Stop an effect */ stop.type = EV_FF; stop.code = effect.id; stop.value = 0; - + write(fd, (const void*) &play, sizeof(stop)); 3.5 Setting the gain ~~~~~~~~~~~~~~~~~~~~ Not all devices have the same strength. Therefore, users should set a gain factor depending on how strong they want effects to be. This setting is -persistent across access to the driver, so you should not care about it if -you are writing games, as another utility probably already set this for you. +persistent across access to the driver. /* Set the gain of the device int gain; /* between 0 and 100 */ @@ -204,11 +187,14 @@ type of device, not all parameters can be dynamically updated. For example, the direction of an effect cannot be updated with iforce devices. In this case, the driver stops the effect, up-load it, and restart it. +Therefore it is recommended to dynamically change direction while the effect +is playing only when it is ok to restart the effect with a replay count of 1. 3.8 Information about the status of effects ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Every time the status of an effect is changed, an event is sent. The values and meanings of the fields of the event are as follows: + struct input_event { /* When the status of the effect changed */ struct timeval time; @@ -225,3 +211,9 @@ struct input_event { FF_STATUS_STOPPED The effect stopped playing FF_STATUS_PLAYING The effect started to play + +NOTE: Status feedback is only supported by iforce driver. If you have + a really good reason to use this, please contact + linux-joystick@atrey.karlin.mff.cuni.cz or anssi.hannula@gmail.com + so that support for it can be added to the rest of the drivers. + diff --git a/Documentation/input/gameport-programming.txt b/Documentation/input/gameport-programming.txt index 1ba3d322e0acb..14e0a8b70225f 100644 --- a/Documentation/input/gameport-programming.txt +++ b/Documentation/input/gameport-programming.txt @@ -18,8 +18,8 @@ Make sure struct gameport is initialized to 0 in all other fields. The gameport generic code will take care of the rest. If your hardware supports more than one io address, and your driver can -choose which one program the hardware to, starting from the more exotic -addresses is preferred, because the likelyhood of clashing with the standard +choose which one to program the hardware to, starting from the more exotic +addresses is preferred, because the likelihood of clashing with the standard 0x201 address is smaller. Eg. if your driver supports addresses 0x200, 0x208, 0x210 and 0x218, then diff --git a/Documentation/input/input.txt b/Documentation/input/input.txt index 47137e75fdb84..ff8cea0225f90 100644 --- a/Documentation/input/input.txt +++ b/Documentation/input/input.txt @@ -68,8 +68,8 @@ will be available as a character device on major 13, minor 63: crw-r--r-- 1 root root 13, 63 Mar 28 22:45 mice - This device has to be created, unless you use devfs, in which case it's -created automatically. The commands to do create it by hand are: + This device has to be created. + The commands to create it by hand are: cd /dev mkdir input @@ -154,7 +154,7 @@ about it. 3.2 Event handlers ~~~~~~~~~~~~~~~~~~ - Event handlers distrubite the events from the devices to userland and + Event handlers distribute the events from the devices to userland and kernel, as needed. 3.2.1 keybdev @@ -230,7 +230,7 @@ generated in the kernel straight to the program, with timestamps. The API is still evolving, but should be useable now. It's described in section 5. - This should be the way for GPM and X to get keyboard and mouse mouse + This should be the way for GPM and X to get keyboard and mouse events. It allows for multihead in X without any specific multihead kernel support. The event codes are the same on all architectures and are hardware independent. @@ -279,7 +279,7 @@ struct input_event { }; 'time' is the timestamp, it returns the time at which the event happened. -Type is for example EV_REL for relative momement, REL_KEY for a keypress or +Type is for example EV_REL for relative moment, REL_KEY for a keypress or release. More types are defined in include/linux/input.h. 'code' is event code, for example REL_X or KEY_BACKSPACE, again a complete @@ -289,24 +289,3 @@ list is in include/linux/input.h. EV_REL, absolute new value for EV_ABS (joysticks ...), or 0 for EV_KEY for release, 1 for keypress and 2 for autorepeat. -6. Contacts -~~~~~~~~~~~ - This effort has its home page at: - - http://www.suse.cz/development/input/ - -You'll find both the latest HID driver and the complete Input driver -there as well as information how to access the CVS repository for -latest revisions of the drivers. - - There is also a mailing list for this: - - majordomo@atrey.karlin.mff.cuni.cz - -Send "subscribe linux-input" to subscribe to it. - -The input changes are also being worked on as part of the LinuxConsole -project, see: - - http://sourceforge.net/projects/linuxconsole/ - diff --git a/Documentation/input/joystick-parport.txt b/Documentation/input/joystick-parport.txt index d537c48cc6d02..ede5f33daad3d 100644 --- a/Documentation/input/joystick-parport.txt +++ b/Documentation/input/joystick-parport.txt @@ -456,8 +456,8 @@ uses the following kernel/module command line: 8 | Sony PSX DDR controller 9 | SNES mouse - The exact type of the PSX controller type is autoprobed when used so -hot swapping should work (but is not recomended). + The exact type of the PSX controller type is autoprobed when used, so +hot swapping should work (but is not recommended). Should you want to use more than one of parallel ports at once, you can use gamecon.map2 and gamecon.map3 as additional command line parameters for two @@ -465,8 +465,8 @@ more parallel ports. There are two options specific to PSX driver portion. gamecon.psx_delay sets the command delay when talking to the controllers. The default of 25 should -work but you can try lowering it for better performace. If your pads don't -respond try raising it untill they work. Setting the type to 8 allows the +work but you can try lowering it for better performance. If your pads don't +respond try raising it until they work. Setting the type to 8 allows the driver to be used with Dance Dance Revolution or similar games. Arrow keys are registered as key presses instead of X and Y axes. diff --git a/Documentation/input/joystick.txt b/Documentation/input/joystick.txt index 841c353297e6e..389de9bd98789 100644 --- a/Documentation/input/joystick.txt +++ b/Documentation/input/joystick.txt @@ -60,7 +60,7 @@ and install it before going on. 2.2 Device nodes ~~~~~~~~~~~~~~~~ -For applications to be able to use the joysticks, in you don't use devfs, +For applications to be able to use the joysticks, you'll have to manually create these nodes in /dev: cd /dev diff --git a/Documentation/input/yealink.txt b/Documentation/input/yealink.txt index 0962c5c948bee..0a8c97e87d47e 100644 --- a/Documentation/input/yealink.txt +++ b/Documentation/input/yealink.txt @@ -87,13 +87,13 @@ Line 3 Format : 888888888888 Format description: - From a user space perspective the world is seperated in "digits" and "icons". + From a userspace perspective the world is separated into "digits" and "icons". A digit can have a character set, an icon can only be ON or OFF. Format specifier '8' : Generic 7 segment digit with individual addressable segments - Reduced capabillity 7 segm digit, when segments are hard wired together. + Reduced capability 7 segm digit, when segments are hard wired together. '1' : 2 segments digit only able to produce a 1. 'e' : Most significant day of the month digit, able to produce at least 1 2 3. |