Commit 87ff65b5 authored by Johan Jonker's avatar Johan Jonker Committed by Rob Herring
Browse files

dt-bindings: i2c: convert rockchip i2c bindings to yaml 



Current dts files with 'i2c' nodes are manually verified.
In order to automate this process i2c-rk3x.txt
has to be converted to yaml. In the new setup
i2c-rk3x.yaml will inherit properties from
i2c-controller.yaml.

Also change document name in MAINTAINERS.

Signed-off-by: default avatarJohan Jonker <jbx6244@gmail.com>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent 905fc6b1

Documentation/devicetree/bindings/i2c/i2c-rk3x.txt

deleted100644 → 0
+0 −68
Original line number Diff line number Diff line 
* Rockchip RK3xxx I2C controller



This driver interfaces with the native I2C controller present in Rockchip

RK3xxx SoCs.



Required properties :



 - reg : Offset and length of the register set for the device

 - compatible: should be one of the following:

   - "rockchip,rv1108-i2c": for rv1108

   - "rockchip,rk3066-i2c": for rk3066

   - "rockchip,rk3188-i2c": for rk3188

   - "rockchip,rk3228-i2c": for rk3228

   - "rockchip,rk3288-i2c": for rk3288

   - "rockchip,rk3328-i2c", "rockchip,rk3399-i2c": for rk3328

   - "rockchip,rk3399-i2c": for rk3399

 - interrupts : interrupt number

 - clocks: See ../clock/clock-bindings.txt

   - For older hardware (rk3066, rk3188, rk3228, rk3288):

     - There is one clock that's used both to derive the functional clock

       for the device and as the bus clock.

   - For newer hardware (rk3399): specified by name

     - "i2c": This is used to derive the functional clock.

     - "pclk": This is the bus clock.



Required on RK3066, RK3188 :



 - rockchip,grf : the phandle of the syscon node for the general register

		  file (GRF)

 - on those SoCs an alias with the correct I2C bus ID (bit offset in the GRF)

   is also required.



Optional properties :



 - clock-frequency : SCL frequency to use (in Hz). If omitted, 100kHz is used.

 - i2c-scl-rising-time-ns : Number of nanoseconds the SCL signal takes to rise

	(t(r) in I2C specification). If not specified this is assumed to be

	the maximum the specification allows(1000 ns for Standard-mode,

	300 ns for Fast-mode) which might cause slightly slower communication.

 - i2c-scl-falling-time-ns : Number of nanoseconds the SCL signal takes to fall

	(t(f) in the I2C specification). If not specified this is assumed to

	be the maximum the specification allows (300 ns) which might cause

	slightly slower communication.

 - i2c-sda-falling-time-ns : Number of nanoseconds the SDA signal takes to fall

	(t(f) in the I2C specification). If not specified we'll use the SCL

	value since they are the same in nearly all cases.



Example:



aliases {

	i2c0 = &i2c0;

}



i2c0: i2c@2002d000 {

	compatible = "rockchip,rk3188-i2c";

	reg = <0x2002d000 0x1000>;

	interrupts = <GIC_SPI 40 IRQ_TYPE_LEVEL_HIGH>;

	#address-cells = <1>;

	#size-cells = <0>;



	rockchip,grf = <&grf>;



	clock-names = "i2c";

	clocks = <&cru PCLK_I2C0>;



	i2c-scl-rising-time-ns = <800>;

	i2c-scl-falling-time-ns = <100>;

};

Documentation/devicetree/bindings/i2c/i2c-rk3x.yaml

0 → 100644
+129 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/i2c/i2c-rk3x.yaml#

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



title: Rockchip RK3xxx I2C controller



description:

  This driver interfaces with the native I2C controller present in Rockchip

  RK3xxx SoCs.



allOf:

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



maintainers:

  - Heiko Stuebner <heiko@sntech.de>



# Everything else is described in the common file

properties:

  compatible:

    oneOf:

      - const: rockchip,rv1108-i2c

      - const: rockchip,rk3066-i2c

      - const: rockchip,rk3188-i2c

      - const: rockchip,rk3228-i2c

      - const: rockchip,rk3288-i2c

      - const: rockchip,rk3399-i2c

      - items:

          - enum:

            - rockchip,rk3328-i2c

          - const: rockchip,rk3399-i2c



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1



  clocks:

    minItems: 1

    items:

      - description:

          For older hardware (rk3066, rk3188, rk3228, rk3288)

          there is one clock that is used both to derive the functional clock

          for the device and as the bus clock.

          For newer hardware (rk3399) this clock is used to derive

          the functional clock

      - description:

          For newer hardware (rk3399) this is the bus clock



  clock-names:

    minItems: 1

    items:

      - const: i2c

      - const: pclk



  rockchip,grf:

    $ref: /schemas/types.yaml#/definitions/phandle

    description:

      Required on RK3066, RK3188 the phandle of the syscon node for

      the general register file (GRF)

      On those SoCs an alias with the correct I2C bus ID

      (bit offset in the GRF) is also required.



  clock-frequency:

    default: 100000

    description:

      SCL frequency to use (in Hz). If omitted, 100kHz is used.



  i2c-scl-rising-time-ns:

    default: 1000

    description:

      Number of nanoseconds the SCL signal takes to rise

      (t(r) in I2C specification). If not specified this is assumed to be

      the maximum the specification allows(1000 ns for Standard-mode,

      300 ns for Fast-mode) which might cause slightly slower communication.



  i2c-scl-falling-time-ns:

    default: 300

    description:

      Number of nanoseconds the SCL signal takes to fall

      (t(f) in the I2C specification). If not specified this is assumed to

      be the maximum the specification allows (300 ns) which might cause

      slightly slower communication.



  i2c-sda-falling-time-ns:

    default: 300

    description:

      Number of nanoseconds the SDA signal takes to fall

      (t(f) in the I2C specification). If not specified we will use the SCL

      value since they are the same in nearly all cases.



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - clock-names



if:

  properties:

    compatible:

      contains:

        enum:

          - rockchip,rk3066-i2c

          - rockchip,rk3188-i2c



then:

  required:

    - rockchip,grf



examples:

  - |

    #include <dt-bindings/clock/rk3188-cru-common.h>

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

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

    i2c0: i2c@2002d000 {

      compatible = "rockchip,rk3188-i2c";

      reg = <0x2002d000 0x1000>;

      interrupts = <GIC_SPI 40 IRQ_TYPE_LEVEL_HIGH>;

      clocks = <&cru PCLK_I2C0>;

      clock-names = "i2c";

      rockchip,grf = <&grf>;

      i2c-scl-falling-time-ns = <100>;

      i2c-scl-rising-time-ns = <800>;

      #address-cells = <1>;

      #size-cells = <0>;

    };

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -2274,7 +2274,7 @@ L: linux-arm-kernel@lists.infradead.org (moderated for non-subscribers) 
L:	linux-rockchip@lists.infradead.org

T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mmind/linux-rockchip.git

S:	Maintained

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

F:	Documentation/devicetree/bindings/i2c/i2c-rk3x.yaml

F:	Documentation/devicetree/bindings/mmc/rockchip-dw-mshc.yaml

F:	arch/arm/boot/dts/rk3*

F:	arch/arm/boot/dts/rv1108*