[mirror_ubuntu-hirsute-kernel.git] / Documentation / input / devices / cs461x.rst

Crystal SoundFusion CS4610/CS4612/CS461 joystick
================================================

This is a new low-level driver to support analog joystick attached to
Crystal SoundFusion CS4610/CS4612/CS4615. This code is based upon
Vortex/Solo drivers as an example of decoration style, and ALSA
0.5.8a kernel drivers as an chipset documentation and samples.

This version does not have cooked mode support; the basic code
is present here, but have not tested completely. The button analysis
is completed in this mode, but the axis movement is not.

Raw mode works fine with analog joystick front-end driver and cs461x
driver as a backend. I've tested this driver with CS4610, 4-axis and
4-button joystick; I mean the jstest utility. Also I've tried to
play in xracer game using joystick, and the result is better than
keyboard only mode.

The sensitivity and calibrate quality have not been tested; the two
reasons are performed: the same hardware cannot work under Win95 (blue
screen in VJOYD); I have no documentation on my chip; and the existing
behavior in my case was not raised the requirement of joystick calibration.
So the driver have no code to perform hardware related calibration.

This driver have the basic support for PCI devices only; there is no
ISA or PnP ISA cards supported.

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
separately of ALSA modules. So, you can use only one joystick driver
without ALSA drivers. The ALSA drivers are not needed to compile or
run this driver.

There are no debug information print have been placed in source, and no
specific options required to work this driver. The found chipset parameters
are printed via printk(KERN_INFO "..."), see the /var/log/messages to
inspect cs461x: prefixed messages to determine possible card detection
errors.

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