begriffs open source - cmsis-freertos/blob - Source/portable/CCS/ARM_CM3/portmacro.h

   1 /*
   2  * FreeRTOS Kernel V10.1.1
   3  * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * http://www.FreeRTOS.org
  23  * http://aws.amazon.com/freertos
  24  *
  25  * 1 tab == 4 spaces!
  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 /* Type definitions. */
  47 #define portCHAR                char
  48 #define portFLOAT               float
  49 #define portDOUBLE              double
  50 #define portLONG                long
  51 #define portSHORT               short
  52 #define portSTACK_TYPE  uint32_t
  53 #define portBASE_TYPE   long
  54
  55 typedef portSTACK_TYPE StackType_t;
  56 typedef long BaseType_t;
  57 typedef unsigned long UBaseType_t;
  58
  59 #if( configUSE_16_BIT_TICKS == 1 )
  60         typedef uint16_t TickType_t;
  61         #define portMAX_DELAY ( TickType_t ) 0xffff
  62 #else
  63         typedef uint32_t TickType_t;
  64         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL
  65
  66         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  67         not need to be guarded with a critical section. */
  68         #define portTICK_TYPE_IS_ATOMIC 1
  69 #endif
  70 /*-----------------------------------------------------------*/
  71
  72 /* Architecture specifics. */
  73 #define portSTACK_GROWTH                        ( -1 )
  74 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  75 #define portBYTE_ALIGNMENT                      8
  76
  77 /*-----------------------------------------------------------*/
  78
  79 /* Compiler directives. */
  80 #define portWEAK_SYMBOL                         __attribute__((weak))
  81
  82 /*-----------------------------------------------------------*/
  83
  84 /* Scheduler utilities. */
  85 #define portYIELD()                                                                                     \
  86 {                                                                                                                       \
  87         /* Set a PendSV to request a context switch. */                 \
  88         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;                 \
  89         __asm( "        dsb" );                                                                         \
  90         __asm( "        isb" );                                                                         \
  91 }
  92
  93 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )
  94 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )
  95 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired != pdFALSE ) portYIELD()
  96 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
  97
  98 /*-----------------------------------------------------------*/
  99
 100 /* Architecture specific optimisations. */
 101 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
 102         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
 103 #endif
 104
 105 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
 106
 107         /* Check the configuration. */
 108         #if( configMAX_PRIORITIES > 32 )
 109                 #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.
 110         #endif
 111
 112         /* Store/clear the ready priorities in a bit map. */
 113         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
 114         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
 115
 116         /*-----------------------------------------------------------*/
 117
 118         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( ( uxReadyPriorities ) ) )
 119
 120 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
 121 /*-----------------------------------------------------------*/
 122
 123 /* Critical section management. */
 124 extern void vPortEnterCritical( void );
 125 extern void vPortExitCritical( void );
 126
 127 #define portDISABLE_INTERRUPTS()                                                                                \
 128 {                                                                                                                                               \
 129         _set_interrupt_priority( configMAX_SYSCALL_INTERRUPT_PRIORITY );        \
 130         __asm( "        dsb" );                                                                                                 \
 131         __asm( "        isb" );                                                                                                 \
 132 }
 133
 134 #define portENABLE_INTERRUPTS()                                 _set_interrupt_priority( 0 )
 135 #define portENTER_CRITICAL()                                    vPortEnterCritical()
 136 #define portEXIT_CRITICAL()                                             vPortExitCritical()
 137 #define portSET_INTERRUPT_MASK_FROM_ISR()               _set_interrupt_priority( configMAX_SYSCALL_INTERRUPT_PRIORITY ); __asm( "       dsb" ); __asm( "        isb" )
 138 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    _set_interrupt_priority( x )
 139 /*-----------------------------------------------------------*/
 140
 141 /* Tickless idle/low power functionality. */
 142 #ifndef portSUPPRESS_TICKS_AND_SLEEP
 143         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
 144         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )
 145 #endif
 146
 147 /*-----------------------------------------------------------*/
 148
 149 /* Task function macros as described on the FreeRTOS.org WEB site.  These are
 150 not necessary for to use this port.  They are defined so the common demo files
 151 (which build with all the ports) will build. */
 152 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
 153 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
 154 /*-----------------------------------------------------------*/
 155
 156 #ifdef configASSERT
 157         void vPortValidateInterruptPriority( void );
 158         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()      vPortValidateInterruptPriority()
 159 #endif
 160
 161 /* portNOP() is not required by this port. */
 162 #define portNOP()
 163
 164 /*-----------------------------------------------------------*/
 165
 166 #ifdef __cplusplus
 167 }
 168 #endif
 169
 170 #endif /* PORTMACRO_H */
 171