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