[v3,1/2] dt-bindings: w1: Add YAML DT schema for AMD AXI w1 host and MAINTAINERS entry

Message ID 20231107180814.615933-2-kris.chaplin@amd.com
State New
Headers
Series w1: Add AXI 1-wire host driver for AMD programmable logic IP core |

Commit Message

Kris Chaplin Nov. 7, 2023, 6:06 p.m. UTC
  Add YAML DT schema for the AMD AXI w1 host IP.

This hardware guarantees protocol timing for driving off-board devices such
as thermal sensors, proms, etc using the 1wire protocol.  The IP has a register
to detect hardware version and so the binding does not have an explict version
number.

Add MAINTAINERS entry for DT schema.

Co-developed-by: Thomas Delev <thomas.delev@amd.com>
Signed-off-by: Thomas Delev <thomas.delev@amd.com>
Signed-off-by: Kris Chaplin <kris.chaplin@amd.com>
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
---
 .../bindings/w1/amd,axi-1wire-host.yaml       | 44 +++++++++++++++++++
 MAINTAINERS                                   |  7 +++
 2 files changed, 51 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/w1/amd,axi-1wire-host.yaml
  

Comments

Rob Herring Nov. 8, 2023, 3:59 p.m. UTC | #1
On Tue, Nov 07, 2023 at 10:06:51AM -0800, Kris Chaplin wrote:
> Add YAML DT schema for the AMD AXI w1 host IP.

Sorry for not noticing earlier, but if there's another spin, drop 'YAML 
DT schema for ' from the subject. You already said that with 
'dt-bindings'.

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

> 
> This hardware guarantees protocol timing for driving off-board devices such
> as thermal sensors, proms, etc using the 1wire protocol.  The IP has a register
> to detect hardware version and so the binding does not have an explict version
> number.
> 
> Add MAINTAINERS entry for DT schema.
> 
> Co-developed-by: Thomas Delev <thomas.delev@amd.com>
> Signed-off-by: Thomas Delev <thomas.delev@amd.com>
> Signed-off-by: Kris Chaplin <kris.chaplin@amd.com>
> Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
> ---
>  .../bindings/w1/amd,axi-1wire-host.yaml       | 44 +++++++++++++++++++
>  MAINTAINERS                                   |  7 +++
>  2 files changed, 51 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/w1/amd,axi-1wire-host.yaml
  
Krzysztof Kozlowski Nov. 8, 2023, 4:20 p.m. UTC | #2
On 08/11/2023 16:59, Rob Herring wrote:
> On Tue, Nov 07, 2023 at 10:06:51AM -0800, Kris Chaplin wrote:
>> Add YAML DT schema for the AMD AXI w1 host IP.
> 
> Sorry for not noticing earlier, but if there's another spin, drop 'YAML 
> DT schema for ' from the subject. You already said that with 
> 'dt-bindings'.
> 
> Acked-by: Rob Herring <robh@kernel.org>

I can fix it while applying. No need to resend, unless there will be
more things to fix.

Anyway this waits till merge window finishes.

Best regards,
Krzysztof
  
Kris Chaplin Nov. 8, 2023, 4:37 p.m. UTC | #3
>>
>> Sorry for not noticing earlier, but if there's another spin, drop 'YAML
>> DT schema for ' from the subject. You already said that with
>> 'dt-bindings'.
>>
>> Acked-by: Rob Herring <robh@kernel.org>
> 
> I can fix it while applying. No need to resend, unless there will be
> more things to fix.

Thank you Krzysztof and Rob.  I'll amend locally and if we have any 
other fixes re-send otherwise hold off.

Regards
Kris
  

Patch

diff --git a/Documentation/devicetree/bindings/w1/amd,axi-1wire-host.yaml b/Documentation/devicetree/bindings/w1/amd,axi-1wire-host.yaml
new file mode 100644
index 000000000000..ef70fa2c0c5d
--- /dev/null
+++ b/Documentation/devicetree/bindings/w1/amd,axi-1wire-host.yaml
@@ -0,0 +1,44 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/w1/amd,axi-1wire-host.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AMD AXI 1-wire bus host for programmable logic
+
+maintainers:
+  - Kris Chaplin <kris.chaplin@amd.com>
+
+properties:
+  compatible:
+    const: amd,axi-1wire-host
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    onewire@a0000000 {
+        compatible = "amd,axi-1wire-host";
+        reg = <0xa0000000 0x10000>;
+        clocks = <&zynqmp_clk 0x47>;
+        interrupts = <GIC_SPI 0x59 IRQ_TYPE_LEVEL_HIGH>;
+    };
+
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index 375b2c87d099..2b23febfaf72 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -891,6 +891,13 @@  Q:	https://patchwork.kernel.org/project/linux-rdma/list/
 F:	drivers/infiniband/hw/efa/
 F:	include/uapi/rdma/efa-abi.h
 
+AMD AXI W1 DRIVER
+M:	Kris Chaplin <kris.chaplin@amd.com>
+R:	Thomas Delev <thomas.delev@amd.com>
+R:	Michal Simek <michal.simek@amd.com>
+S:	Maintained
+F:	Documentation/devicetree/bindings/w1/amd,axi-1wire-host.yaml
+
 AMD CDX BUS DRIVER
 M:	Nipun Gupta <nipun.gupta@amd.com>
 M:	Nikhil Agarwal <nikhil.agarwal@amd.com>