Received-SPF: pass (google.com: domain of linux-kernel+bounces-154823-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
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 v2 2/2] dt-bindings: cache: Add docs for StarFive Starlink cache controller
Date: Tue, 23 Apr 2024 15:26:39 +0800
Message-Id: <20240423072639.143450-3-joshua.yeong@starfivetech.com>
In-Reply-To: <20240423072639.143450-1-joshua.yeong@starfivetech.com>
References: <20240423072639.143450-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?xZwv47HPbrfaoWPaD1OjlAfsK3F4IYzfT73MXesX5ALdeWboAX9OQ8Jym38d?=
 =?us-ascii?Q?bn+dU+3DaenrZ5y8OAtwiiupu+RKrTDJvqCYxJTGwF3Vc3n/Ij7VRurxsXUj?=
 =?us-ascii?Q?N4g0V6lA3WJ/hIYYepJhcJw7KpI39FRfSBPjefSSk/7Z6BUi0HOZvEWOLZNe?=
 =?us-ascii?Q?6vbbposSTdyHka20dPWzN+AjWVgy9BlU0bYqfoe+1DxXuCuLmsHKuQEYyGXV?=
 =?us-ascii?Q?usflDyUif8GPs2mQiYvjvNqkNQuVKHL3zBs5xCRCSgvsxR/oIQs1N1yXcfxh?=
 =?us-ascii?Q?Y4+Y1qsCjmcwktRpLcIoOmIlWG4oc8MqW5fzU7p5dKgGWOL24wNNatlmyDVA?=
 =?us-ascii?Q?3FLE32UMucGWjK2w8TYluAz8IqeDL9303FxbroZHIX4V40aoArNO+Cc+AoUd?=
 =?us-ascii?Q?HJ/RMkDFBg5sNZFGvJFB64yKeNiJM8nF+jG8DcV7ZM3khBehjNV263/Nttkx?=
 =?us-ascii?Q?vKBZi6iONywpZxqNHnXGjTmuRq4ZB+0eoOQi04IGlNOK5M6KEROEJWiY8bz3?=
 =?us-ascii?Q?waAAxjb8fDn4Ed3HN2phFYkZQDqoKrtEwgAqJAzNrnbZhD675u850sgcc+ih?=
 =?us-ascii?Q?7TSEKnWMxYThYfbN7c9TE4JZBtcjNwGVTJabxmDRoNB8YriTopPNe25gGt0P?=
 =?us-ascii?Q?iaK/hiOE9J9GBa3V3ZmNBqF8Ylu3pGMMw/mv8kDPrXWnGP2OaRfhJjsDriqI?=
 =?us-ascii?Q?ciDskZ6Ja5gTivydVHOVKyNNECFnmdTem6LiuvLVD1yT7u3izYk0wdQd0xUX?=
 =?us-ascii?Q?pZNdHdPFqPkEjcYK237c5Y24kBKSn+J4w1WxFhUldvjUyh+Nm1cXei7NETG3?=
 =?us-ascii?Q?DfylBR2EVnrbHTf3erA2MImQAbtlPuf8cZFTlX2lbZndeDTmep/3xfzRXXHB?=
 =?us-ascii?Q?AKlXGPjLzEZCJ+PglW+ojBu7rk2zEsr+QJWvJSe8ARmQQftzNr03doe5IV5x?=
 =?us-ascii?Q?6dgs03lSWW62597tomiHPkG2hN1WLmisR/yEqddrTbUO05gDLiUr/aCiV6yD?=
 =?us-ascii?Q?fI5guIw8jiRq6D8EwaKcZoEOkYWUo8BBJI4hVAxCbOKFKzOvCyLcefzSSI0W?=
 =?us-ascii?Q?oeP0CD80RlqpW+ekU7LpTPa7uEin2jt8uNwo3PCOalcb+sfPZa9c3eeKR8b7?=
 =?us-ascii?Q?qINg6xsjY2MjVY/untEmu9FTk7fZBlgMCAIXFPeVQ0m4jG13JAPsL9ro4hW0?=
 =?us-ascii?Q?HLzbZjdF02XN6AnivQ9NYsbsx7CoynX0wBZvOc212OwCbTFBshCQlKD3ARU0?=
 =?us-ascii?Q?w91i6Uomj9mwlH5qzogyudLoG2ZyJ6qZe9kT6ZdEnvamnRAltHS8tGHY+pjq?=
 =?us-ascii?Q?RGTpN1+ppGRKya7/ZdjB67n5mdjyk64tPlEBuh83j0ZiU9cIhCtVyjxzC6s7?=
 =?us-ascii?Q?+V2sOtFH/g9hRMTBdmTMko3A0be6nEiRZMR7n7aCk0XIYuftSBKVJctNjVIi?=
 =?us-ascii?Q?+mAPmTqewwVva6lNptHcdSp2zN/iBbC7xUrNhNzfZj5w0byC0asDeIBV5NaS?=
 =?us-ascii?Q?fIsN9syJLZliVmRbMXgCUQqK3FPj1qOZAP0Iovqb4yEHk+73+L+Z2rqEzowP?=
 =?us-ascii?Q?cvgabqh+JnxCzidi3H67WchfLZ9yAsG3tNmBJIZrUSiUyopQ0kdBhDq+PPVe?=
 =?us-ascii?Q?HUFoVei+sAWBGL6qY0V3qOE=3D?=
X-OriginatorOrg: starfivetech.com
X-MS-Exchange-CrossTenant-Network-Message-Id: df4a6bf8-e5ef-48de-6062-08dc6366c008
X-MS-Exchange-CrossTenant-AuthSource: SH0PR01MB0841.CHNPR01.prod.partner.outlook.cn
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Apr 2024 07:26:54.0109
 (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: WVYv8qGt6yrPwC0RBdmlhRe3OUDblN2O0TchSDzjFEUz8Nc9NYyWXUdhO4VjHzglSTPry3vFMyOdZ8VVS8LrJ2mAcWYXw5YzEYUffJTs2sg=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SH0PR01MB0633

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

Signed-off-by: Joshua Yeong <joshua.yeong@starfivetech.com>
---
 .../cache/starfive,jh8100-starlink-cache.yaml | 62 +++++++++++++++++++
 1 file changed, 62 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..a8f39baca6cf
--- /dev/null
+++ b/Documentation/devicetree/bindings/cache/starfive,jh8100-starlink-cache.yaml
@@ -0,0 +1,62 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/cache/starfive,starlink-500-cache.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: StarFive StarLink-500 Cache Controller
+
+maintainers:
+  - Joshua Yeong <joshua.yeong@starfivetech.com>
+
+description:
+  StarFive's JH8100 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:
+  - |
+      cache-controller@15000000 {
+        compatible = "starfive,jh8100-starlink-cache", "cache";
+        reg = <0x15000000 0x278>;
+        cache-block-size = <64>;
+        cache-level = <3>;
+        cache-sets = <8192>;
+        cache-size = <0x400000>;
+        cache-unified;
+      };
-- 
2.25.1