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

title: Qualcomm Hardware Mutex Block

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

description:
  The hardware block provides mutexes utilized between different processors on
  the SoC as part of the communication protocol used by these processors.

properties:
  compatible:
    enum:
      - qcom,sfpb-mutex
      - qcom,tcsr-mutex

  '#hwlock-cells':
    const: 1

  syscon:
    $ref: "/schemas/types.yaml#/definitions/phandle-array"
    description:
      Should be a triple of phandle referencing the TCSR mutex syscon, offset
      of first mutex within the syscon and stride between each mutex.

required:
  - compatible
  - '#hwlock-cells'
  - syscon

additionalProperties: false

examples:
  - |
        tcsr_mutex_block: syscon@fd484000 {
                compatible = "syscon";
                reg = <0xfd484000 0x2000>;
        };

        hwlock {
                compatible = "qcom,tcsr-mutex";
                syscon = <&tcsr_mutex_block 0 0x80>;

                #hwlock-cells = <1>;
        };
...