Commit eef8abda authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet

Documentation: input: joydev file corrections

Fix typos, grammar, punctuation in
Documentation/input/joydev/*.rst files.
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Link: https://lore.kernel.org/r/20210429063137.20232-1-rdunlap@infradead.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 6a79162f
...@@ -71,7 +71,7 @@ The possible values of ``type`` are:: ...@@ -71,7 +71,7 @@ The possible values of ``type`` are::
#define JS_EVENT_INIT 0x80 /* initial state of device */ #define JS_EVENT_INIT 0x80 /* initial state of device */
As mentioned above, the driver will issue synthetic JS_EVENT_INIT ORed As mentioned above, the driver will issue synthetic JS_EVENT_INIT ORed
events on open. That is, if it's issuing a INIT BUTTON event, the events on open. That is, if it's issuing an INIT BUTTON event, the
current type value will be:: current type value will be::
int type = JS_EVENT_BUTTON | JS_EVENT_INIT; /* 0x81 */ int type = JS_EVENT_BUTTON | JS_EVENT_INIT; /* 0x81 */
...@@ -100,8 +100,8 @@ is, you have both an axis 0 and a button 0). Generally, ...@@ -100,8 +100,8 @@ is, you have both an axis 0 and a button 0). Generally,
=============== ======= =============== =======
Hats vary from one joystick type to another. Some can be moved in 8 Hats vary from one joystick type to another. Some can be moved in 8
directions, some only in 4, The driver, however, always reports a hat as two directions, some only in 4. The driver, however, always reports a hat as two
independent axis, even if the hardware doesn't allow independent movement. independent axes, even if the hardware doesn't allow independent movement.
js_event.value js_event.value
...@@ -188,10 +188,10 @@ One reason for emptying the queue is that if it gets full you'll start ...@@ -188,10 +188,10 @@ One reason for emptying the queue is that if it gets full you'll start
missing events since the queue is finite, and older events will get missing events since the queue is finite, and older events will get
overwritten. overwritten.
The other reason is that you want to know all what happened, and not The other reason is that you want to know all that happened, and not
delay the processing till later. delay the processing till later.
Why can get the queue full? Because you don't empty the queue as Why can the queue get full? Because you don't empty the queue as
mentioned, or because too much time elapses from one read to another mentioned, or because too much time elapses from one read to another
and too many events to store in the queue get generated. Note that and too many events to store in the queue get generated. Note that
high system load may contribute to space those reads even more. high system load may contribute to space those reads even more.
...@@ -277,7 +277,7 @@ to be in the stable part of the API, and therefore may change without ...@@ -277,7 +277,7 @@ to be in the stable part of the API, and therefore may change without
warning in following releases of the driver. warning in following releases of the driver.
Both JSIOCSCORR and JSIOCGCORR expect &js_corr to be able to hold Both JSIOCSCORR and JSIOCGCORR expect &js_corr to be able to hold
information for all axis. That is, struct js_corr corr[MAX_AXIS]; information for all axes. That is, struct js_corr corr[MAX_AXIS];
struct js_corr is defined as:: struct js_corr is defined as::
...@@ -328,7 +328,7 @@ To test the state of the buttons, ...@@ -328,7 +328,7 @@ To test the state of the buttons,
second_button_state = js.buttons & 2; second_button_state = js.buttons & 2;
The axis values do not have a defined range in the original 0.x driver, The axis values do not have a defined range in the original 0.x driver,
except for that the values are non-negative. The 1.2.8+ drivers use a except that the values are non-negative. The 1.2.8+ drivers use a
fixed range for reporting the values, 1 being the minimum, 128 the fixed range for reporting the values, 1 being the minimum, 128 the
center, and 255 maximum value. center, and 255 maximum value.
......
...@@ -133,15 +133,15 @@ And add a line to your rc script executing that file:: ...@@ -133,15 +133,15 @@ And add a line to your rc script executing that file::
This way, after the next reboot your joystick will remain calibrated. You This way, after the next reboot your joystick will remain calibrated. You
can also add the ``jscal -p`` line to your shutdown script. can also add the ``jscal -p`` line to your shutdown script.
HW specific driver information Hardware-specific driver information
============================== ====================================
In this section each of the separate hardware specific drivers is described. In this section each of the separate hardware specific drivers is described.
Analog joysticks Analog joysticks
---------------- ----------------
The analog.c uses the standard analog inputs of the gameport, and thus The analog.c driver uses the standard analog inputs of the gameport, and thus
supports all standard joysticks and gamepads. It uses a very advanced supports all standard joysticks and gamepads. It uses a very advanced
routine for this, allowing for data precision that can't be found on any routine for this, allowing for data precision that can't be found on any
other system. other system.
...@@ -266,7 +266,7 @@ to: ...@@ -266,7 +266,7 @@ to:
* Logitech WingMan Extreme Digital 3D * Logitech WingMan Extreme Digital 3D
ADI devices are autodetected, and the driver supports up to two (any ADI devices are autodetected, and the driver supports up to two (any
combination of) devices on a single gameport, using an Y-cable or chained combination of) devices on a single gameport, using a Y-cable or chained
together. together.
Logitech WingMan Joystick, Logitech WingMan Attack, Logitech WingMan Logitech WingMan Joystick, Logitech WingMan Attack, Logitech WingMan
...@@ -288,7 +288,7 @@ supports: ...@@ -288,7 +288,7 @@ supports:
* Gravis Xterminator DualControl * Gravis Xterminator DualControl
All these devices are autodetected, and you can even use any combination All these devices are autodetected, and you can even use any combination
of up to two of these pads either chained together or using an Y-cable on a of up to two of these pads either chained together or using a Y-cable on a
single gameport. single gameport.
GrIP MultiPort isn't supported yet. Gravis Stinger is a serial device and is GrIP MultiPort isn't supported yet. Gravis Stinger is a serial device and is
...@@ -311,7 +311,7 @@ allow connecting analog joysticks to them, you'll need to load the analog ...@@ -311,7 +311,7 @@ allow connecting analog joysticks to them, you'll need to load the analog
driver as well to handle the attached joysticks. driver as well to handle the attached joysticks.
The trackball should work with USB mousedev module as a normal mouse. See The trackball should work with USB mousedev module as a normal mouse. See
the USB documentation for how to setup an USB mouse. the USB documentation for how to setup a USB mouse.
ThrustMaster DirectConnect (BSP) ThrustMaster DirectConnect (BSP)
-------------------------------- --------------------------------
...@@ -332,7 +332,7 @@ If you have one of these, contact me. ...@@ -332,7 +332,7 @@ If you have one of these, contact me.
TMDC devices are autodetected, and thus no parameters to the module TMDC devices are autodetected, and thus no parameters to the module
are needed. Up to two TMDC devices can be connected to one gameport, using are needed. Up to two TMDC devices can be connected to one gameport, using
an Y-cable. a Y-cable.
Creative Labs Blaster Creative Labs Blaster
--------------------- ---------------------
...@@ -342,7 +342,7 @@ the: ...@@ -342,7 +342,7 @@ the:
* Creative Blaster GamePad Cobra * Creative Blaster GamePad Cobra
Up to two of these can be used on a single gameport, using an Y-cable. Up to two of these can be used on a single gameport, using a Y-cable.
Genius Digital joysticks Genius Digital joysticks
------------------------ ------------------------
...@@ -381,7 +381,7 @@ card, 16 in case you have two in your system. ...@@ -381,7 +381,7 @@ card, 16 in case you have two in your system.
Trident 4DWave / Aureal Vortex Trident 4DWave / Aureal Vortex
------------------------------ ------------------------------
Soundcards with a Trident 4DWave DX/NX or Aureal Vortex/Vortex2 chipsets Soundcards with a Trident 4DWave DX/NX or Aureal Vortex/Vortex2 chipset
provide an "Enhanced Game Port" mode where the soundcard handles polling the provide an "Enhanced Game Port" mode where the soundcard handles polling the
joystick. This mode is supported by the pcigame.c module. Once loaded the joystick. This mode is supported by the pcigame.c module. Once loaded the
analog driver can use the enhanced features of these gameports.. analog driver can use the enhanced features of these gameports..
...@@ -454,7 +454,7 @@ Devices currently supported by spaceball.c are: ...@@ -454,7 +454,7 @@ Devices currently supported by spaceball.c are:
* SpaceTec SpaceBall 4000 FLX * SpaceTec SpaceBall 4000 FLX
In addition to having the spaceorb/spaceball and serport modules in the In addition to having the spaceorb/spaceball and serport modules in the
kernel, you also need to attach a serial port to it. to do that, run the kernel, you also need to attach a serial port to it. To do that, run the
inputattach program:: inputattach program::
inputattach --spaceorb /dev/tts/x & inputattach --spaceorb /dev/tts/x &
...@@ -466,7 +466,7 @@ or:: ...@@ -466,7 +466,7 @@ or::
where /dev/tts/x is the serial port which the device is connected to. After where /dev/tts/x is the serial port which the device is connected to. After
doing this, the device will be reported and will start working. doing this, the device will be reported and will start working.
There is one caveat with the SpaceOrb. The button #6, the on the bottom There is one caveat with the SpaceOrb. The button #6, the one on the bottom
side of the orb, although reported as an ordinary button, causes internal side of the orb, although reported as an ordinary button, causes internal
recentering of the spaceorb, moving the zero point to the position in which recentering of the spaceorb, moving the zero point to the position in which
the ball is at the moment of pressing the button. So, think first before the ball is at the moment of pressing the button. So, think first before
...@@ -500,7 +500,7 @@ joy-magellan module. It currently supports only the: ...@@ -500,7 +500,7 @@ joy-magellan module. It currently supports only the:
* Magellan 3D * Magellan 3D
* Space Mouse * Space Mouse
models, the additional buttons on the 'Plus' versions are not supported yet. models; the additional buttons on the 'Plus' versions are not supported yet.
To use it, you need to attach the serial port to the driver using the:: To use it, you need to attach the serial port to the driver using the::
...@@ -575,7 +575,7 @@ FAQ ...@@ -575,7 +575,7 @@ FAQ
:A: The device files don't exist. Create them (see section 2.2). :A: The device files don't exist. Create them (see section 2.2).
:Q: Is it possible to connect my old Atari/Commodore/Amiga/console joystick :Q: Is it possible to connect my old Atari/Commodore/Amiga/console joystick
or pad that uses a 9-pin D-type cannon connector to the serial port of my or pad that uses a 9-pin D-type Cannon connector to the serial port of my
PC? PC?
:A: Yes, it is possible, but it'll burn your serial port or the pad. It :A: Yes, it is possible, but it'll burn your serial port or the pad. It
won't work, of course. won't work, of course.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment