git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MikroC/ARM_CM4F/portmacro.h

   1 /*\r
   2     FreeRTOS V9.0.1 - Copyright (C) 2017 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 #ifndef PORTMACRO_H\r
  71 #define PORTMACRO_H\r
  72 \r
  73 #ifdef __cplusplus\r
  74 extern "C" {\r
  75 #endif\r
  76 \r
  77 /*-----------------------------------------------------------\r
  78  * Port specific definitions.\r
  79  *\r
  80  * The settings in this file configure FreeRTOS correctly for the\r
  81  * given hardware and compiler.\r
  82  *\r
  83  * These settings should not be altered.\r
  84  *-----------------------------------------------------------\r
  85  */\r
  86 \r
  87 /* The compiler needs to be told functions that are only referenced by pointer\r
  88 are to be included in the build.  NOTE:  Omitting these lines will result in a\r
  89 run-time crash, not a linker error! */\r
  90 #pragma funcall vTaskStartScheduler prvIdleTask\r
  91 #pragma funcall xTimerCreateTimerTask prvTimerTask\r
  92 \r
  93 /* Type definitions. */\r
  94 #define portCHAR        char\r
  95 #define portFLOAT        float\r
  96 #define portDOUBLE        double\r
  97 #define portLONG        long\r
  98 #define portSHORT        short\r
  99 #define portSTACK_TYPE    uint32_t\r
 100 #define portBASE_TYPE    long\r
 101 \r
 102 typedef portSTACK_TYPE StackType_t;\r
 103 typedef long BaseType_t;\r
 104 typedef unsigned long UBaseType_t;\r
 105 \r
 106 #if( configUSE_16_BIT_TICKS == 1 )\r
 107     typedef uint16_t TickType_t;\r
 108     #define portMAX_DELAY ( TickType_t ) 0xffff\r
 109 #else\r
 110     typedef uint32_t TickType_t;\r
 111     #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 112 \r
 113     /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
 114     not need to be guarded with a critical section. */\r
 115     #define portTICK_TYPE_IS_ATOMIC 1\r
 116 #endif\r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 /* Architecture specifics. */\r
 120 #define portSTACK_GROWTH            ( -1 )\r
 121 #define portTICK_PERIOD_MS            ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 122 #define portBYTE_ALIGNMENT            8\r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 /* Scheduler utilities. */\r
 126 #define portYIELD()                                                             \\r
 127 {                                                                                \\r
 128     /* Set a PendSV to request a context switch. */                                \\r
 129     portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;                                \\r
 130                                                                                 \\r
 131     /* Barriers are normally not required but do ensure the code is completely    \\r
 132     within the specified behaviour for the architecture. */                        \\r
 133   __asm{ dsb  };                       \\r
 134   __asm{ isb };                      \\r
 135 }\r
 136 \r
 137 #define portNVIC_INT_CTRL_REG        ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
 138 #define portNVIC_PENDSVSET_BIT        ( 1UL << 28UL )\r
 139 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired != pdFALSE ) portYIELD()\r
 140 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 /* Critical section management. */\r
 144 extern void vPortEnterCritical( void );\r
 145 extern void vPortExitCritical( void );\r
 146 #define portDISABLE_INTERRUPTS()                CPU_REG_SET( CPU_BASEPRI, configMAX_SYSCALL_INTERRUPT_PRIORITY ); __asm{ dsb }; __asm{ isb }\r
 147 #define portENABLE_INTERRUPTS()                    CPU_REG_SET( CPU_BASEPRI, 0 );\r
 148 #define portENTER_CRITICAL()                    vPortEnterCritical()\r
 149 #define portEXIT_CRITICAL()                        vPortExitCritical()\r
 150 #define portSET_INTERRUPT_MASK_FROM_ISR()        ulPortRaiseBASEPRI()\r
 151 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    CPU_REG_SET( CPU_BASEPRI, x ); /* Barrier instructions not used as this is only used to lower the basepri. */\r
 152 \r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 156 not necessary for to use this port.  They are defined so the common demo files\r
 157 (which build with all the ports) will build. */\r
 158 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 159 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 /* Tickless idle/low power functionality. */\r
 163 #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 164     extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 165     #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 166 #endif\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 /* Architecture specific optimisations. */\r
 170 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 171     #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 172 #endif\r
 173 \r
 174 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 175 \r
 176     /* Generic helper function. */\r
 177     __attribute__( ( always_inline ) ) static inline uint8_t ucPortCountLeadingZeros( uint32_t ulBitmap )\r
 178     {\r
 179     uint8_t ucReturn;\r
 180 \r
 181         __asm volatile ( "clz %0, %1" : "=r" ( ucReturn ) : "r" ( ulBitmap ) );\r
 182         return ucReturn;\r
 183     }\r
 184 \r
 185     /* Check the configuration. */\r
 186     #if( configMAX_PRIORITIES > 32 )\r
 187         #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32.  It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.\r
 188     #endif\r
 189 \r
 190     /* Store/clear the ready priorities in a bit map. */\r
 191     #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 192     #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 193 \r
 194     /*-----------------------------------------------------------*/\r
 195 \r
 196     #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31UL - ( uint32_t ) ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )\r
 197 \r
 198 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 199 \r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 #ifdef configASSERT\r
 203     void vPortValidateInterruptPriority( void );\r
 204     #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()     vPortValidateInterruptPriority()\r
 205 #endif\r
 206 \r
 207 /* portNOP() is not required by this port. */\r
 208 #define portNOP()\r
 209 \r
 210 BaseType_t xPortIsInsideInterrupt( void );\r
 211 \r
 212 /*-----------------------------------------------------------*/\r
 213 \r
 214 static inline uint32_t ulPortRaiseBASEPRI( void )\r
 215 {\r
 216 uint32_t ulOriginalBASEPRI;\r
 217 \r
 218         ulOriginalBASEPRI = CPU_REG_GET( CPU_BASEPRI );\r
 219         CPU_REG_SET( CPU_BASEPRI, configMAX_SYSCALL_INTERRUPT_PRIORITY );\r
 220         __asm{ dsb };\r
 221         __asm{ isb };\r
 222         return ulOriginalBASEPRI;\r
 223 }\r
 224 /*-----------------------------------------------------------*/\r
 225 \r
 226 #ifdef __cplusplus\r
 227 }\r
 228 #endif\r
 229 \r
 230 #endif /* PORTMACRO_H */