Merge tag 'ntb-5.11' of git://github.com/jonmason/ntb
[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-driver-wacom
1 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/speed
2 Date:           April 2010
3 KernelVersion:  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                 <obsoleted by the LED class API now exported by the driver>
28                 Writing to this file sets the status LED luminance (1..127)
29                 when the stylus does not touch the tablet surface, and no
30                 button is pressed on the stylus. This luminance level is
31                 normally lower than the level when a button is pressed.
32
33 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status1_luminance
34 Date:           August 2014
35 Contact:        linux-input@vger.kernel.org
36 Description:
37                 <obsoleted by the LED class API now exported by the driver>
38                 Writing to this file sets the status LED luminance (1..127)
39                 when the stylus touches the tablet surface, or any button is
40                 pressed on the stylus.
41
42 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status_led0_select
43 Date:           August 2014
44 Contact:        linux-input@vger.kernel.org
45 Description:
46                 <obsoleted by the LED class API now exported by the driver>
47                 Writing to this file sets which one of the four (for Intuos 4
48                 and Intuos 5) or of the right four (for Cintiq 21UX2 and Cintiq
49                 24HD) status LEDs is active (0..3). The other three LEDs on the
50                 same side are always inactive.
51
52 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/status_led1_select
53 Date:           August 2014
54 Contact:        linux-input@vger.kernel.org
55 Description:
56                 <obsoleted by the LED class API now exported by the driver>
57                 Writing to this file sets which one of the left four (for Cintiq 21UX2
58                 and Cintiq 24HD) status LEDs is active (0..3). The other three LEDs on
59                 the left are always inactive.
60
61 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/buttons_luminance
62 Date:           August 2014
63 Contact:        linux-input@vger.kernel.org
64 Description:
65                 Writing to this file sets the overall luminance level (0..15)
66                 of all eight button OLED displays.
67
68 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_led/button<n>_rawimg
69 Date:           August 2014
70 Contact:        linux-input@vger.kernel.org
71 Description:
72                 When writing a 1024 byte raw image in Wacom Intuos 4
73                 interleaving format to the file, the image shows up on Button N
74                 of the device. The image is a 64x32 pixel 4-bit gray image. The
75                 1024 byte binary is split up into 16x 64 byte chunks. Each 64
76                 byte chunk encodes the image data for two consecutive lines on
77                 the display. The low nibble of each byte contains the first
78                 line, and the high nibble contains the second line.
79                 When the Wacom Intuos 4 is connected over Bluetooth, the
80                 image has to contain 256 bytes (64x32 px 1 bit colour).
81                 The format is also scrambled, like in the USB mode, and it can
82                 be summarized by converting::
83
84                                             76543210 into GECA6420.
85                                             HGFEDCBA      HFDB7531
86
87 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/unpair_remote
88 Date:           July 2015
89 Contact:        linux-input@vger.kernel.org
90 Description:
91                 Writing the character sequence '*' followed by a newline to
92                 this file will delete all of the current pairings on the
93                 device. Other character sequences are reserved. This file is
94                 write only.
95
96 What:           /sys/bus/hid/devices/<bus>:<vid>:<pid>.<n>/wacom_remote/<serial_number>/remote_mode
97 Date:           July 2015
98 Contact:        linux-input@vger.kernel.org
99 Description:
100                 <obsoleted by the LED class API now exported by the driver>
101                 Reading from this file reports the mode status of the
102                 remote as indicated by the LED lights on the device. If no
103                 reports have been received from the paired device, reading
104                 from this file will report '-1'. The mode is read-only
105                 and cannot be set through the driver.