xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/max16601.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981) 
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunKernel driver max16601
4*4882a593Smuzhiyun======================
5*4882a593Smuzhiyun
6*4882a593SmuzhiyunSupported chips:
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun  * Maxim MAX16601
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun    Prefix: 'max16601'
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun    Addresses scanned: -
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun    Datasheet: Not published
15*4882a593Smuzhiyun
16*4882a593SmuzhiyunAuthor: Guenter Roeck <linux@roeck-us.net>
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun
19*4882a593SmuzhiyunDescription
20*4882a593Smuzhiyun-----------
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunThis driver supports the MAX16601 VR13.HC Dual-Output Voltage Regulator
23*4882a593SmuzhiyunChipset.
24*4882a593Smuzhiyun
25*4882a593SmuzhiyunThe driver is a client driver to the core PMBus driver.
26*4882a593SmuzhiyunPlease see Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunUsage Notes
30*4882a593Smuzhiyun-----------
31*4882a593Smuzhiyun
32*4882a593SmuzhiyunThis driver does not auto-detect devices. You will have to instantiate the
33*4882a593Smuzhiyundevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
34*4882a593Smuzhiyundetails.
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun
37*4882a593SmuzhiyunPlatform data support
38*4882a593Smuzhiyun---------------------
39*4882a593Smuzhiyun
40*4882a593SmuzhiyunThe driver supports standard PMBus driver platform data.
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun
43*4882a593SmuzhiyunSysfs entries
44*4882a593Smuzhiyun-------------
45*4882a593Smuzhiyun
46*4882a593SmuzhiyunThe following attributes are supported.
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun======================= =======================================================
49*4882a593Smuzhiyunin1_label		"vin1"
50*4882a593Smuzhiyunin1_input		VCORE input voltage.
51*4882a593Smuzhiyunin1_alarm		Input voltage alarm.
52*4882a593Smuzhiyun
53*4882a593Smuzhiyunin2_label		"vout1"
54*4882a593Smuzhiyunin2_input		VCORE output voltage.
55*4882a593Smuzhiyunin2_alarm		Output voltage alarm.
56*4882a593Smuzhiyun
57*4882a593Smuzhiyuncurr1_label		"iin1"
58*4882a593Smuzhiyuncurr1_input		VCORE input current, derived from duty cycle and output
59*4882a593Smuzhiyun			current.
60*4882a593Smuzhiyuncurr1_max		Maximum input current.
61*4882a593Smuzhiyuncurr1_max_alarm		Current high alarm.
62*4882a593Smuzhiyun
63*4882a593Smuzhiyuncurr2_label		"iin1.0"
64*4882a593Smuzhiyuncurr2_input		VCORE phase 0 input current.
65*4882a593Smuzhiyun
66*4882a593Smuzhiyuncurr3_label		"iin1.1"
67*4882a593Smuzhiyuncurr3_input		VCORE phase 1 input current.
68*4882a593Smuzhiyun
69*4882a593Smuzhiyuncurr4_label		"iin1.2"
70*4882a593Smuzhiyuncurr4_input		VCORE phase 2 input current.
71*4882a593Smuzhiyun
72*4882a593Smuzhiyuncurr5_label		"iin1.3"
73*4882a593Smuzhiyuncurr5_input		VCORE phase 3 input current.
74*4882a593Smuzhiyun
75*4882a593Smuzhiyuncurr6_label		"iin1.4"
76*4882a593Smuzhiyuncurr6_input		VCORE phase 4 input current.
77*4882a593Smuzhiyun
78*4882a593Smuzhiyuncurr7_label		"iin1.5"
79*4882a593Smuzhiyuncurr7_input		VCORE phase 5 input current.
80*4882a593Smuzhiyun
81*4882a593Smuzhiyuncurr8_label		"iin1.6"
82*4882a593Smuzhiyuncurr8_input		VCORE phase 6 input current.
83*4882a593Smuzhiyun
84*4882a593Smuzhiyuncurr9_label		"iin1.7"
85*4882a593Smuzhiyuncurr9_input		VCORE phase 7 input current.
86*4882a593Smuzhiyun
87*4882a593Smuzhiyuncurr10_label		"iin2"
88*4882a593Smuzhiyuncurr10_input		VCORE input current, derived from sensor element.
89*4882a593Smuzhiyun
90*4882a593Smuzhiyuncurr11_label		"iin3"
91*4882a593Smuzhiyuncurr11_input		VSA input current.
92*4882a593Smuzhiyun
93*4882a593Smuzhiyuncurr12_label		"iout1"
94*4882a593Smuzhiyuncurr12_input		VCORE output current.
95*4882a593Smuzhiyuncurr12_crit		Critical output current.
96*4882a593Smuzhiyuncurr12_crit_alarm	Output current critical alarm.
97*4882a593Smuzhiyuncurr12_max		Maximum output current.
98*4882a593Smuzhiyuncurr12_max_alarm	Output current high alarm.
99*4882a593Smuzhiyun
100*4882a593Smuzhiyuncurr13_label		"iout1.0"
101*4882a593Smuzhiyuncurr13_input		VCORE phase 0 output current.
102*4882a593Smuzhiyun
103*4882a593Smuzhiyuncurr14_label		"iout1.1"
104*4882a593Smuzhiyuncurr14_input		VCORE phase 1 output current.
105*4882a593Smuzhiyun
106*4882a593Smuzhiyuncurr15_label		"iout1.2"
107*4882a593Smuzhiyuncurr15_input		VCORE phase 2 output current.
108*4882a593Smuzhiyun
109*4882a593Smuzhiyuncurr16_label		"iout1.3"
110*4882a593Smuzhiyuncurr16_input		VCORE phase 3 output current.
111*4882a593Smuzhiyun
112*4882a593Smuzhiyuncurr17_label		"iout1.4"
113*4882a593Smuzhiyuncurr17_input		VCORE phase 4 output current.
114*4882a593Smuzhiyun
115*4882a593Smuzhiyuncurr18_label		"iout1.5"
116*4882a593Smuzhiyuncurr18_input		VCORE phase 5 output current.
117*4882a593Smuzhiyun
118*4882a593Smuzhiyuncurr19_label		"iout1.6"
119*4882a593Smuzhiyuncurr19_input		VCORE phase 6 output current.
120*4882a593Smuzhiyun
121*4882a593Smuzhiyuncurr20_label		"iout1.7"
122*4882a593Smuzhiyuncurr20_input		VCORE phase 7 output current.
123*4882a593Smuzhiyun
124*4882a593Smuzhiyuncurr21_label		"iout3"
125*4882a593Smuzhiyuncurr21_input		VSA output current.
126*4882a593Smuzhiyuncurr21_highest		Historical maximum VSA output current.
127*4882a593Smuzhiyuncurr21_reset_history	Write any value to reset curr21_highest.
128*4882a593Smuzhiyuncurr21_crit		Critical output current.
129*4882a593Smuzhiyuncurr21_crit_alarm	Output current critical alarm.
130*4882a593Smuzhiyuncurr21_max		Maximum output current.
131*4882a593Smuzhiyuncurr21_max_alarm	Output current high alarm.
132*4882a593Smuzhiyun
133*4882a593Smuzhiyunpower1_label		"pin1"
134*4882a593Smuzhiyunpower1_input		Input power, derived from duty cycle and output current.
135*4882a593Smuzhiyunpower1_alarm		Input power alarm.
136*4882a593Smuzhiyun
137*4882a593Smuzhiyunpower2_label		"pin2"
138*4882a593Smuzhiyunpower2_input		Input power, derived from input current sensor.
139*4882a593Smuzhiyun
140*4882a593Smuzhiyunpower3_label		"pout"
141*4882a593Smuzhiyunpower3_input		Output power.
142*4882a593Smuzhiyun
143*4882a593Smuzhiyuntemp1_input		VCORE temperature.
144*4882a593Smuzhiyuntemp1_crit		Critical high temperature.
145*4882a593Smuzhiyuntemp1_crit_alarm	Chip temperature critical high alarm.
146*4882a593Smuzhiyuntemp1_max		Maximum temperature.
147*4882a593Smuzhiyuntemp1_max_alarm		Chip temperature high alarm.
148*4882a593Smuzhiyun
149*4882a593Smuzhiyuntemp2_input		TSENSE_0 temperature
150*4882a593Smuzhiyuntemp3_input		TSENSE_1 temperature
151*4882a593Smuzhiyuntemp4_input		TSENSE_2 temperature
152*4882a593Smuzhiyuntemp5_input		TSENSE_3 temperature
153*4882a593Smuzhiyun
154*4882a593Smuzhiyuntemp6_input		VSA temperature.
155*4882a593Smuzhiyuntemp6_crit		Critical high temperature.
156*4882a593Smuzhiyuntemp6_crit_alarm	Chip temperature critical high alarm.
157*4882a593Smuzhiyuntemp6_max		Maximum temperature.
158*4882a593Smuzhiyuntemp6_max_alarm		Chip temperature high alarm.
159*4882a593Smuzhiyun======================= =======================================================
160