summaryrefslogtreecommitdiff
path: root/lib/SEGGER_RTT/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/SEGGER_RTT/README.md')
-rw-r--r--lib/SEGGER_RTT/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/SEGGER_RTT/README.md b/lib/SEGGER_RTT/README.md
new file mode 100644
index 000000000..06349d248
--- /dev/null
+++ b/lib/SEGGER_RTT/README.md
@@ -0,0 +1,24 @@
+RTT
+===
+
+SEGGER RTT Sources
+
+https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer
+https://wiki.segger.com/RTT
+
+## Included files
+
+ * `RTT/`
+ * `SEGGER_RTT.c` - Main module for RTT.
+ * `SEGGER_RTT.h` - Main header for RTT.
+ * `SEGGER_RTT_ASM_ARMv7M.S` - Assembly-optimized implementation of RTT functions for ARMv7M processors.
+ * `SEGGER_RTT_Printf.c` - Simple implementation of printf (`SEGGER_RTT_Printf()`) to write formatted strings via RTT.
+ * `Syscalls/`
+ * `SEGGER_RTT_Syscalls_*.c` - Low-level syscalls to retarget `printf()` to RTT with different toolchains.
+ * `Config/`
+ * `SEGGER_RTT_Conf.h` - RTT configuration file.
+ * `Examples/`
+ * `Main_RTT_InputEchoApp.c` - Example application which echoes input on Channel 0.
+ * `Main_RTT_MenuApp.c` - Example application to demonstrate RTT bi-directional functionality.
+ * `Main_RTT_PrintfTest.c` - Example application to test RTT's simple printf implementation.
+ * `Main_RTT_SpeedTestApp.c` - Example application to measure RTT performance. (Requires embOS)