diff mbox

[v8,1/2] iio:as3935: Add DT binding docs for AS3935 driver

Message ID 1394628794-7598-2-git-send-email-mranostay@gmail.com
State Superseded, archived
Headers show

Commit Message

Matt Ranostay March 12, 2014, 12:53 p.m. UTC
Document compatible string, required and optional DT properties for
AS3935 chipset driver.

Signed-off-by: Matt Ranostay <mranostay@gmail.com>
---
 .../devicetree/bindings/iio/proximity/as3935.txt   | 28 ++++++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.txt        |  1 +
 2 files changed, 29 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/proximity/as3935.txt

Comments

Rob Herring March 12, 2014, 2:30 p.m. UTC | #1
On Wed, Mar 12, 2014 at 7:53 AM, Matt Ranostay <mranostay@gmail.com> wrote:
> Document compatible string, required and optional DT properties for
> AS3935 chipset driver.
>
> Signed-off-by: Matt Ranostay <mranostay@gmail.com>

Acked-by: Rob Herring <robh@kernel.org>

> ---
>  .../devicetree/bindings/iio/proximity/as3935.txt   | 28 ++++++++++++++++++++++
>  .../devicetree/bindings/vendor-prefixes.txt        |  1 +
>  2 files changed, 29 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/proximity/as3935.txt
>
> diff --git a/Documentation/devicetree/bindings/iio/proximity/as3935.txt b/Documentation/devicetree/bindings/iio/proximity/as3935.txt
> new file mode 100644
> index 0000000..ae23dd8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/proximity/as3935.txt
> @@ -0,0 +1,28 @@
> +Austrian Microsystems AS3935 Franklin lightning sensor device driver
> +
> +Required properties:
> +       - compatible: must be "ams,as3935"
> +       - reg: SPI chip select number for the device
> +       - spi-cpha: SPI Mode 1. Refer to spi/spi-bus.txt for generic SPI
> +       slave node bindings.
> +       - interrupt-parent : should be the phandle for the interrupt controller
> +       - interrupts : the sole interrupt generated by the device
> +
> +       Refer to interrupt-controller/interrupts.txt for generic
> +       interrupt client node bindings.
> +
> +Optional properties:
> +       - ams,tuning-capacitor-pf: Calibration tuning capacitor stepping
> +         value 0 - 120pF. This will require using the calibration data from
> +         the manufacturer.
> +
> +Example:
> +
> +as3935@0 {
> +       compatible = "ams,as3935";
> +       reg = <0>;
> +       spi-cpha;
> +       interrupt-parent = <&gpio1>;
> +       interrupts = <16 1>;
> +       ams,tuning-capacitor-pf = <80>;
> +};
> diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
> index 4685ec3..517831d 100644
> --- a/Documentation/devicetree/bindings/vendor-prefixes.txt
> +++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
> @@ -11,6 +11,7 @@ ak    Asahi Kasei Corp.
>  allwinner      Allwinner Technology Co., Ltd.
>  altr   Altera Corp.
>  amcc   Applied Micro Circuits Corporation (APM, formally AMCC)
> +ams    AMS AG
>  amstaos        AMS-Taos Inc.
>  apm    Applied Micro Circuits Corporation (APM)
>  arm    ARM Ltd.
> --
> 1.8.3.2
>
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jonathan Cameron March 15, 2014, 2:58 p.m. UTC | #2
On 12/03/14 14:30, Rob Herring wrote:
> On Wed, Mar 12, 2014 at 7:53 AM, Matt Ranostay <mranostay@gmail.com> wrote:
>> Document compatible string, required and optional DT properties for
>> AS3935 chipset driver.
>>
>> Signed-off-by: Matt Ranostay <mranostay@gmail.com>
>
> Acked-by: Rob Herring <robh@kernel.org>
Applied to the togreg branch of iio.git (probably pushed out as testing
first to allow the autobuilders to play.

Thanks

Jonathan
>
>> ---
>>   .../devicetree/bindings/iio/proximity/as3935.txt   | 28 ++++++++++++++++++++++
>>   .../devicetree/bindings/vendor-prefixes.txt        |  1 +
>>   2 files changed, 29 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/iio/proximity/as3935.txt
>>
>> diff --git a/Documentation/devicetree/bindings/iio/proximity/as3935.txt b/Documentation/devicetree/bindings/iio/proximity/as3935.txt
>> new file mode 100644
>> index 0000000..ae23dd8
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/iio/proximity/as3935.txt
>> @@ -0,0 +1,28 @@
>> +Austrian Microsystems AS3935 Franklin lightning sensor device driver
>> +
>> +Required properties:
>> +       - compatible: must be "ams,as3935"
>> +       - reg: SPI chip select number for the device
>> +       - spi-cpha: SPI Mode 1. Refer to spi/spi-bus.txt for generic SPI
>> +       slave node bindings.
>> +       - interrupt-parent : should be the phandle for the interrupt controller
>> +       - interrupts : the sole interrupt generated by the device
>> +
>> +       Refer to interrupt-controller/interrupts.txt for generic
>> +       interrupt client node bindings.
>> +
>> +Optional properties:
>> +       - ams,tuning-capacitor-pf: Calibration tuning capacitor stepping
>> +         value 0 - 120pF. This will require using the calibration data from
>> +         the manufacturer.
>> +
>> +Example:
>> +
>> +as3935@0 {
>> +       compatible = "ams,as3935";
>> +       reg = <0>;
>> +       spi-cpha;
>> +       interrupt-parent = <&gpio1>;
>> +       interrupts = <16 1>;
>> +       ams,tuning-capacitor-pf = <80>;
>> +};
>> diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
>> index 4685ec3..517831d 100644
>> --- a/Documentation/devicetree/bindings/vendor-prefixes.txt
>> +++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
>> @@ -11,6 +11,7 @@ ak    Asahi Kasei Corp.
>>   allwinner      Allwinner Technology Co., Ltd.
>>   altr   Altera Corp.
>>   amcc   Applied Micro Circuits Corporation (APM, formally AMCC)
>> +ams    AMS AG
>>   amstaos        AMS-Taos Inc.
>>   apm    Applied Micro Circuits Corporation (APM)
>>   arm    ARM Ltd.
>> --
>> 1.8.3.2
>>
>> --
>> To unsubscribe from this list: send the line "unsubscribe devicetree" in
>> the body of a message to majordomo@vger.kernel.org
>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> --
> To unsubscribe from this list: send the line "unsubscribe linux-iio" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/iio/proximity/as3935.txt b/Documentation/devicetree/bindings/iio/proximity/as3935.txt
new file mode 100644
index 0000000..ae23dd8
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/proximity/as3935.txt
@@ -0,0 +1,28 @@ 
+Austrian Microsystems AS3935 Franklin lightning sensor device driver
+
+Required properties:
+	- compatible: must be "ams,as3935"
+	- reg: SPI chip select number for the device
+	- spi-cpha: SPI Mode 1. Refer to spi/spi-bus.txt for generic SPI
+	slave node bindings.
+	- interrupt-parent : should be the phandle for the interrupt controller
+	- interrupts : the sole interrupt generated by the device
+
+	Refer to interrupt-controller/interrupts.txt for generic
+	interrupt client node bindings.
+
+Optional properties:
+	- ams,tuning-capacitor-pf: Calibration tuning capacitor stepping
+	  value 0 - 120pF. This will require using the calibration data from
+	  the manufacturer.
+
+Example:
+
+as3935@0 {
+	compatible = "ams,as3935";
+	reg = <0>;
+	spi-cpha;
+	interrupt-parent = <&gpio1>;
+	interrupts = <16 1>;
+	ams,tuning-capacitor-pf = <80>;
+};
diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
index 4685ec3..517831d 100644
--- a/Documentation/devicetree/bindings/vendor-prefixes.txt
+++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
@@ -11,6 +11,7 @@  ak	Asahi Kasei Corp.
 allwinner	Allwinner Technology Co., Ltd.
 altr	Altera Corp.
 amcc	Applied Micro Circuits Corporation (APM, formally AMCC)
+ams	AMS AG
 amstaos	AMS-Taos Inc.
 apm	Applied Micro Circuits Corporation (APM)
 arm	ARM Ltd.