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

   1 /*\r
   2     FreeRTOS V7.5.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   5 \r
   6     ***************************************************************************\r
   7      *                                                                       *\r
   8      *    FreeRTOS provides completely free yet professionally developed,    *\r
   9      *    robust, strictly quality controlled, supported, and cross          *\r
  10      *    platform software that has become a de facto standard.             *\r
  11      *                                                                       *\r
  12      *    Help yourself get started quickly and support the FreeRTOS         *\r
  13      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  14      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  15      *                                                                       *\r
  16      *    Thank you!                                                         *\r
  17      *                                                                       *\r
  18     ***************************************************************************\r
  19 \r
  20     This file is part of the FreeRTOS distribution.\r
  21 \r
  22     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  23     the terms of the GNU General Public License (version 2) as published by the\r
  24     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  25 \r
  26     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  27     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  28     >>! the source code for proprietary components outside of the FreeRTOS\r
  29     >>! kernel.\r
  30 \r
  31     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  32     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  33     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  34     link: http://www.freertos.org/a00114.html\r
  35 \r
  36     1 tab == 4 spaces!\r
  37 \r
  38     ***************************************************************************\r
  39      *                                                                       *\r
  40      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  41      *    not run, what could be wrong?"                                     *\r
  42      *                                                                       *\r
  43      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  44      *                                                                       *\r
  45     ***************************************************************************\r
  46 \r
  47     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  48     license and Real Time Engineers Ltd. contact details.\r
  49 \r
  50     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  51     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  52     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  53 \r
  54     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  55     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  56     licenses offer ticketed support, indemnification and middleware.\r
  57 \r
  58     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  59     engineered and independently SIL3 certified version for use in safety and\r
  60     mission critical applications that require provable dependability.\r
  61 \r
  62     1 tab == 4 spaces!\r
  63 */\r
  64 \r
  65 \r
  66 #ifndef PORTMACRO_H\r
  67 #define PORTMACRO_H\r
  68 \r
  69 #ifdef __cplusplus\r
  70 extern "C" {\r
  71 #endif\r
  72 \r
  73 /*-----------------------------------------------------------\r
  74  * Port specific definitions.\r
  75  *\r
  76  * The settings in this file configure FreeRTOS correctly for the\r
  77  * given hardware and compiler.\r
  78  *\r
  79  * These settings should not be altered.\r
  80  *-----------------------------------------------------------\r
  81  */\r
  82 \r
  83 /* Type definitions - these are a bit legacy and not really used now, other than\r
  84 portSTACK_TYPE and portBASE_TYPE. */\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  unsigned portLONG\r
  91 #define portBASE_TYPE   long\r
  92 \r
  93 #if( configUSE_16_BIT_TICKS == 1 )\r
  94         typedef unsigned portSHORT portTickType;\r
  95         #define portMAX_DELAY ( portTickType ) 0xffff\r
  96 #else\r
  97         typedef unsigned portLONG portTickType;\r
  98         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  99 #endif\r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 /* Hardware specifics. */\r
 103 #define portBYTE_ALIGNMENT                      8       /* Could make four, according to manual. */\r
 104 #define portSTACK_GROWTH                        -1\r
 105 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )\r
 106 #define portNOP()                                       __asm volatile( "NOP" )\r
 107 \r
 108 /* Save clobbered register, set ITU SWINR (at address 0x872E0), read the value\r
 109 back to ensure it is set before continuing, then restore the clobbered\r
 110 register. */\r
 111 #define portYIELD()                                                     \\r
 112         __asm volatile                                                  \\r
 113         (                                                                               \\r
 114                 "MOV.L #0x872E0, r5                     \n\t"   \\r
 115                 "MOV.B #1, [r5]                         \n\t"   \\r
 116                 "MOV.L [r5], r5                         \n\t"   \\r
 117                 ::: "r5"                                                        \\r
 118         )\r
 119 \r
 120 #define portYIELD_FROM_ISR( x ) if( x != pdFALSE ) { portYIELD(); }\r
 121 \r
 122 /* These macros should not be called directly, but through the \r
 123 taskENTER_CRITICAL() and taskEXIT_CRITICAL() macros.  An extra check is \r
 124 performed if configASSERT() is defined to ensure an assertion handler does not \r
 125 inadvertently attempt to lower the IPL when the call to assert was triggered \r
 126 because the IPL value was found to be above     configMAX_SYSCALL_INTERRUPT_PRIORITY \r
 127 when an ISR safe FreeRTOS API function was executed.  ISR safe FreeRTOS API \r
 128 functions are those that end in FromISR.  FreeRTOS maintains a separate \r
 129 interrupt API to ensure API function and interrupt entry is as fast and as \r
 130 simple as possible. */\r
 131 #define portENABLE_INTERRUPTS()         __asm volatile ( "MVTIPL        #0" )\r
 132 #ifdef configASSERT\r
 133         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID() configASSERT( ( ulPortGetIPL() <= configMAX_SYSCALL_INTERRUPT_PRIORITY ) )\r
 134         #define portDISABLE_INTERRUPTS()        if( ulPortGetIPL() < configMAX_SYSCALL_INTERRUPT_PRIORITY ) __asm volatile ( "MVTIPL    %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) )\r
 135 #else\r
 136         #define portDISABLE_INTERRUPTS()        __asm volatile ( "MVTIPL        %0" ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY) )\r
 137 #endif\r
 138 \r
 139 /* Critical nesting counts are stored in the TCB. */\r
 140 #define portCRITICAL_NESTING_IN_TCB ( 1 )\r
 141 \r
 142 /* The critical nesting functions defined within tasks.c. */\r
 143 extern void vTaskEnterCritical( void );\r
 144 extern void vTaskExitCritical( void );\r
 145 #define portENTER_CRITICAL()    vTaskEnterCritical()\r
 146 #define portEXIT_CRITICAL()             vTaskExitCritical()\r
 147 \r
 148 /* As this port allows interrupt nesting... */\r
 149 unsigned long ulPortGetIPL( void ) __attribute__((naked));\r
 150 void vPortSetIPL( unsigned long ulNewIPL ) __attribute__((naked));\r
 151 #define portSET_INTERRUPT_MASK_FROM_ISR() ulPortGetIPL(); portDISABLE_INTERRUPTS()\r
 152 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ) vPortSetIPL( uxSavedInterruptStatus )\r
 153 \r
 154 /* Tickless idle/low power functionality. */\r
 155 #if configUSE_TICKLESS_IDLE == 1\r
 156         #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 157                 extern void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime );\r
 158                 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 159         #endif\r
 160 #endif\r
 161 \r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 165 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 166 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 167 \r
 168 #ifdef __cplusplus\r
 169 }\r
 170 #endif\r
 171 \r
 172 #endif /* PORTMACRO_H */\r
 173 \r