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 #ifndef PORTMACRO_H 30 #define PORTMACRO_H 31 32 /*----------------------------------------------------------- 33 * Port specific definitions. 34 * 35 * The settings in this file configure FreeRTOS correctly for the 36 * given hardware and compiler. 37 * 38 * These settings should not be altered. 39 *----------------------------------------------------------- 40 */ 41 42 /* Type definitions. */ 43 44 #define portCHAR char 45 #define portFLOAT float 46 #define portDOUBLE double 47 #define portLONG long 48 #define portSHORT short 49 #define portSTACK_TYPE uint16_t 50 #define portBASE_TYPE short 51 #define portPOINTER_SIZE_TYPE uint16_t 52 53 typedef portSTACK_TYPE StackType_t; 54 typedef short BaseType_t; 55 typedef unsigned short UBaseType_t; 56 57 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS ) 58 typedef uint16_t TickType_t; 59 #define portMAX_DELAY ( TickType_t ) 0xffff 60 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS ) 61 typedef uint32_t TickType_t; 62 #define portMAX_DELAY ( TickType_t ) ( 0xFFFFFFFFUL ) 63 #else 64 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width. 65 #endif 66 /*-----------------------------------------------------------*/ 67 68 /* Interrupt control macros. */ 69 #define portDISABLE_INTERRUPTS() __asm volatile ( "DI" ) 70 #define portENABLE_INTERRUPTS() __asm volatile ( "EI" ) 71 /*-----------------------------------------------------------*/ 72 73 /* Critical section control macros. */ 74 #define portNO_CRITICAL_SECTION_NESTING ( ( unsigned short ) 0 ) 75 76 #define portENTER_CRITICAL() \ 77 { \ 78 extern volatile uint16_t usCriticalNesting; \ 79 \ 80 portDISABLE_INTERRUPTS(); \ 81 \ 82 /* Now that interrupts are disabled, ulCriticalNesting can be accessed */ \ 83 /* directly. Increment ulCriticalNesting to keep a count of how many */ \ 84 /* times portENTER_CRITICAL() has been called. */ \ 85 usCriticalNesting++; \ 86 } 87 88 #define portEXIT_CRITICAL() \ 89 { \ 90 extern volatile uint16_t usCriticalNesting; \ 91 \ 92 if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING ) \ 93 { \ 94 /* Decrement the nesting count as we are leaving a critical section. */ \ 95 usCriticalNesting--; \ 96 \ 97 /* If the nesting level has reached zero then interrupts should be */ \ 98 /* re-enabled. */ \ 99 if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING ) \ 100 { \ 101 portENABLE_INTERRUPTS(); \ 102 } \ 103 } \ 104 } 105 /*-----------------------------------------------------------*/ 106 107 /* Task utilities. */ 108 #define portYIELD() __asm volatile ( "BRK" ) 109 #ifndef configREQUIRE_ASM_ISR_WRAPPER 110 #define configREQUIRE_ASM_ISR_WRAPPER 1 111 #endif 112 #if( configREQUIRE_ASM_ISR_WRAPPER == 1 ) 113 /* You must implement an assembly ISR wrapper (see the below for details) if you need an ISR to cause a context switch. 114 * https://www.freertos.org/Documentation/02-Kernel/03-Supported-devices/04-Demos/Renesas/RTOS_RL78_IAR_Demos#writing-interrupt-service-routines */ 115 #define portYIELD_FROM_ISR( xHigherPriorityTaskWoken ) do { if( xHigherPriorityTaskWoken != pdFALSE ) vTaskSwitchContext(); } while( 0 ) 116 #else 117 /* You must not implement an assembly ISR wrapper even if you need an ISR to cause a context switch. 118 * The portYIELD, which is similar to role of an assembly ISR wrapper, runs only when a context switch is required. */ 119 #define portYIELD_FROM_ISR( xHigherPriorityTaskWoken ) do { if( xHigherPriorityTaskWoken != pdFALSE ) portYIELD(); } while( 0 ) 120 #endif 121 #define portNOP() __asm volatile ( "NOP" ) 122 /*-----------------------------------------------------------*/ 123 124 /* Hardware specifics. */ 125 #define portBYTE_ALIGNMENT 2 126 #define portSTACK_GROWTH ( -1 ) 127 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 128 /*-----------------------------------------------------------*/ 129 130 /* Task function macros as described on the FreeRTOS.org WEB site. */ 131 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters ) 132 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters ) 133 134 #endif /* PORTMACRO_H */ 135