Commit a7541de9 authored by Bjorn Andersson's avatar Bjorn Andersson
Browse files

dt-bindings: hwlock: qcom: Migrate binding to YAML



Migrate the Qualcomm TCSR mutex binding to YAML to allow validation.

Reviewed-by: default avatarVinod Koul <vkoul@kernel.org>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarBjorn Andersson <bjorn.andersson@linaro.org>
Link: https://lore.kernel.org/r/20200622075956.171058-2-bjorn.andersson@linaro.org


Signed-off-by: default avatarBjorn Andersson <bjorn.andersson@linaro.org>
parent 285e74ab
Loading
Loading
Loading
Loading
+0 −39
Original line number Diff line number Diff line
Qualcomm Hardware Mutex Block:

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

- compatible:
	Usage: required
	Value type: <string>
	Definition: must be one of:
		    "qcom,sfpb-mutex",
		    "qcom,tcsr-mutex"

- syscon:
	Usage: required
	Value type: <prop-encoded-array>
	Definition: one cell containing:
		    syscon phandle
		    offset of the hwmutex block within the syscon
		    stride of the hwmutex registers

- #hwlock-cells:
	Usage: required
	Value type: <u32>
	Definition: must be 1, the specified cell represent the lock id
		    (hwlock standard property, see hwlock.txt)

Example:

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

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

		#hwlock-cells = <1>;
	};
+51 −0
Original line number Diff line number Diff line
# 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>;
        };
...