summaryrefslogtreecommitdiff
path: root/examples/readme.md
diff options
context:
space:
mode:
authorhathach <[email protected]>2020-04-22 19:18:03 +0700
committerhathach <[email protected]>2020-04-22 19:18:03 +0700
commit1fc7f54a8a05792d6e56d0ed14ded1c4a7b389bd (patch)
treeecc8477e9b5dd3d2538f5a48e15d0f48ea76ec52 /examples/readme.md
parent894a09f2ae7082fd9e850b76febed12dafecdcd4 (diff)
added swo as logger
tested with feather nrf52840 + jlink
Diffstat (limited to 'examples/readme.md')
-rw-r--r--examples/readme.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/examples/readme.md b/examples/readme.md
index 092787221..ae7b0a111 100644
--- a/examples/readme.md
+++ b/examples/readme.md
@@ -44,13 +44,23 @@ $ make LOG=2 BOARD=feather_nrf52840_express all
### Logger
-By default log message is printed via on-board UART which is slow and take lots of CPU time comparing to USB speed. If your board support on-board/external JLink debugger, it would be more efficient to use it with [RTT protocol](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/) for logging. To do that add option `LOGGER=rtt` to build command e.g
+By default log message is printed via on-board UART which is slow and take lots of CPU time comparing to USB speed. If your board support on-board/external debugger, it would be more efficient to use it for logging. There are 2 protocols:
+
+- `LOGGER=rtt`: use [Segger RTT protocol](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/)
+ - Cons: requires jlink as the debugger.
+ - Pros: work with most if not all MCUs
+ - Software viewer is JLink RTT Viewer/Client/Logger which is bundled with JLink driver package.
+- `LOGGER=swo`: Use dedicated SWO pin of ARM Cortex SWD debug header.
+ - Cons: only work with ARM Cortex MCUs minus M0
+ - Pros: even faster than RTT, and should be compatible with hardware and software debugger that support SWO.
+ - Software viewer is JLink SWO Viewer which is also bundled with JLink driver package.
```
$ make LOG=2 LOGGER=rtt BOARD=feather_nrf52840_express all
+$ make LOG=2 LOGGER=swo BOARD=feather_nrf52840_express all
```
-The log can be retrieved by JLink RTT Viewer/Client/Logger software which is bundled with their JLink driver.
+The log can be retrieved by
## Flash