1 Qualcomm Hexagon Peripheral Image Loader
3 This document defines the binding for a component that loads and boots firmware
4 on the Qualcomm Hexagon core.
9 Definition: must be one of:
11 "qcom,ipq8074-wcss-pil"
12 "qcom,msm8916-mss-pil",
13 "qcom,msm8974-mss-pil"
14 "qcom,msm8996-mss-pil"
15 "qcom,msm8998-mss-pil"
21 Value type: <prop-encoded-array>
22 Definition: must specify the base address and size of the qdsp6 and
27 Value type: <stringlist>
28 Definition: must be "q6dsp" and "rmb"
30 - interrupts-extended:
32 Value type: <prop-encoded-array>
33 Definition: reference to the interrupts that match interrupt-names
37 Value type: <stringlist>
38 Definition: The interrupts needed depends on the the compatible
41 qcom,ipq8074-wcss-pil:
44 must be "wdog", "fatal", "ready", "handover", "stop-ack"
49 must be "wdog", "fatal", "ready", "handover", "stop-ack",
54 Value type: <stringlist>
55 Definition: must list the relative firmware image paths for mba and
56 modem. They are used for booting and authenticating the
62 Definition: reference to the clocks that match clock-names
66 Value type: <stringlist>
67 Definition: The clocks needed depend on the compatible string:
68 qcom,ipq8074-wcss-pil:
69 no clock names required
73 must be "iface", "bus", "mem", "xo"
75 must be "iface", "bus", "mem", "xo", "gpll0_mss",
76 "snoc_axi", "mnoc_axi", "pnoc", "qdss"
78 must be "iface", "bus", "mem", "xo", "gpll0_mss",
79 "snoc_axi", "mnoc_axi", "qdss"
81 must be "iface", "bus", "xo", "snoc_axi", "mnoc_axi",
84 must be "iface", "bus", "mem", "xo", "gpll0_mss",
85 "snoc_axi", "mnoc_axi", "prng"
90 Definition: reference to the reset-controller for the modem sub-system
91 reference to the list of 3 reset-controllers for the
93 reference to the list of 2 reset-controllers for the modem
94 sub-system on SC7180, SDM845 SoCs
98 Value type: <stringlist>
99 Definition: must be "mss_restart" for the modem sub-system
100 must be "wcss_aon_reset", "wcss_reset", "wcss_q6_reset"
101 for the wcss sub-system
102 must be "mss_restart", "pdc_reset" for the modem
103 sub-system on SC7180, SDM845 SoCs
105 For devices where the mba and mpss sub-nodes are not specified, mba/mpss region
106 should be referenced as follows:
109 Value type: <phandle>
110 Definition: reference to the reserved-memory for the mba region followed
113 For the compatible strings below the following supplies are required:
115 "qcom,msm8916-mss-pil",
120 Value type: <phandle>
121 Definition: reference to the regulators to be held on behalf of the
122 booting of the Hexagon core
124 For the compatible string below the following supplies are required:
125 "qcom,msm8974-mss-pil"
131 Value type: <phandle>
132 Definition: reference to the regulators to be held on behalf of the
133 booting of the Hexagon core
135 For the compatible string below the following supplies are required:
136 "qcom,msm8996-mss-pil"
139 Value type: <phandle>
140 Definition: reference to the regulators to be held on behalf of the
141 booting of the Hexagon core
145 Value type: <phandle>
146 Definition: reference to power-domains that match power-domain-names
148 - power-domain-names:
150 Value type: <stringlist>
151 Definition: The power-domains needed depend on the compatible string:
153 qcom,ipq8074-wcss-pil:
154 qcom,msm8916-mss-pil:
155 qcom,msm8974-mss-pil:
156 no power-domain names required
157 qcom,msm8996-mss-pil:
158 qcom,msm8998-mss-pil:
162 must be "cx", "mx", "mss", "load_state"
166 Value type: <phandle>
167 Definition: reference to the smem state for requesting the Hexagon to
170 - qcom,smem-state-names:
172 Value type: <stringlist>
173 Definition: must be "stop"
177 Value type: <prop-encoded-array>
178 Definition: a phandle reference to a syscon representing TCSR followed
179 by the three offsets within syscon for q6, modem and nc
182 For the compatible strings below the following phandle references are required:
183 "qcom,sc7180-mss-pil"
186 Value type: <prop-encoded-array>
187 Definition: a phandle reference to a syscon representing TCSR followed
188 by the offset within syscon for conn_box_spare0 register
189 used by the modem sub-system running on SC7180 SoC.
191 The Hexagon node must contain iommus property as described in ../iommu/iommu.txt
192 on platforms which do not have TrustZone.
195 The Hexagon node must contain two subnodes, named "mba" and "mpss" representing
196 the memory regions used by the Hexagon firmware. Each sub-node must contain:
200 Value type: <phandle>
201 Definition: reference to the reserved-memory for the region
203 The Hexagon node may also have an subnode named either "smd-edge" or
204 "glink-edge" that describes the communication edge, channels and devices
205 related to the Hexagon. See ../soc/qcom/qcom,smd.txt and
206 ../soc/qcom/qcom,glink.txt for details on how to describe these.
209 The following example describes the resources needed to boot control the
210 Hexagon, as it is found on MSM8974 boards.
212 modem-rproc@fc880000 {
213 compatible = "qcom,q6v5-pil";
214 reg = <0xfc880000 0x100>,
216 reg-names = "qdsp6", "rmb";
218 interrupts-extended = <&intc 0 24 1>,
219 <&modem_smp2p_in 0 0>,
220 <&modem_smp2p_in 1 0>,
221 <&modem_smp2p_in 2 0>,
222 <&modem_smp2p_in 3 0>;
223 interrupt-names = "wdog",
229 clocks = <&gcc GCC_MSS_Q6_BIMC_AXI_CLK>,
230 <&gcc GCC_MSS_CFG_AHB_CLK>,
231 <&gcc GCC_BOOT_ROM_AHB_CLK>;
232 clock-names = "iface", "bus", "mem";
234 qcom,halt-regs = <&tcsr_mutex_block 0x1180 0x1200 0x1280>;
236 resets = <&gcc GCC_MSS_RESTART>;
237 reset-names = "mss_restart";
239 cx-supply = <&pm8841_s2>;
240 mss-supply = <&pm8841_s3>;
241 mx-supply = <&pm8841_s1>;
242 pll-supply = <&pm8941_l12>;
244 qcom,smem-states = <&modem_smp2p_out 0>;
245 qcom,smem-state-names = "stop";
248 memory-region = <&mba_region>;
252 memory-region = <&mpss_region>;