Skip to content

Commit 7372fff

Browse files
author
pyocd-bot
committed
Deploying to main from @ pyocd/pyocd-website-source@570db5b 🚀
1 parent eae49e2 commit 7372fff

File tree

4 files changed

+26
-22
lines changed

4 files changed

+26
-22
lines changed

docs/command_reference.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1245,7 +1245,7 @@ <h3 id="device">Device</h3>
12451245
<h5 id="reset"><code class="highlighter-rouge">reset</code></h5>
12461246

12471247
<p><strong>Usage</strong>: reset [halt|-halt|-h] [TYPE] <br />
1248-
Reset the target, optionally with halt and/or specifying the reset type. The reset type must be one of ‘default’, ‘hw’, ‘sw’, ‘hardware’, ‘software’, ‘system’, ‘core’, ‘emulated’, ‘sw_system’, ‘sw_core’, ‘sw_sysresetreq’, ‘sw_vectreset’, ‘sw_emulated’, ‘sysresetreq’, or ‘vectreset’.</p>
1248+
Reset the target, optionally with halt and/or specifying the reset type. The reset type must be one of ‘default’, ‘hardware’, ‘system’, ‘core’, ‘n_srst’, ‘sysresetreq’, ‘vectreset’ or ‘emulated’.</p>
12491249

12501250
<h5 id="unlock"><code class="highlighter-rouge">unlock</code></h5>
12511251

docs/multicore_debug.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ <h5 class="sidebar-header">On this page</h5>
239239

240240
<p>By default, the primary core is core number 0. For Arm CoreSight based devices, this will be the core with the lowest associated access port address. Use the <code class="highlighter-rouge">primary_core</code> session option to change the primary core.</p>
241241

242-
<p>When performing multicore debug where multiple gdb instances are connected simultaneously, it is important to set the <code class="highlighter-rouge">enable_multicore_debug</code> session option to true. This changes secondary cores to have their default reset type set to core-only reset (<code class="highlighter-rouge">sw_core</code>). This prevents competing reset requests from the multiple gdb instances causing havoc. On v7-M architecture cores, VECTRESET is used. However, VECTRESET is not supported on other core architecture, so non-v7-M architectures will fall back to an emulated core reset.</p>
242+
<p>When performing multicore debug where multiple gdb instances are connected simultaneously, it is important to set the <code class="highlighter-rouge">enable_multicore_debug</code> session option to true. This changes secondary cores to have their default reset type set to core-only reset. This prevents competing reset requests from the multiple gdb instances causing havoc.</p>
243243

244244
<p>To debug a multicore device, run <code class="highlighter-rouge">pyocd gdbserver</code> as usual. This will connect to the device, detect
245245
the cores, and create the gdb server instances on separate ports. Next, start up two gdb instances
@@ -257,7 +257,6 @@ <h5 class="sidebar-header">On this page</h5>
257257
depend on whether the secondary core’s code is running out of flash or RAM.</p>
258258

259259

260-
261260
</div>
262261
</div>
263262
</main>

docs/options.html

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -551,13 +551,12 @@ <h2 id="general-options">General options</h2>
551551

552552
<tr><td>reset_type</td>
553553
<td>str</td>
554-
<td>'sw'</td>
554+
<td>'default'</td>
555555
<td>
556-
Which type of reset to use by default. Must be one of `default`, `hw`, `sw`, `sw_system`, `sw_core`,
557-
`sw_sysresetreq`, `sw_vectreset`, `sw_emulated`, `system`, `core`, `sysresetreq`, `vectreset`,
558-
`emulated`). The default is `sw`, which itself defaults to `sw_system`. `default` causes the target type's
559-
default reset type to be used; this is usually `sw`. If `enable_multicore_debug` is
560-
set to true, then `sw` for secondary cores will default to `sw_core`.
556+
Which type of reset to use. Must be one of 'default', 'hardware', 'system', 'core', 'n_srst',
557+
'sysresetreq', 'vectreset' or 'emulated'. The 'default' option causes the target type's
558+
default reset type to be used; this is usually `system`. If `enable_multicore_debug` is
559+
set to true, then secondary cores will default to `core`.
561560
</td></tr>
562561

563562
<tr><td>reset.hold_time</td>
@@ -824,11 +823,11 @@ <h2 id="gdb-server-options">GDB server options</h2>
824823
- <tt>n</tt>=none
825824
</td></tr>
826825

827-
<tr><td>xpsr_control_fields</td>
826+
<tr><td>register_fields</td>
828827
<td>bool</td>
829-
<td>False</td>
828+
<td>True</td>
830829
<td>
831-
When set to True, XPSR and CONTROL registers will have their respective bitfields defined for
830+
When set to True, registers with bitfields will have their respective bitfields defined for
832831
presentation in gdb.
833832
</td></tr>
834833

docs/python_api.html

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -330,19 +330,26 @@ <h2 id="reset-control">Reset control</h2>
330330
<p>The <code class="highlighter-rouge">reset_type</code> parameter on the <code class="highlighter-rouge">Target</code> reset methods can be set to one of the <code class="highlighter-rouge">Target.ResetType</code>
331331
enums:</p>
332332
<ul>
333-
<li><code class="highlighter-rouge">ResetType.HW</code>: Hardware reset using the nRESET signal.</li>
334-
<li><code class="highlighter-rouge">ResetType.SW</code>: Uses the core’s default software reset method.</li>
335-
<li><code class="highlighter-rouge">ResetType.SW_SYSRESETREQ</code>: Software reset using SYSRESETREQ, which usually resets the entire system
333+
<li><code class="highlighter-rouge">ResetType.DEFAULT</code>: Uses the core’s default reset method. For pack targets <code class="highlighter-rouge">defaultResetSequence</code> is used.
334+
For internal targets, the default is mapped to <code class="highlighter-rouge">ResetType.SYSTEM</code>, unless <code class="highlighter-rouge">default_reset_type</code>
335+
property is explicitly set.</li>
336+
<li><code class="highlighter-rouge">ResetType.HARDWARE</code>: Execute <code class="highlighter-rouge">ResetHardware</code> debug sequence for pack targets, if the sequence doesn’t exist,
337+
hardware reset using the nSRST signal is used. The same mapping applies for internal targets.</li>
338+
<li><code class="highlighter-rouge">ResetType.SYSTEM</code>: Execute <code class="highlighter-rouge">ResetSystem</code> debug sequence for pack targets, if the sequence doesn’t exist,
339+
software reset using SYSRESETREQ is used. The same mapping applies for internal targets.</li>
340+
<li><code class="highlighter-rouge">ResetType.CORE</code>: Execute <code class="highlighter-rouge">ResetProcessor</code> debug sequence for pack targets, if the sequence doesn’t exist,
341+
software reset using VECTRESET is used. The same mapping applies for internal targets.</li>
342+
<li><code class="highlighter-rouge">ResetType.NSRST</code>: Hardware reset using the nSRST signal.</li>
343+
<li><code class="highlighter-rouge">ResetType.SYSRESETREQ</code>: Software reset using SYSRESETREQ, which usually resets the entire system
336344
on most MCUs.</li>
337-
<li><code class="highlighter-rouge">ResetType.SW_VECTRESET</code>: Software reset using VECTRESET, only available on v7-M targets. This
338-
resets only the core itself. If requested on non-v7-M targets, it will fall back to <code class="highlighter-rouge">SW_EMULATED</code>.</li>
339-
<li><code class="highlighter-rouge">ResetType.SW_EMULATED</code>: Restores the core to reset conditions by writing registers. However, this
345+
<li><code class="highlighter-rouge">ResetType.VECTRESET</code>: Software reset using VECTRESET, only available on v7-M targets. This
346+
resets only the core itself. If requested on non-v7-M targets, it will fall back to <code class="highlighter-rouge">ResetType.EMULATED</code>.</li>
347+
<li><code class="highlighter-rouge">ResetType.EMULATED</code>: Restores the core to reset conditions by writing registers. However, this
340348
will not trigger a reset vector catch.</li>
341349
</ul>
342350

343-
<p>The <code class="highlighter-rouge">CortexM</code> objects have <code class="highlighter-rouge">default_reset_type</code> and <code class="highlighter-rouge">default_software_reset_type</code> properties that
344-
let you control the overall default reset type (any one of the <code class="highlighter-rouge">ResetType</code> enums), as well as the
345-
default if <code class="highlighter-rouge">ResetType.SW</code> is selected, respectively.</p>
351+
<p>The <code class="highlighter-rouge">CortexM</code> objects have a <code class="highlighter-rouge">default_reset_type</code> property that lets you control the overall default reset type.
352+
Property value can be any one of the <code class="highlighter-rouge">ResetType</code> enums.</p>
346353

347354
<p>Another option for performing a halting reset is by setting vector catch with the target’s <code class="highlighter-rouge">set_vector_catch()</code>
348355
method, then using a normal reset. This has the benefit of always halting at reset, if you leave the
@@ -381,7 +388,6 @@ <h2 id="notes">Notes</h2>
381388
</ul>
382389

383390

384-
385391
</div>
386392
</div>
387393
</main>

0 commit comments

Comments
 (0)