[thirdparty/kernel/stable.git] / Documentation / hwmon / xgene-hwmon.rst

Kernel driver xgene-hwmon
=========================

Supported chips:

 * APM X-Gene SoC

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

This driver adds hardware temperature and power reading support for
APM X-Gene SoC using the mailbox communication interface.
For device tree, it is the standard DT mailbox.
For ACPI, it is the PCC mailbox.

The following sensors are supported

  * Temperature
      - SoC on-die temperature in milli-degree C
      - Alarm when high/over temperature occurs

  * Power
      - CPU power in uW
      - IO power in uW

sysfs-Interface
---------------

temp0_input
	- SoC on-die temperature (milli-degree C)
temp0_critical_alarm
	- An 1 would indicates on-die temperature exceeded threshold
power0_input
	- CPU power in (uW)
power1_input
	- IO power in (uW)
Commit	Line	Data
ed42cfa8	1	Kernel driver xgene-hwmon
b04f2f7d	2	=========================
ed42cfa8	3
ed42cfa8	4	Supported chips:
b04f2f7d	5
ed42cfa8	6	* APM X-Gene SoC
	7
	8	Description
	9	-----------
	10
	11	This driver adds hardware temperature and power reading support for
	12	APM X-Gene SoC using the mailbox communication interface.
	13	For device tree, it is the standard DT mailbox.
	14	For ACPI, it is the PCC mailbox.
	15
	16	The following sensors are supported
	17
	18	* Temperature
b04f2f7d MCC	19	- SoC on-die temperature in milli-degree C
	20	- Alarm when high/over temperature occurs
	21
ed42cfa8	22	* Power
b04f2f7d MCC	23	- CPU power in uW
b04f2f7d MCC	24	- IO power in uW
ed42cfa8	25
	26	sysfs-Interface
	27	---------------
	28
b04f2f7d MCC	29	temp0_input
	30	- SoC on-die temperature (milli-degree C)
	31	temp0_critical_alarm
	32	- An 1 would indicates on-die temperature exceeded threshold
	33	power0_input
	34	- CPU power in (uW)
	35	power1_input
	36	- IO power in (uW)