Received-SPF: pass (google.com: domain of linux-kernel+bounces-179455-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 v4 1/2 RESEND] cache: Add StarFive StarLink cache management
Date: Wed, 15 May 2024 13:02:52 +0800
Message-Id: <20240515050253.38061-2-joshua.yeong@starfivetech.com>
In-Reply-To: <20240515050253.38061-1-joshua.yeong@starfivetech.com>
References: <20240515050253.38061-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?88a+I+tKohGVZBReycaRx4dEMzAilpi+tYrgyHClBlcertRZ3d3uhY8zDq+U?=
 =?us-ascii?Q?Tzo5T/J6uqh6o4lVFCCgJ+bMZqjY5bSDDuON33C78blxf+vDHETlIeRRyyc9?=
 =?us-ascii?Q?T/Im4rbfw0nC8XwM4/8Qwmkm7At15AGmBregYqbSmzSYOXMjoaxKChlRZrpa?=
 =?us-ascii?Q?bul6VhZ7sml3UQ9Mvty+z7ZQtwp7QjJPNkknqqqV82STP6vJQSyZ4n0oe+J9?=
 =?us-ascii?Q?AuXK65iililn7lIXdHD2Dt+K3Jr8AvpqyIBTOgJZlRcHAkxXW6gGroaqSaNL?=
 =?us-ascii?Q?n9WiMmx+LPl8iz+2Swy4e2TdLzLJcCoutH05hEWbf8PfHDGf7LQGG9jd5pBg?=
 =?us-ascii?Q?pVvBfS/97sa++f8gdAxQroq9giG17GHtmEob2be6K9fXprG7SQ4YF9ayslTu?=
 =?us-ascii?Q?d0jFUs/FEylgz4ssvl7lBGPPja0BVlrLeAiqhKUsg8JUwZ5dqp9pRTXagVYw?=
 =?us-ascii?Q?uK+TfdatUjabrr/9Iw9SmuhyLoapq5M+4jriZWQsJiTzoQxRZUPP80Kx+gxc?=
 =?us-ascii?Q?P6F5Ph5qdeEm3eAhw1QJKWsYEVeU1V7GijUx1V4BitX+z+7tdaT42I0bcjfr?=
 =?us-ascii?Q?6uHhCiSJKsxaqjf6lt+ALawhLt8QblAlD1WEsqMgNoWmaOmuCBXzFGcx6lwy?=
 =?us-ascii?Q?5yxTu/WHOT2qv5WbBt/J4QT2/fVPD+ePyuOGE5uQDAQtaTQqsvKbtJDB4VEZ?=
 =?us-ascii?Q?1Tw5j6ZGemxSzNU+P/i5vVIY0GA4EQW2mvS7twIOSn38gBXWqSTKdW7u+fVv?=
 =?us-ascii?Q?EUPZXFDEgprJr9DYENpOtEOzxM1dzbyGkuQ/8X4I/xD+pkxrrBB1L8IYSkcZ?=
 =?us-ascii?Q?BJM83cffp7B4Hz+wmRawUhrOK3MiTV2f5HEZDrh/sxP2z6KfEeNrblBqKj7l?=
 =?us-ascii?Q?mjn9TYAuYBpvGl/66rPeLBO0GV/Yb2rAi0Oy+KRYwSEPN/pEwHHs5EvQUWEj?=
 =?us-ascii?Q?o/O1SWX/6eSM2/Itky/2lqmGI1JMWkw+a3cI3cLca78T+JJSDDK4BKTNRD8D?=
 =?us-ascii?Q?o1ZCxVGw7NzPqrM+jSqdHR/6PmoXih2VkeKCoDORpztn2fRLRB57ZMinssIs?=
 =?us-ascii?Q?AZ2EkPz/842hFnmS2NmGn+7uk0/uwc7FgtLeG/SPkaHNmxSvBMTO1D9C5IZU?=
 =?us-ascii?Q?t8p5UoSk2L4Z5tyJk7qcPJGPumuntVMeryUERu7x/+jFZ6ZDX6sakaBQAU/O?=
 =?us-ascii?Q?5x/c7N+dyYSS7MmcUEGxKc7rKiT0LnmlfPSACv8yd5VtWAagMxomzm7n5Lqz?=
 =?us-ascii?Q?zQm8pG0pHpRTIrTk6yf8WkNYkpxqdKp+X1aXRzwd3Yb/WnTl1x3zEUk6hG0y?=
 =?us-ascii?Q?lL1pF6DbesLNiG7JrFhaHOp921nAPNf4hm96kxzt/870GRDj01ULkFXE96RP?=
 =?us-ascii?Q?eH+wdZvofsfu+dl0UShoGGZ+klqr3aEymk0wfvLT8f+0xB3QDpAUGMPMJBIp?=
 =?us-ascii?Q?3o03jFJXyUa74m9uGX65iMgjw01zXVnA1F6hvQPM+7+Yp98ndARorsR6Yozj?=
 =?us-ascii?Q?u4UvBFYKQQVhdHl91CKVVS3nsrt19ct25fLFUi9SByvEkUTwPbQ2YcoNUfxq?=
 =?us-ascii?Q?GeYO1CaG/cM3ej9s+XDFDoZkG0sj6POveUqNLIwbjG/Q4NAG/Q4EQiiezodr?=
 =?us-ascii?Q?vlT9kIyMsntg2tOHAWx6zAU=3D?=
X-OriginatorOrg: starfivetech.com
X-MS-Exchange-CrossTenant-Network-Message-Id: e38d52b4-a3f7-4b6c-d02a-08dc749c6078
X-MS-Exchange-CrossTenant-AuthSource: SH0PR01MB0841.CHNPR01.prod.partner.outlook.cn
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 May 2024 05:03:36.3058
 (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: mWvlMVI0psMId/yhlZM86YISN+uwpoUE+QcfkHaFa7dGZbXBkY8k3Kbk3BE8neDVfBhPcRNSosuA+WjjdDl3yB6jPq7YuwIiHSRwPSHrRqs=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SH0PR01MB0859

Add StarFive Starlink cache management driver.
The driver enables RISC-V non-standard cache
operation on SoC that does not support Zicbom
extension instructions.

Signed-off-by: Joshua Yeong <joshua.yeong@starfivetech.com>
---
 drivers/cache/Kconfig                   |   9 ++
 drivers/cache/Makefile                  |   5 +-
 drivers/cache/starfive_starlink_cache.c | 130 ++++++++++++++++++++++++
 3 files changed, 142 insertions(+), 2 deletions(-)
 create mode 100644 drivers/cache/starfive_starlink_cache.c

diff --git a/drivers/cache/Kconfig b/drivers/cache/Kconfig
index 9345ce4976d7..94abd8f632a7 100644
--- a/drivers/cache/Kconfig
+++ b/drivers/cache/Kconfig
@@ -14,4 +14,13 @@ config SIFIVE_CCACHE
 	help
 	  Support for the composable cache controller on SiFive platforms.

+config STARFIVE_STARLINK_CACHE
+	bool "StarFive StarLink Cache controller"
+	depends on RISCV
+	depends on ARCH_STARFIVE
+	select RISCV_DMA_NONCOHERENT
+	select RISCV_NONSTANDARD_CACHE_OPS
+	help
+	  Support for the StarLink cache controller IP from StarFive.
+
 endmenu
diff --git a/drivers/cache/Makefile b/drivers/cache/Makefile
index 7657cff3bd6c..55c5e851034d 100644
--- a/drivers/cache/Makefile
+++ b/drivers/cache/Makefile
@@ -1,4 +1,5 @@
 # SPDX-License-Identifier: GPL-2.0

-obj-$(CONFIG_AX45MP_L2_CACHE)	+= ax45mp_cache.o
-obj-$(CONFIG_SIFIVE_CCACHE)	+= sifive_ccache.o
+obj-$(CONFIG_AX45MP_L2_CACHE)		+= ax45mp_cache.o
+obj-$(CONFIG_SIFIVE_CCACHE)		+= sifive_ccache.o
+obj-$(CONFIG_STARFIVE_STARLINK_CACHE)	+= starfive_starlink_cache.o
diff --git a/drivers/cache/starfive_starlink_cache.c b/drivers/cache/starfive_starlink_cache.c
new file mode 100644
index 000000000000..24c7d078ca22
--- /dev/null
+++ b/drivers/cache/starfive_starlink_cache.c
@@ -0,0 +1,130 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Cache Management Operations for StarFive's Starlink cache controller
+ *
+ * Copyright (C) 2024 Shanghai StarFive Technology Co., Ltd.
+ *
+ * Author: Joshua Yeong <joshua.yeong@starfivetech.com>
+ */
+
+#include <linux/bitfield.h>
+#include <linux/cacheflush.h>
+#include <linux/iopoll.h>
+#include <linux/of_address.h>
+
+#include <asm/dma-noncoherent.h>
+
+#define STARLINK_CACHE_FLUSH_START_ADDR			0x0
+#define STARLINK_CACHE_FLUSH_END_ADDR			0x8
+#define STARLINK_CACHE_FLUSH_CTL			0x10
+#define STARLINK_CACHE_ALIGN				0x40
+
+#define STARLINK_CACHE_ADDRESS_RANGE_MASK		GENMASK(39, 0)
+#define STARLINK_CACHE_FLUSH_CTL_MODE_MASK		GENMASK(2, 1)
+#define STARLINK_CACHE_FLUSH_CTL_ENABLE_MASK		BIT(0)
+
+#define STARLINK_CACHE_FLUSH_CTL_CLEAN_INVALIDATE	0
+#define STARLINK_CACHE_FLUSH_CTL_MAKE_INVALIDATE	1
+#define STARLINK_CACHE_FLUSH_CTL_CLEAN_SHARED		2
+#define STARLINK_CACHE_FLUSH_POLL_DELAY_US		1
+#define STARLINK_CACHE_FLUSH_TIMEOUT_US			5000000
+
+static void __iomem *starlink_cache_base;
+
+static void starlink_cache_flush_complete(void)
+{
+	volatile void __iomem *ctl = starlink_cache_base + STARLINK_CACHE_FLUSH_CTL;
+	u64 v;
+	int ret;
+
+	ret = readq_poll_timeout_atomic(ctl, v, !(v & STARLINK_CACHE_FLUSH_CTL_ENABLE_MASK),
+					STARLINK_CACHE_FLUSH_POLL_DELAY_US,
+					STARLINK_CACHE_FLUSH_TIMEOUT_US);
+	if (ret)
+		WARN(1, "StarFive Starlink cache flush operation timeout\n");
+}
+
+static void starlink_cache_dma_cache_wback(phys_addr_t paddr, unsigned long size)
+{
+	writeq(FIELD_PREP(STARLINK_CACHE_ADDRESS_RANGE_MASK, paddr),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_START_ADDR);
+	writeq(FIELD_PREP(STARLINK_CACHE_ADDRESS_RANGE_MASK, paddr + size),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_END_ADDR);
+
+	mb();
+	writeq(FIELD_PREP(STARLINK_CACHE_FLUSH_CTL_MODE_MASK,
+			  STARLINK_CACHE_FLUSH_CTL_CLEAN_SHARED),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_CTL);
+
+	starlink_cache_flush_complete();
+}
+
+static void starlink_cache_dma_cache_invalidate(phys_addr_t paddr, unsigned long size)
+{
+	writeq(FIELD_PREP(STARLINK_CACHE_ADDRESS_RANGE_MASK, paddr),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_START_ADDR);
+	writeq(FIELD_PREP(STARLINK_CACHE_ADDRESS_RANGE_MASK, paddr + size),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_END_ADDR);
+
+	mb();
+	writeq(FIELD_PREP(STARLINK_CACHE_FLUSH_CTL_MODE_MASK,
+			  STARLINK_CACHE_FLUSH_CTL_MAKE_INVALIDATE),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_CTL);
+
+	starlink_cache_flush_complete();
+}
+
+static void starlink_cache_dma_cache_wback_inv(phys_addr_t paddr, unsigned long size)
+{
+	writeq(FIELD_PREP(STARLINK_CACHE_ADDRESS_RANGE_MASK, paddr),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_START_ADDR);
+	writeq(FIELD_PREP(STARLINK_CACHE_ADDRESS_RANGE_MASK, paddr + size),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_END_ADDR);
+
+	mb();
+	writeq(FIELD_PREP(STARLINK_CACHE_FLUSH_CTL_MODE_MASK,
+			  STARLINK_CACHE_FLUSH_CTL_CLEAN_INVALIDATE),
+	       starlink_cache_base + STARLINK_CACHE_FLUSH_CTL);
+
+	starlink_cache_flush_complete();
+}
+
+static const struct riscv_nonstd_cache_ops starlink_cache_ops = {
+	.wback = &starlink_cache_dma_cache_wback,
+	.inv = &starlink_cache_dma_cache_invalidate,
+	.wback_inv = &starlink_cache_dma_cache_wback_inv,
+};
+
+static const struct of_device_id starlink_cache_ids[] = {
+	{ .compatible = "starfive,jh8100-starlink-cache" },
+	{ /* sentinel */ }
+};
+
+static int __init starlink_cache_init(void)
+{
+	struct device_node *np;
+	u32 block_size;
+	int ret;
+
+	np = of_find_matching_node(NULL, starlink_cache_ids);
+	if (!of_device_is_available(np))
+		return -ENODEV;
+
+	ret = of_property_read_u32(np, "cache-block-size", &block_size);
+	if (ret)
+		return ret;
+
+	if (block_size % STARLINK_CACHE_ALIGN)
+		return -EINVAL;
+
+	starlink_cache_base = of_iomap(np, 0);
+	if (!starlink_cache_base)
+		return -ENOMEM;
+
+	riscv_cbom_block_size = block_size;
+	riscv_noncoherent_supported();
+	riscv_noncoherent_register_cache_ops(&starlink_cache_ops);
+
+	return 0;
+}
+arch_initcall(starlink_cache_init);
--
2.25.1