PATCH [UPDATED] [3/3] Documentation/ABI/testing/game_device-sysfs-interface: Document game_device interface added to xpad driver

[Mike Murphy <mamurph@cs.clemson.edu>]

[-- Attachment #1: Type: text/plain, Size: 162 bytes --]

Add documentation for the game_device sysfs interface that was added
to the xpad driver in this patchset.

Signed-off-by: Mike Murphy <mamurph[at]cs.clemson.edu>

[-- Attachment #2: gamedevice.patch --]
[-- Type: application/octet-stream, Size: 3354 bytes --]

diff -uNr origdrv/Documentation/ABI/testing/game_device-sysfs-interface newdrv/Documentation/ABI/testing/game_device-sysfs-interface
--- origdrv/Documentation/ABI/testing/game_device-sysfs-interface	1969-12-31 19:00:00.000000000 -0500
+++ newdrv/Documentation/ABI/testing/game_device-sysfs-interface	2009-02-28 21:02:55.000000000 -0500
@@ -0,0 +1,86 @@
+What:		/sys/class/input/inputXX/game_device
+		(exact location depends on kernel and userspace rules)
+Date:		February 2009
+KernelVersion:	2.6.28
+Contact:	Mike Murphy <mamurph@cs.clemson.edu>
+Description:	The game_device subdirectory provides a mechanism for gaming
+		devices, such as joysticks and gamepads, to report information
+		and allow changes to calibration and behavior. The name of
+		this directory SHOULD be game_device for all drivers that
+		support it, and those drivers SHOULD have ABI documentation
+		in this file. However, the exact contents of the directory
+		MAY vary by device type, so that devices can expose whatever
+		properties and settings are appropriate for the hardware
+		and/or driver software.
+
+
+What:		game_device interface for the xpad driver
+		(drivers/input/joystick/xpad.c)
+Date:		February 2009
+KernelVersion:	2.6.28
+Contact:	Mike Murphy <mamurph@cs.clemson.edu>
+Description:	The game_device subdirectory for the Xbox/360 controller
+		driver provides the following files for retrieving information
+		and setting properties:
+
+		left_dead_zone			uint, read/write
+		right_dead_zone			uint, read/write
+
+			Set the size of the analog stick dead zones for the
+			left and right sticks, respectively. Minimum value
+			0, default 8192, maximum 31743 (or 1024 less than
+			the stick_limit for the corresponding stick).
+
+		left_stick_limit		uint, read/write
+		right_stick_limit		uint, read/write
+
+			Set the square-axis limits of the analog left and
+			right sticks, respectively. Minimum value 1024,
+			default 32767, maximum 32767. The minimum is
+			constrained to be the size of the dead zone plus
+			1024. See Documentation/input/xpad.txt for more
+			information.
+
+		rumble_enable			bool, read/write
+
+			Enable or disable the controller's rumble effect.
+			Default 1 (enabled).
+
+		left_trigger_full_axis		bool, read/write
+		right_trigger_full_axis		bool, read/write
+
+			Enable or disable use of a full axis (-32767 to
+			+32767) for each of the left and right triggers,
+			respectively. Default 0 (disabled: use a half axis
+			from 0 to +32767).
+
+		controller_number		uint, read-only
+
+			Controller slot number (1-4) for a wireless Xbox
+			360 gaming receiver. This value will be zero for all
+			wired devices.
+
+		controller_present		bool, read-only
+
+			Controller presence indicator for a wireless Xbox
+			360 gaming receiver. Has the value 1 whenever the
+			controller is turned on and connected to the receiver
+			slot corresponding to the input device. This value
+			will always be 1 for all wired devices.
+
+		controller_type			uint, read-only
+
+			Type of controller that is connected:
+
+			0	No controller connected
+			1	Pad
+			2	Guitar
+			3	Dance pad
+			255	Other/unknown type
+
+		id				string [17], read-only
+
+			16-character (plus NUL byte) presumably unique
+			identifier for each connected WIRELESS controller.
+			Presently, this value is an empty string for all
+			wired devices.