Skip to content

Commit

Permalink
doc: test_and_optimize: debugging tools list edits
Browse files Browse the repository at this point in the history
Reworked the debugging tools section into a table with more
tools listed. NCSDK-22325.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
  • Loading branch information
greg-fer authored and rlubos committed Apr 3, 2024
1 parent 96da08b commit 01c5bdf
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 10 deletions.
8 changes: 7 additions & 1 deletion doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -547,20 +547,27 @@
.. _`Connecting using Serial Terminal`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/connecting.html
.. _`Serial Terminal configuration`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/configuration.html

.. _`nRF Connect Bluetooth Low Energy`: https://docs.nordicsemi.com/bundle/nrf-connect-ble/page/index.html

.. _`Cellular Monitor`: https://docs.nordicsemi.com/bundle/nrf-connect-cellularmonitor/page/index.html
.. _`Managing credentials`: https://docs.nordicsemi.com/bundle/nrf-connect-cellularmonitor/page/managing_credentials.html

.. _`nRF Connect Direct Test Mode`: https://docs.nordicsemi.com/bundle/nrf-connect-direct-test-mode/page/index.html

.. _`nRF Connect Programmer`: https://docs.nordicsemi.com/bundle/nrf-connect-programmer/page/index.html
.. _`Programming the nRF52840 Dongle`:
.. _`Programming a Development Kit`: https://docs.nordicsemi.com/bundle/nrf-connect-programmer/page/programming_dk.html

.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html

.. _`nRF Thread Topology Monitor`: https://docs.nordicsemi.com/bundle/ug_nrf_ttm/page/UG/nrf_ttm/ttm_introduction.html
.. _`nRF Sniffer for 802.15.4`: https://docs.nordicsemi.com/bundle/ug_sniffer_802154/page/UG/sniffer_802154/intro_802154.html
.. _`Configuring Wireshark for Zigbee`: https://docs.nordicsemi.com/bundle/ug_sniffer_802154/page/UG/sniffer_802154/configuring_sniffer_802154_zigbee.html

.. _`Power Profiler Kit II (PPK2)`: https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/PPK_user_guide_Intro.html
.. _`Install the Power Profiler app`: https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/common/nrf_connect_app_installing.html
.. _`Using the Power Profiler app`: https://docs.nordicsemi.com/bundle/ug_ppk2/page/UG/ppk/PPK_user_guide_Running_the_software.html
.. _`nRF Connect Power Profiler`: https://docs.nordicsemi.com/bundle/nrf-connect-ppk/page/index.html

.. _`sysbuild support`: https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/guides/build_overview.html#system-build-sysbuild

Expand Down Expand Up @@ -1522,7 +1529,6 @@

.. _`10.22.3_cs3 ARMHF system, zip archive`: https://res.developer.nordicsemi.com/res/nrf-command-line-tools-10.23.3/nrf-command-line-tools-10.23.3-armhf-linux.zip

.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html
.. _`Git for Windows`: https://git-scm.com/download/win
.. _`nRF Terminal documentation`: https://nrfconnect.github.io/vscode-nrf-connect/terminal/nrfterminal.html

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,10 @@ cJSON
Documentation
=============

* Recommend the use of a :file:`VERSION` file for :ref:`ug_fw_update_image_versions_mcuboot` in the :ref:`ug_fw_update_image_versions` user guide.
* Added:

* List of :ref:`debugging_tools` on the :ref:`debugging` page.
* Recommendation for the use of a :file:`VERSION` file for :ref:`ug_fw_update_image_versions_mcuboot` in the :ref:`ug_fw_update_image_versions` user guide.

* Updated:

Expand Down
48 changes: 40 additions & 8 deletions doc/nrf/test_and_optimize/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ If you want to reset the network core while debugging, make sure to first reset
Debugging secure and non-secure firmware
****************************************

When using a build target with :ref:`CMSE enabled <app_boards_spe_nspe_cpuapp_ns>` (``_ns``), by default you can only debug firmware in the non-secure environment of the application core firmware.
When using a :ref:`build target <app_boards_names>` with :ref:`CMSE enabled <app_boards_spe_nspe_cpuapp_ns>` (``_ns``), by default you can only debug firmware in the non-secure environment of the application core firmware.

To debug firmware running in the secure environment, you need to build Trusted Firmware-M with debug symbols enabled and load the symbols during the debugging session.
To build Trusted Firmware-M with debug symbols, set the :kconfig:option:`CONFIG_TFM_CMAKE_BUILD_TYPE_RELWITHDEBINFO` Kconfig option.
Expand All @@ -133,10 +133,42 @@ Use the following steps to enable monitor-mode debugging in the |NCS|:

For more information about monitor-mode debugging, see Zephyr's :ref:`zephyr:debugmon` documentation and SEGGER's `Monitor-mode Debugging <Monitor-mode Debugging_>`_ documentation.

Other debugging tools
*********************

In addition to nRF Debug, a useful tool for debugging the communication over Bluetooth and mesh networking protocols, such as :ref:`ug_thread` or :ref:`ug_zigbee`, is the `nRF Sniffer for 802.15.4`_.
The nRF Sniffer allows you to look into data exchanged over-the-air between devices.

Check also the different `nRF Connect for Desktop`_ apps, which you can use to test and optimize your application for different use cases.
.. _debugging_tools:

Debugging tools
***************

In addition to nRF Debug, you can use several other standalone tools to debug the |NCS| applications.

The following debugging tools are most commonly used in different areas of the |NCS|:

.. list-table:: Most common debugging tools in the |NCS|
:header-rows: 1

* - Tool
- Purpose
- Area
* - `nRF Connect Bluetooth Low Energy`_
- Configure and test Bluetooth Low Energy devices. Available from `nRF Connect for Desktop`_.
- :ref:`ug_bt`
* - `Cellular Monitor`_
- Capture and analyze modem traces to evaluate communication and view network parameters. Available from `nRF Connect for Desktop`_.
- :ref:`ug_lte`
* - `nRF Connect Direct Test Mode`_
- Perform RF PHY checks of Bluetooth Low Energy devices using a GUI for the Bluetooth-specified Direct Test Mode. Available from `nRF Connect for Desktop`_.
- :ref:`ug_bt`
* - `nRF Connect Power Profiler`_
- Measure the real-time power consumption of your designs. Available from `nRF Connect for Desktop`_.
- :ref:`ug_bt`, :ref:`ug_lte`, :ref:`ug_matter`, :ref:`ug_thread`, :ref:`ug_wifi`, :ref:`ug_zigbee`
* - `Online Power Profiler (OPP)`_
- Calculate the current consumption online.
- :ref:`ug_bt`, :ref:`ug_lte`, :ref:`ug_wifi`
* - `nRF Sniffer for 802.15.4`_
- Debug the communication over networking protocols by look into data exchanged over-the-air between devices.
- :ref:`ug_bt_mesh`, :ref:`ug_matter`, :ref:`ug_thread`, :ref:`ug_zigbee`
* - `nRF Sniffer for Bluetooth LE`_
- Debug Bluetooth packets that are sent between a selected Bluetooth Low Energy device and the device it is communicating with, even when the connection is encrypted. Available from `nRF Util`_.
- :ref:`ug_bt`, :ref:`ug_matter`
* - `nRF Thread Topology Monitor`_
- Visualize Thread mesh network topology in real time.
- :ref:`ug_thread`

0 comments on commit 01c5bdf

Please sign in to comment.