arch: arm: cortex-m: implement timing.c based on DWT

For Cortex-M platforms with DWT we implement
the timing API (timing.c).

Signed-off-by: Ioannis Glaropoulos <[email protected]>

Author: ioannisg

arch/arm/core/aarch32/cortex_m/CMakeLists.txt

@@ -15,6 +15,12 @@ zephyr_library_sources(
 
 zephyr_library_sources_ifdef(CONFIG_DEBUG_COREDUMP coredump.c)
 
+if(CONFIG_CORTEX_M_DWT)
+	if (CONFIG_TIMING_FUNCTIONS)
+		zephyr_library_sources(timing.c)
+	endif()
+endif()
+
 if (CONFIG_SW_VECTOR_RELAY)
 if (CONFIG_CPU_CORTEX_M_HAS_VTOR)
   set(relay_vector_table_sort_key relay_vectors)

arch/arm/core/aarch32/cortex_m/Kconfig

@@ -288,6 +288,13 @@ config SW_VECTOR_RELAY_CLIENT
 	  sure the vector table pointer in RAM is set properly by the image upon
 	  initialization.
 
+config CORTEX_M_DWT
+	bool "Enable and use the DWT"
+	depends on CPU_CORTEX_M_HAS_DWT
+	default y if TIMING_FUNCTIONS
+	help
+	  Enable and use the Data Watchpoint and Trace (DWT) unit for
+	  timing functions.
 endmenu
 
 rsource "mpu/Kconfig"

arch/arm/core/aarch32/cortex_m/timing.c

@@ -0,0 +1,168 @@
+/*
+ * Copyright (c) 2020 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file
+ * @brief ARM Cortex-M Timing functions interface based on DWT
+ *
+ */
+
+#include <init.h>
+#include <timing/timing.h>
+#include <arch/arm/aarch32/cortex_m/cmsis.h>
+
+
+/**
+ * @brief Initialize and Enable the DWT cycle counter
+ *
+ * This routine enables the cycle counter and initializes its value to zero.
+ *
+ * @return 0
+ */
+static inline int z_arm_dwt_init(struct device *arg)
+{
+	/* Enable tracing */
+	CoreDebug->DEMCR |= CoreDebug_DEMCR_TRCENA_Msk;
+
+	/* Clear and enable the cycle counter */
+	DWT->CYCCNT = 0;
+	DWT->CTRL |= DWT_CTRL_CYCCNTENA_Msk;
+
+	/* Assert that the cycle counter is indeed implemented. */
+	__ASSERT(DWT->CTRL & DWT_CTRL_NOCYCCNT_Msk != 0,
+		"DWT implements no cycle counter. "
+		"Cannot be used for cycle counting\n");
+
+	return 0;
+}
+
+/**
+ * @brief Return the current value of the cycle counter
+ *
+ * This routine returns the current value of the DWT Cycle Counter (DWT.CYCCNT)
+ *
+ * @return the cycle counter value
+ */
+static inline uint32_t z_arm_dwt_get_cycles(void)
+{
+	return DWT->CYCCNT;
+}
+
+/**
+ * @brief Reset and start the DWT cycle counter
+ *
+ * This routine starts the cycle counter and resets its value to zero.
+ *
+ * @return 0
+ */
+static inline void z_arm_dwt_cycle_count_start(void)
+{
+	DWT->CYCCNT = 0;
+	DWT->CTRL |= DWT_CTRL_CYCCNTENA_Msk;
+}
+
+/**
+ * @brief Return the current frequency of the cycle counter
+ *
+ * This routine returns the current frequency of the DWT Cycle Counter
+ * in DWT cycles per second (Hz).
+ *
+ * @return the cycle counter frequency value
+ */
+static inline uint64_t z_arm_dwt_freq_get(void)
+{
+#if defined(CONFIG_SOC_FAMILY_NRF)
+	/*
+	 * DWT frequency is taken directly from the
+	 * System Core clock (CPU) frequency, if the
+	 * CMSIS SystemCoreClock symbols is available.
+	 */
+	SystemCoreClockUpdate();
+
+	return SystemCoreClock;
+#elif defined(CONFIG_CORTEX_M_SYSTICK)
+	/* SysTick and DWT both run at CPU frequency,
+	 * reflected in the system timer HW cycles/sec.
+	 */
+	return CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC;
+#else
+	static uint64_t dwt_frequency;
+
+	if (!dwt_frequency) {
+
+		z_arm_dwt_init(NULL);
+
+		uint32_t cyc_start = k_cycle_get_32();
+		uint64_t dwt_start = z_arm_dwt_get_cycles();
+
+		k_busy_wait(10 * USEC_PER_MSEC);
+
+		uint32_t cyc_end = k_cycle_get_32();
+		uint64_t dwt_end = z_arm_dwt_get_cycles();
+
+		uint64_t cyc_freq = sys_clock_hw_cycles_per_sec();
+
+		/*
+		 * cycles are in 32-bit, and delta must be
+		 * calculated in 32-bit percision. Or it would
+		 * wrapping around in 64-bit.
+		 */
+		uint64_t dcyc = (uint32_t)cyc_end - (uint32_t)cyc_start;
+
+		uint64_t dtsc = dwt_end - dwt_start;
+
+		dwt_frequency = (cyc_freq * dtsc) / dcyc;
+
+	}
+	return dwt_frequency;
+#endif /* CONFIG_SOC_FAMILY_NRF */
+}
+
+void timing_init(void)
+{
+	z_arm_dwt_init(NULL);
+}
+
+void timing_start(void)
+{
+	z_arm_dwt_cycle_count_start();
+}
+
+void timing_stop(void)
+{
+	DWT->CTRL &= ~DWT_CTRL_CYCCNTENA_Msk;
+}
+
+timing_t timing_counter_get(void)
+{
+	return (timing_t)z_arm_dwt_get_cycles();
+}
+
+uint64_t timing_cycles_get(volatile timing_t *const start,
+				  volatile timing_t *const end)
+{
+	return (*end - *start);
+}
+
+uint64_t timing_freq_get(void)
+{
+	return z_arm_dwt_freq_get();
+}
+
+uint64_t timing_cycles_to_ns(uint64_t cycles)
+{
+	return (cycles) * (NSEC_PER_USEC) / timing_freq_get_mhz();
+}
+
+uint64_t timing_cycles_to_ns_avg(uint64_t cycles, uint32_t count)
+{
+	return timing_cycles_to_ns(cycles) / count;
+}
+
+uint32_t timing_freq_get_mhz(void)
+{
+	return (uint32_t)(timing_freq_get() / 1000000);
+}

soc/arm/nordic_nrf/Kconfig.defconfig

@@ -33,8 +33,10 @@ config SYS_POWER_MANAGEMENT
 config BUILD_OUTPUT_HEX
 	default y
 
+if !CORTEX_M_DWT
 config SOC_HAS_TIMING_FUNCTIONS
 	default y
+endif
 
 config GPIO
 	default y