From nobody Sun Sep 22 01:40:29 2024 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 66086C433EF for ; Thu, 19 May 2022 10:18:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236561AbiESKSS (ORCPT ); Thu, 19 May 2022 06:18:18 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55880 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229541AbiESKSP (ORCPT ); Thu, 19 May 2022 06:18:15 -0400 Received: from bhuna.collabora.co.uk (bhuna.collabora.co.uk [46.235.227.227]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 43FAF4B1F6; Thu, 19 May 2022 03:18:14 -0700 (PDT) Received: from [127.0.0.1] (localhost [127.0.0.1]) (Authenticated sender: kholk11) with ESMTPSA id DF3511F45A06 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1652955492; bh=elCw2GMrP8XUYjnKjTriaCAevspHDdoKTgv83FjGUQU=; h=From:To:Cc:Subject:Date:From; b=nAMtX5wELFg2hOQVO1y45d6Jnkm2Xjzqzw8l7ncUlQmQzG2Z9r4PZE8CyUZJ054Dn mKhxljLL5HVBu4OQCCj5dYlsTPL8o6Kxt31hQvZTi5xf5hRutyOSv6X4seoX3kKoMc nYa0Gt0zSDykj76rSHcB8QdkIYrGxsjQxE5swhZ0YH9LOuE9GOChIVowhKKiVGvNLC njiS7HoQiodiUIlaY2e99UZ5o5gpGrN7IayPYU8ZfnShMHgb5ZO12JPKOC/QC4k+mO OS3rz1wd4UfNqcPN9VIRG+R7GxXtz43D5t+SrrkI3CIDroP4r1ag0P4biKVG+/xJDW 8U6TDDJhKBV/w== From: AngeloGioacchino Del Regno To: robh+dt@kernel.org Cc: jassisinghbrar@gmail.com, krzysztof.kozlowski+dt@linaro.org, matthias.bgg@gmail.com, houlong.wei@mediatek.com, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-mediatek@lists.infradead.org, AngeloGioacchino Del Regno Subject: [PATCH] dt-bindings: mailbox: mtk-gce: Convert txt to json-schema Date: Thu, 19 May 2022 12:18:06 +0200 Message-Id: <20220519101806.18097-1-angelogioacchino.delregno@collabora.com> X-Mailer: git-send-email 2.35.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" Convert the mtk-gce documentation from freeform text format to a json-schema. Signed-off-by: AngeloGioacchino Del Regno --- .../bindings/mailbox/mediatek,gce-mbox.yaml | 114 ++++++++++++++++++ .../devicetree/bindings/mailbox/mtk-gce.txt | 82 ------------- 2 files changed, 114 insertions(+), 82 deletions(-) create mode 100644 Documentation/devicetree/bindings/mailbox/mediatek,gce-= mbox.yaml delete mode 100644 Documentation/devicetree/bindings/mailbox/mtk-gce.txt diff --git a/Documentation/devicetree/bindings/mailbox/mediatek,gce-mbox.ya= ml b/Documentation/devicetree/bindings/mailbox/mediatek,gce-mbox.yaml new file mode 100644 index 000000000000..750391b4038c --- /dev/null +++ b/Documentation/devicetree/bindings/mailbox/mediatek,gce-mbox.yaml @@ -0,0 +1,114 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mailbox/mediatek,gce-mbox.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: MediaTek Global Command Engine (GCE) mailbox + +maintainers: + - Houlong Wei + +description: | + The Global Command Engine (GCE) is used to help read/write registers + with critical time limitation, such as updating display configuration + during the vblank. + The GCE can be used to implement the Command Queue (CMDQ) driver. + +properties: + compatible: + enum: + - mediatek,mt6779-gce + - mediatek,mt8173-gce + - mediatek,mt8183-gce + - mediatek,mt8186-gce + - mediatek,mt8192-gce + - mediatek,mt8195-gce + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + + clock-names: + items: + - const: gce + + '#mbox-cells': + description: | + The first cell describes the mailbox channel, which is the GCE Threa= d ID; + The second cell describes the priority of the GCE thread. + const: 2 + +required: + - compatible + - reg + - interrupts + - clocks + - clock-names + - '#mbox-cells' + +additionalProperties: false + +allOf: + - if: + properties: + compatible: + enum: + - mediatek,mt8195-gce + then: + properties: + clocks: + maxItems: 2 + + clock-names: + items: + - const: gce0 + - const: gce1 + +examples: + - | + #include + #include + #include + #include + + soc { + #address-cells =3D <2>; + #size-cells =3D <2>; + + gce: mailbox@10212000 { + compatible =3D "mediatek,mt8173-gce"; + reg =3D <0 0x10212000 0 0x1000>; + interrupts =3D ; + clocks =3D <&infracfg CLK_INFRA_GCE>; + clock-names =3D "gce"; + #mbox-cells =3D <2>; + }; + + /* Client device using a GCE Thread */ + mmsys: syscon@14000000 { + compatible =3D "mediatek,mt8173-mmsys", "syscon"; + reg =3D <0 0x14000000 0 0x1000>; + mboxes =3D <&gce 0 CMDQ_THR_PRIO_HIGHEST>, + <&gce 1 CMDQ_THR_PRIO_HIGHEST>; + mediatek,gce-client-reg =3D <&gce SUBSYS_1400XXXX 0 0x1000>; + #clock-cells =3D <1>; + #reset-cells =3D <1>; + }; + + /* Client device listening to specific GCE Events */ + mutex: mutex@14020000 { + compatible =3D "mediatek,mt8173-disp-mutex"; + reg =3D <0 0x14020000 0 0x1000>; + interrupts =3D ; + power-domains =3D <&spm 1>; + clocks =3D <&mmsys CLK_MM_MUTEX_32K>; + mediatek,gce-events =3D , + ; + }; + }; diff --git a/Documentation/devicetree/bindings/mailbox/mtk-gce.txt b/Docume= ntation/devicetree/bindings/mailbox/mtk-gce.txt deleted file mode 100644 index c2aeba63bd47..000000000000 --- a/Documentation/devicetree/bindings/mailbox/mtk-gce.txt +++ /dev/null @@ -1,82 +0,0 @@ -MediaTek GCE -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -The Global Command Engine (GCE) is used to help read/write registers with -critical time limitation, such as updating display configuration during the -vblank. The GCE can be used to implement the Command Queue (CMDQ) driver. - -CMDQ driver uses mailbox framework for communication. Please refer to -mailbox.txt for generic information about mailbox device-tree bindings. - -Required properties: -- compatible: can be "mediatek,mt8173-gce", "mediatek,mt8183-gce", - "mediatek,mt8186-gce", "mediatek,mt8192-gce", "mediatek,mt8195-gce" or - "mediatek,mt6779-gce". -- reg: Address range of the GCE unit -- interrupts: The interrupt signal from the GCE block -- clock: Clocks according to the common clock binding -- clock-names: Must be "gce" to stand for GCE clock -- #mbox-cells: Should be 2. - <&phandle channel priority> - phandle: Label name of a gce node. - channel: Channel of mailbox. Be equal to the thread id of GCE. - priority: Priority of GCE thread. - -Required properties for a client device: -- mboxes: Client use mailbox to communicate with GCE, it should have this - property and list of phandle, mailbox specifiers. -Optional properties for a client device: -- mediatek,gce-client-reg: Specify the sub-system id which is corresponding - to the register address, it should have this property and list of phandl= e, - sub-system specifiers. - <&phandle subsys_number start_offset size> - phandle: Label name of a gce node. - subsys_number: specify the sub-system id which is corresponding - to the register address. - start_offset: the start offset of register address that GCE can access. - size: the total size of register address that GCE can access. - -Optional properties for a client mutex node: -- mediatek,gce-events: GCE events used by clients. The event numbers are - defined in 'dt-bindings/gce/-gce.h'. - -Some vaules of properties are defined in 'dt-bindings/gce/mt8173-gce.h', -'dt-bindings/gce/mt8183-gce.h', 'dt-bindings/gce/mt8186-gce.h' -'dt-bindings/gce/mt8192-gce.h', 'dt-bindings/gce/mt8195-gce.h' or -'dt-bindings/gce/mt6779-gce.h'. -Such as sub-system ids, thread priority, event ids. - -Example: - - gce: gce@10212000 { - compatible =3D "mediatek,mt8173-gce"; - reg =3D <0 0x10212000 0 0x1000>; - interrupts =3D ; - clocks =3D <&infracfg CLK_INFRA_GCE>; - clock-names =3D "gce"; - #mbox-cells =3D <2>; - }; - -Example for a client device: - - mmsys: clock-controller@14000000 { - compatible =3D "mediatek,mt8173-mmsys"; - mboxes =3D <&gce 0 CMDQ_THR_PRIO_LOWEST>, - <&gce 1 CMDQ_THR_PRIO_LOWEST>; - mutex-event-eof =3D ; - mediatek,gce-client-reg =3D <&gce SUBSYS_1400XXXX 0x3000 0x1000>, - <&gce SUBSYS_1401XXXX 0x2000 0x100>; - ... - }; - -Example for a client mutex node: - mutex: mutex@14020000 { - compatible =3D "mediatek,mt8173-disp-mutex"; - reg =3D <0 0x14020000 0 0x1000>; - interrupts =3D ; - power-domains =3D <&scpsys MT8173_POWER_DOMAIN_MM>; - clocks =3D <&mmsys CLK_MM_MUTEX_32K>; - mediatek,gce-events =3D , - ; - }; --=20 2.35.1