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

title: Qualcomm IMEM memory region

maintainers:
  - Bjorn Andersson <bjorn.andersson@linaro.org>

description:
  Qualcomm IMEM is dedicated memory region for various debug features and DMA
  transactions.

properties:
  compatible:
    items:
      - enum:
          - qcom,apq8064-imem
          - qcom,ipq5424-imem
          - qcom,msm8226-imem
          - qcom,msm8974-imem
          - qcom,msm8976-imem
          - qcom,qcs404-imem
          - qcom,qcs615-imem
          - qcom,qcs8300-imem
          - qcom,qdu1000-imem
          - qcom,sa8775p-imem
          - qcom,sar2130p-imem
          - qcom,sc7180-imem
          - qcom,sc7280-imem
          - qcom,sc8280xp-imem
          - qcom,sdm630-imem
          - qcom,sdm845-imem
          - qcom,sdx55-imem
          - qcom,sdx65-imem
          - qcom,sdx75-imem
          - qcom,sm6115-imem
          - qcom,sm6125-imem
          - qcom,sm6350-imem
          - qcom,sm6375-imem
          - qcom,sm7150-imem
          - qcom,sm8150-imem
          - qcom,sm8250-imem
          - qcom,sm8350-imem
          - qcom,sm8450-imem
          - qcom,sm8550-imem
          - qcom,sm8650-imem
          - qcom,sm8750-imem
          - qcom,x1e80100-imem
      - const: syscon
      - const: simple-mfd

  reg:
    maxItems: 1

  ranges: true

  '#address-cells':
    const: 1

  '#size-cells':
    const: 1

  reboot-mode:
    $ref: /schemas/power/reset/syscon-reboot-mode.yaml#

patternProperties:
  "^minidump-sram@[0-9a-f]+$":
    type: object
    description:
      A word in always-on SRAM shared between the kernel and boot firmware.
      Before DDR is initialised on the warm reset following a crash, firmware
      reads this word to decide where to deliver the minidump (USB or storage).

    properties:
      reg:
        maxItems: 1

    required:
      - reg

    additionalProperties: false

  "^modem-tables@[0-9a-f]+$":
    type: object
    description:
      Region containing packet processing configuration for the IP Accelerator.

    properties:
      reg:
        maxItems: 1

    required:
      - reg

    additionalProperties: false

  "^pil-reloc@[0-9a-f]+$":
    $ref: /schemas/remoteproc/qcom,pil-info.yaml#
    description: Peripheral image loader relocation region

required:
  - compatible
  - reg

allOf:
  - if:
      properties:
        compatible:
          contains:
            enum:
              - qcom,apq8064-imem
              - qcom,msm8226-imem
              - qcom,msm8974-imem
    then:
      properties:
        reboot-mode:
          patternProperties:
            # Negative look-ahead to disallow unsupported modes. The '$' has to be
            # part of lookahead group to work, instead of trailing outside of ().
            "^mode-(?!(bootloader$|normal$|recovery$))": false
    else:
      properties:
        reboot-mode: false

additionalProperties: false

examples:
  - |
    soc {
        #address-cells = <2>;
        #size-cells = <2>;

        sram@146bf000 {
            compatible = "qcom,sdm845-imem", "syscon", "simple-mfd";
            reg = <0 0x146bf000 0 0x1000>;
            ranges = <0 0 0x146bf000 0x1000>;

            #address-cells = <1>;
            #size-cells = <1>;

            pil-reloc@94c {
                compatible = "qcom,pil-reloc-info";
                reg = <0x94c 0xc8>;
            };
        };
    };