1 # SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
4 $id: http://devicetree.org/schemas/net/qcom,ipa.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
7 title: Qualcomm IP Accelerator (IPA)
10 - Alex Elder <elder@kernel.org>
13 This binding describes the Qualcomm IPA. The IPA is capable of offloading
14 certain network processing tasks (e.g. filtering, routing, and NAT) from
17 The IPA sits between multiple independent "execution environments,"
18 including the Application Processor (AP) and the modem. The IPA presents
19 a Generic Software Interface (GSI) to each execution environment.
20 The GSI is an integral part of the IPA, but it is logically isolated
21 and has a distinct interrupt and a separately-defined address space.
23 See also soc/qcom/qcom,smp2p.txt and interconnect/interconnect.txt. See
24 iommu/iommu.txt and iommu/arm,smmu.yaml for more information about SMMU
31 | AP +<---. .----+ Modem |
34 -------- | | | | ---------
56 - description: IPA registers
57 - description: IPA shared memory
58 - description: GSI registers
78 - description: IPA interrupt (hardware IRQ)
79 - description: GSI interrupt (hardware IRQ)
80 - description: Modem clock query interrupt (smp2p interrupt)
81 - description: Modem setup ready interrupt (smp2p interrupt)
87 - const: ipa-clock-query
88 - const: ipa-setup-ready
93 - description: Path leading to system memory
94 - description: Path between the AP and IPA config space
96 - description: Path leading to system memory
97 - description: Path leading to internal memory
98 - description: Path between the AP and IPA config space
111 $ref: /schemas/types.yaml#/definitions/phandle
112 description: phandle to the AOSS side-channel message RAM
115 $ref: /schemas/types.yaml#/definitions/phandle-array
116 description: State bits used in by the AP to signal the modem.
118 - description: Whether the "ipa-clock-enabled" state bit is valid
119 - description: Whether the IPA clock is enabled (if valid)
121 qcom,smem-state-names:
122 description: The names of the state bits used for SMP2P output
124 - const: ipa-clock-enabled-valid
125 - const: ipa-clock-enabled
130 If present, it indicates that the modem is responsible for
131 performing early IPA initialization, including loading and
132 validating firwmare used by the GSI.
137 If present, a phandle for a reserved memory area that holds
138 the firmware passed to Trust Zone for authentication. Required
139 when Trust Zone (not the modem) performs early initialization.
142 $ref: /schemas/types.yaml#/definitions/string
144 If present, name (or relative path) of the file within the
145 firmware search path containing the firmware image used when
146 initializing IPA hardware. Optional, and only used when
147 Trust Zone performs early initialization.
158 # Either modem-init is present, or memory-region must be present.
165 # If memory-region is present, firmware-name may optionally be present.
166 # But if modem-init is present, firmware-name must not be present.
175 additionalProperties: false
179 #include <dt-bindings/interrupt-controller/arm-gic.h>
180 #include <dt-bindings/clock/qcom,rpmh.h>
181 #include <dt-bindings/interconnect/qcom,sdm845.h>
184 compatible = "qcom,smp2p";
185 interrupts = <GIC_SPI 576 IRQ_TYPE_EDGE_RISING>;
186 mboxes = <&apss_shared 6>;
187 qcom,smem = <94>, <432>;
188 qcom,local-pid = <0>;
189 qcom,remote-pid = <5>;
191 ipa_smp2p_out: ipa-ap-to-modem {
192 qcom,entry-name = "ipa";
193 #qcom,smem-state-cells = <1>;
196 ipa_smp2p_in: ipa-modem-to-ap {
197 qcom,entry-name = "ipa";
198 interrupt-controller;
199 #interrupt-cells = <2>;
204 compatible = "qcom,sdm845-ipa";
208 iommus = <&apps_smmu 0x720 0x3>;
209 reg = <0x1e40000 0x7000>,
212 reg-names = "ipa-reg",
216 interrupts-extended = <&intc GIC_SPI 311 IRQ_TYPE_EDGE_RISING>,
217 <&intc GIC_SPI 432 IRQ_TYPE_LEVEL_HIGH>,
218 <&ipa_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
219 <&ipa_smp2p_in 1 IRQ_TYPE_EDGE_RISING>;
220 interrupt-names = "ipa",
225 clocks = <&rpmhcc RPMH_IPA_CLK>;
226 clock-names = "core";
229 <&rsc_hlos MASTER_IPA &rsc_hlos SLAVE_EBI1>,
230 <&rsc_hlos MASTER_IPA &rsc_hlos SLAVE_IMEM>,
231 <&rsc_hlos MASTER_APPSS_PROC &rsc_hlos SLAVE_IPA_CFG>;
232 interconnect-names = "memory",
236 qcom,qmp = <&aoss_qmp>;
238 qcom,smem-states = <&ipa_smp2p_out 0>,
240 qcom,smem-state-names = "ipa-clock-enabled-valid",