Merge branch 'for-linus' of ssh://gitolite.kernel.org/pub/scm/linux/kernel/git/jikos...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / pci / xgene-pci.txt
1 * AppliedMicro X-Gene PCIe interface
2
3 Required properties:
4 - device_type: set to "pci"
5 - compatible: should contain "apm,xgene-pcie" to identify the core.
6 - reg: A list of physical base address and length for each set of controller
7        registers. Must contain an entry for each entry in the reg-names
8        property.
9 - reg-names: Must include the following entries:
10   "csr": controller configuration registers.
11   "cfg": PCIe configuration space registers.
12 - #address-cells: set to <3>
13 - #size-cells: set to <2>
14 - ranges: ranges for the outbound memory, I/O regions.
15 - dma-ranges: ranges for the inbound memory regions.
16 - #interrupt-cells: set to <1>
17 - interrupt-map-mask and interrupt-map: standard PCI properties
18         to define the mapping of the PCIe interface to interrupt
19         numbers.
20 - clocks: from common clock binding: handle to pci clock.
21
22 Optional properties:
23 - status: Either "ok" or "disabled".
24 - dma-coherent: Present if DMA operations are coherent
25
26 Example:
27
28 SoC-specific DT Entry:
29
30         pcie0: pcie@1f2b0000 {
31                 status = "disabled";
32                 device_type = "pci";
33                 compatible = "apm,xgene-storm-pcie", "apm,xgene-pcie";
34                 #interrupt-cells = <1>;
35                 #size-cells = <2>;
36                 #address-cells = <3>;
37                 reg = < 0x00 0x1f2b0000 0x0 0x00010000   /* Controller registers */
38                         0xe0 0xd0000000 0x0 0x00040000>; /* PCI config space */
39                 reg-names = "csr", "cfg";
40                 ranges = <0x01000000 0x00 0x00000000 0xe0 0x10000000 0x00 0x00010000   /* io */
41                           0x02000000 0x00 0x80000000 0xe1 0x80000000 0x00 0x80000000>; /* mem */
42                 dma-ranges = <0x42000000 0x80 0x00000000 0x80 0x00000000 0x00 0x80000000
43                               0x42000000 0x00 0x00000000 0x00 0x00000000 0x80 0x00000000>;
44                 interrupt-map-mask = <0x0 0x0 0x0 0x7>;
45                 interrupt-map = <0x0 0x0 0x0 0x1 &gic 0x0 0xc2 0x1
46                                  0x0 0x0 0x0 0x2 &gic 0x0 0xc3 0x1
47                                  0x0 0x0 0x0 0x3 &gic 0x0 0xc4 0x1
48                                  0x0 0x0 0x0 0x4 &gic 0x0 0xc5 0x1>;
49                 dma-coherent;
50                 clocks = <&pcie0clk 0>;
51         };
52
53
54 Board-specific DT Entry:
55         &pcie0 {
56                 status = "ok";
57         };