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

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