begriffs open source - freertos/blob - portable/CodeWarrior/ColdFire_V2/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  uint32_t
  55 #define portBASE_TYPE   long
  56
  57 typedef portSTACK_TYPE StackType_t;
  58 typedef long BaseType_t;
  59 typedef unsigned long UBaseType_t;
  60
  61 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  62     typedef uint16_t TickType_t;
  63     #define portMAX_DELAY ( TickType_t ) 0xffff
  64 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
  65     typedef uint32_t TickType_t;
  66     #define portMAX_DELAY ( TickType_t )    ( 0xFFFFFFFFUL )
  67 #else
  68     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  69 #endif
  70 /*-----------------------------------------------------------*/
  71
  72 /* Hardware specifics. */
  73 #define portBYTE_ALIGNMENT          4
  74 #define portSTACK_GROWTH            -1
  75 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  76 /*-----------------------------------------------------------*/
  77 uint32_t ulPortSetIPL( uint32_t );
  78 #define portDISABLE_INTERRUPTS()    ulPortSetIPL( configMAX_SYSCALL_INTERRUPT_PRIORITY )
  79 #define portENABLE_INTERRUPTS()     ulPortSetIPL( 0 )
  80
  81
  82 extern void vPortEnterCritical( void );
  83 extern void vPortExitCritical( void );
  84 #define portENTER_CRITICAL()        vPortEnterCritical()
  85 #define portEXIT_CRITICAL()         vPortExitCritical()
  86
  87 extern UBaseType_t uxPortSetInterruptMaskFromISR( void );
  88 extern void vPortClearInterruptMaskFromISR( UBaseType_t );
  89 #define portSET_INTERRUPT_MASK_FROM_ISR()   ulPortSetIPL( configMAX_SYSCALL_INTERRUPT_PRIORITY )
  90 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusRegister ) ulPortSetIPL( uxSavedStatusRegister )
  91
  92 /*-----------------------------------------------------------*/
  93
  94 /* Task utilities. */
  95
  96 #define portNOP()   asm volatile (  "nop" )
  97
  98 /* Note this will overwrite all other bits in the force register, it is done this way for speed. */
  99 #define portYIELD()         MCF_INTC0_INTFRCL = ( 1UL << configYIELD_INTERRUPT_VECTOR ); portNOP(); portNOP() /* -32 as we are using the high word of the 64bit mask. */
 100
 101 /*-----------------------------------------------------------*/
 102
 103 /* Task function macros as described on the FreeRTOS.org WEB site. */
 104 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) __attribute__((noreturn))
 105 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
 106 /*-----------------------------------------------------------*/
 107
 108 #define portEND_SWITCHING_ISR( xSwitchRequired ) \
 109     do                                           \
 110     {                                            \
 111         if( xSwitchRequired != pdFALSE )         \
 112         {                                        \
 113             traceISR_EXIT_TO_SCHEDULER();        \
 114             portYIELD();                         \
 115         }                                        \
 116         else                                     \
 117         {                                        \
 118             traceISR_EXIT();                     \
 119         }                                        \
 120     } while( 0 )
 121
 122 /* *INDENT-OFF* */
 123 #ifdef __cplusplus
 124     }
 125 #endif
 126 /* *INDENT-ON* */
 127
 128 #endif /* PORTMACRO_H */