Skip to content

Commit 9854ee0

Browse files
author
pyocd-bot
committed
Deploying to main from @ pyocd/pyocd-website-source@7d38616 🚀
1 parent ce708a0 commit 9854ee0

File tree

4 files changed

+121
-3
lines changed

4 files changed

+121
-3
lines changed

docs/builtin-targets.html

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,36 @@ <h5 class="sidebar-header">On this page</h5>
235235

236236
<tr><th>Target Type Name</th><th>Vendor</th><th>Name</th></tr>
237237

238+
<tr><td><code>air001</code></td>
239+
<td>AirM2M</td>
240+
<td>Air001</td>
241+
</tr>
242+
243+
<tr><td><code>air32f103xb</code></td>
244+
<td>AirM2M</td>
245+
<td>Air32F103xB</td>
246+
</tr>
247+
248+
<tr><td><code>air32f103xc</code></td>
249+
<td>AirM2M</td>
250+
<td>Air32F103xC</td>
251+
</tr>
252+
253+
<tr><td><code>air32f103xe</code></td>
254+
<td>AirM2M</td>
255+
<td>Air32F103xE</td>
256+
</tr>
257+
258+
<tr><td><code>air32f103xg</code></td>
259+
<td>AirM2M</td>
260+
<td>Air32F103xG</td>
261+
</tr>
262+
263+
<tr><td><code>air32f103xp</code></td>
264+
<td>AirM2M</td>
265+
<td>Air32F103xP</td>
266+
</tr>
267+
238268
<tr><td><code>cc3220sf</code></td>
239269
<td>Texas Instruments</td>
240270
<td>CC3220SF</td>
@@ -355,6 +385,16 @@ <h5 class="sidebar-header">On this page</h5>
355385
<td>CY8C6xxA</td>
356386
</tr>
357387

388+
<tr><td><code>hc32a460xe</code></td>
389+
<td>HDSC</td>
390+
<td>HC32F460xE</td>
391+
</tr>
392+
393+
<tr><td><code>hc32a4a0xi</code></td>
394+
<td>HDSC</td>
395+
<td>HC32F4A0xI</td>
396+
</tr>
397+
358398
<tr><td><code>hc32f003</code></td>
359399
<td>HDSC</td>
360400
<td>HC32F003</td>
@@ -405,6 +445,16 @@ <h5 class="sidebar-header">On this page</h5>
405445
<td>HC32F196</td>
406446
</tr>
407447

448+
<tr><td><code>hc32f448xa</code></td>
449+
<td>HDSC</td>
450+
<td>HC32F448xA</td>
451+
</tr>
452+
453+
<tr><td><code>hc32f448xc</code></td>
454+
<td>HDSC</td>
455+
<td>HC32F448xC</td>
456+
</tr>
457+
408458
<tr><td><code>hc32f451xc</code></td>
409459
<td>HDSC</td>
410460
<td>HC32F451xC</td>
@@ -775,6 +825,11 @@ <h5 class="sidebar-header">On this page</h5>
775825
<td>MAX32660</td>
776826
</tr>
777827

828+
<tr><td><code>max32666</code></td>
829+
<td>Maxim</td>
830+
<td>MAX32666</td>
831+
</tr>
832+
778833
<tr><td><code>max32670</code></td>
779834
<td>Maxim</td>
780835
<td>MAX32670</td>
@@ -895,6 +950,11 @@ <h5 class="sidebar-header">On this page</h5>
895950
<td>NRF52840</td>
896951
</tr>
897952

953+
<tr><td><code>nrf91</code></td>
954+
<td>Nordic Semiconductor</td>
955+
<td>NRF91XX</td>
956+
</tr>
957+
898958
<tr><td><code>rp2040</code></td>
899959
<td>Raspberry Pi</td>
900960
<td>RP2040Core0</td>
@@ -915,6 +975,16 @@ <h5 class="sidebar-header">On this page</h5>
915975
<td>RTL8195AM</td>
916976
</tr>
917977

978+
<tr><td><code>rtl8762c</code></td>
979+
<td>Realtek Semiconductor</td>
980+
<td>RTL8762C</td>
981+
</tr>
982+
983+
<tr><td><code>s32k344</code></td>
984+
<td>NXP</td>
985+
<td>S32K344</td>
986+
</tr>
987+
918988
<tr><td><code>s5js100</code></td>
919989
<td>Samsung</td>
920990
<td>S5JS100</td>
@@ -965,6 +1035,21 @@ <h5 class="sidebar-header">On this page</h5>
9651035
<td>STM32F767xx</td>
9661036
</tr>
9671037

1038+
<tr><td><code>stm32h723xx</code></td>
1039+
<td>STMicroelectronics</td>
1040+
<td>STM32H723xx</td>
1041+
</tr>
1042+
1043+
<tr><td><code>stm32h743xx</code></td>
1044+
<td>STMicroelectronics</td>
1045+
<td>STM32H743xx</td>
1046+
</tr>
1047+
1048+
<tr><td><code>stm32h7b0xx</code></td>
1049+
<td>STMicroelectronics</td>
1050+
<td>STM32H7B0xx</td>
1051+
</tr>
1052+
9681053
<tr><td><code>stm32l031x6</code></td>
9691054
<td>STMicroelectronics</td>
9701055
<td>STM32L031x6</td>

docs/command_reference.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,11 @@ <h5 class="sidebar-header">On this page</h5>
306306
<li class="toc-entry toc-h5"><a href="#write8">write8</a></li>
307307
</ul>
308308
</li>
309+
<li class="toc-entry toc-h3"><a href="#nrf91">Nrf91</a>
310+
<ul>
311+
<li class="toc-entry toc-h5"><a href="#nrf91-update-modem-fw">nrf91-update-modem-fw</a></li>
312+
</ul>
313+
</li>
309314
<li class="toc-entry toc-h3"><a href="#openocd-compatibility">Openocd compatibility</a>
310315
<ul>
311316
<li class="toc-entry toc-h5"><a href="#init">init</a></li>
@@ -763,6 +768,16 @@ <h2 id="all-commands">All commands</h2>
763768
Write 8-bit bytes to memory.
764769
</td></tr>
765770

771+
<tr><td colspan="3"><b>Nrf91</b></td></tr>
772+
773+
<tr><td>
774+
<a href="#nrf91-update-modem-fw"><tt>nrf91-update-modem-fw</tt></a>
775+
</td><td>
776+
[-f] mfw_nrf91xx_x.x.x.zip
777+
</td><td>
778+
Update modem firmware for an nRF91 target.
779+
</td></tr>
780+
766781
<tr><td colspan="3"><b>Openocd_compatibility</b></td></tr>
767782

768783
<tr><td>
@@ -1344,6 +1359,13 @@ <h5 id="write8"><code class="highlighter-rouge">write8</code></h5>
13441359
<strong>Usage</strong>: write8 ADDR DATA+ <br />
13451360
Write 8-bit bytes to memory. The data arguments are 8-bit bytes. Can write to both RAM and flash. Flash writes are subject to minimum write size and alignment, and the flash page must have been previously erased.</p>
13461361

1362+
<h3 id="nrf91">Nrf91</h3>
1363+
1364+
<h5 id="nrf91-update-modem-fw"><code class="highlighter-rouge">nrf91-update-modem-fw</code></h5>
1365+
1366+
<p><strong>Usage</strong>: nrf91-update-modem-fw [-f] mfw_nrf91xx_x.x.x.zip <br />
1367+
Update modem firmware for an nRF91 target. If -f is specified, modem firmware is written to the device, even if the correct version is already present.</p>
1368+
13471369
<h3 id="openocd-compatibility">Openocd compatibility</h3>
13481370

13491371
<h5 id="init"><code class="highlighter-rouge">init</code></h5>

docs/debug_probes.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@ <h5 class="sidebar-header">On this page</h5>
239239
<li class="toc-entry toc-h4"><a href="#microchip-edbg">Microchip EDBG</a></li>
240240
</ul>
241241
</li>
242+
<li class="toc-entry toc-h3"><a href="#ti-xds110">TI XDS110</a></li>
242243
<li class="toc-entry toc-h3"><a href="#pe-micro-cyclone-and-multilink">PE Micro Cyclone and Multilink</a></li>
243244
<li class="toc-entry toc-h3"><a href="#stlink">STLink</a>
244245
<ul>
@@ -475,6 +476,10 @@ <h4 id="microchip-edbg">Microchip EDBG</h4>
475476
<p>The Microchip (previously Atmel) EDBG probe firmware, at the time of this writing, provides a CMSIS-DAP v1 interface.
476477
On macOS, reading command responses always times out. The probe works on other OSes, however.</p>
477478

479+
<h3 id="ti-xds110">TI XDS110</h3>
480+
481+
<p>XDS110 firmware version 03.00.00.25 is known to have an issue when using multiple outstanding packets (the default setting). To work around this, set the <code class="highlighter-rouge">cmsis_dap.limit_packets</code> session option, e.g. <code class="highlighter-rouge">-Ocmsis_dap.limit_packets=1</code> on the command line. Earlier firmware versions most likely exhibit the issue; it is unknown whether it is fixed in more recent versions.</p>
482+
478483
<h3 id="pe-micro-cyclone-and-multilink">PE Micro Cyclone and Multilink</h3>
479484

480485
<p>The Cyclone and Multilink debug probes from PE Micro are supported through the use of a separate probe driver

docs/open_cmsis_pack_support.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ <h5 class="sidebar-header">On this page</h5>
251251
</li>
252252
<li class="toc-entry toc-h2"><a href="#pyocds-debug-sequence-implementation">PyOCD’s debug sequence implementation</a>
253253
<ul>
254-
<li class="toc-entry toc-h3"><a href="#cpu-specific-debugport-sequences">CPU-specific DebugPort sequences</a></li>
254+
<li class="toc-entry toc-h3"><a href="#core-specific-sequences">Core-specific sequences</a></li>
255255
<li class="toc-entry toc-h3"><a href="#custom-default-reset-sequences">Custom default reset sequences</a></li>
256256
<li class="toc-entry toc-h3"><a href="#debug-sequences-and-delegate-functions">Debug sequences and delegate functions</a></li>
257257
<li class="toc-entry toc-h3"><a href="#supported-debug-sequences">Supported debug sequences</a></li>
@@ -358,9 +358,15 @@ <h2 id="pyocds-debug-sequence-implementation">PyOCD’s debug sequence implement
358358

359359
<p>This section documents details of the debug sequence engine provided by pyOCD, supported features, and any notable differences with other debuggers (primarily Keil MDK, which provided the first implementation and against which Packs are generally most thoroughly tested by their authors).</p>
360360

361-
<h3 id="cpu-specific-debugport-sequences">CPU-specific DebugPort sequences</h3>
361+
<h3 id="core-specific-sequences">Core-specific sequences</h3>
362362

363-
<p>Like all other debug sequences, <code class="highlighter-rouge">DebugPortSetup</code>, <code class="highlighter-rouge">DebugPortStart</code>, and <code class="highlighter-rouge">DebugPortStop</code> can be customised per CPU core. If a DFP has multiple CPU-specific instances of these sequences, they may behave differently in pyOCD than other debuggers. Many debuggers only “connect” to a single CPU chosen by the user when debugging or running a project. PyOCD is somewhat different in that it connects to the device as a whole, and then debugs a chosen core after the connection is established (which more closely reflects the hardware situation).</p>
363+
<p>The DFP debug sequence architecture is currently based on the fact that most debuggers only “connect” to a single CPU core chosen by the user when debugging or running a project. All debug sequences can be customised per core, and there can be separate sequences for each core.</p>
364+
365+
<p>PyOCD is somewhat different in that it connects to the device as a whole, and then debugs one or more cores after the connection is established. This more closely reflects the hardware situation.</p>
366+
367+
<p>This primarily impacts the <code class="highlighter-rouge">DebugPortSetup</code>, <code class="highlighter-rouge">DebugPortStart</code>, <code class="highlighter-rouge">DebugPortStop</code>, and <code class="highlighter-rouge">DebugDeviceUnlock</code> debug sequences that affect the entire SoC. These relate to the connect procedure for the Arm ADI DP (Debug Port) used for SWD/JTAG communications. While most sequences can be run separately for each core, these are run only once per target connection. The core-specific variant that is selected can affect the rest of the debugging session. (Technically, this is also true for debuggers that are presented as debugging a single core, in cases where a second instance of that debugger can be started to debug another core. But, the way it’s presented to the user is different.)</p>
368+
369+
<p>The <code class="highlighter-rouge">primary_core</code> session option is used to select which core-specific version of the <code class="highlighter-rouge">DebugPort*</code>/<code class="highlighter-rouge">DebugDeviceUnlock</code> sequences is run during the target connection process. For all other sequences, the core-specific version that is run depends on which core is performing the action.</p>
364370

365371
<h3 id="custom-default-reset-sequences">Custom default reset sequences</h3>
366372

0 commit comments

Comments
 (0)