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 #define portCHAR char 44 #define portFLOAT float 45 #define portDOUBLE double 46 #define portLONG long 47 #define portSHORT int 48 #define portBASE_TYPE portSHORT 49 50 /* The stack type changes depending on the data model. */ 51 #ifdef __LARGE_DATA_MODEL__ 52 #define portSTACK_TYPE uint32_t 53 #else 54 #define portSTACK_TYPE uint16_t 55 #define portPOINTER_SIZE_TYPE uint16_t 56 #endif 57 58 typedef portSTACK_TYPE StackType_t; 59 typedef short BaseType_t; 60 typedef unsigned short UBaseType_t; 61 62 #if( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS ) 63 typedef uint16_t TickType_t; 64 #define portMAX_DELAY ( TickType_t ) 0xffff 65 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS ) 66 typedef uint32_t TickType_t; 67 #define portMAX_DELAY ( TickType_t ) ( 0xFFFFFFFFUL ) 68 #else 69 #error configTICK_TYPE_WIDTH_IN_BITS set to unsupported tick type width. 70 #endif 71 72 /*-----------------------------------------------------------*/ 73 74 /* Interrupt control macros. */ 75 #define portDISABLE_INTERRUPTS() __asm volatile ( " DINT\n" " NOP" ) 76 #define portENABLE_INTERRUPTS() __asm volatile ( " NOP\n" " EINT\n" " NOP" ) 77 /*-----------------------------------------------------------*/ 78 79 /* Critical section control macros. */ 80 #define portNO_CRITICAL_SECTION_NESTING ( ( uint16_t ) 0 ) 81 82 #define portENTER_CRITICAL() \ 83 { \ 84 extern volatile uint16_t usCriticalNesting; \ 85 \ 86 portDISABLE_INTERRUPTS(); \ 87 \ 88 /* Now interrupts are disabled usCriticalNesting can be accessed */ \ 89 /* directly. Increment ulCriticalNesting to keep a count of how many */ \ 90 /* times portENTER_CRITICAL() has been called. */ \ 91 usCriticalNesting++; \ 92 } 93 94 #define portEXIT_CRITICAL() \ 95 { \ 96 extern volatile uint16_t usCriticalNesting; \ 97 \ 98 if( usCriticalNesting > portNO_CRITICAL_SECTION_NESTING ) \ 99 { \ 100 /* Decrement the nesting count as we are leaving a critical section. */ \ 101 usCriticalNesting--; \ 102 \ 103 /* If the nesting level has reached zero then interrupts should be */ \ 104 /* re-enabled. */ \ 105 if( usCriticalNesting == portNO_CRITICAL_SECTION_NESTING ) \ 106 { \ 107 portENABLE_INTERRUPTS(); \ 108 } \ 109 } \ 110 } 111 /*-----------------------------------------------------------*/ 112 113 /* Task utilities. */ 114 115 /* 116 * Manual context switch called by portYIELD or taskYIELD. 117 */ 118 extern void vPortYield( void ); 119 #define portYIELD() vPortYield() 120 /*-----------------------------------------------------------*/ 121 122 /* Hardware specifics. */ 123 #define portBYTE_ALIGNMENT 2 124 #define portSTACK_GROWTH ( -1 ) 125 #define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / configTICK_RATE_HZ ) 126 #define portNOP() __asm volatile ( " NOP" ) 127 /*-----------------------------------------------------------*/ 128 129 /* Task function macros as described on the FreeRTOS.org WEB site. */ 130 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters ) 131 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters ) 132 133 extern void vTaskSwitchContext( void ); 134 #define portYIELD_FROM_ISR( x ) do { if( x ) vPortYield(); } while( 0 ) 135 136 void vApplicationSetupTimerInterrupt( void ); 137 138 /* sizeof( int ) != sizeof( long ) so a full printf() library is required if 139 run time stats information is to be displayed. */ 140 #define portLU_PRINTF_SPECIFIER_REQUIRED 141 142 #endif /* PORTMACRO_H */ 143