begriffs open source - freertos/blob - portable/Renesas/RX600v2/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
  30 #ifndef PORTMACRO_H
  31 #define PORTMACRO_H
  32
  33 /* *INDENT-OFF* */
  34 #ifdef __cplusplus
  35     extern "C" {
  36 #endif
  37 /* *INDENT-ON* */
  38
  39 /* Hardware specifics. */
  40 #include "machine.h"
  41
  42 /*-----------------------------------------------------------
  43  * Port specific definitions.
  44  *
  45  * The settings in this file configure FreeRTOS correctly for the
  46  * given hardware and compiler.
  47  *
  48  * These settings should not be altered.
  49  *-----------------------------------------------------------
  50  */
  51
  52 /* Type definitions - these are a bit legacy and not really used now, other than
  53  * portSTACK_TYPE and portBASE_TYPE. */
  54 #define portCHAR          char
  55 #define portFLOAT         float
  56 #define portDOUBLE        double
  57 #define portLONG          long
  58 #define portSHORT         short
  59 #define portSTACK_TYPE    uint32_t
  60 #define portBASE_TYPE     long
  61
  62 typedef portSTACK_TYPE   StackType_t;
  63 typedef long             BaseType_t;
  64 typedef unsigned long    UBaseType_t;
  65
  66 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
  67     typedef uint16_t     TickType_t;
  68     #define portMAX_DELAY              ( TickType_t ) 0xffff
  69 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
  70     typedef uint32_t     TickType_t;
  71     #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  72
  73 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  74  * not need to be guarded with a critical section. */
  75     #define portTICK_TYPE_IS_ATOMIC    1
  76 #else
  77     #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width.
  78 #endif
  79 /*-----------------------------------------------------------*/
  80
  81 /* Hardware specifics. */
  82 #define portBYTE_ALIGNMENT    8             /* Could make four, according to manual. */
  83 #define portSTACK_GROWTH      -1
  84 #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  85 #define portNOP()    nop()
  86
  87
  88 #pragma inline_asm vPortYield
  89 static void vPortYield( void )
  90 {
  91     /* Save clobbered register - may not actually be necessary if inline asm
  92      * functions are considered to use the same rules as function calls by the
  93      * compiler. */
  94     PUSH.L R5
  95     /* Set ITU SWINTR. */
  96     MOV.L # 553696, R5
  97         MOV.B # 1, [ R5 ]
  98     /* Read back to ensure the value is taken before proceeding. */
  99     MOV.L[ R5 ], R5
 100     /* Restore clobbered register to its previous value. */
 101     POP R5
 102 }
 103 #define portYIELD()                                       vPortYield()
 104 #define portYIELD_FROM_ISR( x )                           do { if( x != pdFALSE ) portYIELD( ); } while( 0 )
 105
 106 /* These macros should not be called directly, but through the
 107  * taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is
 108  * performed if configASSERT() is defined to ensure an assertion handler does not
 109  * inadvertently attempt to lower the IPL when the call to assert was triggered
 110  * because the IPL value was found to be above configMAX_SYSCALL_INTERRUPT_PRIORITY
 111  * when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API
 112  * functions are those that end in FromISR.  FreeRTOS maintains a separate
 113  * interrupt API to ensure API function and interrupt entry is as fast and as
 114  * simple as possible. */
 115 #define portENABLE_INTERRUPTS()                           set_ipl( ( long ) 0 )
 116 #ifdef configASSERT
 117     #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    configASSERT( ( get_ipl() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
 118     #define portDISABLE_INTERRUPTS()                      if( get_ipl() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 119 #else
 120     #define portDISABLE_INTERRUPTS()                      set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 121 #endif
 122
 123 /* Critical nesting counts are stored in the TCB. */
 124 #define portCRITICAL_NESTING_IN_TCB    ( 1 )
 125
 126 /* The critical nesting functions defined within tasks.c. */
 127 extern void vTaskEnterCritical( void );
 128 extern void vTaskExitCritical( void );
 129 #define portENTER_CRITICAL()                                           vTaskEnterCritical()
 130 #define portEXIT_CRITICAL()                                            vTaskExitCritical()
 131
 132 /* As this port allows interrupt nesting... */
 133 #define portSET_INTERRUPT_MASK_FROM_ISR()                              ( UBaseType_t ) get_ipl(); set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 134 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus )    set_ipl( ( long ) uxSavedInterruptStatus )
 135
 136 /*-----------------------------------------------------------*/
 137
 138 /* Task function macros as described on the FreeRTOS.org WEB site. */
 139 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 140 #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 141
 142 /* *INDENT-OFF* */
 143 #ifdef __cplusplus
 144     }
 145 #endif
 146 /* *INDENT-ON* */
 147
 148 #endif /* PORTMACRO_H */