Merge tag 'lkdtm-next' of https://git.kernel.org/pub/scm/linux/kernel/git/kees/linux...
[platform/kernel/linux-starfive.git] / Documentation / hwmon / lochnagar.rst
1 Kernel Driver Lochnagar
2 =======================
3
4 Supported systems:
5   * Cirrus Logic : Lochnagar 2
6
7 Author: Lucas A. Tanure Alves
8
9 Description
10 -----------
11
12 Lochnagar 2 features built-in Current Monitor circuitry that allows for the
13 measurement of both voltage and current on up to eight of the supply voltage
14 rails provided to the minicards. The Current Monitor does not require any
15 hardware modifications or external circuitry to operate.
16
17 The current and voltage measurements are obtained through the standard register
18 map interface to the Lochnagar board controller, and can therefore be monitored
19 by software.
20
21 Sysfs attributes
22 ----------------
23
24 ======================= =======================================================
25 temp1_input             The Lochnagar board temperature (milliCelsius)
26 in0_input               Measured voltage for DBVDD1 (milliVolts)
27 in0_label               "DBVDD1"
28 curr1_input             Measured current for DBVDD1 (milliAmps)
29 curr1_label             "DBVDD1"
30 power1_average          Measured average power for DBVDD1 (microWatts)
31 power1_average_interval Power averaging time input valid from 1 to 1708mS
32 power1_label            "DBVDD1"
33 in1_input               Measured voltage for 1V8 DSP (milliVolts)
34 in1_label               "1V8 DSP"
35 curr2_input             Measured current for 1V8 DSP (milliAmps)
36 curr2_label             "1V8 DSP"
37 power2_average          Measured average power for 1V8 DSP (microWatts)
38 power2_average_interval Power averaging time input valid from 1 to 1708mS
39 power2_label            "1V8 DSP"
40 in2_input               Measured voltage for 1V8 CDC (milliVolts)
41 in2_label               "1V8 CDC"
42 curr3_input             Measured current for 1V8 CDC (milliAmps)
43 curr3_label             "1V8 CDC"
44 power3_average          Measured average power for 1V8 CDC (microWatts)
45 power3_average_interval Power averaging time input valid from 1 to 1708mS
46 power3_label            "1V8 CDC"
47 in3_input               Measured voltage for VDDCORE DSP (milliVolts)
48 in3_label               "VDDCORE DSP"
49 curr4_input             Measured current for VDDCORE DSP (milliAmps)
50 curr4_label             "VDDCORE DSP"
51 power4_average          Measured average power for VDDCORE DSP (microWatts)
52 power4_average_interval Power averaging time input valid from 1 to 1708mS
53 power4_label            "VDDCORE DSP"
54 in4_input               Measured voltage for AVDD 1V8 (milliVolts)
55 in4_label               "AVDD 1V8"
56 curr5_input             Measured current for AVDD 1V8 (milliAmps)
57 curr5_label             "AVDD 1V8"
58 power5_average          Measured average power for AVDD 1V8 (microWatts)
59 power5_average_interval Power averaging time input valid from 1 to 1708mS
60 power5_label            "AVDD 1V8"
61 curr6_input             Measured current for SYSVDD (milliAmps)
62 curr6_label             "SYSVDD"
63 power6_average          Measured average power for SYSVDD (microWatts)
64 power6_average_interval Power averaging time input valid from 1 to 1708mS
65 power6_label            "SYSVDD"
66 in6_input               Measured voltage for VDDCORE CDC (milliVolts)
67 in6_label               "VDDCORE CDC"
68 curr7_input             Measured current for VDDCORE CDC (milliAmps)
69 curr7_label             "VDDCORE CDC"
70 power7_average          Measured average power for VDDCORE CDC (microWatts)
71 power7_average_interval Power averaging time input valid from 1 to 1708mS
72 power7_label            "VDDCORE CDC"
73 in7_input               Measured voltage for MICVDD (milliVolts)
74 in7_label               "MICVDD"
75 curr8_input             Measured current for MICVDD (milliAmps)
76 curr8_label             "MICVDD"
77 power8_average          Measured average power for MICVDD (microWatts)
78 power8_average_interval Power averaging time input valid from 1 to 1708mS
79 power8_label            "MICVDD"
80 ======================= =======================================================
81
82 Note:
83     It is not possible to measure voltage on the SYSVDD rail.