begriffs open source - freertos/blob - portable/Renesas/RX700v3_DPFPU/portmacro.h

   1 /*
   2  * FreeRTOS Kernel V10.4.2
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * https://www.FreeRTOS.org
  23  * https://github.com/FreeRTOS
  24  *
  25  * 1 tab == 4 spaces!
  26  */
  27
  28
  29 #ifndef PORTMACRO_H
  30     #define PORTMACRO_H
  31
  32     #ifdef __cplusplus
  33         extern "C" {
  34     #endif
  35
  36 /* Hardware specifics. */
  37     #include <machine.h>
  38
  39 /*-----------------------------------------------------------
  40  * Port specific definitions.
  41  *
  42  * The settings in this file configure FreeRTOS correctly for the
  43  * given hardware and compiler.
  44  *
  45  * These settings should not be altered.
  46  *-----------------------------------------------------------
  47  */
  48
  49 /* When the FIT configurator or the Smart Configurator is used, platform.h has to be
  50  * used. */
  51     #ifndef configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H
  52         #define configINCLUDE_PLATFORM_H_INSTEAD_OF_IODEFINE_H 0
  53     #endif
  54
  55 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or undefined) then each task will
  56  * be created without a DPFPU context, and a task must call vTaskUsesDPFPU() before
  57  * making use of any DPFPU registers.  If configUSE_TASK_DPFPU_SUPPORT is set to 2 then
  58  * tasks are created with a DPFPU context by default, and calling vTaskUsesDPFPU() has
  59  * no effect.  If configUSE_TASK_DPFPU_SUPPORT is set to 0 then tasks never take care
  60  * of any DPFPU context (even if DPFPU registers are used). */
  61     #ifndef configUSE_TASK_DPFPU_SUPPORT
  62         #define configUSE_TASK_DPFPU_SUPPORT 1
  63     #endif
  64
  65 /*-----------------------------------------------------------*/
  66
  67 /* Type definitions - these are a bit legacy and not really used now, other than
  68  * portSTACK_TYPE and portBASE_TYPE. */
  69     #define portCHAR          char
  70     #define portFLOAT         float
  71     #define portDOUBLE        double
  72     #define portLONG          long
  73     #define portSHORT         short
  74     #define portSTACK_TYPE    uint32_t
  75     #define portBASE_TYPE     long
  76
  77     typedef portSTACK_TYPE   StackType_t;
  78     typedef long             BaseType_t;
  79     typedef unsigned long    UBaseType_t;
  80
  81     #if ( configUSE_16_BIT_TICKS == 1 )
  82         typedef uint16_t     TickType_t;
  83         #define portMAX_DELAY              ( TickType_t ) 0xffff
  84     #else
  85         typedef uint32_t     TickType_t;
  86         #define portMAX_DELAY              ( TickType_t ) 0xffffffffUL
  87
  88 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  89  * not need to be guarded with a critical section. */
  90         #define portTICK_TYPE_IS_ATOMIC    1
  91     #endif
  92
  93 /*-----------------------------------------------------------*/
  94
  95 /* Hardware specifics. */
  96     #define portBYTE_ALIGNMENT    8     /* Could make four, according to manual. */
  97     #define portSTACK_GROWTH      -1
  98     #define portTICK_PERIOD_MS    ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  99     #define portNOP()    nop()
 100
 101 /* Yield equivalent to "*portITU_SWINTR = 0x01; ( void ) *portITU_SWINTR;"
 102  * where portITU_SWINTR is the location of the software interrupt register
 103  * (0x000872E0).  Don't rely on the assembler to select a register, so instead
 104  * save and restore clobbered registers manually. */
 105     #pragma inline_asm vPortYield
 106     static void vPortYield( void )
 107     {
 108     #ifndef __CDT_PARSER__
 109         /* Save clobbered register - may not actually be necessary if inline asm
 110          * functions are considered to use the same rules as function calls by the
 111          * compiler. */
 112         PUSH.L R5
 113         /* Set ITU SWINTR. */
 114         MOV.L # 000872E0H, R5
 115         MOV.B # 1, [ R5 ]
 116         /* Read back to ensure the value is taken before proceeding. */
 117         CMP [ R5 ].UB, R5
 118         /* Restore clobbered register to its previous value. */
 119         POP R5
 120     #endif
 121     }
 122
 123     #define portYIELD()                                       vPortYield()
 124     #define portYIELD_FROM_ISR( x )                           if( ( x ) != pdFALSE ) portYIELD()
 125
 126 /* These macros should not be called directly, but through the
 127  * taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is
 128  * performed if configASSERT() is defined to ensure an assertion handler does not
 129  * inadvertently attempt to lower the IPL when the call to assert was triggered
 130  * because the IPL value was found to be above  configMAX_SYSCALL_INTERRUPT_PRIORITY
 131  * when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API
 132  * functions are those that end in FromISR.  FreeRTOS maintains a separate
 133  * interrupt API to ensure API function and interrupt entry is as fast and as
 134  * simple as possible. */
 135     #define portENABLE_INTERRUPTS()                           set_ipl( ( long ) 0 )
 136     #ifdef configASSERT
 137         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()    configASSERT( ( get_ipl() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )
 138         #define portDISABLE_INTERRUPTS()                      if( get_ipl() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 139     #else
 140         #define portDISABLE_INTERRUPTS()                      set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 141     #endif
 142
 143 /* Critical nesting counts are stored in the TCB. */
 144     #define portCRITICAL_NESTING_IN_TCB    ( 1 )
 145
 146 /* The critical nesting functions defined within tasks.c. */
 147     extern void vTaskEnterCritical( void );
 148     extern void vTaskExitCritical( void );
 149     #define portENTER_CRITICAL()    vTaskEnterCritical()
 150     #define portEXIT_CRITICAL()     vTaskExitCritical()
 151
 152 /* As this port allows interrupt nesting... */
 153     #define portSET_INTERRUPT_MASK_FROM_ISR()                              ( UBaseType_t ) get_ipl(); set_ipl( ( long ) configMAX_SYSCALL_INTERRUPT_PRIORITY )
 154     #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus )    set_ipl( ( long ) uxSavedInterruptStatus )
 155
 156 /*-----------------------------------------------------------*/
 157
 158 /* Task function macros as described on the FreeRTOS.org WEB site. */
 159     #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )    void vFunction( void * pvParameters )
 160     #define portTASK_FUNCTION( vFunction, pvParameters )          void vFunction( void * pvParameters )
 161
 162 /*-----------------------------------------------------------*/
 163
 164 /* If configUSE_TASK_DPFPU_SUPPORT is set to 1 (or left undefined) then tasks are
 165  * created without a DPFPU context and must call vPortTaskUsesDPFPU() to give
 166  * themselves a DPFPU context before using any DPFPU instructions.  If
 167  * configUSE_TASK_DPFPU_SUPPORT is set to 2 then all tasks will have a DPFPU context
 168  * by default. */
 169     #if( configUSE_TASK_DPFPU_SUPPORT == 1 )
 170         void vPortTaskUsesDPFPU( void );
 171     #else
 172 /* Each task has a DPFPU context already, so define this function away to
 173  * nothing to prevent it being called accidentally. */
 174         #define vPortTaskUsesDPFPU()
 175     #endif
 176     #define portTASK_USES_DPFPU() vPortTaskUsesDPFPU()
 177
 178 /* Definition to allow compatibility with existing FreeRTOS Demo using flop.c. */
 179     #define portTASK_USES_FLOATING_POINT() vPortTaskUsesDPFPU()
 180
 181     #ifdef __cplusplus
 182         }
 183     #endif
 184
 185 #endif /* PORTMACRO_H */