git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A9_Cyclone_V_SoC_DK/FreeRTOSConfig.h

   1 /*\r
   2     FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \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
  12 \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
  19 \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
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\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
  31      *                                                                       *\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
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \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
  42 \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
  46 \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
  51 \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
  55 \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
  58 \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
  62 \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
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 #ifndef FREERTOS_CONFIG_H\r
  71 #define FREERTOS_CONFIG_H\r
  72 \r
  73 /* Altera library includes. */\r
  74 #include "alt_timers.h"\r
  75 #include "alt_interrupt.h"\r
  76 #include "alt_globaltmr.h"\r
  77 \r
  78 /*-----------------------------------------------------------\r
  79  * Application specific definitions.\r
  80  *\r
  81  * These definitions should be adjusted for your particular hardware and\r
  82  * application requirements.\r
  83  *\r
  84  * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE\r
  85  * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.\r
  86  *\r
  87  * See http://www.freertos.org/a00110.html for a full list of configuration\r
  88  * options.\r
  89  *----------------------------------------------------------*/\r
  90 \r
  91 /*\r
  92  * The FreeRTOS Cortex-A port implements a full interrupt nesting model.\r
  93  *\r
  94  * Interrupts that are assigned a priority at or below\r
  95  * configMAX_API_CALL_INTERRUPT_PRIORITY (which counter-intuitively in the ARM\r
  96  * generic interrupt controller [GIC] means a priority that has a numerical\r
  97  * value above configMAX_API_CALL_INTERRUPT_PRIORITY) can call interrupt safe\r
  98  * FreeRTOS API functions and will nest.\r
  99  *\r
 100  * Interrupts that are assigned a priority above\r
 101  * configMAX_API_CALL_INTERRUPT_PRIORITY (which in the GIC means a numerical\r
 102  * value below configMAX_API_CALL_INTERRUPT_PRIORITY) cannot call any FreeRTOS\r
 103  * API functions, will nest, and will not be masked by FreeRTOS critical\r
 104  * sections (although it is necessary for interrupts to be globally disabled\r
 105  * extremely briefly as the interrupt mask is updated in the GIC).\r
 106  *\r
 107  * FreeRTOS functions that can be called from an interrupt are those that end in\r
 108  * "FromISR".  FreeRTOS maintains a separate interrupt safe API to enable\r
 109  * interrupt entry to be shorter, faster, simpler and smaller.\r
 110  *\r
 111  * The Cyclone V SoC implements 32 unique interrupt priorities.  For the\r
 112  * purpose of setting configMAX_API_CALL_INTERRUPT_PRIORITY 32 represents the\r
 113  * lowest priority.\r
 114  */\r
 115 #define configMAX_API_CALL_INTERRUPT_PRIORITY   18\r
 116 \r
 117 /* The application will define the array used as the RTOS heap to ensure it can\r
 118 be located in the (faster) on-chip RAM.  When this parameter is set to 1 the\r
 119 application must define an array using the name and size as follows below, but\r
 120 is free to locate the array in any suitable RAM region (the faster the better as\r
 121 the stacks used by the tasks are allocated from this array):\r
 122 \r
 123 uint8_t ucHeap[ configTOTAL_HEAP_SIZE ];\r
 124 \r
 125 */\r
 126 #define configAPPLICATION_ALLOCATED_HEAP                1\r
 127 \r
 128 #define configCPU_CLOCK_HZ                                              /* Not used in this demo. */\r
 129 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 130 #define configUSE_TICKLESS_IDLE                                 0\r
 131 #define configTICK_RATE_HZ                                              ( ( TickType_t ) 1000 )\r
 132 #define configUSE_PREEMPTION                                    1\r
 133 #define configMAX_PRIORITIES                                    ( 7 )\r
 134 #define configMINIMAL_STACK_SIZE                                ( ( unsigned short ) 200 )\r
 135 #define configTOTAL_HEAP_SIZE                                   ( 50 * 1024 )\r
 136 #define configMAX_TASK_NAME_LEN                                 ( 10 )\r
 137 #define configUSE_TRACE_FACILITY                                1\r
 138 #define configUSE_16_BIT_TICKS                                  0\r
 139 #define configIDLE_SHOULD_YIELD                                 1\r
 140 #define configUSE_MUTEXES                                               1\r
 141 #define configQUEUE_REGISTRY_SIZE                               8\r
 142 #define configCHECK_FOR_STACK_OVERFLOW                  2\r
 143 #define configUSE_RECURSIVE_MUTEXES                             1\r
 144 #define configUSE_APPLICATION_TASK_TAG                  0\r
 145 #define configUSE_COUNTING_SEMAPHORES                   1\r
 146 #define configUSE_QUEUE_SETS                                    1\r
 147 \r
 148 /* Hook/Callback related definitions. */\r
 149 #define configUSE_MALLOC_FAILED_HOOK                    1\r
 150 #define configUSE_IDLE_HOOK                                             1\r
 151 #define configUSE_TICK_HOOK                                             1\r
 152 #define configUSE_DAEMON_TASK_STARTUP_HOOK              1\r
 153 \r
 154 /* Co-routine definitions. */\r
 155 #define configUSE_CO_ROUTINES                                   0\r
 156 #define configMAX_CO_ROUTINE_PRIORITIES                 ( 2 )\r
 157 \r
 158 /* Software timer definitions. */\r
 159 #define configUSE_TIMERS                                                1\r
 160 #define configTIMER_TASK_PRIORITY                               ( configMAX_PRIORITIES - 1 )\r
 161 #define configTIMER_QUEUE_LENGTH                                5\r
 162 #define configTIMER_TASK_STACK_DEPTH                    ( configMINIMAL_STACK_SIZE * 2 )\r
 163 \r
 164 /* Set the following definitions to 1 to include the API function, or zero\r
 165 to exclude the API function. */\r
 166 #define INCLUDE_vTaskPrioritySet                                1\r
 167 #define INCLUDE_uxTaskPriorityGet                               1\r
 168 #define INCLUDE_vTaskDelete                                             1\r
 169 #define INCLUDE_vTaskCleanUpResources                   1\r
 170 #define INCLUDE_vTaskSuspend                                    1\r
 171 #define INCLUDE_vTaskDelayUntil                                 1\r
 172 #define INCLUDE_vTaskDelay                                              1\r
 173 #define INCLUDE_xTimerPendFunctionCall                  1\r
 174 #define INCLUDE_eTaskGetState                                   1\r
 175 \r
 176 /* This demo makes use of one or more example stats formatting functions.  These\r
 177 format the raw data provided by the uxTaskGetSystemState() function in to human\r
 178 readable ASCII form.  See the notes in the implementation of vTaskList() within\r
 179 FreeRTOS/Source/tasks.c for limitations. */\r
 180 #define configUSE_STATS_FORMATTING_FUNCTIONS    1\r
 181 \r
 182 /* Run time stats related definitions. */\r
 183 #define configGENERATE_RUN_TIME_STATS 1\r
 184 #define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() alt_globaltmr_start()\r
 185 #define portGET_RUN_TIME_COUNTER_VALUE()  ( ( uint32_t ) ( alt_globaltmr_get64() >> ( uint64_t ) 16 ) )\r
 186 \r
 187 \r
 188 /* The size of the global output buffer that is available for use when there\r
 189 are multiple command interpreters running at once (for example, one on a UART\r
 190 and one on TCP/IP).  This is done to prevent an output buffer being defined by\r
 191 each implementation - which would waste RAM.  In this case, there is only one\r
 192 command interpreter running. */\r
 193 #define configCOMMAND_INT_MAX_OUTPUT_SIZE 2096\r
 194 \r
 195 /* Normal assert() semantics without relying on the provision of an assert.h\r
 196 header file. */\r
 197 void vAssertCalled( const char * pcFile, unsigned long ulLine );\r
 198 #define configASSERT( x ) if( ( x ) == 0 ) vAssertCalled( __FILE__, __LINE__ );\r
 199 \r
 200 /* If configTASK_RETURN_ADDRESS is not defined then a task that attempts to\r
 201 return from its implementing function will end up in a "task exit error"\r
 202 function - which contains a call to configASSERT().  However this can give GCC\r
 203 some problems when it tries to unwind the stack, as the exit error function has\r
 204 nothing to return to.  To avoid this define configTASK_RETURN_ADDRESS to 0.  */\r
 205 #define configTASK_RETURN_ADDRESS       NULL\r
 206 \r
 207 \r
 208 /****** Hardware specific settings. *******************************************/\r
 209 \r
 210  typedef struct INT_DISPATCH_s\r
 211  {\r
 212      alt_int_callback_t pxISR;\r
 213      void *             pvContext;\r
 214  }\r
 215  INT_DISPATCH_t;\r
 216 \r
 217 void vRegisterIRQHandler( uint32_t ulID, alt_int_callback_t pxHandlerFunction, void *pvContext );\r
 218 void vApplicationIRQHandler( uint32_t ulICCIAR );\r
 219 \r
 220 /*\r
 221  * The application must provide a function that configures a peripheral to\r
 222  * create the FreeRTOS tick interrupt, then define configSETUP_TICK_INTERRUPT()\r
 223  * in FreeRTOSConfig.h to call the function.  This file contains a function\r
 224  * that is suitable for use on the Zynq MPU.  FreeRTOS_Tick_Handler() must\r
 225  * be installed as the peripheral's interrupt handler.\r
 226  */\r
 227 void vConfigureTickInterrupt( void );\r
 228 #define configSETUP_TICK_INTERRUPT() vConfigureTickInterrupt();\r
 229 \r
 230 void vClearTickInterrupt( void );\r
 231 #define configCLEAR_TICK_INTERRUPT() alt_gpt_int_clear_pending( ALT_GPT_CPU_PRIVATE_TMR );\r
 232 \r
 233 /* The following constant describe the hardware, and are correct for the\r
 234 Cyclone V SoC. */\r
 235 #define configINTERRUPT_CONTROLLER_BASE_ADDRESS                 ( 0xFFFED000 )\r
 236 #define configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET ( -0xf00 )\r
 237 #define configUNIQUE_INTERRUPT_PRIORITIES                               32\r
 238 \r
 239 #endif /* FREERTOS_CONFIG_H */\r
 240 \r