mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Paul Cercueil <paul@crapouillou.net>
To: Thomas Bogendoerfer <tsbogend@alpha.franken.de>,
	Rob Herring <robh+dt@kernel.org>
Cc: od@zcrc.me, 周琰杰 <zhouyanjie@wanyeetech.com>,
	devicetree@vger.kernel.org, linux-mips@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	"Paul Cercueil" <paul@crapouillou.net>
Subject: [PATCH 02/13] dt-bindings: mmc: Convert jz4740-mmc doc to YAML
Date: Mon, 13 Apr 2020 17:26:22 +0200	[thread overview]
Message-ID: <20200413152633.198301-2-paul@crapouillou.net> (raw)
In-Reply-To: <20200413152633.198301-1-paul@crapouillou.net>

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: Paul Cercueil <paul@crapouillou.net>
---
 .../devicetree/bindings/mmc/ingenic,mmc.yaml  | 79 +++++++++++++++++++
 .../devicetree/bindings/mmc/jz4740.txt        | 41 ----------
 2 files changed, 79 insertions(+), 41 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mmc/ingenic,mmc.yaml
 delete mode 100644 Documentation/devicetree/bindings/mmc/jz4740.txt

diff --git a/Documentation/devicetree/bindings/mmc/ingenic,mmc.yaml b/Documentation/devicetree/bindings/mmc/ingenic,mmc.yaml
new file mode 100644
index 000000000000..e60bfe980ab3
--- /dev/null
+++ b/Documentation/devicetree/bindings/mmc/ingenic,mmc.yaml
@@ -0,0 +1,79 @@
+# 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";
+    };
diff --git a/Documentation/devicetree/bindings/mmc/jz4740.txt b/Documentation/devicetree/bindings/mmc/jz4740.txt
deleted file mode 100644
index 453d3b9d145d..000000000000
--- a/Documentation/devicetree/bindings/mmc/jz4740.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-* 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";
-};
-- 
2.25.1


  reply	other threads:[~2020-04-13 15:27 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-13 15:26 [PATCH 01/13] dt-bindings: timer: Convert ingenic,tcu.txt " Paul Cercueil
2020-04-13 15:26 ` Paul Cercueil [this message]
2020-04-20 20:48   ` [PATCH 02/13] dt-bindings: mmc: Convert jz4740-mmc doc " Rob Herring
2020-04-13 15:26 ` [PATCH 03/13] dt-bindings: dma: Convert jz4740-dma " Paul Cercueil
2020-04-20 20:49   ` Rob Herring
2020-04-13 15:26 ` [PATCH 04/13] dt-bindings: usb: ingenic,musb: Add usb-role-switch property Paul Cercueil
2020-04-20 20:49   ` Rob Herring
2020-04-13 15:26 ` [PATCH 05/13] dt-bindings: MIPS: Require SoC compatible string after board string Paul Cercueil
2020-04-20 20:50   ` Rob Herring
2020-04-13 15:26 ` [PATCH 06/13] MIPS: ingenic: DTS: Fix invalid value in #dma-cells Paul Cercueil
2020-04-13 15:26 ` [PATCH 07/13] MIPS: ingenic: DTS: Respect cell count of common properties Paul Cercueil
2020-04-29 21:04   ` Thomas Bogendoerfer
2020-04-30 12:17     ` Paul Cercueil
2020-04-13 15:26 ` [PATCH 08/13] MIPS: ingenic: DTS: Add nodes for the watchdog/PWM/OST Paul Cercueil
2020-04-29 21:04   ` Thomas Bogendoerfer
2020-04-13 15:26 ` [PATCH 09/13] MIPS: ingenic: DTS: Update JZ4770 support Paul Cercueil
2020-04-29 21:05   ` Thomas Bogendoerfer
2020-04-13 15:26 ` [PATCH 10/13] MIPS: ingenic: DTS: Update GCW0 support Paul Cercueil
2020-04-29 21:05   ` Thomas Bogendoerfer
2020-04-13 15:26 ` [PATCH 11/13] MIPS: ingenic: CI20: enable OST, PWM drivers in defconfig Paul Cercueil
2020-04-29 21:05   ` Thomas Bogendoerfer
2020-04-13 15:26 ` [PATCH 12/13] MIPS: ingenic: GCW0: Update defconfig Paul Cercueil
2020-04-29 21:06   ` Thomas Bogendoerfer
2020-04-13 15:26 ` [PATCH 13/13] MIPS: ingenic: Drop obsolete code, merge the rest in setup.c Paul Cercueil
2020-04-29 21:06   ` Thomas Bogendoerfer
2020-04-20 20:47 ` [PATCH 01/13] dt-bindings: timer: Convert ingenic,tcu.txt to YAML Rob Herring

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200413152633.198301-2-paul@crapouillou.net \
    --to=paul@crapouillou.net \
    --cc=devicetree@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mips@vger.kernel.org \
    --cc=od@zcrc.me \
    --cc=robh+dt@kernel.org \
    --cc=tsbogend@alpha.franken.de \
    --cc=zhouyanjie@wanyeetech.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®