begriffs open source - freertos/blob - portable/IAR/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  * SPDX-License-Identifier: MIT
   6  *
   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 /* IAR includes. */\r
  48     #include <intrinsics.h>\r
  49 \r
  50 /* Type definitions. */\r
  51     #define portCHAR          char\r
  52     #define portFLOAT         float\r
  53     #define portDOUBLE        double\r
  54     #define portLONG          long\r
  55     #define portSHORT         short\r
  56     #define portSTACK_TYPE    uint32_t\r
  57     #define portBASE_TYPE     long\r
  58 \r
  59     typedef portSTACK_TYPE   StackType_t;\r
  60     typedef long             BaseType_t;\r
  61     typedef unsigned long    UBaseType_t;\r
  62 \r
  63     #if ( configUSE_16_BIT_TICKS == 1 )\r
  64         typedef uint16_t     TickType_t;\r
  65         #define portMAX_DELAY              ( TickType_t ) 0xffff\r
  66     #else\r
  67         typedef uint32_t     TickType_t;\r
  68         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL\r
  69 \r
  70 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  71  * not need to be guarded with a critical section. */\r
  72         #define portTICK_TYPE_IS_ATOMIC    1\r
  73     #endif\r
  74 /*-----------------------------------------------------------*/\r
  75 \r
  76 /* Architecture specifics. */\r
  77     #define portSTACK_GROWTH      ( -1 )\r
  78     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  79     #define portBYTE_ALIGNMENT    8\r
  80 /*-----------------------------------------------------------*/\r
  81 \r
  82 /* Compiler directives. */\r
  83     #define portWEAK_SYMBOL    __attribute__( ( weak ) )\r
  84 \r
  85 /*-----------------------------------------------------------*/\r
  86 \r
  87 \r
  88 /* Scheduler utilities. */\r
  89     #define portYIELD()                                 \\r
  90     {                                                   \\r
  91         /* Set a PendSV to request a context switch. */ \\r
  92         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \\r
  93         __DSB();                                        \\r
  94         __ISB();                                        \\r
  95     }\r
  96 \r
  97     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )\r
  98     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )\r
  99     #define portEND_SWITCHING_ISR( xSwitchRequired )    do { if( xSwitchRequired != pdFALSE ) portYIELD(); } while( 0 )\r
 100     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )\r
 101 \r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 /* Architecture specific optimisations. */\r
 105     #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 106         #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1\r
 107     #endif\r
 108 \r
 109     #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 )\r
 110 \r
 111 /* Check the configuration. */\r
 112         #if ( configMAX_PRIORITIES > 32 )\r
 113             #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
 114         #endif\r
 115 \r
 116 /* Store/clear the ready priorities in a bit map. */\r
 117         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities )    ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 118         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities )     ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 119 \r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31UL - ( ( uint32_t ) __CLZ( ( uxReadyPriorities ) ) ) )\r
 123 \r
 124     #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 125 /*-----------------------------------------------------------*/\r
 126 \r
 127 /* Critical section management. */\r
 128     extern void vPortEnterCritical( void );\r
 129     extern void vPortExitCritical( void );\r
 130 \r
 131     #define portDISABLE_INTERRUPTS()                           \\r
 132     {                                                          \\r
 133         __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY ); \\r
 134         __DSB();                                               \\r
 135         __ISB();                                               \\r
 136     }\r
 137 \r
 138     #define portENABLE_INTERRUPTS()                   __set_BASEPRI( 0 )\r
 139     #define portENTER_CRITICAL()                      vPortEnterCritical()\r
 140     #define portEXIT_CRITICAL()                       vPortExitCritical()\r
 141     #define portSET_INTERRUPT_MASK_FROM_ISR()         __get_BASEPRI(); portDISABLE_INTERRUPTS()\r
 142     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    __set_BASEPRI( x )\r
 143 /*-----------------------------------------------------------*/\r
 144 \r
 145 /* Tickless idle/low power functionality. */\r
 146     #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 147         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 148         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 149     #endif\r
 150 \r
 151 /*-----------------------------------------------------------*/\r
 152 \r
 153 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 154  * not necessary for to use this port.  They are defined so the common demo files\r
 155  * (which build with all the ports) will build. */\r
 156     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )\r
 157     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )\r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160     #ifdef configASSERT\r
 161         void vPortValidateInterruptPriority( void );\r
 162         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()\r
 163     #endif\r
 164 \r
 165 /* portNOP() is not required by this port. */\r
 166     #define portNOP()\r
 167 \r
 168     #define portINLINE              __inline\r
 169 \r
 170     #ifndef portFORCE_INLINE\r
 171         #define portFORCE_INLINE    inline __attribute__( ( always_inline ) )\r
 172     #endif\r
 173 \r
 174 /*-----------------------------------------------------------*/\r
 175 \r
 176     portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )\r
 177     {\r
 178         uint32_t ulCurrentInterrupt;\r
 179         BaseType_t xReturn;\r
 180 \r
 181         /* Obtain the number of the currently executing interrupt. */\r
 182         __asm volatile ( "mrs %0, ipsr" : "=r" ( ulCurrentInterrupt )::"memory" );\r
 183 \r
 184         if( ulCurrentInterrupt == 0 )\r
 185         {\r
 186             xReturn = pdFALSE;\r
 187         }\r
 188         else\r
 189         {\r
 190             xReturn = pdTRUE;\r
 191         }\r
 192 \r
 193         return xReturn;\r
 194     }\r
 195 \r
 196 /*-----------------------------------------------------------*/\r
 197 \r
 198 /* Suppress warnings that are generated by the IAR tools, but cannot be fixed in\r
 199  * the source code because to do so would cause other compilers to generate\r
 200  * warnings. */\r
 201     #pragma diag_suppress=Pe191\r
 202     #pragma diag_suppress=Pa082\r
 203 \r
 204     #ifdef __cplusplus\r
 205         }\r
 206     #endif\r
 207 \r
 208 #endif /* PORTMACRO_H */\r