Commit 2ebeea2b authored by Paul Cercueil's avatar Paul Cercueil Committed by Rob Herring
Browse files

dt-bindings: mmc: Convert jz4740-mmc doc to YAML



Convert the jz4740-mmc.txt documentation to YAML.

The ingenic,jz4770-mmc compatible string was added in the process, with
a fallback to ingenic,jz4760-mmc.

Signed-off-by: default avatarPaul Cercueil <paul@crapouillou.net>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent 49ac0c7c
Loading
Loading
Loading
Loading
+79 −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/mmc/ingenic,mmc.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Ingenic SoCs MMC Controller DT bindings

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

allOf:
  - $ref: mmc-controller.yaml#

properties:
  compatible:
    oneOf:
      - enum:
        - ingenic,jz4740-mmc
        - ingenic,jz4725b-mmc
        - ingenic,jz4760-mmc
        - ingenic,jz4780-mmc
        - ingenic,x1000-mmc
      - items:
        - const: ingenic,jz4770-mmc
        - const: ingenic,jz4760-mmc

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 1

  clock-names:
    const: mmc

  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-names
  - dmas
  - dma-names

examples:
  - |
    #include <dt-bindings/clock/jz4780-cgu.h>
    #include <dt-bindings/dma/jz4780-dma.h>
    mmc0: mmc@13450000 {
      compatible = "ingenic,jz4780-mmc";
      reg = <0x13450000 0x1000>;

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

      clocks = <&cgu JZ4780_CLK_MSC0>;
      clock-names = "mmc";

      cap-sd-highspeed;
      cap-mmc-highspeed;
      cap-sdio-irq;
      dmas = <&dma JZ4780_DMA_MSC0_RX 0xffffffff>,
             <&dma JZ4780_DMA_MSC0_TX 0xffffffff>;
      dma-names = "rx", "tx";
    };
+0 −41
Original line number Diff line number Diff line
* Ingenic XBurst MMC controllers

This file documents the device tree properties used for the MMC controller in
Ingenic JZ4740/JZ4760/JZ4780/X1000 SoCs. These are in addition to the core MMC
properties described in mmc.txt.

Required properties:
- compatible: Should be one of the following:
  - "ingenic,jz4740-mmc" for the JZ4740
  - "ingenic,jz4725b-mmc" for the JZ4725B
  - "ingenic,jz4760-mmc" for the JZ4760
  - "ingenic,jz4780-mmc" for the JZ4780
  - "ingenic,x1000-mmc" for the X1000
- reg: Should contain the MMC controller registers location and length.
- interrupts: Should contain the interrupt specifier of the MMC controller.
- clocks: Clock for the MMC controller.

Optional properties:
- dmas: List of DMA specifiers with the controller specific format
        as described in the generic DMA client binding. A tx and rx
        specifier is required.
- dma-names: RX and TX  DMA request names.
        Should be "rx" and "tx", in that order.

For additional details on DMA client bindings see ../dma/dma.txt.

Example:

mmc0: mmc@13450000 {
	compatible = "ingenic,jz4780-mmc";
	reg = <0x13450000 0x1000>;

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

	clocks = <&cgu JZ4780_CLK_MSC0>;
	clock-names = "mmc";

	dmas = <&dma JZ4780_DMA_MSC0_RX 0xffffffff>, <&dma JZ4780_DMA_MSC0_TX 0xffffffff>;
	dma-names = "rx", "tx";
};