GNU Linux-libre 4.4.294-gnu1
[releases.git] / Documentation / ABI / testing / sysfs-driver-wacom
1 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/speed
2 Date:           April 2010
3 Kernel Version: 2.6.35
4 Contact:        linux-bluetooth@vger.kernel.org
5 Description:
6                 The /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/speed file
7                 controls reporting speed of Wacom bluetooth tablet. Reading
8                 from this file returns 1 if tablet reports in high speed mode
9                 or 0 otherwise. Writing to this file one of these values
10                 switches reporting speed.
11
12 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/led
13 Date:           August 2014
14 Contact:        linux-input@vger.kernel.org
15 Description:
16                 Attribute group for control of the status LEDs and the OLEDs.
17                 This attribute group is only available for Intuos 4 M, L,
18                 and XL (with LEDs and OLEDs), Intuos 4 WL, Intuos 5 (LEDs only),
19                 Intuos Pro (LEDs only) and Cintiq 21UX2 and Cintiq 24HD
20                 (LEDs only). Therefore its presence implicitly signifies the
21                 presence of said LEDs and OLEDs on the tablet device.
22
23 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status0_luminance
24 Date:           August 2014
25 Contact:        linux-input@vger.kernel.org
26 Description:
27                 Writing to this file sets the status LED luminance (1..127)
28                 when the stylus does not touch the tablet surface, and no
29                 button is pressed on the stylus. This luminance level is
30                 normally lower than the level when a button is pressed.
31
32 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status1_luminance
33 Date:           August 2014
34 Contact:        linux-input@vger.kernel.org
35 Description:
36                 Writing to this file sets the status LED luminance (1..127)
37                 when the stylus touches the tablet surface, or any button is
38                 pressed on the stylus.
39
40 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status_led0_select
41 Date:           August 2014
42 Contact:        linux-input@vger.kernel.org
43 Description:
44                 Writing to this file sets which one of the four (for Intuos 4
45                 and Intuos 5) or of the right four (for Cintiq 21UX2 and Cintiq
46                 24HD) status LEDs is active (0..3). The other three LEDs on the
47                 same side are always inactive.
48
49 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status_led1_select
50 Date:           August 2014
51 Contact:        linux-input@vger.kernel.org
52 Description:
53                 Writing to this file sets which one of the left four (for Cintiq 21UX2
54                 and Cintiq 24HD) status LEDs is active (0..3). The other three LEDs on
55                 the left are always inactive.
56
57 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/buttons_luminance
58 Date:           August 2014
59 Contact:        linux-input@vger.kernel.org
60 Description:
61                 Writing to this file sets the overall luminance level (0..15)
62                 of all eight button OLED displays.
63
64 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/button<n>_rawimg
65 Date:           August 2014
66 Contact:        linux-input@vger.kernel.org
67 Description:
68                 When writing a 1024 byte raw image in Wacom Intuos 4
69                 interleaving format to the file, the image shows up on Button N
70                 of the device. The image is a 64x32 pixel 4-bit gray image. The
71                 1024 byte binary is split up into 16x 64 byte chunks. Each 64
72                 byte chunk encodes the image data for two consecutive lines on
73                 the display. The low nibble of each byte contains the first
74                 line, and the high nibble contains the second line.
75                 When the Wacom Intuos 4 is connected over Bluetooth, the
76                 image has to contain 256 bytes (64x32 px 1 bit colour).
77                 The format is also scrambled, like in the USB mode, and it can
78                 be summarized by converting 76543210 into GECA6420.
79                                             HGFEDCBA      HFDB7531
80
81 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote
82 Date:           July 2015
83 Contact:        linux-input@vger.kernel.org
84 Description:
85                 Writing the character sequence '*' followed by a newline to
86                 this file will delete all of the current pairings on the
87                 device. Other character sequences are reserved. This file is
88                 write only.
89
90 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/<serial_number>/remote_mode
91 Date:           July 2015
92 Contact:        linux-input@vger.kernel.org
93 Description:
94                 Reading from this file reports the mode status of the
95                 remote as indicated by the LED lights on the device. If no
96                 reports have been received from the paired device, reading
97                 from this file will report '-1'. The mode is read-only
98                 and cannot be set through the driver.