# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/remoteproc/qcom,shikra-pas.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Qualcomm Shikra SoC Peripheral Authentication Service

maintainers:
  - Bibek Kumar Patro <bibek.patro@oss.qualcomm.com>
  - Komal Bajaj <komal.bajaj@oss.qualcomm.com>

description:
  Qualcomm Shikra SoC Peripheral Authentication Service loads and boots
  firmware on the Qualcomm DSP Hexagon cores.

properties:
  compatible:
    enum:
      - qcom,shikra-cdsp-pas
      - qcom,shikra-lpaicp-pas
      - qcom,shikra-mpss-pas

  reg:
    maxItems: 1

  clocks:
    items:
      - description: XO clock

  clock-names:
    items:
      - const: xo

  memory-region:
    minItems: 1
    maxItems: 2

  smd-edge: false

  firmware-name:
    minItems: 1
    items:
      - description: Firmware name of the Hexagon core
      - description: Firmware name of the Hexagon Devicetree

  glink-edge:
    $ref: /schemas/remoteproc/qcom,glink-edge.yaml#
    description:
      Qualcomm G-Link subnode which represents communication edge, channels
      and devices related to the remoteproc core.
    unevaluatedProperties: false

  qcom,smem-states:
    $ref: /schemas/types.yaml#/definitions/phandle-array
    description: States used by the AP to signal the Hexagon core
    items:
      - description: Stop the remote processor
        items:
          - description: Phandle to the Shared Memory Point 2 Point device
              handling the communication with a remote processor
          - description: Single bit index to toggle in the value sent to
              the remote processor
            maximum: 32

  qcom,smem-state-names:
    description: The names of the state bits used for SMP2P output
    items:
      - const: stop

required:
  - compatible
  - reg
  - memory-region

allOf:
  - $ref: /schemas/remoteproc/qcom,pas-common.yaml#

  - if:
      properties:
        compatible:
          enum:
            - qcom,shikra-cdsp-pas
            - qcom,shikra-mpss-pas
    then:
      properties:
        interrupts:
          minItems: 6
        interrupt-names:
          minItems: 6
        memory-region:
          maxItems: 1
        firmware-name:
          maxItems: 1
        power-domains:
          items:
            - description: CX power domain
        power-domain-names:
          items:
            - const: cx

  - if:
      properties:
        compatible:
          enum:
            - qcom,shikra-lpaicp-pas
    then:
      properties:
        interrupts:
          maxItems: 5
        interrupt-names:
          maxItems: 5
        memory-region:
          minItems: 2
        firmware-name:
          minItems: 2
        power-domains: false
        power-domain-names: false

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/clock/qcom,rpmcc.h>
    #include <dt-bindings/interconnect/qcom,icc.h>
    #include <dt-bindings/interconnect/qcom,rpm-icc.h>
    #include <dt-bindings/interconnect/qcom,shikra.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    #include <dt-bindings/interrupt-controller/irq.h>
    #include <dt-bindings/power/qcom-rpmpd.h>
 
    remoteproc@b300000 {
        compatible = "qcom,shikra-cdsp-pas";
        reg = <0x0b300000 0x100000>;
 
        interrupts-extended = <&intc GIC_SPI 265 IRQ_TYPE_EDGE_RISING>,
                              <&cdsp_smp2p_in 0 IRQ_TYPE_EDGE_RISING>,
                              <&cdsp_smp2p_in 1 IRQ_TYPE_EDGE_RISING>,
                              <&cdsp_smp2p_in 2 IRQ_TYPE_EDGE_RISING>,
                              <&cdsp_smp2p_in 3 IRQ_TYPE_EDGE_RISING>,
                              <&cdsp_smp2p_in 7 IRQ_TYPE_EDGE_RISING>;
        interrupt-names = "wdog", "fatal", "ready",
                          "handover", "stop-ack", "shutdown-ack";
 
        clocks = <&rpmcc RPM_SMD_XO_CLK_SRC>;
        clock-names = "xo";
 
        interconnects = <&mem_noc MASTER_AMPSS_M0 RPM_ALWAYS_TAG
                         &mc_virt SLAVE_EBI_CH0 RPM_ALWAYS_TAG>;
 
        power-domains = <&rpmpd RPMHPD_CX>;
        power-domain-names = "cx";
 
        memory-region = <&cdsp_mem>;
 
        qcom,smem-states = <&cdsp_smp2p_out 0>;
        qcom,smem-state-names = "stop";
 
        firmware-name = "qcom/shikra/cdsp.mbn";
 
        glink-edge {
            interrupts = <GIC_SPI 261 IRQ_TYPE_EDGE_RISING>;
            mboxes = <&apcs_glb 4>;
            qcom,remote-pid = <5>;
            label = "cdsp";
        };
    };