[PATCH v3 2/2] NFC: pn544_i2c: Add DTS Documentation

[PATCH v3 2/2] NFC: pn544_i2c: Add DTS Documentation

[Clement Perrochaud]

Describe the properties used by the PN544 NFC controller driver.

Signed-off-by: Clément Perrochaud <clement.perrochaud-3arQi8VN3Tc@public.gmane.org>
---
 .../devicetree/bindings/net/nfc/pn544.txt          | 32 ++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/nfc/pn544.txt

diff --git a/Documentation/devicetree/bindings/net/nfc/pn544.txt b/Documentation/devicetree/bindings/net/nfc/pn544.txt
new file mode 100644
index 0000000..2017ad5
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/nfc/pn544.txt
@@ -0,0 +1,32 @@
+* NXP Semiconductors PN544 NFC Controller
+
+Required properties:
+- compatible: Should be "nxp,pn544_i2c".
+- clock-frequency: I²C work frequency.
+- reg: address on the bus
+- irq: Input GPIO pin used for interrupt requests from the controller
+- en: Output GPIO pin used for enabling/disabling the PN544
+- fw:Output GPIO pin used to enter firmware download mode
+
+Optional SoC Specific Properties:
+- pinctrl-names: Contains only one value - "default".
+- pintctrl-0: Specifies the pin control groups used for this controller.
+
+Example (for ARM-based BeagleBone with PN544 on I2C2):
+
+&i2c2 {
+
+	status = "okay";
+
+    pn544: pn544@28 {
+
+        compatible = "nxp,pn544_i2c";
+
+        reg = <0x28>;
+        clock-frequency = <400000>;
+
+        irq  = <&gpio1 17 GPIO_ACTIVE_HIGH>;
+        en = <&gpio3 21 GPIO_ACTIVE_HIGH>;
+        fw = <&gpio3 19 GPIO_ACTIVE_HIGH>;
+    };
+};
-- 
1.9.0

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

Re: [PATCH v3 2/2] NFC: pn544_i2c: Add DTS Documentation

[Mark Rutland]

On Mon, Mar 31, 2014 at 01:22:24PM +0100, Clement Perrochaud wrote:
> Describe the properties used by the PN544 NFC controller driver.
> 
> Signed-off-by: Clément Perrochaud <clement.perrochaud-3arQi8VN3Tc@public.gmane.org>
> ---
>  .../devicetree/bindings/net/nfc/pn544.txt          | 32 ++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/nfc/pn544.txt
> 
> diff --git a/Documentation/devicetree/bindings/net/nfc/pn544.txt b/Documentation/devicetree/bindings/net/nfc/pn544.txt
> new file mode 100644
> index 0000000..2017ad5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/nfc/pn544.txt
> @@ -0,0 +1,32 @@
> +* NXP Semiconductors PN544 NFC Controller
> +
> +Required properties:
> +- compatible: Should be "nxp,pn544_i2c".

s/_/-/ in compatible strings and property names, please.

> +- clock-frequency: I²C work frequency.
> +- reg: address on the bus
> +- irq: Input GPIO pin used for interrupt requests from the controller

As this is an interrupt from the point of view of the device, I would
prefer this described as an interrupt (using the standard interrupts
property), with the GPIO controller described as an interrupt
controller.

> +- en: Output GPIO pin used for enabling/disabling the PN544

enable-gpios?

> +- fw:Output GPIO pin used to enter firmware download mode

firmware-gpios?

Cheers,
Mark.

> +
> +Optional SoC Specific Properties:
> +- pinctrl-names: Contains only one value - "default".
> +- pintctrl-0: Specifies the pin control groups used for this controller.
> +
> +Example (for ARM-based BeagleBone with PN544 on I2C2):
> +
> +&i2c2 {
> +
> +	status = "okay";
> +
> +    pn544: pn544@28 {
> +
> +        compatible = "nxp,pn544_i2c";
> +
> +        reg = <0x28>;
> +        clock-frequency = <400000>;
> +
> +        irq  = <&gpio1 17 GPIO_ACTIVE_HIGH>;
> +        en = <&gpio3 21 GPIO_ACTIVE_HIGH>;
> +        fw = <&gpio3 19 GPIO_ACTIVE_HIGH>;
> +    };
> +};
> -- 
> 1.9.0
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.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-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

RE: [PATCH v3 2/2] NFC: pn544_i2c: Add DTS Documentation

[Clement Perrochaud]

Mark Rutland wrote: 
> s/_/-/ in compatible strings and property names, please. 
>  [...]
> As this is an interrupt from the point of view of the device, I would
> prefer this described as an interrupt (using the standard interrupts
> property), with the GPIO controller described as an interrupt
> controller. 
>  [...]
> enable-gpios? 
>  [...]
> firmware-gpios? 

Hi Mark,

Thank you for your help.

Where can I find documentation describing these naming conventions?

Thanks in advance for your answer,

-- 
Clément Perrochaud
NXP Semiconductors

Re: [PATCH v3 2/2] NFC: pn544_i2c: Add DTS Documentation

[Mark Rutland]

On Tue, Apr 01, 2014 at 02:45:10PM +0100, Clement Perrochaud wrote:
> Mark Rutland wrote: 
> > s/_/-/ in compatible strings and property names, please. 
> >  [...]
> > As this is an interrupt from the point of view of the device, I would
> > prefer this described as an interrupt (using the standard interrupts
> > property), with the GPIO controller described as an interrupt
> > controller. 
> >  [...]
> > enable-gpios? 
> >  [...]
> > firmware-gpios? 
> 
> Hi Mark,
> 
> Thank you for your help.
> 
> Where can I find documentation describing these naming conventions?

Documentation/devicetree/bindings/gpio/gpio.txt:

	GPIO properties should be named "[<name>-]gpios".

In general, following existing style is preferred, and "enable-gpios" is
already relatively common.

We admittedly have short names like "cs-gpios", but personally I would
prefer "firmware-gpios" to "fw-gpios" for clarity.

Cheers,
Mark.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html