git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/CCS/ARM_Cortex-R4/portmacro.h

   1 /*\r
   2     FreeRTOS V7.5.3 - Copyright (C) 2013 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 distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! 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 #ifndef __PORTMACRO_H__\r
  67 #define __PORTMACRO_H__\r
  68 \r
  69 /*-----------------------------------------------------------\r
  70  * Port specific definitions.\r
  71  *\r
  72  * The settings in this file configure FreeRTOS correctly for the\r
  73  * given hardware and compiler.\r
  74  *\r
  75  * These settings should not be altered.\r
  76  *-----------------------------------------------------------\r
  77  */\r
  78 \r
  79 /* Type definitions. */\r
  80 #define portCHAR        char\r
  81 #define portFLOAT       float\r
  82 #define portDOUBLE      double\r
  83 #define portLONG        long\r
  84 #define portSHORT       short\r
  85 #define portSTACK_TYPE  unsigned long\r
  86 #define portBASE_TYPE   long\r
  87 \r
  88 #if (configUSE_16_BIT_TICKS == 1)\r
  89     typedef unsigned portSHORT portTickType;\r
  90     #define portMAX_DELAY (portTickType) 0xFFFF\r
  91 #else\r
  92     typedef unsigned portLONG portTickType;\r
  93     #define portMAX_DELAY (portTickType) 0xFFFFFFFFF\r
  94 #endif\r
  95 \r
  96 \r
  97 /* Architecture specifics. */\r
  98 #define portSTACK_GROWTH    (-1)\r
  99 #define portTICK_RATE_MS    ((portTickType) 1000 / configTICK_RATE_HZ)\r
 100 #define portBYTE_ALIGNMENT  8\r
 101 \r
 102 /* Critical section handling. */\r
 103 extern void vPortEnterCritical(void);\r
 104 extern void vPortExitCritical(void);\r
 105 #define portENTER_CRITICAL()            vPortEnterCritical()\r
 106 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 107 #define portDISABLE_INTERRUPTS()        asm( " CPSID I" )\r
 108 #define portENABLE_INTERRUPTS()         asm( " CPSIE I" )\r
 109 \r
 110 /* Scheduler utilities. */\r
 111 #pragma SWI_ALIAS( vPortYield, 0 )\r
 112 extern void vPortYield( void );\r
 113 #define portYIELD()                     vPortYield()\r
 114 #define portSYS_SSIR1_REG                       ( * ( ( volatile unsigned long * ) 0xFFFFFFB0 ) )\r
 115 #define portSYS_SSIR1_SSKEY                     ( 0x7500UL )\r
 116 #define portYIELD_WITHIN_API()          { portSYS_SSIR1_REG = portSYS_SSIR1_SSKEY;  asm( " DSB " ); asm( " ISB " ); }\r
 117 #define portYIELD_FROM_ISR( x )         if( x != pdFALSE ){ portSYS_SSIR1_REG = portSYS_SSIR1_SSKEY;  ( void ) portSYS_SSIR1_REG; }\r
 118 \r
 119 /* Architecture specific optimisations. */\r
 120 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 121 \r
 122         /* Check the configuration. */\r
 123         #if( configMAX_PRIORITIES > 32 )\r
 124                 #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
 125         #endif\r
 126 \r
 127         /* Store/clear the ready priorities in a bit map. */\r
 128         #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 129         #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 130 \r
 131         /*-----------------------------------------------------------*/\r
 132 \r
 133         #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - __clz( ( uxReadyPriorities ) ) )\r
 134 \r
 135 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 136 \r
 137 \r
 138 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 139 #define portTASK_FUNCTION(vFunction, pvParameters)       void vFunction(void *pvParameters)\r
 140 #define portTASK_FUNCTION_PROTO(vFunction, pvParameters) void vFunction(void *pvParameters)\r
 141 \r
 142 #endif /* __PORTMACRO_H__ */\r
 143 \r