git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MB96340_Softune/FreeRTOS_96348hs_SK16FX100PMC/readme.txt

   1 ==========================================================================\r
   2                    Template Project for MB96348HS Series\r
   3 ==========================================================================\r
   4                    Fujitsu Microelectronics Europe GmbH                       \r
   5    \r
   6  The following  software  is for  demonstration  purposes only.  It is not\r
   7  fully  tested, nor validated  in order  to fullfill  its task  under  all\r
   8  circumstances.  Therefore,  this software or  any part of it must only be\r
   9  used in an evaluation laboratory environment.                        \r
  10  This software is subject to the rules of our standard DISCLAIMER, that is\r
  11  delivered with our SW-tools on the Fujitsu Microcontrollers DVD \r
  12  (V5.0 or higher "\START.HTM").\r
  13 ==========================================================================\r
  14                \r
  15 History\r
  16 Date        Ver     Author  Softune     Description\r
  17 2007-10-29  1.0     MPi     V30L33R11   original version\r
  18 2007-11-02  1.1     MPi     V30L33R11   Added the watchdog functionality\r
  19                                                                                 Used vTaskStartScheduler() instead\r
  20                                                                                 of xPortStartScheduler()\r
  21 2007-11-12  1.2     MPi     V30L33R11   Updated FreeRTOS 4.6.1 and tested\r
  22 2007-11-23  1.3     MPi     V30L33R11   Seperated watchdog functionality in watchdog.c \r
  23                                                                                 and watchdog.h\r
  24 2008-01-03  1.4     MPi     V30L33R11   Added portYIELDFromISR() and now all the\r
  25                                                                                 demo application functions are working.\r
  26 2008-01-04  1.5     MPi     V30L33R11   Updated FreeRTOS 4.7.0 and tested\r
  27 2008-01-10  1.6     MPi     V30L33R11   Replaced INT9 with INT #122 in macro portYIELD()\r
  28 2008-01-14  1.7     MPi     V30L33R11   Modified the code to work with  SK-16FX-100PMC V1.1\r
  29 2008-01-15  1.8     MPi     V30L33R11   Integrated SVN releases 1.5 and 1.6.                    \r
  30 ==========================================================================\r
  31 1.0.\r
  32 This is a project is to test the FreeRTOS port for 16FX and the demo application\r
  33 which runs on FLASH-CAN-100P-240.\r
  34 \r
  35 This FreeRTOS port uses the Task Stack pointed by User Stack pointer (USB:USP) for\r
  36 tasks and the system stack pointed by System Stack pointer (SSB:SSP) for everything\r
  37 else. \r
  38 \r
  39 This port is tested with MEDIUM and LARGE memory model and seems to be working fine.\r
  40 The define MEMMODEL has to be configured in order to use the corresponding memory\r
  41 model.\r
  42 \r
  43 This port doesnt use any register banking and always uses bank 0. It also consider that\r
  44 the parameters to the tasks is passed via stack and not via registers.        \r
  45 \r
  46 In this port the implemetation of portENTER_CRITICAL() and portEXIT_CRITICAL() macros\r
  47 is changed in order to make them more efficient. Now usCriticalNesting variable is not\r
  48 used to keep track of global interrupt enable. Rather the current PS is stored on to \r
  49 the stack and interrupts are disabled for portENTER_CRITICAL(). And for portEXIT_CRITICAL()\r
  50 simply the PS is restored from stack.\r
  51 \r
  52 1.1.\r
  53 In this port, the functionality is added to initialize and clear the watchdog in the\r
  54 dedicated task, Tick Hook or the Idle Hook. The place exactly where the wtachdog can be \r
  55 cleared can be configured. Though Idle Hook is not an approproiate place to clear the \r
  56 watchdog, its done here for demonstration purpose only.\r
  57 \r
  58 Also from Main function vTaskStartScheduler() function is called instead of xPortStartScheduler().\r
  59 After doing this change now no more IDLE task is required to be added seperately as \r
  60 vTaskStartScheduler() adds prvIdleTask() on its own.\r
  61 \r
  62 1.2.\r
  63 Updated the FreeRTOS version to 4.6.1 and tested with the same.\r
  64 \r
  65 1.3.\r
  66 Moved the watchdog functionality to watchdog.c and watchdog.h.\r
  67 \r
  68 1.4.\r
  69 Added portYIELDFromISR() which uses delayed interrupt. This macro needs to be used from the\r
  70 application ISRs in order to force a context switch from them if required. It should be noted\r
  71 that the interrupt priority of such application ISRs MUST be always higher than the dealyed \r
  72 interrupt (currently 23) in order to perform the context switch correctly.\r
  73 \r
  74 It should be also noted that the RLT0 and Delayed Interrupt priority MUST be always same in order \r
  75 to assure correct working of this port.\r
  76 \r
  77 Now portYIELD() used software interrupt INT9 instead of delayed interrupt.\r
  78 \r
  79 Now all the queue functions works ok.\r
  80 \r
  81 Tested with the heap_1.c, heap_2.c and heap_3.c.\r
  82 \r
  83 At one time, either of heap_1.c or heap_2.c or heap_3.c needs to be used. Hence the files those are not \r
  84 required to be used should be removed from the target of the build.\r
  85 \r
  86 Added the __STD_LIB_sbrk.c file in order to define the *sbrk() function. This is required while using\r
  87 heap_3.c file which uses the dynamic memory allocation.\r
  88 \r
  89 Made changes to the demo application files crhook.c. Please refer the file and grep for "Added by MPi" \r
  90 to find the changes. It should be noted that if INCLUDE_StartHookCoRoutines is defined as 0 (i.e. if\r
  91 vStartHookCoRoutines() functionality is NOT required) then crhook.c file should be removed from target \r
  92 build and uncomment the vApplicationTickHook() function from main.c should be uncommnented.\r
  93 \r
  94 Added taskutility.c file. This file contains vUART2Task() which calls vTaskList() and vTaskStartTrace()\r
  95 functions.\r
  96 \r
  97 If vCreateBlockTimeTasks() is not called then the LED at PDR00_P7 blinks at normal rate (3s).\r
  98 \r
  99 This port is tested with MEDIUM and LARGE memory model and working fine.\r
 100 \r
 101 configMINIMAL_STACK_SIZE value changed to 172 from 70 in order to make the port work.\r
 102 \r
 103 1.5.\r
 104 Updated the FreeRTOS version to 4.7.0 and tested with the same. Tested for pre-emptive as well as \r
 105 co-operative approach.\r
 106 \r
 107 1.6.\r
 108 portYIELD() macro now uses INT #122 instead of INT9.\r
 109 \r
 110 Optimized functions vParTestToggleLED() and vParTestSetLED() in main.c.\r
 111 \r
 112 Now watchdog uses 2^23 as clock prescaler instead of 2^24. Also updated the WTC_CLR_PER in watchdog.h.\r
 113 \r
 114 1.7.\r
 115 Modified the code to work with  SK-16FX-100PMC V1.1.\r
 116 \r
 117 Made changes to the demo application files crflash.c. Please refer the file and grep for "Added by MPi" \r
 118 to find the changes.\r
 119 \r
 120 Made changes to taskutility.c and vectors.c in order to use UART1 instead of UART2.\r
 121  \r
 122 Made changes to main.c file in order to handle use the 7-segment display (SEG1) connected to Port09 for tasks\r
 123 and 7-segment display (SEG2) connected to Port00 for co-routines.\r
 124 \r
 125 Added config.h and moved the demo application configs there.\r
 126 \r
 127 1.8.\r
 128 It should be noted that the readme, appnote and SVN tag version numbers may be different for the same release.\r
 129 \r
 130 This readme is specific to project FreeRTOS_96348hs_SK16FX100PMC. And this project specifically works\r
 131 on board SK-16FX-100PMC V1.1 along with EUROScope debugger.\r
 132 \r
 133 Created 4 different configuration Config_1 to Config_4. Each config includes certain demo application function.\r
 134 More details specific to each configuration can be found in the appnote.\r
 135 \r
 136 Used relative path to include files instead of absolute.\r
 137 \r
 138 Created config, MemMang, serial and utility subdirectories and moved corresponding functionlaity there.\r
 139 \r
 140 Updated config.h, main.c and start.asm in order to have configuration specific build.\r
 141 \r
 142 Clock settings:\r
 143 ---------------\r
 144 Crystal:  4 MHz\r
 145 CLKB:    56 MHz\r
 146 CLKP1:   56 MHz\r
 147 CLKP2:   56 MHz\r