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