Add profiler for TF-M
* Support logging the timing of a checkpoint for SPE and/or NSPE
* Add self test program
Signed-off-by: David Wang <david.wang@arm.com>
Change-Id: Ie4d3d14966faeadb77819854b473efdedbe384fb
diff --git a/profiler/export/prof_if_s.h b/profiler/export/prof_if_s.h
new file mode 100644
index 0000000..709114d
--- /dev/null
+++ b/profiler/export/prof_if_s.h
@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2021-2022, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+#ifndef __PROF_IF_S_H__
+#define __PROF_IF_S_H__
+
+/* This file defines all API that should be called by secure side */
+
+#include <stdint.h>
+#include <stddef.h>
+#include <stdbool.h>
+#include "prof_common.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * Topic based timing logging
+ */
+#define PROF_TIMING_LOG(topic_id, cp_id) \
+ prof_timing_cp( \
+ PROF_MAKE_TIMING_TAG((cp_id), (topic_id), PROF_CALI_IDX_S, \
+ PROF_TYPE_TIMING_LOG))
+
+/*
+ * Get the timing value for further calibration
+ * The difference with checkpoint is that the calibration item doesn't increase
+ * the index in database. So, the calibration item can be overwritten by other
+ * items. The reason of keeping writing calibration data into database is that
+ * we want to make a full cycle of saving an item into the database to more
+ * accurately reflect the latency.
+ */
+#define PROF_TIMING_CALIBRATE() prof_timing_cp( \
+ PROF_MAKE_TIMING_TAG(0, 0, 0, PROF_TYPE_TIMING_CALI))
+
+/*
+ * Secure side can call this macro to do/redo calibration
+ * Suggest to do/redo calibration before running the profiling. It's because the
+ * latency introduced by the profiler may be changed in the system lifecycle.
+ * For example, enable caches, change CPU frequency, etc.
+ * 'rounds' sets how many rounds executed for the calibration. In theory, "more
+ * rounds" is more accurate.
+ * Set `rounds` to `0` to reset the calibration value to 0.
+ */
+#define PROF_DO_CALIBRATE(rounds) prof_calibrate( \
+ PROF_CALI_IDX_S, rounds, 0)
+
+/*
+ * Get the calibration value from the tag.
+ * The calibrated counter is
+ * "current_counter" - "previous_counter" - "current_cali_value"
+ * "current_cali_value" = PROF_GET_CALI_VALUE_FROM_TAG(current_tag)
+ */
+#define PROF_GET_CALI_VALUE_FROM_TAG(tag) prof_get_cali_value_veneer( \
+ PROF_GET_CALI_IDX_FROM_TAG(tag))
+
+/* Get data */
+#define PROF_FETCH_DATA_START(tag, data, tag_pattern, tag_mask) \
+ prof_get_data_start(tag, data, tag_pattern, tag_mask)
+
+#define PROF_FETCH_DATA_CONTINUE(tag, data, tag_pattern, tag_mask) \
+ prof_get_data_continue(tag, data, tag_pattern, tag_mask)
+
+#define PROF_FETCH_DATA_BY_TOPIC_START(tag, data, topic) \
+ prof_get_data_start(tag, data, \
+ PROF_MAKE_TIMING_TAG(0, topic, 0, 0), PROF_MASK_TOPIC)
+
+#define PROF_FETCH_DATA_BY_TOPIC_CONTINUE(tag, data, topic) \
+ prof_get_data_continue(tag, data, \
+ PROF_MAKE_TIMING_TAG(0, topic, 0, 0), PROF_MASK_TOPIC)
+
+#define PROF_FETCH_DATA_BY_CP_START(tag, data, topic, cp) \
+ prof_get_data_start(tag, data, \
+ PROF_MAKE_TIMING_TAG(cp, topic, 0, 0), PROF_MASK_TOPIC_CP)
+
+#define PROF_FETCH_DATA_BY_CP_CONTINUE(tag, data, topic, cp) \
+ prof_get_data_continue(tag, data, \
+ PROF_MAKE_TIMING_TAG(cp, topic, 0, 0), PROF_MASK_TOPIC_CP)
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __PROF_IF_S_H__ */