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

   1 /*
   2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
   3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   4  *
   5  * SPDX-License-Identifier: MIT
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   8  * this software and associated documentation files (the "Software"), to deal in
   9  * the Software without restriction, including without limitation the rights to
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  11  * the Software, and to permit persons to whom the Software is furnished to do so,
  12  * subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in all
  15  * copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  *
  24  * https://www.FreeRTOS.org
  25  * https://github.com/FreeRTOS
  26  *
  27  */
  28
  29 #ifndef PORTMACRO_H
  30 #define PORTMACRO_H
  31
  32 /* *INDENT-OFF* */
  33 #ifdef __cplusplus
  34     extern "C" {
  35 #endif
  36 /* *INDENT-ON* */
  37
  38 /*-----------------------------------------------------------
  39  * Port specific definitions.
  40  *
  41  * The settings in this file configure FreeRTOS correctly for the
  42  * given hardware and compiler.
  43  *
  44  * These settings should not be altered.
  45  *-----------------------------------------------------------
  46  */
  47
  48 /* IAR includes. */
  49 #include <intrinsics.h>
  50
  51 /* Type definitions. */
  52 #define portCHAR          char
  53 #define portFLOAT         float
  54 #define portDOUBLE        double
  55 #define portLONG          long
  56 #define portSHORT         short
  57 #define portSTACK_TYPE    uint32_t
  58 #define portBASE_TYPE     long
  59
  60 typedef portSTACK_TYPE   StackType_t;
  61 typedef long             BaseType_t;
  62 typedef unsigned long    UBaseType_t;
  63
  64 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  65     typedef uint16_t     TickType_t;
  66     #define portMAX_DELAY              ( TickType_t ) 0xffff
  67 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
  68     typedef uint32_t     TickType_t;
  69     #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  70
  71 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  72  * not need to be guarded with a critical section. */
  73     #define portTICK_TYPE_IS_ATOMIC    1
  74 #else
  75     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  76 #endif
  77 /*-----------------------------------------------------------*/
  78
  79 /* Architecture specifics. */
  80 #define portSTACK_GROWTH      ( -1 )
  81 #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  82 #define portBYTE_ALIGNMENT    8
  83 /*-----------------------------------------------------------*/
  84
  85 /* Compiler directives. */
  86 #define portWEAK_SYMBOL    __attribute__( ( weak ) )
  87
  88 /*-----------------------------------------------------------*/
  89
  90
  91 /* Scheduler utilities. */
  92 #define portYIELD()                                     \
  93     {                                                   \
  94         /* Set a PendSV to request a context switch. */ \
  95         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
  96         __DSB();                                        \
  97         __ISB();                                        \
  98     }
  99
 100 #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
 101 #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
 102 #define portEND_SWITCHING_ISR( xSwitchRequired ) \
 103     do                                           \
 104     {                                            \
 105         if( xSwitchRequired != pdFALSE )         \
 106         {                                        \
 107             traceISR_EXIT_TO_SCHEDULER();        \
 108             portYIELD();                         \
 109         }                                        \
 110         else                                     \
 111         {                                        \
 112             traceISR_EXIT();                     \
 113         }                                        \
 114     } while( 0 )
 115 #define portYIELD_FROM_ISR( x )    portEND_SWITCHING_ISR( x )
 116
 117 /*-----------------------------------------------------------*/
 118
 119 /* Architecture specific optimisations. */
 120 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
 121     #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1
 122 #endif
 123
 124 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 )
 125
 126 /* Check the configuration. */
 127     #if ( configMAX_PRIORITIES > 32 )
 128         #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.
 129     #endif
 130
 131 /* Store/clear the ready priorities in a bit map. */
 132     #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities )    ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
 133     #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities )     ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
 134
 135 /*-----------------------------------------------------------*/
 136
 137     #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31UL - ( ( uint32_t ) __CLZ( ( uxReadyPriorities ) ) ) )
 138
 139 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
 140 /*-----------------------------------------------------------*/
 141
 142 /* Critical section management. */
 143 extern void vPortEnterCritical( void );
 144 extern void vPortExitCritical( void );
 145
 146 #define portDISABLE_INTERRUPTS()                               \
 147     {                                                          \
 148         __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY ); \
 149         __DSB();                                               \
 150         __ISB();                                               \
 151     }
 152
 153 #define portENABLE_INTERRUPTS()                   __set_BASEPRI( 0 )
 154 #define portENTER_CRITICAL()                      vPortEnterCritical()
 155 #define portEXIT_CRITICAL()                       vPortExitCritical()
 156 #define portSET_INTERRUPT_MASK_FROM_ISR()         __get_BASEPRI(); portDISABLE_INTERRUPTS()
 157 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    __set_BASEPRI( x )
 158 /*-----------------------------------------------------------*/
 159
 160 /* Tickless idle/low power functionality. */
 161 #ifndef portSUPPRESS_TICKS_AND_SLEEP
 162     extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
 163     #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
 164 #endif
 165
 166 /*-----------------------------------------------------------*/
 167
 168 /* Task function macros as described on the FreeRTOS.org WEB site.  These are
 169  * not necessary for to use this port.  They are defined so the common demo files
 170  * (which build with all the ports) will build. */
 171 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 172 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 173 /*-----------------------------------------------------------*/
 174
 175 #if ( configASSERT_DEFINED == 1 )
 176     void vPortValidateInterruptPriority( void );
 177     #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()
 178 #endif
 179
 180 /* portNOP() is not required by this port. */
 181 #define portNOP()
 182
 183 #define portINLINE              __inline
 184
 185 #ifndef portFORCE_INLINE
 186     #define portFORCE_INLINE    inline __attribute__( ( always_inline ) )
 187 #endif
 188
 189 /*-----------------------------------------------------------*/
 190
 191 portFORCE_INLINE static BaseType_t xPortIsInsideInterrupt( void )
 192 {
 193     uint32_t ulCurrentInterrupt;
 194     BaseType_t xReturn;
 195
 196     /* Obtain the number of the currently executing interrupt. */
 197     __asm volatile ( "mrs %0, ipsr" : "=r" ( ulCurrentInterrupt )::"memory" );
 198
 199     if( ulCurrentInterrupt == 0 )
 200     {
 201         xReturn = pdFALSE;
 202     }
 203     else
 204     {
 205         xReturn = pdTRUE;
 206     }
 207
 208     return xReturn;
 209 }
 210
 211 /*-----------------------------------------------------------*/
 212
 213 /* Suppress warnings that are generated by the IAR tools, but cannot be fixed in
 214  * the source code because to do so would cause other compilers to generate
 215  * warnings. */
 216 #pragma diag_suppress=Pe191
 217 #pragma diag_suppress=Pa082
 218
 219 /* *INDENT-OFF* */
 220 #ifdef __cplusplus
 221     }
 222 #endif
 223 /* *INDENT-ON* */
 224
 225 #endif /* PORTMACRO_H */