xref: /linux/Documentation/ABI/testing/sysfs-driver-wacom (revision cdd38c5f1ce4398ec58fec95904b75824daab7b5)
1c704b4efSBenjamin TissoiresWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/speed
25d7e7d47SEduard HasenleithnerDate:		April 2010
35d7e7d47SEduard HasenleithnerKernelVersion:	2.6.35
45d7e7d47SEduard HasenleithnerContact:	linux-bluetooth@vger.kernel.org
55d7e7d47SEduard HasenleithnerDescription:
6c704b4efSBenjamin Tissoires		The /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/speed file
7c704b4efSBenjamin Tissoires		controls reporting speed of Wacom bluetooth tablet. Reading
8c704b4efSBenjamin Tissoires		from this file returns 1 if tablet reports in high speed mode
95d7e7d47SEduard Hasenleithner		or 0 otherwise. Writing to this file one of these values
105d7e7d47SEduard Hasenleithner		switches reporting speed.
115d7e7d47SEduard Hasenleithner
12c704b4efSBenjamin TissoiresWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/led
13c704b4efSBenjamin TissoiresDate:		August 2014
145d7e7d47SEduard HasenleithnerContact:	linux-input@vger.kernel.org
155d7e7d47SEduard HasenleithnerDescription:
1609e7d941SPing Cheng		Attribute group for control of the status LEDs and the OLEDs.
1709e7d941SPing Cheng		This attribute group is only available for Intuos 4 M, L,
18c704b4efSBenjamin Tissoires		and XL (with LEDs and OLEDs), Intuos 4 WL, Intuos 5 (LEDs only),
19c704b4efSBenjamin Tissoires		Intuos Pro (LEDs only) and Cintiq 21UX2 and Cintiq 24HD
20c704b4efSBenjamin Tissoires		(LEDs only). Therefore its presence implicitly signifies the
21c704b4efSBenjamin Tissoires		presence of said LEDs and OLEDs on the tablet device.
225d7e7d47SEduard Hasenleithner
23c704b4efSBenjamin TissoiresWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status0_luminance
24c704b4efSBenjamin TissoiresDate:		August 2014
255d7e7d47SEduard HasenleithnerContact:	linux-input@vger.kernel.org
265d7e7d47SEduard HasenleithnerDescription:
2797f5541fSBenjamin Tissoires		<obsoleted by the LED class API now exported by the driver>
2877e82516SPing Cheng		Writing to this file sets the status LED luminance (1..127)
295d7e7d47SEduard Hasenleithner		when the stylus does not touch the tablet surface, and no
30f4fa9a6dSPing Cheng		button is pressed on the stylus. This luminance level is
31f4fa9a6dSPing Cheng		normally lower than the level when a button is pressed.
325d7e7d47SEduard Hasenleithner
33c704b4efSBenjamin TissoiresWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status1_luminance
34c704b4efSBenjamin TissoiresDate:		August 2014
355d7e7d47SEduard HasenleithnerContact:	linux-input@vger.kernel.org
365d7e7d47SEduard HasenleithnerDescription:
3797f5541fSBenjamin Tissoires		<obsoleted by the LED class API now exported by the driver>
3877e82516SPing Cheng		Writing to this file sets the status LED luminance (1..127)
395d7e7d47SEduard Hasenleithner		when the stylus touches the tablet surface, or any button is
405d7e7d47SEduard Hasenleithner		pressed on the stylus.
415d7e7d47SEduard Hasenleithner
42c704b4efSBenjamin TissoiresWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status_led0_select
43c704b4efSBenjamin TissoiresDate:		August 2014
445d7e7d47SEduard HasenleithnerContact:	linux-input@vger.kernel.org
455d7e7d47SEduard HasenleithnerDescription:
4697f5541fSBenjamin Tissoires		<obsoleted by the LED class API now exported by the driver>
479b5b95ddSJason Gerecke		Writing to this file sets which one of the four (for Intuos 4
489b5b95ddSJason Gerecke		and Intuos 5) or of the right four (for Cintiq 21UX2 and Cintiq
499b5b95ddSJason Gerecke		24HD) status LEDs is active (0..3). The other three LEDs on the
509b5b95ddSJason Gerecke		same side are always inactive.
5109e7d941SPing Cheng
52c704b4efSBenjamin TissoiresWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status_led1_select
53c704b4efSBenjamin TissoiresDate:		August 2014
5409e7d941SPing ChengContact:	linux-input@vger.kernel.org
5509e7d941SPing ChengDescription:
5697f5541fSBenjamin Tissoires		<obsoleted by the LED class API now exported by the driver>
57246835fcSJason Gerecke		Writing to this file sets which one of the left four (for Cintiq 21UX2
58246835fcSJason Gerecke		and Cintiq 24HD) status LEDs is active (0..3). The other three LEDs on
59246835fcSJason Gerecke		the left are always inactive.
605d7e7d47SEduard Hasenleithner
61c704b4efSBenjamin TissoiresWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/buttons_luminance
62c704b4efSBenjamin TissoiresDate:		August 2014
635d7e7d47SEduard HasenleithnerContact:	linux-input@vger.kernel.org
645d7e7d47SEduard HasenleithnerDescription:
655d7e7d47SEduard Hasenleithner		Writing to this file sets the overall luminance level (0..15)
665d7e7d47SEduard Hasenleithner		of all eight button OLED displays.
675d7e7d47SEduard Hasenleithner
68c704b4efSBenjamin TissoiresWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/button<n>_rawimg
69c704b4efSBenjamin TissoiresDate:		August 2014
705d7e7d47SEduard HasenleithnerContact:	linux-input@vger.kernel.org
715d7e7d47SEduard HasenleithnerDescription:
725d7e7d47SEduard Hasenleithner		When writing a 1024 byte raw image in Wacom Intuos 4
735d7e7d47SEduard Hasenleithner		interleaving format to the file, the image shows up on Button N
745d7e7d47SEduard Hasenleithner		of the device. The image is a 64x32 pixel 4-bit gray image. The
755d7e7d47SEduard Hasenleithner		1024 byte binary is split up into 16x 64 byte chunks. Each 64
765d7e7d47SEduard Hasenleithner		byte chunk encodes the image data for two consecutive lines on
775d7e7d47SEduard Hasenleithner		the display. The low nibble of each byte contains the first
785d7e7d47SEduard Hasenleithner		line, and the high nibble contains the second line.
79c704b4efSBenjamin Tissoires		When the Wacom Intuos 4 is connected over Bluetooth, the
80c704b4efSBenjamin Tissoires		image has to contain 256 bytes (64x32 px 1 bit colour).
81c704b4efSBenjamin Tissoires		The format is also scrambled, like in the USB mode, and it can
82*34433332SMauro Carvalho Chehab		be summarized by converting::
83*34433332SMauro Carvalho Chehab
84*34433332SMauro Carvalho Chehab					    76543210 into GECA6420.
85c704b4efSBenjamin Tissoires					    HGFEDCBA      HFDB7531
8672b236d6SAaron Skomra
8772b236d6SAaron SkomraWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote
8872b236d6SAaron SkomraDate:		July 2015
8972b236d6SAaron SkomraContact:	linux-input@vger.kernel.org
9072b236d6SAaron SkomraDescription:
9172b236d6SAaron Skomra		Writing the character sequence '*' followed by a newline to
9272b236d6SAaron Skomra		this file will delete all of the current pairings on the
9372b236d6SAaron Skomra		device. Other character sequences are reserved. This file is
9472b236d6SAaron Skomra		write only.
9572b236d6SAaron Skomra
9672b236d6SAaron SkomraWhat:		/sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/<serial_number>/remote_mode
9772b236d6SAaron SkomraDate:		July 2015
9872b236d6SAaron SkomraContact:	linux-input@vger.kernel.org
9972b236d6SAaron SkomraDescription:
10097f5541fSBenjamin Tissoires		<obsoleted by the LED class API now exported by the driver>
10172b236d6SAaron Skomra		Reading from this file reports the mode status of the
10272b236d6SAaron Skomra		remote as indicated by the LED lights on the device. If no
10372b236d6SAaron Skomra		reports have been received from the paired device, reading
10472b236d6SAaron Skomra		from this file will report '-1'. The mode is read-only
10572b236d6SAaron Skomra		and cannot be set through the driver.
106