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

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 \r
  30 #ifndef PORTMACRO_H\r
  31 #define PORTMACRO_H\r
  32 \r
  33 #ifdef __cplusplus\r
  34 extern "C" {\r
  35 #endif\r
  36 \r
  37 /*-----------------------------------------------------------\r
  38  * Port specific definitions.\r
  39  *\r
  40  * The settings in this file configure FreeRTOS correctly for the\r
  41  * given hardware and compiler.\r
  42  *\r
  43  * These settings should not be altered.\r
  44  *-----------------------------------------------------------\r
  45  */\r
  46 \r
  47 /* Type definitions. */\r
  48 #define portCHAR                char\r
  49 #define portFLOAT               float\r
  50 #define portDOUBLE              double\r
  51 #define portLONG                long\r
  52 #define portSHORT               short\r
  53 #define portSTACK_TYPE  uint32_t\r
  54 #define portBASE_TYPE   long\r
  55 \r
  56 typedef portSTACK_TYPE StackType_t;\r
  57 typedef long BaseType_t;\r
  58 typedef unsigned long UBaseType_t;\r
  59 \r
  60 #if( configUSE_16_BIT_TICKS == 1 )\r
  61         typedef uint16_t TickType_t;\r
  62         #define portMAX_DELAY ( TickType_t ) 0xffff\r
  63 #else\r
  64         typedef uint32_t TickType_t;\r
  65         #define portMAX_DELAY ( TickType_t ) 0xffffffffUL\r
  66 \r
  67         /* 32-bit tick type on a 32-bit architecture, so reads of the tick count do\r
  68         not need to be guarded with a critical section. */\r
  69         #define portTICK_TYPE_IS_ATOMIC 1\r
  70 #endif\r
  71 /*-----------------------------------------------------------*/\r
  72 \r
  73 /* Architecture specifics. */\r
  74 #define portSTACK_GROWTH                        ( -1 )\r
  75 #define portTICK_PERIOD_MS                      ( ( TickType_t ) 1000 / configTICK_RATE_HZ )\r
  76 #define portBYTE_ALIGNMENT                      8\r
  77 /*-----------------------------------------------------------*/\r
  78 \r
  79 \r
  80 /* Scheduler utilities. */\r
  81 extern void vPortYield( void );\r
  82 #define portNVIC_INT_CTRL_REG           ( * ( ( volatile uint32_t * ) 0xe000ed04 ) )\r
  83 #define portNVIC_PENDSVSET_BIT          ( 1UL << 28UL )\r
  84 #define portYIELD()                                     vPortYield()\r
  85 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT\r
  86 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 \r
  90 /* Critical section management. */\r
  91 extern void vPortEnterCritical( void );\r
  92 extern void vPortExitCritical( void );\r
  93 extern uint32_t ulSetInterruptMaskFromISR( void ) __attribute__((naked));\r
  94 extern void vClearInterruptMaskFromISR( uint32_t ulMask )  __attribute__((naked));\r
  95 \r
  96 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulSetInterruptMaskFromISR()\r
  97 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vClearInterruptMaskFromISR( x )\r
  98 #define portDISABLE_INTERRUPTS()                                __asm volatile  ( " cpsid i " ::: "memory" )\r
  99 #define portENABLE_INTERRUPTS()                                 __asm volatile  ( " cpsie i " ::: "memory" )\r
 100 #define portENTER_CRITICAL()                                    vPortEnterCritical()\r
 101 #define portEXIT_CRITICAL()                                             vPortExitCritical()\r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 106 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 107 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 108 \r
 109 #define portNOP()\r
 110 \r
 111 #ifdef __cplusplus\r
 112 }\r
 113 #endif\r
 114 \r
 115 #endif /* PORTMACRO_H */\r
 116 \r