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 -------- | | | | ---------
46 const: "qcom,sdm845-ipa"
50 - description: IPA registers
51 - description: IPA shared memory
52 - description: GSI registers
71 - description: IPA interrupt (hardware IRQ)
72 - description: GSI interrupt (hardware IRQ)
73 - description: Modem clock query interrupt (smp2p interrupt)
74 - description: Modem setup ready interrupt (smp2p interrupt)
80 - const: ipa-clock-query
81 - const: ipa-setup-ready
85 - description: Interconnect path between IPA and main memory
86 - description: Interconnect path between IPA and internal memory
87 - description: Interconnect path between IPA and the AP subsystem
96 $ref: /schemas/types.yaml#/definitions/phandle-array
97 description: State bits used in by the AP to signal the modem.
99 - description: Whether the "ipa-clock-enabled" state bit is valid
100 - description: Whether the IPA clock is enabled (if valid)
102 qcom,smem-state-names:
103 $ref: /schemas/types.yaml#/definitions/string-array
104 description: The names of the state bits used for SMP2P output
106 - const: ipa-clock-enabled-valid
107 - const: ipa-clock-enabled
112 If present, it indicates that the modem is responsible for
113 performing early IPA initialization, including loading and
114 validating firwmare used by the GSI.
117 $ref: /schemas/types.yaml#definitions/phandle
119 This defines the phandle to the remoteproc node representing
120 the modem subsystem. This is requied so the IPA driver can
121 receive and act on notifications of modem up/down events.
124 $ref: /schemas/types.yaml#/definitions/phandle-array
127 If present, a phandle for a reserved memory area that holds
128 the firmware passed to Trust Zone for authentication. Required
129 when Trust Zone (not the modem) performs early initialization.
147 additionalProperties: false
151 #include <dt-bindings/interrupt-controller/irq.h>
152 #include <dt-bindings/clock/qcom,rpmh.h>
153 #include <dt-bindings/interconnect/qcom,sdm845.h>
156 compatible = "qcom,smp2p";
157 ipa_smp2p_out: ipa-ap-to-modem {
158 qcom,entry-name = "ipa";
159 #qcom,smem-state-cells = <1>;
162 ipa_smp2p_in: ipa-modem-to-ap {
163 qcom,entry-name = "ipa";
164 interrupt-controller;
165 #interrupt-cells = <2>;
169 compatible = "qcom,sdm845-ipa";
172 modem-remoteproc = <&mss_pil>;
174 iommus = <&apps_smmu 0x720 0x3>;
175 reg = <0x1e40000 0x7000>,
178 reg-names = "ipa-reg",
182 interrupts-extended = <&intc 0 311 IRQ_TYPE_EDGE_RISING>,
183 <&intc 0 432 IRQ_TYPE_LEVEL_HIGH>,
184 <&ipa_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
185 <&ipa_smp2p_in 1 IRQ_TYPE_EDGE_RISING>;
186 interrupt-names = "ipa",
191 clocks = <&rpmhcc RPMH_IPA_CLK>;
192 clock-names = "core";
195 <&rsc_hlos MASTER_IPA &rsc_hlos SLAVE_EBI1>,
196 <&rsc_hlos MASTER_IPA &rsc_hlos SLAVE_IMEM>,
197 <&rsc_hlos MASTER_APPSS_PROC &rsc_hlos SLAVE_IPA_CFG>;
198 interconnect-names = "memory",
202 qcom,smem-states = <&ipa_smp2p_out 0>,
204 qcom,smem-state-names = "ipa-clock-enabled-valid",