begriffs open source - freertos/blob - portable/GCC/RISC-V/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 /*-----------------------------------------------------------
  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 /* Type definitions. */
  50 #if __riscv_xlen == 64
  51     #define portSTACK_TYPE          uint64_t
  52     #define portBASE_TYPE           int64_t
  53     #define portUBASE_TYPE          uint64_t
  54     #define portMAX_DELAY           ( TickType_t ) 0xffffffffffffffffUL
  55     #define portPOINTER_SIZE_TYPE   uint64_t
  56 #elif __riscv_xlen == 32
  57     #define portSTACK_TYPE          uint32_t
  58     #define portBASE_TYPE           int32_t
  59     #define portUBASE_TYPE          uint32_t
  60     #define portMAX_DELAY           ( TickType_t ) 0xffffffffUL
  61 #else
  62     #error Assembler did not define __riscv_xlen
  63 #endif
  64
  65 typedef portSTACK_TYPE StackType_t;
  66 typedef portBASE_TYPE BaseType_t;
  67 typedef portUBASE_TYPE UBaseType_t;
  68 typedef portUBASE_TYPE TickType_t;
  69
  70 /* Legacy type definitions. */
  71 #define portCHAR            char
  72 #define portFLOAT           float
  73 #define portDOUBLE          double
  74 #define portLONG            long
  75 #define portSHORT           short
  76
  77 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do
  78  * not need to be guarded with a critical section. */
  79 #define portTICK_TYPE_IS_ATOMIC 1
  80 /*-----------------------------------------------------------*/
  81
  82 /* Architecture specifics. */
  83 #define portSTACK_GROWTH            ( -1 )
  84 #define portTICK_PERIOD_MS          ( ( TickType_t ) 1000 / configTICK_RATE_HZ )
  85 #ifdef __riscv_32e
  86     #define portBYTE_ALIGNMENT      8   /* RV32E uses RISC-V EABI with reduced stack alignment requirements */
  87 #else
  88     #define portBYTE_ALIGNMENT      16
  89 #endif
  90 /*-----------------------------------------------------------*/
  91
  92 /* Scheduler utilities. */
  93 extern void vTaskSwitchContext( void );
  94 #define portYIELD() __asm volatile( "ecall" );
  95 #define portEND_SWITCHING_ISR( xSwitchRequired ) do { if( xSwitchRequired ) vTaskSwitchContext(); } while( 0 )
  96 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )
  97 /*-----------------------------------------------------------*/
  98
  99 /* Critical section management. */
 100 #define portCRITICAL_NESTING_IN_TCB                             0
 101
 102 #define portSET_INTERRUPT_MASK_FROM_ISR()                       0
 103 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusValue ) ( void ) uxSavedStatusValue
 104
 105 #define portDISABLE_INTERRUPTS()    __asm volatile( "csrc mstatus, 8" )
 106 #define portENABLE_INTERRUPTS()     __asm volatile( "csrs mstatus, 8" )
 107
 108 extern size_t xCriticalNesting;
 109 #define portENTER_CRITICAL()            \
 110 {                                       \
 111     portDISABLE_INTERRUPTS();           \
 112     xCriticalNesting++;                 \
 113 }
 114
 115 #define portEXIT_CRITICAL()             \
 116 {                                       \
 117     xCriticalNesting--;                 \
 118     if( xCriticalNesting == 0 )         \
 119     {                                   \
 120         portENABLE_INTERRUPTS();        \
 121     }                                   \
 122 }
 123
 124 /*-----------------------------------------------------------*/
 125
 126 /* Architecture specific optimisations. */
 127 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
 128     #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
 129 #endif
 130
 131 #if( configUSE_PORT_OPTIMISED_TASK_SELECTION == 1 )
 132
 133     /* Check the configuration. */
 134     #if( configMAX_PRIORITIES > 32 )
 135         #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32.  It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.
 136     #endif
 137
 138     /* Store/clear the ready priorities in a bit map. */
 139     #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )
 140     #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )
 141
 142     /*-----------------------------------------------------------*/
 143
 144     #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - __builtin_clz( uxReadyPriorities ) )
 145
 146 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
 147
 148
 149 /*-----------------------------------------------------------*/
 150
 151 /* Task function macros as described on the FreeRTOS.org WEB site. These are
 152  * not necessary for to use this port.  They are defined so the common demo
 153  * files (which build with all the ports) will build. */
 154 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
 155 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
 156
 157 /*-----------------------------------------------------------*/
 158
 159 #define portNOP()    __asm volatile( " nop " )
 160 #define portINLINE   __inline
 161
 162 #ifndef portFORCE_INLINE
 163     #define portFORCE_INLINE inline __attribute__(( always_inline))
 164 #endif
 165
 166 #define portMEMORY_BARRIER() __asm volatile( "" ::: "memory" )
 167 /*-----------------------------------------------------------*/
 168
 169 /* configCLINT_BASE_ADDRESS is a legacy definition that was replaced by the
 170  * configMTIME_BASE_ADDRESS and configMTIMECMP_BASE_ADDRESS definitions.  For
 171  * backward compatibility derive the newer definitions from the old if the old
 172  * definition is found. */
 173 #if defined( configCLINT_BASE_ADDRESS ) && !defined( configMTIME_BASE_ADDRESS ) && ( configCLINT_BASE_ADDRESS == 0 )
 174     /* Legacy case where configCLINT_BASE_ADDRESS was defined as 0 to indicate
 175      * there was no CLINT.  Equivalent now is to set the MTIME and MTIMECMP
 176      * addresses to 0. */
 177     #define configMTIME_BASE_ADDRESS     ( 0 )
 178     #define configMTIMECMP_BASE_ADDRESS ( 0 )
 179 #elif defined( configCLINT_BASE_ADDRESS ) && !defined( configMTIME_BASE_ADDRESS )
 180     /* Legacy case where configCLINT_BASE_ADDRESS was set to the base address of
 181      * the CLINT.  Equivalent now is to derive the MTIME and MTIMECMP addresses
 182      * from the CLINT address. */
 183     #define configMTIME_BASE_ADDRESS     ( ( configCLINT_BASE_ADDRESS ) + 0xBFF8UL )
 184     #define configMTIMECMP_BASE_ADDRESS ( ( configCLINT_BASE_ADDRESS ) + 0x4000UL )
 185 #elif !defined( configMTIME_BASE_ADDRESS ) || !defined( configMTIMECMP_BASE_ADDRESS )
 186     #error configMTIME_BASE_ADDRESS and configMTIMECMP_BASE_ADDRESS must be defined in FreeRTOSConfig.h.  Set them to zero if there is no MTIME (machine time) clock.  See https://www.FreeRTOS.org/Using-FreeRTOS-on-RISC-V.html
 187 #endif
 188
 189 /* *INDENT-OFF* */
 190 #ifdef __cplusplus
 191     }
 192 #endif
 193 /* *INDENT-ON* */
 194
 195 #endif /* PORTMACRO_H */