1 /* 2 * FreeRTOS Kernel V11.1.0 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 #include <intrinsics.h> 34 35 /* *INDENT-OFF* */ 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 /* *INDENT-ON* */ 40 41 /* Hardware specifics. */ 42 #include "machine.h" 43 44 /*----------------------------------------------------------- 45 * Port specific definitions. 46 * 47 * The settings in this file configure FreeRTOS correctly for the 48 * given hardware and compiler. 49 * 50 * These settings should not be altered. 51 *----------------------------------------------------------- 52 */ 53 54 /* Type definitions - these are a bit legacy and not really used now, other than 55 * portSTACK_TYPE and portBASE_TYPE. */ 56 #define portCHAR char 57 #define portFLOAT float 58 #define portDOUBLE double 59 #define portLONG long 60 #define portSHORT short 61 #define portSTACK_TYPE uint32_t 62 #define portBASE_TYPE long 63 64 typedef portSTACK_TYPE StackType_t; 65 typedef long BaseType_t; 66 typedef unsigned long UBaseType_t; 67 68 69 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS ) 70 typedef uint16_t TickType_t; 71 #define portMAX_DELAY ( TickType_t ) 0xffff 72 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS ) 73 typedef uint32_t TickType_t; 74 #define portMAX_DELAY ( TickType_t ) 0xffffffffUL 75 76 /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do 77 * not need to be guarded with a critical section. */ 78 #define portTICK_TYPE_IS_ATOMIC 1 79 #else 80 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width. 81 #endif 82 /*-----------------------------------------------------------*/ 83 84 /* Hardware specifics. */ 85 #define portBYTE_ALIGNMENT 8 /* Could make four, according to manual. */ 86 #define portSTACK_GROWTH -1 87 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 88 #define portNOP() __no_operation() 89 90 #define portYIELD() \ 91 __asm volatile \ 92 ( \ 93 "MOV.L #0x872E0, R15 \n" \ 94 "MOV.B #1, [R15] \n" \ 95 "MOV.L [R15], R15 \n" \ 96 ::: "R15" \ 97 ) 98 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_interrupt_level( ( uint8_t ) 0 ) 111 #ifdef configASSERT 112 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( __get_interrupt_level() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) ) 113 #define portDISABLE_INTERRUPTS() if( __get_interrupt_level() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __set_interrupt_level( ( uint8_t ) configMAX_SYSCALL_INTERRUPT_PRIORITY ) 114 #else 115 #define portDISABLE_INTERRUPTS() __set_interrupt_level( ( uint8_t ) 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() __get_interrupt_level(); portDISABLE_INTERRUPTS() 129 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) __set_interrupt_level( ( uint8_t ) ( uxSavedInterruptStatus ) ) 130 131 /* Tickless idle/low power functionality. */ 132 #if configUSE_TICKLESS_IDLE == 1 133 #ifndef portSUPPRESS_TICKS_AND_SLEEP 134 extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime ); 135 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime ) 136 #endif 137 #endif 138 139 /*-----------------------------------------------------------*/ 140 141 /* Task function macros as described on the FreeRTOS.org WEB site. */ 142 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void * pvParameters ) 143 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void * pvParameters ) 144 145 /* Prevent warnings of undefined behaviour: the order of volatile accesses is 146 * undefined - all warnings have been manually checked and are not an issue, and 147 * the warnings cannot be prevent by code changes without undesirable effects. */ 148 #pragma diag_suppress=Pa082 149 150 /* *INDENT-OFF* */ 151 #ifdef __cplusplus 152 } 153 #endif 154 /* *INDENT-ON* */ 155 156 #endif /* PORTMACRO_H */ 157
