summaryrefslogtreecommitdiffstats
path: root/Documentation/hwmon/lattepanda-sigma-ec.rst
blob: 8a521ee1fef1e1c4704eb40537f7cb1c4ebd68ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.. SPDX-License-Identifier: GPL-2.0-or-later

Kernel driver lattepanda-sigma-ec
=================================

Supported systems:

  * LattePanda Sigma (Intel 13th Gen i5-1340P)

    DMI vendor: LattePanda

    DMI product: LattePanda Sigma

    BIOS version: 5.27 (verified)

    Datasheet: Not available (EC registers discovered empirically)

Author: Mariano Abad <weimaraner@gmail.com>

Description
-----------

This driver provides hardware monitoring for the LattePanda Sigma
single-board computer made by DFRobot. The board uses an ITE IT8613E
Embedded Controller to manage a CPU cooling fan and thermal sensors.

The BIOS declares the ACPI Embedded Controller (``PNP0C09``) with
``_STA`` returning 0, preventing the kernel's ACPI EC subsystem from
initializing. This driver reads the EC directly via the standard ACPI
EC I/O ports (``0x62`` data, ``0x66`` command/status).

Sysfs attributes
----------------

======================= ===============================================
``fan1_input``          Fan speed in RPM (EC registers 0x2E:0x2F,
                        16-bit big-endian)
``fan1_label``          "CPU Fan"
``temp1_input``         Board/ambient temperature in millidegrees
                        Celsius (EC register 0x60, unsigned)
``temp1_label``         "Board Temp"
``temp2_input``         CPU proximity temperature in millidegrees
                        Celsius (EC register 0x70, unsigned)
``temp2_label``         "CPU Temp"
======================= ===============================================

Module parameters
-----------------

``force`` (bool, default false)
    Force loading on BIOS versions other than 5.27. The driver still
    requires DMI vendor and product name matching.

Known limitations
-----------------

* Fan speed control is not supported. The fan is always under EC
  automatic control.
* The EC register map was verified only on BIOS version 5.27.
  Other versions may use different register offsets; use the ``force``
  parameter at your own risk.