drivers: debug: Moved nrf_etr from misc

Moved the nrf_etr driver from the drive/misc folder into the recently
established driver/debug folder where it is a better fit. Moved the
associated files such as bindings and headers accordingly as well.

Signed-off-by: Karsten Koenig <[email protected]>

Author: karstenkoenig

doc/releases/migration-guide-4.3.rst

@@ -61,6 +61,14 @@ Device Drivers and Devicetree
 
 .. zephyr-keep-sorted-start re(^\w)
 
+MISC
+====
+
+* The nrf_etr driver has been migrated to drivers/debug. As a consequence the related Kconfig
+  symbol was renamed from ``NRF_ETR`` to :kconfig:option:`DEBUG_NRF_ETR`, along with the rest of
+  the ``NRF_ETR`` symbols. Also the driver needs to be explicitly enabled via
+  :kconfig:option:`DEBUG_DRIVER` as it is no longer built by default.
+
 MFD
 ===
 

doc/services/logging/cs_stm.rst

@@ -119,7 +119,7 @@ When using logs, this method has the following advantages:
 
 Proxy core is using Nordic specific peripheral (TBM) to get ETR buffer busyness and send data over
 UART. Nordic specific driver for ETR buffer is located in
-:zephyr_file:`drivers/misc/coresight/nrf_etr.c`.
+:zephyr_file:`drivers/debug/debug_nrf_etr.c`.
 
 Configuration
 -------------
@@ -175,7 +175,7 @@ in :zephyr_file:`subsys/logging/frontends/log_frontend_stmesp_demux.c`.
 
 ``Proxy`` is using Nordic specific peripheral (TBM) to get ETR buffer busyness and read and
 decode data and send human-readable data over UART. Nordic specific driver for ETR buffer is
-located in :zephyr_file:`drivers/misc/coresight/nrf_etr.c`. It is using :ref:`cs_trace_defmt` and
+located in :zephyr_file:`drivers/debug/debug_nrf_etr.c`. It is using :ref:`cs_trace_defmt` and
 :ref:`mipi_stp_decoder` and above-mentioned demultiplexer to decode messages.
 
 Logging messages contains read-only format string used in the logging macros thus they cannot be

drivers/debug/CMakeLists.txt

@@ -5,4 +5,5 @@ zephyr_library()
 
 # zephyr-keep-sorted-start
 zephyr_library_sources_ifdef(CONFIG_DEBUG_SILABS_PTI debug_silabs_pti.c)
+zephyr_library_sources_ifdef(CONFIG_DEBUG_NRF_ETR debug_nrf_etr.c)
 # zephyr-keep-sorted-stop

drivers/debug/Kconfig

@@ -15,6 +15,7 @@ config DEBUG_DRIVER_INIT_PRIORITY
 	  Debug drivers initialization priority.
 
 # zephyr-keep-sorted-start
+source "drivers/debug/Kconfig.nrf"
 source "drivers/debug/Kconfig.silabs"
 # zephyr-keep-sorted-stop
 

drivers/misc/coresight/Kconfig renamed to drivers/debug/Kconfig.nrf

@@ -3,7 +3,7 @@
 
 DT_COMPAT_NORDIC_NRF_TBM := nordic,nrf-tbm
 
-config NRF_ETR
+config DEBUG_NRF_ETR
 	bool "Coresight ETR handler (with Nordic TBM)"
 	depends on $(dt_compat_enabled,$(DT_COMPAT_NORDIC_NRF_TBM))
 	select NRFX_TBM
@@ -14,9 +14,9 @@ config NRF_ETR
 	  data). Busyness is tracked using TBM (Trace Buffer Monitor) peripheral
 	  which is specific to Nordic Semiconductor SoCs.
 
-if NRF_ETR
+if DEBUG_NRF_ETR
 
-config NRF_ETR_DECODE
+config DEBUG_NRF_ETR_DECODE
 	bool "Decode ETR content"
 	default y if LOG_FRONTEND_STMESP_FSC
 	select MIPI_STP_DECODER
@@ -29,70 +29,70 @@ config NRF_ETR_DECODE
 	  In this mode, log messages stored by Coresight STM logging frontends are
 	  decoded and printed in the human readable form.
 
-config NRF_ETR_DECODE_DROP_PERIOD
+config DEBUG_NRF_ETR_DECODE_DROP_PERIOD
 	int "Period of dropped messages notification"
 	default 5000
 	help
 	  Period (in milliseconds) how often it is checked if any dropped messages
 	  have occurred.
 
-config NRF_ETR_DEBUG
+config DEBUG_NRF_ETR_DEBUG
 	bool "Debug mode"
 	depends on !LOG_PRINTK
 	select MIPI_STP_DECODER
 	select CS_TRACE_DEFMT
 	help
 	  In debug mode STPv2 decoded data is printed.
 
-config NRF_ETR_STACK_SIZE
+config DEBUG_NRF_ETR_STACK_SIZE
 	int "ETR thread stack size"
-	default 2048 if NRF_ETR_DECODE || NRF_ETR_DEBUG
+	default 2048 if DEBUG_NRF_ETR_DECODE || DEBUG_NRF_ETR_DEBUG
 	default 1024
 
-config NRF_ETR_BACKOFF
+config DEBUG_NRF_ETR_BACKOFF
 	int "Thread backoff time (ms)"
 	default 10
 	help
 	  Determines how often attempt to dump the data is performed.
 
-config NRF_ETR_FLUSH_TIMEOUT
+config DEBUG_NRF_ETR_FLUSH_TIMEOUT
 	int "Backoff time during flushing (ms)"
 	default 100
 	help
 	  When thread triggers flushing of ETR data, it periodically checks if
 	  there is still a pending ETR data. This option specifies how often
 	  thread is waking up to check. Given in milliseconds.
 
-config NRF_ETR_SYNC_PERIOD
+config DEBUG_NRF_ETR_SYNC_PERIOD
 	int "Period of custom synchronization frame"
-	default 0 if NRF_ETR_DECODE
-	default 0 if NRF_ETR_DEBUG
+	default 0 if DEBUG_NRF_ETR_DECODE
+	default 0 if DEBUG_NRF_ETR_DEBUG
 	default 16
 	help
 	  To help find the synchronization when decoding the ETR content
 	  by a host tool a synchronization pattern (16 bytes of 0xFF) can be
 	  sent on regular intervals. This frame is sent between Coresight formatter
 	  frames. Use 0 to disable.
 
-config NRF_ETR_SHELL
+config DEBUG_NRF_ETR_SHELL
 	bool "Use shell"
 	select UART_ASYNC_API
 	select UART_ASYNC_RX_HELPER
 	select SHELL_LOG_BACKEND_CUSTOM
-	depends on NRF_ETR_DECODE
+	depends on DEBUG_NRF_ETR_DECODE
 	default y if SHELL
 	help
 	  Enable shell with Coresight STM logging support.
 
-if NRF_ETR_SHELL
+if DEBUG_NRF_ETR_SHELL
 
-config NRF_ETR_SHELL_PROMPT
+config DEBUG_NRF_ETR_SHELL_PROMPT
 	string "Displayed prompt name"
 	default "uart:~$ "
 	help
 	  Displayed prompt name for UART shell with Coresight STM logging.
 
-config NRF_ETR_SHELL_ASYNC_RX_BUFFER_SIZE
+config DEBUG_NRF_ETR_SHELL_ASYNC_RX_BUFFER_SIZE
 	int "Size of the RX buffer"
 	default 16
 	help
@@ -101,13 +101,13 @@ config NRF_ETR_SHELL_ASYNC_RX_BUFFER_SIZE
 	  slow and may need to be increased if long messages are pasted directly
 	  to the shell prompt.
 
-config NRF_ETR_SHELL_ASYNC_RX_BUFFER_COUNT
+config DEBUG_NRF_ETR_SHELL_ASYNC_RX_BUFFER_COUNT
 	int "Number of RX buffers"
 	default 4
 	range 2 64
 	help
 	  Number of RX buffers.
 
-endif # NRF_ETR_SHELL
+endif # DEBUG_NRF_ETR_SHELL
 
-endif # NRF_ETR
+endif # DEBUG_NRF_ETR