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