Re: [PATCH v3 3/3] docs: hwmon: add docs for the NXP MC34VR500 PMIC

[Guenter Roeck <linux@roeck-us.net>]

On Tue, Jan 17, 2023 at 05:13:40PM +0100, Mario Kicherer wrote:
> This patch adds documentation for the NXP MC34VR500 PMIC.

"Add documentation".

See Documentation/process/submitting-patches.rst,
"Describe your changes".

> 
> Signed-off-by: Mario Kicherer <dev@kicherer.org>
> ---
>  Documentation/hwmon/mc34vr500.rst | 32 +++++++++++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 Documentation/hwmon/mc34vr500.rst
> 
> diff --git a/Documentation/hwmon/mc34vr500.rst b/Documentation/hwmon/mc34vr500.rst
> new file mode 100644
> index 000000000000..5a8e0cbf4dbf
> --- /dev/null
> +++ b/Documentation/hwmon/mc34vr500.rst
> @@ -0,0 +1,32 @@
> +Kernel driver mc34vr500
> +=======================
> +
> +Supported Chips:
> +
> +  * NXP MC34VR500
> +
> +    Prefix: 'mc34vr500'
> +
> +    Addresses scanned: I2C 0x08

No, since there is no detect function.

> +
> +    Datasheet: https://www.nxp.com/docs/en/data-sheet/MC34VR500.pdf
> +
> +Author: Mario Kicherer <dev@kicherer.org>
> +
> +Description
> +-----------
> +
> +This driver implements initial support for the NXP MC34VR500 PMIC. The MC34VR500
> +monitors the temperature, input voltage and output currents and provides
> +corresponding alarms. For the temperature, the chip can send interrupts if
> +the temperature rises above one of the following values: 110°, 120°, 125° and
> +130° Celsius. For the input voltage, an interrupt is sent when the voltage
> +drops below 2.8V.
> +
> +Currently, this driver only implements the input voltage and temperature
> +alarms. The interrupts are mapped as follows:
> +
> +<= 2.8V  -> in_min_alarm

in0_min_alarm

> +>110°c   -> temp_max_alarm
> +>120°c   -> temp_crit_alarm
> +>130°c   -> temp_emergency_alarm

temp1_xxx

> -- 
> 2.34.1
>