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: must list the watchdog, fatal IRQs ready, handover and
  23                     stop-ack IRQs
  24
  25 - interrupt-names:
  26         Usage: required
  27         Value type: <stringlist>
  28         Definition: must be "wdog", "fatal", "ready", "handover", "stop-ack"
  29
  30 - clocks:
  31         Usage: required
  32         Value type: <prop-encoded-array>
  33         Definition: reference to the xo clock and optionally aggre2 clock to be
  34                     held on behalf of the booting Hexagon core
  35
  36 - clock-names:
  37         Usage: required
  38         Value type: <stringlist>
  39         Definition: must be "xo" and optionally include "aggre2"
  40
  41 - cx-supply:
  42         Usage: required
  43         Value type: <phandle>
  44         Definition: reference to the regulator to be held on behalf of the
  45                     booting Hexagon core
  46
  47 - px-supply:
  48         Usage: required
  49         Value type: <phandle>
  50         Definition: reference to the px regulator to be held on behalf of the
  51                     booting Hexagon core
  52
  53 - memory-region:
  54         Usage: required
  55         Value type: <phandle>
  56         Definition: reference to the reserved-memory for the ADSP
  57
  58 - qcom,smem-states:
  59         Usage: required
  60         Value type: <phandle>
  61         Definition: reference to the smem state for requesting the ADSP to
  62                     shut down
  63
  64 - qcom,smem-state-names:
  65         Usage: required
  66         Value type: <stringlist>
  67         Definition: must be "stop"
  68
  69
  70 = SUBNODES
  71 The adsp node may have an subnode named either "smd-edge" or "glink-edge" that
  72 describes the communication edge, channels and devices related to the ADSP.
  73 See ../soc/qcom/qcom,smd.txt and ../soc/qcom/qcom,glink.txt for details on how
  74 to describe these.
  75
  76
  77 = EXAMPLE
  78 The following example describes the resources needed to boot control the
  79 ADSP, as it is found on MSM8974 boards.
  80
  81         adsp {
  82                 compatible = "qcom,msm8974-adsp-pil";
  83
  84                 interrupts-extended = <&intc 0 162 IRQ_TYPE_EDGE_RISING>,
  85                                       <&adsp_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
  86                                       <&adsp_smp2p_in 1 IRQ_TYPE_EDGE_RISING>,
  87                                       <&adsp_smp2p_in 2 IRQ_TYPE_EDGE_RISING>,
  88                                       <&adsp_smp2p_in 3 IRQ_TYPE_EDGE_RISING>;
  89                 interrupt-names = "wdog",
  90                                   "fatal",
  91                                   "ready",
  92                                   "handover",
  93                                   "stop-ack";
  94
  95                 clocks = <&rpmcc RPM_CXO_CLK>;
  96                 clock-names = "xo";
  97
  98                 cx-supply = <&pm8841_s2>;
  99
 100                 memory-region = <&adsp_region>;
 101
 102                 qcom,smem-states = <&adsp_smp2p_out 0>;
 103                 qcom,smem-state-names = "stop";
 104
 105                 smd-edge {
 106                         interrupts = <0 156 IRQ_TYPE_EDGE_RISING>;
 107
 108                         qcom,ipc = <&apcs 8 8>;
 109                         qcom,smd-edge = <1>;
 110                 };
 111         };
 112
 113 The following example describes the resources needed to boot control the
 114 SLPI, as it is found on MSM8996 boards.
 115
 116         slpi {
 117                 compatible = "qcom,msm8996-slpi-pil";
 118                 interrupts-extended = <&intc 0 390 IRQ_TYPE_EDGE_RISING>,
 119                                       <&slpi_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
 120                                       <&slpi_smp2p_in 1 IRQ_TYPE_EDGE_RISING>,
 121                                       <&slpi_smp2p_in 2 IRQ_TYPE_EDGE_RISING>,
 122                                       <&slpi_smp2p_in 3 IRQ_TYPE_EDGE_RISING>;
 123                 interrupt-names = "wdog",
 124                                   "fatal",
 125                                   "ready",
 126                                   "handover",
 127                                   "stop-ack";
 128
 129                 clocks = <&rpmcc MSM8996_RPM_SMD_XO_CLK_SRC>,
 130                          <&rpmcc MSM8996_RPM_SMD_AGGR2_NOC_CLK>;
 131                 clock-names = "xo", "aggre2";
 132
 133                 cx-supply = <&pm8994_l26>;
 134                 px-supply = <&pm8994_lvs2>;
 135
 136                 memory-region = <&slpi_region>;
 137                 qcom,smem-states = <&slpi_smp2p_out 0>;
 138                 qcom,smem-state-names = "stop";
 139         };