1 # SPDX-License-Identifier: (GPL-2.0-only OR BS 1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2 2 %YAML 1.2
3 --- 3 ---
4 $id: http://devicetree.org/schemas/pci/host-ge 4 $id: http://devicetree.org/schemas/pci/host-generic-pci.yaml#
5 $schema: http://devicetree.org/meta-schemas/co 5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6 6
7 title: Generic PCI host controller 7 title: Generic PCI host controller
8 8
9 maintainers: 9 maintainers:
10 - Will Deacon <will@kernel.org> 10 - Will Deacon <will@kernel.org>
11 11
12 description: | 12 description: |
13 Firmware-initialised PCI host controllers an 13 Firmware-initialised PCI host controllers and PCI emulations, such as the
14 virtio-pci implementations found in kvmtool 14 virtio-pci implementations found in kvmtool and other para-virtualised
15 systems, do not require driver support for c 15 systems, do not require driver support for complexities such as regulator
16 and clock management. In fact, the controlle 16 and clock management. In fact, the controller may not even require the
17 configuration of a control interface by the 17 configuration of a control interface by the operating system, instead
18 presenting a set of fixed windows describing 18 presenting a set of fixed windows describing a subset of IO, Memory and
19 Configuration Spaces. 19 Configuration Spaces.
20 20
21 Configuration Space is assumed to be memory- 21 Configuration Space is assumed to be memory-mapped (as opposed to being
22 accessed via an ioport) and laid out with a 22 accessed via an ioport) and laid out with a direct correspondence to the
23 geography of a PCI bus address by concatenat 23 geography of a PCI bus address by concatenating the various components to
24 form an offset. 24 form an offset.
25 25
26 For CAM, this 24-bit offset is: 26 For CAM, this 24-bit offset is:
27 27
28 cfg_offset(bus, device, function, re 28 cfg_offset(bus, device, function, register) =
29 bus << 16 | device << 11 29 bus << 16 | device << 11 | function << 8 | register
30 30
31 While ECAM extends this by 4 bits to accommo 31 While ECAM extends this by 4 bits to accommodate 4k of function space:
32 32
33 cfg_offset(bus, device, function, re 33 cfg_offset(bus, device, function, register) =
34 bus << 20 | device << 15 34 bus << 20 | device << 15 | function << 12 | register
35 35
36 properties: 36 properties:
37 compatible: 37 compatible:
38 description: Depends on the layout of conf 38 description: Depends on the layout of configuration space (CAM vs ECAM
39 respectively). May also have more specif 39 respectively). May also have more specific compatibles.
40 oneOf: 40 oneOf:
41 - description: 41 - description:
42 PCIe host controller in Arm Juno bas 42 PCIe host controller in Arm Juno based on PLDA XpressRICH3-AXI IP
43 items: 43 items:
44 - const: arm,juno-r1-pcie 44 - const: arm,juno-r1-pcie
45 - const: plda,xpressrich3-axi 45 - const: plda,xpressrich3-axi
46 - const: pci-host-ecam-generic 46 - const: pci-host-ecam-generic
47 - description: | 47 - description: |
48 ThunderX PCI host controller for pas 48 ThunderX PCI host controller for pass-1.x silicon
49 49
50 Firmware-initialized PCI host contro 50 Firmware-initialized PCI host controller to on-chip devices found on
51 some Cavium ThunderX processors. Th 51 some Cavium ThunderX processors. These devices have ECAM-based config
52 access, but the BARs are all at fixe 52 access, but the BARs are all at fixed addresses. We handle the fixed
53 addresses by synthesizing Enhanced A 53 addresses by synthesizing Enhanced Allocation (EA) capabilities for
54 these devices. 54 these devices.
55 const: cavium,pci-host-thunder-ecam 55 const: cavium,pci-host-thunder-ecam
56 - description: 56 - description:
57 Cavium ThunderX PEM firmware-initial 57 Cavium ThunderX PEM firmware-initialized PCIe host controller
58 const: cavium,pci-host-thunder-pem 58 const: cavium,pci-host-thunder-pem
59 - description: 59 - description:
60 HiSilicon Hip06/Hip07 PCIe host brid 60 HiSilicon Hip06/Hip07 PCIe host bridge in almost-ECAM mode. Some
61 firmware places the host controller 61 firmware places the host controller in a mode where it is ECAM
62 compliant for all devices other than 62 compliant for all devices other than the root complex.
63 enum: 63 enum:
64 - hisilicon,hip06-pcie-ecam 64 - hisilicon,hip06-pcie-ecam
65 - hisilicon,hip07-pcie-ecam 65 - hisilicon,hip07-pcie-ecam
66 - description: | 66 - description: |
67 In some cases, firmware may already 67 In some cases, firmware may already have configured the Synopsys
68 DesignWare PCIe controller in RC mod 68 DesignWare PCIe controller in RC mode with static ATU window mappings
69 that cover all config, MMIO and I/O 69 that cover all config, MMIO and I/O spaces in a [mostly] ECAM
70 compatible fashion. In this case, th 70 compatible fashion. In this case, there is no need for the OS to
71 perform any low level setup of clock 71 perform any low level setup of clocks, PHYs or device registers, nor
72 is there any reason for the driver t 72 is there any reason for the driver to reconfigure ATU windows for
73 config and/or IO space accesses at r 73 config and/or IO space accesses at runtime.
74 74
75 In cases where the IP was synthesize 75 In cases where the IP was synthesized with a minimum ATU window size
76 of 64 KB, it cannot be supported by 76 of 64 KB, it cannot be supported by the generic ECAM driver, because
77 it requires special config space acc 77 it requires special config space accessors that filter accesses to
78 device #1 and beyond on the first bu 78 device #1 and beyond on the first bus.
79 items: 79 items:
80 - enum: 80 - enum:
81 - marvell,armada8k-pcie-ecam 81 - marvell,armada8k-pcie-ecam
82 - socionext,synquacer-pcie-ecam 82 - socionext,synquacer-pcie-ecam
83 - const: snps,dw-pcie-ecam 83 - const: snps,dw-pcie-ecam
84 - description: 84 - description:
85 CAM or ECAM compliant PCI host contr 85 CAM or ECAM compliant PCI host controllers without any quirks
86 enum: 86 enum:
87 - pci-host-cam-generic 87 - pci-host-cam-generic
88 - pci-host-ecam-generic 88 - pci-host-ecam-generic
89 89
90 reg: 90 reg:
91 description: 91 description:
92 The Configuration Space base address and 92 The Configuration Space base address and size, as accessed from the parent
93 bus. The base address corresponds to the 93 bus. The base address corresponds to the first bus in the "bus-range"
94 property. If no "bus-range" is specified 94 property. If no "bus-range" is specified, this will be bus 0 (the
95 default). Some host controllers have a 2 95 default). Some host controllers have a 2nd non-compliant address range,
96 so 2 entries are allowed. 96 so 2 entries are allowed.
97 minItems: 1 97 minItems: 1
98 maxItems: 2 98 maxItems: 2
99 99
100 ranges: 100 ranges:
101 description: 101 description:
102 As described in IEEE Std 1275-1994, but 102 As described in IEEE Std 1275-1994, but must provide at least a
103 definition of non-prefetchable memory. O 103 definition of non-prefetchable memory. One or both of prefetchable Memory
104 and IO Space may also be provided. 104 and IO Space may also be provided.
105 105
106 dma-coherent: true 106 dma-coherent: true
107 iommu-map: true 107 iommu-map: true
108 iommu-map-mask: true 108 iommu-map-mask: true
109 msi-parent: true 109 msi-parent: true
110 110
111 ats-supported: 111 ats-supported:
112 description: 112 description:
113 Indicates that a PCIe host controller su 113 Indicates that a PCIe host controller supports ATS, and can handle Memory
114 Requests with Address Type (AT). 114 Requests with Address Type (AT).
115 type: boolean 115 type: boolean
116 116
117 required: 117 required:
118 - compatible 118 - compatible
119 - reg 119 - reg
120 - ranges 120 - ranges
121 121
122 allOf: 122 allOf:
123 - $ref: /schemas/pci/pci-host-bridge.yaml# 123 - $ref: /schemas/pci/pci-host-bridge.yaml#
124 - if: 124 - if:
125 properties: 125 properties:
126 compatible: 126 compatible:
127 contains: 127 contains:
128 const: arm,juno-r1-pcie 128 const: arm,juno-r1-pcie
129 then: 129 then:
130 required: 130 required:
131 - dma-coherent 131 - dma-coherent
132 132
133 - if: 133 - if:
134 properties: 134 properties:
135 compatible: 135 compatible:
136 not: 136 not:
137 contains: 137 contains:
138 enum: 138 enum:
139 - cavium,pci-host-thunder-pem 139 - cavium,pci-host-thunder-pem
140 - hisilicon,hip06-pcie-ecam 140 - hisilicon,hip06-pcie-ecam
141 - hisilicon,hip07-pcie-ecam 141 - hisilicon,hip07-pcie-ecam
142 then: 142 then:
143 properties: 143 properties:
144 reg: 144 reg:
145 maxItems: 1 145 maxItems: 1
146 146
147 unevaluatedProperties: false 147 unevaluatedProperties: false
148 148
149 examples: 149 examples:
150 - | 150 - |
151 151
152 bus { 152 bus {
153 #address-cells = <2>; 153 #address-cells = <2>;
154 #size-cells = <2>; 154 #size-cells = <2>;
155 pcie@40000000 { 155 pcie@40000000 {
156 compatible = "pci-host-cam-generic 156 compatible = "pci-host-cam-generic";
157 device_type = "pci"; 157 device_type = "pci";
158 #address-cells = <3>; 158 #address-cells = <3>;
159 #size-cells = <2>; 159 #size-cells = <2>;
160 bus-range = <0x0 0x1>; 160 bus-range = <0x0 0x1>;
161 161
162 // CPU_PHYSICAL(2) SIZE(2) 162 // CPU_PHYSICAL(2) SIZE(2)
163 reg = <0x0 0x40000000 0x0 0x10000 163 reg = <0x0 0x40000000 0x0 0x1000000>;
164 164
165 // BUS_ADDRESS(3) CPU_PHYSICAL(2) 165 // BUS_ADDRESS(3) CPU_PHYSICAL(2) SIZE(2)
166 ranges = <0x01000000 0x0 0x0100000 166 ranges = <0x01000000 0x0 0x01000000 0x0 0x01000000 0x0 0x00010000>,
167 <0x02000000 0x0 0x4100000 167 <0x02000000 0x0 0x41000000 0x0 0x41000000 0x0 0x3f000000>;
168 168
169 #interrupt-cells = <0x1>; 169 #interrupt-cells = <0x1>;
170 170
171 // PCI_DEVICE(3) INT#(1) CONTROL 171 // PCI_DEVICE(3) INT#(1) CONTROLLER(PHANDLE) CONTROLLER_DATA(3)
172 interrupt-map = < 0x0 0x0 0x0 0 172 interrupt-map = < 0x0 0x0 0x0 0x1 &gic 0x0 0x4 0x1>,
173 < 0x800 0x0 0x0 0 173 < 0x800 0x0 0x0 0x1 &gic 0x0 0x5 0x1>,
174 <0x1000 0x0 0x0 0 174 <0x1000 0x0 0x0 0x1 &gic 0x0 0x6 0x1>,
175 <0x1800 0x0 0x0 0 175 <0x1800 0x0 0x0 0x1 &gic 0x0 0x7 0x1>;
176 176
177 // PCI_DEVICE(3) INT#(1) 177 // PCI_DEVICE(3) INT#(1)
178 interrupt-map-mask = <0xf800 0x0 0 178 interrupt-map-mask = <0xf800 0x0 0x0 0x7>;
179 }; 179 };
180 }; 180 };
181 ... 181 ...
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.