]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MB91460_Softune/readme.txt
Update version numbers ready for release.
[freertos] / FreeRTOS / Demo / MB91460_Softune / readme.txt
1 \r
2 ==========================================================================\r
3                    Template Project for MB91F467D \r
4 ==========================================================================\r
5                    Fujitsu Microelectronics Europe GmbH                       \r
6                  http://emea.fujitsu.com/microelectronics \r
7                                                             \r
8 The  following  software  is for  demonstration  purposes only.  It is not\r
9 fully  tested, nor validated  in  order  to fullfill  its task  under  all\r
10 circumstances.  Therefore,  this software  or  any part of it must only be\r
11 used in an evaluation laboratory environment.                        \r
12 This software is subject to  the rules of our standard DISCLAIMER, that is\r
13 delivered  with  our  SW-tools  on  the  Fujitsu  Microcontrollers CD /DVD\r
14 (V3.4 or higher "\START.HTM").\r
15 ==========================================================================\r
16                \r
17 History\r
18 Date        Ver     Author  Softune     Description\r
19 2007-11-12  1.0     MPi     V60L06              original version\r
20 2007-11-12  1.1     MPi     V60L06              Changed the version for consistency\r
21                                                                                 with SVN\r
22 2007-11-23  1.2     MPi     V60L06              Seperated Watchdog functionality\r
23                                                                                 added watchdog.c and watchdog.h\r
24 2007-12-13  1.3     MPi     V60L06              Tested with the FreeRTOS version 4.6.1.\r
25 2007-12-13  1.4     MPi     V60L06              Tested with the FreeRTOS version 4.7.0.\r
26 2007-01-07  1.5     MPi     V60L06              Removed watchdog.c, watchdog.h, port.c \r
27                                                                                 and portmacro.h from directory\r
28                                                                                 \FreeRTOS_Port_FR\91467d_FreeRTOS\SRC\r
29 2007-01-18  1.6     MPi     V60L06              Tested with monitor debugger\r
30 ==========================================================================\r
31 1.0.\r
32 This is a project is to test the FreeRTOS port for FR (91467D) and the demo \r
33 application which runs on SK-91F467-Felxray V1.1.\r
34 \r
35 1.1.\r
36 This FreeRTOS port uses the Task Stack pointed by User Stack pointer (USP) for\r
37 tasks and the system stack pointed by System Stack pointer (SSP) for everything\r
38 else. \r
39 \r
40 1.2.\r
41 In this port, the functionality is added to initialize and clear the watchdog in \r
42 the dedicated task, Tick Hook or the Idle Hook. The place exactly where the \r
43 watchdog can be cleared can be configured. Though Idle Hook is not an approproiate\r
44 place to clear the watchdog, its done here for demonstration purpose only.\r
45 \r
46 Also from Main function vTaskStartScheduler() function is called instead of \r
47 xPortStartScheduler(). After doing this change now no more IDLE task is required\r
48 to be added seperately as vTaskStartScheduler() adds prvIdleTask() on its own.\r
49 \r
50 The System Stack required by each of the RLT0 and Delayed Interrupt ISR is around 100 \r
51 bytes. This is considering no interrupts has higher priority than the RLT0 and Delayed \r
52 interrupt (23). If an application has interrupt whose priority is higher than these \r
53 interrupts, which is very likely, then for each such interrupt the user has to increase \r
54 the stack size at least by 50 bytes, though this is not an optimum figure and very well \r
55 depends upon the application.\r
56 Hence though the STACK_SYS_SIZE is defined as 2000, its optimum value would be very well\r
57 dependent on the application where the port would be used.\r
58 \r
59 1.3.\r
60 Tested with the FreeRTOS version 4.6.1.\r
61 \r
62 Changed portBYTE_ALIGNMENT to 4 from 1.\r
63 \r
64 Added portYIELDFromISR() which uses delayed interrupt. This macro needs to be used from the\r
65 application ISRs in order to force a context switch from them if required. It should be noted\r
66 that the interrupt priority of such application ISRs MUST be always higher than the dealyed \r
67 interrupt (currently 23) in order to perform the context switch correctly.\r
68 \r
69 It should be also noted that the RLT0 and Delayed Interrupt priority MUST be always same in order \r
70 to assure correct working of this port.\r
71 \r
72 Now portYIELD() used software interrupt INT #40H instead of delayed interrupt.\r
73 \r
74 Now all the queue functions works ok.\r
75 \r
76 Tested with the heap_1.c, heap_2.c and heap_3.c.\r
77 \r
78 Added the __STD_LIB_sbrk.c file in order to define the *sbrk() function. This is required while using\r
79 heap_3.c file which uses the dynamic memory allocation.\r
80 \r
81 Made changes to the demo application files crflash.c and crhook.c. Please refer those file\r
82 and grep for "Added by MPi" to find the changes.\r
83 \r
84 Added taskutility.c file. This file contains vUART4Task() which calls vTaskList() and vTaskStartTrace()\r
85 functions.\r
86 \r
87 If vCreateBlockTimeTasks() is not called then the LED at PDR25_D7 blinks at normal rate (3s).\r
88 \r
89 1.4.\r
90 Tested with the FreeRTOS version 4.6.1.\r
91 \r
92 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
93 required to be used should be removed from the target of the build.\r
94 \r
95 1.5.\r
96 Removed watchdog.c, watchdog.h, port.c and portmacro.h from directory \FreeRTOS_Port_FR\91467d_FreeRTOS\SRC, \r
97 since they are moved to folders watchdog and port respectively.\r
98 \r
99 1.6.\r
100 It should be noted that the readme, appnote and SVN tag version numbers may be different for the same release.\r
101 \r
102 Used relative path to include files instead of absolute.\r
103 \r
104 Created config, MemMang, serial and utility subdirectories and moved corresponding functionlaity there.\r
105 \r
106 Updated taskuitlity.c, vectors.c in oredr to use UART 5 instead of UART 4\r
107 \r
108 Updated flash.c to increase LEDs to 4 from 3.\r
109 \r
110 Clock settings:\r
111 ---------------\r
112 Crystal:  4 MHz\r
113 CPU:     64 MHz\r
114 CLKP:    16 MHz\r