Received-SPF: pass (google.com: domain of linux-kernel+bounces-158413-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Joshua Yeong <joshua.yeong@starfivetech.com>
To: robh@kernel.org,
	krzk+dt@kernel.org,
	conor+dt@kernel.org,
	conor@kernel.org,
	paul.walmsley@sifive.com,
	palmer@dabbelt.com,
	aou@eecs.berkeley.edu,
	joshua.yeong@starfivetech.com,
	leyfoon.tan@starfivetech.com,
	jeeheng.sia@starfivetech.com
Cc: devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-riscv@lists.infradead.org
Subject: [PATCH v4 2/2] dt-bindings: cache: Add docs for StarFive Starlink cache controller
Date: Thu, 25 Apr 2024 18:48:41 +0800
Message-Id: <20240425104841.72379-3-joshua.yeong@starfivetech.com>
In-Reply-To: <20240425104841.72379-1-joshua.yeong@starfivetech.com>
References: <20240425104841.72379-1-joshua.yeong@starfivetech.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?IeLKnNaRUKuZs43fXbG3M42Uu67NMv2LpJ51AtlAtGiMscRlHf6Zac4uT6eg?=
 =?us-ascii?Q?2UggLZK3Qst6QxSWBLlkMO0vq9g+DXDlRS1vcQRkifTdx/pB+GPJDgL/egJ2?=
 =?us-ascii?Q?/5S4nuXkbzNkRORbh9jq04bX3ifUxRi6N7DVVN+0TgLUQH00fuwtjVZphQ/l?=
 =?us-ascii?Q?G8oD+FFxb8Scyx5hDVF8UGtliCe9dcWdgVuA2eRvnwYZugj5968qjCeQ1LYB?=
 =?us-ascii?Q?PAXP7K23UhhdRkDYCrv+cEeshtZzzxwyDNeAqXNyHyy8Z3WYwEjfToc3wPvm?=
 =?us-ascii?Q?zF/es1YwGsEkE+90MWRVbnVR8RETTYDsa2VCY7FEvVySRrcVEyBhj/7r/y+O?=
 =?us-ascii?Q?gSXUuW+S3rx6YR4tWGsZM3tqZ+2/rPUY8eJJ+cF22pero7wqLFmLalvSbG6y?=
 =?us-ascii?Q?+q7A2f5htxJys4kZnWXhKWHi+Zj+GXz1zlb09BwQCDEBIhhpVSo693iaGmFm?=
 =?us-ascii?Q?Z5J2L53KianTzio1DiJxfA25TUgP7QkwhvNDaxoI+MJxqhCnJSLghGvg9A4x?=
 =?us-ascii?Q?NJmyusmX/mH1vZz359XB8y3H5e3mA6yyflyLUPwfrrb3ISGsL424dlciPVJ9?=
 =?us-ascii?Q?N4kXCLANdNn710suFd13kSlMpN3WDSxxpJGSe5lJpkR5XGFXw0ko3V3zrMUB?=
 =?us-ascii?Q?3YUyp3Gpeu2GfoRA/gvWXEseKkVzf8RU6/9NTxizAVlgS8TkKQU0iC1+Qbkr?=
 =?us-ascii?Q?T42DkmwNcuPu5YhD0D8FCcw1iABvscU6N83wwSuh8INtVU1v87jei5/VGw4s?=
 =?us-ascii?Q?eeE6MnYpgWBETvruh07ReCB/I2MQlQy024mvfEmKh2wa1hZ1d4cMEpo5ReRN?=
 =?us-ascii?Q?dle7J4p23XjS83ZFn71voxSjvn2Z+b1Wv9H6VIfgpVwRS8jKI07/0spxzqNS?=
 =?us-ascii?Q?rn62GXJCFXjlVA8qERfj5uavLsSuiLsc6agtufroarF/FmRkLkcO2g4LOR0+?=
 =?us-ascii?Q?uO216LTVwi8+IcVvDLxQUBsmuseJjDpOjnxpDyPhn970NfRheGb9Jrga9za9?=
 =?us-ascii?Q?dbO6p9WwG3xEHQWUCWumndXhbsfveNKO54qRKmwgADgXgBtl7xeRYWGCkHQn?=
 =?us-ascii?Q?Fvhbal1Fq+aFK2igu0RqFiB80S2j8Cy1zaxTDXVQh7QM/BzmGhN+8a3FEEwP?=
 =?us-ascii?Q?p5YDI7sjHDZD2DVZEjYZsSlFnVMzNi1mZMf8U8FYPcSuNIbbZ7ZkZRrhmn/8?=
 =?us-ascii?Q?xJAN+nOFISms1IA4vpFaoAchzOiZqgMnXGNGDsM0PUbP29SQBWiip/gX1rnP?=
 =?us-ascii?Q?2CZ7lDw7D9QGcnSCE/xzMhHrmgnHn9hLs46KHFZxQbNEwUKsmXkzzfRTsFzt?=
 =?us-ascii?Q?27d3L08WDozx6MauIs+gQoQi4I91RkMS59FZujZqMJZ5v87cpMdGYziVbBst?=
 =?us-ascii?Q?11MmIvqkJpVdto5aWIeMgJtoaTQHmETWT7QWKXRcCJJaMeyj/08ex+0UhQEF?=
 =?us-ascii?Q?53WIIQd9Fr1R59pPMm85UY/pGBKbsr33MLT8I7SeeWHRvDmg0ZzPWPMZY8XJ?=
 =?us-ascii?Q?Wpsp4yP/NQhrhCuIEymf9OORfzMjxDOUENrUftgl0idfkkbScxyhLXAwDbs1?=
 =?us-ascii?Q?XcyMh4rjoS4eD1GRuHSkldpNLjmLVDPfIx2BiK2RxrEOav0G/jM1MyTKw9fO?=
 =?us-ascii?Q?Dy0/NK8rj3Q4Ris+C6VUtKg=3D?=
X-OriginatorOrg: starfivetech.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 47a980ff-09e8-4f92-3d7b-08dc651557d4
X-MS-Exchange-CrossTenant-AuthSource: SH0PR01MB0841.CHNPR01.prod.partner.outlook.cn
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Apr 2024 10:49:12.4319
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 06fe3fa3-1221-43d3-861b-5a4ee687a85c
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: L/e+yJa3fXDhlR2pWp+jyDvjzTDkAyZnBMaXCkTq6JvEETtXDEbB9TwaZ31uewYQpYaUeqVVgKJPzW3gcdXodk+BL/RqLo6G9js/7S2QMt8=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SH0PR01MB0491

Add DT binding documentation used by StarFive's
Starlink cache controller.

Signed-off-by: Joshua Yeong <joshua.yeong@starfivetech.com>
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
---
 .../cache/starfive,jh8100-starlink-cache.yaml | 66 +++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/cache/starfive,jh8100-starlink-cache.yaml

diff --git a/Documentation/devicetree/bindings/cache/starfive,jh8100-starlink-cache.yaml b/Documentation/devicetree/bindings/cache/starfive,jh8100-starlink-cache.yaml
new file mode 100644
index 000000000000..6d61098e388b
--- /dev/null
+++ b/Documentation/devicetree/bindings/cache/starfive,jh8100-starlink-cache.yaml
@@ -0,0 +1,66 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/cache/starfive,jh8100-starlink-cache.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: StarFive StarLink Cache Controller
+
+maintainers:
+  - Joshua Yeong <joshua.yeong@starfivetech.com>
+
+description:
+  StarFive's StarLink Cache Controller manages the L3 cache shared between
+  clusters of CPU cores. The cache driver enables RISC-V non-standard cache
+  management as an alternative to instructions in the RISC-V Zicbom extension.
+
+allOf:
+  - $ref: /schemas/cache-controller.yaml#
+
+# We need a select here so we don't match all nodes with 'cache'
+select:
+  properties:
+    compatible:
+      contains:
+        enum:
+          - starfive,jh8100-starlink-cache
+
+  required:
+    - compatible
+
+properties:
+  compatible:
+    items:
+      - const: starfive,jh8100-starlink-cache
+      - const: cache
+
+  reg:
+    maxItems: 1
+
+unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+  - cache-block-size
+  - cache-level
+  - cache-sets
+  - cache-size
+  - cache-unified
+
+examples:
+  - |
+      soc {
+        #address-cells = <2>;
+        #size-cells = <2>;
+
+        cache-controller@15000000 {
+          compatible = "starfive,jh8100-starlink-cache", "cache";
+          reg = <0x0 0x15000000 0x0 0x278>;
+          cache-block-size = <64>;
+          cache-level = <3>;
+          cache-sets = <8192>;
+          cache-size = <0x400000>;
+          cache-unified;
+        };
+      };
-- 
2.25.1