git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/ARM_CM3/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel V10.2.1\r
   3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 \r
  29 #ifndef PORTMACRO_H\r
  30 #define PORTMACRO_H\r
  31 \r
  32 #ifdef __cplusplus\r
  33 extern "C" {\r
  34 #endif\r
  35 \r
  36 /*-----------------------------------------------------------\r
  37  * Port specific definitions.\r
  38  *\r
  39  * The settings in this file configure FreeRTOS correctly for the\r
  40  * given hardware and compiler.\r
  41  *\r
  42  * These settings should not be altered.\r
  43  *-----------------------------------------------------------\r
  44  */\r
  45 \r
  46 /* Type definitions. */\r
  47 #define portCHAR                char\r
  48 #define portFLOAT               float\r
  49 #define portDOUBLE              double\r
  50 #define portLONG                long\r
  51 #define portSHORT               short\r
  52 #define portSTACK_TYPE  uint32_t\r
  53 #define portBASE_TYPE   long\r
  54 \r
  55 typedef portSTACK_TYPE StackType_t;\r
  56 typedef long BaseType_t;\r
  57 typedef unsigned long UBaseType_t;\r
  58 \r
  59 #if( configUSE_16_BIT_TICKS == 1 )\r
  60         typedef uint16_t TickType_t;\r
  61         #define portMAX_DELAY ( TickType_t ) 0xffff\r
  62 #else\r
  63         typedef uint32_t TickType_t;\r
  64         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
  65 \r
  66         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  67         not need to be guarded with a critical section. */\r
  68         #define portTICK_TYPE_IS_ATOMIC 1\r
  69 #endif\r
  70 /*-----------------------------------------------------------*/\r
  71 \r
  72 /* Architecture specifics. */\r
  73 #define portSTACK_GROWTH                        ( -1 )\r
  74 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  75 #define portBYTE_ALIGNMENT                      8\r
  76 /*-----------------------------------------------------------*/\r
  77 \r
  78 /* Scheduler utilities. */\r
  79 #define portYIELD()                                                                                                                     \\r
  80 {                                                                                                                                                               \\r
  81         /* Set a PendSV to request a context switch. */                                                         \\r
  82         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;                                                         \\r
  83                                                                                                                                                                 \\r
  84         /* Barriers are normally not required but do ensure the code is completely      \\r
  85         within the specified behaviour for the architecture. */                                         \\r
  86         __asm volatile( "dsb" ::: "memory" );                                                                           \\r
  87         __asm volatile( "isb" );                                                                                                        \\r
  88 }\r
  89 \r
  90 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
  91 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )\r
  92 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired != pdFALSE ) portYIELD()\r
  93 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 /* Critical section management. */\r
  97 extern void vPortEnterCritical( void );\r
  98 extern void vPortExitCritical( void );\r
  99 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortRaiseBASEPRI()\r
 100 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortSetBASEPRI(x)\r
 101 #define portDISABLE_INTERRUPTS()                                vPortRaiseBASEPRI()\r
 102 #define portENABLE_INTERRUPTS()                                 vPortSetBASEPRI(0)\r
 103 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 104 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 105 \r
 106 /*-----------------------------------------------------------*/\r
 107 \r
 108 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 109 not necessary for to use this port.  They are defined so the common demo files\r
 110 (which build with all the ports) will build. */\r
 111 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 112 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 113 /*-----------------------------------------------------------*/\r
 114 \r
 115 /* Tickless idle/low power functionality. */\r
 116 #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 117         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 118         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 119 #endif\r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 /* Architecture specific optimisations. */\r
 123 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 124         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 125 #endif\r
 126 \r
 127 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 128 \r
 129         /* Generic helper function. */\r
 130         __attribute__( ( always_inline ) ) static inline uint8_t ucPortCountLeadingZeros( uint32_t ulBitmap )\r
 131         {\r
 132         uint8_t ucReturn;\r
 133 \r
 134                 __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) : "memory" );\r
 135                 return ucReturn;\r
 136         }\r
 137 \r
 138         /* Check the configuration. */\r
 139         #if( configMAX_PRIORITIES > 32 )\r
 140                 #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
 141         #endif\r
 142 \r
 143         /* Store/clear the ready priorities in a bit map. */\r
 144         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 145         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 146 \r
 147         /*-----------------------------------------------------------*/\r
 148 \r
 149         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )\r
 150 \r
 151 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 152 \r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 #ifdef configASSERT\r
 156         void vPortValidateInterruptPriority( void );\r
 157         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()\r
 158 #endif\r
 159 \r
 160 /* portNOP() is not required by this port. */\r
 161 #define portNOP()\r
 162 \r
 163 #define portINLINE      __inline\r
 164 \r
 165 #ifndef portFORCE_INLINE\r
 166         #define portFORCE_INLINE inline __attribute__(( always_inline))\r
 167 #endif\r
 168 \r
 169 portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )\r
 170 {\r
 171 uint32_t ulCurrentInterrupt;\r
 172 BaseType_t xReturn;\r
 173 \r
 174         /* Obtain the number of the currently executing interrupt. */\r
 175         __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) :: "memory" );\r
 176 \r
 177         if( ulCurrentInterrupt == 0 )\r
 178         {\r
 179                 xReturn = pdFALSE;\r
 180         }\r
 181         else\r
 182         {\r
 183                 xReturn = pdTRUE;\r
 184         }\r
 185 \r
 186         return xReturn;\r
 187 }\r
 188 \r
 189 /*-----------------------------------------------------------*/\r
 190 \r
 191 portFORCE_INLINE static void vPortRaiseBASEPRI( void )\r
 192 {\r
 193 uint32_t ulNewBASEPRI;\r
 194 \r
 195         __asm volatile\r
 196         (\r
 197                 "       mov %0, %1                                                                                              \n" \\r
 198                 "       msr basepri, %0                                                                                 \n" \\r
 199                 "       isb                                                                                                             \n" \\r
 200                 "       dsb                                                                                                             \n" \\r
 201                 :"=r" (ulNewBASEPRI) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) : "memory"\r
 202         );\r
 203 }\r
 204 \r
 205 /*-----------------------------------------------------------*/\r
 206 \r
 207 portFORCE_INLINE static uint32_t ulPortRaiseBASEPRI( void )\r
 208 {\r
 209 uint32_t ulOriginalBASEPRI, ulNewBASEPRI;\r
 210 \r
 211         __asm volatile\r
 212         (\r
 213                 "       mrs %0, basepri                                                                                 \n" \\r
 214                 "       mov %1, %2                                                                                              \n" \\r
 215                 "       msr basepri, %1                                                                                 \n" \\r
 216                 "       isb                                                                                                             \n" \\r
 217                 "       dsb                                                                                                             \n" \\r
 218                 :"=r" (ulOriginalBASEPRI), "=r" (ulNewBASEPRI) : "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) : "memory"\r
 219         );\r
 220 \r
 221         /* This return will not be reached but is necessary to prevent compiler\r
 222         warnings. */\r
 223         return ulOriginalBASEPRI;\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 portFORCE_INLINE static void vPortSetBASEPRI( uint32_t ulNewMaskValue )\r
 228 {\r
 229         __asm volatile\r
 230         (\r
 231                 "       msr basepri, %0 " :: "r" ( ulNewMaskValue ) : "memory"\r
 232         );\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 #define portMEMORY_BARRIER() __asm volatile( "" ::: "memory" )\r
 237 \r
 238 #ifdef __cplusplus\r
 239 }\r
 240 #endif\r
 241 \r
 242 #endif /* PORTMACRO_H */\r
 243 \r