Profiler: Improvements on data fetching
Replace the PROF_FETCH_DATA_x by PROF_FETCH_DATA_BY_CP_x
The original PROF_FETCH_DATA_x takes tag_pattern, tag_mask
as input parameters. However the users only know the cp/topic
pair when do PROF_TIMING_LOG. Tag marks are supposed to be
internal only.
Change-Id: I58085b626232cb0ca48342b8f582322644609ba3
Signed-off-by: Kevin Peng <kevin.peng@arm.com>
diff --git a/profiler/readme.rst b/profiler/readme.rst
index 21514f2..0b7d1e1 100644
--- a/profiler/readme.rst
+++ b/profiler/readme.rst
@@ -86,14 +86,19 @@
=============
For the same consistent reason as counter logging, same macros are defined as
-the interface for both secure and non-secure side.
+the interfaces for both secure and non-secure side.
-The data fetching interface works as stream way. `PROF_FETCH_DATA_START` and
-`PROF_FETCH_DATA_BY_XXX_START` search the data that matches the given pattern
+The data fetching interfaces work as stream way. `PROF_FETCH_DATA_START` and
+`PROF_FETCH_DATA_BY_TOPIC_START` search the data that matches the given pattern
from the beginning of the database. `PROF_FETCH_DATA_CONTINUE` and
-`PROF_FETCH_DATA_BY_XXX_CONTINUE` search from the next data set of the
+`PROF_FETCH_DATA_BY_TOPIC_CONTINUE` search from the next data set of the
previous result.
+ .. Note::
+
+ All the APIs increase the internal search index, be careful on mixing using them
+ for different checkpoints and topics at the same time.
+
The match condition of a search is controlled by the tag mask. It's `tag value`
& `tag_mask` == `tag_pattern`. To enumerate the whole database, set
`tag_mask` and `tag_pattern` both to `0`.
@@ -102,9 +107,6 @@
`PROF_FETCH_DATA_BY_TOPIC_XXX`: Get data for a specific `topic`.
-`PROF_FETCH_DATA_BY_CP_XXX`: Get data for a specific checkpoint by specifying
-both `topic` and `cp`.
-
The APIs return `false` if no matching data found until the end of the database.
Calibration