begriffs open source - freertos/blob - portable/GCC/ARM_CM0/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     #ifdef __cplusplus
  34         extern "C" {
  35     #endif
  36
  37 /*-----------------------------------------------------------
  38  * Port specific definitions.
  39  *
  40  * The settings in this file configure FreeRTOS correctly for the
  41  * given hardware and compiler.
  42  *
  43  * These settings should not be altered.
  44  *-----------------------------------------------------------
  45  */
  46
  47 /* Type definitions. */
  48     #define portCHAR          char
  49     #define portFLOAT         float
  50     #define portDOUBLE        double
  51     #define portLONG          long
  52     #define portSHORT         short
  53     #define portSTACK_TYPE    uint32_t
  54     #define portBASE_TYPE     long
  55
  56     typedef portSTACK_TYPE   StackType_t;
  57     typedef long             BaseType_t;
  58     typedef unsigned long    UBaseType_t;
  59
  60     #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  61         typedef uint16_t     TickType_t;
  62         #define portMAX_DELAY              ( TickType_t ) 0xffff
  63     #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
  64         typedef uint32_t     TickType_t;
  65         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  66
  67 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  68  * not need to be guarded with a critical section. */
  69         #define portTICK_TYPE_IS_ATOMIC    1
  70     #else
  71         #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  72     #endif
  73 /*-----------------------------------------------------------*/
  74
  75 /* Architecture specifics. */
  76     #define portSTACK_GROWTH      ( -1 )
  77     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  78     #define portBYTE_ALIGNMENT    8
  79     #define portDONT_DISCARD      __attribute__( ( used ) )
  80 /*-----------------------------------------------------------*/
  81
  82
  83 /* Scheduler utilities. */
  84     extern void vPortYield( void );
  85     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )
  86     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )
  87     #define portYIELD()                                 vPortYield()
  88     #define portEND_SWITCHING_ISR( xSwitchRequired )    do { if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; } while( 0 )
  89     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )
  90 /*-----------------------------------------------------------*/
  91
  92
  93 /* Critical section management. */
  94     extern void vPortEnterCritical( void );
  95     extern void vPortExitCritical( void );
  96     extern uint32_t ulSetInterruptMaskFromISR( void ) __attribute__( ( naked ) );
  97     extern void vClearInterruptMaskFromISR( uint32_t ulMask )  __attribute__( ( naked ) );
  98
  99     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulSetInterruptMaskFromISR()
 100     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vClearInterruptMaskFromISR( x )
 101     #define portDISABLE_INTERRUPTS()                  __asm volatile ( " cpsid i " ::: "memory" )
 102     #define portENABLE_INTERRUPTS()                   __asm volatile ( " cpsie i " ::: "memory" )
 103     #define portENTER_CRITICAL()                      vPortEnterCritical()
 104     #define portEXIT_CRITICAL()                       vPortExitCritical()
 105
 106 /*-----------------------------------------------------------*/
 107
 108 /* Tickless idle/low power functionality. */
 109     #ifndef portSUPPRESS_TICKS_AND_SLEEP
 110         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );
 111         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )
 112     #endif
 113 /*-----------------------------------------------------------*/
 114
 115 /* Task function macros as described on the FreeRTOS.org WEB site. */
 116     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 117     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 118
 119     #define portNOP()
 120
 121     #define portMEMORY_BARRIER()    __asm volatile ( "" ::: "memory" )
 122
 123     #ifdef __cplusplus
 124         }
 125     #endif
 126
 127 #endif /* PORTMACRO_H */