xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/lochnagar.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunKernel Driver Lochnagar
2*4882a593Smuzhiyun=======================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunSupported systems:
5*4882a593Smuzhiyun  * Cirrus Logic : Lochnagar 2
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunAuthor: Lucas A. Tanure Alves
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunDescription
10*4882a593Smuzhiyun-----------
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunLochnagar 2 features built-in Current Monitor circuitry that allows for the
13*4882a593Smuzhiyunmeasurement of both voltage and current on up to eight of the supply voltage
14*4882a593Smuzhiyunrails provided to the minicards. The Current Monitor does not require any
15*4882a593Smuzhiyunhardware modifications or external circuitry to operate.
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunThe current and voltage measurements are obtained through the standard register
18*4882a593Smuzhiyunmap interface to the Lochnagar board controller, and can therefore be monitored
19*4882a593Smuzhiyunby software.
20*4882a593Smuzhiyun
21*4882a593SmuzhiyunSysfs attributes
22*4882a593Smuzhiyun----------------
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun======================= =======================================================
25*4882a593Smuzhiyuntemp1_input             The Lochnagar board temperature (milliCelsius)
26*4882a593Smuzhiyunin0_input               Measured voltage for DBVDD1 (milliVolts)
27*4882a593Smuzhiyunin0_label               "DBVDD1"
28*4882a593Smuzhiyuncurr1_input             Measured current for DBVDD1 (milliAmps)
29*4882a593Smuzhiyuncurr1_label             "DBVDD1"
30*4882a593Smuzhiyunpower1_average          Measured average power for DBVDD1 (microWatts)
31*4882a593Smuzhiyunpower1_average_interval Power averaging time input valid from 1 to 1708mS
32*4882a593Smuzhiyunpower1_label            "DBVDD1"
33*4882a593Smuzhiyunin1_input               Measured voltage for 1V8 DSP (milliVolts)
34*4882a593Smuzhiyunin1_label               "1V8 DSP"
35*4882a593Smuzhiyuncurr2_input             Measured current for 1V8 DSP (milliAmps)
36*4882a593Smuzhiyuncurr2_label             "1V8 DSP"
37*4882a593Smuzhiyunpower2_average          Measured average power for 1V8 DSP (microWatts)
38*4882a593Smuzhiyunpower2_average_interval Power averaging time input valid from 1 to 1708mS
39*4882a593Smuzhiyunpower2_label            "1V8 DSP"
40*4882a593Smuzhiyunin2_input               Measured voltage for 1V8 CDC (milliVolts)
41*4882a593Smuzhiyunin2_label               "1V8 CDC"
42*4882a593Smuzhiyuncurr3_input             Measured current for 1V8 CDC (milliAmps)
43*4882a593Smuzhiyuncurr3_label             "1V8 CDC"
44*4882a593Smuzhiyunpower3_average          Measured average power for 1V8 CDC (microWatts)
45*4882a593Smuzhiyunpower3_average_interval Power averaging time input valid from 1 to 1708mS
46*4882a593Smuzhiyunpower3_label            "1V8 CDC"
47*4882a593Smuzhiyunin3_input               Measured voltage for VDDCORE DSP (milliVolts)
48*4882a593Smuzhiyunin3_label               "VDDCORE DSP"
49*4882a593Smuzhiyuncurr4_input             Measured current for VDDCORE DSP (milliAmps)
50*4882a593Smuzhiyuncurr4_label             "VDDCORE DSP"
51*4882a593Smuzhiyunpower4_average          Measured average power for VDDCORE DSP (microWatts)
52*4882a593Smuzhiyunpower4_average_interval Power averaging time input valid from 1 to 1708mS
53*4882a593Smuzhiyunpower4_label            "VDDCORE DSP"
54*4882a593Smuzhiyunin4_input               Measured voltage for AVDD 1V8 (milliVolts)
55*4882a593Smuzhiyunin4_label               "AVDD 1V8"
56*4882a593Smuzhiyuncurr5_input             Measured current for AVDD 1V8 (milliAmps)
57*4882a593Smuzhiyuncurr5_label             "AVDD 1V8"
58*4882a593Smuzhiyunpower5_average          Measured average power for AVDD 1V8 (microWatts)
59*4882a593Smuzhiyunpower5_average_interval Power averaging time input valid from 1 to 1708mS
60*4882a593Smuzhiyunpower5_label            "AVDD 1V8"
61*4882a593Smuzhiyuncurr6_input             Measured current for SYSVDD (milliAmps)
62*4882a593Smuzhiyuncurr6_label             "SYSVDD"
63*4882a593Smuzhiyunpower6_average          Measured average power for SYSVDD (microWatts)
64*4882a593Smuzhiyunpower6_average_interval Power averaging time input valid from 1 to 1708mS
65*4882a593Smuzhiyunpower6_label            "SYSVDD"
66*4882a593Smuzhiyunin6_input               Measured voltage for VDDCORE CDC (milliVolts)
67*4882a593Smuzhiyunin6_label               "VDDCORE CDC"
68*4882a593Smuzhiyuncurr7_input             Measured current for VDDCORE CDC (milliAmps)
69*4882a593Smuzhiyuncurr7_label             "VDDCORE CDC"
70*4882a593Smuzhiyunpower7_average          Measured average power for VDDCORE CDC (microWatts)
71*4882a593Smuzhiyunpower7_average_interval Power averaging time input valid from 1 to 1708mS
72*4882a593Smuzhiyunpower7_label            "VDDCORE CDC"
73*4882a593Smuzhiyunin7_input               Measured voltage for MICVDD (milliVolts)
74*4882a593Smuzhiyunin7_label               "MICVDD"
75*4882a593Smuzhiyuncurr8_input             Measured current for MICVDD (milliAmps)
76*4882a593Smuzhiyuncurr8_label             "MICVDD"
77*4882a593Smuzhiyunpower8_average          Measured average power for MICVDD (microWatts)
78*4882a593Smuzhiyunpower8_average_interval Power averaging time input valid from 1 to 1708mS
79*4882a593Smuzhiyunpower8_label            "MICVDD"
80*4882a593Smuzhiyun======================= =======================================================
81*4882a593Smuzhiyun
82*4882a593SmuzhiyunNote:
83*4882a593Smuzhiyun    It is not possible to measure voltage on the SYSVDD rail.
84