Re: [PATCH 09/11] staging: iio: ad7746: Add devicetree bindings documentation

[Jonathan Cameron]

On Wed, 21 Mar 2018 11:28:57 -0300
Hernán Gonzalez <hernan@xxxxxxxxxxxxxxxxxxxx> wrote:

> Signed-off-by: Hernán Gonzalez <hernan@xxxxxxxxxxxxxxxxxxxx>
Device tree bindings must be cc'd to the device tree binding maintainers
and the devicetree binding list.

Comments inline but don't forget to cc them on v2.

Jonathan

> ---
>  .../devicetree/bindings/staging/iio/cdc/ad7746.txt | 32 ++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/staging/iio/cdc/ad7746.txt
> 
> diff --git a/Documentation/devicetree/bindings/staging/iio/cdc/ad7746.txt b/Documentation/devicetree/bindings/staging/iio/cdc/ad7746.txt
> new file mode 100644
> index 0000000..13d0056
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/staging/iio/cdc/ad7746.txt
> @@ -0,0 +1,32 @@
> +Analog Devices AD7746/5/7 capacitive sensor driver
> +
> +Required properties:
> +	- compatible: Should be one of
> +		* "adi,ad7745": When using the AD7745 device
> +		* "adi,ad7746": When using the AD7746 device
> +		* "adi,ad7747": When using the AD7747 device
The when using bit is kind of obvious.  Probably no need to state.

> +	- reg: The 7-bits long I2c address of the device
> +
> +Optional properties:
> +	- adi,exclvl: 0 = +-VDD/8
> +                1 = +-VDD/4
> +                2 = +-VDD * 3/8
> +                3 = +-VDD/2 (Default)
That needs a comment to explain what exactly it is rather than
just documenting the enum values.

> +	- adi,nexca_en: Invert excitation output A.
> +	- adi,nexcb_en:	Invert excitation output B.
> +
> +Example:
> +Here exclvl would be 1 (VDD/4), Excitation pin A would be inverted and
> +Excitation pin B would NOT be inverted.
> +
> +i2c2 {
> +
> +      < . . . >
> +
> +      ad7746: ad7746@60 {
> +              compatible = "ad7746";
> +              reg = <0x60>;
> +              adi,exclvl = <1>;
> +              adi,nexca_en;
> +      };
> +};