git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/RVDS/ARM_CM4F/portmacro.h

   1 /*\r
   2     FreeRTOS V7.6.0 - Copyright (C) 2013 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 \r
  67 #ifndef PORTMACRO_H\r
  68 #define PORTMACRO_H\r
  69 \r
  70 #ifdef __cplusplus\r
  71 extern "C" {\r
  72 #endif\r
  73 \r
  74 /*-----------------------------------------------------------\r
  75  * Port specific definitions.\r
  76  *\r
  77  * The settings in this file configure FreeRTOS correctly for the\r
  78  * given hardware and compiler.\r
  79  *\r
  80  * These settings should not be altered.\r
  81  *-----------------------------------------------------------\r
  82  */\r
  83 \r
  84 /* Type definitions. */\r
  85 #define portCHAR                char\r
  86 #define portFLOAT               float\r
  87 #define portDOUBLE              double\r
  88 #define portLONG                long\r
  89 #define portSHORT               short\r
  90 #define portSTACK_TYPE  uint32_t\r
  91 #define portBASE_TYPE   long\r
  92 \r
  93 typedef portSTACK_TYPE StackType_t;\r
  94 typedef long BaseType_t;\r
  95 typedef unsigned long UBaseType_t;\r
  96 \r
  97 #if( configUSE_16_BIT_TICKS == 1 )\r
  98         typedef uint16_t TickType_t;\r
  99         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 100 #else\r
 101         typedef uint32_t TickType_t;\r
 102         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 103 #endif\r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 /* Architecture specifics. */\r
 107 #define portSTACK_GROWTH                        ( -1 )\r
 108 #define portTICK_RATE_MS                        ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 109 #define portBYTE_ALIGNMENT                      8\r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112 /* Scheduler utilities. */\r
 113 extern void vPortYield( void );\r
 114 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
 115 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )\r
 116 #define portYIELD()                                     vPortYield()\r
 117 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT\r
 118 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 119 /*-----------------------------------------------------------*/\r
 120 \r
 121 /* Critical section management. */\r
 122 extern uint32_t ulPortSetInterruptMask( void );\r
 123 extern void vPortClearInterruptMask( uint32_t ulNewMask );\r
 124 extern void vPortEnterCritical( void );\r
 125 extern void vPortExitCritical( void );\r
 126 \r
 127 #define portDISABLE_INTERRUPTS()                                ulPortSetInterruptMask()\r
 128 #define portENABLE_INTERRUPTS()                                 vPortClearInterruptMask( 0 )\r
 129 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 130 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 131 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 132 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask(x)\r
 133 \r
 134 /*-----------------------------------------------------------*/\r
 135 \r
 136 /* Tickless idle/low power functionality. */\r
 137 #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 138         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 139         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 140 #endif\r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 /* Port specific optimisations. */\r
 144 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 145 \r
 146         /* Check the configuration. */\r
 147         #if( configMAX_PRIORITIES > 32 )\r
 148                 #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32.  It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.\r
 149         #endif\r
 150 \r
 151         /* Store/clear the ready priorities in a bit map. */\r
 152         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 153         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 154 \r
 155         /*-----------------------------------------------------------*/\r
 156 \r
 157         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( ( uxReadyPriorities ) ) )\r
 158 \r
 159 #endif /* taskRECORD_READY_PRIORITY */\r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 163 not necessary for to use this port.  They are defined so the common demo files\r
 164 (which build with all the ports) will build. */\r
 165 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 166 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 #ifdef configASSERT\r
 170         void vPortValidateInterruptPriority( void );\r
 171         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 172 #endif\r
 173 \r
 174 /* portNOP() is not required by this port. */\r
 175 #define portNOP()\r
 176 \r
 177 #ifdef __cplusplus\r
 178 }\r
 179 #endif\r
 180 \r
 181 #endif /* PORTMACRO_H */\r
 182 \r