From: Mario Kicherer Date: Wed, 18 Jan 2023 12:30:18 +0000 (+0100) Subject: docs: hwmon: add docs for the NXP MC34VR500 PMIC X-Git-Tag: v6.6.7~3481^2~25 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a66c9147916fefc66dba06236ff5307180d95cd4;p=platform%2Fkernel%2Flinux-starfive.git docs: hwmon: add docs for the NXP MC34VR500 PMIC Add documentation for the NXP MC34VR500 PMIC. Signed-off-by: Mario Kicherer Link: https://lore.kernel.org/r/20230118123019.3041303-3-dev@kicherer.org [groeck: Added to index] Signed-off-by: Guenter Roeck --- diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst index 7b36b08..95f5459 100644 --- a/Documentation/hwmon/index.rst +++ b/Documentation/hwmon/index.rst @@ -145,6 +145,7 @@ Hardware Monitoring Kernel Drivers max6697 max8688 mc13783-adc + mc34vr500 mcp3021 menf21bmc mlxreg-fan diff --git a/Documentation/hwmon/mc34vr500.rst b/Documentation/hwmon/mc34vr500.rst new file mode 100644 index 0000000..f82d872 --- /dev/null +++ b/Documentation/hwmon/mc34vr500.rst @@ -0,0 +1,32 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Kernel driver mc34vr500 +======================= + +Supported Chips: + + * NXP MC34VR500 + + Prefix: 'mc34vr500' + + Datasheet: https://www.nxp.com/docs/en/data-sheet/MC34VR500.pdf + +Author: Mario Kicherer + +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 -> in0_min_alarm +>110°c -> temp1_max_alarm +>120°c -> temp1_crit_alarm +>130°c -> temp1_emergency_alarm