Skip to contentSkip to conversation

lib: utils: Add fdt_add_cpu_idle_states() helper function

PATCH New Samuel Holland 2 participants 4 messages Jan 23, 2023 – Jan 24, 2023 Arm/Allwinner sunXi SoC support

lore
Share & tools
lore

Samuel Holland

author maintainer
#0 lore raw

PATCH v2 1/2 lib: utils: Add fdt_add_cpu_idle_states() helper function

Since the availability and latency properties of CPU idle states depend on the specific SBI HSM implementation, it is appropriate that the idle states are added to the devicetree at runtime by that implementation.

This helper function adds a platform-provided array of idle states to the devicetree, following the SBI idle state binding.

---

Changes in v2:
- Do nothing if the idle-states node already exists

 include/sbi_utils/fdt/fdt_fixup.h | 23 +++++++++
 lib/utils/fdt/fdt_fixup.c         | 85 +++++++++++++++++++++++++++++++
 2 files changed, 108 insertions(+)
include/sbi_utils/fdt/fdt_fixup.h +23 -0
index fb076ba..cab3f0f 100644
@@ -9,6 +9,29 @@
 #ifndef __FDT_FIXUP_H__
 #define __FDT_FIXUP_H__
 
+struct sbi_cpu_idle_state {
+	const char *name;
+	uint32_t suspend_param;
+	bool local_timer_stop;
+	uint32_t entry_latency_us;
+	uint32_t exit_latency_us;
+	uint32_t min_residency_us;
+	uint32_t wakeup_latency_us;
+};
+
+/**
+ * Add CPU idle states to cpu nodes in the DT
+ *
+ * Add information about CPU idle states to the devicetree. This function
+ * assumes that CPU idle states are not already present in the devicetree, and
+ * that all CPU states are equally applicable to all CPUs.
+ *
+ * @param fdt: device tree blob
+ * @param states: array of idle state descriptions, ending with empty element
+ * @return zero on success and -ve on failure
+ */
+int fdt_add_cpu_idle_states(void *dtb, const struct sbi_cpu_idle_state *state);
+
 /**
  * Fix up the CPU node in the device tree
  *
lib/utils/fdt/fdt_fixup.c +85 -0

91 lines not on this page · raw message

Signature · 1 line
2.37.4
author maintainer
#1 lore raw

PATCH v2 2/2 platform: generic: allwinner: Advertise nonretentive suspend

Add D1's nonretentive suspend state to the devicetree so S-mode software knows about it and can use it.

Latency and power measurements were taken on an Allwinner Nezha board:
- Entry latency was measured from the beginning of sbi_ecall_handler() to before the call to wfi() in sun20i_d1_hart_suspend().
- Exit latency was measured from the beginning of sbi_init() to before the call to sbi_hart_switch_mode() in init_warmboot().
- There was a 17.5 mW benefit from non-retentive suspend compared to WFI, with a 170 mW cost during the 107 us entry/exit period. This provides a break-even point around 1040 us. Residency includes entry latency, so round this up to 1100 us.
- The hardware power sequence latency (after the WFI) is assumed to be negligible, so set the wakeup latency to the exit latency.

---

(no changes since v1)

 platform/generic/allwinner/sun20i-d1.c | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
platform/generic/allwinner/sun20i-d1.c +20 -0
index e2b76a3..295c159 100644
@@ -12,6 +12,7 @@
 #include <sbi/sbi_error.h>
 #include <sbi/sbi_hsm.h>
 #include <sbi/sbi_pmu.h>
+#include <sbi_utils/fdt/fdt_fixup.h>
 #include <sbi_utils/fdt/fdt_helper.h>
 #include <sbi_utils/irqchip/fdt_irqchip_plic.h>
 
@@ -202,6 +203,24 @@ static int sun20i_d1_final_init(bool cold_boot, const struct fdt_match *match)
 	return 0;
 }
 
+static const struct sbi_cpu_idle_state sun20i_d1_cpu_idle_states[] = {
+	{
+		.name			= "cpu-nonretentive",
+		.suspend_param		= SBI_HSM_SUSPEND_NON_RET_DEFAULT,
+		.local_timer_stop	= true,
+		.entry_latency_us	= 40,
+		.exit_latency_us	= 67,
+		.min_residency_us	= 1100,
+		.wakeup_latency_us	= 67,
+	},
+	{ }
+};
+
+static int sun20i_d1_fdt_fixup(void *fdt, const struct fdt_match *match)
+{
+	return fdt_add_cpu_idle_states(fdt, sun20i_d1_cpu_idle_states);
+}
+
 static void thead_c9xx_pmu_ctr_enable_irq(uint32_t ctr_idx)
 {
 	unsigned long mip_val;
@@ -265,5 +284,6 @@ static const struct fdt_match sun20i_d1_match[] = {
 const struct platform_override sun20i_d1 = {
 	.match_table	= sun20i_d1_match,
 	.final_init	= sun20i_d1_final_init,
+	.fdt_fixup	= sun20i_d1_fdt_fixup,
 	.extensions_init = sun20i_d1_extensions_init,
 };
Signature · 1 line
2.37.4
Applied
#2 lore raw

PATCH v2 2/2 platform: generic: allwinner: Advertise nonretentive suspend

Quoted 16 lines · Samuel Holland

Add D1's nonretentive suspend state to the devicetree so S-mode software knows about it and can use it.

Latency and power measurements were taken on an Allwinner Nezha board:
- Entry latency was measured from the beginning of sbi_ecall_handler() to before the call to wfi() in sun20i_d1_hart_suspend().
- Exit latency was measured from the beginning of sbi_init() to before the call to sbi_hart_switch_mode() in init_warmboot().
- There was a 17.5 mW benefit from non-retentive suspend compared to WFI, with a 170 mW cost during the 107 us entry/exit period. This provides a break-even point around 1040 us. Residency includes entry latency, so round this up to 1100 us.
- The hardware power sequence latency (after the WFI) is assumed to be negligible, so set the wakeup latency to the exit latency.

Quoted 2 lines

Applied this patch to the riscv/opensbi repo.

Thanks,
Anup

Quoted 54 lines

---

(no changes since v1)

 platform/generic/allwinner/sun20i-d1.c | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
platform/generic/allwinner/sun20i-d1.c +20 -1
index e2b76a3..295c159 100644
@@ -12,6 +12,7 @@
 #include <sbi/sbi_error.h>
 #include <sbi/sbi_hsm.h>
 #include <sbi/sbi_pmu.h>
+#include <sbi_utils/fdt/fdt_fixup.h>
 #include <sbi_utils/fdt/fdt_helper.h>
 #include <sbi_utils/irqchip/fdt_irqchip_plic.h>
 
@@ -202,6 +203,24 @@ static int sun20i_d1_final_init(bool cold_boot, const struct fdt_match *match)
        return 0;
 }
 
+static const struct sbi_cpu_idle_state sun20i_d1_cpu_idle_states[] = {
+       {
+               .name                   = "cpu-nonretentive",
+               .suspend_param          = SBI_HSM_SUSPEND_NON_RET_DEFAULT,
+               .local_timer_stop       = true,
+               .entry_latency_us       = 40,
+               .exit_latency_us        = 67,
+               .min_residency_us       = 1100,
+               .wakeup_latency_us      = 67,
+       },
+       { }
+};
+
+static int sun20i_d1_fdt_fixup(void *fdt, const struct fdt_match *match)
+{
+       return fdt_add_cpu_idle_states(fdt, sun20i_d1_cpu_idle_states);
+}
+
 static void thead_c9xx_pmu_ctr_enable_irq(uint32_t ctr_idx)
 {
        unsigned long mip_val;
@@ -265,5 +284,6 @@ static const struct fdt_match sun20i_d1_match[] = {
 const struct platform_override sun20i_d1 = {
        .match_table    = sun20i_d1_match,
        .final_init     = sun20i_d1_final_init,
+       .fdt_fixup      = sun20i_d1_fdt_fixup,
        .extensions_init = sun20i_d1_extensions_init,
 };
--

2.37.4

Applied
#3 lore raw

PATCH v2 1/2 lib: utils: Add fdt_add_cpu_idle_states() helper function

In reply to Samuel Holland
Quoted 10 lines · Samuel Holland

Since the availability and latency properties of CPU idle states depend on the specific SBI HSM implementation, it is appropriate that the idle states are added to the devicetree at runtime by that implementation.

This helper function adds a platform-provided array of idle states to the devicetree, following the SBI idle state binding.

Applied this patch to the riscv/opensbi repo.

Thanks,
Anup

Quoted 142 lines

---

Changes in v2:
- Do nothing if the idle-states node already exists

 include/sbi_utils/fdt/fdt_fixup.h | 23 +++++++++
 lib/utils/fdt/fdt_fixup.c         | 85 +++++++++++++++++++++++++++++++
 2 files changed, 108 insertions(+)
include/sbi_utils/fdt/fdt_fixup.h +23 -0
index fb076ba..cab3f0f 100644
@@ -9,6 +9,29 @@
 #ifndef __FDT_FIXUP_H__
 #define __FDT_FIXUP_H__
 
+struct sbi_cpu_idle_state {
+       const char *name;
+       uint32_t suspend_param;
+       bool local_timer_stop;
+       uint32_t entry_latency_us;
+       uint32_t exit_latency_us;
+       uint32_t min_residency_us;
+       uint32_t wakeup_latency_us;
+};
+
+/**
+ * Add CPU idle states to cpu nodes in the DT
+ *
+ * Add information about CPU idle states to the devicetree. This function
+ * assumes that CPU idle states are not already present in the devicetree, and
+ * that all CPU states are equally applicable to all CPUs.
+ *
+ * @param fdt: device tree blob
+ * @param states: array of idle state descriptions, ending with empty element
+ * @return zero on success and -ve on failure
+ */
+int fdt_add_cpu_idle_states(void *dtb, const struct sbi_cpu_idle_state *state);
+
 /**
  * Fix up the CPU node in the device tree
  *
lib/utils/fdt/fdt_fixup.c +85 -1
index 42692cc..e57a4e1 100644
@@ -18,6 +18,91 @@
 #include <sbi_utils/fdt/fdt_pmu.h>
 #include <sbi_utils/fdt/fdt_helper.h>
 
+int fdt_add_cpu_idle_states(void *fdt, const struct sbi_cpu_idle_state *state)
+{
+       int cpu_node, cpus_node, err, idle_states_node;
+       uint32_t count, phandle;
+
+       err = fdt_open_into(fdt, fdt, fdt_totalsize(fdt) + 1024);
+       if (err < 0)
+               return err;
+
+       err = fdt_find_max_phandle(fdt, &phandle);
+       phandle++;
+       if (err < 0)
+               return err;
+
+       cpus_node = fdt_path_offset(fdt, "/cpus");
+       if (cpus_node < 0)
+               return cpus_node;
+
+       /* Do nothing if the idle-states node already exists. */
+       idle_states_node = fdt_subnode_offset(fdt, cpus_node, "idle-states");
+       if (idle_states_node >= 0)
+               return 0;
+
+       /* Create the idle-states node and its child nodes. */
+       idle_states_node = fdt_add_subnode(fdt, cpus_node, "idle-states");
+       if (idle_states_node < 0)
+               return idle_states_node;
+
+       for (count = 0; state->name; count++, phandle++, state++) {
+               int idle_state_node;
+
+               idle_state_node = fdt_add_subnode(fdt, idle_states_node,
+                                                 state->name);
+               if (idle_state_node < 0)
+                       return idle_state_node;
+
+               fdt_setprop_string(fdt, idle_state_node, "compatible",
+                                  "riscv,idle-state");
+               fdt_setprop_u32(fdt, idle_state_node,
+                               "riscv,sbi-suspend-param",
+                               state->suspend_param);
+               if (state->local_timer_stop)
+                       fdt_setprop_empty(fdt, idle_state_node,
+                                         "local-timer-stop");
+               fdt_setprop_u32(fdt, idle_state_node, "entry-latency-us",
+                               state->entry_latency_us);
+               fdt_setprop_u32(fdt, idle_state_node, "exit-latency-us",
+                               state->exit_latency_us);
+               fdt_setprop_u32(fdt, idle_state_node, "min-residency-us",
+                               state->min_residency_us);
+               if (state->wakeup_latency_us)
+                       fdt_setprop_u32(fdt, idle_state_node,
+                                       "wakeup-latency-us",
+                                       state->wakeup_latency_us);
+               fdt_setprop_u32(fdt, idle_state_node, "phandle", phandle);
+       }
+
+       if (count == 0)
+               return 0;
+
+       /* Link each cpu node to the idle state nodes. */
+       fdt_for_each_subnode(cpu_node, fdt, cpus_node) {
+               const char *device_type;
+               fdt32_t *value;
+
+               /* Only process child nodes with device_type = "cpu". */
+               device_type = fdt_getprop(fdt, cpu_node, "device_type", NULL);
+               if (!device_type || strcmp(device_type, "cpu"))
+                       continue;
+
+               /* Allocate space for the list of phandles. */
+               err = fdt_setprop_placeholder(fdt, cpu_node, "cpu-idle-states",
+                                             count * sizeof(phandle),
+                                             (void **)&value);
+               if (err < 0)
+                       return err;
+
+               /* Fill in the phandles of the idle state nodes. */
+               for (uint32_t i = 0; i < count; ++i)
+                       value[i] = cpu_to_fdt32(phandle - count + i);
+       }
+
+       return 0;
+}
+
 void fdt_cpu_fixup(void *fdt)
 {
        struct sbi_domain *dom = sbi_domain_thishart_ptr();
--

2.37.4