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 22Some models have a toggle for changing the behaviour of the "Turbo/Silent" 23button of the device. It will change the key event that it triggers with 24a flip of the `tt_toggle` attribute. See below for boards that support this 25function. 26 27Supported devices 28----------------- 29 30Currently the driver supports the following handhelds: 31 32 - AOK ZOE A1 33 - Aya Neo 2 34 - Aya Neo AIR 35 - Aya Neo AIR Pro 36 - Aya Neo Geek 37 - OneXPlayer AMD 38 - OneXPlayer mini AMD 39 - OneXPlayer mini AMD PRO 40 41"Turbo/Silent" button behaviour toggle is only supported on: 42 - AOK ZOE A1 43 - OneXPlayer mini AMD (only with updated alpha BIOS) 44 - OneXPlayer mini AMD PRO 45 46Sysfs entries 47------------- 48 49The following attributes are supported: 50 51fan1_input 52 Read Only. Reads current fan RMP. 53 54pwm1_enable 55 Read Write. Enable manual fan control. Write "1" to set to manual, write "0" 56 to let the EC control de fan speed. Read this attribute to see current status. 57 58pwm1 59 Read Write. Read this attribute to see current duty cycle in the range [0-255]. 60 When pwm1_enable is set to "1" (manual) write any value in the range [0-255] 61 to set fan speed. 62 63tt_toggle 64 Read Write. Read this attribute to check the status of the turbo/silent 65 button behaviour function. Write "1" to activate the switch and "0" to 66 deactivate it. The specific keycodes and behaviour is specific to the device 67 both with this function on and off. This attribute is attached to the platform 68 driver and not to the hwmon driver (/sys/devices/platform/oxp-platform/tt_toggle) 69