[PATCH linux dev-4.10 v3 3/5] Documentation: hwmon: Add IBM power supply documentation

[Brandon Wyman]

On Wed, Aug 2, 2017 at 3:25 PM, Eddie James <eajames at linux.vnet.ibm.com> wrote:
> From: "Edward A. James" <eajames at us.ibm.com>
>
> Signed-off-by: Edward A. James <eajames at us.ibm.com>
> ---
>  Documentation/hwmon/ibmps | 53 +++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 53 insertions(+)
>  create mode 100644 Documentation/hwmon/ibmps
>
> diff --git a/Documentation/hwmon/ibmps b/Documentation/hwmon/ibmps
> new file mode 100644
> index 0000000..7f13fd4
> --- /dev/null
> +++ b/Documentation/hwmon/ibmps
> @@ -0,0 +1,53 @@
> +Kernel driver ibmps
> +====================
> +
> +Supported chips:
> +  * IBM Witherspoon power supply
> +
> +Author: Eddie James <eajames at us.ibm.com>
> +
> +Description
> +-----------
> +
> +This driver supports the IBM power supply. This driver is a client to the core
> +PMBus driver.
> +
> +Usage Notes
> +-----------
> +
> +This driver should auto-detect devices. In the event that it does not, you will
> +have to instantiate the devices explicitly. Please see
> +Documentation/i2c/instantiating-devices for details.
> +
> +Sysfs entries
> +-------------
> +
> +The following attributes are supported:
> +
> +curr1_alarm            Output current over-current fault.
> +curr1_input            Measured output current in mA.
> +curr1_label            "iout1"
> +
> +fan1_alarm             Fan 1 warning.
> +fan1_fault             Fan 1 fault.
> +fan1_input             Fan 1 speed in RPM.
> +fan2_alarm             Fan 2 warning.
> +fan2_fault             Fan 2 fault.
> +fan2_input             Fan 2 speed in RPM.
> +
> +in1_alarm              Input voltage under-voltage fault.

Is this the normal/regular file to put this under-voltage fault in? I
noticed that the UCD9200 device driver appears to be the only one
looking for that right now, and it has it updating in1_lcrit_alarm:
ucd9200:in1_lcrit_alarm         Voltage critical low alarm. From
VIN_UV_FAULT status.

> +in1_input              Measured input voltage in mV.
> +in1_label              "vin"
> +in2_alarm              Output voltage over-voltage fault.
> +in2_input              Measured output voltage in mV.
> +in2_label              "vout1"
> +
> +power1_input           Measured input power in uW.
> +power1_label           "pin"
> +
> +temp1_alarm            PSU inlet ambient temperature over-temperature fault.
> +temp1_input            Measured PSU inlet ambient temp in millidegrees C.
> +temp2_alarm            Secondary rectifier temp over-temperature fault.
> +temp2_input            Measured secondary rectifier temp in millidegrees C.
> +temp3_alarm            ORing FET temperature over-temperature fault.
> +temp3_input            Measured ORing FET temperature in millidegrees C.
> --
> 1.8.3.1
>