On Thu, May 20, 2021 at 01:21:02PM +0200, Fabien Parent wrote:
> Convert the binding documentation for i2c-mt65xx driver to the
> YAML schema format.
>
> Signed-off-by: Fabien Parent <fparent@xxxxxxxxxxxx>
> ---
>
> v2:
> * write compatibles in a more compact way
> * set the node pattern to be "^i2c@[0-9a-f]+$" instead of
> "^i2c[0-9]*@[0-9a-f]+"$
>
> .../devicetree/bindings/i2c/i2c-mt65xx.txt | 49 ----------
> .../devicetree/bindings/i2c/i2c-mt65xx.yaml | 93 +++++++++++++++++++
> 2 files changed, 93 insertions(+), 49 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-mt65xx.txt
> create mode 100644 Documentation/devicetree/bindings/i2c/i2c-mt65xx.yaml
>
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-mt65xx.txt b/Documentation/devicetree/bindings/i2c/i2c-mt65xx.txt
> deleted file mode 100644
> index 7f0194fdd0cc..000000000000
> --- a/Documentation/devicetree/bindings/i2c/i2c-mt65xx.txt
> +++ /dev/null
> @@ -1,49 +0,0 @@
> -* MediaTek's I2C controller
> -
> -The MediaTek's I2C controller is used to interface with I2C devices.
> -
> -Required properties:
> - - compatible: value should be either of the following.
> - "mediatek,mt2701-i2c", "mediatek,mt6577-i2c": for MediaTek MT2701
> - "mediatek,mt2712-i2c": for MediaTek MT2712
> - "mediatek,mt6577-i2c": for MediaTek MT6577
> - "mediatek,mt6589-i2c": for MediaTek MT6589
> - "mediatek,mt6797-i2c", "mediatek,mt6577-i2c": for MediaTek MT6797
> - "mediatek,mt7622-i2c": for MediaTek MT7622
> - "mediatek,mt7623-i2c", "mediatek,mt6577-i2c": for MediaTek MT7623
> - "mediatek,mt7629-i2c", "mediatek,mt2712-i2c": for MediaTek MT7629
> - "mediatek,mt8173-i2c": for MediaTek MT8173
> - "mediatek,mt8183-i2c": for MediaTek MT8183
> - "mediatek,mt8192-i2c": for MediaTek MT8192
> - "mediatek,mt8516-i2c", "mediatek,mt2712-i2c": for MediaTek MT8516
> - - reg: physical base address of the controller and dma base, length of memory
> - mapped region.
> - - interrupts: interrupt number to the cpu.
> - - clock-div: the fixed value for frequency divider of clock source in i2c
> - module. Each IC may be different.
> - - clocks: clock name from clock manager
> - - clock-names: Must include "main" and "dma", "arb" is for multi-master that
> - one bus has more than two i2c controllers, if enable have-pmic need include
> - "pmic" extra.
> -
> -Optional properties:
> - - clock-frequency: Frequency in Hz of the bus when transfer, the default value
> - is 100000.
> - - mediatek,have-pmic: platform can control i2c form special pmic side.
> - Only mt6589 and mt8135 support this feature.
> - - mediatek,use-push-pull: IO config use push-pull mode.
> -
> -Example:
> -
> - i2c0: i2c@1100d000 {
> - compatible = "mediatek,mt6577-i2c";
> - reg = <0x1100d000 0x70>,
> - <0x11000300 0x80>;
> - interrupts = <GIC_SPI 44 IRQ_TYPE_LEVEL_LOW>;
> - clock-frequency = <400000>;
> - mediatek,have-pmic;
> - clock-div = <16>;
> - clocks = <&i2c0_ck>, <&ap_dma_ck>;
> - clock-names = "main", "dma";
> - };
> -
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-mt65xx.yaml b/Documentation/devicetree/bindings/i2c/i2c-mt65xx.yaml
> new file mode 100644
> index 000000000000..41cedb4930de
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/i2c-mt65xx.yaml
> @@ -0,0 +1,93 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/i2c/i2c-mt65xx.yaml#";
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#";
> +
> +title: MediaTek I2C Controller
> +
> +maintainers:
> + - Qii Wang <qii.wang@xxxxxxxxxxxx>
> + - Matthias Brugger <matthias.bgg@xxxxxxxxx>
> +
> +allOf:
> + - $ref: /schemas/i2c/i2c-controller.yaml#
> +
> +properties:
> + $nodename:
> + pattern: "^i2c@[0-9a-f]+$"
> +
> + compatible:
> + oneOf:
> + - enum:
> + - mediatek,mt2712-i2c
> + - mediatek,mt6577-i2c
> + - mediatek,mt6589-i2c
> + - mediatek,mt7622-i2c
> + - mediatek,mt8173-i2c
> + - mediatek,mt8183-i2c
> + - mediatek,mt8192-i2c
> + - items:
> + - enum:
> + - mediatek,mt2701-i2c
> + - mediatek,mt6797-i2c
> + - mediatek,mt7623-i2c
> + - const: mediatek,mt6577-i2c
> + - items:
> + - enum:
> + - mediatek,mt7629-i2c
> + - mediatek,mt8516-i2c
> + - const: mediatek,mt2712-i2c
> +
> + clocks:
> + minItems: 2
> + maxItems: 4
> + items:
> + - description: Controller clock
> + - description: DMA clock
> + - description: ARB clock for multi-master when a bus has more than
> + one i2c controllers
> + - description: PMIC clock. Only when mediatek,have-pmic is set.
> +
> + clock-names:
> + minItems: 2
> + maxItems: 4
> + items:
> + - const: main
> + - const: dma
> + - const: arb
> + - const: pmic
> +
> + mediatek,have-pmic:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description: Platform can control I2C from the PMIC
> +
> + mediatek,use-push-pull:
> + $ref: /schemas/types.yaml#/definitions/flag
> + description: IO config use push-pull mode.
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - clocks
> + - clock-names
> + - clock-div
This isn't documented.
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + i2c0: i2c@1100d000 {
> + compatible = "mediatek,mt6577-i2c";
> + reg = <0x1100d000 0x70>,
> + <0x11000300 0x80>;
> + interrupts = <GIC_SPI 44 IRQ_TYPE_LEVEL_LOW>;
> + clock-frequency = <400000>;
> + mediatek,have-pmic;
> + clock-div = <16>;
> + clocks = <&i2c0_ck>, <&ap_dma_ck>;
> + clock-names = "main", "dma";
> + };
> --
> 2.31.1
>
