begriffs open source - cmsis-freertos/blob - Source/portable/GCC/MicroBlaze/portmacro.h

   1 /*
   2  * FreeRTOS Kernel V11.2.0
   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
  68 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  69  * not need to be guarded with a critical section. */
  70     #define portTICK_TYPE_IS_ATOMIC    1
  71 #else
  72     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  73 #endif
  74 /*-----------------------------------------------------------*/
  75
  76 /* Interrupt control macros. */
  77 void microblaze_disable_interrupts( void );
  78 void microblaze_enable_interrupts( void );
  79 #define portDISABLE_INTERRUPTS()    microblaze_disable_interrupts()
  80 #define portENABLE_INTERRUPTS()     microblaze_enable_interrupts()
  81 /*-----------------------------------------------------------*/
  82
  83 /* Critical section macros. */
  84 void vPortEnterCritical( void );
  85 void vPortExitCritical( void );
  86 #define portENTER_CRITICAL()                  \
  87     {                                         \
  88         extern UBaseType_t uxCriticalNesting; \
  89         microblaze_disable_interrupts();      \
  90         uxCriticalNesting++;                  \
  91     }
  92
  93 #define portEXIT_CRITICAL()                      \
  94     {                                            \
  95         extern UBaseType_t uxCriticalNesting;    \
  96         /* Interrupts are disabled, so we can */ \
  97         /* access the variable directly. */      \
  98         uxCriticalNesting--;                     \
  99         if( uxCriticalNesting == 0 )             \
 100         {                                        \
 101             /* The nesting has unwound and we \
 102              * can enable interrupts again. */ \
 103             portENABLE_INTERRUPTS();           \
 104         }                                      \
 105     }
 106
 107 /*-----------------------------------------------------------*/
 108
 109 /* Task utilities. */
 110 void vPortYield( void );
 111 #define portYIELD()             vPortYield()
 112
 113 void vTaskSwitchContext();
 114 #define portYIELD_FROM_ISR()    vTaskSwitchContext()
 115 /*-----------------------------------------------------------*/
 116
 117 /* Hardware specifics. */
 118 #define portBYTE_ALIGNMENT    4
 119 #define portSTACK_GROWTH      ( -1 )
 120 #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
 121 #define portNOP()               asm volatile ( "NOP" )
 122 #define portMEMORY_BARRIER()    asm volatile ( "" ::: "memory" )
 123 /*-----------------------------------------------------------*/
 124
 125 /* Task function macros as described on the FreeRTOS.org WEB site. */
 126 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 127 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 128
 129 /* *INDENT-OFF* */
 130 #ifdef __cplusplus
 131     }
 132 #endif
 133 /* *INDENT-ON* */
 134
 135 #endif /* PORTMACRO_H */