linux-hwmon.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mario Kicherer <dev@kicherer.org>
To: linux-hwmon@vger.kernel.org
Cc: jdelvare@suse.com, linux@roeck-us.net, robh+dt@kernel.org,
	krzysztof.kozlowski+dt@linaro.org, corbet@lwn.net,
	linux-doc@vger.kernel.org, devicetree@vger.kernel.org,
	Mario Kicherer <dev@kicherer.org>
Subject: [PATCH v4 2/3] docs: hwmon: add docs for the NXP MC34VR500 PMIC
Date: Wed, 18 Jan 2023 13:30:18 +0100	[thread overview]
Message-ID: <20230118123019.3041303-3-dev@kicherer.org> (raw)
In-Reply-To: <20230118123019.3041303-1-dev@kicherer.org>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=y, Size: 1403 bytes --]

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

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
-- 
2.34.1


  parent reply	other threads:[~2023-01-18 13:08 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-18 12:30 [PATCH v4 0/3] hwmon: add initial NXP MC34VR500 PMIC monitoring support Mario Kicherer
2023-01-18 12:30 ` [PATCH v4 1/3] dt-bindings: hwmon: add nxp,mc34vr500 Mario Kicherer
2023-01-19 11:42   ` Krzysztof Kozlowski
2023-01-24 13:56   ` Guenter Roeck
2023-01-18 12:30 ` Mario Kicherer [this message]
2023-01-24 13:59   ` [PATCH v4 2/3] docs: hwmon: add docs for the NXP MC34VR500 PMIC Guenter Roeck
2023-01-18 12:30 ` [PATCH v4 3/3] hwmon: add initial NXP MC34VR500 PMIC monitoring support Mario Kicherer
2023-01-24 14:00   ` Guenter Roeck

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230118123019.3041303-3-dev@kicherer.org \
    --to=dev@kicherer.org \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=jdelvare@suse.com \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).