diff mbox

[V8,1/2] mmc: OCTEON: Add DT bindings for OCTEON MMC controller.

Message ID 57853472.2050404@cavium.com (mailing list archive)
State New, archived
Headers show

Commit Message

Steven J. Hill July 12, 2016, 6:18 p.m. UTC 
Add Device Tree binding document for Octeon MMC controller. The driver
is in a following patch. The OCTEON's MMC controller can be connected
to up to 4 "slots" which may be eMMC, MMC or SD card devices. As there
is a single controller, each available slot is represented as a child
node of the controller.

Signed-off-by: Steven J. Hill <steven.hill@cavium.com>
Acked-by: David Daney <david.daney@cavium.com>

---
v8:
- Properly documented deprecated device tree properties.

v7:
- Rewrote a lot of the document for better readability

v6:
- Split up patch
- Moved device tree fixup to platform code
---

Signed-off-by: Steven J. Hill <Steven.Hill@cavium.com>
---
 .../devicetree/bindings/mmc/octeon-mmc.txt         | 72 ++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mmc/octeon-mmc.txt

Comments

Rob Herring (Arm) July 16, 2016, 9:36 p.m. UTC | #1 
On Tue, Jul 12, 2016 at 01:18:26PM -0500, Steven J. Hill wrote:
> Add Device Tree binding document for Octeon MMC controller. The driver
> is in a following patch. The OCTEON's MMC controller can be connected
> to up to 4 "slots" which may be eMMC, MMC or SD card devices. As there
> is a single controller, each available slot is represented as a child
> node of the controller.
> 
> Signed-off-by: Steven J. Hill <steven.hill@cavium.com>
> Acked-by: David Daney <david.daney@cavium.com>
> 
> ---
> v8:
> - Properly documented deprecated device tree properties.
> 
> v7:
> - Rewrote a lot of the document for better readability
> 
> v6:
> - Split up patch
> - Moved device tree fixup to platform code
> ---
> 
> Signed-off-by: Steven J. Hill <Steven.Hill@cavium.com>
> ---
>  .../devicetree/bindings/mmc/octeon-mmc.txt         | 72 ++++++++++++++++++++++
>  1 file changed, 72 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mmc/octeon-mmc.txt

Acked-by: Rob Herring <robh@kernel.org>

--
To unsubscribe from this list: send the line "unsubscribe linux-mmc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mmc/octeon-mmc.txt b/Documentation/devicetree/bindings/mmc/octeon-mmc.txt
new file mode 100644
index 0000000..d4e2e28
--- /dev/null
+++ b/Documentation/devicetree/bindings/mmc/octeon-mmc.txt
@@ -0,0 +1,72 @@ 
+* OCTEON SD/MMC Host Controller
+
+This controller is present on some members of the Cavium OCTEON SoC
+family, provide an interface for eMMC, MMC and SD devices.  There is a
+single controller that may have several "slots" connected.  These
+slots appear as children of the main controller node.
+The DMA engine is an integral part of the controller block.
+
+Required properties:
+- compatible : Should be "cavium,octeon-6130-mmc" or "cavium,octeon-7890-mmc"
+- reg : Two entries:
+	1) The base address of the MMC controller register bank
+	2) The base address of the MMC DMA engine register bank
+- interrupts :
+	For "cavium,octeon-6130-mmc": two entries:
+	1) The MMC controller interrupt line
+	2) The MMC DMA engine interrupt line
+	For "cavium,octeon-7890-mmc": nine entries:
+	1) Next block transfer of a multiblock transfer has completed (BUF_DONE)
+	2) Operation completed successfully (CMD_DONE)
+	3) DMA transfer completed successfully (DMA_DONE)
+	4) Operation encountered an error (CMD_ERR)
+	5) DMA transfer encountered an error (DMA_ERR)
+	6) Switch operation completed successfully (SWITCH_DONE)
+	7) Switch operation encountered an error (SWITCH_ERR)
+	8) Internal DMA engine request completion interrupt (DONE)
+	9) Internal DMA FIFO underflow (FIFO)
+- #address-cells : Must be <1>
+- #size-cells : Must be <0>
+
+Required properties of child nodes:
+- compatible : Should be
+  - "cavium,octeon-6130-mmc-slot"
+- reg : The slot number.
+
+Optional properties of child nodes:
+- cd-gpios : Specify GPIOs for card detection
+- wp-gpios : Specify GPIOs for write protection
+- bus-width : for data lines present in the slot. Default is 8.
+- max-frequency : Maximum operating frequency of the slot. Default is 52000000.
+- spi-max-frequency (DEPRECATED)
+
+Cavium specific properties of child nodes:
+- power-gpios : Specify GPIOs for power control
+- cavium,cmd-clk-skew : the amount of delay (in pS) past the clock edge
+	to sample the command pin.
+- cavium,dat-clk-skew : the amount of delay (in pS) past the clock edge
+	to sample the data pin.
+- cavium,bus-max-width (DEPRECATED)
+
+Example:
+	mmc@1180000002000 {
+		compatible = "cavium,octeon-6130-mmc";
+		reg = <0x11800 0x00002000 0x0 0x100>,
+		      <0x11800 0x00000168 0x0 0x20>;
+		#address-cells = <1>;
+		#size-cells = <0>;
+		/* EMM irq, DMA irq */
+		interrupts = <1 19>, <0 63>;
+
+		/* The board only has a single MMC slot */
+		mmc-slot@0 {
+			compatible = "cavium,octeon-6130-mmc-slot";
+			reg = <0>;
+			max-frequency = <20000000>;
+			/* bus width can be 1, 4 or 8 */
+			bus-width = <8>;
+			cd-gpios = <&gpio 9 0>;
+			wp-gpios = <&gpio 10 0>;
+			power-gpios = <&gpio 8 0>;
+		};
+	};