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