Documentation/hwmon/oxp-sensors.rst

   1 .. SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 Kernel driver oxp-sensors
   4 =========================
   5
   6 Authors:
   7     - Derek John Clark <derekjohn.clark@gmail.com>
   8     - Joaquín Ignacio Aramendía <samsagax@gmail.com>
   9
  10 Description:
  11 ------------
  12
  13 Handheld devices from One Netbook and Aya Neo provide fan readings and fan
  14 control through their embedded controllers.
  15
  16 Currently only supports AMD boards from One X Player, AOK ZOE, and some Aya
  17 Neo devices. One X Player Intel boards could be supported if we could figure
  18 out the EC registers and values to write to since the EC layout and model is
  19 different. Aya Neo devices preceding the AIR may not be supportable as the EC
  20 model is different and do not appear to have manual control capabilities.
  21
  22 Some models have a toggle for changing the behaviour of the "Turbo/Silent"
  23 button of the device. It will change the key event that it triggers with
  24 a flip of the `tt_toggle` attribute. See below for boards that support this
  25 function.
  26
  27 Supported devices
  28 -----------------
  29
  30 Currently the driver supports the following handhelds:
  31
  32  - AOK ZOE A1
  33  - AOK ZOE A1 PRO
  34  - Aya Neo 2
  35  - Aya Neo AIR
  36  - Aya Neo AIR Plus (Mendocino)
  37  - Aya Neo AIR Pro
  38  - Aya Neo Geek
  39  - OneXPlayer AMD
  40  - OneXPlayer mini AMD
  41  - OneXPlayer mini AMD PRO
  42
  43 "Turbo/Silent" button behaviour toggle is only supported on:
  44  - AOK ZOE A1
  45  - AOK ZOE A1 PRO
  46  - OneXPlayer mini AMD (only with updated alpha BIOS)
  47  - OneXPlayer mini AMD PRO
  48
  49 Sysfs entries
  50 -------------
  51
  52 The following attributes are supported:
  53
  54 fan1_input
  55   Read Only. Reads current fan RMP.
  56
  57 pwm1_enable
  58   Read Write. Enable manual fan control. Write "1" to set to manual, write "0"
  59   to let the EC control de fan speed. Read this attribute to see current status.
  60
  61 pwm1
  62   Read Write. Read this attribute to see current duty cycle in the range [0-255].
  63   When pwm1_enable is set to "1" (manual) write any value in the range [0-255]
  64   to set fan speed.
  65
  66 tt_toggle
  67   Read Write. Read this attribute to check the status of the turbo/silent
  68   button behaviour function. Write "1" to activate the switch and "0" to
  69   deactivate it. The specific keycodes and behaviour is specific to the device
  70   both with this function on and off. This attribute is attached to the platform
  71   driver and not to the hwmon driver (/sys/devices/platform/oxp-platform/tt_toggle)