Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2669d9f5 authored by Guenter Roeck's avatar Guenter Roeck
Browse files

hwmon: (max8688) Add driver documentation 



MAX8688 has its own driver, thus should have its own documentation instead of
being mentioned in the generic PMBus driver documentation.

Signed-off-by: default avatarGuenter Roeck <guenter.roeck@ericsson.com>
Reviewed-by: default avatarTom Grennan <tom.grennan@ericsson.com>
parent 180b3d88

Documentation/hwmon/max8688

0 → 100644
+69 −0
Original line number Diff line number Diff line 
Kernel driver max8688

=====================



Supported chips:

  * Maxim MAX8688

    Prefix: 'max8688'

    Addresses scanned: -

    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf



Author: Guenter Roeck <guenter.roeck@ericsson.com>





Description

-----------



This driver supports hardware montoring for Maxim MAX8688 Digital Power-Supply

Controller/Monitor with PMBus Interface.



The driver is a client driver to the core PMBus driver. Please see

Documentation/hwmon/pmbus for details on PMBus client drivers.





Usage Notes

-----------



This driver does not auto-detect devices. You will have to instantiate the

devices explicitly. Please see Documentation/i2c/instantiating-devices for

details.





Platform data support

---------------------



The driver supports standard PMBus driver platform data.





Sysfs entries

-------------



The following attributes are supported. Limits are read-write; all other

attributes are read-only.



in1_label		"vout1"

in1_input		Measured voltage. From READ_VOUT register.

in1_min			Minumum Voltage. From VOUT_UV_WARN_LIMIT register.

in1_max			Maximum voltage. From VOUT_OV_WARN_LIMIT register.

in1_lcrit		Critical minumum Voltage. VOUT_UV_FAULT_LIMIT register.

in1_crit		Critical maximum voltage. From VOUT_OV_FAULT_LIMIT register.

in1_min_alarm		Voltage low alarm. From VOLTAGE_UV_WARNING status.

in1_max_alarm		Voltage high alarm. From VOLTAGE_OV_WARNING status.

in1_lcrit_alarm		Voltage critical low alarm. From VOLTAGE_UV_FAULT status.

in1_crit_alarm		Voltage critical high alarm. From VOLTAGE_OV_FAULT status.



curr1_label		"iout1"

curr1_input		Measured current. From READ_IOUT register.

curr1_max		Maximum current. From IOUT_OC_WARN_LIMIT register.

curr1_crit		Critical maximum current. From IOUT_OC_FAULT_LIMIT register.

curr1_max_alarm		Current high alarm. From IOUT_OC_WARN_LIMIT register.

curr1_crit_alarm	Current critical high alarm. From IOUT_OC_FAULT status.



temp1_input		Measured temperature. From READ_TEMPERATURE_1 register.

temp1_max		Maximum temperature. From OT_WARN_LIMIT register.

temp1_crit		Critical high temperature. From OT_FAULT_LIMIT register.

temp1_max_alarm		Chip temperature high alarm. Set by comparing

			READ_TEMPERATURE_1 with OT_WARN_LIMIT if TEMP_OT_WARNING

			status is set.

temp1_crit_alarm	Chip temperature critical high alarm. Set by comparing

			READ_TEMPERATURE_1 with OT_FAULT_LIMIT if TEMP_OT_FAULT

			status is set.

Documentation/hwmon/pmbus

+0 −5
Original line number Diff line number Diff line
@@ -28,11 +28,6 @@ Supported chips: 
    Prefixes: 'max34441'

    Addresses scanned: -

    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX34441.pdf

  * Maxim MAX8688

    Digital Power-Supply Controller/Monitor

    Prefix: 'max8688'

    Addresses scanned: -

    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8688.pdf

  * Generic PMBus devices

    Prefix: 'pmbus'

    Addresses scanned: -