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
92 - description: Path leading to system memory
93 - description: Path between the AP and IPA config space
95 - description: Path leading to system memory
96 - description: Path leading to internal memory
97 - description: Path between the AP and IPA config space
110 $ref: /schemas/types.yaml#/definitions/phandle-array
111 description: State bits used in by the AP to signal the modem.
113 - description: Whether the "ipa-clock-enabled" state bit is valid
114 - description: Whether the IPA clock is enabled (if valid)
116 qcom,smem-state-names:
117 description: The names of the state bits used for SMP2P output
119 - const: ipa-clock-enabled-valid
120 - const: ipa-clock-enabled
125 If present, it indicates that the modem is responsible for
126 performing early IPA initialization, including loading and
127 validating firwmare used by the GSI.
132 If present, a phandle for a reserved memory area that holds
133 the firmware passed to Trust Zone for authentication. Required
134 when Trust Zone (not the modem) performs early initialization.
137 $ref: /schemas/types.yaml#/definitions/string
139 If present, name (or relative path) of the file within the
140 firmware search path containing the firmware image used when
141 initializing IPA hardware. Optional, and only used when
142 Trust Zone performs early initialization.
153 # Either modem-init is present, or memory-region must be present.
160 # If memory-region is present, firmware-name may optionally be present.
161 # But if modem-init is present, firmware-name must not be present.
170 additionalProperties: false
174 #include <dt-bindings/interrupt-controller/arm-gic.h>
175 #include <dt-bindings/clock/qcom,rpmh.h>
176 #include <dt-bindings/interconnect/qcom,sdm845.h>
179 compatible = "qcom,smp2p";
180 ipa_smp2p_out: ipa-ap-to-modem {
181 qcom,entry-name = "ipa";
182 #qcom,smem-state-cells = <1>;
185 ipa_smp2p_in: ipa-modem-to-ap {
186 qcom,entry-name = "ipa";
187 interrupt-controller;
188 #interrupt-cells = <2>;
192 compatible = "qcom,sdm845-ipa";
196 iommus = <&apps_smmu 0x720 0x3>;
197 reg = <0x1e40000 0x7000>,
200 reg-names = "ipa-reg",
204 interrupts-extended = <&intc GIC_SPI 311 IRQ_TYPE_EDGE_RISING>,
205 <&intc GIC_SPI 432 IRQ_TYPE_LEVEL_HIGH>,
206 <&ipa_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
207 <&ipa_smp2p_in 1 IRQ_TYPE_EDGE_RISING>;
208 interrupt-names = "ipa",
213 clocks = <&rpmhcc RPMH_IPA_CLK>;
214 clock-names = "core";
217 <&rsc_hlos MASTER_IPA &rsc_hlos SLAVE_EBI1>,
218 <&rsc_hlos MASTER_IPA &rsc_hlos SLAVE_IMEM>,
219 <&rsc_hlos MASTER_APPSS_PROC &rsc_hlos SLAVE_IPA_CFG>;
220 interconnect-names = "memory",
224 qcom,smem-states = <&ipa_smp2p_out 0>,
226 qcom,smem-state-names = "ipa-clock-enabled-valid",