begriffs open source - cmsis-freertos/blob - Source/portable/IAR/ARM_CM3/portmacro.h

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