nuttx/nuttx-mirror
1
2
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2025-01-13 09:49:21 +08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation: Add usage guide for the debugpoint command

Browse source 
See https://github.com/apache/nuttx-apps/pull/2549

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
This commit is contained in:
Huang Qi 2024-09-08 17:07:26 +08:00 committed by Xiang Xiao
parent 3f00c4aae0
commit 9d5b9b7c05
1 changed files with 57 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
Documentation/applications/system/debugpoint/index.rst Normal file
View file

@ -0,0 +1,57 @@
=====================================
``debugpoint`` Debug Utility
=====================================
``CONFIG_SYSTEM_DEBUGPOINT=y``
The ``debugpoint`` utility is a tool for testing and managing debug points (breakpoints and watchpoints) in the system. It allows users to set, remove, and test various types of debug points.
Usage::
debugpoint [options]
Options::
-r addr Set a read watchpoint at address
-w addr Set a write watchpoint at address
-b addr Set a breakpoint at address
-x addr Set a read/write watchpoint at address
-c Cancel the watchpoint or breakpoint (must be used with -r, -w, -b, or -x)
-l len Set the watch length (must be used with -r, -w, -b, or -x)
Examples::
# Set a read watchpoint at address 0x1000
debugpoint -r 0x1000
# Set a write watchpoint at address 0x2000
debugpoint -w 0x2000
# Set a breakpoint at address 0x3000
debugpoint -b 0x3000
# Set a read/write watchpoint at address 0x4000
debugpoint -x 0x4000
# Cancel the read watchpoint at address 0x1000
debugpoint -r 0x1000 -c
# Cancel the write watchpoint at address 0x2000
debugpoint -w 0x2000 -c
# Cancel the breakpoint at address 0x3000
debugpoint -b 0x3000 -c
# Cancel the read/write watchpoint at address 0x4000
debugpoint -x 0x4000 -c
# Set the watch length to 8 bytes for a read watchpoint at address 0x1000
debugpoint -r 0x1000 -l 8
# Set the watch length to 8 bytes for a write watchpoint at address 0x2000
debugpoint -w 0x2000 -l 8
# Set the watch length to 8 bytes for a breakpoint at address 0x3000
debugpoint -b 0x3000 -l 8
The ``debug`` utility also includes automated tests for breakpoints and watchpoints. When run without any options, it will execute these tests to verify the functionality of the debug points.