Received-SPF: pass (google.com: domain of linux-kernel+bounces-156515-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 v3 2/2] dt-bindings: cache: Add docs for StarFive Starlink cache controller
Date: Wed, 24 Apr 2024 15:58:56 +0800
Message-Id: <20240424075856.145850-3-joshua.yeong@starfivetech.com>
In-Reply-To: <20240424075856.145850-1-joshua.yeong@starfivetech.com>
References: <20240424075856.145850-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?aLQMGYg1+y8ljUTGQOVprl6xHvknpNwJCln/pa/QOYofzvpKyc8SffenN+ct?=
 =?us-ascii?Q?KeAAzSTlgaVcLKn/Ogytn+gNL7kMSODFQQWlPYu6csrM/tCwktnXfwCMZU+w?=
 =?us-ascii?Q?GNWZSoBgVz9mLuqj6Mue3vsJ71F1BTVKT+3dRBHXVX4qWSNGjm0kXwDDqJJw?=
 =?us-ascii?Q?guz39lUWh9y9Id/zN3XZvCCcc56QhK3CkwOGkjKaSrj2/kR8oIRRTAIoOizq?=
 =?us-ascii?Q?bB8x+GJZ/9MphIJDWkqdsJGoulHf/bUL/W3n5PdBRhmpmdUAZKFU9xlRvYSx?=
 =?us-ascii?Q?KDrC2Nw5CC79K2RzAXaGWiD9IG/qUCwb3VhavgssMnD/UI44ytHByKIDJWHI?=
 =?us-ascii?Q?W0RKyuE7TzNR22Bn+g8/hRKfwmQOHz1+tz8awtbwAXuEdgRo6Fs7JBIkeo4a?=
 =?us-ascii?Q?hp0xHIJsYBHzROJweKA7GU5Q2jG+7h7m4YxrYwpX26b3tZr1NqCjb7pm80F8?=
 =?us-ascii?Q?siS6QVZc/DhPN5TxU/WlCQShK/PrwwmujV/LK5JhUKokbgNsZxWFji4w8OkA?=
 =?us-ascii?Q?P1Bgz4s0ou/l4z5tmSMCaSBg2Guabf5YGcDJX4iZZOLYdNlfzv+Y/iRrdmdd?=
 =?us-ascii?Q?/ufrCgK5Pjdg/ThEXQCcOnTl/DPj2DcA7o9OKCJO791MbmKW5Fwv713rENZv?=
 =?us-ascii?Q?VNK2IZRrbA+4wy8V8en59M17Qge/RWnx8ibYmjFfCW/SuGDONZeBF71ueTfX?=
 =?us-ascii?Q?Al8TL7pG2OnKhJjJBfxcwyew6qT5uBlOpWTdby7HzYa8vBatOwV8Aod3e6tt?=
 =?us-ascii?Q?8H09KYpzPk+wc5U2vEiNqZ5fc0zxQz2zSM/X3zyPmgYZ1XrEY4iG9szi34iA?=
 =?us-ascii?Q?GpVag+LzCxPFSI3bvm1xPSXnYmfWqA0VkdyGsNjSqja10F1wJZOpQ22DG0FS?=
 =?us-ascii?Q?Bnds2tMgbhNtvQANNr5ix+ug7QuEvQ3aD52vi+3kBI+Gtj3KC3LLHJ6OT4Id?=
 =?us-ascii?Q?ZmpEbq1c2y30Kq+JC9s8BisG/LlZm/FluHBccmZjwm/eLAzbQ8kHihT061BA?=
 =?us-ascii?Q?72YiOS0zGYuaaAOvb3WhO9Xe/Gy0FTx1Doy/xHhZTu3HZVSpTyrVkpaYI7kv?=
 =?us-ascii?Q?s12gcRWMPbgaVenkZCmSQrbukhbGwbnCzK74HW0lTIhfCdCN6l5OgIQU3t1Z?=
 =?us-ascii?Q?mXLoeLnK1MvgqBlQos0Qq+t+Gt0jZpDlVtedhcPeqy2IbGZoRO3HUq5KVZaU?=
 =?us-ascii?Q?XOeI7Fxw3jSRVxDCoQCjzO+dXivZijCqx5lebFyC+XhWQxUeUEMLC5393iFR?=
 =?us-ascii?Q?HIsj4mragR7WHapBMrsJps3vXPR4jch7fB4A9qXGpHY/Ev1LvuTV2ZVeZsst?=
 =?us-ascii?Q?JKmXRgsPRT8ePii57zGgCrg6OEsWjbb1KJS2JeQCuDpbPg4zXcB0VjWtt3zX?=
 =?us-ascii?Q?LmBvdD7OhEbQ/lc4PCcl+CN+cVD+nmWxDIDWlOCPUQCfD/foOFeGji2Cuz83?=
 =?us-ascii?Q?ovzHLPb462yFJnfPUQuh2ps7XBnlV78NLLQybUF2LsGyQj8M1ZoWb18Wq63G?=
 =?us-ascii?Q?GJzXsbN6rQ9B9sIsCje9c7lcxJ9Pp8yOBgzb9oTF76nYmxCJpQ5HizekaRAa?=
 =?us-ascii?Q?z3IqMIJ75PfhQ6hFy0ajN27FNWDj86ndFYGXlldku4YPAr0hLK1q7cnB2hJP?=
 =?us-ascii?Q?0zKALOe1YwiEQRDFgxxYR+Y=3D?=
X-OriginatorOrg: starfivetech.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 7f6bdcc4-cb93-4e7e-ace3-08dc64347592
X-MS-Exchange-CrossTenant-AuthSource: SH0PR01MB0841.CHNPR01.prod.partner.outlook.cn
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Apr 2024 07:59:25.6194
 (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: +uOilfcSRANc591JY4yvfRq/SYFLFfMICxy81M/C/8v70TixVG6xtIqbp9HEe4XRaeG4tQz7rj3zdKeUesYm76W28+nyqqVYfsQp8f0UtXk=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SH0PR01MB0460

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 | 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