lkml.org 
[lkml]   [2021]   [May]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH v3 6/6] hwmon: (pmbus/pim4328) Add documentation for the pim4328 PMBus driver
From
Date
On 5/24/21 8:02 AM, Erik Rosen wrote:
> Add documentation and index link for pim4328 PMBus driver.
>
> Signed-off-by: Erik Rosen <erik.rosen@metormote.com>
> ---
> Documentation/hwmon/index.rst | 1 +
> Documentation/hwmon/pim4328.rst | 105 ++++++++++++++++++++++++++++++++
> MAINTAINERS | 7 +++
> 3 files changed, 113 insertions(+)
> create mode 100644 Documentation/hwmon/pim4328.rst
>
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index 9ed60fa84cbe..719625f8f755 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -150,6 +150,7 @@ Hardware Monitoring Kernel Drivers
> pc87360
> pc87427
> pcf8591
> + pim4328
> pm6764tr
> pmbus
> powr1220
> diff --git a/Documentation/hwmon/pim4328.rst b/Documentation/hwmon/pim4328.rst
> new file mode 100644
> index 000000000000..70c9e7a6882c
> --- /dev/null
> +++ b/Documentation/hwmon/pim4328.rst
> @@ -0,0 +1,105 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +Kernel driver pim4328
> +=====================
> +
> +Supported chips:
> +
> + * Flex PIM4328
> +
> + Prefix: 'pim4328', 'bmr455'
> +
> + Addresses scanned: -
> +
> + Datasheet:
> +
> +https://flexpowermodules.com/resources/fpm-techspec-pim4328
> +
> + * Flex PIM4820
> +
> + Prefixes: 'pim4820'
> +
> + Addresses scanned: -
> +
> + Datasheet: https://flexpowermodules.com/resources/fpm-techspec-pim4820
> +
> + * Flex PIM4006, PIM4106, PIM4206, PIM4306, PIM4406
> +
> + Prefixes: 'pim4006', 'pim4106', 'pim4206', 'pim4306', 'pim4406'
> +
> + Addresses scanned: -
> +
> + Datasheet: https://flexpowermodules.com/resources/fpm-techspec-pim4006
> +
> +Author: Erik Rosen <erik.rosen@metormote.com>
> +
> +
> +Description
> +-----------
> +
> +This driver supports hardware monitoring for Flex PIM4328 and
> +compatible digital power interface modules.
> +
> +The driver is a client driver to the core PMBus driver. Please see
> +Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
> +on PMBus client drivers.
> +
> +
> +Usage Notes
> +-----------
> +
> +This driver does not auto-detect devices. You will have to instantiate the
> +devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
> +details.
> +
> +
> +Platform data support
> +---------------------
> +
> +The driver supports standard PMBus driver platform data.
> +
> +
> +Sysfs entries
> +-------------
> +
> +The following attributes are supported. All attributes are read-only.
> +
> +======================= ========================================================
> +in1_label "vin"
> +in1_input Measured input voltage.
> +in1_alarm Input voltage alarm.
> +
> +in2_label "vin.0"
> +in2_input Measured input voltage on input A.
> +
> + PIM4328 and PIM4X06
> +
> +in3_label "vin.1"
> +in3_input Measured input voltage on input B.
> +
> + PIM4328 and PIM4X06
> +
> +in4_label "vcap"
> +in4_input Measured voltage on holdup capacitor.
> +
> + PIM4328
> +
> +curr1_label "iin.0"
> +curr1_input Measured input current on input A.
> +
> + PIM4X06
> +
> +curr2_label "iin.1"
> +curr2_input Measured input current on input B.
> +
> + PIM4X06
> +
> +currX_label "iout1"
> +currX_input Measured output current.
> +currX_alarm Output current alarm.
> +
> + X is 1 for PIM4820, 3 otherwise.
> +
> +temp1_input Measured temperature.
> +temp1_alarm High temperature alarm.
> +======================= ========================================================
> diff --git a/MAINTAINERS b/MAINTAINERS
> index bd7aff0c120f..378a121d80f6 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -14416,6 +14416,13 @@ K: (?i)pidfd
> K: (?i)clone3
> K: \b(clone_args|kernel_clone_args)\b
>
> +PIM4328 DRIVER
> +M: Daniel Nilsson <daniel.nilsson@flex.com>

This will require an Ack from Daniel; you can not just nominate someone
else as maintainer.

> +L: linux-hwmon@vger.kernel.org
> +S: Maintained
> +F: Documentation/hwmon/pim4328.rst
> +F: drivers/hwmon/pmbus/pim4328.c
> +
> PIN CONTROL SUBSYSTEM
> M: Linus Walleij <linus.walleij@linaro.org>
> L: linux-gpio@vger.kernel.org
>

\
 
 \ /
  Last update: 2021-05-26 06:33    [W:0.213 / U:0.696 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site