begriffs open source - freertos/blob - portable/MikroC/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     #ifdef __cplusplus
  33         extern "C" {
  34     #endif
  35
  36 /*-----------------------------------------------------------
  37  * Port specific definitions.
  38  *
  39  * The settings in this file configure FreeRTOS correctly for the
  40  * given hardware and compiler.
  41  *
  42  * These settings should not be altered.
  43  *-----------------------------------------------------------
  44  */
  45
  46 /* The compiler needs to be told functions that are only referenced by pointer
  47  * are to be included in the build.  NOTE:  Omitting these lines will result in a
  48  * run-time crash, not a linker error! */
  49     #pragma funcall vTaskStartScheduler prvIdleTask
  50     #pragma funcall xTimerCreateTimerTask prvTimerTask
  51
  52 /* Type definitions. */
  53     #define portCHAR          char
  54     #define portFLOAT         float
  55     #define portDOUBLE        double
  56     #define portLONG          long
  57     #define portSHORT         short
  58     #define portSTACK_TYPE    uint32_t
  59     #define portBASE_TYPE     long
  60
  61     typedef portSTACK_TYPE   StackType_t;
  62     typedef long             BaseType_t;
  63     typedef unsigned long    UBaseType_t;
  64
  65     #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  66         typedef uint16_t     TickType_t;
  67         #define portMAX_DELAY              ( TickType_t ) 0xffff
  68     #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
  69         typedef uint32_t     TickType_t;
  70         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  71
  72 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  73  * not need to be guarded with a critical section. */
  74         #define portTICK_TYPE_IS_ATOMIC    1
  75     #else
  76         #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  77     #endif
  78 /*-----------------------------------------------------------*/
  79
  80 /* Architecture specifics. */
  81     #define portSTACK_GROWTH      ( -1 )
  82     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  83     #define portBYTE_ALIGNMENT    8
  84 /*-----------------------------------------------------------*/
  85
  86 /* Scheduler utilities. */
  87     #define portYIELD()                                 \
  88     {                                                   \
  89         /* Set a PendSV to request a context switch. */ \
  90         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
  91                                                         \
  92         /* Barriers are normally not required but do ensure the code is completely \
  93          * within the specified behaviour for the architecture. */ \
  94         __asm{ dsb };                                              \
  95         __asm{ isb };                                              \
  96     }
  97
  98     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
  99     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
 100     #define portEND_SWITCHING_ISR( xSwitchRequired )    do { if( xSwitchRequired != pdFALSE ) portYIELD(); } while( 0 )
 101     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )
 102 /*-----------------------------------------------------------*/
 103
 104 /* Critical section management. */
 105     extern void vPortEnterCritical( void );
 106     extern void vPortExitCritical( void );
 107     #define portDISABLE_INTERRUPTS()                  CPU_REG_SET( CPU_BASEPRI, configMAX_SYSCALL_INTERRUPT_PRIORITY ); __asm{ dsb }; __asm{ isb }
 108     #define portENABLE_INTERRUPTS()                   CPU_REG_SET( CPU_BASEPRI, 0 );
 109     #define portENTER_CRITICAL()                      vPortEnterCritical()
 110     #define portEXIT_CRITICAL()                       vPortExitCritical()
 111     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulPortRaiseBASEPRI()
 112     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    CPU_REG_SET( CPU_BASEPRI, x ); /* Barrier instructions not used as this is only used to lower the basepri. */
 113
 114 /*-----------------------------------------------------------*/
 115
 116 /* Task function macros as described on the FreeRTOS.org WEB site.  These are
 117  * not necessary for to use this port.  They are defined so the common demo files
 118  * (which build with all the ports) will build. */
 119     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 120     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 121 /*-----------------------------------------------------------*/
 122
 123 /* Tickless idle/low power functionality. */
 124     #ifndef portSUPPRESS_TICKS_AND_SLEEP
 125         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
 126         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
 127     #endif
 128 /*-----------------------------------------------------------*/
 129
 130 /* Architecture specific optimisations. */
 131     #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
 132         #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1
 133     #endif
 134
 135     #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
 136
 137 /* Generic helper function. */
 138         __attribute__( ( always_inline ) ) static inline uint8_t ucPortCountLeadingZeros( uint32_t ulBitmap )
 139         {
 140             uint8_t ucReturn;
 141
 142             __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) );
 143
 144             return ucReturn;
 145         }
 146
 147 /* Check the configuration. */
 148         #if ( configMAX_PRIORITIES > 32 )
 149             #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.
 150         #endif
 151
 152 /* Store/clear the ready priorities in a bit map. */
 153         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities )    ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
 154         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities )     ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
 155
 156 /*-----------------------------------------------------------*/
 157
 158         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31UL - ( uint32_t ) ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )
 159
 160     #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
 161
 162 /*-----------------------------------------------------------*/
 163
 164     #ifdef configASSERT
 165         void vPortValidateInterruptPriority( void );
 166         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()
 167     #endif
 168
 169 /* portNOP() is not required by this port. */
 170     #define portNOP()
 171
 172     BaseType_t xPortIsInsideInterrupt( void );
 173
 174 /*-----------------------------------------------------------*/
 175
 176     static inline uint32_t ulPortRaiseBASEPRI( void )
 177     {
 178         uint32_t ulOriginalBASEPRI;
 179
 180         ulOriginalBASEPRI = CPU_REG_GET( CPU_BASEPRI );
 181         CPU_REG_SET( CPU_BASEPRI, configMAX_SYSCALL_INTERRUPT_PRIORITY );
 182         __asm{ dsb };
 183         __asm{ isb };
 184         return ulOriginalBASEPRI;
 185     }
 186 /*-----------------------------------------------------------*/
 187
 188     #ifdef __cplusplus
 189         }
 190     #endif
 191
 192 #endif /* PORTMACRO_H */