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

   1 /*\r
   2  * FreeRTOS Kernel V10.2.0\r
   3  * Copyright (C) 2019 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.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 \r
  29 #ifndef PORTMACRO_H\r
  30 #define PORTMACRO_H\r
  31 \r
  32 #ifdef __cplusplus\r
  33 extern "C" {\r
  34 #endif\r
  35 \r
  36 /*-----------------------------------------------------------\r
  37  * Port specific definitions.\r
  38  *\r
  39  * The settings in this file configure FreeRTOS correctly for the\r
  40  * given hardware and compiler.\r
  41  *\r
  42  * These settings should not be altered.\r
  43  *-----------------------------------------------------------\r
  44  */\r
  45 \r
  46 /* Type definitions. */\r
  47 #define portCHAR                char\r
  48 #define portFLOAT               float\r
  49 #define portDOUBLE              double\r
  50 #define portLONG                long\r
  51 #define portSHORT               short\r
  52 #define portSTACK_TYPE  uint32_t\r
  53 #define portBASE_TYPE   long\r
  54 \r
  55 typedef portSTACK_TYPE StackType_t;\r
  56 typedef long BaseType_t;\r
  57 typedef unsigned long UBaseType_t;\r
  58 \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                       ( ( volatile uint32_t * ) 0xe000ed04 )\r
  83 #define portNVIC_PENDSVSET                      0x10000000\r
  84 #define portYIELD()                                     vPortYield()\r
  85 \r
  86 #define portEND_SWITCHING_ISR( xSwitchRequired ) if( xSwitchRequired ) *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET\r
  87 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
  88 /*-----------------------------------------------------------*/\r
  89 \r
  90 \r
  91 /* Critical section management. */\r
  92 \r
  93 /*\r
  94  * Set basepri to portMAX_SYSCALL_INTERRUPT_PRIORITY without effecting other\r
  95  * registers.  r0 is clobbered.\r
  96  */\r
  97 #define portSET_INTERRUPT_MASK() __set_BASEPRI( configMAX_SYSCALL_INTERRUPT_PRIORITY )\r
  98 \r
  99 /*\r
 100  * Set basepri back to 0 without effective other registers.\r
 101  * r0 is clobbered.  FAQ:  Setting BASEPRI to 0 is not a bug.  Please see\r
 102  * http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html before disagreeing.\r
 103  */\r
 104 #define portCLEAR_INTERRUPT_MASK() __set_BASEPRI( 0 )\r
 105 \r
 106 extern uint32_t ulPortSetInterruptMask( void );\r
 107 extern void vPortClearInterruptMask( uint32_t ulNewMask );\r
 108 #define portSET_INTERRUPT_MASK_FROM_ISR()               ulPortSetInterruptMask()\r
 109 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortClearInterruptMask( x )\r
 110 \r
 111 \r
 112 extern void vPortEnterCritical( void );\r
 113 extern void vPortExitCritical( void );\r
 114 \r
 115 #define portDISABLE_INTERRUPTS()        portSET_INTERRUPT_MASK()\r
 116 #define portENABLE_INTERRUPTS()         portCLEAR_INTERRUPT_MASK()\r
 117 #define portENTER_CRITICAL()            vPortEnterCritical()\r
 118 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 119 \r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 /* Task function macros as described on the FreeRTOS.org WEB site. */\r
 123 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 124 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 125 \r
 126 #define portNOP()\r
 127 \r
 128 #ifdef __cplusplus\r
 129 }\r
 130 #endif\r
 131 \r
 132 #endif /* PORTMACRO_H */\r
 133 \r