GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / pci / rcar-pci.txt
1 * Renesas R-Car PCIe interface
2
3 Required properties:
4 compatible: "renesas,pcie-r8a7779" for the R8A7779 SoC;
5             "renesas,pcie-r8a7790" for the R8A7790 SoC;
6             "renesas,pcie-r8a7791" for the R8A7791 SoC;
7             "renesas,pcie-r8a7793" for the R8A7793 SoC;
8             "renesas,pcie-r8a7795" for the R8A7795 SoC;
9             "renesas,pcie-r8a7796" for the R8A7796 SoC;
10             "renesas,pcie-rcar-gen2" for a generic R-Car Gen2 compatible device.
11             "renesas,pcie-rcar-gen3" for a generic R-Car Gen3 compatible device.
12
13             When compatible with the generic version, nodes must list the
14             SoC-specific version corresponding to the platform first
15             followed by the generic version.
16
17 - reg: base address and length of the PCIe controller registers.
18 - #address-cells: set to <3>
19 - #size-cells: set to <2>
20 - bus-range: PCI bus numbers covered
21 - device_type: set to "pci"
22 - ranges: ranges for the PCI memory and I/O regions.
23 - dma-ranges: ranges for the inbound memory regions.
24 - interrupts: two interrupt sources for MSI interrupts, followed by interrupt
25         source for hardware related interrupts (e.g. link speed change).
26 - #interrupt-cells: set to <1>
27 - interrupt-map-mask and interrupt-map: standard PCI properties
28         to define the mapping of the PCIe interface to interrupt numbers.
29 - clocks: from common clock binding: clock specifiers for the PCIe controller
30         and PCIe bus clocks.
31 - clock-names: from common clock binding: should be "pcie" and "pcie_bus".
32
33 Example:
34
35 SoC-specific DT Entry:
36
37         pcie: pcie@fe000000 {
38                 compatible = "renesas,pcie-r8a7791", "renesas,pcie-rcar-gen2";
39                 reg = <0 0xfe000000 0 0x80000>;
40                 #address-cells = <3>;
41                 #size-cells = <2>;
42                 bus-range = <0x00 0xff>;
43                 device_type = "pci";
44                 ranges = <0x01000000 0 0x00000000 0 0xfe100000 0 0x00100000
45                           0x02000000 0 0xfe200000 0 0xfe200000 0 0x00200000
46                           0x02000000 0 0x30000000 0 0x30000000 0 0x08000000
47                           0x42000000 0 0x38000000 0 0x38000000 0 0x08000000>;
48                 dma-ranges = <0x42000000 0 0x40000000 0 0x40000000 0 0x40000000
49                               0x42000000 2 0x00000000 2 0x00000000 0 0x40000000>;
50                 interrupts = <0 116 4>, <0 117 4>, <0 118 4>;
51                 #interrupt-cells = <1>;
52                 interrupt-map-mask = <0 0 0 0>;
53                 interrupt-map = <0 0 0 0 &gic 0 116 4>;
54                 clocks = <&mstp3_clks R8A7791_CLK_PCIE>, <&pcie_bus_clk>;
55                 clock-names = "pcie", "pcie_bus";
56         };