begriffs open source - freertos/blob - portable/Renesas/RX700v3_DPFPU/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     #ifdef __cplusplus
  34         extern "C" {
  35     #endif
  36
  37 /* Hardware specifics. */
  38     #include <machine.h>
  39
  40 /*-----------------------------------------------------------
  41  * Port specific definitions.
  42  *
  43  * The settings in this file configure FreeRTOS correctly for the
  44  * given hardware and compiler.
  45  *
  46  * These settings should not be altered.
  47  *-----------------------------------------------------------
  48  */
  49
  50 /* When the FIT configurator or the Smart Configurator is used, platform.h has to be
  51  * used. */
  52     #ifndef configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H
  53         #define configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 0
  54     #endif
  55
  56 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or undefined) then each task will
  57  * be created without a DPFPU context, and a task must call vTaskUsesDPFPU() before
  58  * making use of any DPFPU registers.  If configUSE_TASK_DPFPU_SUPPORT is set to 2 then
  59  * tasks are created with a DPFPU context by default, and calling vTaskUsesDPFPU() has
  60  * no effect.  If configUSE_TASK_DPFPU_SUPPORT is set to 0 then tasks never take care
  61  * of any DPFPU context (even if DPFPU registers are used). */
  62     #ifndef configUSE_TASK_DPFPU_SUPPORT
  63         #define configUSE_TASK_DPFPU_SUPPORT 1
  64     #endif
  65
  66 /*-----------------------------------------------------------*/
  67
  68 /* Type definitions - these are a bit legacy and not really used now, other than
  69  * portSTACK_TYPE and portBASE_TYPE. */
  70     #define portCHAR          char
  71     #define portFLOAT         float
  72     #define portDOUBLE        double
  73     #define portLONG          long
  74     #define portSHORT         short
  75     #define portSTACK_TYPE    uint32_t
  76     #define portBASE_TYPE     long
  77
  78     typedef portSTACK_TYPE   StackType_t;
  79     typedef long             BaseType_t;
  80     typedef unsigned long    UBaseType_t;
  81
  82     #if ( configUSE_16_BIT_TICKS == 1 )
  83         typedef uint16_t     TickType_t;
  84         #define portMAX_DELAY              ( TickType_t ) 0xffff
  85     #else
  86         typedef uint32_t     TickType_t;
  87         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  88
  89 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  90  * not need to be guarded with a critical section. */
  91         #define portTICK_TYPE_IS_ATOMIC    1
  92     #endif
  93
  94 /*-----------------------------------------------------------*/
  95
  96 /* Hardware specifics. */
  97     #define portBYTE_ALIGNMENT    8     /* Could make four, according to manual. */
  98     #define portSTACK_GROWTH      -1
  99     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
 100     #define portNOP()    nop()
 101
 102 /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;"
 103  * where portITU_SWINTR is the location of the software interrupt register
 104  * (0x000872E0).  Don't rely on the assembler to select a register, so instead
 105  * save and restore clobbered registers manually. */
 106     #pragma inline_asm vPortYield
 107     static void vPortYield( void )
 108     {
 109     #ifndef __CDT_PARSER__
 110         /* Save clobbered register - may not actually be necessary if inline asm
 111          * functions are considered to use the same rules as function calls by the
 112          * compiler. */
 113         PUSH.L R5
 114         /* Set ITU SWINTR. */
 115         MOV.L # 000872E0H, R5
 116         MOV.B # 1, [ R5 ]
 117         /* Read back to ensure the value is taken before proceeding. */
 118         CMP [ R5 ].UB, R5
 119         /* Restore clobbered register to its previous value. */
 120         POP R5
 121     #endif
 122     }
 123
 124     #define portYIELD()                                       vPortYield()
 125     #define portYIELD_FROM_ISR( x )                           do { if( ( x ) != pdFALSE ) portYIELD(); } while( 0 )
 126
 127 /* These macros should not be called directly, but through the
 128  * taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is
 129  * performed if configASSERT() is defined to ensure an assertion handler does not
 130  * inadvertently attempt to lower the IPL when the call to assert was triggered
 131  * because the IPL value was found to be above  configMAX_SYSCALL_INTERRUPT_PRIORITY
 132  * when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API
 133  * functions are those that end in FromISR.  FreeRTOS maintains a separate
 134  * interrupt API to ensure API function and interrupt entry is as fast and as
 135  * simple as possible. */
 136     #define portENABLE_INTERRUPTS()                           set_ipl( ( long ) 0 )
 137     #ifdef configASSERT
 138         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    configASSERT( ( get_ipl() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
 139         #define portDISABLE_INTERRUPTS()                      if( get_ipl() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 140     #else
 141         #define portDISABLE_INTERRUPTS()                      set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 142     #endif
 143
 144 /* Critical nesting counts are stored in the TCB. */
 145     #define portCRITICAL_NESTING_IN_TCB    ( 1 )
 146
 147 /* The critical nesting functions defined within tasks.c. */
 148     extern void vTaskEnterCritical( void );
 149     extern void vTaskExitCritical( void );
 150     #define portENTER_CRITICAL()    vTaskEnterCritical()
 151     #define portEXIT_CRITICAL()     vTaskExitCritical()
 152
 153 /* As this port allows interrupt nesting... */
 154     #define portSET_INTERRUPT_MASK_FROM_ISR()                              ( UBaseType_t ) get_ipl(); set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 155     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus )    set_ipl( ( long ) uxSavedInterruptStatus )
 156
 157 /*-----------------------------------------------------------*/
 158
 159 /* Task function macros as described on the FreeRTOS.org WEB site. */
 160     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 161     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 162
 163 /*-----------------------------------------------------------*/
 164
 165 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or left undefined) then tasks are
 166  * created without a DPFPU context and must call vPortTaskUsesDPFPU() to give
 167  * themselves a DPFPU context before using any DPFPU instructions.  If
 168  * configUSE_TASK_DPFPU_SUPPORT is set to 2 then all tasks will have a DPFPU context
 169  * by default. */
 170     #if( configUSE_TASK_DPFPU_SUPPORT == 1 )
 171         void vPortTaskUsesDPFPU( void );
 172     #else
 173 /* Each task has a DPFPU context already, so define this function away to
 174  * nothing to prevent it being called accidentally. */
 175         #define vPortTaskUsesDPFPU()
 176     #endif
 177     #define portTASK_USES_DPFPU() vPortTaskUsesDPFPU()
 178
 179 /* Definition to allow compatibility with existing FreeRTOS Demo using flop.c. */
 180     #define portTASK_USES_FLOATING_POINT() vPortTaskUsesDPFPU()
 181
 182     #ifdef __cplusplus
 183         }
 184     #endif
 185
 186 #endif /* PORTMACRO_H */