xref: /linux/Documentation/hwmon/oxp-sensors.rst (revision 3a39d672e7f48b8d6b91a09afa4b55352773b4b5)
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
13*b82b38a4SDerek J. ClarkHandheld devices from OneNetbook, AOKZOE, AYANEO, And OrangePi provide fan
14*b82b38a4SDerek J. Clarkreadings and fan control through their embedded controllers.
15ed264e8aSJoaquín Ignacio Aramendía
16*b82b38a4SDerek J. ClarkCurrently supports OneXPlayer devices, AOKZOE, AYANEO, and OrangePi
17*b82b38a4SDerek J. Clarkhandheld devices. AYANEO devices preceding the AIR and OneXPlayer devices
18*b82b38a4SDerek J. Clarkpreceding the Mini A07 are not supportable as the EC model is different
19*b82b38a4SDerek J. Clarkand do not have manual control capabilities.
203ca0f12aSJoaquín Ignacio Aramendía
21*b82b38a4SDerek J. ClarkSome OneXPlayer and AOKZOE models have a toggle for changing the behaviour
22*b82b38a4SDerek J. Clarkof the "Turbo/Silent" button of the device. It will change the key event
23*b82b38a4SDerek J. Clarkthat it triggers with a flip of the `tt_toggle` attribute. See below for
24*b82b38a4SDerek J. Clarkboards that support this function.
25be144ee4SJoaquín Ignacio Aramendía
263ca0f12aSJoaquín Ignacio AramendíaSupported devices
273ca0f12aSJoaquín Ignacio Aramendía-----------------
283ca0f12aSJoaquín Ignacio Aramendía
293ca0f12aSJoaquín Ignacio AramendíaCurrently the driver supports the following handhelds:
303ca0f12aSJoaquín Ignacio Aramendía
313ca0f12aSJoaquín Ignacio Aramendía - AOKZOE A1
324dbbaf8fSJerrod Frost - AOKZOE A1 PRO
33*b82b38a4SDerek J. Clark - AYANEO 2
34*b82b38a4SDerek J. Clark - AYANEO 2S
35*b82b38a4SDerek J. Clark - AYANEO AIR
36*b82b38a4SDerek J. Clark - AYANEO AIR 1S
37*b82b38a4SDerek J. Clark - AYANEO AIR Plus (Mendocino)
38*b82b38a4SDerek J. Clark - AYANEO AIR Pro
39*b82b38a4SDerek J. Clark - AYANEO Flip DS
40*b82b38a4SDerek J. Clark - AYANEO Flip KB
41*b82b38a4SDerek J. Clark - AYANEO Geek
42*b82b38a4SDerek J. Clark - AYANEO Geek 1S
43*b82b38a4SDerek J. Clark - AYANEO KUN
44*b82b38a4SDerek J. Clark - OneXPlayer 2
45*b82b38a4SDerek J. Clark - OneXPlayer 2 Pro
463ca0f12aSJoaquín Ignacio Aramendía - OneXPlayer AMD
473ca0f12aSJoaquín Ignacio Aramendía - OneXPlayer mini AMD
483ca0f12aSJoaquín Ignacio Aramendía - OneXPlayer mini AMD PRO
49*b82b38a4SDerek J. Clark - OneXPlayer OneXFly
50*b82b38a4SDerek J. Clark - OneXPlayer X1 A
51*b82b38a4SDerek J. Clark - OneXPlayer X1 i
52*b82b38a4SDerek J. Clark - OneXPlayer X1 mini
53*b82b38a4SDerek J. Clark - OrangePi NEO-01
54ed264e8aSJoaquín Ignacio Aramendía
55be144ee4SJoaquín Ignacio Aramendía"Turbo/Silent" button behaviour toggle is only supported on:
56be144ee4SJoaquín Ignacio Aramendía - AOK ZOE A1
574dbbaf8fSJerrod Frost - AOK ZOE A1 PRO
58*b82b38a4SDerek J. Clark - OneXPlayer 2
59*b82b38a4SDerek J. Clark - OneXPlayer 2 Pro
60be144ee4SJoaquín Ignacio Aramendía - OneXPlayer mini AMD (only with updated alpha BIOS)
61be144ee4SJoaquín Ignacio Aramendía - OneXPlayer mini AMD PRO
62*b82b38a4SDerek J. Clark - OneXPlayer OneXFly
63*b82b38a4SDerek J. Clark - OneXPlayer X1 A
64*b82b38a4SDerek J. Clark - OneXPlayer X1 i
65*b82b38a4SDerek J. Clark - OneXPlayer X1 mini
66be144ee4SJoaquín Ignacio Aramendía
67ed264e8aSJoaquín Ignacio AramendíaSysfs entries
68ed264e8aSJoaquín Ignacio Aramendía-------------
69ed264e8aSJoaquín Ignacio Aramendía
70ed264e8aSJoaquín Ignacio AramendíaThe following attributes are supported:
71ed264e8aSJoaquín Ignacio Aramendía
72ed264e8aSJoaquín Ignacio Aramendíafan1_input
7334ea1f98SCryolitia PukNgae  Read Only. Reads current fan RPM.
74ed264e8aSJoaquín Ignacio Aramendía
75ed264e8aSJoaquín Ignacio Aramendíapwm1_enable
76ed264e8aSJoaquín Ignacio Aramendía  Read Write. Enable manual fan control. Write "1" to set to manual, write "0"
77ed264e8aSJoaquín Ignacio Aramendía  to let the EC control de fan speed. Read this attribute to see current status.
78ed264e8aSJoaquín Ignacio Aramendía
79ed264e8aSJoaquín Ignacio Aramendíapwm1
80ed264e8aSJoaquín Ignacio Aramendía  Read Write. Read this attribute to see current duty cycle in the range [0-255].
81ed264e8aSJoaquín Ignacio Aramendía  When pwm1_enable is set to "1" (manual) write any value in the range [0-255]
82ed264e8aSJoaquín Ignacio Aramendía  to set fan speed.
83be144ee4SJoaquín Ignacio Aramendía
84be144ee4SJoaquín Ignacio Aramendíatt_toggle
85be144ee4SJoaquín Ignacio Aramendía  Read Write. Read this attribute to check the status of the turbo/silent
86be144ee4SJoaquín Ignacio Aramendía  button behaviour function. Write "1" to activate the switch and "0" to
87be144ee4SJoaquín Ignacio Aramendía  deactivate it. The specific keycodes and behaviour is specific to the device
88be144ee4SJoaquín Ignacio Aramendía  both with this function on and off. This attribute is attached to the platform
89be144ee4SJoaquín Ignacio Aramendía  driver and not to the hwmon driver (/sys/devices/platform/oxp-platform/tt_toggle)
90