linux-kernel - [PATCH v9 2/7] nfc: pn532: Add uart phy docs and rename it

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20191008140544.17112-3-poeschel@lemonage.de>
Date:   Tue,  8 Oct 2019 16:05:39 +0200
From:   Lars Poeschel <poeschel@...onage.de>
To:     "David S. Miller" <davem@...emloft.net>,
        Rob Herring <robh+dt@...nel.org>,
        Mark Rutland <mark.rutland@....com>,
        Lars Poeschel <poeschel@...onage.de>,
        netdev@...r.kernel.org (open list:NFC SUBSYSTEM),
        devicetree@...r.kernel.org (open list:OPEN FIRMWARE AND FLATTENED
        DEVICE TREE BINDINGS), linux-kernel@...r.kernel.org (open list)
Cc:     Johan Hovold <johan@...nel.org>, Simon Horman <horms@...ge.net.au>
Subject: [PATCH v9 2/7] nfc: pn532: Add uart phy docs and rename it

This adds documentation about the uart phy to the pn532 binding doc. As
the filename "pn533-i2c.txt" is not appropriate any more, rename it to
the more general "pn532.txt".
This also documents the deprecation of the compatible strings ending
with "...-i2c".

Cc: Johan Hovold <johan@...nel.org>
Cc: Simon Horman <horms@...ge.net.au>
Signed-off-by: Lars Poeschel <poeschel@...onage.de>
---
Changes in v9:
- Rebased the patch series on v5.4-rc2
- Produce patch with -M4 to git format-patch to detect the rename
- Change DT node name from pn532@24 to nfc@24 in example

Changes in v8:
- Update existing binding doc instead of adding a new one:
  - Add uart phy example
  - Add general "pn532" compatible string
  - Deprecate "...-i2c" compatible strings
  - Rename file to a more general filename
- Intentionally drop Rob's Reviewed-By as I guess this rather big change
  requires a new review

Changes in v7:
- Accidentally lost Rob's Reviewed-By

Changes in v6:
- Rebased the patch series on v5.3-rc5
- Picked up Rob's Reviewed-By

Changes in v4:
- Add documentation about reg property in case of i2c

Changes in v3:
- seperate binding doc instead of entry in trivial-devices.txt

 .../net/nfc/{pn533-i2c.txt => pn532.txt}      | 25 ++++++++++++++++---
 1 file changed, 21 insertions(+), 4 deletions(-)
 rename Documentation/devicetree/bindings/net/nfc/{pn533-i2c.txt => pn532.txt} (42%)

diff --git a/Documentation/devicetree/bindings/net/nfc/pn533-i2c.txt b/Documentation/devicetree/bindings/net/nfc/pn532.txt
similarity index 42%
rename from Documentation/devicetree/bindings/net/nfc/pn533-i2c.txt
rename to Documentation/devicetree/bindings/net/nfc/pn532.txt
index 2efe3886b95b..a5507dc499bc 100644
--- a/Documentation/devicetree/bindings/net/nfc/pn533-i2c.txt
+++ b/Documentation/devicetree/bindings/net/nfc/pn532.txt
@@ -1,9 +1,16 @@
 * NXP Semiconductors PN532 NFC Controller
 
 Required properties:
-- compatible: Should be "nxp,pn532-i2c" or "nxp,pn533-i2c".
+- compatible: Should be
+    - "nxp,pn532" Place a node with this inside the devicetree node of the bus
+                  where the NFC chip is connected to.
+                  Currently the kernel has phy bindings for uart and i2c.
+    - "nxp,pn532-i2c" (DEPRECATED) only works for the i2c binding.
+    - "nxp,pn533-i2c" (DEPRECATED) only works for the i2c binding.
+
+Required properties if connected on i2c:
 - clock-frequency: I²C work frequency.
-- reg: address on the bus
+- reg: for the I²C bus address. This is fixed at 0x24 for the PN532.
 - interrupts: GPIO interrupt to which the chip is connected
 
 Optional SoC Specific Properties:
@@ -15,9 +22,9 @@ Example (for ARM-based BeagleBone with PN532 on I2C2):
 &i2c2 {
 
 
-	pn532: pn532@24 {
+	pn532: nfc@24 {
 
-		compatible = "nxp,pn532-i2c";
+		compatible = "nxp,pn532";
 
 		reg = <0x24>;
 		clock-frequency = <400000>;
@@ -27,3 +34,13 @@ Example (for ARM-based BeagleBone with PN532 on I2C2):
 
 	};
 };
+
+Example (for PN532 connected via uart):
+
+uart4: serial@...42000 {
+        compatible = "ti,omap3-uart";
+
+        pn532: nfc {
+                compatible = "nxp,pn532";
+        };
+};
-- 
2.23.0