xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/max8688.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunKernel driver max8688
2*4882a593Smuzhiyun=====================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunSupported chips:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun  * Maxim MAX8688
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun    Prefix: 'max8688'
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun    Addresses scanned: -
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf
13*4882a593Smuzhiyun
14*4882a593SmuzhiyunAuthor: Guenter Roeck <linux@roeck-us.net>
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunDescription
18*4882a593Smuzhiyun-----------
19*4882a593Smuzhiyun
20*4882a593SmuzhiyunThis driver supports hardware monitoring for Maxim MAX8688 Digital Power-Supply
21*4882a593SmuzhiyunController/Monitor with PMBus Interface.
22*4882a593Smuzhiyun
23*4882a593SmuzhiyunThe driver is a client driver to the core PMBus driver. Please see
24*4882a593SmuzhiyunDocumentation/hwmon/pmbus.rst for details on PMBus client drivers.
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun
27*4882a593SmuzhiyunUsage Notes
28*4882a593Smuzhiyun-----------
29*4882a593Smuzhiyun
30*4882a593SmuzhiyunThis driver does not auto-detect devices. You will have to instantiate the
31*4882a593Smuzhiyundevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
32*4882a593Smuzhiyundetails.
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun
35*4882a593SmuzhiyunPlatform data support
36*4882a593Smuzhiyun---------------------
37*4882a593Smuzhiyun
38*4882a593SmuzhiyunThe driver supports standard PMBus driver platform data.
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun
41*4882a593SmuzhiyunSysfs entries
42*4882a593Smuzhiyun-------------
43*4882a593Smuzhiyun
44*4882a593SmuzhiyunThe following attributes are supported. Limits are read-write; all other
45*4882a593Smuzhiyunattributes are read-only.
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun======================= ========================================================
48*4882a593Smuzhiyunin1_label		"vout1"
49*4882a593Smuzhiyunin1_input		Measured voltage. From READ_VOUT register.
50*4882a593Smuzhiyunin1_min			Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
51*4882a593Smuzhiyunin1_max			Maximum voltage. From VOUT_OV_WARN_LIMIT register.
52*4882a593Smuzhiyunin1_lcrit		Critical minimum Voltage. VOUT_UV_FAULT_LIMIT register.
53*4882a593Smuzhiyunin1_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT
54*4882a593Smuzhiyun			register.
55*4882a593Smuzhiyunin1_min_alarm		Voltage low alarm. From VOLTAGE_UV_WARNING status.
56*4882a593Smuzhiyunin1_max_alarm		Voltage high alarm. From VOLTAGE_OV_WARNING status.
57*4882a593Smuzhiyunin1_lcrit_alarm		Voltage critical low alarm. From VOLTAGE_UV_FAULT
58*4882a593Smuzhiyun			status.
59*4882a593Smuzhiyunin1_crit_alarm		Voltage critical high alarm. From VOLTAGE_OV_FAULT
60*4882a593Smuzhiyun			status.
61*4882a593Smuzhiyunin1_highest		Historical maximum voltage.
62*4882a593Smuzhiyunin1_reset_history	Write any value to reset history.
63*4882a593Smuzhiyun
64*4882a593Smuzhiyuncurr1_label		"iout1"
65*4882a593Smuzhiyuncurr1_input		Measured current. From READ_IOUT register.
66*4882a593Smuzhiyuncurr1_max		Maximum current. From IOUT_OC_WARN_LIMIT register.
67*4882a593Smuzhiyuncurr1_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT
68*4882a593Smuzhiyun			register.
69*4882a593Smuzhiyuncurr1_max_alarm		Current high alarm. From IOUT_OC_WARN_LIMIT register.
70*4882a593Smuzhiyuncurr1_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.
71*4882a593Smuzhiyuncurr1_highest		Historical maximum current.
72*4882a593Smuzhiyuncurr1_reset_history	Write any value to reset history.
73*4882a593Smuzhiyun
74*4882a593Smuzhiyuntemp1_input		Measured temperature. From READ_TEMPERATURE_1 register.
75*4882a593Smuzhiyuntemp1_max		Maximum temperature. From OT_WARN_LIMIT register.
76*4882a593Smuzhiyuntemp1_crit		Critical high temperature. From OT_FAULT_LIMIT register.
77*4882a593Smuzhiyuntemp1_max_alarm		Chip temperature high alarm. Set by comparing
78*4882a593Smuzhiyun			READ_TEMPERATURE_1 with OT_WARN_LIMIT if TEMP_OT_WARNING
79*4882a593Smuzhiyun			status is set.
80*4882a593Smuzhiyuntemp1_crit_alarm	Chip temperature critical high alarm. Set by comparing
81*4882a593Smuzhiyun			READ_TEMPERATURE_1 with OT_FAULT_LIMIT if TEMP_OT_FAULT
82*4882a593Smuzhiyun			status is set.
83*4882a593Smuzhiyuntemp1_highest		Historical maximum temperature.
84*4882a593Smuzhiyuntemp1_reset_history	Write any value to reset history.
85*4882a593Smuzhiyun======================= ========================================================
86