Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Anup Patel <anup.patel@wdc.com>
To:     Palmer Dabbelt <palmer@dabbelt.com>,
        Palmer Dabbelt <palmerdabbelt@google.com>,
        Paul Walmsley <paul.walmsley@sifive.com>,
        Thomas Gleixner <tglx@linutronix.de>,
        Marc Zyngier <maz@kernel.org>,
        Daniel Lezcano <daniel.lezcano@linaro.org>,
        Rob Herring <robh+dt@kernel.org>
Cc:     Atish Patra <atish.patra@wdc.com>,
        Alistair Francis <Alistair.Francis@wdc.com>,
        Anup Patel <anup@brainfault.org>,
        linux-riscv@lists.infradead.org, linux-kernel@vger.kernel.org,
        devicetree@vger.kernel.org, Anup Patel <anup.patel@wdc.com>,
        Bin Meng <bmeng.cn@gmail.com>
Subject: [RFC PATCH v4 08/10] dt-bindings: timer: Add ACLINT MTIMER bindings
Date:   Thu,  7 Oct 2021 18:06:30 +0530
Message-Id: <20211007123632.697666-9-anup.patel@wdc.com>
In-Reply-To: <20211007123632.697666-1-anup.patel@wdc.com>
References: <20211007123632.697666-1-anup.patel@wdc.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
WDCIPOUTBOUND: EOP-TRUE
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?6reIMyRhlfLNNrWrFM2Yw0xhNEaGPhsarEbYOvLiEmA4qwyBKJx25EzMoXLf?=
 =?us-ascii?Q?E24SFxXyZYsdyQic+8AkFL/qgf5RTa2XFG6Bemay9s6ouQYM9CZfNv3NLW2r?=
 =?us-ascii?Q?hmn+BIJ+rcFNkS2LcGipCcmGPd659zQkscJPlkXRWRHH2T2y1WxvFSVXKWz2?=
 =?us-ascii?Q?0/5ugdR19tpqSZHagnuTflAJWFvJ85a3ypVf9gj8Y3+LsMitTQ36ICljHlmK?=
 =?us-ascii?Q?0arQCuLEDL1d+Ytfz0kI7LpsjJji5AWbOxSJxdXAydAf6ABGW84GkKv4zng5?=
 =?us-ascii?Q?AHRu8BqSeeOOze7+R8J/3gomn1joICVqjrIEtZ/IoO6LZOCvY+ClSnSyNjcq?=
 =?us-ascii?Q?dAZub3sHV7aLLvGPMi3V2IVRhhiOJo7LilQc4N2n77fLY5mnLfv+j0+jEDKy?=
 =?us-ascii?Q?J0zBccKApASt+fy2mHbfy+VymhHZ/7FD/kTsPGttmbBskbYirSaG3QgA9xK8?=
 =?us-ascii?Q?6F6HFxw5PCU6gHCu7BNrryvIc2m2IELbllyLAtuAPnrgsYbvhJ9LWsFaoPTL?=
 =?us-ascii?Q?GTnbj5SZTv+aG0oWuZKlHWKU7VEWu3Z3pzbW9P6ZRufHww/JPykPDjOMx2W/?=
 =?us-ascii?Q?ZjQOS5Hzfc4HvKjQ9UOudt/ZdQCOHvFffWk3x0AXQTwE6C8/AdZwULbwOofK?=
 =?us-ascii?Q?H4bilTtkghguFIIC80tY4d6LbwxQTO3UtPSilrcAvCUsxZt2nh5b5yNQJoUm?=
 =?us-ascii?Q?Tt1b9Zz7h79D7iaxOaiHbNT/Q+5CsCCezxmeI2WvnMK2vSMMqsFOe0+uMTO0?=
 =?us-ascii?Q?oULaA9K8b423pOW8ZlOLq6rpuenxTphHfJlhTJ6M0ly1ujQg8z5X4PYH2he6?=
 =?us-ascii?Q?jL2qMK1Gd0+o1olhCTyLKJytg75tvbJq5TlpuGSqbLT74fpLuVqyDYW/6keE?=
 =?us-ascii?Q?hryMazMkyZBGML5qmkWW5q9EqkAU1hMBcBsfRZ8dTcnqs9+sXtI9e4FUTSXt?=
 =?us-ascii?Q?zXZFuN+xDv8zzH/j6mHPfEnSXWzEFICIVIsuNsPMlcRGenP+gk1gqse1+Tp6?=
 =?us-ascii?Q?01K2YQrolib/tlADp7wC1CcidwikDmAbe4oE8EHRgFcbav3J9bEYF1nKG7YY?=
 =?us-ascii?Q?RuLR1G8d/ceyCnIcFaLhXNe93iLg7ud8oknIE9jad3WXLd2ytB+eWyUpTEyQ?=
 =?us-ascii?Q?1aU0hM2n5DtCQdtRlNP0vby7IgUi+fNLe37j4IML9FF8wEh0vVAaL/QS4fim?=
 =?us-ascii?Q?6TpmsXhl+vRg4UwG0EOEGJZjkSO9K/xiJva/lg2x5tFKRshnHjuunjHCXXR7?=
 =?us-ascii?Q?bLwCpVetvxZfvZ3vZwQ5ZHxCwm5/JC2+kpSL2+5ItigREA6fDAkTXaJdnzip?=
 =?us-ascii?Q?8UToTcQwAe51WpyELXCfxgbn?=
X-OriginatorOrg: wdc.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 08396c37-1210-4275-3fa6-08d9898f3a64
X-MS-Exchange-CrossTenant-AuthSource: CO6PR04MB7812.namprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Oct 2021 12:37:30.5729
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: b61c8803-16f3-4c35-9b17-6f65f441df86
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: INXk/pEpxoOU7snPaqPiDk1vs3WtlrchH7WxlTFsyt3AqV8uotir9z3gkC0exFtly+ix1+O0wm444lAnuOo2kg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO6PR04MB7892
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

We add DT bindings documentation for the ACLINT MTIMER device
found on RISC-V SOCs.

Signed-off-by: Anup Patel <anup.patel@wdc.com>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
---
 .../bindings/timer/riscv,aclint-mtimer.yaml   | 67 +++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/timer/riscv,aclint-mtimer.yaml

diff --git a/Documentation/devicetree/bindings/timer/riscv,aclint-mtimer.yaml b/Documentation/devicetree/bindings/timer/riscv,aclint-mtimer.yaml
new file mode 100644
index 000000000000..ebb7e81a5a12
--- /dev/null
+++ b/Documentation/devicetree/bindings/timer/riscv,aclint-mtimer.yaml
@@ -0,0 +1,67 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/timer/riscv,aclint-mtimer.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RISC-V ACLINT M-level Timer
+
+maintainers:
+  - Anup Patel <anup.patel@wdc.com>
+
+description:
+  RISC-V SOCs include an implementation of the M-level timer (MTIMER) defined
+  in the RISC-V Advanced Core Local Interruptor (ACLINT) specification. The
+  ACLINT MTIMER device is documented in the RISC-V ACLINT specification found
+  at https://github.com/riscv/riscv-aclint/blob/main/riscv-aclint.adoc.
+
+  The ACLINT MTIMER device directly connects to the M-level timer interrupt
+  lines of various HARTs (or CPUs) so the RISC-V per-HART (or per-CPU) local
+  interrupt controller is the parent interrupt controller for the ACLINT
+  MTIMER device.
+
+  The clock frequency of ACLINT is specified via "timebase-frequency" DT
+  property of "/cpus" DT node. The "timebase-frequency" DT property is
+  described in Documentation/devicetree/bindings/riscv/cpus.yaml
+
+properties:
+  compatible:
+    items:
+      - enum:
+         - sifive,fu540-c000-aclint-mtimer
+      - const: riscv,aclint-mtimer
+
+    description:
+      Should be "<vendor>,<chip>-aclint-mtimer" and "riscv,aclint-mtimer".
+
+  reg:
+    description: |
+      Specifies base physical address(s) of the MTIME register and MTIMECMPx
+      registers. The 1st region is the MTIME register base and size. The 2nd
+      region is the MTIMECMPx registers base and size.
+    minItems: 2
+    maxItems: 2
+
+  interrupts-extended:
+    minItems: 1
+    maxItems: 4095
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts-extended
+
+examples:
+  - |
+    timer@2004000 {
+      compatible = "sifive,fu540-c000-aclint-mtimer", "riscv,aclint-mtimer";
+      reg = <0x200bff8 0x8>,
+            <0x2004000 0x7ff8>;
+      interrupts-extended = <&cpu1intc 7>,
+                            <&cpu2intc 7>,
+                            <&cpu3intc 7>,
+                            <&cpu4intc 7>;
+    };
+...
-- 
2.25.1