git.sur5r.net Git - freertos/blob - Demo/CORTEX_STM32F103_Primer_GCC/main.c

   1 /*\r
   2         FreeRTOS V5.4.1 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 /*\r
  49  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
  50  * documentation provides more details of the standard demo application tasks.\r
  51  * In addition to the standard demo tasks, the following tasks and tests are\r
  52  * defined and/or created within this file:\r
  53  *\r
  54  * "Fast Interrupt Test" - A high frequency periodic interrupt is generated\r
  55  * using a free running timer to demonstrate the use of the\r
  56  * configKERNEL_INTERRUPT_PRIORITY configuration constant.  The interrupt\r
  57  * service routine measures the number of processor clocks that occur between\r
  58  * each interrupt - and in so doing measures the jitter in the interrupt timing.\r
  59  * The maximum measured jitter time is latched in the ulMaxJitter variable, and\r
  60  * displayed on the LCD by the 'Check' task as described below.  The\r
  61  * fast interrupt is configured and handled in the timertest.c source file.\r
  62  *\r
  63  * "LCD" task - the LCD task is a 'gatekeeper' task.  It is the only task that\r
  64  * is permitted to access the display directly.  Other tasks wishing to write a\r
  65  * message to the LCD send the message on a queue to the LCD task instead of\r
  66  * accessing the LCD themselves.  The LCD task just blocks on the queue waiting\r
  67  * for messages - waking and displaying the messages as they arrive.  Messages\r
  68  * can either be a text string to display, or an instruction to update MEMS\r
  69  * input.  The MEMS input is used to display a ball that can be moved around\r
  70  * LCD by tilting the STM32 Primer.  45% is taken as the neutral position.\r
  71  *\r
  72  * "Check" task -  This only executes every five seconds but has the highest\r
  73  * priority so is guaranteed to get processor time.  Its main function is to\r
  74  * check that all the standard demo tasks are still operational.  Should any\r
  75  * unexpected behaviour within a demo task be discovered the 'check' task will\r
  76  * write an error to the LCD (via the LCD task).  If all the demo tasks are\r
  77  * executing with their expected behaviour then the check task writes PASS\r
  78  * along with the max jitter time to the LCD (again via the LCD task), as\r
  79  * described above.\r
  80  *\r
  81  * Tick Hook - A tick hook is provided just for demonstration purposes.  In \r
  82  * this case it is used to periodically send an instruction to updated the\r
  83  * MEMS input to the LCD task.\r
  84  *\r
  85  */\r
  86 \r
  87 /* CircleOS includes.  Some of the CircleOS peripheral functionality is \r
  88 utilised, although CircleOS itself is not used. */\r
  89 #include "circle.h"\r
  90 \r
  91 /* Standard includes. */\r
  92 #include <string.h>\r
  93 \r
  94 /* Scheduler includes. */\r
  95 #include "FreeRTOS.h"\r
  96 #include "task.h"\r
  97 #include "queue.h"\r
  98 \r
  99 /* Demo app includes. */\r
 100 #include "BlockQ.h"\r
 101 #include "blocktim.h"\r
 102 #include "GenQTest.h"\r
 103 #include "partest.h"\r
 104 #include "QPeek.h"\r
 105 \r
 106 /* The bitmap used to display the FreeRTOS.org logo is stored in 16bit format\r
 107 and therefore takes up a large proportion of the Flash space.  Setting this\r
 108 parameter to 0 excludes the bitmap from the build, freeing up Flash space for\r
 109 extra code. */\r
 110 #define mainINCLUDE_BITMAP                                      0\r
 111 \r
 112 #if mainINCLUDE_BITMAP == 1\r
 113         #include "bitmap.h"\r
 114 #endif\r
 115 \r
 116 /* Task priorities. */\r
 117 #define mainQUEUE_POLL_PRIORITY                         ( tskIDLE_PRIORITY + 2 )\r
 118 #define mainCHECK_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 3 )\r
 119 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )\r
 120 #define mainGEN_Q_PRIORITY                                      ( tskIDLE_PRIORITY + 0 )\r
 121 #define mainFLASH_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 2 )\r
 122 \r
 123 /* Splash screen related constants. */\r
 124 #define mainBITMAP_Y                                            ( 38 )\r
 125 #define mainBITMAP_X                                            ( 18 )\r
 126 #define mainURL_Y                                                       ( 8 )\r
 127 #define mainURL_X                                                       ( 78 )\r
 128 #define mainSPLASH_SCREEN_DELAY         ( 2000 / portTICK_RATE_MS )\r
 129 \r
 130 /* Text drawing related constants. */\r
 131 #define mainLCD_CHAR_HEIGHT                     ( 13 )\r
 132 #define mainLCD_MAX_Y                           ( 110 )\r
 133 \r
 134 /* The maximum number of message that can be waiting for display at any one\r
 135 time. */\r
 136 #define mainLCD_QUEUE_SIZE                                      ( 3 )\r
 137 \r
 138 /* The check task uses the sprintf function so requires a little more stack. */\r
 139 #define mainCHECK_TASK_STACK_SIZE                       ( configMINIMAL_STACK_SIZE + 50 )\r
 140 \r
 141 /* The LCD task calls some of the CircleOS functions (for MEMS and LCD access),\r
 142 these can require a larger stack. */\r
 143 #define configLCD_TASK_STACK_SIZE                       ( configMINIMAL_STACK_SIZE + 50 )\r
 144 \r
 145 /* Dimensions the buffer into which the jitter time is written. */\r
 146 #define mainMAX_MSG_LEN                                         25\r
 147 \r
 148 /* The time between cycles of the 'check' task. */\r
 149 #define mainCHECK_DELAY                                         ( ( portTickType ) 5000 / portTICK_RATE_MS )\r
 150 \r
 151 /* The period at which the MEMS input should be updated. */\r
 152 #define mainMEMS_DELAY                                          ( ( portTickType ) 100 / portTICK_RATE_MS )\r
 153 \r
 154 /* The rate at which the flash task toggles the LED. */\r
 155 #define mainFLASH_DELAY                                         ( ( portTickType ) 1000 / portTICK_RATE_MS )\r
 156 \r
 157 /* The number of nano seconds between each processor clock. */\r
 158 #define mainNS_PER_CLOCK ( ( unsigned portLONG ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )\r
 159 \r
 160 /* The two types of message that can be sent to the LCD task. */\r
 161 #define mainUPDATE_BALL_MESSAGE                         ( 0 )\r
 162 #define mainWRITE_STRING_MESSAGE                        ( 1 )\r
 163 \r
 164 /* Type of the message sent to the LCD task. */\r
 165 typedef struct\r
 166 {\r
 167         portBASE_TYPE xMessageType;\r
 168         signed char *pcMessage;\r
 169 } xLCDMessage;\r
 170 \r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 /*\r
 174  * Configure the clocks, GPIO and other peripherals as required by the demo.\r
 175  */\r
 176 static void prvSetupHardware( void );\r
 177 \r
 178 /*\r
 179  * The LCD is written two by more than one task so is controlled by a\r
 180  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
 181  * access the LCD directly.  Other tasks wanting to display a message send\r
 182  * the message to the gatekeeper.\r
 183  */\r
 184 static void prvLCDTask( void *pvParameters );\r
 185 \r
 186 /*\r
 187  * Checks the status of all the demo tasks then prints a message to the\r
 188  * display.  The message will be either PASS - and include in brackets the\r
 189  * maximum measured jitter time (as described at the to of the file), or a\r
 190  * message that describes which of the standard demo tasks an error has been\r
 191  * discovered in.\r
 192  *\r
 193  * Messages are not written directly to the terminal, but passed to prvLCDTask\r
 194  * via a queue.\r
 195  *\r
 196  * The check task also receives instructions to update the MEMS input, which\r
 197  * in turn can also lead to the LCD being updated.\r
 198  */\r
 199 static void prvCheckTask( void *pvParameters );\r
 200 \r
 201 /*\r
 202  * Configures the timers and interrupts for the fast interrupt test as\r
 203  * described at the top of this file.\r
 204  */\r
 205 extern void vSetupTimerTest( void );\r
 206 \r
 207 /*\r
 208  * A cut down version of sprintf() used to percent the HUGE GCC library\r
 209  * equivalent from being included in the binary image. \r
 210  */\r
 211 extern int sprintf(char *out, const char *format, ...);\r
 212 \r
 213 /*\r
 214  * Simple toggle the LED periodically for timing verification.\r
 215  */\r
 216 static void prvFlashTask( void *pvParameters );\r
 217 \r
 218 /*-----------------------------------------------------------*/\r
 219 \r
 220 /* The queue used to send messages to the LCD task. */\r
 221 xQueueHandle xLCDQueue;\r
 222 \r
 223 /*-----------------------------------------------------------*/\r
 224 \r
 225 int main( void )\r
 226 {\r
 227         #ifdef DEBUG\r
 228                 debug();\r
 229         #endif\r
 230 \r
 231         prvSetupHardware();\r
 232 \r
 233         /* Create the queue used by the LCD task.  Messages for display on the LCD\r
 234         are received via this queue. */\r
 235         xLCDQueue = xQueueCreate( mainLCD_QUEUE_SIZE, sizeof( xLCDMessage ) );\r
 236         \r
 237         /* Start the standard demo tasks. */\r
 238         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 239     vCreateBlockTimeTasks();\r
 240         vStartGenericQueueTasks( mainGEN_Q_PRIORITY );\r
 241         vStartQueuePeekTasks();\r
 242         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 243 \r
 244         /* Start the tasks defined within this file/specific to this demo. */\r
 245     xTaskCreate( prvCheckTask, ( signed portCHAR * ) "Check", mainCHECK_TASK_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL ); \r
 246         xTaskCreate( prvLCDTask, ( signed portCHAR * ) "LCD", configLCD_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 247         xTaskCreate( prvFlashTask, ( signed portCHAR * ) "Flash", configMINIMAL_STACK_SIZE, NULL, mainFLASH_TASK_PRIORITY, NULL );\r
 248 \r
 249         /* Configure the timers used by the fast interrupt timer test. */\r
 250         vSetupTimerTest();\r
 251         \r
 252         /* Start the scheduler. */\r
 253         vTaskStartScheduler();\r
 254         \r
 255         /* Will only get here if there was not enough heap space to create the\r
 256         idle task. */\r
 257         return 0;\r
 258 }\r
 259 /*-----------------------------------------------------------*/\r
 260 \r
 261 void prvLCDTask( void *pvParameters )\r
 262 {\r
 263 xLCDMessage xMessage;\r
 264 portCHAR cY = mainLCD_CHAR_HEIGHT;\r
 265 const portCHAR * const pcString = "www.FreeRTOS.org";\r
 266 const portCHAR * const pcBlankLine = "                  ";\r
 267 \r
 268         DRAW_Init();\r
 269 \r
 270         #if mainINCLUDE_BITMAP == 1\r
 271                 DRAW_SetImage( pucImage, mainBITMAP_Y, mainBITMAP_X, bmpBITMAP_HEIGHT, bmpBITMAP_WIDTH );\r
 272         #endif\r
 273 \r
 274         LCD_SetScreenOrientation( V9 );\r
 275         DRAW_DisplayString( mainURL_Y, mainURL_X, pcString, strlen( pcString ) );\r
 276         vTaskDelay( mainSPLASH_SCREEN_DELAY );\r
 277         LCD_FillRect( 0, 0, CHIP_SCREEN_WIDTH, CHIP_SCREEN_HEIGHT, RGB_WHITE );\r
 278 \r
 279         for( ;; )\r
 280         {\r
 281                 /* Wait for a message to arrive that requires displaying. */\r
 282                 while( xQueueReceive( xLCDQueue, &xMessage, portMAX_DELAY ) != pdPASS );\r
 283 \r
 284                 /* Check the message type. */\r
 285                 if( xMessage.xMessageType == mainUPDATE_BALL_MESSAGE )\r
 286                 {\r
 287                         /* Read the MEMS and update the ball display on the LCD if required. */\r
 288                         MEMS_Handler();\r
 289                         POINTER_Handler();\r
 290                 }\r
 291                 else\r
 292                 {\r
 293                         /* A text string was sent.  First blank off the old text string, then\r
 294                         draw the new text on the next line down. */\r
 295                         DRAW_DisplayString( 0, cY, pcBlankLine, strlen( pcBlankLine ) );\r
 296 \r
 297                         cY -= mainLCD_CHAR_HEIGHT;\r
 298                         if( cY <= ( mainLCD_CHAR_HEIGHT - 1 ) )\r
 299                         {                       \r
 300                                 /* Wrap the line onto which we are going to write the text. */\r
 301                                 cY = mainLCD_MAX_Y;\r
 302                         }\r
 303                         \r
 304                         /* Display the message. */\r
 305                         DRAW_DisplayString( 0, cY, xMessage.pcMessage, strlen( xMessage.pcMessage ) );\r
 306                 }\r
 307         }\r
 308 }\r
 309 /*-----------------------------------------------------------*/\r
 310 \r
 311 static void prvCheckTask( void *pvParameters )\r
 312 {\r
 313 portTickType xLastExecutionTime;\r
 314 xLCDMessage xMessage;\r
 315 static signed portCHAR cPassMessage[ mainMAX_MSG_LEN ];\r
 316 extern unsigned portSHORT usMaxJitter;\r
 317 \r
 318         /* Initialise the xLastExecutionTime variable on task entry. */\r
 319         xLastExecutionTime = xTaskGetTickCount();\r
 320 \r
 321         /* Setup the message we are going to send to the LCD task. */\r
 322         xMessage.xMessageType = mainWRITE_STRING_MESSAGE;\r
 323         xMessage.pcMessage = cPassMessage;\r
 324         \r
 325     for( ;; )\r
 326         {\r
 327                 /* Perform this check every mainCHECK_DELAY milliseconds. */\r
 328                 vTaskDelayUntil( &xLastExecutionTime, mainCHECK_DELAY );\r
 329 \r
 330                 /* Has an error been found in any task?   If so then point the text\r
 331                 we are going to send to the LCD task to an error message instead of\r
 332                 the PASS message. */\r
 333                 if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 334                 {\r
 335                         xMessage.pcMessage = "ERROR IN GEN Q";\r
 336                 }\r
 337         if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 338                 {\r
 339                         xMessage.pcMessage = "ERROR IN BLOCK Q";\r
 340                 }\r
 341                 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 342                 {\r
 343                         xMessage.pcMessage = "ERROR IN BLOCK TIME";\r
 344                 }\r
 345         else if( xArePollingQueuesStillRunning() != pdTRUE )\r
 346         {\r
 347             xMessage.pcMessage = "ERROR IN POLL Q";\r
 348         }\r
 349                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 350                 {\r
 351                         xMessage.pcMessage = "ERROR IN PEEK Q";\r
 352                 }\r
 353                 else\r
 354                 {\r
 355                         /* No errors were found in any task, so send a pass message\r
 356                         with the max measured jitter time also included (as per the\r
 357                         fast interrupt test described at the top of this file and on\r
 358                         the online documentation page for this demo application). */\r
 359                         sprintf( ( portCHAR * ) cPassMessage, "PASS [%uns]", ( ( unsigned portLONG ) usMaxJitter ) * mainNS_PER_CLOCK );\r
 360                 }\r
 361 \r
 362                 /* Send the message to the LCD gatekeeper for display. */\r
 363                 xQueueSend( xLCDQueue, &xMessage, portMAX_DELAY );\r
 364         }\r
 365 }\r
 366 /*-----------------------------------------------------------*/\r
 367 \r
 368 void vApplicationTickHook( void )\r
 369 {\r
 370 static unsigned portLONG ulCallCount;\r
 371 static const xLCDMessage xMemsMessage = { mainUPDATE_BALL_MESSAGE, NULL };\r
 372 static portBASE_TYPE xHigherPriorityTaskWoken;\r
 373 \r
 374         /* Periodically send a message to the LCD task telling it to update\r
 375         the MEMS input, and then if necessary the LCD. */\r
 376         ulCallCount++;\r
 377         if( ulCallCount >= mainMEMS_DELAY )\r
 378         {\r
 379                 ulCallCount = 0;\r
 380                 xHigherPriorityTaskWoken = pdFALSE;\r
 381                 xQueueSendFromISR( xLCDQueue, &xMemsMessage, &xHigherPriorityTaskWoken );\r
 382         }\r
 383 }\r
 384 /*-----------------------------------------------------------*/\r
 385 \r
 386 static void prvSetupHardware( void )\r
 387 {\r
 388         /* Start with the clocks in their expected state. */\r
 389         RCC_DeInit();\r
 390 \r
 391         /* Enable HSE (high speed external clock). */\r
 392         RCC_HSEConfig( RCC_HSE_ON );\r
 393 \r
 394         /* Wait till HSE is ready. */\r
 395         while( RCC_GetFlagStatus( RCC_FLAG_HSERDY ) == RESET )\r
 396         {\r
 397         }\r
 398 \r
 399         /* 2 wait states required on the flash. */\r
 400         *( ( unsigned portLONG * ) 0x40022000 ) = 0x02;\r
 401 \r
 402         /* HCLK = SYSCLK */\r
 403         RCC_HCLKConfig( RCC_SYSCLK_Div1 );\r
 404 \r
 405         /* PCLK2 = HCLK */\r
 406         RCC_PCLK2Config( RCC_HCLK_Div1 );\r
 407 \r
 408         /* PCLK1 = HCLK/2 */\r
 409         RCC_PCLK1Config( RCC_HCLK_Div2 );\r
 410 \r
 411         /* PLLCLK = 12MHz * 6 = 72 MHz. */\r
 412         RCC_PLLConfig( RCC_PLLSource_HSE_Div1, RCC_PLLMul_6 );\r
 413 \r
 414         /* Enable PLL. */\r
 415         RCC_PLLCmd( ENABLE );\r
 416 \r
 417         /* Wait till PLL is ready. */\r
 418         while(RCC_GetFlagStatus(RCC_FLAG_PLLRDY) == RESET)\r
 419         {\r
 420         }\r
 421 \r
 422         /* Select PLL as system clock source. */\r
 423         RCC_SYSCLKConfig( RCC_SYSCLKSource_PLLCLK );\r
 424 \r
 425         /* Wait till PLL is used as system clock source. */\r
 426         while( RCC_GetSYSCLKSource() != 0x08 )\r
 427         {\r
 428         }\r
 429 \r
 430         /* Enable GPIOA, GPIOB, GPIOC, GPIOD, GPIOE and AFIO clocks */\r
 431         RCC_APB2PeriphClockCmd( RCC_APB2Periph_GPIOA | RCC_APB2Periph_GPIOB |RCC_APB2Periph_GPIOC\r
 432                                                         | RCC_APB2Periph_GPIOD | RCC_APB2Periph_GPIOE | RCC_APB2Periph_AFIO, ENABLE );\r
 433 \r
 434         /* SPI2 Periph clock enable */\r
 435         RCC_APB1PeriphClockCmd( RCC_APB1Periph_SPI2, ENABLE );\r
 436 \r
 437 \r
 438         /* Set the Vector Table base address at 0x08000000 */\r
 439         NVIC_SetVectorTable( NVIC_VectTab_FLASH, 0x0 );\r
 440 \r
 441         NVIC_PriorityGroupConfig( NVIC_PriorityGroup_4 );\r
 442         \r
 443         /* Configure HCLK clock as SysTick clock source. */\r
 444         SysTick_CLKSourceConfig( SysTick_CLKSource_HCLK );\r
 445         \r
 446         /* Misc initialisation, including some of the CircleOS features.  Note\r
 447         that CircleOS itself is not used. */\r
 448         vParTestInitialise();\r
 449         MEMS_Init();\r
 450         POINTER_Init();\r
 451         POINTER_SetMode( POINTER_RESTORE_LESS );\r
 452 }\r
 453 /*-----------------------------------------------------------*/\r
 454 \r
 455 static void prvFlashTask( void *pvParameters )\r
 456 {\r
 457 portTickType xLastExecutionTime;\r
 458 \r
 459         /* Initialise the xLastExecutionTime variable on task entry. */\r
 460         xLastExecutionTime = xTaskGetTickCount();\r
 461 \r
 462     for( ;; )\r
 463         {\r
 464                 /* Simple toggle the LED periodically.  This just provides some timing\r
 465                 verification. */\r
 466                 vTaskDelayUntil( &xLastExecutionTime, mainFLASH_DELAY );\r
 467                 vParTestToggleLED( 0 );\r
 468         }\r
 469 }\r
 470 /*-----------------------------------------------------------*/\r
 471 \r
 472 void starting_delay( unsigned long ul )\r
 473 {\r
 474         vTaskDelay( ( portTickType ) ul );\r
 475 }\r
 476 \r
 477 \r
 478 \r