git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/ThirdParty/GCC/nrf52840-dk/portmacro_cmsis.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 #ifndef PORTMACRO_CMSIS_H\r
  30 #define PORTMACRO_CMSIS_H\r
  31 #include "app_util.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 /* RTC register */\r
  79 #define portNRF_RTC_REG        NRF_RTC1\r
  80 /* IRQn used by the selected RTC */\r
  81 #define portNRF_RTC_IRQn       RTC1_IRQn\r
  82 /* Constants required to manipulate the NVIC. */\r
  83 #define portNRF_RTC_PRESCALER  ( (uint32_t) (ROUNDED_DIV(configSYSTICK_CLOCK_HZ, configTICK_RATE_HZ) - 1) )\r
  84 /* Maximum RTC ticks */\r
  85 #define portNRF_RTC_MAXTICKS   ((1U<<24)-1U)\r
  86 /*-----------------------------------------------------------*/\r
  87 \r
  88 /* Scheduler utilities. */\r
  89 #define portYIELD() do                                                          \\r
  90 {                                                                               \\r
  91     /* Set a PendSV to request a context switch. */                             \\r
  92     SCB->ICSR = SCB_ICSR_PENDSVSET_Msk;                                         \\r
  93     __SEV();                                                                    \\r
  94     /* Barriers are normally not required but do ensure the code is completely  \\r
  95     within the specified behaviour for the architecture. */                     \\r
  96     __DSB();                                                                    \\r
  97     __ISB();                                                                    \\r
  98 }while (0)\r
  99 \r
 100 #define portEND_SWITCHING_ISR( xSwitchRequired ) if ( (xSwitchRequired) != pdFALSE ) portYIELD()\r
 101 #define portYIELD_FROM_ISR( x ) portEND_SWITCHING_ISR( x )\r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 /* Critical section management. */\r
 105 extern void vPortEnterCritical( void );\r
 106 extern void vPortExitCritical( void );\r
 107 #define portSET_INTERRUPT_MASK_FROM_ISR()       ulPortRaiseBASEPRI()\r
 108 #define portCLEAR_INTERRUPT_MASK_FROM_ISR(x)    vPortSetBASEPRI(x)\r
 109 #define portDISABLE_INTERRUPTS()                vPortRaiseBASEPRI()\r
 110 #define portENABLE_INTERRUPTS()                 vPortSetBASEPRI(0)\r
 111 #define portENTER_CRITICAL()                    vPortEnterCritical()\r
 112 #define portEXIT_CRITICAL()                     vPortExitCritical()\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 /* Task function macros as described on the FreeRTOS.org WEB site.  These are\r
 117 not necessary for to use this port.  They are defined so the common demo files\r
 118 (which build with all the ports) will build. */\r
 119 #define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 120 #define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )\r
 121 /*-----------------------------------------------------------*/\r
 122 \r
 123 /* Tickless idle/low power functionality. */\r
 124 #ifndef portSUPPRESS_TICKS_AND_SLEEP\r
 125     extern void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime );\r
 126     #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime ) vPortSuppressTicksAndSleep( xExpectedIdleTime )\r
 127 #endif\r
 128 /*-----------------------------------------------------------*/\r
 129 \r
 130 /* Architecture specific optimisations. */\r
 131 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
 132     #define configUSE_PORT_OPTIMISED_TASK_SELECTION 1\r
 133 #endif\r
 134 \r
 135 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1\r
 136 \r
 137     /* Count leading zeros helper. */\r
 138     #define ucPortCountLeadingZeros( bits ) __CLZ( bits )\r
 139 \r
 140     /* Check the configuration. */\r
 141     #if ( configMAX_PRIORITIES > 32 )\r
 142         #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
 143     #endif\r
 144 \r
 145     /* Store/clear the ready priorities in a bit map. */\r
 146     #define portRECORD_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) |= ( 1UL << ( uxPriority ) )\r
 147     #define portRESET_READY_PRIORITY( uxPriority, uxReadyPriorities ) ( uxReadyPriorities ) &= ~( 1UL << ( uxPriority ) )\r
 148 \r
 149     /*-----------------------------------------------------------*/\r
 150 \r
 151     #define portGET_HIGHEST_PRIORITY( uxTopPriority, uxReadyPriorities ) uxTopPriority = ( 31 - ucPortCountLeadingZeros( ( uxReadyPriorities ) ) )\r
 152 \r
 153 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
 154 \r
 155 /*-----------------------------------------------------------*/\r
 156 \r
 157 #ifdef configASSERT\r
 158     void vPortValidateInterruptPriority( void );\r
 159     #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()  vPortValidateInterruptPriority()\r
 160 #endif\r
 161 \r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 #define vPortSetBASEPRI( ulNewMaskValue ) __set_BASEPRI(ulNewMaskValue)\r
 165 \r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 #define vPortRaiseBASEPRI( ) vPortSetBASEPRI(configMAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS))\r
 169 \r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 __STATIC_INLINE uint32_t ulPortRaiseBASEPRI( void )\r
 173 {\r
 174     uint32_t ulOriginalBASEPRI = __get_BASEPRI();\r
 175     vPortRaiseBASEPRI();\r
 176     return ulOriginalBASEPRI;\r
 177 }\r
 178 \r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 \r
 182 #ifdef __cplusplus\r
 183 }\r
 184 #endif\r
 185 \r
 186 #endif /* PORTMACRO_CMSIS_H */\r
 187 \r