Annotate and the Log View
ARM DUI 0482K
Copyright © 2010-2012 ARM. All rights reserved.
10-7
ID120712
Non-Confidential
10.3
Adding images to reports using Visual Annotate
In addition to simple text overlays using Annotate, Streamline supports the annotation of
images, providing further application-level context to the Timeline view.
Figure 10-3 Visual Annotation in the Timeline view
Just like textual annotation, the application writes to
/dev/gator/annotate
virtual file using
standard c-library functions. The gator driver outputs this data with a timestamp to Streamline
and integrates it with the trace and sample report.
The mechanics of instrumenting your source code to provide visual annotation is similar to the
process of adding standard annotation. For more information on text-only annotation, see
Customize reports using Annotate
To include images in the data sent to the host during a capture session, use the
ANNOTATE_VISUAL
macro in your source code instead of the
ANNOTATE
and
ANNOTATE_COLOR
macros used in standard
annotation.
ANNOTATE_VISUAL
provides a parameter for image data.
Note
You can locate all of the files provided by DS-5 by selecting
Help
→
ARM Extras...
from the
main menu.
To use visual annotation, you must:
1.
Include the
streamline_annotate.h
header file located in
.../gator/annotate/
in your
source code using the following line of code:
#include "streamline_annotate.h"
Note
You can customize the example
streamline_annotate.h
file provided by DS-5 or create
your own. Use it as a template if you want to create your own customized annotate
functions.
2.
You must call the following before using the
ANNOTATE_VISUAL
macro:
ANNOTATE_DEFINE;
3.
Insert the
ANNOTATE_VISUAL
macro into your code:
ANNOTATE_VISUAL(
data
,
length
,
str
);