git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/FreeRTOS-Plus-Trace/readme.txt

   1 -------------------------------------------------------------------------------\r
   2           Tracealyzer for FreeRTOS - Trace Recorder Library v3.1.1                      \r
   3 -------------------------------------------------------------------------------\r
   4 \r
   5 Tracealyzer for FreeRTOS is a sophisticated tool for tracing and visualization\r
   6 of FreeRTOS-based systems. Tracealyzer gives an unprecedented insight into the\r
   7 runtime behavior, which speeds up debugging, validation and optimization. \r
   8 \r
   9 To learn more about this, see\r
  10 \r
  11  - Getting Started (videos etc): http://percepio.com/gettingstarted/tz-freertos/\r
  12 \r
  13  - User Manual (incl. Recorder API): http://percepio.com/docs/FreeRTOS/manual\r
  14 \r
  15  - FAQ: http://percepio.com/category/faq/\r
  16 \r
  17 In case you have any questions, don't hesitate to contact support@percepio.com\r
  18 \r
  19 -------------------------------------------------------------------------------\r
  20 \r
  21 Changes, v3.1.1 -> v3.1.2\r
  22 \r
  23 - Fixed two bugs related to User Events, one in vTracePrintF and other in vTracePrint.\r
  24 \r
  25 - Fixed a build problem related to a single reference of the old FreeRTOS type "xTaskHandle", in trcKernelPort.c.\r
  26   Changed to "TaskHandle_t", unless if using an older FreeRTOS kernel or the "compatibility mode".\r
  27 \r
  28 - Removed traceCREATE_MUTEX hook for FreeRTOS v9 or later (no longer required)\r
  29 \r
  30 - Updated the User Manual regarding snapshot trace via IAR Embedded Workbench.\r
  31 \r
  32 - Renamed vTraceGetTraceBuffer to xTraceGetTraceBuffer, since returning a pointer.\r
  33 \r
  34 -------------------------------------------------------------------------------\r
  35 \r
  36 Changes, v3.1.0 -> v3.1.1\r
  37 \r
  38 After the major changes in the v3.1.0 trace recorder library, this update \r
  39 corrects a number of minor issues. Only minor functional improvements.\r
  40 \r
  41 - You can now use TRC_ALLOC_CUSTOM_BUFFER to declare a trace buffer on a custom\r
  42   location (using linker directives). \r
  43   The related function vTraceSetRecorderDataBuffer has been promoted to the\r
  44   Common API (previously only supported in snapshot mode, but custom allocation\r
  45   is now generally supported also in streaming mode).\r
  46   \r
  47 - Removed TRC_CFG_USE_LINKER_PRAGMA. No longer necessary thanks to the custom\r
  48   allocation mode.\r
  49   \r
  50 - Added support for timestamping from custom periodic timers, required for\r
  51   accurate timestamping on Cortex-M0/M0+ devices when using tickless idle.\r
  52   Only for streaming mode so far. See TRC_CUSTOM_TIMER_INCR / DECR.\r
  53 \r
  54 - ARM Cortex-M port: Made sure the DWT unit is initialized properly, in case\r
  55   the debugger doesn't handle this.\r
  56 \r
  57 - ARM Cortex-M port: Added possibility to use Systick timestamping also on\r
  58   Cortex-M3/M4/M7 devices (that otherwise use DWT timestamping by default).\r
  59   To use this option, define the macro TRC_CFG_ARM_CM_USE_SYSTICK.\r
  60 \r
  61 - J-Link streaming: The default RTT buffer has been changed from 0 to 1.\r
  62 \r
  63 - J-Link streaming: The RTT buffer settings for buffer 1 and higher, are now\r
  64   found in trcStreamingPort.h. Note: These settings don't apply to buffer 0.\r
  65 \r
  66 - vTracePrint has been optimized for better performance in string logging.\r
  67 \r
  68 - Minor performance improvement related to symbol table transfer in streaming mode.\r
  69 \r
  70 - Timer names now registered also in streaming mode.\r
  71 \r
  72 - Timer start and stop event are now traced.\r
  73 \r
  74 - Implemented support for queue registry (traceQUEUE_REGISTRY_ADD) also for streaming.\r
  75 \r
  76 - Fixed a bug related to repeated calls of vTraceEnable.\r
  77 \r
  78 - Fixed a bug where task-switches seemed to occur even though the scheduler was disabled.\r
  79 \r
  80 - Renamed HARDWARE_PORT_TEXAS_INSTRUMENTS_TMS570_RM48, added prefix TRC.\r
  81 \r
  82 - Fixed several language issues in the comments and documentation.\r
  83 \r
  84 - Fixed several minor issues and warnings from different compilers\r
  85  (including PowerPC/gcc) and configurations.\r
  86 \r
  87 -------------------------------------------------------------------------------\r
  88  \r
  89 Changes, v3.0.9 -> v3.1.0\r
  90 \r
  91 - Merge of previously separated snapshot and streaming recorders into a single\r
  92   recorder supporting both streaming and snapshot as different modes.\r
  93   \r
  94 - New common API for supporting both streaming and snapshot modes.\r
  95   \r
  96 - New integration guide, see the User Manual.\r
  97 \r
  98 - Major improvement of API documentation in source files and User Manual.\r
  99   \r
 100 - New concept of "stream ports", giving a better structure defining streaming\r
 101   interfaces, and restructured the J-Link and TCP/IP streaming as stream ports.\r
 102   \r
 103 - Added a stream port for USB CDC connections, with STM32 as example.\r
 104   Since Tracealyzer now can receive serial data on Windows COM ports, this is\r
 105   really easy to use.\r
 106 \r
 107 - Added a warning (#error) for cases where FreeRTOS tickless idle mode is used\r
 108   together with timestamping using SysTick or other periodic interrupt timers,\r
 109   Tracing with tickless idle requires an independent time source to correctly\r
 110   capture the length of the idle periods.\r
 111  \r
 112 - Major changes in the recorder API. Important examples are:\r
 113 \r
 114   * Some configuration macros have changed names, e.g. for "hardware port".\r
 115     Make sure to remove any old "trcConfig.h" files if upgrading from an\r
 116         earlier version!\r
 117 \r
 118   * Recorder configuration in trcConfig.h has been minimized and now only \r
 119     includes the important settings that are independent of recorder mode.\r
 120         Advanced settings for each mode are found in trcSnapshotConfig.h and\r
 121         trcStreamingConfig.h.\r
 122                 \r
 123   * vTraceEnable replaces Trace_Init and vTraceInitTraceData, as well as\r
 124     vTraceStart and uiTraceStart.\r
 125   \r
 126   * vTraceStop now part of the common API and thereby available also in\r
 127     streaming. And since vTraceEnable can start the streaming directly\r
 128         you have the option control the tracing from target, e.g., for\r
 129         streaming to a device file system.\r
 130   \r
 131   * vTraceStoreKernelObjectName from old streaming recorder has been replaced\r
 132     by vTraceSetQueueName, vTraceSetSemaphoreName, etc.\r
 133          \r
 134   * vTraceSetISRProperties now returns a "traceHandle" that should be passed as\r
 135     parameter to vTraceStoreISRBegin and vTraceStoreISREnd.\r
 136         \r
 137   * xTraceRegisterString has replaced the old functions xTraceOpenLabel and \r
 138     vTraceStoreUserEventChannelName. This now returns a "traceString" for use\r
 139         as "channel" parameter in vTracePrintF, and in other places where strings\r
 140         are stored.\r
 141         \r
 142   * Removed vTraceStoreISREndManual and vTraceStoreISREndAuto, use\r
 143     vTraceStoreISREnd instead.\r
 144   \r
 145   * Renamed the functions for saving User Events in a separate buffer:\r
 146      - xTraceRegisterChannelFormat      ->      xTraceRegisterUBChannel\r
 147      - vTraceChannelPrintF              ->      vTraceUBData\r
 148      - vTraceChannelUserEvent           ->      vTraceUBEvent\r
 149   \r
 150  \r
 151 -------------------------------------------------------------------------------\r
 152 Copyright Percepio AB, 2017.