On Mon, Nov 23, 2020 at 10:56:58AM -0800, rentao.b...@gmail.com wrote:
> From: Tao Ren
>
> Add documentation for the max127 hardware monitoring driver.
>
> Signed-off-by: Tao Ren
> Reviewed-by: Guenter Roeck
Applied.
Thanks,
Guenter
> ---
> Changes in v5:
>- None.
> Changes in v4:
>- None.
> Changes in v3:
>- no code change. xdp maintainers were removed from to/cc list.
> Changes in v2:
>- add more description for min/max sysfs nodes.
>- convert values from volt to millivolt in the document.
>
> Documentation/hwmon/index.rst | 1 +
> Documentation/hwmon/max127.rst | 45 ++
> 2 files changed, 46 insertions(+)
> create mode 100644 Documentation/hwmon/max127.rst
>
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index 408760d13813..0a07b6000c20 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -111,6 +111,7 @@ Hardware Monitoring Kernel Drivers
> ltc4245
> ltc4260
> ltc4261
> + max127
> max16064
> max16065
> max1619
> diff --git a/Documentation/hwmon/max127.rst b/Documentation/hwmon/max127.rst
> new file mode 100644
> index ..dc192dd9c37c
> --- /dev/null
> +++ b/Documentation/hwmon/max127.rst
> @@ -0,0 +1,45 @@
> +.. SPDX-License-Identifier: GPL-2.0-or-later
> +
> +Kernel driver max127
> +
> +
> +Author:
> +
> + * Tao Ren
> +
> +Supported chips:
> +
> + * Maxim MAX127
> +
> +Prefix: 'max127'
> +
> +Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX127-MAX128.pdf
> +
> +Description
> +---
> +
> +The MAX127 is a multirange, 12-bit data acquisition system (DAS) providing
> +8 analog input channels that are independently software programmable for
> +a variety of ranges. The available ranges are {0,5V}, {0,10V}, {-5,5V}
> +and {-10,10V}.
> +
> +The MAX127 features a 2-wire, I2C-compatible serial interface that allows
> +communication among multiple devices using SDA and SCL lines.
> +
> +Sysfs interface
> +---
> +
> + ==
> ==
> + in[0-7]_input The input voltage (in mV) of the corresponding channel.
> + RO
> +
> + in[0-7]_minThe lower input limit (in mV) for the corresponding channel.
> + ADC range and LSB will be updated when the limit is changed.
> + For the MAX127, it will be adjusted to -1, -5000, or 0.
> + RW
> +
> + in[0-7]_maxThe higher input limit (in mV) for the corresponding
> channel.
> + ADC range and LSB will be updated when the limit is changed.
> + For the MAX127, it will be adjusted to 0, 5000, or 1.
> + RW
> + ==
> ==
