begriffs open source - cmsis-freertos/blob - Source/portable/RVDS/ARM_CM0/portmacro.h

   1 /*
   2  * FreeRTOS Kernel V11.1.0
   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
  84 /* Scheduler utilities. */
  85 extern void vPortYield( void );
  86 #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
  87 #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
  88 #define portYIELD()                vPortYield()
  89 #define portEND_SWITCHING_ISR( xSwitchRequired )            \
  90     do                                                      \
  91     {                                                       \
  92         if( xSwitchRequired )                               \
  93         {                                                   \
  94             traceISR_EXIT_TO_SCHEDULER();                   \
  95             portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; \
  96         }                                                   \
  97         else                                                \
  98         {                                                   \
  99             traceISR_EXIT();                                \
 100         }                                                   \
 101     } while( 0 )
 102 #define portYIELD_FROM_ISR( x )    portEND_SWITCHING_ISR( x )
 103 /*-----------------------------------------------------------*/
 104
 105 /* Critical section management. */
 106 extern void vPortEnterCritical( void );
 107 extern void vPortExitCritical( void );
 108 extern uint32_t ulSetInterruptMaskFromISR( void );
 109 extern void vClearInterruptMaskFromISR( uint32_t ulMask );
 110
 111 #define portSET_INTERRUPT_MASK_FROM_ISR()         ulSetInterruptMaskFromISR()
 112 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vClearInterruptMaskFromISR( x )
 113 #define portDISABLE_INTERRUPTS()                  __disable_irq()
 114 #define portENABLE_INTERRUPTS()                   __enable_irq()
 115 #define portENTER_CRITICAL()                      vPortEnterCritical()
 116 #define portEXIT_CRITICAL()                       vPortExitCritical()
 117
 118 /*-----------------------------------------------------------*/
 119
 120 /* Tickless idle/low power functionality. */
 121 #ifndef portSUPPRESS_TICKS_AND_SLEEP
 122     extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
 123     #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
 124 #endif
 125 /*-----------------------------------------------------------*/
 126
 127 /* Task function macros as described on the FreeRTOS.org WEB site. */
 128 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 129 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 130
 131 #define portNOP()
 132
 133 #define portINLINE              __inline
 134
 135 #ifndef portFORCE_INLINE
 136     #define portFORCE_INLINE    __forceinline
 137 #endif
 138
 139 /*-----------------------------------------------------------*/
 140
 141 static portFORCE_INLINE BaseType_t xPortIsInsideInterrupt( void )
 142 {
 143     uint32_t ulCurrentInterrupt;
 144     BaseType_t xReturn;
 145
 146     /* Obtain the number of the currently executing interrupt. */
 147     __asm
 148     {
 149 /* *INDENT-OFF* */
 150             mrs ulCurrentInterrupt, ipsr
 151 /* *INDENT-ON* */
 152     }
 153
 154     if( ulCurrentInterrupt == 0 )
 155     {
 156         xReturn = pdFALSE;
 157     }
 158     else
 159     {
 160         xReturn = pdTRUE;
 161     }
 162
 163     return xReturn;
 164 }
 165
 166 /*-----------------------------------------------------------*/
 167
 168 /* *INDENT-OFF* */
 169 #ifdef __cplusplus
 170     }
 171 #endif
 172 /* *INDENT-ON* */
 173
 174 #endif /* PORTMACRO_H */