1.. SPDX-License-Identifier: GPL-2.0-or-later
2
3Kernel driver oxp-sensors
4=========================
5
6Authors:
7    - Derek John Clark <derekjohn.clark@gmail.com>
8    - Joaquín Ignacio Aramendía <samsagax@gmail.com>
9
10Description:
11------------
12
13Handheld devices from One Netbook and Aya Neo provide fan readings and fan
14control through their embedded controllers.
15
16Currently only supports AMD boards from One X Player, AOK ZOE, and some Aya
17Neo devices. One X Player Intel boards could be supported if we could figure
18out the EC registers and values to write to since the EC layout and model is
19different. Aya Neo devices preceding the AIR may not be supportable as the EC
20model is different and do not appear to have manual control capabilities.
21
22Supported devices
23-----------------
24
25Currently the driver supports the following handhelds:
26
27 - AOK ZOE A1
28 - Aya Neo AIR
29 - Aya Neo AIR Pro
30 - OneXPlayer AMD
31 - OneXPlayer mini AMD
32 - OneXPlayer mini AMD PRO
33
34Sysfs entries
35-------------
36
37The following attributes are supported:
38
39fan1_input
40  Read Only. Reads current fan RMP.
41
42pwm1_enable
43  Read Write. Enable manual fan control. Write "1" to set to manual, write "0"
44  to let the EC control de fan speed. Read this attribute to see current status.
45
46pwm1
47  Read Write. Read this attribute to see current duty cycle in the range [0-255].
48  When pwm1_enable is set to "1" (manual) write any value in the range [0-255]
49  to set fan speed.
50