/* | |
FreeRTOS V9.0.1 - Copyright (C) 2017 Real Time Engineers Ltd. | |
All rights reserved | |
VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION. | |
This file is part of the FreeRTOS distribution. | |
FreeRTOS is free software; you can redistribute it and/or modify it under | |
the terms of the GNU General Public License (version 2) as published by the | |
Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception. | |
*************************************************************************** | |
>>! NOTE: The modification to the GPL is included to allow you to !<< | |
>>! distribute a combined work that includes FreeRTOS without being !<< | |
>>! obliged to provide the source code for proprietary components !<< | |
>>! outside of the FreeRTOS kernel. !<< | |
*************************************************************************** | |
FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY | |
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | |
FOR A PARTICULAR PURPOSE. Full license text is available on the following | |
link: http://www.freertos.org/a00114.html | |
*************************************************************************** | |
* * | |
* FreeRTOS provides completely free yet professionally developed, * | |
* robust, strictly quality controlled, supported, and cross * | |
* platform software that is more than just the market leader, it * | |
* is the industry's de facto standard. * | |
* * | |
* Help yourself get started quickly while simultaneously helping * | |
* to support the FreeRTOS project by purchasing a FreeRTOS * | |
* tutorial book, reference manual, or both: * | |
* http://www.FreeRTOS.org/Documentation * | |
* * | |
*************************************************************************** | |
http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading | |
the FAQ page "My application does not run, what could be wrong?". Have you | |
defined configASSERT()? | |
http://www.FreeRTOS.org/support - In return for receiving this top quality | |
embedded software for free we request you assist our global community by | |
participating in the support forum. | |
http://www.FreeRTOS.org/training - Investing in training allows your team to | |
be as productive as possible as early as possible. Now you can receive | |
FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers | |
Ltd, and the world's leading authority on the world's leading RTOS. | |
http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products, | |
including FreeRTOS+Trace - an indispensable productivity tool, a DOS | |
compatible FAT file system, and our tiny thread aware UDP/IP stack. | |
http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate. | |
Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS. | |
http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High | |
Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS | |
licenses offer ticketed support, indemnification and commercial middleware. | |
http://www.SafeRTOS.com - High Integrity Systems also provide a safety | |
engineered and independently SIL3 certified version for use in safety and | |
mission critical applications that require provable dependability. | |
1 tab == 4 spaces! | |
*/ | |
/****************************************************************************** | |
* This project provides two demo applications. A simple blinky style project, | |
* and a more comprehensive test and demo application. The | |
* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is used to select between the two. | |
* The simply blinky demo is implemented and described in main_blinky.c. The | |
* more comprehensive test and demo application is implemented and described in | |
* main_full.c. | |
* | |
* This file implements the code that is not demo specific, including the | |
* hardware setup and FreeRTOS hook functions. | |
* | |
******************************************************************************* | |
* -NOTE- The Win32 port is a simulation (or is that emulation?) only! Do not | |
* expect to get real time behaviour from the Win32 port or this demo | |
* application. It is provided as a convenient development and demonstration | |
* test bed only. This was tested using Windows XP on a dual core laptop. | |
* | |
* Windows will not be running the FreeRTOS simulator threads continuously, so | |
* the timing information in the FreeRTOS+Trace logs have no meaningful units. | |
* See the documentation page for the Windows simulator for an explanation of | |
* the slow timing: | |
* http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html | |
* - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT - | |
******************************************************************************* | |
* | |
*/ | |
/* Standard includes. */ | |
#include <stdio.h> | |
#include <stdlib.h> | |
#include <conio.h> | |
/* FreeRTOS kernel includes. */ | |
#include "FreeRTOS.h" | |
#include "task.h" | |
/* This project provides two demo applications. A simple blinky style project, | |
and a more comprehensive test and demo application. The | |
mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is used to select between the two. | |
The simply blinky demo is implemented and described in main_blinky.c. The more | |
comprehensive test and demo application is implemented and described in | |
main_full.c. */ | |
#define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY 1 | |
/* This demo uses heap_5.c, and these constants define the sizes of the regions | |
that make up the total heap. This is only done to provide an example of heap_5 | |
being used as this demo could easily create one large heap region instead of | |
multiple smaller heap regions - in which case heap_4.c would be the more | |
appropriate choice. */ | |
#define mainREGION_1_SIZE 7001 | |
#define mainREGION_2_SIZE 18105 | |
#define mainREGION_3_SIZE 2807 | |
/* | |
* main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1. | |
* main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0. | |
*/ | |
extern void main_blinky( void ); | |
extern void main_full( void ); | |
/* | |
* Some of the RTOS hook (callback) functions only need special processing when | |
* the full demo is being used. The simply blinky demo has no special | |
* requirements, so these functions are called from the hook functions defined | |
* in this file, but are defined in main_full.c. | |
*/ | |
void vFullDemoTickHookFunction( void ); | |
void vFullDemoIdleFunction( void ); | |
/* | |
* This demo uses heap_5.c, so start by defining some heap regions. This is | |
* only done to provide an example as this demo could easily create one large | |
* heap region instead of multiple smaller heap regions - in which case heap_4.c | |
* would be the more appropriate choice. No initialisation is required when | |
* heap_4.c is used. | |
*/ | |
static void prvInitialiseHeap( void ); | |
/* | |
* Prototypes for the standard FreeRTOS callback/hook functions implemented | |
* within this file. | |
*/ | |
void vApplicationMallocFailedHook( void ); | |
void vApplicationIdleHook( void ); | |
void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName ); | |
void vApplicationTickHook( void ); | |
/* | |
* Writes trace data to a disk file when the trace recording is stopped. | |
* This function will simply overwrite any trace files that already exist. | |
*/ | |
static void prvSaveTraceFile( void ); | |
/* Notes if the trace is running or not. */ | |
static BaseType_t xTraceRunning = pdTRUE; | |
/*-----------------------------------------------------------*/ | |
int main( void ) | |
{ | |
/* This demo uses heap_5.c, so start by defining some heap regions. This | |
is only done to provide an example as this demo could easily create one | |
large heap region instead of multiple smaller heap regions - in which case | |
heap_4.c would be the more appropriate choice. No initialisation is | |
required when heap_4.c is used. */ | |
prvInitialiseHeap(); | |
/* Initialise the trace recorder. Use of the trace recorder is optional. | |
See http://www.FreeRTOS.org/trace for more information. */ | |
vTraceEnable( TRC_START ); | |
/* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top | |
of this file. */ | |
#if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1 ) | |
{ | |
main_blinky(); | |
} | |
#else | |
{ | |
/* Start the trace recording - the recording is written to a file if | |
configASSERT() is called. */ | |
printf( "\r\nTrace started.\r\nThe trace will be dumped to disk if a call to configASSERT() fails.\r\n" ); | |
printf( "Uncomment the call to kbhit() in this file to also dump trace with a key press.\r\n" ); | |
uiTraceStart(); | |
main_full(); | |
} | |
#endif | |
return 0; | |
} | |
/*-----------------------------------------------------------*/ | |
void vApplicationMallocFailedHook( void ) | |
{ | |
/* vApplicationMallocFailedHook() will only be called if | |
configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h. It is a hook | |
function that will get called if a call to pvPortMalloc() fails. | |
pvPortMalloc() is called internally by the kernel whenever a task, queue, | |
timer or semaphore is created. It is also called by various parts of the | |
demo application. If heap_1.c or heap_2.c are used, then the size of the | |
heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in | |
FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used | |
to query the size of free heap space that remains (although it does not | |
provide information on how the remaining heap might be fragmented). */ | |
vAssertCalled( __LINE__, __FILE__ ); | |
} | |
/*-----------------------------------------------------------*/ | |
void vApplicationIdleHook( void ) | |
{ | |
/* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set | |
to 1 in FreeRTOSConfig.h. It will be called on each iteration of the idle | |
task. It is essential that code added to this hook function never attempts | |
to block in any way (for example, call xQueueReceive() with a block time | |
specified, or call vTaskDelay()). If the application makes use of the | |
vTaskDelete() API function (as this demo application does) then it is also | |
important that vApplicationIdleHook() is permitted to return to its calling | |
function, because it is the responsibility of the idle task to clean up | |
memory allocated by the kernel to any task that has since been deleted. */ | |
/* Uncomment the following code to allow the trace to be stopped with any | |
key press. The code is commented out by default as the kbhit() function | |
interferes with the run time behaviour. */ | |
/* | |
if( _kbhit() != pdFALSE ) | |
{ | |
if( xTraceRunning == pdTRUE ) | |
{ | |
vTraceStop(); | |
prvSaveTraceFile(); | |
xTraceRunning = pdFALSE; | |
} | |
} | |
*/ | |
#if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 ) | |
{ | |
/* Call the idle task processing used by the full demo. The simple | |
blinky demo does not use the idle task hook. */ | |
vFullDemoIdleFunction(); | |
} | |
#endif | |
} | |
/*-----------------------------------------------------------*/ | |
void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName ) | |
{ | |
( void ) pcTaskName; | |
( void ) pxTask; | |
/* Run time stack overflow checking is performed if | |
configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook | |
function is called if a stack overflow is detected. */ | |
vAssertCalled( __LINE__, __FILE__ ); | |
} | |
/*-----------------------------------------------------------*/ | |
void vApplicationTickHook( void ) | |
{ | |
/* This function will be called by each tick interrupt if | |
configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h. User code can be | |
added here, but the tick hook is called from an interrupt context, so | |
code must not attempt to block, and only the interrupt safe FreeRTOS API | |
functions can be used (those that end in FromISR()). */ | |
#if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 ) | |
{ | |
vFullDemoTickHookFunction(); | |
} | |
#endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */ | |
} | |
/*-----------------------------------------------------------*/ | |
void vAssertCalled( unsigned long ulLine, const char * const pcFileName ) | |
{ | |
static BaseType_t xPrinted = pdFALSE; | |
volatile uint32_t ulSetToNonZeroInDebuggerToContinue = 0; | |
/* Parameters are not used. */ | |
( void ) ulLine; | |
( void ) pcFileName; | |
taskENTER_CRITICAL(); | |
{ | |
/* Stop the trace recording. */ | |
if( xPrinted == pdFALSE ) | |
{ | |
xPrinted = pdTRUE; | |
if( xTraceRunning == pdTRUE ) | |
{ | |
vTraceStop(); | |
prvSaveTraceFile(); | |
} | |
} | |
/* You can step out of this function to debug the assertion by using | |
the debugger to set ulSetToNonZeroInDebuggerToContinue to a non-zero | |
value. */ | |
while( ulSetToNonZeroInDebuggerToContinue == 0 ) | |
{ | |
__asm volatile( "NOP" ); | |
__asm volatile( "NOP" ); | |
} | |
} | |
taskEXIT_CRITICAL(); | |
} | |
/*-----------------------------------------------------------*/ | |
static void prvSaveTraceFile( void ) | |
{ | |
FILE* pxOutputFile; | |
pxOutputFile = fopen( "Trace.dump", "wb"); | |
if( pxOutputFile != NULL ) | |
{ | |
fwrite( RecorderDataPtr, sizeof( RecorderDataType ), 1, pxOutputFile ); | |
fclose( pxOutputFile ); | |
printf( "\r\nTrace output saved to Trace.dump\r\n" ); | |
} | |
else | |
{ | |
printf( "\r\nFailed to create trace dump file\r\n" ); | |
} | |
} | |
/*-----------------------------------------------------------*/ | |
static void prvInitialiseHeap( void ) | |
{ | |
/* This demo uses heap_5.c, so start by defining some heap regions. This is | |
only done to provide an example as this demo could easily create one large heap | |
region instead of multiple smaller heap regions - in which case heap_4.c would | |
be the more appropriate choice. No initialisation is required when heap_4.c is | |
used. The xHeapRegions structure requires the regions to be defined in order, | |
so this just creates one big array, then populates the structure with offsets | |
into the array - with gaps in between and messy alignment just for test | |
purposes. */ | |
static uint8_t ucHeap[ configTOTAL_HEAP_SIZE ]; | |
volatile uint32_t ulAdditionalOffset = 19; /* Just to prevent 'condition is always true' warnings in configASSERT(). */ | |
const HeapRegion_t xHeapRegions[] = | |
{ | |
/* Start address with dummy offsets Size */ | |
{ ucHeap + 1, mainREGION_1_SIZE }, | |
{ ucHeap + 15 + mainREGION_1_SIZE, mainREGION_2_SIZE }, | |
{ ucHeap + 19 + mainREGION_1_SIZE + mainREGION_2_SIZE, mainREGION_3_SIZE }, | |
{ NULL, 0 } | |
}; | |
/* Sanity check that the sizes and offsets defined actually fit into the | |
array. */ | |
configASSERT( ( ulAdditionalOffset + mainREGION_1_SIZE + mainREGION_2_SIZE + mainREGION_3_SIZE ) < configTOTAL_HEAP_SIZE ); | |
vPortDefineHeapRegions( xHeapRegions ); | |
} | |
/*-----------------------------------------------------------*/ |