begriffs open source - freertos/blob - portable/GCC/ARM_CM4F/portmacro.h

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