[PATCH v9 2/4] Documentation: Add documentation for APM X-Gene SoC SATA host controller DTS binding

Mark Rutland
2014-01-15T11:18:39Z

On Wed, Jan 15, 2014 at 07:11:48AM +0000, Loc Ho wrote:
> Signed-off-by: Loc Ho <lho@apm.com>
> Signed-off-by: Tuan Phan <tphan@apm.com>
> Signed-off-by: Suman Tripathi <stripathi@apm.com>
> ---
> .../devicetree/bindings/ata/apm-xgene.txt | 68 ++++++++++++++++++++
> 1 files changed, 68 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..3d1421a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ata/apm-xgene.txt
> @@ -0,0 +1,68 @@
> +* APM X-Gene 6.0 Gb/s SATA host controller nodes
> +
> +SATA host controller 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-sgmii" if mux'ed with SGMII
> + or "apm,xgene-ahci-pcie" if mux'ed with PCIe.
> +- reg : First memory resource shall be the AHCI memory
> + resource.
> + Second memory resource shall be the host controller
> + memory resource.
> +- interrupts : Interrupt mapping for SATA host controller IRQ.

s/Interrupt-mapping/interrupt-specifier/

> +- clocks : Reference to the clock entry.
> +- phys : PHY reference with parameter 0.

The specific value of the phy-specifier shouldn't matter to this
binding. What should matter is what it logically corresponds to.

> +- phy-names : Name of the PHY. Shall be "sata-6g".

Could you define phys in terms of phy-names please? It makes the
relationship clearer:

- phys: a list of phandles + phy-sciefiers, one for each entry in
phy-names

- phy-names: Should contain:
* "sata-6g" for the SATA PHY <notes about requirements go here>

Cheers,
Mark.