Documentation/devicetree/bindings/remoteproc/qcom,adsp.txt

   1 Qualcomm ADSP Peripheral Image Loader
   2
   3 This document defines the binding for a component that loads and boots firmware
   4 on the Qualcomm ADSP Hexagon core.
   5
   6 - compatible:
   7         Usage: required
   8         Value type: <string>
   9         Definition: must be one of:
  10                     "qcom,msm8974-adsp-pil"
  11                     "qcom,msm8996-adsp-pil"
  12                     "qcom,msm8996-slpi-pil"
  13                     "qcom,qcs404-adsp-pas"
  14                     "qcom,qcs404-cdsp-pas"
  15                     "qcom,qcs404-wcss-pas"
  16                     "qcom,sdm845-adsp-pas"
  17                     "qcom,sdm845-cdsp-pas"
  18
  19 - interrupts-extended:
  20         Usage: required
  21         Value type: <prop-encoded-array>
  22         Definition: reference to the interrupts that match interrupt-names
  23
  24 - interrupt-names:
  25         Usage: required
  26         Value type: <stringlist>
  27         Definition: The interrupts needed depends on the compatible
  28                     string:
  29         qcom,msm8974-adsp-pil:
  30         qcom,msm8996-adsp-pil:
  31         qcom,msm8996-slpi-pil:
  32         qcom,qcs404-adsp-pas:
  33         qcom,qcs404-cdsp-pas:
  34         qcom,sdm845-adsp-pas:
  35         qcom,sdm845-cdsp-pas:
  36                     must be "wdog", "fatal", "ready", "handover", "stop-ack"
  37         qcom,qcs404-wcss-pas:
  38                     must be "wdog", "fatal", "ready", "handover", "stop-ack",
  39                     "shutdown-ack"
  40
  41 - firmware-name:
  42         Usage: optional
  43         Value type: <string>
  44         Definition: must list the relative firmware image path for the
  45                     Hexagon Core.
  46
  47 - clocks:
  48         Usage: required
  49         Value type: <prop-encoded-array>
  50         Definition: reference to the xo clock and optionally aggre2 clock to be
  51                     held on behalf of the booting Hexagon core
  52
  53 - clock-names:
  54         Usage: required
  55         Value type: <stringlist>
  56         Definition: must be "xo" and optionally include "aggre2"
  57
  58 - cx-supply:
  59         Usage: required
  60         Value type: <phandle>
  61         Definition: reference to the regulator to be held on behalf of the
  62                     booting Hexagon core
  63
  64 - px-supply:
  65         Usage: required
  66         Value type: <phandle>
  67         Definition: reference to the px regulator to be held on behalf of the
  68                     booting Hexagon core
  69
  70 - memory-region:
  71         Usage: required
  72         Value type: <phandle>
  73         Definition: reference to the reserved-memory for the ADSP
  74
  75 - qcom,smem-states:
  76         Usage: required
  77         Value type: <phandle>
  78         Definition: reference to the smem state for requesting the ADSP to
  79                     shut down
  80
  81 - qcom,smem-state-names:
  82         Usage: required
  83         Value type: <stringlist>
  84         Definition: must be "stop"
  85
  86
  87 = SUBNODES
  88 The adsp node may have an subnode named either "smd-edge" or "glink-edge" that
  89 describes the communication edge, channels and devices related to the ADSP.
  90 See ../soc/qcom/qcom,smd.txt and ../soc/qcom/qcom,glink.txt for details on how
  91 to describe these.
  92
  93
  94 = EXAMPLE
  95 The following example describes the resources needed to boot control the
  96 ADSP, as it is found on MSM8974 boards.
  97
  98         adsp {
  99                 compatible = "qcom,msm8974-adsp-pil";
 100
 101                 interrupts-extended = <&intc 0 162 IRQ_TYPE_EDGE_RISING>,
 102                                       <&adsp_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
 103                                       <&adsp_smp2p_in 1 IRQ_TYPE_EDGE_RISING>,
 104                                       <&adsp_smp2p_in 2 IRQ_TYPE_EDGE_RISING>,
 105                                       <&adsp_smp2p_in 3 IRQ_TYPE_EDGE_RISING>;
 106                 interrupt-names = "wdog",
 107                                   "fatal",
 108                                   "ready",
 109                                   "handover",
 110                                   "stop-ack";
 111
 112                 clocks = <&rpmcc RPM_CXO_CLK>;
 113                 clock-names = "xo";
 114
 115                 cx-supply = <&pm8841_s2>;
 116
 117                 memory-region = <&adsp_region>;
 118
 119                 qcom,smem-states = <&adsp_smp2p_out 0>;
 120                 qcom,smem-state-names = "stop";
 121
 122                 smd-edge {
 123                         interrupts = <0 156 IRQ_TYPE_EDGE_RISING>;
 124
 125                         qcom,ipc = <&apcs 8 8>;
 126                         qcom,smd-edge = <1>;
 127                 };
 128         };
 129
 130 The following example describes the resources needed to boot control the
 131 SLPI, as it is found on MSM8996 boards.
 132
 133         slpi {
 134                 compatible = "qcom,msm8996-slpi-pil";
 135                 interrupts-extended = <&intc 0 390 IRQ_TYPE_EDGE_RISING>,
 136                                       <&slpi_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
 137                                       <&slpi_smp2p_in 1 IRQ_TYPE_EDGE_RISING>,
 138                                       <&slpi_smp2p_in 2 IRQ_TYPE_EDGE_RISING>,
 139                                       <&slpi_smp2p_in 3 IRQ_TYPE_EDGE_RISING>;
 140                 interrupt-names = "wdog",
 141                                   "fatal",
 142                                   "ready",
 143                                   "handover",
 144                                   "stop-ack";
 145
 146                 clocks = <&rpmcc MSM8996_RPM_SMD_XO_CLK_SRC>,
 147                          <&rpmcc MSM8996_RPM_SMD_AGGR2_NOC_CLK>;
 148                 clock-names = "xo", "aggre2";
 149
 150                 cx-supply = <&pm8994_l26>;
 151                 px-supply = <&pm8994_lvs2>;
 152
 153                 memory-region = <&slpi_region>;
 154                 qcom,smem-states = <&slpi_smp2p_out 0>;
 155                 qcom,smem-state-names = "stop";
 156         };