Merge remote-tracking branch 'asoc/topic/kconfig' into asoc-next
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / ata / ahci-platform.txt
1 * AHCI SATA Controller
2
3 SATA nodes are defined to describe on-chip Serial ATA controllers.
4 Each SATA controller should have its own node.
5
6 It is possible, but not required, to represent each port as a sub-node.
7 It allows to enable each port independently when dealing with multiple
8 PHYs.
9
10 Required properties:
11 - compatible        : compatible string, one of:
12   - "allwinner,sun4i-a10-ahci"
13   - "hisilicon,hisi-ahci"
14   - "cavium,octeon-7130-ahci"
15   - "ibm,476gtr-ahci"
16   - "marvell,armada-380-ahci"
17   - "marvell,armada-3700-ahci"
18   - "snps,dwc-ahci"
19   - "snps,exynos5440-ahci"
20   - "snps,spear-ahci"
21   - "generic-ahci"
22 - interrupts        : <interrupt mapping for SATA IRQ>
23 - reg               : <registers mapping>
24
25 Please note that when using "generic-ahci" you must also specify a SoC specific
26 compatible:
27         compatible = "manufacturer,soc-model-ahci", "generic-ahci";
28
29 Optional properties:
30 - dma-coherent      : Present if dma operations are coherent
31 - clocks            : a list of phandle + clock specifier pairs
32 - target-supply     : regulator for SATA target power
33 - phys              : reference to the SATA PHY node
34 - phy-names         : must be "sata-phy"
35 - ports-implemented : Mask that indicates which ports that the HBA supports
36                       are available for software to use. Useful if PORTS_IMPL
37                       is not programmed by the BIOS, which is true with
38                       some embedded SOC's.
39
40 Required properties when using sub-nodes:
41 - #address-cells    : number of cells to encode an address
42 - #size-cells       : number of cells representing the size of an address
43
44
45 Sub-nodes required properties:
46 - reg               : the port number
47 And at least one of the following properties:
48 - phys              : reference to the SATA PHY node
49 - target-supply    : regulator for SATA target power
50
51 Examples:
52         sata@ffe08000 {
53                 compatible = "snps,spear-ahci";
54                 reg = <0xffe08000 0x1000>;
55                 interrupts = <115>;
56         };
57
58         ahci: sata@01c18000 {
59                 compatible = "allwinner,sun4i-a10-ahci";
60                 reg = <0x01c18000 0x1000>;
61                 interrupts = <56>;
62                 clocks = <&pll6 0>, <&ahb_gates 25>;
63                 target-supply = <&reg_ahci_5v>;
64         };
65
66 With sub-nodes:
67         sata@f7e90000 {
68                 compatible = "marvell,berlin2q-achi", "generic-ahci";
69                 reg = <0xe90000 0x1000>;
70                 interrupts = <GIC_SPI 7 IRQ_TYPE_LEVEL_HIGH>;
71                 clocks = <&chip CLKID_SATA>;
72                 #address-cells = <1>;
73                 #size-cells = <0>;
74
75                 sata0: sata-port@0 {
76                         reg = <0>;
77                         phys = <&sata_phy 0>;
78                         target-supply = <&reg_sata0>;
79                 };
80
81                 sata1: sata-port@1 {
82                         reg = <1>;
83                         phys = <&sata_phy 1>;
84                         target-supply = <&reg_sata1>;;
85                 };
86         };