xref: /openbmc/linux/Documentation/hwmon/oxp-sensors.rst (revision 2612e3bbc0386368a850140a6c9b990cd496a5ec)
1ed264e8aSJoaquín Ignacio Aramendía.. SPDX-License-Identifier: GPL-2.0-or-later
2ed264e8aSJoaquín Ignacio Aramendía
3ed264e8aSJoaquín Ignacio AramendíaKernel driver oxp-sensors
4ed264e8aSJoaquín Ignacio Aramendía=========================
5ed264e8aSJoaquín Ignacio Aramendía
6ebd4bfeeSDerek J. ClarkAuthors:
7ebd4bfeeSDerek J. Clark    - Derek John Clark <derekjohn.clark@gmail.com>
8ed264e8aSJoaquín Ignacio Aramendía    - Joaquín Ignacio Aramendía <samsagax@gmail.com>
9ed264e8aSJoaquín Ignacio Aramendía
10ed264e8aSJoaquín Ignacio AramendíaDescription:
11ed264e8aSJoaquín Ignacio Aramendía------------
12ed264e8aSJoaquín Ignacio Aramendía
13ebd4bfeeSDerek J. ClarkHandheld devices from One Netbook and Aya Neo provide fan readings and fan
14ebd4bfeeSDerek J. Clarkcontrol through their embedded controllers.
15ed264e8aSJoaquín Ignacio Aramendía
16ebd4bfeeSDerek J. ClarkCurrently only supports AMD boards from One X Player, AOK ZOE, and some Aya
17ebd4bfeeSDerek J. ClarkNeo devices. One X Player Intel boards could be supported if we could figure
18ebd4bfeeSDerek J. Clarkout the EC registers and values to write to since the EC layout and model is
19ebd4bfeeSDerek J. Clarkdifferent. Aya Neo devices preceding the AIR may not be supportable as the EC
20ebd4bfeeSDerek J. Clarkmodel is different and do not appear to have manual control capabilities.
213ca0f12aSJoaquín Ignacio Aramendía
22be144ee4SJoaquín Ignacio AramendíaSome models have a toggle for changing the behaviour of the "Turbo/Silent"
23be144ee4SJoaquín Ignacio Aramendíabutton of the device. It will change the key event that it triggers with
24be144ee4SJoaquín Ignacio Aramendíaa flip of the `tt_toggle` attribute. See below for boards that support this
25be144ee4SJoaquín Ignacio Aramendíafunction.
26be144ee4SJoaquín Ignacio Aramendía
273ca0f12aSJoaquín Ignacio AramendíaSupported devices
283ca0f12aSJoaquín Ignacio Aramendía-----------------
293ca0f12aSJoaquín Ignacio Aramendía
303ca0f12aSJoaquín Ignacio AramendíaCurrently the driver supports the following handhelds:
313ca0f12aSJoaquín Ignacio Aramendía
323ca0f12aSJoaquín Ignacio Aramendía - AOK ZOE A1
33*4dbbaf8fSJerrod Frost - AOK ZOE A1 PRO
34f415cb6cSJoaquín Ignacio Aramendía - Aya Neo 2
35ebd4bfeeSDerek J. Clark - Aya Neo AIR
36ebd4bfeeSDerek J. Clark - Aya Neo AIR Pro
37f415cb6cSJoaquín Ignacio Aramendía - Aya Neo Geek
383ca0f12aSJoaquín Ignacio Aramendía - OneXPlayer AMD
393ca0f12aSJoaquín Ignacio Aramendía - OneXPlayer mini AMD
403ca0f12aSJoaquín Ignacio Aramendía - OneXPlayer mini AMD PRO
41ed264e8aSJoaquín Ignacio Aramendía
42be144ee4SJoaquín Ignacio Aramendía"Turbo/Silent" button behaviour toggle is only supported on:
43be144ee4SJoaquín Ignacio Aramendía - AOK ZOE A1
44*4dbbaf8fSJerrod Frost - AOK ZOE A1 PRO
45be144ee4SJoaquín Ignacio Aramendía - OneXPlayer mini AMD (only with updated alpha BIOS)
46be144ee4SJoaquín Ignacio Aramendía - OneXPlayer mini AMD PRO
47be144ee4SJoaquín Ignacio Aramendía
48ed264e8aSJoaquín Ignacio AramendíaSysfs entries
49ed264e8aSJoaquín Ignacio Aramendía-------------
50ed264e8aSJoaquín Ignacio Aramendía
51ed264e8aSJoaquín Ignacio AramendíaThe following attributes are supported:
52ed264e8aSJoaquín Ignacio Aramendía
53ed264e8aSJoaquín Ignacio Aramendíafan1_input
54ed264e8aSJoaquín Ignacio Aramendía  Read Only. Reads current fan RMP.
55ed264e8aSJoaquín Ignacio Aramendía
56ed264e8aSJoaquín Ignacio Aramendíapwm1_enable
57ed264e8aSJoaquín Ignacio Aramendía  Read Write. Enable manual fan control. Write "1" to set to manual, write "0"
58ed264e8aSJoaquín Ignacio Aramendía  to let the EC control de fan speed. Read this attribute to see current status.
59ed264e8aSJoaquín Ignacio Aramendía
60ed264e8aSJoaquín Ignacio Aramendíapwm1
61ed264e8aSJoaquín Ignacio Aramendía  Read Write. Read this attribute to see current duty cycle in the range [0-255].
62ed264e8aSJoaquín Ignacio Aramendía  When pwm1_enable is set to "1" (manual) write any value in the range [0-255]
63ed264e8aSJoaquín Ignacio Aramendía  to set fan speed.
64be144ee4SJoaquín Ignacio Aramendía
65be144ee4SJoaquín Ignacio Aramendíatt_toggle
66be144ee4SJoaquín Ignacio Aramendía  Read Write. Read this attribute to check the status of the turbo/silent
67be144ee4SJoaquín Ignacio Aramendía  button behaviour function. Write "1" to activate the switch and "0" to
68be144ee4SJoaquín Ignacio Aramendía  deactivate it. The specific keycodes and behaviour is specific to the device
69be144ee4SJoaquín Ignacio Aramendía  both with this function on and off. This attribute is attached to the platform
70be144ee4SJoaquín Ignacio Aramendía  driver and not to the hwmon driver (/sys/devices/platform/oxp-platform/tt_toggle)
71