Commit 118a209d authored by Paul Cercueil's avatar Paul Cercueil Committed by Rob Herring
Browse files

dt-bindings: i2c: Convert i2c-jz4780.txt to YAML



Convert the i2c-jz4780.txt file to ingenic,i2c.yaml.

Two things were changed in the process:
- the clock-frequency property can now only be set to the two values
  that can be set by the hardware;
- the dmas and dma-names properties are now required.

Signed-off-by: default avatarPaul Cercueil <paul@crapouillou.net>
[robh: add ref to i2c-controller.yaml]
Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent 6e172df7
Loading
Loading
Loading
Loading
+0 −33
Original line number Diff line number Diff line
* Ingenic JZ4780 I2C Bus controller

Required properties:
- compatible: should be one of the following:
  - "ingenic,jz4780-i2c" for the JZ4780
  - "ingenic,x1000-i2c" for the X1000
- reg: Should contain the address & size of the I2C controller registers.
- interrupts: Should specify the interrupt provided by parent.
- clocks: Should contain a single clock specifier for the JZ4780 I2C clock.
- clock-frequency: desired I2C bus clock frequency in Hz.

Recommended properties:
- pinctrl-names: should be "default";
- pinctrl-0: phandle to pinctrl function

Example

/ {
	i2c4: i2c4@10054000 {
		compatible = "ingenic,jz4780-i2c";
		reg = <0x10054000 0x1000>;

		interrupt-parent = <&intc>;
		interrupts = <56>;

		clocks = <&cgu JZ4780_CLK_SMB4>;
		clock-frequency = <100000>;
		pinctrl-names = "default";
		pinctrl-0 = <&pins_i2c4_data>;

	};
};
+88 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/i2c/ingenic,i2c.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Ingenic SoCs I2C controller devicetree bindings

maintainers:
  - Paul Cercueil <paul@crapouillou.net>

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

properties:
  $nodename:
    pattern: "^i2c@[0-9a-f]+$"

  compatible:
    enum:
      - ingenic,jz4780-i2c
      - ingenic,x1000-i2c

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 1

  clock-frequency:
    enum: [ 100000, 400000 ]

  dmas:
    items:
      - description: DMA controller phandle and request line for RX
      - description: DMA controller phandle and request line for TX

  dma-names:
    items:
      - const: rx
      - const: tx

required:
  - compatible
  - reg
  - interrupts
  - clocks
  - clock-frequency
  - dmas
  - dma-names

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/clock/jz4780-cgu.h>
    #include <dt-bindings/dma/jz4780-dma.h>
    #include <dt-bindings/interrupt-controller/irq.h>
    i2c@10054000 {
      compatible = "ingenic,jz4780-i2c";
      #address-cells = <1>;
      #size-cells = <0>;
      reg = <0x10054000 0x1000>;

      interrupt-parent = <&intc>;
      interrupts = <56>;

      clocks = <&cgu JZ4780_CLK_SMB4>;
      pinctrl-names = "default";
      pinctrl-0 = <&pins_i2c4_data>;

      dmas = <&dma JZ4780_DMA_SMB4_RX 0xffffffff>,
             <&dma JZ4780_DMA_SMB4_TX 0xffffffff>;
      dma-names = "rx", "tx";

      clock-frequency = <400000>;

      rtc@51 {
        compatible = "nxp,pcf8563";
        reg = <0x51>;

        interrupt-parent = <&gpf>;
        interrupts = <30 IRQ_TYPE_LEVEL_LOW>;
      };
    };