Annotate and the Log View 
ARM DUI 0482K Copyright © 2010-2012 ARM. All rights reserved. 10-5
ID120712 Non-Confidential
10.2 Adding bookmarks using Annotate
You can use annotate to add bookmarks to the Timeline automatically. The process is similar to 
adding standard annotate overlays, but requires the use of a different set of annotate functions. 
For general instructions on how to set up annotation, see Customize reports using Annotate on 
page 10-2.
Figure 10-2 Automatically adding bookmarks during capture
The file 
streamline_annotate.h
, located in 
.../gator/annotate/, 
contains all of the functions 
necessary to automatically add bookmarks. You must include this header file in your source 
code to use them.
 You can locate all of the files provided by DS-5 by selecting Help → ARM Extras... from the 
main menu.
Use the following functions to add bookmarks:
ANNOTATE_MARKER()
 
Use this function to add a a red bookmark to the Timeline view without a title. It 
has no parameters.
ANNOTATE_MARKER_STR(...)
 
This function adds a marker to the Timeline view with a title. Pass a string as a 
parameter to 
ANNOTATE_MARKER_STR(...)
 and the Timeline view displays it when 
you hover over the bookmark.
ANNOTATE_MARKER_COLOR(setColor)
 
This functions adds a bookmark and assigns it a color. Pass a color through as a 
parameter to automatically assign it to the bookmark.
ANNOTATE_MARKER_COLOR_STR(setColor, ...)
 
This function creates a bookmark with a title, and a color. Set the color and the 
title string using the function parameters and the created bookmark appears in the 
Timeline view with the defined properties.
 When you annotate from within the kernel or a module, you do not need to use 
ANNOTATE_DEFINE
 
and 
ANNOTATE_SETUP
.  Kernel annotations are not supported in interrupt context.
10.2.1 See also
Tasks 
• Customize reports using Annotate on page 10-2
• Capturing data on your target on page 11-2
• Creating custom performance counters on page 11-4.