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

   1 /*\r
   2     FreeRTOS V8.1.2 - Copyright (C) 2014 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 \r
  67 #ifndef PORTMACRO_H\r
  68 #define PORTMACRO_H\r
  69 \r
  70 #ifdef __cplusplus\r
  71 extern "C" {\r
  72 #endif\r
  73 \r
  74 /*-----------------------------------------------------------\r
  75  * Port specific definitions.\r
  76  *\r
  77  * The settings in this file configure FreeRTOS correctly for the\r
  78  * given hardware and compiler.\r
  79  *\r
  80  * These settings should not be altered.\r
  81  *-----------------------------------------------------------\r
  82  */\r
  83 \r
  84 /* Type definitions. */\r
  85 #define portCHAR                char\r
  86 #define portFLOAT               float\r
  87 #define portDOUBLE              double\r
  88 #define portLONG                long\r
  89 #define portSHORT               short\r
  90 #define portSTACK_TYPE  uint32_t\r
  91 #define portBASE_TYPE   long\r
  92 \r
  93 typedef portSTACK_TYPE StackType_t;\r
  94 typedef long BaseType_t;\r
  95 typedef unsigned long UBaseType_t;\r
  96 \r
  97 \r
  98 #if( configUSE_16_BIT_TICKS == 1 )\r
  99         typedef uint16_t TickType_t;\r
 100         #define portMAX_DELAY ( TickType_t ) 0xffff\r
 101 #else\r
 102         typedef uint32_t TickType_t;\r
 103         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
 104 #endif\r
 105 /*-----------------------------------------------------------*/\r
 106 \r
 107 /* Architecture specifics. */\r
 108 #define portSTACK_GROWTH                        ( -1 )\r
 109 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
 110 #define portBYTE_ALIGNMENT                      8\r
 111 /*-----------------------------------------------------------*/\r
 112 \r
 113 \r
 114 /* Scheduler utilities. */\r
 115 extern void vPortYield( void );\r
 116 #define portNVIC_INT_CTRL                       ( ( volatile uint32_t * ) 0xe000ed04 )\r
 117 #define portNVIC_PENDSVSET                      0x10000000\r
 118 #define portYIELD()                                     vPortYield()\r
 119 \r
 120 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET\r
 121 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 \r
 125 /* Critical section management. */\r
 126 \r
 127 /*\r
 128  * Set basepri to portMAX_SYSCALL_INTERRUPT_PRIORITY without effecting other\r
 129  * registers.  r0 is clobbered.\r
 130  */\r
 131 #define portSET_INTERRUPT_MASK() __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY )\r
 132 \r
 133 /*\r
 134  * Set basepri back to 0 without effective other registers.\r
 135  * r0 is clobbered.  FAQ:  Setting BASEPRI to 0 is not a bug.  Please see\r
 136  * http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html before disagreeing.\r
 137  */\r
 138 #define portCLEAR_INTERRUPT_MASK() __set_BASEPRI( 0 )\r
 139 \r
 140 extern uint32_t ulPortSetInterruptMask( void );\r
 141 extern void vPortClearInterruptMask( uint32_t ulNewMask );\r
 142 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 143 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask( x )\r
 144 \r
 145 \r
 146 extern void vPortEnterCritical( void );\r
 147 extern void vPortExitCritical( void );\r
 148 \r
 149 #define portDISABLE_INTERRUPTS()        portSET_INTERRUPT_MASK()\r
 150 #define portENABLE_INTERRUPTS()         portCLEAR_INTERRUPT_MASK()\r
 151 #define portENTER_CRITICAL()            vPortEnterCritical()\r
 152 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 153 \r
 154 /*-----------------------------------------------------------*/\r
 155 \r
 156 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 157 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 158 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 159 \r
 160 #define portNOP()\r
 161 \r
 162 #ifdef __cplusplus\r
 163 }\r
 164 #endif\r
 165 \r
 166 #endif /* PORTMACRO_H */\r
 167 \r