Add device tree binding documentation for the AMD I3C master controller.
The controller is represented by the compatible string "xlnx,axi-i3c-1.0".
The binding specifies required properties including register space, clock,
resets, interrupts, and provides an example usage.
Signed-off-by: Manikanta Guntupalli <manikanta.guntupalli@amd.com>
---
Changes for V2:
Updated commit subject and description.
Moved allOf to after required.
Removed xlnx,num-targets property.
---
.../devicetree/bindings/i3c/xlnx,axi-i3c.yaml | 53 +++++++++++++++++++
1 file changed, 53 insertions(+)
create mode 100644 Documentation/devicetree/bindings/i3c/xlnx,axi-i3c.yaml
diff --git a/Documentation/devicetree/bindings/i3c/xlnx,axi-i3c.yaml b/Documentation/devicetree/bindings/i3c/xlnx,axi-i3c.yaml
new file mode 100644
index 000000000000..48be3c53c1be
--- /dev/null
+++ b/Documentation/devicetree/bindings/i3c/xlnx,axi-i3c.yaml
@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i3c/xlnx,axi-i3c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AMD I3C master
+
+maintainers:
+ - Manikanta Guntupalli <manikanta.guntupalli@amd.com>
+
+description:
+ The AXI-I3C IP is an I3C Controller with an AXI4-Lite interface, compatible
+ with the MIPI I3C Specification v1.1.1. The design includes bidirectional I/O
+ buffers that implement open collector drivers for the SDA and SCL signals.
+ External pull-up resistors are required to properly hold the bus at a Logic-1
+ level when the drivers are released.
+
+properties:
+ compatible:
+ const: xlnx,axi-i3c-1.0
+
+ resets:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ maxItems: 1
+
+required:
+ - reg
+ - clocks
+
+allOf:
+ - $ref: i3c.yaml#
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ i3c@80000000 {
+ compatible = "xlnx,axi-i3c-1.0";
+ reg = <0x80000000 0x10000>;
+ clocks = <&zynqmp_clk 71>;
+ #address-cells = <3>;
+ #size-cells = <0>;
+ };
+...
--
2.34.1
On Fri, Aug 29, 2025 at 10:43:26PM +0530, Manikanta Guntupalli wrote: > Add device tree binding documentation for the AMD I3C master controller. > > The controller is represented by the compatible string "xlnx,axi-i3c-1.0". > The binding specifies required properties including register space, clock, > resets, interrupts, and provides an example usage. These two are completely redundant and useless sentences. Binding cannot specify anything else. Instead describe the hardware. Your previous patches for bindings also had completely redundant commit msg. You need to write WHY you are doing changes or describe the hardware. Repeating the code is pointless, we can read the code. Best regards, Krzysztof
On Fri, Aug 29, 2025 at 10:43:26PM +0530, Manikanta Guntupalli wrote: > Add device tree binding documentation for the AMD I3C master controller. > > The controller is represented by the compatible string "xlnx,axi-i3c-1.0". > The binding specifies required properties including register space, clock, > resets, interrupts, and provides an example usage. > > Signed-off-by: Manikanta Guntupalli <manikanta.guntupalli@amd.com> > --- > Changes for V2: > Updated commit subject and description. > Moved allOf to after required. > Removed xlnx,num-targets property. > --- > .../devicetree/bindings/i3c/xlnx,axi-i3c.yaml | 53 +++++++++++++++++++ > 1 file changed, 53 insertions(+) > create mode 100644 Documentation/devicetree/bindings/i3c/xlnx,axi-i3c.yaml > > diff --git a/Documentation/devicetree/bindings/i3c/xlnx,axi-i3c.yaml b/Documentation/devicetree/bindings/i3c/xlnx,axi-i3c.yaml > new file mode 100644 > index 000000000000..48be3c53c1be > --- /dev/null > +++ b/Documentation/devicetree/bindings/i3c/xlnx,axi-i3c.yaml > @@ -0,0 +1,53 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/i3c/xlnx,axi-i3c.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: AMD I3C master > + > +maintainers: > + - Manikanta Guntupalli <manikanta.guntupalli@amd.com> > + > +description: > + The AXI-I3C IP is an I3C Controller with an AXI4-Lite interface, compatible > + with the MIPI I3C Specification v1.1.1. The design includes bidirectional I/O > + buffers that implement open collector drivers for the SDA and SCL signals. > + External pull-up resistors are required to properly hold the bus at a Logic-1 > + level when the drivers are released. > + > +properties: > + compatible: > + const: xlnx,axi-i3c-1.0 > + > + resets: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + reg: > + maxItems: 1 Reg is the second property. Rest should go alphabetically. > + > + clocks: > + maxItems: 1 > + > +required: By convention, also compatible. > + - reg > + - clocks > + > +allOf: > + - $ref: i3c.yaml# > + > +unevaluatedProperties: false > + > +examples: > + - | > + i3c@80000000 { > + compatible = "xlnx,axi-i3c-1.0"; > + reg = <0x80000000 0x10000>; > + clocks = <&zynqmp_clk 71>; Make the example complete - missing resets and interrupts. Best regards, Krzysztof
© 2016 - 2025 Red Hat, Inc.