begriffs open source - freertos/blob - portable/RVDS/ARM_CM3/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>\r
   3  * Copyright (C) 2021 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  * https://www.FreeRTOS.org\r
  23  * https://github.com/FreeRTOS\r
  24  *\r
  25  */\r
  26 \r
  27 \r
  28 #ifndef PORTMACRO_H\r
  29 #define PORTMACRO_H\r
  30 \r
  31 /* *INDENT-OFF* */\r
  32 #ifdef __cplusplus\r
  33     extern "C" {\r
  34 #endif\r
  35 /* *INDENT-ON* */\r
  36 \r
  37 /*-----------------------------------------------------------\r
  38  * Port specific definitions.\r
  39  *\r
  40  * The settings in this file configure FreeRTOS correctly for the\r
  41  * given hardware and compiler.\r
  42  *\r
  43  * These settings should not be altered.\r
  44  *-----------------------------------------------------------\r
  45  */\r
  46 \r
  47 /* Type definitions. */\r
  48     #define portCHAR          char\r
  49     #define portFLOAT         float\r
  50     #define portDOUBLE        double\r
  51     #define portLONG          long\r
  52     #define portSHORT         short\r
  53     #define portSTACK_TYPE    uint32_t\r
  54     #define portBASE_TYPE     long\r
  55 \r
  56     typedef portSTACK_TYPE   StackType_t;\r
  57     typedef long             BaseType_t;\r
  58     typedef unsigned long    UBaseType_t;\r
  59 \r
  60     #if ( configUSE_16_BIT_TICKS == 1 )\r
  61         typedef uint16_t     TickType_t;\r
  62         #define portMAX_DELAY              ( TickType_t ) 0xffff\r
  63     #else\r
  64         typedef uint32_t     TickType_t;\r
  65         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL\r
  66 \r
  67 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  68  * not need to be guarded with a critical section. */\r
  69         #define portTICK_TYPE_IS_ATOMIC    1\r
  70     #endif\r
  71 /*-----------------------------------------------------------*/\r
  72 \r
  73 /* Architecture specifics. */\r
  74     #define portSTACK_GROWTH          ( -1 )\r
  75     #define portTICK_PERIOD_MS        ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  76     #define portBYTE_ALIGNMENT        8\r
  77 \r
  78 /* Constants used with memory barrier intrinsics. */\r
  79     #define portSY_FULL_READ_WRITE    ( 15 )\r
  80 \r
  81 /*-----------------------------------------------------------*/\r
  82 \r
  83 /* Scheduler utilities. */\r
  84     #define portYIELD()                                 \\r
  85     {                                                   \\r
  86         /* Set a PendSV to request a context switch. */ \\r
  87         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \\r
  88                                                         \\r
  89         /* Barriers are normally not required but do ensure the code is completely \\r
  90          * within the specified behaviour for the architecture. */ \\r
  91         __dsb( portSY_FULL_READ_WRITE );                           \\r
  92         __isb( portSY_FULL_READ_WRITE );                           \\r
  93     }\r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )\r
  97     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )\r
  98     #define portEND_SWITCHING_ISR( xSwitchRequired )    do { if( xSwitchRequired != pdFALSE ) portYIELD(); } while( 0 )\r
  99     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )\r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 /* Critical section management. */\r
 103     extern void vPortEnterCritical( void );\r
 104     extern void vPortExitCritical( void );\r
 105 \r
 106     #define portDISABLE_INTERRUPTS()                  vPortRaiseBASEPRI()\r
 107     #define portENABLE_INTERRUPTS()                   vPortSetBASEPRI( 0 )\r
 108     #define portENTER_CRITICAL()                      vPortEnterCritical()\r
 109     #define portEXIT_CRITICAL()                       vPortExitCritical()\r
 110     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulPortRaiseBASEPRI()\r
 111     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vPortSetBASEPRI( x )\r
 112 \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 /* Port 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 /* Check the configuration. */\r
 130         #if ( configMAX_PRIORITIES > 32 )\r
 131             #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
 132         #endif\r
 133 \r
 134 /* Store/clear the ready priorities in a bit map. */\r
 135         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities )    ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 136         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities )     ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 137 \r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31UL - ( uint32_t ) __clz( ( uxReadyPriorities ) ) )\r
 141 \r
 142     #endif /* taskRECORD_READY_PRIORITY */\r
 143 /*-----------------------------------------------------------*/\r
 144 \r
 145 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 146  * not necessary for to use this port.  They are defined so the common demo files\r
 147  * (which build with all the ports) will build. */\r
 148     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )\r
 149     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )\r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152     #ifdef configASSERT\r
 153         void vPortValidateInterruptPriority( void );\r
 154         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()\r
 155     #endif\r
 156 \r
 157 /* portNOP() is not required by this port. */\r
 158     #define portNOP()\r
 159 \r
 160     #define portINLINE              __inline\r
 161 \r
 162     #ifndef portFORCE_INLINE\r
 163         #define portFORCE_INLINE    __forceinline\r
 164     #endif\r
 165 \r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168     static portFORCE_INLINE void vPortSetBASEPRI( uint32_t ulBASEPRI )\r
 169     {\r
 170         __asm\r
 171         {\r
 172             /* Barrier instructions are not used as this function is only used to\r
 173              * lower the BASEPRI value. */\r
 174 /* *INDENT-OFF* */\r
 175             msr basepri, ulBASEPRI\r
 176 /* *INDENT-ON* */\r
 177         }\r
 178     }\r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181     static portFORCE_INLINE void vPortRaiseBASEPRI( void )\r
 182     {\r
 183         uint32_t ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 184 \r
 185         __asm\r
 186         {\r
 187             /* Set BASEPRI to the max syscall priority to effect a critical\r
 188              * section. */\r
 189 /* *INDENT-OFF* */\r
 190             msr basepri, ulNewBASEPRI\r
 191             dsb\r
 192             isb\r
 193 /* *INDENT-ON* */\r
 194         }\r
 195     }\r
 196 /*-----------------------------------------------------------*/\r
 197 \r
 198     static portFORCE_INLINE void vPortClearBASEPRIFromISR( void )\r
 199     {\r
 200         __asm\r
 201         {\r
 202             /* Set BASEPRI to 0 so no interrupts are masked.  This function is only\r
 203              * used to lower the mask in an interrupt, so memory barriers are not\r
 204              * used. */\r
 205 /* *INDENT-OFF* */\r
 206             msr basepri, # 0\r
 207 /* *INDENT-ON* */\r
 208         }\r
 209     }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212     static portFORCE_INLINE uint32_t ulPortRaiseBASEPRI( void )\r
 213     {\r
 214         uint32_t ulReturn, ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 215 \r
 216         __asm\r
 217         {\r
 218             /* Set BASEPRI to the max syscall priority to effect a critical\r
 219              * section. */\r
 220 /* *INDENT-OFF* */\r
 221             mrs ulReturn, basepri\r
 222             msr basepri, ulNewBASEPRI\r
 223             dsb\r
 224             isb\r
 225 /* *INDENT-ON* */\r
 226         }\r
 227 \r
 228         return ulReturn;\r
 229     }\r
 230 /*-----------------------------------------------------------*/\r
 231 \r
 232     static portFORCE_INLINE BaseType_t xPortIsInsideInterrupt( void )\r
 233     {\r
 234         uint32_t ulCurrentInterrupt;\r
 235         BaseType_t xReturn;\r
 236 \r
 237         /* Obtain the number of the currently executing interrupt. */\r
 238         __asm\r
 239         {\r
 240 /* *INDENT-OFF* */\r
 241             mrs ulCurrentInterrupt, ipsr\r
 242 /* *INDENT-ON* */\r
 243         }\r
 244 \r
 245         if( ulCurrentInterrupt == 0 )\r
 246         {\r
 247             xReturn = pdFALSE;\r
 248         }\r
 249         else\r
 250         {\r
 251             xReturn = pdTRUE;\r
 252         }\r
 253 \r
 254         return xReturn;\r
 255     }\r
 256 \r
 257 \r
 258 /* *INDENT-OFF* */\r
 259 #ifdef __cplusplus\r
 260     }\r
 261 #endif\r
 262 /* *INDENT-ON* */\r
 263 \r
 264 #endif /* PORTMACRO_H */\r