begriffs open source - cmsis-freertos/blob - Source/portable/Renesas/RX100/portmacro.h

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