git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MSVC-MingW/port.c

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /* Scheduler includes. */\r
  76 #include "FreeRTOS.h"\r
  77 #include "task.h"\r
  78 #include <stdio.h>\r
  79 \r
  80 #define portMAX_INTERRUPTS                              ( ( unsigned long ) sizeof( unsigned long ) * 8UL ) /* The number of bits in an unsigned long. */\r
  81 #define portNO_CRITICAL_NESTING                 ( ( unsigned long ) 0 )\r
  82 \r
  83 /*\r
  84  * Created as a high priority thread, this function uses a timer to simulate\r
  85  * a tick interrupt being generated on an embedded target.  In this Windows\r
  86  * environment the timer does not achieve anything approaching real time \r
  87  * performance though.\r
  88  */\r
  89 static DWORD WINAPI prvSimulatedPeripheralTimer( LPVOID lpParameter );\r
  90 \r
  91 /* \r
  92  * Process all the simulated interrupts - each represented by a bit in \r
  93  * ulPendingInterrupts variable.\r
  94  */\r
  95 static void prvProcessSimulatedInterrupts( void );\r
  96 \r
  97 /*\r
  98  * Interrupt handlers used by the kernel itself.  These are executed from the\r
  99  * simulated interrupt handler thread.\r
 100  */\r
 101 static unsigned long prvProcessYieldInterrupt( void );\r
 102 static unsigned long prvProcessTickInterrupt( void );\r
 103 \r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 /* The WIN32 simulator runs each task in a thread.  The context switching is\r
 107 managed by the threads, so the task stack does not have to be managed directly,\r
 108 although the task stack is still used to hold an xThreadState structure this is\r
 109 the only thing it will ever hold.  The structure indirectly maps the task handle \r
 110 to a thread handle. */\r
 111 typedef struct\r
 112 {\r
 113         /* Handle of the thread that executes the task. */\r
 114         void *pvThread;\r
 115 \r
 116 } xThreadState;\r
 117 \r
 118 /* Simulated interrupts waiting to be processed.  This is a bit mask where each\r
 119 bit represents one interrupt, so a maximum of 32 interrupts can be simulated. */\r
 120 static volatile unsigned long ulPendingInterrupts = 0UL;\r
 121 \r
 122 /* An event used to inform the simulated interrupt processing thread (a high \r
 123 priority thread that simulated interrupt processing) that an interrupt is\r
 124 pending. */\r
 125 static void *pvInterruptEvent = NULL;\r
 126 \r
 127 /* Mutex used to protect all the simulated interrupt variables that are accessed \r
 128 by multiple threads. */\r
 129 static void *pvInterruptEventMutex = NULL;\r
 130 \r
 131 /* The critical nesting count for the currently executing task.  This is \r
 132 initialised to a non-zero value so interrupts do not become enabled during \r
 133 the initialisation phase.  As each task has its own critical nesting value \r
 134 ulCriticalNesting will get set to zero when the first task runs.  This \r
 135 initialisation is probably not critical in this simulated environment as the\r
 136 simulated interrupt handlers do not get created until the FreeRTOS scheduler is \r
 137 started anyway. */\r
 138 static unsigned long ulCriticalNesting = 9999UL;\r
 139 \r
 140 /* Handlers for all the simulated software interrupts.  The first two positions\r
 141 are used for the Yield and Tick interrupts so are handled slightly differently,\r
 142 all the other interrupts can be user defined. */\r
 143 static unsigned long (*ulIsrHandler[ portMAX_INTERRUPTS ])( void ) = { 0 };\r
 144 \r
 145 /* Pointer to the TCB of the currently executing task. */\r
 146 extern void *pxCurrentTCB;\r
 147 \r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 static DWORD WINAPI prvSimulatedPeripheralTimer( LPVOID lpParameter )\r
 151 {\r
 152 portTickType xMinimumWindowsBlockTime = ( portTickType ) 20;\r
 153 \r
 154         /* Just to prevent compiler warnings. */\r
 155         ( void ) lpParameter;\r
 156 \r
 157         for(;;)\r
 158         {\r
 159                 /* Wait until the timer expires and we can access the simulated interrupt \r
 160                 variables.  *NOTE* this is not a 'real time' way of generating tick \r
 161                 events as the next wake time should be relative to the previous wake \r
 162                 time, not the time that Sleep() is called.  It is done this way to \r
 163                 prevent overruns in this very non real time simulated/emulated \r
 164                 environment. */\r
 165                 if( portTICK_RATE_MS < xMinimumWindowsBlockTime )\r
 166                 {\r
 167                         Sleep( xMinimumWindowsBlockTime );\r
 168                 }\r
 169                 else\r
 170                 {\r
 171                         Sleep( portTICK_RATE_MS );\r
 172                 }\r
 173 \r
 174                 WaitForSingleObject( pvInterruptEventMutex, INFINITE );\r
 175 \r
 176                 /* The timer has expired, generate the simulated tick event. */\r
 177                 ulPendingInterrupts |= ( 1 << portINTERRUPT_TICK );\r
 178 \r
 179                 /* The interrupt is now pending - notify the simulated interrupt \r
 180                 handler thread. */\r
 181                 SetEvent( pvInterruptEvent );\r
 182 \r
 183                 /* Give back the mutex so the simulated interrupt handler unblocks \r
 184                 and can access the interrupt handler variables. */\r
 185                 ReleaseMutex( pvInterruptEventMutex );\r
 186         }\r
 187 \r
 188         #ifdef __GNUC__\r
 189                 /* Should never reach here - MingW complains if you leave this line out,\r
 190                 MSVC complains if you put it in. */\r
 191                 return 0;\r
 192         #endif\r
 193 }\r
 194 /*-----------------------------------------------------------*/\r
 195 \r
 196 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 197 {\r
 198 xThreadState *pxThreadState = NULL;\r
 199 char *pcTopOfStack = ( char * ) pxTopOfStack;\r
 200 \r
 201         /* In this simulated case a stack is not initialised, but instead a thread\r
 202         is created that will execute the task being created.  The thread handles\r
 203         the context switching itself.  The xThreadState object is placed onto\r
 204         the stack that was created for the task - so the stack buffer is still\r
 205         used, just not in the conventional way.  It will not be used for anything\r
 206         other than holding this structure. */\r
 207         pxThreadState = ( xThreadState * ) ( pcTopOfStack - sizeof( xThreadState ) );\r
 208 \r
 209         /* Create the thread itself. */\r
 210         pxThreadState->pvThread = CreateThread( NULL, 0, ( LPTHREAD_START_ROUTINE ) pxCode, pvParameters, CREATE_SUSPENDED, NULL );\r
 211         SetThreadAffinityMask( pxThreadState->pvThread, 0x01 );\r
 212         SetThreadPriorityBoost( pxThreadState->pvThread, TRUE );\r
 213         SetThreadPriority( pxThreadState->pvThread, THREAD_PRIORITY_IDLE );\r
 214         \r
 215         return ( portSTACK_TYPE * ) pxThreadState;\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 portBASE_TYPE xPortStartScheduler( void )\r
 220 {\r
 221 void *pvHandle;\r
 222 long lSuccess = pdPASS;\r
 223 xThreadState *pxThreadState;\r
 224 \r
 225         /* Install the interrupt handlers used by the scheduler itself. */\r
 226         vPortSetInterruptHandler( portINTERRUPT_YIELD, prvProcessYieldInterrupt );\r
 227         vPortSetInterruptHandler( portINTERRUPT_TICK, prvProcessTickInterrupt );\r
 228 \r
 229         /* Create the events and mutexes that are used to synchronise all the\r
 230         threads. */\r
 231         pvInterruptEventMutex = CreateMutex( NULL, FALSE, NULL );\r
 232         pvInterruptEvent = CreateEvent( NULL, FALSE, FALSE, NULL );\r
 233 \r
 234         if( ( pvInterruptEventMutex == NULL ) || ( pvInterruptEvent == NULL ) )\r
 235         {\r
 236                 lSuccess = pdFAIL;\r
 237         }\r
 238 \r
 239         /* Set the priority of this thread such that it is above the priority of \r
 240         the threads that run tasks.  This higher priority is required to ensure\r
 241         simulated interrupts take priority over tasks. */\r
 242         pvHandle = GetCurrentThread();\r
 243         if( pvHandle == NULL )\r
 244         {\r
 245                 lSuccess = pdFAIL;\r
 246         }\r
 247         \r
 248         if( lSuccess == pdPASS )\r
 249         {\r
 250                 if( SetThreadPriority( pvHandle, THREAD_PRIORITY_NORMAL ) == 0 )\r
 251                 {\r
 252                         lSuccess = pdFAIL;\r
 253                 }\r
 254                 SetThreadPriorityBoost( pvHandle, TRUE );\r
 255                 SetThreadAffinityMask( pvHandle, 0x01 );\r
 256         }\r
 257 \r
 258         if( lSuccess == pdPASS )\r
 259         {\r
 260                 /* Start the thread that simulates the timer peripheral to generate\r
 261                 tick interrupts.  The priority is set below that of the simulated \r
 262                 interrupt handler so the interrupt event mutex is used for the\r
 263                 handshake / overrun protection. */\r
 264                 pvHandle = CreateThread( NULL, 0, prvSimulatedPeripheralTimer, NULL, 0, NULL );\r
 265                 if( pvHandle != NULL )\r
 266                 {\r
 267                         SetThreadPriority( pvHandle, THREAD_PRIORITY_BELOW_NORMAL );\r
 268                         SetThreadPriorityBoost( pvHandle, TRUE );\r
 269                         SetThreadAffinityMask( pvHandle, 0x01 );\r
 270                 }\r
 271                 \r
 272                 /* Start the highest priority task by obtaining its associated thread \r
 273                 state structure, in which is stored the thread handle. */\r
 274                 pxThreadState = ( xThreadState * ) *( ( unsigned long * ) pxCurrentTCB );\r
 275                 ulCriticalNesting = portNO_CRITICAL_NESTING;\r
 276 \r
 277                 /* Bump up the priority of the thread that is going to run, in the\r
 278                 hope that this will asist in getting the Windows thread scheduler to\r
 279                 behave as an embedded engineer might expect. */\r
 280                 ResumeThread( pxThreadState->pvThread );\r
 281 \r
 282                 /* Handle all simulated interrupts - including yield requests and \r
 283                 simulated ticks. */\r
 284                 prvProcessSimulatedInterrupts();\r
 285         }       \r
 286         \r
 287         /* Would not expect to return from prvProcessSimulatedInterrupts(), so should \r
 288         not get here. */\r
 289         return 0;\r
 290 }\r
 291 /*-----------------------------------------------------------*/\r
 292 \r
 293 static unsigned long prvProcessYieldInterrupt( void )\r
 294 {\r
 295         return pdTRUE;\r
 296 }\r
 297 /*-----------------------------------------------------------*/\r
 298 \r
 299 static unsigned long prvProcessTickInterrupt( void )\r
 300 {\r
 301 unsigned long ulSwitchRequired;\r
 302 \r
 303         /* Process the tick itself. */\r
 304         vTaskIncrementTick();\r
 305         #if( configUSE_PREEMPTION != 0 )\r
 306         {\r
 307                 /* A context switch is only automatically performed from the tick\r
 308                 interrupt if the pre-emptive scheduler is being used. */\r
 309                 ulSwitchRequired = pdTRUE;\r
 310         }\r
 311         #else\r
 312         {\r
 313                 ulSwitchRequired = pdFALSE;\r
 314         }\r
 315         #endif\r
 316 \r
 317         return ulSwitchRequired;\r
 318 }\r
 319 /*-----------------------------------------------------------*/\r
 320 \r
 321 static void prvProcessSimulatedInterrupts( void )\r
 322 {\r
 323 unsigned long ulSwitchRequired, i;\r
 324 xThreadState *pxThreadState;\r
 325 void *pvObjectList[ 2 ];\r
 326 \r
 327         /* Going to block on the mutex that ensured exclusive access to the simulated \r
 328         interrupt objects, and the event that signals that a simulated interrupt\r
 329         should be processed. */\r
 330         pvObjectList[ 0 ] = pvInterruptEventMutex;\r
 331         pvObjectList[ 1 ] = pvInterruptEvent;\r
 332 \r
 333         for(;;)\r
 334         {\r
 335                 WaitForMultipleObjects( sizeof( pvObjectList ) / sizeof( void * ), pvObjectList, TRUE, INFINITE );\r
 336 \r
 337                 /* Used to indicate whether the simulated interrupt processing has\r
 338                 necessitated a context switch to another task/thread. */\r
 339                 ulSwitchRequired = pdFALSE;\r
 340 \r
 341                 /* For each interrupt we are interested in processing, each of which is\r
 342                 represented by a bit in the 32bit ulPendingInterrupts variable. */\r
 343                 for( i = 0; i < portMAX_INTERRUPTS; i++ )\r
 344                 {\r
 345                         /* Is the simulated interrupt pending? */\r
 346                         if( ulPendingInterrupts & ( 1UL << i ) )\r
 347                         {\r
 348                                 /* Is a handler installed? */\r
 349                                 if( ulIsrHandler[ i ] != NULL )\r
 350                                 {\r
 351                                         /* Run the actual handler. */\r
 352                                         if( ulIsrHandler[ i ]() != pdFALSE )\r
 353                                         {\r
 354                                                 ulSwitchRequired |= ( 1 << i );\r
 355                                         }\r
 356                                 }\r
 357 \r
 358                                 /* Clear the interrupt pending bit. */\r
 359                                 ulPendingInterrupts &= ~( 1UL << i );\r
 360                         }\r
 361                 }\r
 362 \r
 363                 if( ulSwitchRequired != pdFALSE )\r
 364                 {\r
 365                         void *pvOldCurrentTCB;\r
 366 \r
 367                         pvOldCurrentTCB = pxCurrentTCB;\r
 368 \r
 369                         /* Select the next task to run. */\r
 370                         vTaskSwitchContext();\r
 371 \r
 372                         /* If the task selected to enter the running state is not the task\r
 373                         that is already in the running state. */\r
 374                         if( pvOldCurrentTCB != pxCurrentTCB )\r
 375                         {\r
 376                                 /* Suspend the old thread. */\r
 377                                 pxThreadState = ( xThreadState *) *( ( unsigned long * ) pvOldCurrentTCB );\r
 378                                 SuspendThread( pxThreadState->pvThread );\r
 379 \r
 380                                 /* Obtain the state of the task now selected to enter the \r
 381                                 Running state. */\r
 382                                 pxThreadState = ( xThreadState * ) ( *( unsigned long *) pxCurrentTCB );\r
 383                                 ResumeThread( pxThreadState->pvThread );\r
 384                         }\r
 385                 }\r
 386 \r
 387                 ReleaseMutex( pvInterruptEventMutex );\r
 388         }\r
 389 }\r
 390 /*-----------------------------------------------------------*/\r
 391 \r
 392 void vPortDeleteThread( void *pvTaskToDelete )\r
 393 {\r
 394 xThreadState *pxThreadState;\r
 395 \r
 396         WaitForSingleObject( pvInterruptEventMutex, INFINITE );\r
 397 \r
 398         /* Find the handle of the thread being deleted. */\r
 399         pxThreadState = ( xThreadState * ) ( *( unsigned long *) pvTaskToDelete );\r
 400         TerminateThread( pxThreadState->pvThread, 0 );\r
 401 \r
 402         ReleaseMutex( pvInterruptEventMutex );\r
 403 }\r
 404 /*-----------------------------------------------------------*/\r
 405 \r
 406 void vPortEndScheduler( void )\r
 407 {\r
 408         /* This function IS NOT TESTED! */\r
 409         TerminateProcess( GetCurrentProcess(), 0 );\r
 410 }\r
 411 /*-----------------------------------------------------------*/\r
 412 \r
 413 void vPortGenerateSimulatedInterrupt( unsigned long ulInterruptNumber )\r
 414 {\r
 415         if( ( ulInterruptNumber < portMAX_INTERRUPTS ) && ( pvInterruptEventMutex != NULL ) )\r
 416         {\r
 417                 /* Yield interrupts are processed even when critical nesting is non-zero. */\r
 418                 WaitForSingleObject( pvInterruptEventMutex, INFINITE );\r
 419                 ulPendingInterrupts |= ( 1 << ulInterruptNumber );\r
 420 \r
 421                 /* The simulated interrupt is now held pending, but don't actually process it\r
 422                 yet if this call is within a critical section.  It is possible for this to\r
 423                 be in a critical section as calls to wait for mutexes are accumulative. */\r
 424                 if( ulCriticalNesting == 0 )\r
 425                 {\r
 426                         SetEvent( pvInterruptEvent );                   \r
 427                 }\r
 428 \r
 429                 ReleaseMutex( pvInterruptEventMutex );\r
 430         }\r
 431 }\r
 432 /*-----------------------------------------------------------*/\r
 433 \r
 434 void vPortSetInterruptHandler( unsigned long ulInterruptNumber, unsigned long (*pvHandler)( void ) )\r
 435 {\r
 436         if( ulInterruptNumber < portMAX_INTERRUPTS )\r
 437         {\r
 438                 if( pvInterruptEventMutex != NULL )\r
 439                 {\r
 440                         WaitForSingleObject( pvInterruptEventMutex, INFINITE );\r
 441                         ulIsrHandler[ ulInterruptNumber ] = pvHandler;\r
 442                         ReleaseMutex( pvInterruptEventMutex );\r
 443                 }\r
 444                 else\r
 445                 {\r
 446                         ulIsrHandler[ ulInterruptNumber ] = pvHandler;\r
 447                 }\r
 448         }\r
 449 }\r
 450 /*-----------------------------------------------------------*/\r
 451 \r
 452 void vPortEnterCritical( void )\r
 453 {\r
 454         if( xTaskGetSchedulerState() != taskSCHEDULER_NOT_STARTED )\r
 455         {\r
 456                 /* The interrupt event mutex is held for the entire critical section,\r
 457                 effectively disabling (simulated) interrupts. */\r
 458                 WaitForSingleObject( pvInterruptEventMutex, INFINITE );\r
 459                 ulCriticalNesting++;\r
 460         }\r
 461         else\r
 462         {\r
 463                 ulCriticalNesting++;\r
 464         }       \r
 465 }\r
 466 /*-----------------------------------------------------------*/\r
 467 \r
 468 void vPortExitCritical( void )\r
 469 {\r
 470 long lMutexNeedsReleasing;\r
 471 \r
 472         /* The interrupt event mutex should already be held by this thread as it was\r
 473         obtained on entry to the critical section. */\r
 474 \r
 475         lMutexNeedsReleasing = pdTRUE;\r
 476 \r
 477         if( ulCriticalNesting > portNO_CRITICAL_NESTING )\r
 478         {\r
 479                 if( ulCriticalNesting == ( portNO_CRITICAL_NESTING + 1 ) )\r
 480                 {\r
 481                         ulCriticalNesting--;\r
 482 \r
 483                         /* Were any interrupts set to pending while interrupts were \r
 484                         (simulated) disabled? */\r
 485                         if( ulPendingInterrupts != 0UL )\r
 486                         {\r
 487                                 SetEvent( pvInterruptEvent );\r
 488 \r
 489                                 /* Mutex will be released now, so does not require releasing\r
 490                                 on function exit. */\r
 491                                 lMutexNeedsReleasing = pdFALSE;\r
 492                                 ReleaseMutex( pvInterruptEventMutex );\r
 493                         }\r
 494                 }\r
 495                 else\r
 496                 {\r
 497                         /* Tick interrupts will still not be processed as the critical\r
 498                         nesting depth will not be zero. */\r
 499                         ulCriticalNesting--;\r
 500                 }\r
 501         }\r
 502 \r
 503         if( lMutexNeedsReleasing == pdTRUE )\r
 504         {\r
 505                 ReleaseMutex( pvInterruptEventMutex );\r
 506         }\r
 507 }\r
 508 /*-----------------------------------------------------------*/\r
 509 \r