RealView ® Debugger CommandLine Reference Guide

Version 3.0


Table of Contents

Preface
About this book
Intended audience
Using this book
Typographical conventions
Further reading
Feedback
Feedback on RealView Debugger
Feedback on this book
1. Working with the CLI
1.1. General command language syntax
1.1.1. General syntax rules
1.1.2. Command qualifiers and flags
1.1.3. Command parameters
1.1.4. Abbreviations
1.2. Window and file numbers
1.3. Using expressions and statements
1.3.1. Expressions
1.3.2. Keywords
1.3.3. Predefined macros
1.4. Command scripts
1.4.1. Considerations when using command scripts
1.4.2. Command script comments
1.4.3. Example command script
1.5. Macro language
1.5.1. Macro definition
1.5.2. Macro body
1.5.3. Macro terminator
1.5.4. Macro comments
1.5.5. Macro local symbols
1.6. Types of RealView Debugger expressions
1.7. Constructing expressions
1.7.1. Permitted symbol names
1.7.2. Program symbols
1.7.3. Debugger variable symbols
1.7.4. Macro symbols
1.7.5. Reserved symbols
1.7.6. Operations on symbols and registers
1.7.7. Addresses
1.7.8. Expression strings
1.7.9. Target functions
1.8. Using variables in the debugger
1.8.1. Scope
1.8.2. Data types
1.8.3. Root names
1.8.4. Module names
1.8.5. Variable references
1.8.6. Stack references
1.9. Source patching with macros
1.9.1. Patching example to re-implement aloop
1.9.2. Patching example to emulate a serialport
1.9.3. Other ways to use macros
2. RealView Debugger Commands
2.1. Command syntax definition
2.1.1. Specifying address ranges
2.2. Debugger commands listed by function
2.2.1. Board file access
2.2.2. Execution control
2.2.3. Examining source files
2.2.4. Program image management
2.2.5. Target registers and memory
2.2.6. Status enquiries
2.2.7. Macros and aliases
2.2.8. CLI
2.2.9. Program symbol manipulation
2.2.10. Creating and writing to files andwindows
2.2.11. Processor tracing
2.2.12. OS-aware debugging
2.2.13. Miscellaneous
2.3. Alphabetical command reference
2.3.1. ADD
2.3.2. ADDFILE
2.3.3. ALIAS
2.3.4. ANALYZER
2.3.5. AOS_resource-list
2.3.6. ARGUMENTS
2.3.7. BACCESS
2.3.8. BEXECUTION
2.3.9. BGLOBAL
2.3.10. BINSTRUCTION
2.3.11. BOARD
2.3.12. BREAD
2.3.13. BREAK
2.3.14. BREAKACCESS
2.3.15. BREAKEXECUTION
2.3.16. BREAKINSTRUCTION
2.3.17. BREAKREAD
2.3.18. BREAKWRITE
2.3.19. BROWSE
2.3.20. BWRITE
2.3.21. CANCEL
2.3.22. CCTRL
2.3.23. CEXPRESSION
2.3.24. CLEARBREAK
2.3.25. COMPARE
2.3.26. CONNECT
2.3.27. CONTEXT
2.3.28. COPY
2.3.29. DBOARD
2.3.30. DBREAK
2.3.31. DCOMMANDS
2.3.32. DEFINE
2.3.33. DELBOARD
2.3.34. DELETE
2.3.35. DELFILE
2.3.36. DHELP
2.3.37. DISABLEBREAK
2.3.38. DISASSEMBLE
2.3.39. DISCONNECT
2.3.40. DLOADERR
2.3.41. DMAP
2.3.42. DOS_resource-list
2.3.43. DOWN
2.3.44. DPIPEVIEW
2.3.45. DTBOARD
2.3.46. DTBREAK
2.3.47. DTFILE
2.3.48. DTRACE
2.3.49. DUMP
2.3.50. DUMPMAP
2.3.51. DVFILE
2.3.52. EDITBOARDFILE
2.3.53. EMURESET
2.3.54. EMURST
2.3.55. ENABLEBREAK
2.3.56. ERROR
2.3.57. ETM_CONFIG
2.3.58. EXPAND
2.3.59. FAILINC
2.3.60. FILL
2.3.61. FLASH
2.3.62. FOPEN
2.3.63. FPRINTF
2.3.64. GO
2.3.65. GOSTEP
2.3.66. HALT
2.3.67. HELP
2.3.68. HOST
2.3.69. HWRESET
2.3.70. INCLUDE
2.3.71. INTRPT
2.3.72. JOURNAL
2.3.73. JUMP
2.3.74. LIST
2.3.75. LOAD
2.3.76. LOG
2.3.77. MACRO
2.3.78. MEMMAP
2.3.79. MEMWINDOW
2.3.80. MMAP
2.3.81. MODE
2.3.82. MONITOR
2.3.83. NAMETRANSLATE
2.3.84. NOMONITOR
2.3.85. ONSTATE
2.3.86. OPTION
2.3.87. OS action commands
2.3.88. OS resource commands
2.3.89. OSCTRL
2.3.90. PATHTRANSLATE
2.3.91. PAUSE
2.3.92. PRINTDSM
2.3.93. PRINTF
2.3.94. PRINTSYMBOLS
2.3.95. PRINTTYPE
2.3.96. PRINTVALUE
2.3.97. PROPERTIES
2.3.98. PS
2.3.99. PT
2.3.100. QUIT
2.3.101. READBOARDFILE
2.3.102. READFILE
2.3.103. REEXEC
2.3.104. RELOAD
2.3.105. RESET
2.3.106. RESETBREAKS
2.3.107. RESTART
2.3.108. RSTBREAKS
2.3.109. RUN
2.3.110. SCOPE
2.3.111. SEARCH
2.3.112. SETFLAGS
2.3.113. SETMEM
2.3.114. SETREG
2.3.115. SETTINGS
2.3.116. SHOW
2.3.117. SINSTR
2.3.118. SM
2.3.119. SOINSTR
2.3.120. SOVERLINE
2.3.121. SR
2.3.122. STATS
2.3.123. STDIOLOG
2.3.124. STEPINSTR
2.3.125. STEPLINE
2.3.126. STEPOINSTR
2.3.127. STEPO
2.3.128. STOP
2.3.129. SYNCHEXEC
2.3.130. TEST
2.3.131. THREAD
2.3.132. TRACE
2.3.133. TRACEBUFFER
2.3.134. TRACEDATAACCESS
2.3.135. TRACEDATAREAD
2.3.136. TRACEDATAWRITE
2.3.137. TRACEEXTCOND
2.3.138. TRACEINSTREXEC
2.3.139. TRACEINSTRFETCH
2.3.140. UNLOAD
2.3.141. UP
2.3.142. VCLEAR
2.3.143. VCLOSE
2.3.144. VERIFYFILE
2.3.145. VMACRO
2.3.146. VOPEN
2.3.147. VSETC
2.3.148. WAIT
2.3.149. WARMSTART
2.3.150. WHERE
2.3.151. WINDOW
2.3.152. WRITEFILE
2.3.153. XTRIGGER
3. RealView Debugger Predefined Macros
3.1. Predefined macros listed by function
3.1.1. Access data values at an address
3.1.2. Flow control statements
3.1.3. File and window access
3.1.4. String manipulation
3.1.5. Memory manipulation
3.1.6. Miscellaneous
3.1.7. User interaction macros
3.2. Alphabetical predefined macro reference
3.2.1. byte
3.2.2. dword
3.2.3. error
3.2.4. fclose
3.2.5. fgetc
3.2.6. fopen
3.2.7. fputc
3.2.8. fread
3.2.9. fwrite
3.2.10. getsym
3.2.11. memchr
3.2.12. memclr
3.2.13. memcpy
3.2.14. memset
3.2.15. prompt_file
3.2.16. prompt_list
3.2.17. prompt_text
3.2.18. prompt_yesno
3.2.19. prompt_yesno_cancel
3.2.20. reg_str
3.2.21. strcat
3.2.22. strchr
3.2.23. strcmp
3.2.24. strcpy
3.2.25. stricmp
3.2.26. strlen
3.2.27. strncmp
3.2.28. until
3.2.29. when
3.2.30. word
4. RealView Debugger Keywords
4.1. Keywords listed by function
4.1.1. Data type keywords
4.1.2. Conditional statement keywords
4.1.3. Flow control keywords
4.1.4. Miscellaneous keywords
4.2. Alphabetical keyword reference
4.2.1. break
4.2.2. continue
4.2.3. do-while
4.2.4. for
4.2.5. if
4.2.6. if-else
4.2.7. isalive
4.2.8. return
4.2.9. sizeof
4.2.10. while

List of Tables

1.1. Types of CLI expressions
1.2. Qualified symbol references
1.3. Reserved symbols
1.4. Format specifiers for printing reserved symbols
1.5. Common processor core register symbols
1.6. Extended CPSR and SPSR processor core register symbols
1.7. Register operations
1.8. Address expressions
1.9. Examples of expression strings
1.10. Equivalent RealView Debugger data types for ARM assembler
1.11. Special casting types
1.12. Examples of references to variables
1.13. C operators for referencing and dereferencing variables
1.14. Macros for interacting with files and windows
1.15. Commands that run macros automatically
1.16. Commands that enable you to manage macros
2.1. Board file access commands
2.2. Execution control commands
2.3. Examining source file commands
2.4. Program image management commands
2.5. Target register and memory access commands
2.6. Status enquiry commands
2.7. Macro and alias commands
2.8. CLI commands
2.9. Program symbol manipulation commands
2.10. Creating files and text writing commands
2.11. Processor tracing commands
2.12. OS-aware specific debugging commands
2.13. Debugging commands with OS-aware related features
2.14. Miscellaneous commands
2.15. Changed argument assignments
2.16. Example hw_in test strings for an ARM940T
2.17. Example hw_in test strings for an ARM940T
2.18. Example hw_in test strings for an ARM940T
2.19. Example hw_in test strings for an ARM940T
2.20. External condition events
3.1. Access data value macros
3.2. Flow control statements
3.3. File and window access macros
3.4. String manipulation
3.5. Memory Manipulation macros
3.6. Miscellaneous macros
3.7. User interaction macros
3.8. Error classes
4.1. Data type keywords
4.2. Conditional statement keywords
4.3. Flow control keywords
4.4. Miscellaneous keywords

Proprietary Notice

Words and logos marked with ® or ™ are registered trademarks or trademarksowned by ARM Limited. Other brands and names mentioned herein maybe the trademarks of their respective owners.

Neither the whole nor any part of the information containedin, or the product described in, this document may be adapted orreproduced in any material form except with the prior written permissionof the copyright holder.

The product described in this document is subject to continuousdevelopments and improvements. All particulars of the product andits use contained in this document are given by ARM in good faith.However, all warranties implied or expressed, including but notlimited to implied warranties of merchantability, or fitness forpurpose, are excluded.

This document is intended only to assist the reader in theuse of the product. ARM Limited shall not be liable for any lossor damage arising from the use of any information in this document,or any error or omission in such information, or any incorrect useof the product.

ConfidentialityStatus

This document is Non-Confidential. The right to use, copyand disclose this document may be subject to license restrictionsin accordance with the terms of the agreement entered into by ARMand the party that ARM delivered this document to.

Product Status

The information in this document is final, that is for a developedproduct.

Revision History
Revision A April2002 RealView Debugger v1.5 release
Revision B September2002 RealView Debugger v1.6 release
Revision C February2003 RealView Debugger v1.6.1 release
Revision D September2003 RealView Debugger v1.6.1 release for RVDSv2.0
Revision E January2004 RealView Debugger v1.7 release for RVDS v2.1
Revision F December2004 RealView Debugger v1.8 release for RVDS v2.2
Revision G May2005 RealView Debugger v1.8 SP1 release for RVDSv2.2 SP1
Revision H March2006 RealView Debugger 3.0 release for RVDS v3.0
Copyright © 2002-2006 ARM Limited. All rights reserved. ARM DUI 0175H
Non-Confidential