]> git.sur5r.net Git - freertos/blob - Demo/CORTEX_LM3Sxxxx_IAR_Keil/main.c
Small mods, and update file headers.
[freertos] / Demo / CORTEX_LM3Sxxxx_IAR_Keil / main.c
1 /*\r
2         FreeRTOS.org V4.8.0 - Copyright (C) 2003-2008 Richard Barry.\r
3 \r
4         This file is part of the FreeRTOS.org distribution.\r
5 \r
6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
7         it under the terms of the GNU General Public License as published by\r
8         the Free Software Foundation; either version 2 of the License, or\r
9         (at your option) any later version.\r
10 \r
11         FreeRTOS.org is distributed in the hope that it will be useful,\r
12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14         GNU General Public License for more details.\r
15 \r
16         You should have received a copy of the GNU General Public License\r
17         along with FreeRTOS.org; if not, write to the Free Software\r
18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
19 \r
20         A special exception to the GPL can be applied should you wish to distribute\r
21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
22         the source code for any proprietary components.  See the licensing section\r
23         of http://www.FreeRTOS.org for full details of how and when the exception\r
24         can be applied.\r
25 \r
26     ***************************************************************************\r
27     ***************************************************************************\r
28     *                                                                         *\r
29     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *\r
30     * and even write all or part of your application on your behalf.          *\r
31     * See http://www.OpenRTOS.com for details of the services we provide to   *\r
32     * expedite your project.                                                  *\r
33     *                                                                         *\r
34     ***************************************************************************\r
35     ***************************************************************************\r
36 \r
37         Please ensure to read the configuration and relevant port sections of the\r
38         online documentation.\r
39 \r
40         http://www.FreeRTOS.org - Documentation, latest information, license and \r
41         contact details.\r
42 \r
43         http://www.SafeRTOS.com - A version that is certified for use in safety \r
44         critical systems.\r
45 \r
46         http://www.OpenRTOS.com - Commercial support, development, porting, \r
47         licensing and training services.\r
48 */\r
49 \r
50 \r
51 /*\r
52  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
53  * documentation provides more details of the standard demo application tasks.\r
54  * In addition to the standard demo tasks, the following tasks and tests are\r
55  * defined and/or created within this file:\r
56  *\r
57  * "Fast Interrupt Test" - A high frequency periodic interrupt is generated\r
58  * using a free running timer to demonstrate the use of the\r
59  * configKERNEL_INTERRUPT_PRIORITY configuration constant.  The interrupt\r
60  * service routine measures the number of processor clocks that occur between\r
61  * each interrupt - and in so doing measures the jitter in the interrupt timing.\r
62  * The maximum measured jitter time is latched in the ulMaxJitter variable, and\r
63  * displayed on the OLED display by the 'OLED' task as described below.  The\r
64  * fast interrupt is configured and handled in the timertest.c source file.\r
65  *\r
66  * "OLED" task - the OLED task is a 'gatekeeper' task.  It is the only task that\r
67  * is permitted to access the display directly.  Other tasks wishing to write a\r
68  * message to the OLED send the message on a queue to the OLED task instead of\r
69  * accessing the OLED themselves.  The OLED task just blocks on the queue waiting\r
70  * for messages - waking and displaying the messages as they arrive.\r
71  *\r
72  * "Check" hook -  This only executes every five seconds from the tick hook.\r
73  * Its main function is to check that all the standard demo tasks are still\r
74  * operational.  Should any unexpected behaviour within a demo task be discovered\r
75  * the tick hook will write an error to the OLED (via the OLED task).  If all the\r
76  * demo tasks are executing with their expected behaviour then the check task\r
77  * writes PASS to the OLED (again via the OLED task), as described above.\r
78  *\r
79  * "uIP" task -  This is the task that handles the uIP stack.  All TCP/IP\r
80  * processing is performed in this task.\r
81  */\r
82 \r
83 \r
84 \r
85 /* Standard includes. */\r
86 #include <stdio.h>\r
87 \r
88 /* Scheduler includes. */\r
89 #include "FreeRTOS.h"\r
90 #include "task.h"\r
91 #include "queue.h"\r
92 #include "semphr.h"\r
93 \r
94 /* Demo app includes. */\r
95 #include "BlockQ.h"\r
96 #include "death.h"\r
97 #include "integer.h"\r
98 #include "blocktim.h"\r
99 #include "flash.h"\r
100 #include "partest.h"\r
101 #include "semtest.h"\r
102 #include "PollQ.h"\r
103 #include "lcd_message.h"\r
104 #include "bitmap.h"\r
105 #include "GenQTest.h"\r
106 #include "QPeek.h"\r
107 \r
108 /* Hardware library includes. */\r
109 #include "hw_memmap.h"\r
110 #include "hw_types.h"\r
111 #include "hw_sysctl.h"\r
112 #include "sysctl.h"\r
113 #include "gpio.h"\r
114 #include "rit128x96x4.h"\r
115 #include "osram128x64x4.h"\r
116 \r
117 /*-----------------------------------------------------------*/\r
118 \r
119 /* The time between cycles of the 'check' functionality (defined within the\r
120 tick hook. */\r
121 #define mainCHECK_DELAY                                         ( ( portTickType ) 5000 / portTICK_RATE_MS )\r
122 \r
123 /* Size of the stack allocated to the uIP task. */\r
124 #define mainBASIC_WEB_STACK_SIZE            ( configMINIMAL_STACK_SIZE * 3 )\r
125 \r
126 /* The OLED task uses the sprintf function so requires a little more stack too. */\r
127 #define mainOLED_TASK_STACK_SIZE                        ( configMINIMAL_STACK_SIZE + 50 )\r
128 \r
129 /* Task priorities. */\r
130 #define mainQUEUE_POLL_PRIORITY                         ( tskIDLE_PRIORITY + 2 )\r
131 #define mainCHECK_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 3 )\r
132 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1 )\r
133 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )\r
134 #define mainCREATOR_TASK_PRIORITY           ( tskIDLE_PRIORITY + 3 )\r
135 #define mainINTEGER_TASK_PRIORITY           ( tskIDLE_PRIORITY )\r
136 #define mainGEN_QUEUE_TASK_PRIORITY                     ( tskIDLE_PRIORITY )\r
137 \r
138 /* The maximum number of message that can be waiting for display at any one\r
139 time. */\r
140 #define mainOLED_QUEUE_SIZE                                     ( 3 )\r
141 \r
142 /* Dimensions the buffer into which the jitter time is written. */\r
143 #define mainMAX_MSG_LEN                                         25\r
144 \r
145 /* The period of the system clock in nano seconds.  This is used to calculate\r
146 the jitter time in nano seconds. */\r
147 #define mainNS_PER_CLOCK                                        ( ( unsigned portLONG ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )\r
148 \r
149 /* Constants used when writing strings to the display. */\r
150 #define mainCHARACTER_HEIGHT                            ( 9 )\r
151 #define mainMAX_ROWS_96                                         ( mainCHARACTER_HEIGHT * 10 )\r
152 #define mainMAX_ROWS_64                                         ( mainCHARACTER_HEIGHT * 7 )\r
153 #define mainFULL_SCALE                                          ( 15 )\r
154 #define ulSSI_FREQUENCY                                         ( 3500000UL )\r
155 \r
156 /*-----------------------------------------------------------*/\r
157 \r
158 /*\r
159  * The task that handles the uIP stack.  All TCP/IP processing is performed in\r
160  * this task.\r
161  */\r
162 extern void vuIP_Task( void *pvParameters );\r
163 \r
164 /*\r
165  * The display is written two by more than one task so is controlled by a\r
166  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
167  * access the display directly.  Other tasks wanting to display a message send\r
168  * the message to the gatekeeper.\r
169  */\r
170 static void vOLEDTask( void *pvParameters );\r
171 \r
172 /*\r
173  * Configure the hardware for the demo.\r
174  */\r
175 static void prvSetupHardware( void );\r
176 \r
177 /*\r
178  * Configures the high frequency timers - those used to measure the timing\r
179  * jitter while the real time kernel is executing.\r
180  */\r
181 extern void vSetupTimer( void );\r
182 \r
183 /*-----------------------------------------------------------*/\r
184 \r
185 /* The queue used to send messages to the OLED task. */\r
186 xQueueHandle xOLEDQueue;\r
187 \r
188 /* The welcome text. */\r
189 const portCHAR * const pcWelcomeMessage = "   www.FreeRTOS.org";\r
190 \r
191 /*-----------------------------------------------------------*/\r
192 \r
193 int main( void )\r
194 {\r
195         prvSetupHardware();\r
196 \r
197         /* Create the queue used by the OLED task.  Messages for display on the OLED\r
198         are received via this queue. */\r
199         xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );\r
200 \r
201         /* Create the uIP task if running on a processor that includes a MAC and\r
202         PHY. */\r
203         if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )\r
204         {\r
205                 xTaskCreate( vuIP_Task, ( signed portCHAR * ) "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );\r
206         }\r
207 \r
208         /* Start the standard demo tasks. */\r
209         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
210     vCreateBlockTimeTasks();\r
211     vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
212     vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
213     vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );\r
214     vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
215     vStartQueuePeekTasks();\r
216 \r
217         /* Start the tasks defined within this file/specific to this demo. */\r
218         xTaskCreate( vOLEDTask, ( signed portCHAR * ) "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
219 \r
220         /* The suicide tasks must be created last as they need to know how many\r
221         tasks were running prior to their creation in order to ascertain whether\r
222         or not the correct/expected number of tasks are running at any given time. */\r
223     vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
224 \r
225         /* Configure the high frequency interrupt used to measure the interrupt\r
226         jitter time.  The Keil port does not yet include the\r
227         configKERNEL_INTERRUPT_PRIORITY functionality so cannot perform this test. */\r
228         vSetupTimer();\r
229         \r
230         /* Start the scheduler. */\r
231         vTaskStartScheduler();\r
232 \r
233     /* Will only get here if there was insufficient memory to create the idle\r
234     task. */\r
235         return 0;\r
236 }\r
237 /*-----------------------------------------------------------*/\r
238 \r
239 void prvSetupHardware( void )\r
240 {\r
241     /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V.  This is\r
242     a workaround to allow the PLL to operate reliably. */\r
243     if( DEVICE_IS_REVA2 )\r
244     {\r
245         SysCtlLDOSet( SYSCTL_LDO_2_75V );\r
246     }\r
247         \r
248         /* Set the clocking to run from the PLL at 50 MHz */\r
249         SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );\r
250         \r
251         /*      Enable Port F for Ethernet LEDs\r
252                 LED0        Bit 3   Output\r
253                 LED1        Bit 2   Output */\r
254         SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );\r
255         GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );\r
256         GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );  \r
257         \r
258         vParTestInitialise();\r
259 }\r
260 /*-----------------------------------------------------------*/\r
261 \r
262 void vApplicationTickHook( void )\r
263 {\r
264 static xOLEDMessage xMessage = { "PASS" };\r
265 static unsigned portLONG ulTicksSinceLastDisplay = 0;\r
266 \r
267         /* Called from every tick interrupt.  Have enough ticks passed to make it\r
268         time to perform our health status check again? */\r
269         ulTicksSinceLastDisplay++;\r
270         if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )\r
271         {\r
272                 ulTicksSinceLastDisplay = 0;\r
273                 \r
274                 /* Has an error been found in any task? */\r
275                 if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
276                 {\r
277                         xMessage.pcMessage = "ERROR IN GEN Q";\r
278                 }\r
279                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
280                 {\r
281                         xMessage.pcMessage = "ERROR IN PEEK Q";\r
282                 }\r
283                 else if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
284                 {\r
285                         xMessage.pcMessage = "ERROR IN BLOCK Q";\r
286                 }\r
287                 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
288                 {\r
289                         xMessage.pcMessage = "ERROR IN BLOCK TIME";\r
290                 }\r
291             else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
292             {\r
293                 xMessage.pcMessage = "ERROR IN SEMAPHORE";\r
294             }\r
295             else if( xArePollingQueuesStillRunning() != pdTRUE )\r
296             {\r
297                 xMessage.pcMessage = "ERROR IN POLL Q";\r
298             }\r
299             else if( xIsCreateTaskStillRunning() != pdTRUE )\r
300             {\r
301                 xMessage.pcMessage = "ERROR IN CREATE";\r
302             }\r
303             else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
304             {\r
305                 xMessage.pcMessage = "ERROR IN MATH";\r
306             }\r
307         \r
308                 /* Send the message to the OLED gatekeeper for display. */\r
309                 xQueueSendFromISR( xOLEDQueue, &xMessage, pdFALSE );\r
310         }\r
311 }\r
312 /*-----------------------------------------------------------*/\r
313 \r
314 void vOLEDTask( void *pvParameters )\r
315 {\r
316 xOLEDMessage xMessage;\r
317 unsigned portLONG ulY, ulMaxY;\r
318 static portCHAR cMessage[ mainMAX_MSG_LEN ];\r
319 extern unsigned portLONG ulMaxJitter;\r
320 \r
321 /* Functions to access the OLED.  The one used depends on the dev kit\r
322 being used. */\r
323 void ( *vOLEDInit )( unsigned portLONG );\r
324 void ( *vOLEDStringDraw )( const portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portCHAR );\r
325 void ( *vOLEDImageDraw )( const unsigned portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portLONG, unsigned portLONG );\r
326 void ( *vOLEDClear )( void );\r
327 \r
328         /* Map the OLED access functions to the driver functions that are appropriate\r
329         for the evaluation kit being used. */   \r
330         switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )\r
331         {\r
332                 case SYSCTL_DID1_PRTNO_6965     :       \r
333                 case SYSCTL_DID1_PRTNO_2965     :       vOLEDInit = OSRAM128x64x4Init;\r
334                                                                                 vOLEDStringDraw = OSRAM128x64x4StringDraw;\r
335                                                                                 vOLEDImageDraw = OSRAM128x64x4ImageDraw;\r
336                                                                                 vOLEDClear = OSRAM128x64x4Clear;\r
337                                                                                 ulMaxY = mainMAX_ROWS_64;\r
338                                                                                 break;\r
339                                                                                 \r
340                 default                                         :       vOLEDInit = RIT128x96x4Init;\r
341                                                                                 vOLEDStringDraw = RIT128x96x4StringDraw;\r
342                                                                                 vOLEDImageDraw = RIT128x96x4ImageDraw;\r
343                                                                                 vOLEDClear = RIT128x96x4Clear;\r
344                                                                                 ulMaxY = mainMAX_ROWS_96;                                                                               \r
345                                                                                 break;\r
346         }\r
347 \r
348         ulY = ulMaxY;\r
349         \r
350         /* Initialise the OLED and display a startup message. */\r
351         vOLEDInit( ulSSI_FREQUENCY );   \r
352         vOLEDStringDraw( " POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );\r
353         vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );\r
354         \r
355         for( ;; )\r
356         {\r
357                 /* Wait for a message to arrive that requires displaying. */\r
358                 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );\r
359         \r
360                 /* Write the message on the next available row. */\r
361                 ulY += mainCHARACTER_HEIGHT;\r
362                 if( ulY >= ulMaxY )\r
363                 {\r
364                         ulY = mainCHARACTER_HEIGHT;\r
365                         vOLEDClear();\r
366                         vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );                      \r
367                 }\r
368 \r
369                 /* Display the message along with the maximum jitter time from the\r
370                 high priority time test. */\r
371                 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );\r
372                 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );\r
373         }\r
374 }\r