Received-SPF: pass (google.com: domain of linux-kernel+bounces-158582-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
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] cache: Add StarFive StarLink cache management
Date: Thu, 25 Apr 2024 18:48:40 +0800
Message-Id: <20240425104841.72379-2-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?Oz8FwwMPq3wm1OeJjlMoYiKJ67lDvK3ssbrXivMqHKEarUbcZCREsF7ZSEUM?=
 =?us-ascii?Q?W1lh72QYnYmjN5ER6F+ypzbPdTz4SvEpzVuQKDa08Q0jSSDFaUZofXjP+Kh4?=
 =?us-ascii?Q?LS7ecIAS3n3kOHvEX4725fbuA3aP0UiNQpCJB/ayoHW8m21zDQ3J7wOr9goo?=
 =?us-ascii?Q?Bd/kLgd7fKyvbgkdY0HrmnUNH1ri83amxlDLp0JnjzAMbNHaeI+yF7E2GTYy?=
 =?us-ascii?Q?Gpil03AFLMvnFB+VfyZATYnn2K1j7iKHhvu1wS0IMQdmoBr/+AViJ9AS1RL/?=
 =?us-ascii?Q?QDFJ1zTGuSxuYJXsrWUzNOihtXqJtMYO1w9oUt2PJuZ9uDGmeb07Q2J6dZvH?=
 =?us-ascii?Q?UOXiw6BLR7KMcKx7fY+ypfrVtprrMgE0NkZShRrnIeGArls6yIG49aRPWkVN?=
 =?us-ascii?Q?rI0fZBF7+Zv2ZYjYERah0kTb4w8WWEwzHDanmHpeG0lc5kZ7yuhwVIvav8TT?=
 =?us-ascii?Q?rEgPi8V3xb5A6Pj8qLQxjHkE4JdY3e5O42Has0+/cvEtqNOcl3fKV3VNdZUh?=
 =?us-ascii?Q?fMUGeD1OQJN37J9dbiuU5akSUfT7njtVko55KVLYtxDona7AcmM9I6bfGsR2?=
 =?us-ascii?Q?f3jLRg5WYH6Lz5WmUa3JEBmhTBu46DqhTztrS8nlWpStPZ4/oO3zgyp/m43G?=
 =?us-ascii?Q?oMSzw8H/z62HbHurfWcXkdRlVFLKn2BoSld+Lm0xKNS25l72n+R+b2g6XHwA?=
 =?us-ascii?Q?sWmxjF009FOrWesOhIgjko3MEAfehaMEfGzQuKQALUWJjeA9zgTxue8AuyD3?=
 =?us-ascii?Q?SuI+lRsB0mFVnkZngTPQ/sMmHVEPGeeS7Hx8YPQXBiljVAMKJp7veqRGKBo/?=
 =?us-ascii?Q?rl3LFu5oZVbrLUB30XgummYdW3gESYqUxulEi+jafaXcgy5/EIS4e7X1B37p?=
 =?us-ascii?Q?YvPlCRyTHJNgw9yD/67GcAPwxcTUraHuCgzP5Ti1Pzo58GO9J66zAS+6ijdL?=
 =?us-ascii?Q?y/+dtQZlpcM4rbnzVrHaAyMYTvDpNVrzTxa1OmvKBYIH3mCq6tl1+XmO5As4?=
 =?us-ascii?Q?qViwesjgn2/En/V9oZ5b2AlSm7SRRRypTHeBsH0h1ZFyavye6rXkygyspGCP?=
 =?us-ascii?Q?CGHKUQAdyLK71HAf3VQQFByBrIzN59Sh1m6036H4QhP2SifgiiYelGYO0CMz?=
 =?us-ascii?Q?Svwr6ZiexUxPUQf/tORn5b3MsivYooh5aT90UULyumxH0dtxN5KOAKIzrf4z?=
 =?us-ascii?Q?8aaNXD4Rq4ZgMWbTJkjk86NwDwtotZhyYmipx3vKbBMktSkE/QnkgB6Zo2AW?=
 =?us-ascii?Q?TniHW0t0klbIWcF1fThW1ByhVCA/HiE1OqveH0nVXjnTR7B7rXQ2fhQJl2OG?=
 =?us-ascii?Q?VbMuTb8W8aLyzQFJwz0doaM/N0hivJCer0rliVsNqtCmSTwQ0NdHRPsK/+85?=
 =?us-ascii?Q?suuTfCYExHzv/27ziKmvl06c8ffv45utrMa1PficPaMyR/Z2rHf6w86kMjmA?=
 =?us-ascii?Q?mGn4Mce/Ujk+5ew81eIgb1ByO50UW7HRW9eb7Irnz6XEcA7YxRaDOf136jcr?=
 =?us-ascii?Q?OXG4WNKP5HyFgWiTtJko3gNJB/ooLDHNW8Hf8h2kKRSvUZfmuZQN1TSkKMMY?=
 =?us-ascii?Q?1ekAQ2Arhvq2CoGm9pkJdP63SSWtxMsf5gNe4LGFil8LBVZ9HzBaeuLbQRpD?=
 =?us-ascii?Q?UQlepTvXLcE4N+zMamJKNmw=3D?=
X-OriginatorOrg: starfivetech.com
X-MS-Exchange-CrossTenant-Network-Message-Id: eb29ef21-1597-4519-b8eb-08dc6515533e
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:04.6258
 (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: Ufqo4WDviBmQ7WuilaE+3mvW/17r5B0pl1XP07J4SLvls3LEmwKLdi3z5OM5eneZNIkLY673hzVhx6Au7Pai6P1U4sxuKD+rLChrO1Bgbz8=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SH0PR01MB0491

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