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,qcs404-wcss-pil"
13 "qcom,msm8916-mss-pil",
14 "qcom,msm8974-mss-pil"
15 "qcom,msm8996-mss-pil"
16 "qcom,msm8998-mss-pil"
22 Value type: <prop-encoded-array>
23 Definition: must specify the base address and size of the qdsp6 and
28 Value type: <stringlist>
29 Definition: must be "q6dsp" and "rmb"
31 - interrupts-extended:
33 Value type: <prop-encoded-array>
34 Definition: reference to the interrupts that match interrupt-names
38 Value type: <stringlist>
39 Definition: The interrupts needed depends on the the compatible
42 qcom,ipq8074-wcss-pil:
46 must be "wdog", "fatal", "ready", "handover", "stop-ack"
51 must be "wdog", "fatal", "ready", "handover", "stop-ack",
56 Value type: <stringlist>
57 Definition: must list the relative firmware image paths for mba and
58 modem. They are used for booting and authenticating the
64 Definition: reference to the clocks that match clock-names
68 Value type: <stringlist>
69 Definition: The clocks needed depend on the compatible string:
70 qcom,ipq8074-wcss-pil:
71 no clock names required
73 must be "xo", "gcc_abhs_cbcr", "gcc_abhs_cbcr",
74 "gcc_axim_cbcr", "lcc_ahbfabric_cbc", "tcsr_lcc_cbc",
75 "lcc_abhs_cbc", "lcc_tcm_slave_cbc", "lcc_abhm_cbc",
76 "lcc_axim_cbc", "lcc_bcr_sleep"
80 must be "iface", "bus", "mem", "xo"
82 must be "iface", "bus", "mem", "xo", "gpll0_mss",
83 "snoc_axi", "mnoc_axi", "pnoc", "qdss"
85 must be "iface", "bus", "mem", "xo", "gpll0_mss",
86 "snoc_axi", "mnoc_axi", "qdss"
88 must be "iface", "bus", "xo", "snoc_axi", "mnoc_axi",
91 must be "iface", "bus", "mem", "xo", "gpll0_mss",
92 "snoc_axi", "mnoc_axi", "prng"
97 Definition: reference to the reset-controller for the modem sub-system
98 reference to the list of 3 reset-controllers for the
100 reference to the list of 2 reset-controllers for the modem
101 sub-system on SC7180, SDM845 SoCs
105 Value type: <stringlist>
106 Definition: must be "mss_restart" for the modem sub-system
107 must be "wcss_aon_reset", "wcss_reset", "wcss_q6_reset"
108 for the wcss sub-system
109 must be "mss_restart", "pdc_reset" for the modem
110 sub-system on SC7180, SDM845 SoCs
112 For devices where the mba and mpss sub-nodes are not specified, mba/mpss region
113 should be referenced as follows:
116 Value type: <phandle>
117 Definition: reference to the reserved-memory for the mba region followed
120 For the compatible strings below the following supplies are required:
122 "qcom,msm8916-mss-pil",
123 - cx-supply: (deprecated, use power domain instead)
124 - mx-supply: (deprecated, use power domain instead)
127 Value type: <phandle>
128 Definition: reference to the regulators to be held on behalf of the
129 booting of the Hexagon core
131 For the compatible string below the following supplies are required:
132 "qcom,msm8974-mss-pil"
133 - cx-supply: (deprecated, use power domain instead)
135 - mx-supply: (deprecated, use power domain instead)
138 Value type: <phandle>
139 Definition: reference to the regulators to be held on behalf of the
140 booting of the Hexagon core
142 For the compatible string below the following supplies are required:
143 "qcom,qcs404-wcss-pil"
146 Value type: <phandle>
147 Definition: reference to the regulators to be held on behalf of the
148 booting of the Hexagon core
150 For the compatible string below the following supplies are required:
151 "qcom,msm8996-mss-pil"
154 Value type: <phandle>
155 Definition: reference to the regulators to be held on behalf of the
156 booting of the Hexagon core
160 Value type: <phandle>
161 Definition: reference to power-domains that match power-domain-names
163 - power-domain-names:
165 Value type: <stringlist>
166 Definition: The power-domains needed depend on the compatible string:
167 qcom,ipq8074-wcss-pil:
168 no power-domain names required
170 qcom,msm8916-mss-pil:
171 qcom,msm8974-mss-pil:
172 qcom,msm8996-mss-pil:
173 qcom,msm8998-mss-pil:
177 must be "cx", "mx", "mss", "load_state"
181 Value type: <phandle>
182 Definition: reference to the smem state for requesting the Hexagon to
185 - qcom,smem-state-names:
187 Value type: <stringlist>
188 Definition: must be "stop"
192 Value type: <prop-encoded-array>
193 Definition: a phandle reference to a syscon representing TCSR followed
194 by the three offsets within syscon for q6, modem and nc
197 For the compatible strings below the following phandle references are required:
198 "qcom,sc7180-mss-pil"
201 Value type: <prop-encoded-array>
202 Definition: a phandle reference to a syscon representing TCSR followed
203 by the offset within syscon for conn_box_spare0 register
204 used by the modem sub-system running on SC7180 SoC.
206 The Hexagon node must contain iommus property as described in ../iommu/iommu.txt
207 on platforms which do not have TrustZone.
210 The Hexagon node must contain two subnodes, named "mba" and "mpss" representing
211 the memory regions used by the Hexagon firmware. Each sub-node must contain:
215 Value type: <phandle>
216 Definition: reference to the reserved-memory for the region
218 The Hexagon node may also have an subnode named either "smd-edge" or
219 "glink-edge" that describes the communication edge, channels and devices
220 related to the Hexagon. See ../soc/qcom/qcom,smd.txt and
221 ../soc/qcom/qcom,glink.txt for details on how to describe these.
224 The following example describes the resources needed to boot control the
225 Hexagon, as it is found on MSM8974 boards.
227 modem-rproc@fc880000 {
228 compatible = "qcom,q6v5-pil";
229 reg = <0xfc880000 0x100>,
231 reg-names = "qdsp6", "rmb";
233 interrupts-extended = <&intc 0 24 1>,
234 <&modem_smp2p_in 0 0>,
235 <&modem_smp2p_in 1 0>,
236 <&modem_smp2p_in 2 0>,
237 <&modem_smp2p_in 3 0>;
238 interrupt-names = "wdog",
244 clocks = <&gcc GCC_MSS_Q6_BIMC_AXI_CLK>,
245 <&gcc GCC_MSS_CFG_AHB_CLK>,
246 <&gcc GCC_BOOT_ROM_AHB_CLK>;
247 clock-names = "iface", "bus", "mem";
249 qcom,halt-regs = <&tcsr_mutex_block 0x1180 0x1200 0x1280>;
251 resets = <&gcc GCC_MSS_RESTART>;
252 reset-names = "mss_restart";
254 cx-supply = <&pm8841_s2>;
255 mss-supply = <&pm8841_s3>;
256 mx-supply = <&pm8841_s1>;
257 pll-supply = <&pm8941_l12>;
259 qcom,smem-states = <&modem_smp2p_out 0>;
260 qcom,smem-state-names = "stop";
263 memory-region = <&mba_region>;
267 memory-region = <&mpss_region>;