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

   1 /*\r
   2  * FreeRTOS Kernel V10.4.3 LTS Patch 3\r
   3  * Copyright (C) 2020 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  * 1 tab == 4 spaces!\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 /* Type definitions. */\r
  47     #define portCHAR          char\r
  48     #define portFLOAT         float\r
  49     #define portDOUBLE        double\r
  50     #define portLONG          long\r
  51     #define portSHORT         short\r
  52     #define portSTACK_TYPE    uint32_t\r
  53     #define portBASE_TYPE     long\r
  54 \r
  55     typedef portSTACK_TYPE   StackType_t;\r
  56     typedef long             BaseType_t;\r
  57     typedef unsigned long    UBaseType_t;\r
  58 \r
  59     #if ( configUSE_16_BIT_TICKS == 1 )\r
  60         typedef uint16_t     TickType_t;\r
  61         #define portMAX_DELAY              ( TickType_t ) 0xffff\r
  62     #else\r
  63         typedef uint32_t     TickType_t;\r
  64         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL\r
  65 \r
  66 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  67  * not need to be guarded with a critical section. */\r
  68         #define portTICK_TYPE_IS_ATOMIC    1\r
  69     #endif\r
  70 /*-----------------------------------------------------------*/\r
  71 \r
  72 /* Architecture specifics. */\r
  73     #define portSTACK_GROWTH      ( -1 )\r
  74     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  75     #define portBYTE_ALIGNMENT    8\r
  76 /*-----------------------------------------------------------*/\r
  77 \r
  78 /* Scheduler utilities. */\r
  79     #define portYIELD()                                 \\r
  80     {                                                   \\r
  81         /* Set a PendSV to request a context switch. */ \\r
  82         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \\r
  83         __asm( "        dsb");                                \\r
  84         __asm( "        isb");                                \\r
  85     }\r
  86 \r
  87     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )\r
  88     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )\r
  89     #define portEND_SWITCHING_ISR( xSwitchRequired )    if( xSwitchRequired != pdFALSE ) portYIELD()\r
  90     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )\r
  91 \r
  92 /*-----------------------------------------------------------*/\r
  93 \r
  94 /* Architecture specific optimisations. */\r
  95     #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
  96         #define configUSE_PORT_OPTIMISED_TASK_SELECTION    1\r
  97     #endif\r
  98 \r
  99     #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 100 \r
 101 /* Check the configuration. */\r
 102         #if ( configMAX_PRIORITIES > 32 )\r
 103             #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
 104         #endif\r
 105 \r
 106 /* Store/clear the ready priorities in a bit map. */\r
 107         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities )    ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 108         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities )     ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 109 \r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    uxTopPriority = ( 31 - __clz( ( uxReadyPriorities ) ) )\r
 113 \r
 114     #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 /* Critical section management. */\r
 118     extern void vPortEnterCritical( void );\r
 119     extern void vPortExitCritical( void );\r
 120 \r
 121     #define portDISABLE_INTERRUPTS()                                     \\r
 122     {                                                                    \\r
 123         _set_interrupt_priority( configMAX_SYSCALL_INTERRUPT_PRIORITY ); \\r
 124         __asm( "        dsb");                                                 \\r
 125         __asm( "        isb");                                                 \\r
 126     }\r
 127 \r
 128     #define portENABLE_INTERRUPTS()                   _set_interrupt_priority( 0 )\r
 129     #define portENTER_CRITICAL()                      vPortEnterCritical()\r
 130     #define portEXIT_CRITICAL()                       vPortExitCritical()\r
 131     #define portSET_INTERRUPT_MASK_FROM_ISR()         _set_interrupt_priority( configMAX_SYSCALL_INTERRUPT_PRIORITY ); __asm( " dsb" ); __asm( "        isb")\r
 132     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    _set_interrupt_priority( x )\r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 /* Tickless idle/low power functionality. */\r
 136     #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 137         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 138         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 139     #endif\r
 140 \r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 144  * not necessary for to use this port.  They are defined so the common demo files\r
 145  * (which build with all the ports) will build. */\r
 146     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )\r
 147     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )\r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150     #ifdef configASSERT\r
 151         void vPortValidateInterruptPriority( void );\r
 152         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    vPortValidateInterruptPriority()\r
 153     #endif\r
 154 \r
 155 /* portNOP() is not required by this port. */\r
 156     #define portNOP()\r
 157 \r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160     #ifdef __cplusplus\r
 161         }\r
 162     #endif\r
 163 \r
 164 #endif /* PORTMACRO_H */\r