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

   1 /*
   2  * FreeRTOS SMP Kernel V202110.00
   3  * Copyright (C) 2020 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  * https://www.FreeRTOS.org
  23  * https://github.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
  60     #if ( configUSE_16_BIT_TICKS == 1 )
  61         typedef uint16_t     TickType_t;
  62         #define portMAX_DELAY              ( TickType_t ) 0xffff
  63     #else
  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     #endif
  71 /*-----------------------------------------------------------*/
  72
  73 /* Architecture specifics. */
  74     #define portSTACK_GROWTH      ( -1 )
  75     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  76     #define portBYTE_ALIGNMENT    8
  77 /*-----------------------------------------------------------*/
  78
  79
  80 /* Scheduler utilities. */
  81     extern void vPortYield( void );
  82     #define portNVIC_INT_CTRL     ( ( volatile uint32_t * ) 0xe000ed04 )
  83     #define portNVIC_PENDSVSET    0x10000000
  84     #define portYIELD()                                 vPortYield()
  85
  86     #define portEND_SWITCHING_ISR( xSwitchRequired )    if( xSwitchRequired ) *( portNVIC_INT_CTRL ) = portNVIC_PENDSVSET
  87     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )
  88 /*-----------------------------------------------------------*/
  89
  90
  91 /* Critical section management. */
  92
  93 /*
  94  * Set basepri to portMAX_SYSCALL_INTERRUPT_PRIORITY without effecting other
  95  * registers.  r0 is clobbered.
  96  */
  97     #define portSET_INTERRUPT_MASK()      __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY )
  98
  99 /*
 100  * Set basepri back to 0 without effective other registers.
 101  * r0 is clobbered.  FAQ:  Setting BASEPRI to 0 is not a bug.  Please see
 102  * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html before disagreeing.
 103  */
 104     #define portCLEAR_INTERRUPT_MASK()    __set_BASEPRI( 0 )
 105
 106     extern uint32_t ulPortSetInterruptMask( void );
 107     extern void vPortClearInterruptMask( uint32_t ulNewMask );
 108     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulPortSetInterruptMask()
 109     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vPortClearInterruptMask( x )
 110
 111
 112     extern void vPortEnterCritical( void );
 113     extern void vPortExitCritical( void );
 114
 115     #define portDISABLE_INTERRUPTS()    portSET_INTERRUPT_MASK()
 116     #define portENABLE_INTERRUPTS()     portCLEAR_INTERRUPT_MASK()
 117     #define portENTER_CRITICAL()        vPortEnterCritical()
 118     #define portEXIT_CRITICAL()         vPortExitCritical()
 119
 120 /*-----------------------------------------------------------*/
 121
 122 /* Task function macros as described on the FreeRTOS.org WEB site. */
 123     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 124     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 125
 126     #define portNOP()
 127
 128     #ifdef __cplusplus
 129         }
 130     #endif
 131
 132 #endif /* PORTMACRO_H */