git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/FreeRTOS_Plus_UDP_and_CLI_LPC1830_GCC/ThirdParty/TraceRecorderSrc/readme.txt

   1 \r
   2 FreeRTOS+Trace Trace Recorder Library\r
   3 -------------------------------------\r
   4 Percepio AB\r
   5 www.percepio.com\r
   6 \r
   7 This directory contains the core trace recorder library used by FreeRTOS+Trace v2.3. \r
   8 \r
   9 Ready-to-run demonstrations projects are found at www.percepio.com.\r
  10 \r
  11 For information on how to integrate the recorder library in your FreeRTOS build, see\r
  12 the FreeRTOS+Trace User Manual, section 2.\r
  13 \r
  14 For information on how to upload the trace data from your target system RAM to \r
  15 FreeRTOS+Trace, see "debugger trace upload.txt"\r
  16 \r
  17 NOTE: This trace recorder library requires FreeRTOS v7.3.0 or later.\r
  18 \r
  19 Files included\r
  20 --------------\r
  21 - trcConfig.h               - The recorder's configuration file, check this!\r
  22 - trcUser.c / trcUser.h     - The main API towards the application (trcUser.h in the only include necessary).\r
  23 - trcKernel.c / trcKernel.h - Internal routines for storing kernel events.\r
  24 - trcBase.c / trcBase.h     - Internal routines for manipulating the data structures and calculating timestamps.\r
  25 - trcPort.c / trcPort.h     - The port layer, abstracting the hardware (mainly the timer used for timestamping).\r
  26 - trcHooks.h                            - The interface between FreeRTOS and the recorder, containing trace macro defintions.\r
  27 - trcTypes.h                            - Type definitions used.\r
  28 \r
  29 Hardware Timer Ports\r
  30 --------------------\r
  31 This release contains hardware timer ports for the following hardware architectures:\r
  32 \r
  33 - ARM Cortex M3/M4 (all brands, such as Atmel SAM3/SAM4, NXP 17xx, 18xx, 43xx, STM32, Freescale Kinetis, ...)\r
  34 - Atmel AT91SAM7x\r
  35 - Atmel AT32UC3 (AVR32)\r
  36 - Renesas RX600 (e.g., RX62N)\r
  37 - Microchip dsPIC/PIC24\r
  38 \r
  39 These are defined in trcPort.h. This also contains several "unofficial" ports, provided by external contributors.\r
  40 By unofficial, it means that they are not yet verified by Percepio AB. Please refer to trcPort.h for detailed information. \r
  41 If you use an unofficial port and beleive it is incorrect, please let us know!\r
  42 \r
  43 In case your MCU is not yet supported directly, developing a new port is quite easy, just a matter of defining a few macros\r
  44 according to your specific MCU. See trcPort.h for further information.\r
  45 \r
  46 In case you have any questions, do not hesitate to contact support@percepio.com\r
  47 \r
  48 Percepio AB\r
  49 Köpmangatan 1A\r
  50 72215 Västerås\r
  51 Sweden\r
  52 \r
  53 www.percepio.com