[PATCH v2] hwmon: (ads1015) Add devicetree documentation

[PATCH v2] hwmon: (ads1015) Add devicetree documentation

[Dirk Eibach]

Signed-off-by: Dirk Eibach <eibach@gdsys.de>
---
Changes since v1:
- removed sysfs from description
- explain channels 

 Documentation/devicetree/bindings/i2c/ads1015.txt |   29 +++++++++++++++++++++
 1 files changed, 29 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/i2c/ads1015.txt

diff --git a/Documentation/devicetree/bindings/i2c/ads1015.txt b/Documentation/devicetree/bindings/i2c/ads1015.txt
new file mode 100644
index 0000000..0f30616
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/ads1015.txt
@@ -0,0 +1,29 @@
+ADS1015 (I2C)
+
+This device is a 12-bit A-D converter with 4 inputs.
+
+The inputs can be used single ended or in certain differential combinations.
+
+For configuration all possible combinations are mapped to 8 channels:
+0: Voltage over AIN0 and AIN1.
+1: Voltage over AIN0 and AIN3.
+2: Voltage over AIN1 and AIN3.
+3: Voltage over AIN2 and AIN3.
+4: Voltage over AIN0 and GND.
+5: Voltage over AIN1 and GND.
+6: Voltage over AIN2 and GND.
+7: Voltage over AIN3 and GND.
+
+Optional properties:
+
+ - exported-channels : exported_channels is a bitmask that specifies which
+		       channels should be accessable by the user.
+
+Example:
+ads1015@49 {
+	compatible = "ti,ads1015";
+	reg = <0x49>;
+	exported-channels = <0x14>;
+};
+
+In this example only channel 2 and 4 would be accessable by the user.
-- 
1.5.6.5

Re: [PATCH v2] hwmon: (ads1015) Add devicetree documentation

[Jean Delvare]

On Thu,  3 Mar 2011 13:19:17 +0100, Dirk Eibach wrote:
> Signed-off-by: Dirk Eibach <eibach-dJ+jgKLZIg4@public.gmane.org>
> ---
> Changes since v1:
> - removed sysfs from description
> - explain channels 
> 
>  Documentation/devicetree/bindings/i2c/ads1015.txt |   29 +++++++++++++++++++++
>  1 files changed, 29 insertions(+), 0 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/i2c/ads1015.txt
> 
> diff --git a/Documentation/devicetree/bindings/i2c/ads1015.txt b/Documentation/devicetree/bindings/i2c/ads1015.txt
> new file mode 100644
> index 0000000..0f30616
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/ads1015.txt
> @@ -0,0 +1,29 @@
> +ADS1015 (I2C)
> +
> +This device is a 12-bit A-D converter with 4 inputs.
> +
> +The inputs can be used single ended or in certain differential combinations.
> +
> +For configuration all possible combinations are mapped to 8 channels:
> +0: Voltage over AIN0 and AIN1.
> +1: Voltage over AIN0 and AIN3.
> +2: Voltage over AIN1 and AIN3.
> +3: Voltage over AIN2 and AIN3.
> +4: Voltage over AIN0 and GND.
> +5: Voltage over AIN1 and GND.
> +6: Voltage over AIN2 and GND.
> +7: Voltage over AIN3 and GND.
> +
> +Optional properties:
> +
> + - exported-channels : exported_channels is a bitmask that specifies which
> +		       channels should be accessable by the user.

"accessable" doesn't exist as an English word.

> +
> +Example:
> +ads1015@49 {
> +	compatible = "ti,ads1015";
> +	reg = <0x49>;
> +	exported-channels = <0x14>;
> +};
> +
> +In this example only channel 2 and 4 would be accessable by the user.

Ditto.

-- 
Jean Delvare

Re: [PATCH v2] hwmon: (ads1015) Add devicetree documentation

[Grant Likely]

On Thu, Mar 03, 2011 at 01:19:17PM +0100, Dirk Eibach wrote:
> Signed-off-by: Dirk Eibach <eibach-dJ+jgKLZIg4@public.gmane.org>
> ---
> Changes since v1:
> - removed sysfs from description
> - explain channels 
> 
>  Documentation/devicetree/bindings/i2c/ads1015.txt |   29 +++++++++++++++++++++
>  1 files changed, 29 insertions(+), 0 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/i2c/ads1015.txt
> 
> diff --git a/Documentation/devicetree/bindings/i2c/ads1015.txt b/Documentation/devicetree/bindings/i2c/ads1015.txt
> new file mode 100644
> index 0000000..0f30616
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/ads1015.txt

While this device is on an i2c bus, it is a hwmon device.  Similar to
hwmon drivers, the documentation makes more sense in
Documentation/devicetree/bindings/hwmon/ti-ads1015.txt

> @@ -0,0 +1,29 @@
> +ADS1015 (I2C)
> +
> +This device is a 12-bit A-D converter with 4 inputs.
> +
> +The inputs can be used single ended or in certain differential combinations.
> +
> +For configuration all possible combinations are mapped to 8 channels:
> +0: Voltage over AIN0 and AIN1.
> +1: Voltage over AIN0 and AIN3.
> +2: Voltage over AIN1 and AIN3.
> +3: Voltage over AIN2 and AIN3.
> +4: Voltage over AIN0 and GND.
> +5: Voltage over AIN1 and GND.
> +6: Voltage over AIN2 and GND.
> +7: Voltage over AIN3 and GND.
> +

Required properties:
 - compatible : must be "ti,ads1015"

> +Optional properties:
> +
> + - exported-channels : exported_channels is a bitmask that specifies which
> +		       channels should be accessable by the user.
> +
> +Example:
> +ads1015@49 {
> +	compatible = "ti,ads1015";
> +	reg = <0x49>;
> +	exported-channels = <0x14>;
> +};
> +
> +In this example only channel 2 and 4 would be accessable by the user.
> -- 
> 1.5.6.5
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at  http://www.tux.org/lkml/