Lines Matching +full:github +full:- +full:pages
1 .. _flash-debug-host-tools:
9 Zephyr's west tool has built-in support for all of these in its ``flash``,
12 file declares that support properly. See :ref:`west-build-flash-debug` for
17 SAM Boot Assistant (SAM-BA)
20 Atmel SAM Boot Assistant (Atmel SAM-BA) allows In-System Programming (ISP)
22 allows users to develop and program boards with SAM-BA support using
23 :ref:`west <west-flashing>`. Zephyr supports devices with/without ROM
29 .. code-block:: console
31 west flash [ -r bossac ] [ -p /dev/ttyX ] [ --erase ]
35 By default, flashing with bossac will only erase the flash pages containing
36 the flashed application, leaving other pages untouched. Should you wish to
37 erase the entire flash of the target when flashing, pass the ``--erase``
59 3. Build and flash the SAM-BA bootloader on the device.
61 .. tab:: With compatible SAM-BA bootloader
75 to select the right compatible SAM-BA bootloader mode.
77 3. Build and flash the SAM-BA bootloader on the device.
86 --------------------------------------
90 the application uses a storage or other non-application partition. In this
97 .. code-block:: devicetree
101 zephyr,code-partition = &code_partition;
107 compatible = "fixed-partitions";
108 #address-cells = <1>;
109 #size-cells = <1>;
112 label = "sam-ba";
114 read-only;
120 read-only;
138 .. code-block:: devicetree
142 zephyr,code-partition = &code_partition;
148 compatible = "fixed-partitions";
149 #address-cells = <1>;
150 #size-cells = <1>;
155 read-only;
171 Enabling SAM-BA runner
172 ----------------------
174 In order to instruct Zephyr west tool to use the SAM-BA bootloader the
180 ``west flash -r bossac``.
184 As a quick reference, see these three board documentation pages:
186 - :zephyr:board:`sam4e_xpro` (ROM bootloader)
187 - :zephyr:board:`adafruit_feather_m0_basic_proto` (Adafruit UF2 bootloader)
188 - :zephyr:board:`arduino_nano_33_iot` (Arduino bootloader)
189 - :zephyr:board:`arduino_nano_33_ble` (Arduino legacy bootloader)
192 ------------------------------------------------
198 ``--bossac`` option, as follows:
200 .. code-block:: console
202 west flash -r bossac --bossac="C:\Program Files (x86)\BOSSA\bossac.exe" --bossac-port="COMx"
209 .. _linkserver-debug-host-tools:
215 which also provides a command-line target flash programming capabilities.
218 for continuous integration and test. LinkServer can be used with MCU-Link, LPC-Link2,
219 LPC11U35-based and OpenSDA based standalone or on-board debug probes from NXP.
223 including NXP's MCU-Link and LPCScrypt tools.
227 - :ref:`lpclink2-cmsis-onboard-debug-probe`
228 - :ref:`mcu-link-cmsis-onboard-debug-probe`
229 - :ref:`opensda-daplink-onboard-debug-probe`
237 .. group-tab:: Linux
239 .. code-block:: console
243 .. group-tab:: Windows
245 .. code-block:: console
261 .. code-block:: console
266 LinkServer west runner ``--probe`` option to pass the probe index.
268 .. code-block:: console
270 west flash --runner=linkserver --probe=3
272 3. Device-specific settings can be overridden with the west runner for LinkServer with
273 the option '--override'. May be used multiple times. The format is dictated
276 .. code-block:: console
278 …west flash --runner=linkserver --override /device/memory/5/flash-driver=MIMXRT500_SFDP_MXIC_OSPI_S…
284 .. _jlink-debug-host-tools:
286 J-Link Debug Host Tools
292 - J-Link GDB Server: GDB remote debugging
293 - J-Link Commander: Command-line control and flash programming
294 - RTT Viewer: RTT terminal input and output
295 - SystemView: Real-time event visualization and recording
299 - :ref:`lpclink2-jlink-onboard-debug-probe`
300 - :ref:`opensda-jlink-onboard-debug-probe`
301 - :ref:`mcu-link-jlink-onboard-debug-probe`
302 - :ref:`jlink-external-debug-probe`
303 - :ref:`stlink-v21-onboard-debug-probe`
305 Check if your SoC is listed in `J-Link Supported Devices`_.
307 Download and install the `J-Link Software and Documentation Pack`_ to get the
308 J-Link GDB Server and Commander, and to install the associated USB device
312 Note that the J-Link GDB server does not yet support Zephyr RTOS-awareness.
314 .. _openocd-debug-host-tools:
321 RTOS-awareness is included in the Zephyr SDK; otherwise see `Getting OpenOCD`_
326 - :ref:`opensda-daplink-onboard-debug-probe`
327 - :ref:`jlink-external-debug-probe`
328 - :ref:`stlink-v21-onboard-debug-probe`
333 <https://github.com/zephyrproject-rtos/sdk-ng/releases>`_.
337 - Download openocd for Windows from here: `OpenOCD Windows`_
338 - Copy bin and share dirs to ``C:\Program Files\OpenOCD\``
339 - Add ``C:\Program Files\OpenOCD\bin`` to 'PATH' environment variable
341 .. _pyocd-debug-host-tools:
347 flash programming support for Arm Cortex-M SoCs. It is distributed on PyPi and
349 Started Guide. pyOCD includes support for Zephyr RTOS-awareness.
353 - :ref:`lpclink2-cmsis-onboard-debug-probe`
354 - :ref:`mcu-link-cmsis-onboard-debug-probe`
355 - :ref:`opensda-daplink-onboard-debug-probe`
356 - :ref:`stlink-v21-onboard-debug-probe`
360 .. _lauterbach-trace32-debug-host-tools:
366 debuggers and real-time tracer with support for JTAG, SWD, NEXUS or ETM over
367 multiple core architectures, including Arm Cortex-A/-R/-M, RISC-V, Xtensa, etc.
369 support using :ref:`west <west-flashing>`.
372 board to execute a custom start-up script (Practice Script) for the different
378 -----------------------------------
385 ----------------------
389 flash or debug the Zephyr application as detailed in :ref:`west-build-flash-debug`.
397 ``--config CONFIG`` to the runner, for example:
399 .. code-block:: console
401 west flash --config myconfig.t32
403 For more options, run ``west flash --context -r t32`` to print the usage.
406 ---------------------
411 .. _nxp-s32-debug-host-tools:
416 :ref:`nxp-s32-debug-probe` is designed to work in conjunction with
423 Note that Zephyr RTOS-awareness support for the NXP S32 GDB server depends on
433 -----------
437 the runner on each invocation via ``--s32ds-path`` as shown below:
441 .. group-tab:: Linux
443 .. code-block:: console
445 west debug --s32ds-path=/opt/NXP/S32DS.3.5
447 .. group-tab:: Windows
449 .. code-block:: console
451 west debug --s32ds-path=C:\NXP\S32DS.3.5
456 via ``--dev-id=<connection-string>``. Consult NXP S32 debug probe user manual
460 .. code-block:: console
462 west debug --dev-id='s32dbg:00:04:9f:00:ca:fe'
464 It is possible to pass extra options to the debug host tools via ``--tool-opt``.
470 .. code-block:: console
472 west debug --tool-opt='--batch'
474 probe-rs Debug Host Tools
477 probe-rs is an open-source embedded toolkit written in Rust. It provides
478 out-of-the-box support for a variety of debug probes, including CMSIS-DAP,
479 ST-Link, SEGGER J-Link, FTDI and built-in USB-JTAG interface on ESP32 devices.
481 Check `probe-rs Installation`_ for more setup details.
483 Check if your SoC is listed in `probe-rs Supported Devices`_.
485 .. _stm32cubeprog-flash-host-tools:
493 It provides an easy-to-use and efficient environment for reading, writing, and verifying device mem…
502 It is delivered in GUI (graphical user interface) and CLI (command-line interface) versions.
506 - :ref:`stlink-v21-onboard-debug-probe`
507 - :ref:`jlink-external-debug-probe`
508 - Standalone `ST-LINK-V2`_, `ST-LINK-V3`_, and `STLINK-V3PWR`_ probes
511 ---------------------------
516 Alternatively, it can be installed as part of `STM32CubeCLT`_ all-in-one multi-OS command-line tool…
522 -----------
527 .. code-block:: console
529 west flash --runner stm32cubeprogrammer
533 .. _J-Link Software and Documentation Pack:
534 https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack
536 .. _J-Link Supported Devices:
537 https://www.segger.com/downloads/supported-devices.php
540 https://openocd.org/pages/getting-openocd.html
543 https://github.com/zephyrproject-rtos/openocd/tree/latest/tcl/target
546 https://github.com/pyocd/pyOCD/tree/main/pyocd/target/builtin
549 http://gnutoolchains.com/arm-eabi/openocd/
564 https://github.com/shumatech/BOSSA/releases
567 …p.com/design/software/development-software/mcuxpresso-software-and-tools-/mcuxpresso-for-visual-st…
570 https://github.com/nxp-mcuxpresso/vscode-for-mcux/wiki/Dependency-Installation
573 …/www.nxp.com/design/software/development-software/s32-design-studio-ide/s32-design-studio-for-s32-…
578 .. _probe-rs Installation:
579 https://probe.rs/docs/getting-started/installation/
581 .. _probe-rs Supported Devices:
585 https://www.st.com/en/development-tools/stm32cubeprog.html
588 https://www.st.com/en/development-tools/stm32cubeclt.html
591 …https://www.st.com/resource/en/user_manual/um2237-stm32cubeprogrammer-software-description-stmicro…
593 .. _ST-LINK-V2:
594 https://www.st.com/en/development-tools/st-link-v2.html
596 .. _ST-LINK-V3:
597 https://www.st.com/en/development-tools/stlink-v3set.html
599 .. _STLINK-V3PWR:
600 https://www.st.com/en/development-tools/stlink-v3pwr.html