git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/IA32_flat/portmacro.h

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 #ifndef PORTMACRO_H\r
  29 #define PORTMACRO_H\r
  30 \r
  31 #ifdef __cplusplus\r
  32         extern "C" {\r
  33 #endif\r
  34 \r
  35 /*-----------------------------------------------------------\r
  36  * Port specific definitions.\r
  37  *\r
  38  * The settings in this file configure FreeRTOS correctly for the given hardware\r
  39  * and compiler.\r
  40  *\r
  41  * These settings should not be altered.\r
  42  *-----------------------------------------------------------\r
  43  */\r
  44 \r
  45 /* Type definitions. */\r
  46 #define portCHAR                char\r
  47 #define portFLOAT               float\r
  48 #define portDOUBLE              double\r
  49 #define portLONG                long\r
  50 #define portSHORT               short\r
  51 #define portSTACK_TYPE  uint32_t\r
  52 #define portBASE_TYPE   long\r
  53 \r
  54 typedef portSTACK_TYPE StackType_t;\r
  55 typedef long BaseType_t;\r
  56 typedef unsigned long UBaseType_t;\r
  57 \r
  58 typedef uint32_t TickType_t;\r
  59 #define portMAX_DELAY ( ( TickType_t ) 0xffffffffUL )\r
  60 \r
  61 /*-----------------------------------------------------------*/\r
  62 \r
  63 /* Hardware specifics. */\r
  64 #define portSTACK_GROWTH                        ( -1 )\r
  65 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  66 #define portBYTE_ALIGNMENT                      32\r
  67 \r
  68 /*-----------------------------------------------------------*/\r
  69 \r
  70 /* Task utilities. */\r
  71 \r
  72 /* The interrupt priority (for vectors 16 to 255) is determined using vector/16.\r
  73 The quotient is rounded to the nearest integer with 1 being the lowest priority\r
  74 and 15 is the highest.  Therefore the following two interrupts are at the lowest\r
  75 priority.  *NOTE 1* If the yield vector is changed then it must also be changed\r
  76 in the portYIELD_INTERRUPT definition immediately below. */\r
  77 #define portAPIC_TIMER_INT_VECTOR               ( 0x21 )\r
  78 #define portAPIC_YIELD_INT_VECTOR               ( 0x20 )\r
  79 \r
  80 /* Build yield interrupt instruction. */\r
  81 #define portYIELD_INTERRUPT "int $0x20"\r
  82 \r
  83 /* APIC register addresses. */\r
  84 #define portAPIC_EOI                                    ( *( ( volatile uint32_t * ) 0xFEE000B0UL ) )\r
  85 \r
  86 /* APIC bit definitions. */\r
  87 #define portAPIC_ENABLE_BIT                             ( 1UL << 8UL )\r
  88 #define portAPIC_TIMER_PERIODIC                 ( 1UL << 17UL )\r
  89 #define portAPIC_DISABLE                                ( 1UL << 16UL )\r
  90 #define portAPIC_NMI                                    ( 4 << 8)\r
  91 #define portAPIC_DIV_16                                 ( 0x03 )\r
  92 \r
  93 /* Define local API register addresses. */\r
  94 #define portAPIC_ID_REGISTER                    ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x20UL  ) ) )\r
  95 #define portAPIC_SPURIOUS_INT                   ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0xF0UL  ) ) )\r
  96 #define portAPIC_LVT_TIMER                              ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x320UL ) ) )\r
  97 #define portAPIC_TIMER_INITIAL_COUNT    ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x380UL ) ) )\r
  98 #define portAPIC_TIMER_CURRENT_COUNT    ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x390UL ) ) )\r
  99 #define portAPIC_TASK_PRIORITY                  ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x80UL  ) ) )\r
 100 #define portAPIC_LVT_ERROR                              ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x370UL ) ) )\r
 101 #define portAPIC_ERROR_STATUS                   ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x280UL ) ) )\r
 102 #define portAPIC_LDR                                    ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0xD0UL  ) ) )\r
 103 #define portAPIC_TMRDIV                                 ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x3E0UL ) ) )\r
 104 #define portAPIC_LVT_PERF                               ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x340UL ) ) )\r
 105 #define portAPIC_LVT_LINT0                              ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x350UL ) ) )\r
 106 #define portAPIC_LVT_LINT1                              ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0x360UL ) ) )\r
 107 \r
 108 /* Don't yield if inside a critical section - instead hold the yield pending\r
 109 so it is performed when the critical section is exited. */\r
 110 #define portYIELD()                                                             \\r
 111 {                                                                                                       \\r
 112 extern volatile uint32_t ulCriticalNesting;                     \\r
 113 extern volatile uint32_t ulPortYieldPending;            \\r
 114         if( ulCriticalNesting != 0 )                                    \\r
 115         {                                                                                               \\r
 116                 ulPortYieldPending = pdTRUE;                            \\r
 117         }                                                                                               \\r
 118         else                                                                                    \\r
 119         {                                                                                               \\r
 120                 __asm volatile( portYIELD_INTERRUPT );          \\r
 121         }                                                                                               \\r
 122 }\r
 123 \r
 124 /* Called at the end of an ISR that can cause a context switch - pend a yield if\r
 125 xSwithcRequired is not false. */\r
 126 #define portEND_SWITCHING_ISR( xSwitchRequired )        \\r
 127 {                                                                                                       \\r
 128 extern volatile uint32_t ulPortYieldPending;            \\r
 129         if( xSwitchRequired != pdFALSE )                                \\r
 130         {                                                                                               \\r
 131                 ulPortYieldPending = 1;                                         \\r
 132         }                                                                                               \\r
 133 }\r
 134 \r
 135 /* Same as portEND_SWITCHING_ISR() - take your pick which name to use. */\r
 136 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 137 \r
 138 /*-----------------------------------------------------------\r
 139  * Critical section control\r
 140  *----------------------------------------------------------*/\r
 141 \r
 142 /* Critical sections for use in interrupts. */\r
 143 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 144 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask( x )\r
 145 \r
 146 extern void vPortEnterCritical( void );\r
 147 extern void vPortExitCritical( void );\r
 148 extern uint32_t ulPortSetInterruptMask( void );\r
 149 extern void vPortClearInterruptMask( uint32_t ulNewMaskValue );\r
 150 \r
 151 /* These macros do not globally disable/enable interrupts.  They do mask off\r
 152 interrupts that have a priority below configMAX_API_CALL_INTERRUPT_PRIORITY. */\r
 153 #define portENTER_CRITICAL()            vPortEnterCritical()\r
 154 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 155 #define portDISABLE_INTERRUPTS()        __asm volatile( "cli" )\r
 156 #define portENABLE_INTERRUPTS()         __asm volatile( "sti" )\r
 157 \r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 161 not required for this port but included in case common demo code that uses these\r
 162 macros is used. */\r
 163 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters )      void vFunction( void *pvParameters )\r
 164 #define portTASK_FUNCTION( vFunction, pvParameters )    void vFunction( void *pvParameters )\r
 165 \r
 166 /* Architecture specific optimisations. */\r
 167 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 168 \r
 169         /* Store/clear the ready priorities in a bit map. */\r
 170         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities )    \\r
 171                 __asm volatile( "bsr %1, %0\n\t"                                                                        \\r
 172                                                 :"=r"(uxTopPriority) : "rm"(uxReadyPriorities) : "cc" )\r
 173 \r
 174         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 175         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 176 \r
 177 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 178 \r
 179 #define portNOP() __asm volatile( "NOP" )\r
 180 \r
 181 /*-----------------------------------------------------------\r
 182  * Misc\r
 183  *----------------------------------------------------------*/\r
 184 \r
 185 #define portNUM_VECTORS         256\r
 186 #define portMAX_PRIORITY        15\r
 187 typedef void ( *ISR_Handler_t ) ( void );\r
 188 \r
 189 /* Any task that uses the floating point unit MUST call vPortTaskUsesFPU()\r
 190 before any floating point instructions are executed. */\r
 191 #ifndef configSUPPORT_FPU\r
 192         #define configSUPPORT_FPU 0\r
 193 #endif\r
 194 \r
 195 #if configSUPPORT_FPU == 1\r
 196         void vPortTaskUsesFPU( void );\r
 197         #define portTASK_USES_FLOATING_POINT() vPortTaskUsesFPU()\r
 198 #endif\r
 199 \r
 200 /* See the comments under the configUSE_COMMON_INTERRUPT_ENTRY_POINT definition\r
 201 below. */\r
 202 BaseType_t xPortRegisterCInterruptHandler( ISR_Handler_t pxHandler, uint32_t ulVectorNumber );\r
 203 BaseType_t xPortInstallInterruptHandler( ISR_Handler_t pxHandler, uint32_t ulVectorNumber );\r
 204 \r
 205 #ifndef configAPIC_BASE\r
 206         /* configAPIC_BASE_ADDRESS sets the base address of the local APIC.  It can\r
 207         be overridden in FreeRTOSConfig.h should it not be constant. */\r
 208         #define configAPIC_BASE 0xFEE00000UL\r
 209 #endif\r
 210 \r
 211 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 212         /* The FreeRTOS scheduling algorithm selects the task that will enter the\r
 213         Running state.  configUSE_PORT_OPTIMISED_TASK_SELECTION is used to set how\r
 214         that is done.\r
 215 \r
 216         If configUSE_PORT_OPTIMISED_TASK_SELECTION is set to 0 then the task to\r
 217         enter the Running state is selected using a portable algorithm written in\r
 218         C.  This is the slowest method, but the algorithm does not restrict the\r
 219         maximum number of unique RTOS task priorities that are available.\r
 220 \r
 221         If configUSE_PORT_OPTIMISED_TASK_SELECTION is set to 1 then the task to\r
 222         enter the Running state is selected using a single assembly instruction.\r
 223         This is the fastest method, but restricts the maximum number of unique RTOS\r
 224         task priorities to 32 (the same task priority can be assigned to any number\r
 225         of RTOS tasks). */\r
 226         #warning configUSE_PORT_OPTIMISED_TASK_SELECTION was not defined in FreeRTOSConfig.h and has been defaulted to 1\r
 227         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 228 #endif\r
 229 \r
 230 #ifndef configUSE_COMMON_INTERRUPT_ENTRY_POINT\r
 231         /* There are two ways of implementing interrupt handlers:\r
 232 \r
 233                 1) As standard C functions -\r
 234 \r
 235                 This method can only be used if configUSE_COMMON_INTERRUPT_ENTRY_POINT\r
 236                 is set to 1.  The C function is installed using\r
 237                 xPortRegisterCInterruptHandler().\r
 238 \r
 239                 This is the simplest of the two methods but incurs a slightly longer\r
 240                 interrupt entry time.\r
 241 \r
 242                 2) By using an assembly stub that wraps the handler in the FreeRTOS\r
 243                    portFREERTOS_INTERRUPT_ENTRY and portFREERTOS_INTERRUPT_EXIT macros.\r
 244 \r
 245                 This method can always be used.  It is slightly more complex than\r
 246                 method 1 but benefits from a faster interrupt entry time. */\r
 247         #warning configUSE_COMMON_INTERRUPT_ENTRY_POINT was not defined in FreeRTOSConfig.h and has been defaulted to 1.\r
 248         #define configUSE_COMMON_INTERRUPT_ENTRY_POINT  1\r
 249 #endif\r
 250 \r
 251 #ifndef configISR_STACK_SIZE\r
 252         /* Interrupt entry code will switch the stack in use to a dedicated system\r
 253         stack.\r
 254 \r
 255         configISR_STACK_SIZE defines the number of 32-bit values that can be stored\r
 256         on the system stack, and must be large enough to hold a potentially nested\r
 257         interrupt stack frame. */\r
 258 \r
 259         #error configISR_STACK_SIZE was not defined in FreeRTOSConfig.h.\r
 260 #endif\r
 261 \r
 262 #ifndef configMAX_API_CALL_INTERRUPT_PRIORITY\r
 263         /* Interrupt safe FreeRTOS functions (those that end in "FromISR" must not\r
 264         be called from an interrupt that has a priority above that set by\r
 265         configMAX_API_CALL_INTERRUPT_PRIORITY.  */\r
 266         #warning configMAX_API_CALL_INTERRUPT_PRIORITY was not defined in FreeRTOSConfig.h and has been defaulted to 10\r
 267         #define configMAX_API_CALL_INTERRUPT_PRIORITY 10\r
 268 #endif\r
 269 \r
 270 #ifndef configSUPPORT_FPU\r
 271         #warning configSUPPORT_FPU was not defined in FreeRTOSConfig.h and has been defaulted to 0\r
 272         #define configSUPPORT_FPU 0\r
 273 #endif\r
 274 \r
 275 /* The value written to the task priority register to raise the interrupt mask\r
 276 to the maximum from which FreeRTOS API calls can be made. */\r
 277 #define portAPIC_PRIORITY_SHIFT         ( 4UL )\r
 278 #define portAPIC_MAX_SUB_PRIORITY       ( 0x0fUL )\r
 279 #define portMAX_API_CALL_PRIORITY               ( ( configMAX_API_CALL_INTERRUPT_PRIORITY << portAPIC_PRIORITY_SHIFT ) | portAPIC_MAX_SUB_PRIORITY )\r
 280 \r
 281 /* Asserts if interrupt safe FreeRTOS functions are called from a priority\r
 282 above the max system call interrupt priority. */\r
 283 #define portAPIC_PROCESSOR_PRIORITY     ( *( ( volatile uint32_t * ) ( configAPIC_BASE + 0xA0UL  ) ) )\r
 284 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( portAPIC_PROCESSOR_PRIORITY ) <= ( portMAX_API_CALL_PRIORITY ) )\r
 285 \r
 286 #ifdef __cplusplus\r
 287         } /* extern C */\r
 288 #endif\r
 289 \r
 290 #endif /* PORTMACRO_H */\r
 291 \r