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
77 - description: IPA interrupt (hardware IRQ)
78 - description: GSI interrupt (hardware IRQ)
79 - description: Modem clock query interrupt (smp2p interrupt)
80 - description: Modem setup ready interrupt (smp2p interrupt)
86 - const: ipa-clock-query
87 - const: ipa-setup-ready
91 - description: Interconnect path between IPA and main memory
92 - description: Interconnect path between IPA and internal memory
93 - description: Interconnect path between IPA and the AP subsystem
102 $ref: /schemas/types.yaml#/definitions/phandle-array
103 description: State bits used in by the AP to signal the modem.
105 - description: Whether the "ipa-clock-enabled" state bit is valid
106 - description: Whether the IPA clock is enabled (if valid)
108 qcom,smem-state-names:
109 description: The names of the state bits used for SMP2P output
111 - const: ipa-clock-enabled-valid
112 - const: ipa-clock-enabled
117 If present, it indicates that the modem is responsible for
118 performing early IPA initialization, including loading and
119 validating firwmare used by the GSI.
124 If present, a phandle for a reserved memory area that holds
125 the firmware passed to Trust Zone for authentication. Required
126 when Trust Zone (not the modem) performs early initialization.
129 $ref: /schemas/types.yaml#/definitions/string
131 If present, name (or relative path) of the file within the
132 firmware search path containing the firmware image used when
133 initializing IPA hardware. Optional, and only used when
134 Trust Zone performs early initialization.
145 # Either modem-init is present, or memory-region must be present.
152 # If memory-region is present, firmware-name may optionally be present.
153 # But if modem-init is present, firmware-name must not be present.
162 additionalProperties: false
166 #include <dt-bindings/interrupt-controller/arm-gic.h>
167 #include <dt-bindings/clock/qcom,rpmh.h>
168 #include <dt-bindings/interconnect/qcom,sdm845.h>
171 compatible = "qcom,smp2p";
172 ipa_smp2p_out: ipa-ap-to-modem {
173 qcom,entry-name = "ipa";
174 #qcom,smem-state-cells = <1>;
177 ipa_smp2p_in: ipa-modem-to-ap {
178 qcom,entry-name = "ipa";
179 interrupt-controller;
180 #interrupt-cells = <2>;
184 compatible = "qcom,sdm845-ipa";
188 iommus = <&apps_smmu 0x720 0x3>;
189 reg = <0x1e40000 0x7000>,
192 reg-names = "ipa-reg",
196 interrupts-extended = <&intc GIC_SPI 311 IRQ_TYPE_EDGE_RISING>,
197 <&intc GIC_SPI 432 IRQ_TYPE_LEVEL_HIGH>,
198 <&ipa_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
199 <&ipa_smp2p_in 1 IRQ_TYPE_EDGE_RISING>;
200 interrupt-names = "ipa",
205 clocks = <&rpmhcc RPMH_IPA_CLK>;
206 clock-names = "core";
209 <&rsc_hlos MASTER_IPA &rsc_hlos SLAVE_EBI1>,
210 <&rsc_hlos MASTER_IPA &rsc_hlos SLAVE_IMEM>,
211 <&rsc_hlos MASTER_APPSS_PROC &rsc_hlos SLAVE_IPA_CFG>;
212 interconnect-names = "memory",
216 qcom,smem-states = <&ipa_smp2p_out 0>,
218 qcom,smem-state-names = "ipa-clock-enabled-valid",