| Message ID | 20230118123019.3041303-3-dev@kicherer.org (mailing list archive) |
|---|---|
| State | Accepted |
| Headers | show |
| Series | hwmon: add initial NXP MC34VR500 PMIC monitoring support | expand |
On Wed, Jan 18, 2023 at 01:30:18PM +0100, Mario Kicherer wrote: > Add documentation for the NXP MC34VR500 PMIC. > > Signed-off-by: Mario Kicherer <dev@kicherer.org> Checkpatch notes that the SPDX license identifier is missing. I copied the one from the source (SPDX-License-Identifier: GPL-2.0-or-later). If this is not what you want, please let me know and/or resubmit with the desired license identifier. Thanks, Guenter > --- > Documentation/hwmon/mc34vr500.rst | 30 ++++++++++++++++++++++++++++++ > 1 file changed, 30 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..c9e3b44fb04f > --- /dev/null > +++ b/Documentation/hwmon/mc34vr500.rst > @@ -0,0 +1,30 @@ > +Kernel driver mc34vr500 > +======================= > + > +Supported Chips: > + > + * NXP MC34VR500 > + > + Prefix: 'mc34vr500' > + > + 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 -> in0_min_alarm > +>110°c -> temp1_max_alarm > +>120°c -> temp1_crit_alarm > +>130°c -> temp1_emergency_alarm
diff --git a/Documentation/hwmon/mc34vr500.rst b/Documentation/hwmon/mc34vr500.rst new file mode 100644 index 000000000000..c9e3b44fb04f --- /dev/null +++ b/Documentation/hwmon/mc34vr500.rst @@ -0,0 +1,30 @@ +Kernel driver mc34vr500 +======================= + +Supported Chips: + + * NXP MC34VR500 + + Prefix: 'mc34vr500' + + 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 -> in0_min_alarm +>110°c -> temp1_max_alarm +>120°c -> temp1_crit_alarm +>130°c -> temp1_emergency_alarm
Add documentation for the NXP MC34VR500 PMIC. Signed-off-by: Mario Kicherer <dev@kicherer.org> --- Documentation/hwmon/mc34vr500.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 Documentation/hwmon/mc34vr500.rst