begriffs open source - freertos/blob - portable/GCC/ARM_CM0/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>\r
   3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * https://www.FreeRTOS.org\r
  23  * https://github.com/FreeRTOS\r
  24  *\r
  25  */\r
  26 \r
  27 \r
  28 #ifndef PORTMACRO_H\r
  29     #define PORTMACRO_H\r
  30 \r
  31     #ifdef __cplusplus\r
  32         extern "C" {\r
  33     #endif\r
  34 \r
  35 /*-----------------------------------------------------------\r
  36  * Port specific definitions.\r
  37  *\r
  38  * The settings in this file configure FreeRTOS correctly for the\r
  39  * given hardware and compiler.\r
  40  *\r
  41  * These settings should not be altered.\r
  42  *-----------------------------------------------------------\r
  43  */\r
  44 \r
  45 /* Type definitions. */\r
  46     #define portCHAR          char\r
  47     #define portFLOAT         float\r
  48     #define portDOUBLE        double\r
  49     #define portLONG          long\r
  50     #define portSHORT         short\r
  51     #define portSTACK_TYPE    uint32_t\r
  52     #define portBASE_TYPE     long\r
  53 \r
  54     typedef portSTACK_TYPE   StackType_t;\r
  55     typedef long             BaseType_t;\r
  56     typedef unsigned long    UBaseType_t;\r
  57 \r
  58     #if ( configUSE_16_BIT_TICKS == 1 )\r
  59         typedef uint16_t     TickType_t;\r
  60         #define portMAX_DELAY              ( TickType_t ) 0xffff\r
  61     #else\r
  62         typedef uint32_t     TickType_t;\r
  63         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL\r
  64 \r
  65 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  66  * not need to be guarded with a critical section. */\r
  67         #define portTICK_TYPE_IS_ATOMIC    1\r
  68     #endif\r
  69 /*-----------------------------------------------------------*/\r
  70 \r
  71 /* Architecture specifics. */\r
  72     #define portSTACK_GROWTH      ( -1 )\r
  73     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  74     #define portBYTE_ALIGNMENT    8\r
  75     #define portDONT_DISCARD      __attribute__( ( used ) )\r
  76 /*-----------------------------------------------------------*/\r
  77 \r
  78 \r
  79 /* Scheduler utilities. */\r
  80     extern void vPortYield( void );\r
  81     #define portNVIC_INT_CTRL_REG     ( *( ( volatile uint32_t * ) 0xe000ed04 ) )\r
  82     #define portNVIC_PENDSVSET_BIT    ( 1UL << 28UL )\r
  83     #define portYIELD()                                 vPortYield()\r
  84     #define portEND_SWITCHING_ISR( xSwitchRequired )    do { if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT; } while( 0 )\r
  85     #define portYIELD_FROM_ISR( x )                     portEND_SWITCHING_ISR( x )\r
  86 /*-----------------------------------------------------------*/\r
  87 \r
  88 \r
  89 /* Critical section management. */\r
  90     extern void vPortEnterCritical( void );\r
  91     extern void vPortExitCritical( void );\r
  92     extern uint32_t ulSetInterruptMaskFromISR( void ) __attribute__( ( naked ) );\r
  93     extern void vClearInterruptMaskFromISR( uint32_t ulMask )  __attribute__( ( naked ) );\r
  94 \r
  95     #define portSET_INTERRUPT_MASK_FROM_ISR()         ulSetInterruptMaskFromISR()\r
  96     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( x )    vClearInterruptMaskFromISR( x )\r
  97     #define portDISABLE_INTERRUPTS()                  __asm volatile ( " cpsid i " ::: "memory" )\r
  98     #define portENABLE_INTERRUPTS()                   __asm volatile ( " cpsie i " ::: "memory" )\r
  99     #define portENTER_CRITICAL()                      vPortEnterCritical()\r
 100     #define portEXIT_CRITICAL()                       vPortExitCritical()\r
 101 \r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 /* Tickless idle/low power functionality. */\r
 105     #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 106         extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 107         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )    vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 108     #endif\r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 112     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )\r
 113     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )\r
 114 \r
 115     #define portNOP()\r
 116 \r
 117     #define portMEMORY_BARRIER()    __asm volatile ( "" ::: "memory" )\r
 118 \r
 119     #ifdef __cplusplus\r
 120         }\r
 121     #endif\r
 122 \r
 123 #endif /* PORTMACRO_H */\r