Add the Labs projects provided in the V10.2.1_191129 zip file.

[freertos] / FreeRTOS-Labs / Source / FreeRTOS-Plus-Trace / streamports / USB_CDC / Readme-Streamport.txt

diff --git a/FreeRTOS-Labs/Source/FreeRTOS-Plus-Trace/streamports/USB_CDC/Readme-Streamport.txt b/FreeRTOS-Labs/Source/FreeRTOS-Plus-Trace/streamports/USB_CDC/Readme-Streamport.txt
new file mode 100644 (file)
index 0000000..260f12a
--- /dev/null
+++ b/FreeRTOS-Labs/Source/FreeRTOS-Plus-Trace/streamports/USB_CDC/Readme-Streamport.txt
@@ -0,0 +1,27 @@
+Tracealyzer Stream Port for USB CDC (STM32 example)\r
+---------------------------------------------------\r
+\r
+This directory contains a "stream port" for the Tracealyzer recorder library,\r
+i.e., the specific code needed to use a particular interface for streaming a\r
+Tracealyzer RTOS trace. The stream port is defined by a set of macros in\r
+trcStreamingPort.h, found in the "include" directory.\r
+\r
+This particular stream port targets USB CDC. This is an example for the STM32 USB\r
+stack (from the STM32CubeMX code generation tool, v1.4.1) and has been tested on\r
+a STM32F767ZI device on a Nucleo board. See this blog post:\r
+\r
+http://percepio.com/2017/02/03/usb-trace-streaming-st-nucleo-f767zi-board/\r
+\r
+However, it should be straight-forward to modify this for other USB stacks.\r
+\r
+To use this stream port, make sure that include/trcStreamingPort.h is found\r
+by the compiler (i.e., add this folder to your project's include paths) and\r
+add all included source files to your build. Make sure no other versions of\r
+trcStreamingPort.h are included by mistake!\r
+\r
+Note that the USB stack not included, but assumed to exist in the project already.\r
+\r
+See also http://percepio.com/2016/10/05/rtos-tracing.\r
+\r
+Percepio AB\r
+www.percepio.com
\ No newline at end of file