Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / sam / docs / ui-cmds / cmd_break.html
CommitLineData
920dae64
AT
1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2<html>
3<head>
4<title>SPARC Architectural Model: User Commands</title>
5</head>
6<body bgcolor="#FFFFFF" LANG="en-US">
7<div STYLE="margin-bottom: 0cm"></div>&nbsp;
8
9<h2>
10break
11</h2>
12
13<h4>
14NAME
15</h4>
16<ul>
17break - set breakpoint
18</ul>
19
20<h4>SYNOPSIS</h4>
21<tt>
22break
23<p>break <i>pc_addr</i> [<i>cpu_num</i>]</p>
24<p>break [-cpu <i>cpu_set</i>] <i>pc_addr</i></p>
25<p>break [-cpu <i>cpu_set</i>] -trap <i>trap_type</i></p>
26<p>break [-cpu <i>cpu_set</i>] -red</p>
27</ul>
28</tt>
29
30<h4>DESCRIPTION</h4>
31<ul>
32Set a breakpoint on one or more cpus. One of these cpus encounters a breakpoint, control is returned to frontend before the instruction is executed.
33<p>
34Each breakpoint is associated with an id (printed when the breakpoint
35is set, by typing break with no arguments, or by the list-breakpoints
36command) which is used for further references to the breakpoint.
37<p>
38The break command without any arguments prints the list of current
39breakpoints.
40<p>
41break <i>pc_addr</i> <i>cpu_num</i> sets a
42breakpoint at <i>pc_addr</i> on the cpu <i>cpu_num</i>.
43<p>
44For the remaining forms of break, the optional flag
45<a href="flag_cpu.html">-cpu</a> selects a collection
46of cpus on which the appropriate breakpoint is set. If the -cpu flag
47is omitted, then the breakpoint is set on all configured cpus.
48<p>
49break followed by an optional -cpu flag and a <i>pc_addr</i> sets a
50breakpoint at <i>pc_addr</i> on the selected set of cpus.
51<p>
52The -trap flag sets a trap breakpoint that stops execution before a
53trap of type <i>trap_type</i> is taken on the selected set of cpus.
54<p>
55The -red flag sets a RED state breakpoint that stops execution before
56any of the selected set of cpus enters the RED state.
57<p>
58Breakpoints can be removed using delete.
59
60<p> Breakpoints are <b>not supported</b> in execution-driven mode. An
61execution-driven timing model may provide its own breakpoint
62capability. To avoid unpredictable results, all breakpoints should be
63disabled prior to enabling execution-driven simulation
64</p>
65
66</ul>
67
68<h4>RETURN VALUES</h4>
69<ul>
70Returns the breakpoint id of the newly set breakpoint.
71</ul>
72
73<h4>SEE ALSO</h4>
74<ul><a href="cmd_delete.html">delete</a></ul>
75<ul><a href="cmd_enable_disable.html">enable/disable</a></ul>
76<ul><a href="cmd_ignore.html">ignore</a></ul>
77<ul><a href="cmd_list-breakpoints.html">list-breakpoints</a></ul>
78
79<hr>
80</body>
81</html>