git.sur5r.net Git - freertos/blob - Demo/MicroBlaze_Spartan-6_EthernetLite/SDKProjects/RTOSDemoSource/FreeRTOS_Source/portable/GCC/MicroBlaze/portmacro.h

   1 /*\r
   2     FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 #ifndef PORTMACRO_H\r
  55 #define PORTMACRO_H\r
  56 \r
  57 #ifdef __cplusplus\r
  58 extern "C" {\r
  59 #endif\r
  60 \r
  61 /* BSP includes. */\r
  62 #include <mb_interface.h>\r
  63 #include <xparameters.h>\r
  64 \r
  65 /*-----------------------------------------------------------\r
  66  * Port specific definitions.  \r
  67  *\r
  68  * The settings in this file configure FreeRTOS correctly for the\r
  69  * given hardware and compiler.\r
  70  *\r
  71  * These settings should not be altered.\r
  72  *-----------------------------------------------------------\r
  73  */\r
  74 \r
  75 /* Type definitions. */\r
  76 #define portCHAR                char\r
  77 #define portFLOAT               float\r
  78 #define portDOUBLE              double\r
  79 #define portLONG                long\r
  80 #define portSHORT               short\r
  81 #define portSTACK_TYPE  unsigned portLONG\r
  82 #define portBASE_TYPE   portLONG\r
  83 \r
  84 #if( configUSE_16_BIT_TICKS == 1 )\r
  85         typedef unsigned portSHORT portTickType;\r
  86         #define portMAX_DELAY ( portTickType ) 0xffff\r
  87 #else\r
  88         typedef unsigned portLONG portTickType;\r
  89         #define portMAX_DELAY ( portTickType ) 0xffffffff\r
  90 #endif\r
  91 /*-----------------------------------------------------------*/ \r
  92 \r
  93 /* Interrupt control macros and functions. */\r
  94 void microblaze_disable_interrupts( void );\r
  95 void microblaze_enable_interrupts( void );\r
  96 #define portDISABLE_INTERRUPTS()        microblaze_disable_interrupts()\r
  97 #define portENABLE_INTERRUPTS()         microblaze_enable_interrupts()\r
  98 \r
  99 portBASE_TYPE xPortInstallInterruptHandler( unsigned char ucInterruptID, XInterruptHandler pxHandler, void *pvCallBackRef );\r
 100 void vPortEnableInterrupt( unsigned char ucInterruptID );\r
 101 void vPortDisableInterrupt( unsigned char ucInterruptID );\r
 102 \r
 103 void vApplicationSetupTimerInterrupt( void );\r
 104 \r
 105 /*-----------------------------------------------------------*/\r
 106 \r
 107 /* Critical section macros. */\r
 108 void vPortEnterCritical( void );\r
 109 void vPortExitCritical( void );\r
 110 #define portENTER_CRITICAL()            {                                                                                                                               \\r
 111                                                                                 extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 112                                                                                 microblaze_disable_interrupts();                                                        \\r
 113                                                                                 uxCriticalNesting++;                                                                            \\r
 114                                                                         }\r
 115                                                                         \r
 116 #define portEXIT_CRITICAL()                     {                                                                                                                               \\r
 117                                                                                 extern volatile unsigned portBASE_TYPE uxCriticalNesting;       \\r
 118                                                                                 /* Interrupts are disabled, so we can */                                        \\r
 119                                                                                 /* access the variable directly. */                                                     \\r
 120                                                                                 uxCriticalNesting--;                                                                            \\r
 121                                                                                 if( uxCriticalNesting == 0 )                                                            \\r
 122                                                                                 {                                                                                                                       \\r
 123                                                                                         /* The nesting has unwound and we                                               \\r
 124                                                                                         can enable interrupts again. */                                                 \\r
 125                                                                                         portENABLE_INTERRUPTS();                                                                \\r
 126                                                                                 }                                                                                                                       \\r
 127                                                                         }\r
 128 \r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 /* Task utilities. */\r
 132 void vPortYield( void );\r
 133 #define portYIELD() vPortYield()\r
 134 \r
 135 void vTaskSwitchContext();\r
 136 extern volatile unsigned long ulTaskSwitchRequested;\r
 137 #define portYIELD_FROM_ISR( x ) if( x != pdFALSE ) ulTaskSwitchRequested = 1\r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 /* Hardware specifics. */\r
 141 #define portBYTE_ALIGNMENT                      4\r
 142 #define portSTACK_GROWTH                        ( -1 )\r
 143 #define portTICK_RATE_MS                        ( ( portTickType ) 1000 / configTICK_RATE_HZ )          \r
 144 #define portNOP()                                       asm volatile ( "NOP" )\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 148 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 149 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 150 \r
 151 typedef struct PORT_REGISTER_DUMP\r
 152 {\r
 153         /* The following structure members hold the values of the MicroBlaze\r
 154         registers at the time the exception was raised. */\r
 155         unsigned long ulR1_SP;\r
 156         unsigned long ulR2_small_data_area;\r
 157         unsigned long ulR3;\r
 158         unsigned long ulR4;\r
 159         unsigned long ulR5;\r
 160         unsigned long ulR6;\r
 161         unsigned long ulR7;\r
 162         unsigned long ulR8;\r
 163         unsigned long ulR9;\r
 164         unsigned long ulR10;\r
 165         unsigned long ulR11;\r
 166         unsigned long ulR12;\r
 167         unsigned long ulR13_read_write_small_data_area;\r
 168         unsigned long ulR14_return_address_from_interrupt;\r
 169         unsigned long ulR15_return_address_from_subroutine;\r
 170         unsigned long ulR16_return_address_from_trap;\r
 171         unsigned long ulR17_return_address_from_some_exceptions;\r
 172         unsigned long ulR18;\r
 173         unsigned long ulR19;\r
 174         unsigned long ulR20;\r
 175         unsigned long ulR21;\r
 176         unsigned long ulR22;\r
 177         unsigned long ulR23;\r
 178         unsigned long ulR24;\r
 179         unsigned long ulR25;\r
 180         unsigned long ulR26;\r
 181         unsigned long ulR27;\r
 182         unsigned long ulR28;\r
 183         unsigned long ulR29;\r
 184         unsigned long ulR30;\r
 185         unsigned long ulR31;\r
 186         unsigned long ulPC;\r
 187         unsigned long ulESR;\r
 188         unsigned long ulBTR;\r
 189         unsigned long ulMSR;\r
 190         unsigned long ulEAR;\r
 191         unsigned long ulFSR;\r
 192         unsigned long ulEDR;\r
 193 \r
 194         /* A human readable description of the exception cause.  The strings used\r
 195         are the same as the #define constant names found in the\r
 196         microblaze_exceptions_i.h header file */\r
 197         signed char *pcExceptionCause;\r
 198 \r
 199         /* The human readable name of the task that was running at the time the\r
 200         exception occurred.  This is the name that was given to the task when the\r
 201         task was created using the FreeRTOS xTaskCreate() API function. */\r
 202         signed char *pcCurrentTaskName;\r
 203 \r
 204         /* The handle of the task that was running a the time the exception\r
 205         occurred. */\r
 206         void * xCurrentTaskHandle;\r
 207 \r
 208 } xPortRegisterDump;\r
 209 \r
 210 void vPortExceptionsInstallHandlers( void );\r
 211 void vApplicationExceptionRegisterDump( xPortRegisterDump *xRegisterDump );\r
 212 \r
 213 #ifdef __cplusplus\r
 214 }\r
 215 #endif\r
 216 \r
 217 #endif /* PORTMACRO_H */\r
 218 \r