USB: xpad: dance pad support
[linux-2.6.git] / Documentation / input / cs461x.txt
1 Preface.
2
3 This is a new low-level driver to support analog joystick attached to
4 Crystal SoundFusion CS4610/CS4612/CS4615. This code is based upon 
5 Vortex/Solo drivers as an example of decoration style, and ALSA
6 0.5.8a kernel drivers as an chipset documentation and samples.
7
8 This version does not have cooked mode support; the basic code 
9 is present here, but have not tested completely. The button analysis 
10 is completed in this mode, but the axis movement is not. 
11
12 Raw mode works fine with analog joystick front-end driver and cs461x
13 driver as a backend. I've tested this driver with CS4610, 4-axis and 
14 4-button joystick; I mean the jstest utility. Also I've tried to
15 play in xracer game using joystick, and the result is better than
16 keyboard only mode.
17
18 The sensitivity and calibrate quality have not been tested; the two
19 reasons are performed: the same hardware cannot work under Win95 (blue 
20 screen in VJOYD); I have no documentation on my chip; and the existing 
21 behavior in my case was not raised the requirement of joystick calibration. 
22 So the driver have no code to perform hardware related calibration.
23
24 The patch contains minor changes of Config.in and Makefile files. All
25 needed code have been moved to one separate file cs461x.c like ns558.c
26 This driver have the basic support for PCI devices only; there is no
27 ISA or PnP ISA cards supported. AFAIK the ns558 have support for Crystal 
28 ISA and PnP ISA series.
29
30 The driver works with ALSA drivers simultaneously. For example, the xracer
31 uses joystick as input device and PCM device as sound output in one time.
32 There are no sound or input collisions detected. The source code have
33 comments about them; but I've found the joystick can be initialized 
34 separately of ALSA modules. So, you canm use only one joystick driver
35 without ALSA drivers. The ALSA drivers are not needed to compile or
36 run this driver.
37
38 There are no debug information print have been placed in source, and no
39 specific options required to work this driver. The found chipset parameters
40 are printed via printk(KERN_INFO "..."), see the /var/log/messages to
41 inspect cs461x: prefixed messages to determine possible card detection 
42 errors.
43
44 Regards,
45 Viktor