begriffs open source - freertos/blob - portable/IAR/V850ES/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 #ifndef PORTMACRO_H
  30 #define PORTMACRO_H
  31
  32 /* *INDENT-OFF* */
  33 #ifdef __cplusplus
  34     extern "C" {
  35 #endif
  36 /* *INDENT-ON* */
  37
  38 /*-----------------------------------------------------------
  39  * Port specific definitions.
  40  *
  41  * The settings in this file configure FreeRTOS correctly for the
  42  * given hardware and compiler.
  43  *
  44  * These settings should not be altered.
  45  *-----------------------------------------------------------
  46  */
  47
  48 /* Type definitions. */
  49 #define portCHAR        char
  50 #define portFLOAT       float
  51 #define portDOUBLE      double
  52 #define portLONG        long
  53 #define portSHORT       short
  54 #define portSTACK_TYPE  unsigned int
  55 #define portBASE_TYPE   int
  56
  57 typedef portSTACK_TYPE StackType_t;
  58 typedef long BaseType_t;
  59 typedef unsigned long UBaseType_t;
  60
  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 #else
  69     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  70 #endif
  71 /*-----------------------------------------------------------*/
  72
  73 /* Interrupt control macros. */
  74 #define portDISABLE_INTERRUPTS() __asm ( "DI" )
  75 #define portENABLE_INTERRUPTS()  __asm ( "EI" )
  76 /*-----------------------------------------------------------*/
  77
  78 /* Critical section control macros. */
  79 #define portNO_CRITICAL_SECTION_NESTING     ( ( UBaseType_t ) 0 )
  80
  81 #define portENTER_CRITICAL()                                                        \
  82 {                                                                                   \
  83 extern volatile /*uint16_t*/ portSTACK_TYPE usCriticalNesting;                      \
  84                                                                                     \
  85     portDISABLE_INTERRUPTS();                                                       \
  86                                                                                     \
  87     /* Now interrupts are disabled ulCriticalNesting can be accessed */             \
  88     /* directly.  Increment ulCriticalNesting to keep a count of how many */        \
  89     /* times portENTER_CRITICAL() has been called. */                               \
  90     usCriticalNesting++;                                                            \
  91 }
  92
  93 #define portEXIT_CRITICAL()                                                         \
  94 {                                                                                   \
  95 extern volatile /*uint16_t*/ portSTACK_TYPE usCriticalNesting;                      \
  96                                                                                     \
  97     if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING )                       \
  98     {                                                                               \
  99         /* Decrement the nesting count as we are leaving a critical section. */     \
 100         usCriticalNesting--;                                                        \
 101                                                                                     \
 102         /* If the nesting level has reached zero then interrupts should be */       \
 103         /* re-enabled. */                                                           \
 104         if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING )                  \
 105         {                                                                           \
 106             portENABLE_INTERRUPTS();                                                \
 107         }                                                                           \
 108     }                                                                               \
 109 }
 110 /*-----------------------------------------------------------*/
 111
 112 /* Task utilities. */
 113 extern void vPortYield( void );
 114 extern void vPortStart( void );
 115 extern void portSAVE_CONTEXT( void );
 116 extern void portRESTORE_CONTEXT( void );
 117 #define portYIELD() __asm ( "trap 0" )
 118 #define portNOP()   __asm ( "NOP" )
 119 extern void vTaskSwitchContext( void );
 120 #define portYIELD_FROM_ISR( xHigherPriorityTaskWoken ) do { if( xHigherPriorityTaskWoken ) vTaskSwitchContext(); } while( 0 )
 121
 122 /*-----------------------------------------------------------*/
 123
 124 /* Hardwware specifics. */
 125 #define portBYTE_ALIGNMENT  4
 126 #define portSTACK_GROWTH    ( -1 )
 127 #define portTICK_PERIOD_MS  ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
 128 /*-----------------------------------------------------------*/
 129
 130 /* Task function macros as described on the FreeRTOS.org WEB site. */
 131 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
 132 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
 133
 134
 135 /* *INDENT-OFF* */
 136 #ifdef __cplusplus
 137     }
 138 #endif
 139 /* *INDENT-ON* */
 140
 141 #endif /* PORTMACRO_H */