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

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