GNU Linux-libre 6.9.1-gnu
[releases.git] / Documentation / input / devices / edt-ft5x06.rst
1 EDT ft5x06 based Polytouch devices
2 ----------------------------------
3
4 The edt-ft5x06 driver is useful for the EDT "Polytouch" family of capacitive
5 touch screens. Note that it is *not* suitable for other devices based on the
6 focaltec ft5x06 devices, since they contain vendor-specific firmware. In
7 particular this driver is not suitable for the Nook tablet.
8
9 It has been tested with the following devices:
10   * EP0350M06
11   * EP0430M06
12   * EP0570M06
13   * EP0700M06
14
15 The driver allows configuration of the touch screen via a set of sysfs files:
16
17 /sys/class/input/eventX/device/device/threshold:
18     allows setting the "click"-threshold in the range from 0 to 80.
19
20 /sys/class/input/eventX/device/device/gain:
21     allows setting the sensitivity in the range from 0 to 31. Note that
22     lower values indicate higher sensitivity.
23
24 /sys/class/input/eventX/device/device/offset:
25     allows setting the edge compensation in the range from 0 to 31.
26
27 /sys/class/input/eventX/device/device/report_rate:
28     allows setting the report rate in the range from 3 to 14.
29
30
31 For debugging purposes the driver provides a few files in the debug
32 filesystem (if available in the kernel). In /sys/kernel/debug/edt_ft5x06
33 you'll find the following files:
34
35 num_x, num_y:
36     (readonly) contains the number of sensor fields in X- and
37     Y-direction.
38
39 mode:
40     allows switching the sensor between "factory mode" and "operation
41     mode" by writing "1" or "0" to it. In factory mode (1) it is
42     possible to get the raw data from the sensor. Note that in factory
43     mode regular events don't get delivered and the options described
44     above are unavailable.
45
46 raw_data:
47     contains num_x * num_y big endian 16 bit values describing the raw
48     values for each sensor field. Note that each read() call on this
49     files triggers a new readout. It is recommended to provide a buffer
50     big enough to contain num_x * num_y * 2 bytes.
51
52 Note that reading raw_data gives a I/O error when the device is not in factory
53 mode. The same happens when reading/writing to the parameter files when the
54 device is not in regular operation mode.