[PATCH v2 5/5] Documentation: Add documentation for APM X-Gene SATA DTS binding

[Loc Ho]

Documentation: Add documentation for APM X-Gene SATA DTS binding

Signed-off-by: Loc Ho <lho at apm.com>
Signed-off-by: Tuan Phan <tphan at apm.com>
Signed-off-by: Suman Tripathi <stripathi at apm.com>
---
 .../devicetree/bindings/ata/apm-xgene.txt          |   84 ++++++++++++++++++++
 1 files changed, 84 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/ata/apm-xgene.txt

diff --git a/Documentation/devicetree/bindings/ata/apm-xgene.txt b/Documentation/devicetree/bindings/ata/apm-xgene.txt
new file mode 100644
index 0000000..cd52864
--- /dev/null
+++ b/Documentation/devicetree/bindings/ata/apm-xgene.txt
@@ -0,0 +1,84 @@
+* APM X-Gene 6.0 Gb/s SATA nodes
+
+SATA nodes are defined to describe on-chip Serial ATA controllers.
+Each SATA controller (pair of ports) have its own node.
+
+Required properties:
+- compatible		: Shall be "apm,xgene-ahci"
+- reg			: First memory resource shall be the AHCI memory resource
+			  Second memory resource shall be the Serdes memory resource
+			  Third memory resource shall be the optional Serdes
+			  memory resource if mux'ed with another IP
+- interrupt-parent	: Interrupt controller
+- interrupts		: Interrupt mapping for SATA IRQ
+- #clock-cells		: Shall be value of 1
+- clocks		: Reference to the clock entry
+- clock-names		: Shall be "eth01clk", "eth23clk", or "eth45clk".
+
+Optional properties:
+- status		: Shall be "ok" if enabled or "na" if disabled. Default
+			  is "ok".
+- serdes-diff-clk	: Shall be 0 for external, 1 internal differential,
+			  or 2 internal single ended clock. Default is 0.
+- gen-sel		: Shall be 1 (force Gen1), 2 (Force Gen2, or 3 Gen3).
+			  Default is 3.
+- EQA1			: Serdes EQ parameter for A1 chip. Default is 9.
+- EQ			: Serdes EQ parameter for non-A1 chip. Default is 2.
+- GENAVG		: Enable averaging Serdes calculation. Default is 0 for
+			  A1 chip and 1 for non-A1 chip.
+- LBA1			: Serdes loopback buffer for A1 chip. Default is 1;
+- LB			: Serdes loopback buffer for non-A1 chip. Default is 0;
+- LCA1			: Serdes loopback enable control for A1 chip. Default
+			  is 1;
+- LC			: Serdes loopback enable control for non-A1 chip.
+			  Default is 0;
+- CDRA1			: Serdes SPD select CDR for A1 chip. Default is 5.
+- CDR			: Serdes SPD select CDR for non-A1 chip. Default is 5.
+- PQA1			: Serdes PQ for A1 chip. Default is 8.
+- PQ			: Serdes PQ for non-A1 chip. Default is 0xA.
+- coherent		: Enable coherent (1 = enable, 0 = disable).
+			  Default is 1.
+
+Example:
+		sata0: sata at 1a000000 {
+			compatible = "apm,xgene-ahci";
+			reg =  <0x0 0x1a000000 0x0 0x100000
+				0x0 0x1f210000 0x0 0x10000>;
+			interrupt-parent = <&gic>;
+			interrupts = <0x0 0x86 0x4>;
+			#clock-cells = <1>;
+		        clocks = <&eth01clk 0>;
+			clock-names = "eth01clk";
+			status = "na";
+			serdes-diff-clk = <0>;
+			gen-sel = <3>;
+		};
+
+		sata1: sata at 1a400000 {
+			compatible = "apm,xgene-ahci";
+			reg =  <0x0 0x1a400000 0x0 0x100000
+				0x0 0x1f220000 0x0 0x10000>;
+			interrupt-parent = <&gic>;
+			interrupts = <0x0 0x87 0x4>;
+			#clock-cells = <1>;
+		        clocks = <&eth23clk 0>;
+			clock-names = "eth23clk";
+			status = "na";
+			serdes-diff-clk = <0>;
+			gen-sel = <3>;
+		};
+
+		sata2: sata at 1a800000 {
+			compatible = "apm,xgene-ahci";
+			reg =  <0x0 0x1a800000 0x0 0x100000
+				0x0 0x1f230000 0x0 0x10000
+				0x0 0x1f2d0000 0x0 0x10000 >;
+			interrupt-parent = <&gic>;
+			interrupts = <0x0 0x88 0x4>;
+			#clock-cells = <1>;
+		        clocks = <&sata45clk 0>;
+			clock-names = "sata45clk";
+			status = "ok";
+			serdes-diff-clk = <0>;
+			gen-sel = <3>;
+		};
-- 
1.5.5