dt-bindings: i2c: cadence: Migrate i2c-cadence documentation to YAML

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: "http://devicetree.org/schemas/i2c/cdns,i2c-r1p10.yaml#"

$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: Cadence I2C controller Device Tree Bindings

maintainers:

  - Michal Simek <michal.simek@xilinx.com>

allOf:

  - $ref: /schemas/i2c/i2c-controller.yaml#

properties:

  compatible:

    enum:

      - cdns,i2c-r1p10 # cadence i2c controller version 1.0

      - cdns,i2c-r1p14 # cadence i2c controller version 1.4

  reg:

    maxItems: 1

  clocks:

    minItems: 1

  interrupts:

    maxItems: 1

  clock-frequency:

    minimum: 1

    maximum: 400000

    description: |

      Desired operating frequency, in Hz, of the bus.

  clock-name:

    const: pclk

    description: |

      Input clock name.

required:

  - compatible

  - reg

  - clocks

  - interrupts

examples:

  - |

    #include <dt-bindings/interrupt-controller/arm-gic.h>

    i2c@e0004000 {

        compatible = "cdns,i2c-r1p10";

        clocks = <&clkc 38>;

        interrupts = <GIC_SPI 25 IRQ_TYPE_LEVEL_HIGH>;

        reg = <0xe0004000 0x1000>;

        clock-frequency = <400000>;

        #address-cells = <1>;

        #size-cells = <0>;

    };

Binding for the Cadence I2C controller

Required properties:

  - reg: Physical base address and size of the controller's register area.

  - compatible: Should contain one of:

		* "cdns,i2c-r1p10"

		Note:	Use this when cadence i2c controller version 1.0 is used.

		* "cdns,i2c-r1p14"

		Note:	Use this when cadence i2c controller version 1.4 is used.

  - clocks: Input clock specifier. Refer to common clock bindings.

  - interrupts: Interrupt specifier. Refer to interrupt bindings.

  - #address-cells: Should be 1.

  - #size-cells: Should be 0.

Optional properties:

  - clock-frequency: Desired operating frequency, in Hz, of the bus.

  - clock-names: Input clock name, should be 'pclk'.

Example:

	i2c@e0004000 {

		compatible = "cdns,i2c-r1p10";

		clocks = <&clkc 38>;

		interrupts = <GIC_SPI 25 IRQ_TYPE_LEVEL_HIGH>;

		reg = <0xe0004000 0x1000>;

		clock-frequency = <400000>;

		#address-cells = <1>;

		#size-cells = <0>;

	};

S:	Supported

W:	http://wiki.xilinx.com

T:	git https://github.com/Xilinx/linux-xlnx.git

F:	Documentation/devicetree/bindings/i2c/i2c-cadence.txt

F:	Documentation/devicetree/bindings/i2c/cdns,i2c-r1p10.yaml

F:	Documentation/devicetree/bindings/i2c/i2c-xiic.txt

F:	arch/arm/mach-zynq/

F:	drivers/block/xsysace.c