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

   1 /*\r
   2  * FreeRTOS Kernel V10.4.3\r
   3  * Copyright (C) 2020 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  * 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 /* Constants used with memory barrier intrinsics. */\r
  78     #define portSY_FULL_READ_WRITE    ( 15 )\r
  79 \r
  80 /*-----------------------------------------------------------*/\r
  81 \r
  82 /* Scheduler utilities. */\r
  83     #define portYIELD()                                 \\r
  84     {                                                   \\r
  85         /* Set a PendSV to request a context switch. */ \\r
  86         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \\r
  87                                                         \\r
  88         /* Barriers are normally not required but do ensure the code is completely \\r
  89          * within the specified behaviour for the architecture. */ \\r
  90         __dsb( portSY_FULL_READ_WRITE );                           \\r
  91         __isb( portSY_FULL_READ_WRITE );                           \\r
  92     }\r
  93 /*-----------------------------------------------------------*/\r
  94 \r
  95     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )\r
  96     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )\r
  97     #define portEND_SWITCHING_ISR( xSwitchRequired )    if( xSwitchRequired != pdFALSE ) portYIELD()\r
  98     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )\r
  99 /*-----------------------------------------------------------*/\r
 100 \r
 101 /* Critical section management. */\r
 102     extern void vPortEnterCritical( void );\r
 103     extern void vPortExitCritical( void );\r
 104 \r
 105     #define portDISABLE_INTERRUPTS()                  vPortRaiseBASEPRI()\r
 106     #define portENABLE_INTERRUPTS()                   vPortSetBASEPRI( 0 )\r
 107     #define portENTER_CRITICAL()                      vPortEnterCritical()\r
 108     #define portEXIT_CRITICAL()                       vPortExitCritical()\r
 109     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulPortRaiseBASEPRI()\r
 110     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vPortSetBASEPRI( x )\r
 111 \r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 /* Tickless idle/low power functionality. */\r
 115     #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 116         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 117         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 118     #endif\r
 119 /*-----------------------------------------------------------*/\r
 120 \r
 121 /* Port specific optimisations. */\r
 122     #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 123         #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1\r
 124     #endif\r
 125 \r
 126     #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 127 \r
 128 /* Check the configuration. */\r
 129         #if ( configMAX_PRIORITIES > 32 )\r
 130             #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
 131         #endif\r
 132 \r
 133 /* Store/clear the ready priorities in a bit map. */\r
 134         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities )    ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 135         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities )     ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 136 \r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31UL - ( uint32_t ) __clz( ( uxReadyPriorities ) ) )\r
 140 \r
 141     #endif /* taskRECORD_READY_PRIORITY */\r
 142 /*-----------------------------------------------------------*/\r
 143 \r
 144 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 145  * not necessary for to use this port.  They are defined so the common demo files\r
 146  * (which build with all the ports) will build. */\r
 147     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )\r
 148     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )\r
 149 /*-----------------------------------------------------------*/\r
 150 \r
 151     #ifdef configASSERT\r
 152         void vPortValidateInterruptPriority( void );\r
 153         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()\r
 154     #endif\r
 155 \r
 156 /* portNOP() is not required by this port. */\r
 157     #define portNOP()\r
 158 \r
 159     #define portINLINE              __inline\r
 160 \r
 161     #ifndef portFORCE_INLINE\r
 162         #define portFORCE_INLINE    __forceinline\r
 163     #endif\r
 164 \r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167     static portFORCE_INLINE void vPortSetBASEPRI( uint32_t ulBASEPRI )\r
 168     {\r
 169         __asm\r
 170         {\r
 171             /* Barrier instructions are not used as this function is only used to\r
 172              * lower the BASEPRI value. */\r
 173 /* *INDENT-OFF* */\r
 174             msr basepri, ulBASEPRI\r
 175 /* *INDENT-ON* */\r
 176         }\r
 177     }\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180     static portFORCE_INLINE void vPortRaiseBASEPRI( void )\r
 181     {\r
 182         uint32_t ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 183 \r
 184         __asm\r
 185         {\r
 186             /* Set BASEPRI to the max syscall priority to effect a critical\r
 187              * section. */\r
 188 /* *INDENT-OFF* */\r
 189             cpsid i\r
 190             msr basepri, ulNewBASEPRI\r
 191             dsb\r
 192             isb\r
 193             cpsie i\r
 194 /* *INDENT-ON* */\r
 195         }\r
 196     }\r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199     static portFORCE_INLINE void vPortClearBASEPRIFromISR( void )\r
 200     {\r
 201         __asm\r
 202         {\r
 203             /* Set BASEPRI to 0 so no interrupts are masked.  This function is only\r
 204              * used to lower the mask in an interrupt, so memory barriers are not\r
 205              * used. */\r
 206 /* *INDENT-OFF* */\r
 207             msr basepri, # 0\r
 208 /* *INDENT-ON* */\r
 209         }\r
 210     }\r
 211 /*-----------------------------------------------------------*/\r
 212 \r
 213     static portFORCE_INLINE uint32_t ulPortRaiseBASEPRI( void )\r
 214     {\r
 215         uint32_t ulReturn, ulNewBASEPRI = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 216 \r
 217         __asm\r
 218         {\r
 219             /* Set BASEPRI to the max syscall priority to effect a critical\r
 220              * section. */\r
 221 /* *INDENT-OFF* */\r
 222             mrs ulReturn, basepri\r
 223             cpsid i\r
 224             msr basepri, ulNewBASEPRI\r
 225             dsb\r
 226             isb\r
 227             cpsie i\r
 228 /* *INDENT-ON* */\r
 229         }\r
 230 \r
 231         return ulReturn;\r
 232     }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235     static portFORCE_INLINE BaseType_t xPortIsInsideInterrupt( void )\r
 236     {\r
 237         uint32_t ulCurrentInterrupt;\r
 238         BaseType_t xReturn;\r
 239 \r
 240         /* Obtain the number of the currently executing interrupt. */\r
 241         __asm\r
 242         {\r
 243 /* *INDENT-OFF* */\r
 244             mrs ulCurrentInterrupt, ipsr\r
 245 /* *INDENT-ON* */\r
 246         }\r
 247 \r
 248         if( ulCurrentInterrupt == 0 )\r
 249         {\r
 250             xReturn = pdFALSE;\r
 251         }\r
 252         else\r
 253         {\r
 254             xReturn = pdTRUE;\r
 255         }\r
 256 \r
 257         return xReturn;\r
 258     }\r
 259 \r
 260 \r
 261     #ifdef __cplusplus\r
 262         }\r
 263     #endif\r
 264 \r
 265 #endif /* PORTMACRO_H */\r