Re: [PATCH 2/2] docs: hwmon: Document max127 driver

2020-11-16 Thread Guenter Roeck
On Mon, Nov 16, 2020 at 05:09:44PM -0800, rentao.b...@gmail.com wrote:
> From: Tao Ren 
> 
> Add documentation for max127 hardware monitoring driver.
> 
> Signed-off-by: Tao Ren 
> ---
>  Documentation/hwmon/index.rst  |  1 +
>  Documentation/hwmon/max127.rst | 43 ++
>  2 files changed, 44 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 ..e50225a61c1a
> --- /dev/null
> +++ b/Documentation/hwmon/max127.rst
> @@ -0,0 +1,43 @@
> +.. 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 conversion value for the corresponding channel.
> +  RO
> +
> +  in[0-7]_minThe lower limit (in Volt) for the corresponding channel.
> +  For the MAX127, it will be adjusted to -10, -5, or 0.
> +  RW
> +
> +  in[0-7]_maxThe higher limit (in Volt) for the corresponding channel.
> +  For the MAX127, it will be adjusted to 0, 5, or 10.
> +  RW

This should explain that the limits set the ADC range.

> +  == 
> ==
> -- 
> 2.17.1
> 


[PATCH 2/2] docs: hwmon: Document max127 driver

2020-11-16 Thread rentao . bupt
From: Tao Ren 

Add documentation for max127 hardware monitoring driver.

Signed-off-by: Tao Ren 
---
 Documentation/hwmon/index.rst  |  1 +
 Documentation/hwmon/max127.rst | 43 ++
 2 files changed, 44 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 ..e50225a61c1a
--- /dev/null
+++ b/Documentation/hwmon/max127.rst
@@ -0,0 +1,43 @@
+.. 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 conversion value for the corresponding channel.
+RO
+
+  in[0-7]_minThe lower limit (in Volt) for the corresponding channel.
+For the MAX127, it will be adjusted to -10, -5, or 0.
+RW
+
+  in[0-7]_maxThe higher limit (in Volt) for the corresponding channel.
+For the MAX127, it will be adjusted to 0, 5, or 10.
+RW
+  == ==
-- 
2.17.1