2 FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
7 This file is part of the FreeRTOS distribution.
9 FreeRTOS is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License (version 2) as published by the
11 Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.
13 ***************************************************************************
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
15 >>! distribute a combined work that includes FreeRTOS without being !<<
16 >>! obliged to provide the source code for proprietary components !<<
17 >>! outside of the FreeRTOS kernel. !<<
18 ***************************************************************************
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
23 link: http://www.freertos.org/a00114.html
25 ***************************************************************************
27 * FreeRTOS provides completely free yet professionally developed, *
28 * robust, strictly quality controlled, supported, and cross *
29 * platform software that is more than just the market leader, it *
30 * is the industry's de facto standard. *
32 * Help yourself get started quickly while simultaneously helping *
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
34 * tutorial book, reference manual, or both: *
35 * http://www.FreeRTOS.org/Documentation *
37 ***************************************************************************
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
40 the FAQ page "My application does not run, what could be wrong?". Have you
41 defined configASSERT()?
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
44 embedded software for free we request you assist our global community by
45 participating in the support forum.
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
48 be as productive as possible as early as possible. Now you can receive
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
50 Ltd, and the world's leading authority on the world's leading RTOS.
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
61 licenses offer ticketed support, indemnification and commercial middleware.
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
64 engineered and independently SIL3 certified version for use in safety and
65 mission critical applications that require provable dependability.
70 /* Standard includes. */
73 /* Scheduler includes. */
80 #pragma comment(lib, "winmm.lib")
83 #define portMAX_INTERRUPTS ( ( uint32_t ) sizeof( uint32_t ) * 8UL ) /* The number of bits in an uint32_t. */
84 #define portNO_CRITICAL_NESTING ( ( uint32_t ) 0 )
86 /* The priorities at which the various components of the simulation execute.
87 Priorities are higher when a soak test is performed to lessen the effect of
88 Windows interfering with the timing. */
91 #define portDELETE_SELF_THREAD_PRIORITY THREAD_PRIORITY_HIGHEST /* Must be highest. */
92 #define portSIMULATED_INTERRUPTS_THREAD_PRIORITY THREAD_PRIORITY_NORMAL
93 #define portSIMULATED_TIMER_THREAD_PRIORITY THREAD_PRIORITY_BELOW_NORMAL
94 #define portTASK_THREAD_PRIORITY THREAD_PRIORITY_IDLE
96 #define portDELETE_SELF_THREAD_PRIORITY THREAD_PRIORITY_TIME_CRITICAL /* Must be highest. */
97 #define portSIMULATED_INTERRUPTS_THREAD_PRIORITY THREAD_PRIORITY_HIGHEST
98 #define portSIMULATED_TIMER_THREAD_PRIORITY THREAD_PRIORITY_ABOVE_NORMAL
99 #define portTASK_THREAD_PRIORITY THREAD_PRIORITY_NORMAL
102 * Created as a high priority thread, this function uses a timer to simulate
103 * a tick interrupt being generated on an embedded target. In this Windows
104 * environment the timer does not achieve anything approaching real time
105 * performance though.
107 static DWORD WINAPI prvSimulatedPeripheralTimer( LPVOID lpParameter );
110 * Process all the simulated interrupts - each represented by a bit in
111 * ulPendingInterrupts variable.
113 static void prvProcessSimulatedInterrupts( void );
116 * Interrupt handlers used by the kernel itself. These are executed from the
117 * simulated interrupt handler thread.
119 static uint32_t prvProcessYieldInterrupt( void );
120 static uint32_t prvProcessTickInterrupt( void );
123 * Called when the process exits to let Windows know the high timer resolution
124 * is no longer required.
126 static BOOL WINAPI prvEndProcess( DWORD dwCtrlType );
128 /*-----------------------------------------------------------*/
130 /* The WIN32 simulator runs each task in a thread. The context switching is
131 managed by the threads, so the task stack does not have to be managed directly,
132 although the task stack is still used to hold an xThreadState structure this is
133 the only thing it will ever hold. The structure indirectly maps the task handle
134 to a thread handle. */
137 /* Handle of the thread that executes the task. */
142 /* Simulated interrupts waiting to be processed. This is a bit mask where each
143 bit represents one interrupt, so a maximum of 32 interrupts can be simulated. */
144 static volatile uint32_t ulPendingInterrupts = 0UL;
146 /* An event used to inform the simulated interrupt processing thread (a high
147 priority thread that simulated interrupt processing) that an interrupt is
149 static void *pvInterruptEvent = NULL;
151 /* Mutex used to protect all the simulated interrupt variables that are accessed
152 by multiple threads. */
153 static void *pvInterruptEventMutex = NULL;
155 /* The critical nesting count for the currently executing task. This is
156 initialised to a non-zero value so interrupts do not become enabled during
157 the initialisation phase. As each task has its own critical nesting value
158 ulCriticalNesting will get set to zero when the first task runs. This
159 initialisation is probably not critical in this simulated environment as the
160 simulated interrupt handlers do not get created until the FreeRTOS scheduler is
162 static uint32_t ulCriticalNesting = 9999UL;
164 /* Handlers for all the simulated software interrupts. The first two positions
165 are used for the Yield and Tick interrupts so are handled slightly differently,
166 all the other interrupts can be user defined. */
167 static uint32_t (*ulIsrHandler[ portMAX_INTERRUPTS ])( void ) = { 0 };
169 /* Pointer to the TCB of the currently executing task. */
170 extern void *pxCurrentTCB;
172 /* Used to ensure nothing is processed during the startup sequence. */
173 static BaseType_t xPortRunning = pdFALSE;
175 /*-----------------------------------------------------------*/
177 static DWORD WINAPI prvSimulatedPeripheralTimer( LPVOID lpParameter )
179 TickType_t xMinimumWindowsBlockTime;
182 /* Set the timer resolution to the maximum possible. */
183 if( timeGetDevCaps( &xTimeCaps, sizeof( xTimeCaps ) ) == MMSYSERR_NOERROR )
185 xMinimumWindowsBlockTime = ( TickType_t ) xTimeCaps.wPeriodMin;
186 timeBeginPeriod( xTimeCaps.wPeriodMin );
188 /* Register an exit handler so the timeBeginPeriod() function can be
189 matched with a timeEndPeriod() when the application exits. */
190 SetConsoleCtrlHandler( prvEndProcess, TRUE );
194 xMinimumWindowsBlockTime = ( TickType_t ) 20;
197 /* Just to prevent compiler warnings. */
198 ( void ) lpParameter;
202 /* Wait until the timer expires and we can access the simulated interrupt
203 variables. *NOTE* this is not a 'real time' way of generating tick
204 events as the next wake time should be relative to the previous wake
205 time, not the time that Sleep() is called. It is done this way to
206 prevent overruns in this very non real time simulated/emulated
208 if( portTICK_PERIOD_MS < xMinimumWindowsBlockTime )
210 Sleep( xMinimumWindowsBlockTime );
214 Sleep( portTICK_PERIOD_MS );
217 configASSERT( xPortRunning );
219 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
221 /* The timer has expired, generate the simulated tick event. */
222 ulPendingInterrupts |= ( 1 << portINTERRUPT_TICK );
224 /* The interrupt is now pending - notify the simulated interrupt
226 if( ulCriticalNesting == 0 )
228 SetEvent( pvInterruptEvent );
231 /* Give back the mutex so the simulated interrupt handler unblocks
232 and can access the interrupt handler variables. */
233 ReleaseMutex( pvInterruptEventMutex );
237 /* Should never reach here - MingW complains if you leave this line out,
238 MSVC complains if you put it in. */
242 /*-----------------------------------------------------------*/
244 static BOOL WINAPI prvEndProcess( DWORD dwCtrlType )
250 if( timeGetDevCaps( &xTimeCaps, sizeof( xTimeCaps ) ) == MMSYSERR_NOERROR )
252 /* Match the call to timeBeginPeriod( xTimeCaps.wPeriodMin ) made when
253 the process started with a timeEndPeriod() as the process exits. */
254 timeEndPeriod( xTimeCaps.wPeriodMin );
259 /*-----------------------------------------------------------*/
261 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )
263 xThreadState *pxThreadState = NULL;
264 int8_t *pcTopOfStack = ( int8_t * ) pxTopOfStack;
265 const SIZE_T xStackSize = 1024; /* Set the size to a small number which will get rounded up to the minimum possible. */
269 /* Ensure highest priority class is inherited. */
270 if( !SetPriorityClass( GetCurrentProcess(), REALTIME_PRIORITY_CLASS ) )
272 printf( "SetPriorityClass() failed\r\n" );
277 /* In this simulated case a stack is not initialised, but instead a thread
278 is created that will execute the task being created. The thread handles
279 the context switching itself. The xThreadState object is placed onto
280 the stack that was created for the task - so the stack buffer is still
281 used, just not in the conventional way. It will not be used for anything
282 other than holding this structure. */
283 pxThreadState = ( xThreadState * ) ( pcTopOfStack - sizeof( xThreadState ) );
285 /* Create the thread itself. */
286 pxThreadState->pvThread = CreateThread( NULL, xStackSize, ( LPTHREAD_START_ROUTINE ) pxCode, pvParameters, CREATE_SUSPENDED | STACK_SIZE_PARAM_IS_A_RESERVATION, NULL );
287 configASSERT( pxThreadState->pvThread ); /* See comment where TerminateThread() is called. */
288 SetThreadAffinityMask( pxThreadState->pvThread, 0x01 );
289 SetThreadPriorityBoost( pxThreadState->pvThread, TRUE );
290 SetThreadPriority( pxThreadState->pvThread, portTASK_THREAD_PRIORITY );
292 return ( StackType_t * ) pxThreadState;
294 /*-----------------------------------------------------------*/
296 BaseType_t xPortStartScheduler( void )
299 int32_t lSuccess = pdPASS;
300 xThreadState *pxThreadState;
302 /* Install the interrupt handlers used by the scheduler itself. */
303 vPortSetInterruptHandler( portINTERRUPT_YIELD, prvProcessYieldInterrupt );
304 vPortSetInterruptHandler( portINTERRUPT_TICK, prvProcessTickInterrupt );
306 /* Create the events and mutexes that are used to synchronise all the
308 pvInterruptEventMutex = CreateMutex( NULL, FALSE, NULL );
309 pvInterruptEvent = CreateEvent( NULL, FALSE, FALSE, NULL );
311 if( ( pvInterruptEventMutex == NULL ) || ( pvInterruptEvent == NULL ) )
316 /* Set the priority of this thread such that it is above the priority of
317 the threads that run tasks. This higher priority is required to ensure
318 simulated interrupts take priority over tasks. */
319 pvHandle = GetCurrentThread();
320 if( pvHandle == NULL )
325 if( lSuccess == pdPASS )
327 if( SetThreadPriority( pvHandle, portSIMULATED_INTERRUPTS_THREAD_PRIORITY ) == 0 )
331 SetThreadPriorityBoost( pvHandle, TRUE );
332 SetThreadAffinityMask( pvHandle, 0x01 );
335 if( lSuccess == pdPASS )
337 /* Start the thread that simulates the timer peripheral to generate
338 tick interrupts. The priority is set below that of the simulated
339 interrupt handler so the interrupt event mutex is used for the
340 handshake / overrun protection. */
341 pvHandle = CreateThread( NULL, 0, prvSimulatedPeripheralTimer, NULL, CREATE_SUSPENDED, NULL );
342 if( pvHandle != NULL )
344 SetThreadPriority( pvHandle, portSIMULATED_TIMER_THREAD_PRIORITY );
345 SetThreadPriorityBoost( pvHandle, TRUE );
346 SetThreadAffinityMask( pvHandle, 0x01 );
347 ResumeThread( pvHandle );
350 /* Start the highest priority task by obtaining its associated thread
351 state structure, in which is stored the thread handle. */
352 pxThreadState = ( xThreadState * ) *( ( size_t * ) pxCurrentTCB );
353 ulCriticalNesting = portNO_CRITICAL_NESTING;
355 /* Bump up the priority of the thread that is going to run, in the
356 hope that this will assist in getting the Windows thread scheduler to
357 behave as an embedded engineer might expect. */
358 ResumeThread( pxThreadState->pvThread );
360 /* Handle all simulated interrupts - including yield requests and
362 prvProcessSimulatedInterrupts();
365 /* Would not expect to return from prvProcessSimulatedInterrupts(), so should
369 /*-----------------------------------------------------------*/
371 static uint32_t prvProcessYieldInterrupt( void )
375 /*-----------------------------------------------------------*/
377 static uint32_t prvProcessTickInterrupt( void )
379 uint32_t ulSwitchRequired;
381 /* Process the tick itself. */
382 configASSERT( xPortRunning );
383 ulSwitchRequired = ( uint32_t ) xTaskIncrementTick();
385 return ulSwitchRequired;
387 /*-----------------------------------------------------------*/
389 static void prvProcessSimulatedInterrupts( void )
391 uint32_t ulSwitchRequired, i;
392 xThreadState *pxThreadState;
393 void *pvObjectList[ 2 ];
396 /* Going to block on the mutex that ensured exclusive access to the simulated
397 interrupt objects, and the event that signals that a simulated interrupt
398 should be processed. */
399 pvObjectList[ 0 ] = pvInterruptEventMutex;
400 pvObjectList[ 1 ] = pvInterruptEvent;
402 /* Create a pending tick to ensure the first task is started as soon as
403 this thread pends. */
404 ulPendingInterrupts |= ( 1 << portINTERRUPT_TICK );
405 SetEvent( pvInterruptEvent );
407 xPortRunning = pdTRUE;
411 WaitForMultipleObjects( sizeof( pvObjectList ) / sizeof( void * ), pvObjectList, TRUE, INFINITE );
413 /* Used to indicate whether the simulated interrupt processing has
414 necessitated a context switch to another task/thread. */
415 ulSwitchRequired = pdFALSE;
417 /* For each interrupt we are interested in processing, each of which is
418 represented by a bit in the 32bit ulPendingInterrupts variable. */
419 for( i = 0; i < portMAX_INTERRUPTS; i++ )
421 /* Is the simulated interrupt pending? */
422 if( ulPendingInterrupts & ( 1UL << i ) )
424 /* Is a handler installed? */
425 if( ulIsrHandler[ i ] != NULL )
427 /* Run the actual handler. */
428 if( ulIsrHandler[ i ]() != pdFALSE )
430 ulSwitchRequired |= ( 1 << i );
434 /* Clear the interrupt pending bit. */
435 ulPendingInterrupts &= ~( 1UL << i );
439 if( ulSwitchRequired != pdFALSE )
441 void *pvOldCurrentTCB;
443 pvOldCurrentTCB = pxCurrentTCB;
445 /* Select the next task to run. */
446 vTaskSwitchContext();
448 /* If the task selected to enter the running state is not the task
449 that is already in the running state. */
450 if( pvOldCurrentTCB != pxCurrentTCB )
452 /* Suspend the old thread. */
453 pxThreadState = ( xThreadState *) *( ( size_t * ) pvOldCurrentTCB );
454 SuspendThread( pxThreadState->pvThread );
456 /* Ensure the thread is actually suspended by performing a
457 synchronous operation that can only complete when the thread is
458 actually suspended. The below code asks for dummy register
460 xContext.ContextFlags = CONTEXT_INTEGER;
461 ( void ) GetThreadContext( pxThreadState->pvThread, &xContext );
463 /* Obtain the state of the task now selected to enter the
465 pxThreadState = ( xThreadState * ) ( *( size_t *) pxCurrentTCB );
466 ResumeThread( pxThreadState->pvThread );
470 ReleaseMutex( pvInterruptEventMutex );
473 /*-----------------------------------------------------------*/
475 void vPortDeleteThread( void *pvTaskToDelete )
477 xThreadState *pxThreadState;
478 uint32_t ulErrorCode;
480 /* Remove compiler warnings if configASSERT() is not defined. */
481 ( void ) ulErrorCode;
483 /* Find the handle of the thread being deleted. */
484 pxThreadState = ( xThreadState * ) ( *( size_t *) pvTaskToDelete );
486 /* Check that the thread is still valid, it might have been closed by
487 vPortCloseRunningThread() - which will be the case if the task associated
488 with the thread originally deleted itself rather than being deleted by a
490 if( pxThreadState->pvThread != NULL )
492 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
494 /* !!! This is not a nice way to terminate a thread, and will eventually
495 result in resources being depleted if tasks frequently delete other
496 tasks (rather than deleting themselves) as the task stacks will not be
498 ulErrorCode = TerminateThread( pxThreadState->pvThread, 0 );
499 configASSERT( ulErrorCode );
501 ulErrorCode = CloseHandle( pxThreadState->pvThread );
502 configASSERT( ulErrorCode );
504 ReleaseMutex( pvInterruptEventMutex );
507 /*-----------------------------------------------------------*/
509 void vPortCloseRunningThread( void *pvTaskToDelete, volatile BaseType_t *pxPendYield )
511 xThreadState *pxThreadState;
513 uint32_t ulErrorCode;
515 /* Remove compiler warnings if configASSERT() is not defined. */
516 ( void ) ulErrorCode;
518 /* Find the handle of the thread being deleted. */
519 pxThreadState = ( xThreadState * ) ( *( size_t *) pvTaskToDelete );
520 pvThread = pxThreadState->pvThread;
522 /* Raise the Windows priority of the thread to ensure the FreeRTOS scheduler
523 does not run and swap it out before it is closed. If that were to happen
524 the thread would never run again and effectively be a thread handle and
526 SetThreadPriority( pvThread, portDELETE_SELF_THREAD_PRIORITY );
528 /* This function will not return, therefore a yield is set as pending to
529 ensure a context switch occurs away from this thread on the next tick. */
530 *pxPendYield = pdTRUE;
532 /* Mark the thread associated with this task as invalid so
533 vPortDeleteThread() does not try to terminate it. */
534 pxThreadState->pvThread = NULL;
536 /* Close the thread. */
537 ulErrorCode = CloseHandle( pvThread );
538 configASSERT( ulErrorCode );
540 /* This is called from a critical section, which must be exited before the
546 /*-----------------------------------------------------------*/
548 void vPortEndScheduler( void )
550 /* This function IS NOT TESTED! */
551 TerminateProcess( GetCurrentProcess(), 0 );
553 /*-----------------------------------------------------------*/
555 void vPortGenerateSimulatedInterrupt( uint32_t ulInterruptNumber )
557 configASSERT( xPortRunning );
559 if( ( ulInterruptNumber < portMAX_INTERRUPTS ) && ( pvInterruptEventMutex != NULL ) )
561 /* Yield interrupts are processed even when critical nesting is
563 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
564 ulPendingInterrupts |= ( 1 << ulInterruptNumber );
566 /* The simulated interrupt is now held pending, but don't actually
567 process it yet if this call is within a critical section. It is
568 possible for this to be in a critical section as calls to wait for
569 mutexes are accumulative. */
570 if( ulCriticalNesting == 0 )
572 SetEvent( pvInterruptEvent );
575 ReleaseMutex( pvInterruptEventMutex );
578 /*-----------------------------------------------------------*/
580 void vPortSetInterruptHandler( uint32_t ulInterruptNumber, uint32_t (*pvHandler)( void ) )
582 if( ulInterruptNumber < portMAX_INTERRUPTS )
584 if( pvInterruptEventMutex != NULL )
586 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
587 ulIsrHandler[ ulInterruptNumber ] = pvHandler;
588 ReleaseMutex( pvInterruptEventMutex );
592 ulIsrHandler[ ulInterruptNumber ] = pvHandler;
596 /*-----------------------------------------------------------*/
598 void vPortEnterCritical( void )
600 if( xPortRunning == pdTRUE )
602 /* The interrupt event mutex is held for the entire critical section,
603 effectively disabling (simulated) interrupts. */
604 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
612 /*-----------------------------------------------------------*/
614 void vPortExitCritical( void )
616 int32_t lMutexNeedsReleasing;
618 /* The interrupt event mutex should already be held by this thread as it was
619 obtained on entry to the critical section. */
621 lMutexNeedsReleasing = pdTRUE;
623 if( ulCriticalNesting > portNO_CRITICAL_NESTING )
625 if( ulCriticalNesting == ( portNO_CRITICAL_NESTING + 1 ) )
629 /* Were any interrupts set to pending while interrupts were
630 (simulated) disabled? */
631 if( ulPendingInterrupts != 0UL )
633 configASSERT( xPortRunning );
634 SetEvent( pvInterruptEvent );
636 /* Mutex will be released now, so does not require releasing
638 lMutexNeedsReleasing = pdFALSE;
639 ReleaseMutex( pvInterruptEventMutex );
644 /* Tick interrupts will still not be processed as the critical
645 nesting depth will not be zero. */
650 if( pvInterruptEventMutex != NULL )
652 if( lMutexNeedsReleasing == pdTRUE )
654 configASSERT( xPortRunning );
655 ReleaseMutex( pvInterruptEventMutex );
659 /*-----------------------------------------------------------*/