xref: /linux/Documentation/hwmon/tvs-mpfs.rst (revision 7acf90feab8b009fde7def08ff2c622d0f10e99f)
1*ecc0eb5eSLars Randers.. SPDX-License-Identifier: GPL-2.0
2*ecc0eb5eSLars Randers
3*ecc0eb5eSLars RandersKernel driver tvs-mpfs
4*ecc0eb5eSLars Randers======================
5*ecc0eb5eSLars Randers
6*ecc0eb5eSLars RandersSupported chips:
7*ecc0eb5eSLars Randers
8*ecc0eb5eSLars Randers  * PolarFire SoC
9*ecc0eb5eSLars Randers
10*ecc0eb5eSLars RandersAuthors:
11*ecc0eb5eSLars Randers
12*ecc0eb5eSLars Randers   - Conor Dooley <conor.dooley@microchip.com>
13*ecc0eb5eSLars Randers   - Lars Randers <lranders@mail.dk>
14*ecc0eb5eSLars Randers
15*ecc0eb5eSLars RandersDescription
16*ecc0eb5eSLars Randers-----------
17*ecc0eb5eSLars Randers
18*ecc0eb5eSLars RandersThis driver implements support for the temperature and voltage sensors on
19*ecc0eb5eSLars RandersPolarFire SoC. The temperature reports how hot the die is, and the voltages are
20*ecc0eb5eSLars Randersthe SoC's 1.05, 1.8 and 2.5 volt rails respectively.
21*ecc0eb5eSLars Randers
22*ecc0eb5eSLars Randers
23*ecc0eb5eSLars RandersUsage Notes
24*ecc0eb5eSLars Randers-----------
25*ecc0eb5eSLars Randers
26*ecc0eb5eSLars Randersupdate_interval has a permitted range of 0 to 8 milliseconds.
27*ecc0eb5eSLars Randers
28*ecc0eb5eSLars RandersTemperatures are read in millidegrees Celsius, but the hardware measures in
29*ecc0eb5eSLars Randersdegrees Kelvin, storing the result as 11.4 fixed point data, for a maximum
30*ecc0eb5eSLars Randersvalue of 2047.9375 degrees Kelvin.
31*ecc0eb5eSLars Randers
32*ecc0eb5eSLars RandersVoltages are read in millivolts. The hardware measures in millivolts, storing
33*ecc0eb5eSLars Randersthe value as 12.3 fixed point data, for a maximum of 4095.875 millivolts.
34*ecc0eb5eSLars RandersThe minimum value reportable by the driver is 0 volts, although the hardware
35*ecc0eb5eSLars Randersis capable of measuring negative values.
36*ecc0eb5eSLars Randers
37*ecc0eb5eSLars RandersSysfs entries
38*ecc0eb5eSLars Randers-------------
39*ecc0eb5eSLars Randers
40*ecc0eb5eSLars RandersThe following attributes are supported. update_interval is read-write, as are
41*ecc0eb5eSLars Randersthe enables. All other attributes are read only.
42*ecc0eb5eSLars Randers
43*ecc0eb5eSLars Randers======================= ====================================================
44*ecc0eb5eSLars Randerstemp1_label		Fixed name for channel.
45*ecc0eb5eSLars Randerstemp1_input		Measured temperature for channel.
46*ecc0eb5eSLars Randerstemp1_enable		Enable/disable for channel.
47*ecc0eb5eSLars Randers
48*ecc0eb5eSLars Randersin[0-2]_label		Fixed name for channel.
49*ecc0eb5eSLars Randersin[0-2]_input		Measured voltage for channel.
50*ecc0eb5eSLars Randersin[0-2]_enable		Enable/disable for channel.
51*ecc0eb5eSLars Randers
52*ecc0eb5eSLars Randersupdate_interval		The interval at which the chip will update readings.
53*ecc0eb5eSLars Randers======================= ====================================================
54