2 FreeRTOS V8.2.1 - Copyright (C) 2015 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
70 /* Standard includes. */
\r
73 /* Scheduler includes. */
\r
74 #include "FreeRTOS.h"
\r
78 #include "mmsystem.h"
\r
80 #pragma comment(lib, "winmm.lib")
\r
83 #define portMAX_INTERRUPTS ( ( uint32_t ) sizeof( uint32_t ) * 8UL ) /* The number of bits in an uint32_t. */
\r
84 #define portNO_CRITICAL_NESTING ( ( uint32_t ) 0 )
\r
87 * Created as a high priority thread, this function uses a timer to simulate
\r
88 * a tick interrupt being generated on an embedded target. In this Windows
\r
89 * environment the timer does not achieve anything approaching real time
\r
90 * performance though.
\r
92 static DWORD WINAPI prvSimulatedPeripheralTimer( LPVOID lpParameter );
\r
95 * Process all the simulated interrupts - each represented by a bit in
\r
96 * ulPendingInterrupts variable.
\r
98 static void prvProcessSimulatedInterrupts( void );
\r
101 * Interrupt handlers used by the kernel itself. These are executed from the
\r
102 * simulated interrupt handler thread.
\r
104 static uint32_t prvProcessYieldInterrupt( void );
\r
105 static uint32_t prvProcessTickInterrupt( void );
\r
108 * Called when the process exits to let Windows know the high timer resolution
\r
109 * is no longer required.
\r
111 static BOOL WINAPI prvEndProcess( DWORD dwCtrlType );
\r
113 /*-----------------------------------------------------------*/
\r
115 /* The WIN32 simulator runs each task in a thread. The context switching is
\r
116 managed by the threads, so the task stack does not have to be managed directly,
\r
117 although the task stack is still used to hold an xThreadState structure this is
\r
118 the only thing it will ever hold. The structure indirectly maps the task handle
\r
119 to a thread handle. */
\r
122 /* Handle of the thread that executes the task. */
\r
127 /* Simulated interrupts waiting to be processed. This is a bit mask where each
\r
128 bit represents one interrupt, so a maximum of 32 interrupts can be simulated. */
\r
129 static volatile uint32_t ulPendingInterrupts = 0UL;
\r
131 /* An event used to inform the simulated interrupt processing thread (a high
\r
132 priority thread that simulated interrupt processing) that an interrupt is
\r
134 static void *pvInterruptEvent = NULL;
\r
136 /* Mutex used to protect all the simulated interrupt variables that are accessed
\r
137 by multiple threads. */
\r
138 static void *pvInterruptEventMutex = NULL;
\r
140 /* The critical nesting count for the currently executing task. This is
\r
141 initialised to a non-zero value so interrupts do not become enabled during
\r
142 the initialisation phase. As each task has its own critical nesting value
\r
143 ulCriticalNesting will get set to zero when the first task runs. This
\r
144 initialisation is probably not critical in this simulated environment as the
\r
145 simulated interrupt handlers do not get created until the FreeRTOS scheduler is
\r
147 static uint32_t ulCriticalNesting = 9999UL;
\r
149 /* Handlers for all the simulated software interrupts. The first two positions
\r
150 are used for the Yield and Tick interrupts so are handled slightly differently,
\r
151 all the other interrupts can be user defined. */
\r
152 static uint32_t (*ulIsrHandler[ portMAX_INTERRUPTS ])( void ) = { 0 };
\r
154 /* Pointer to the TCB of the currently executing task. */
\r
155 extern void *pxCurrentTCB;
\r
157 /* Used to ensure nothing is processed during the startup sequence. */
\r
158 static BaseType_t xPortRunning = pdFALSE;
\r
160 /*-----------------------------------------------------------*/
\r
162 static DWORD WINAPI prvSimulatedPeripheralTimer( LPVOID lpParameter )
\r
164 TickType_t xMinimumWindowsBlockTime;
\r
165 TIMECAPS xTimeCaps;
\r
167 /* Set the timer resolution to the maximum possible. */
\r
168 if( timeGetDevCaps( &xTimeCaps, sizeof( xTimeCaps ) ) == MMSYSERR_NOERROR )
\r
170 xMinimumWindowsBlockTime = ( TickType_t ) xTimeCaps.wPeriodMin;
\r
171 timeBeginPeriod( xTimeCaps.wPeriodMin );
\r
173 /* Register an exit handler so the timeBeginPeriod() function can be
\r
174 matched with a timeEndPeriod() when the application exits. */
\r
175 SetConsoleCtrlHandler( prvEndProcess, TRUE );
\r
179 xMinimumWindowsBlockTime = ( TickType_t ) 20;
\r
182 /* Just to prevent compiler warnings. */
\r
183 ( void ) lpParameter;
\r
187 /* Wait until the timer expires and we can access the simulated interrupt
\r
188 variables. *NOTE* this is not a 'real time' way of generating tick
\r
189 events as the next wake time should be relative to the previous wake
\r
190 time, not the time that Sleep() is called. It is done this way to
\r
191 prevent overruns in this very non real time simulated/emulated
\r
193 if( portTICK_PERIOD_MS < xMinimumWindowsBlockTime )
\r
195 Sleep( xMinimumWindowsBlockTime );
\r
199 Sleep( portTICK_PERIOD_MS );
\r
202 configASSERT( xPortRunning );
\r
204 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
\r
206 /* The timer has expired, generate the simulated tick event. */
\r
207 ulPendingInterrupts |= ( 1 << portINTERRUPT_TICK );
\r
209 /* The interrupt is now pending - notify the simulated interrupt
\r
211 if( ulCriticalNesting == 0 )
\r
213 SetEvent( pvInterruptEvent );
\r
216 /* Give back the mutex so the simulated interrupt handler unblocks
\r
217 and can access the interrupt handler variables. */
\r
218 ReleaseMutex( pvInterruptEventMutex );
\r
222 /* Should never reach here - MingW complains if you leave this line out,
\r
223 MSVC complains if you put it in. */
\r
227 /*-----------------------------------------------------------*/
\r
229 static BOOL WINAPI prvEndProcess( DWORD dwCtrlType )
\r
231 TIMECAPS xTimeCaps;
\r
233 ( void ) dwCtrlType;
\r
235 if( timeGetDevCaps( &xTimeCaps, sizeof( xTimeCaps ) ) == MMSYSERR_NOERROR )
\r
237 /* Match the call to timeBeginPeriod( xTimeCaps.wPeriodMin ) made when
\r
238 the process started with a timeEndPeriod() as the process exits. */
\r
239 timeEndPeriod( xTimeCaps.wPeriodMin );
\r
244 /*-----------------------------------------------------------*/
\r
246 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )
\r
248 xThreadState *pxThreadState = NULL;
\r
249 int8_t *pcTopOfStack = ( int8_t * ) pxTopOfStack;
\r
251 /* In this simulated case a stack is not initialised, but instead a thread
\r
252 is created that will execute the task being created. The thread handles
\r
253 the context switching itself. The xThreadState object is placed onto
\r
254 the stack that was created for the task - so the stack buffer is still
\r
255 used, just not in the conventional way. It will not be used for anything
\r
256 other than holding this structure. */
\r
257 pxThreadState = ( xThreadState * ) ( pcTopOfStack - sizeof( xThreadState ) );
\r
259 /* Create the thread itself. */
\r
260 pxThreadState->pvThread = CreateThread( NULL, 0, ( LPTHREAD_START_ROUTINE ) pxCode, pvParameters, CREATE_SUSPENDED, NULL );
\r
261 configASSERT( pxThreadState->pvThread );
\r
262 SetThreadAffinityMask( pxThreadState->pvThread, 0x01 );
\r
263 SetThreadPriorityBoost( pxThreadState->pvThread, TRUE );
\r
264 SetThreadPriority( pxThreadState->pvThread, THREAD_PRIORITY_IDLE );
\r
266 return ( StackType_t * ) pxThreadState;
\r
268 /*-----------------------------------------------------------*/
\r
270 BaseType_t xPortStartScheduler( void )
\r
273 int32_t lSuccess = pdPASS;
\r
274 xThreadState *pxThreadState;
\r
276 /* Install the interrupt handlers used by the scheduler itself. */
\r
277 vPortSetInterruptHandler( portINTERRUPT_YIELD, prvProcessYieldInterrupt );
\r
278 vPortSetInterruptHandler( portINTERRUPT_TICK, prvProcessTickInterrupt );
\r
280 /* Create the events and mutexes that are used to synchronise all the
\r
282 pvInterruptEventMutex = CreateMutex( NULL, FALSE, NULL );
\r
283 pvInterruptEvent = CreateEvent( NULL, FALSE, FALSE, NULL );
\r
285 if( ( pvInterruptEventMutex == NULL ) || ( pvInterruptEvent == NULL ) )
\r
290 /* Set the priority of this thread such that it is above the priority of
\r
291 the threads that run tasks. This higher priority is required to ensure
\r
292 simulated interrupts take priority over tasks. */
\r
293 pvHandle = GetCurrentThread();
\r
294 if( pvHandle == NULL )
\r
299 if( lSuccess == pdPASS )
\r
301 if( SetThreadPriority( pvHandle, THREAD_PRIORITY_NORMAL ) == 0 )
\r
305 SetThreadPriorityBoost( pvHandle, TRUE );
\r
306 SetThreadAffinityMask( pvHandle, 0x01 );
\r
309 if( lSuccess == pdPASS )
\r
311 /* Start the thread that simulates the timer peripheral to generate
\r
312 tick interrupts. The priority is set below that of the simulated
\r
313 interrupt handler so the interrupt event mutex is used for the
\r
314 handshake / overrun protection. */
\r
315 pvHandle = CreateThread( NULL, 0, prvSimulatedPeripheralTimer, NULL, 0, NULL );
\r
316 if( pvHandle != NULL )
\r
318 SetThreadPriority( pvHandle, THREAD_PRIORITY_BELOW_NORMAL );
\r
319 SetThreadPriorityBoost( pvHandle, TRUE );
\r
320 SetThreadAffinityMask( pvHandle, 0x01 );
\r
323 /* Start the highest priority task by obtaining its associated thread
\r
324 state structure, in which is stored the thread handle. */
\r
325 pxThreadState = ( xThreadState * ) *( ( size_t * ) pxCurrentTCB );
\r
326 ulCriticalNesting = portNO_CRITICAL_NESTING;
\r
328 /* Bump up the priority of the thread that is going to run, in the
\r
329 hope that this will assist in getting the Windows thread scheduler to
\r
330 behave as an embedded engineer might expect. */
\r
331 ResumeThread( pxThreadState->pvThread );
\r
333 /* Handle all simulated interrupts - including yield requests and
\r
334 simulated ticks. */
\r
335 prvProcessSimulatedInterrupts();
\r
338 /* Would not expect to return from prvProcessSimulatedInterrupts(), so should
\r
342 /*-----------------------------------------------------------*/
\r
344 static uint32_t prvProcessYieldInterrupt( void )
\r
348 /*-----------------------------------------------------------*/
\r
350 static uint32_t prvProcessTickInterrupt( void )
\r
352 uint32_t ulSwitchRequired;
\r
354 /* Process the tick itself. */
\r
355 configASSERT( xPortRunning );
\r
356 ulSwitchRequired = ( uint32_t ) xTaskIncrementTick();
\r
358 return ulSwitchRequired;
\r
360 /*-----------------------------------------------------------*/
\r
362 static void prvProcessSimulatedInterrupts( void )
\r
364 uint32_t ulSwitchRequired, i;
\r
365 xThreadState *pxThreadState;
\r
366 void *pvObjectList[ 2 ];
\r
368 /* Going to block on the mutex that ensured exclusive access to the simulated
\r
369 interrupt objects, and the event that signals that a simulated interrupt
\r
370 should be processed. */
\r
371 pvObjectList[ 0 ] = pvInterruptEventMutex;
\r
372 pvObjectList[ 1 ] = pvInterruptEvent;
\r
374 /* Create a pending tick to ensure the first task is started as soon as
\r
375 this thread pends. */
\r
376 ulPendingInterrupts |= ( 1 << portINTERRUPT_TICK );
\r
377 SetEvent( pvInterruptEvent );
\r
379 xPortRunning = pdTRUE;
\r
383 WaitForMultipleObjects( sizeof( pvObjectList ) / sizeof( void * ), pvObjectList, TRUE, INFINITE );
\r
385 /* Used to indicate whether the simulated interrupt processing has
\r
386 necessitated a context switch to another task/thread. */
\r
387 ulSwitchRequired = pdFALSE;
\r
389 /* For each interrupt we are interested in processing, each of which is
\r
390 represented by a bit in the 32bit ulPendingInterrupts variable. */
\r
391 for( i = 0; i < portMAX_INTERRUPTS; i++ )
\r
393 /* Is the simulated interrupt pending? */
\r
394 if( ulPendingInterrupts & ( 1UL << i ) )
\r
396 /* Is a handler installed? */
\r
397 if( ulIsrHandler[ i ] != NULL )
\r
399 /* Run the actual handler. */
\r
400 if( ulIsrHandler[ i ]() != pdFALSE )
\r
402 ulSwitchRequired |= ( 1 << i );
\r
406 /* Clear the interrupt pending bit. */
\r
407 ulPendingInterrupts &= ~( 1UL << i );
\r
411 if( ulSwitchRequired != pdFALSE )
\r
413 void *pvOldCurrentTCB;
\r
415 pvOldCurrentTCB = pxCurrentTCB;
\r
417 /* Select the next task to run. */
\r
418 vTaskSwitchContext();
\r
420 /* If the task selected to enter the running state is not the task
\r
421 that is already in the running state. */
\r
422 if( pvOldCurrentTCB != pxCurrentTCB )
\r
424 /* Suspend the old thread. */
\r
425 pxThreadState = ( xThreadState *) *( ( size_t * ) pvOldCurrentTCB );
\r
426 SuspendThread( pxThreadState->pvThread );
\r
428 /* Obtain the state of the task now selected to enter the
\r
430 pxThreadState = ( xThreadState * ) ( *( size_t *) pxCurrentTCB );
\r
431 ResumeThread( pxThreadState->pvThread );
\r
435 ReleaseMutex( pvInterruptEventMutex );
\r
438 /*-----------------------------------------------------------*/
\r
440 void vPortDeleteThread( void *pvTaskToDelete )
\r
442 xThreadState *pxThreadState;
\r
443 uint32_t ulErrorCode;
\r
445 /* Remove compiler warnings if configASSERT() is not defined. */
\r
446 ( void ) ulErrorCode;
\r
448 /* Find the handle of the thread being deleted. */
\r
449 pxThreadState = ( xThreadState * ) ( *( size_t *) pvTaskToDelete );
\r
451 /* Check that the thread is still valid, it might have been closed by
\r
452 vPortCloseRunningThread() - which will be the case if the task associated
\r
453 with the thread originally deleted itself rather than being deleted by a
\r
455 if( pxThreadState->pvThread != NULL )
\r
457 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
\r
459 ulErrorCode = TerminateThread( pxThreadState->pvThread, 0 );
\r
460 configASSERT( ulErrorCode );
\r
462 ulErrorCode = CloseHandle( pxThreadState->pvThread );
\r
463 configASSERT( ulErrorCode );
\r
465 ReleaseMutex( pvInterruptEventMutex );
\r
468 /*-----------------------------------------------------------*/
\r
470 void vPortCloseRunningThread( void *pvTaskToDelete, volatile BaseType_t *pxPendYield )
\r
472 xThreadState *pxThreadState;
\r
474 uint32_t ulErrorCode;
\r
476 /* Remove compiler warnings if configASSERT() is not defined. */
\r
477 ( void ) ulErrorCode;
\r
479 /* Find the handle of the thread being deleted. */
\r
480 pxThreadState = ( xThreadState * ) ( *( size_t *) pvTaskToDelete );
\r
481 pvThread = pxThreadState->pvThread;
\r
483 /* Raise the Windows priority of the thread to ensure the FreeRTOS scheduler
\r
484 does not run and swap it out before it is closed. If that were to happen
\r
485 the thread would never run again and effectively be a thread handle and
\r
487 SetThreadPriority( pvThread, THREAD_PRIORITY_ABOVE_NORMAL );
\r
489 /* This function will not return, therefore a yield is set as pending to
\r
490 ensure a context switch occurs away from this thread on the next tick. */
\r
491 *pxPendYield = pdTRUE;
\r
493 /* Mark the thread associated with this task as invalid so
\r
494 vPortDeleteThread() does not try to terminate it. */
\r
495 pxThreadState->pvThread = NULL;
\r
497 /* Close the thread. */
\r
498 ulErrorCode = CloseHandle( pvThread );
\r
499 configASSERT( ulErrorCode );
\r
503 /*-----------------------------------------------------------*/
\r
505 void vPortEndScheduler( void )
\r
507 /* This function IS NOT TESTED! */
\r
508 TerminateProcess( GetCurrentProcess(), 0 );
\r
510 /*-----------------------------------------------------------*/
\r
512 void vPortGenerateSimulatedInterrupt( uint32_t ulInterruptNumber )
\r
514 configASSERT( xPortRunning );
\r
516 if( ( ulInterruptNumber < portMAX_INTERRUPTS ) && ( pvInterruptEventMutex != NULL ) )
\r
518 /* Yield interrupts are processed even when critical nesting is non-zero. */
\r
519 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
\r
520 ulPendingInterrupts |= ( 1 << ulInterruptNumber );
\r
522 /* The simulated interrupt is now held pending, but don't actually process it
\r
523 yet if this call is within a critical section. It is possible for this to
\r
524 be in a critical section as calls to wait for mutexes are accumulative. */
\r
525 if( ulCriticalNesting == 0 )
\r
527 SetEvent( pvInterruptEvent );
\r
530 ReleaseMutex( pvInterruptEventMutex );
\r
533 /*-----------------------------------------------------------*/
\r
535 void vPortSetInterruptHandler( uint32_t ulInterruptNumber, uint32_t (*pvHandler)( void ) )
\r
537 if( ulInterruptNumber < portMAX_INTERRUPTS )
\r
539 if( pvInterruptEventMutex != NULL )
\r
541 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
\r
542 ulIsrHandler[ ulInterruptNumber ] = pvHandler;
\r
543 ReleaseMutex( pvInterruptEventMutex );
\r
547 ulIsrHandler[ ulInterruptNumber ] = pvHandler;
\r
551 /*-----------------------------------------------------------*/
\r
553 void vPortEnterCritical( void )
\r
555 if( xPortRunning == pdTRUE )
\r
557 /* The interrupt event mutex is held for the entire critical section,
\r
558 effectively disabling (simulated) interrupts. */
\r
559 WaitForSingleObject( pvInterruptEventMutex, INFINITE );
\r
560 ulCriticalNesting++;
\r
564 ulCriticalNesting++;
\r
567 /*-----------------------------------------------------------*/
\r
569 void vPortExitCritical( void )
\r
571 int32_t lMutexNeedsReleasing;
\r
573 /* The interrupt event mutex should already be held by this thread as it was
\r
574 obtained on entry to the critical section. */
\r
576 lMutexNeedsReleasing = pdTRUE;
\r
578 if( ulCriticalNesting > portNO_CRITICAL_NESTING )
\r
580 if( ulCriticalNesting == ( portNO_CRITICAL_NESTING + 1 ) )
\r
582 ulCriticalNesting--;
\r
584 /* Were any interrupts set to pending while interrupts were
\r
585 (simulated) disabled? */
\r
586 if( ulPendingInterrupts != 0UL )
\r
588 configASSERT( xPortRunning );
\r
589 SetEvent( pvInterruptEvent );
\r
591 /* Mutex will be released now, so does not require releasing
\r
592 on function exit. */
\r
593 lMutexNeedsReleasing = pdFALSE;
\r
594 ReleaseMutex( pvInterruptEventMutex );
\r
599 /* Tick interrupts will still not be processed as the critical
\r
600 nesting depth will not be zero. */
\r
601 ulCriticalNesting--;
\r
605 if( pvInterruptEventMutex != NULL )
\r
607 if( lMutexNeedsReleasing == pdTRUE )
\r
609 configASSERT( xPortRunning );
\r
610 ReleaseMutex( pvInterruptEventMutex );
\r
614 /*-----------------------------------------------------------*/
\r