Skip to contentSkip to conversation

Register Zicntr in FDT when emulating is possible

PATCH Superseded Yao Zi 2 participants 4 messages Apr 18, 2025 – Apr 19, 2025

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Yao Zi

author
#0 lore raw

v2 cover Register Zicntr in FDT when emulating is possible

OpenSBI is capable of emulating time CSR on HARTs without a full Zicntr extension. Previously, we hardcoded Zicntr extension in the devicetree for these cores, like JH7110 in mainline Linux[1]. This doesn't reflect the hardware and may confuse pre-SBI bootloaders, like U-Boot running in M-Mode.

To solve the issue, let's register Zicntr in FDT dynamically for cores supporting it by SBI emulation, allowing pre-SBI stages to detect Zicntr availability reliably with riscv,isa-extensions.

[1]: https://elixir.bootlin.com/linux/v6.14-rc3/source/arch/riscv/boot/dts/starfive/jh7110.dtsi#L61

Changed from v1
- Zicntr detection
- Introduce a bitmap to sbi_hart_features instead of using pseudo- extensions to represent availability of CSRs
- Change possibly misleading abbreviation "RO" to "read-only" in commit message
- FDT fixup
- Don't register zicntr to (legacy) devicetrees where harts don't come with a riscv,isa-extensions property

Yao Zi (2):
lib: sbi: hart: Detect existence of cycle and instret CSRs for Zicntr
lib: utils: fdt: Claim Zicntr if time CSR emulation is possible

 include/sbi/sbi_hart.h    |  9 +++++++++
 lib/sbi/sbi_hart.c        | 35 ++++++++++++++++++++++++++++-------
 lib/utils/fdt/fdt_fixup.c | 33 ++++++++++++++++++++++++++++++++-
 3 files changed, 69 insertions(+), 8 deletions(-)
Signature · 7 lines
2.49.0


-- 
opensbi mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/opensbi
author
#1 lore raw

PATCH v2 1/2 lib: sbi: hart: Detect existence of cycle and instret CSRs for Zicntr

Zicntr extension specifies three read-only CSRs, time, cycle and instret. It isn't sufficient to report Zicntr is fully supported with only time CSR detected.

This patch introduces a bitmap to sbi_hart_features to record availability of these CSRs, which are detected using traps. Zicntr is reported as present if and only if three CSRs are all available on the HARTs.

---
 include/sbi/sbi_hart.h |  9 +++++++++
 lib/sbi/sbi_hart.c     | 35 ++++++++++++++++++++++++++++-------
 2 files changed, 37 insertions(+), 7 deletions(-)
include/sbi/sbi_hart.h +9 -0
index c3a7feb..48edafe 100644
@@ -91,6 +91,13 @@ struct sbi_hart_ext_data {
 
 extern const struct sbi_hart_ext_data sbi_hart_ext[];
 
+/** CSRs should be detected by access and trapping */
+enum sbi_hart_csrs {
+	SBI_HART_CSR_CYCLE = 0,
+	SBI_HART_CSR_TIME,
+	SBI_HART_CSR_INSTRET,
+};
+
 /*
  * Smepmp enforces access boundaries between M-mode and
  * S/U-mode. When it is enabled, the PMPs are programmed
@@ -110,6 +117,7 @@ struct sbi_hart_features {
 	bool detected;
 	int priv_version;
 	unsigned long extensions[BITS_TO_LONGS(SBI_HART_EXT_MAX)];
+	unsigned long csrs;
 	unsigned int pmp_count;
 	unsigned int pmp_addr_bits;
 	unsigned int pmp_log2gran;
@@ -148,6 +156,7 @@ bool sbi_hart_has_extension(struct sbi_scratch *scratch,
 			    enum sbi_hart_extensions ext);
 void sbi_hart_get_extensions_str(struct sbi_scratch *scratch,
 				 char *extension_str, int nestr);
+bool sbi_hart_has_csr(struct sbi_scratch *scratch, enum sbi_hart_csrs csr);
 
 void __attribute__((noreturn)) sbi_hart_hang(void);
 
lib/sbi/sbi_hart.c +28 -7
index c343805..f98b6b0 100644
@@ -733,6 +733,20 @@ void sbi_hart_get_extensions_str(struct sbi_scratch *scratch,
 		sbi_strncpy(extensions_str, "none", nestr);
 }
 
+/**
+ * Check whether a particular CSR is present on the HART
+ *
+ * @param scratch pointer to the HART scratch space
+ * @param csr the CSR number to check
+ */
+bool sbi_hart_has_csr(struct sbi_scratch *scratch, enum sbi_hart_csrs csr)
+{
+	struct sbi_hart_features *hfeatures =
+			sbi_scratch_offset_ptr(scratch, hart_features_offset);
+
+	return (hfeatures->csrs >> csr) & 1UL;
+}
+
 static unsigned long hart_pmp_get_allowed_addr(void)
 {
 	unsigned long val = 0;
@@ -789,7 +803,6 @@ static int hart_detect_features(struct sbi_scratch *scratch)
 	struct sbi_hart_features *hfeatures =
 		sbi_scratch_offset_ptr(scratch, hart_features_offset);
 	unsigned long val, oldval;
-	bool has_zicntr = false;
 	int rc;
 
 	/* If hart features already detected then do nothing */
@@ -798,6 +811,7 @@ static int hart_detect_features(struct sbi_scratch *scratch)
 
 	/* Clear hart features */
 	sbi_memset(hfeatures->extensions, 0, sizeof(hfeatures->extensions));
+	hfeatures->csrs = 0;
 	hfeatures->pmp_count = 0;
 	hfeatures->mhpm_mask = 0;
 	hfeatures->priv_version = SBI_HART_PRIV_VER_UNKNOWN;
@@ -924,9 +938,6 @@ __pmp_skip:
 	/* Detect if hart supports sscofpmf */
 	__check_ext_csr(SBI_HART_PRIV_VER_1_11,
 			CSR_SCOUNTOVF, SBI_HART_EXT_SSCOFPMF);
-	/* Detect if hart supports time CSR */
-	__check_ext_csr(SBI_HART_PRIV_VER_UNKNOWN,
-			CSR_TIME, SBI_HART_EXT_ZICNTR);
 	/* Detect if hart has AIA local interrupt CSRs */
 	__check_ext_csr(SBI_HART_PRIV_VER_UNKNOWN,
 			CSR_MTOPI, SBI_HART_EXT_SMAIA);
@@ -945,8 +956,16 @@ __pmp_skip:
 
 #undef __check_ext_csr
 
-	/* Save trap based detection of Zicntr */
-	has_zicntr = sbi_hart_has_extension(scratch, SBI_HART_EXT_ZICNTR);
+#define __check_csr_existence(__csr, __csr_id)				\
+	csr_read_allowed(__csr, &trap);					\
+	if (!trap.cause)						\
+		hfeatures->csrs |= 1 << __csr_id;
+
+	__check_csr_existence(CSR_CYCLE, SBI_HART_CSR_CYCLE);
+	__check_csr_existence(CSR_TIME, SBI_HART_CSR_TIME);
+	__check_csr_existence(CSR_INSTRET, SBI_HART_CSR_INSTRET);
+
+#undef __check_csr_existence
 
 	/* Let platform populate extensions */
 	rc = sbi_platform_extensions_init(sbi_platform_thishart_ptr(),
@@ -956,7 +975,9 @@ __pmp_skip:
 
 	/* Zicntr should only be detected using traps */
 	__sbi_hart_update_extension(hfeatures, SBI_HART_EXT_ZICNTR,
-				    has_zicntr);
+			    (hfeatures->csrs & BIT(SBI_HART_CSR_CYCLE))	&&
+			    (hfeatures->csrs & BIT(SBI_HART_CSR_TIME))	&&
+			    (hfeatures->csrs & BIT(SBI_HART_CSR_INSTRET)));
 
 	/* Extensions implied by other extensions and features */
 	if (hfeatures->mhpm_mask)
Signature · 7 lines
2.49.0


-- 
opensbi mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/opensbi
#2 lore raw

Re: [PATCH v2 1/2] lib: sbi: hart: Detect existence of cycle and instret CSRs for Zicntr

Quoted 24 lines · 在 2025-04-18五的 14:47 +0000,Yao Zi写道:

Zicntr extension specifies three read-only CSRs, time, cycle and instret. It isn't sufficient to report Zicntr is fully supported with only time CSR detected.

This patch introduces a bitmap to sbi_hart_features to record availability of these CSRs, which are detected using traps. Zicntr is reported as present if and only if three CSRs are all available on the HARTs.

---
 include/sbi/sbi_hart.h |  9 +++++++++ lib/sbi/sbi_hart.c     | 35 ++++++++++++++++++++++++++++-------

 2 files changed, 37 insertions(+), 7 deletions(-)
include/sbi/sbi_hart.h +0 -0
index c3a7feb..48edafe 100644
@@ -91,6 +91,13 @@ struct sbi_hart_ext_data {


 extern const struct sbi_hart_ext_data sbi_hart_ext[];

include/sbi/sbi_hart.h struct sbi_hart_ext_data { · line 98

Quoted 5 lines
include/sbi/sbi_hart.h +5 -0
+/** CSRs should be detected by access and trapping */
+enum sbi_hart_csrs {
+	SBI_HART_CSR_CYCLE = 0,
+	SBI_HART_CSR_TIME,
+	SBI_HART_CSR_INSTRET,

add SBI_HART_CSR_MAX

include/sbi/sbi_hart.h struct sbi_hart_features { · line 120

Quoted 10 lines
include/sbi/sbi_hart.h +2 -0
+};
+

 /*
  * Smepmp enforces access boundaries between M-mode and
  * S/U-mode. When it is enabled, the PMPs are programmed

include/sbi/sbi_hart.h +1 -0
@@ -110,6 +117,7 @@ struct sbi_hart_features {
  	bool detected;
  	int priv_version;
  	unsigned long extensions[BITS_TO_LONGS(SBI_HART_EXT_MAX)];
+	unsigned long csrs;

change to unsigned long csrs[BITS_TO_LONGS(SBI_HART_CSR_MAX)];

To make the code more flexible, it is recommended to add the above modification

Regards,
Xiang W

Quoted 95 lines
include/sbi/sbi_hart.h +1 -0
  	unsigned int pmp_count;
  	unsigned int pmp_addr_bits;
  	unsigned int pmp_log2gran;
@@ -148,6 +156,7 @@ bool sbi_hart_has_extension(struct sbi_scratch *scratch,
  			    enum sbi_hart_extensions ext);
  void sbi_hart_get_extensions_str(struct sbi_scratch *scratch,
  				 char *extension_str, int nestr);
+bool sbi_hart_has_csr(struct sbi_scratch *scratch, enum sbi_hart_csrs csr);


 void __attribute__((noreturn)) sbi_hart_hang(void);

lib/sbi/sbi_hart.c +0 -0
index c343805..f98b6b0 100644
@@ -733,6 +733,20 @@ void sbi_hart_get_extensions_str(struct sbi_scratch *scratch,
  		sbi_strncpy(extensions_str, "none", nestr);
  }

lib/sbi/sbi_hart.c +14 -0
+/**
+ * Check whether a particular CSR is present on the HART
+ *
+ * @param scratch pointer to the HART scratch space
+ * @param csr the CSR number to check
+ */
+bool sbi_hart_has_csr(struct sbi_scratch *scratch, enum sbi_hart_csrs csr)
+{
+	struct sbi_hart_features *hfeatures =
+			sbi_scratch_offset_ptr(scratch, hart_features_offset);
+
+	return (hfeatures->csrs >> csr) & 1UL;
+}
+

 static unsigned long hart_pmp_get_allowed_addr(void) {
  unsigned long val = 0;

lib/sbi/sbi_hart.c +0 -0
@@ -789,7 +803,6 @@ static int hart_detect_features(struct sbi_scratch *scratch)

  struct sbi_hart_features *hfeatures = sbi_scratch_offset_ptr(scratch, hart_features_offset); unsigned long val, oldval;

lib/sbi/sbi_hart.c +0 -1
-	bool has_zicntr = false;

  int rc;

  /* If hart features already detected then do nothing */

lib/sbi/sbi_hart.c +0 -0
@@ -798,6 +811,7 @@ static int hart_detect_features(struct sbi_scratch *scratch)


  /* Clear hart features */ sbi_memset(hfeatures->extensions, 0, sizeof(hfeatures->extensions));

lib/sbi/sbi_hart.c +1 -0
+	hfeatures->csrs = 0;

  hfeatures->pmp_count = 0; hfeatures->mhpm_mask = 0; hfeatures->priv_version = SBI_HART_PRIV_VER_UNKNOWN;

lib/sbi/sbi_hart.c +0 -3
@@ -924,9 +938,6 @@ __pmp_skip:
  	/* Detect if hart supports sscofpmf */
  	__check_ext_csr(SBI_HART_PRIV_VER_1_11,
  			CSR_SCOUNTOVF, SBI_HART_EXT_SSCOFPMF);
-	/* Detect if hart supports time CSR */
-	__check_ext_csr(SBI_HART_PRIV_VER_UNKNOWN,
-			CSR_TIME, SBI_HART_EXT_ZICNTR);
  	/* Detect if hart has AIA local interrupt CSRs */
  	__check_ext_csr(SBI_HART_PRIV_VER_UNKNOWN,
  			CSR_MTOPI, SBI_HART_EXT_SMAIA);
@@ -945,8 +956,16 @@ __pmp_skip:


 #undef __check_ext_csr

lib/sbi/sbi_hart.c +10 -2
-	/* Save trap based detection of Zicntr */
-	has_zicntr = sbi_hart_has_extension(scratch, SBI_HART_EXT_ZICNTR);
+#define __check_csr_existence(__csr, __csr_id)				\
+	csr_read_allowed(__csr, &trap);					\
+	if (!trap.cause)						\
+		hfeatures->csrs |= 1 << __csr_id;
+
+	__check_csr_existence(CSR_CYCLE, SBI_HART_CSR_CYCLE);
+	__check_csr_existence(CSR_TIME, SBI_HART_CSR_TIME);
+	__check_csr_existence(CSR_INSTRET, SBI_HART_CSR_INSTRET);
+
+#undef __check_csr_existence


  /* Let platform populate extensions */
  rc = sbi_platform_extensions_init(sbi_platform_thishart_ptr(),

lib/sbi/sbi_hart.c +0 -0
@@ -956,7 +975,9 @@ __pmp_skip:


  /* Zicntr should only be detected using traps */ __sbi_hart_update_extension(hfeatures, SBI_HART_EXT_ZICNTR,

lib/sbi/sbi_hart.c +3 -1
-				    has_zicntr);
+			    (hfeatures->csrs & BIT(SBI_HART_CSR_CYCLE))	&&
+			    (hfeatures->csrs & BIT(SBI_HART_CSR_TIME))	&&
+			    (hfeatures->csrs & BIT(SBI_HART_CSR_INSTRET)));


  /* Extensions implied by other extensions and features */ if (hfeatures->mhpm_mask)

Signature · 1 line
2.49.0
Signature · 3 lines
opensbi mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/opensbi
author
#3 lore raw

PATCH v2 2/2 lib: utils: fdt: Claim Zicntr if time CSR emulation is possible

In reply to Yao Zi

OpenSBI is capable of emulating time CSR through an external timer for HARTs that don't implement a full Zicntr extension. Let's register Zicntr extension in the FDT if CSR emulation is active.

This avoids hardcoding the extension in the devicetree, which may confuse pre-SBI bootloaders.

---
 lib/utils/fdt/fdt_fixup.c | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)
lib/utils/fdt/fdt_fixup.c +32 -1
index e237dd0..f3fe8af 100644
@@ -16,6 +16,7 @@
 #include <sbi/sbi_scratch.h>
 #include <sbi/sbi_string.h>
 #include <sbi/sbi_error.h>
+#include <sbi/sbi_timer.h>
 #include <sbi_utils/fdt/fdt_fixup.h>
 #include <sbi_utils/fdt/fdt_pmu.h>
 #include <sbi_utils/fdt/fdt_helper.h>
@@ -107,10 +108,21 @@ int fdt_add_cpu_idle_states(void *fdt, const struct sbi_cpu_idle_state *state)
 
 void fdt_cpu_fixup(void *fdt)
 {
+	struct sbi_scratch *scratch = sbi_scratch_thishart_ptr();
 	struct sbi_domain *dom = sbi_domain_thishart_ptr();
 	int err, cpu_offset, cpus_offset, len;
-	const char *mmu_type;
+	const char *mmu_type, *extensions;
 	u32 hartid, hartindex;
+	bool emulated_zicntr;
+
+	/*
+	 * Claim Zicntr extension in riscv,isa-extensions if
+	 *  1. OpenSBI can emulate time CSR with a timer
+	 *  2. The other two CSRs specified by Zicntr are available
+	 */
+	emulated_zicntr = sbi_timer_get_device() != NULL &&
+			  sbi_hart_has_csr(scratch, SBI_HART_CSR_CYCLE) &&
+			  sbi_hart_has_csr(scratch, SBI_HART_CSR_INSTRET);
 
 	err = fdt_open_into(fdt, fdt, fdt_totalsize(fdt) + 32);
 	if (err < 0)
@@ -140,6 +152,25 @@ void fdt_cpu_fixup(void *fdt)
 		    !mmu_type || !len)
 			fdt_setprop_string(fdt, cpu_offset, "status",
 					   "disabled");
+
+		if (!emulated_zicntr)
+			continue;
+
+		extensions = fdt_getprop(fdt, cpu_offset,
+					 "riscv,isa-extensions", &len);
+		/*
+		 * For legacy devicetrees, don't create riscv,isa-extensions
+		 * property if there hasn't been already one.
+		 */
+		if (extensions &&
+		    !fdt_stringlist_contains(extensions, len, "zicntr")) {
+			err = fdt_open_into(fdt, fdt, fdt_totalsize(fdt) + 16);
+			if (err)
+				continue;
+
+			fdt_appendprop_string(fdt, cpu_offset,
+					      "riscv,isa-extensions", "zicntr");
+		}
 	}
 }
 
Signature · 7 lines
2.49.0


-- 
opensbi mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/opensbi