rpp/doc/os.txt

   1 ######################################
   2 # FreeRTOS library for RPP           #
   3 ######################################
   4
   5 TODO: OS layer was downgraded from 7.4.2 to 7.0.2. Please update this file.
   6
   7 This library includes the vanilla FreeRTOS version 7.4.2 configured for TI
   8 TMS570 processor family. Below you can find a listing of the files involved and
   9 where they come from.
  10
  11 + Common source code (Kernel):
  12
  13     src/os/croutine.c (Optional)
  14     src/os/list.c
  15     src/os/queue.c
  16     src/os/tasks.c
  17     src/os/timers.c  (Optional)
  18
  19         -> Originally found in:
  20             <FreeRTOSRoot>/FreeRTOS/Source
  21
  22 + Common include definitions:
  23
  24     include/os/croutine.h
  25     include/os/FreeRTOS.h
  26     include/os/list.h
  27     include/os/mpu_wrappers.h
  28     include/os/portable.h (with minor editions)
  29     include/os/projdefs.h
  30     include/os/queue.h
  31     include/os/semphr.h
  32     include/os/StackMacros.h
  33     include/os/task.h
  34     include/os/timers.h
  35
  36         -> Originally found in:
  37             <FreeRTOSRoot>/FreeRTOS/Source/include
  38
  39 + TMS570 / ARM Cortex R4 for CCS port:
  40
  41     src/os/heap.c
  42
  43         -> Originally found in:
  44             <FreeRTOSRoot>/FreeRTOS/Source/portable/MemMang (renamed from heap_4.c)
  45         -> For documentation about heap_4.c memory managment scheme check:
  46             http://www.freertos.org/a00111.html
  47
  48     src/os/port.c
  49     src/os/portASM.asm
  50     include/os/portmacro.h
  51
  52         -> Originally found in:
  53             <FreeRTOSRoot>/FreeRTOS/Source/portable/CCS/ARM_Cortex-R4
  54
  55     include/os/FreeRTOSConfig.h
  56
  57         -> Originally found in:
  58             <FreeRTOSRoot>/FreeRTOS/Demo/CORTEX_R4_RM48_TMS570_CCS5
  59
  60
  61 The following changes were applied to the source code base:
  62
  63 + Replaced include directives to adapt to RPP library standard:
  64
  65     #include "
  66
  67         With
  68
  69     #include "os/
  70
  71 + New line character set to UNIX '\n' and tabs replaced by 4 spaces.
  72