]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/portable/IAR/ARM_CM3/port.c
Update to MIT licensed FreeRTOS V10.0.0 - see https://www.freertos.org/History.txt
[freertos] / FreeRTOS / Source / portable / IAR / ARM_CM3 / port.c
index b05587c442daf73b71f9cd08862fbf91e496bcf4..36c889cb8e16c7185f125b710422a0d85b86979d 100644 (file)
@@ -1,67 +1,30 @@
 /*\r
-    FreeRTOS V8.0.1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
-    All rights reserved\r
-\r
-    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS provides completely free yet professionally developed,    *\r
-     *    robust, strictly quality controlled, supported, and cross          *\r
-     *    platform software that has become a de facto standard.             *\r
-     *                                                                       *\r
-     *    Help yourself get started quickly and support the FreeRTOS         *\r
-     *    project by purchasing a FreeRTOS tutorial book, reference          *\r
-     *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
-     *                                                                       *\r
-     *    Thank you!                                                         *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    This file is part of the FreeRTOS distribution.\r
-\r
-    FreeRTOS is free software; you can redistribute it and/or modify it under\r
-    the terms of the GNU General Public License (version 2) as published by the\r
-    Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
-\r
-    >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
-    >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
-    >>!   obliged to provide the source code for proprietary components     !<<\r
-    >>!   outside of the FreeRTOS kernel.                                   !<<\r
-\r
-    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
-    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
-    FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
-    link: http://www.freertos.org/a00114.html\r
-\r
-    1 tab == 4 spaces!\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
-     *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
-    license and Real Time Engineers Ltd. contact details.\r
-\r
-    http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
-    including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
-    compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
-    Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
-    licenses offer ticketed support, indemnification and middleware.\r
-\r
-    http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
-    engineered and independently SIL3 certified version for use in safety and\r
-    mission critical applications that require provable dependability.\r
-\r
-    1 tab == 4 spaces!\r
-*/\r
+ * FreeRTOS Kernel V10.0.0\r
+ * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
+ * this software and associated documentation files (the "Software"), to deal in\r
+ * the Software without restriction, including without limitation the rights to\r
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
+ * the Software, and to permit persons to whom the Software is furnished to do so,\r
+ * subject to the following conditions:\r
+ *\r
+ * The above copyright notice and this permission notice shall be included in all\r
+ * copies or substantial portions of the Software. If you wish to use our Amazon\r
+ * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+ *\r
+ * http://www.FreeRTOS.org\r
+ * http://aws.amazon.com/freertos\r
+ *\r
+ * 1 tab == 4 spaces!\r
+ */\r
 \r
 /*-----------------------------------------------------------\r
  * Implementation of functions defined in portable.h for the ARM CM3 port.\r
@@ -74,7 +37,7 @@
 #include "FreeRTOS.h"\r
 #include "task.h"\r
 \r
-#if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
+#if( configMAX_SYSCALL_INTERRUPT_PRIORITY == 0 )\r
        #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
 #endif\r
 \r
 #define portPRIGROUP_SHIFT                                     ( 8UL )\r
 \r
 /* Masks off all bits but the VECTACTIVE bits in the ICSR register. */\r
-#define portVECTACTIVE_MASK                                    ( 0x1FUL )\r
+#define portVECTACTIVE_MASK                                    ( 0xFFUL )\r
 \r
 /* Constants required to set up the initial stack. */\r
 #define portINITIAL_XPSR                                       ( 0x01000000 )\r
@@ -127,6 +90,10 @@ occurred while the SysTick counter is stopped during tickless idle
 calculations. */\r
 #define portMISSED_COUNTS_FACTOR                       ( 45UL )\r
 \r
+/* For strict compliance with the Cortex-M spec the task start address should\r
+have bit-0 clear, as it is loaded into the PC on exit from an ISR. */\r
+#define portSTART_ADDRESS_MASK                         ( ( StackType_t ) 0xfffffffeUL )\r
+\r
 /* For backward compatibility, ensure configKERNEL_INTERRUPT_PRIORITY is\r
 defined.  The value 255 should also ensure backward compatibility.\r
 FreeRTOS.org versions prior to V4.3.0 did not include this definition. */\r
@@ -134,10 +101,6 @@ FreeRTOS.org versions prior to V4.3.0 did not include this definition. */
        #define configKERNEL_INTERRUPT_PRIORITY 255\r
 #endif\r
 \r
-/* Each task maintains its own interrupt status in the critical nesting\r
-variable. */\r
-static UBaseType_t uxCriticalNesting = 0xaaaaaaaa;\r
-\r
 /*\r
  * Setup the timer to generate the tick interrupts.  The implementation in this\r
  * file is weak to allow application writers to change the timer used to\r
@@ -162,10 +125,14 @@ static void prvTaskExitError( void );
 \r
 /*-----------------------------------------------------------*/\r
 \r
+/* Each task maintains its own interrupt status in the critical nesting\r
+variable. */\r
+static UBaseType_t uxCriticalNesting = 0xaaaaaaaa;\r
+\r
 /*\r
  * The number of SysTick increments that make up one tick period.\r
  */\r
-#if configUSE_TICKLESS_IDLE == 1\r
+#if( configUSE_TICKLESS_IDLE == 1 )\r
        static uint32_t ulTimerCountsForOneTick = 0;\r
 #endif /* configUSE_TICKLESS_IDLE */\r
 \r
@@ -173,7 +140,7 @@ static void prvTaskExitError( void );
  * The maximum number of tick periods that can be suppressed is limited by the\r
  * 24 bit resolution of the SysTick timer.\r
  */\r
-#if configUSE_TICKLESS_IDLE == 1\r
+#if( configUSE_TICKLESS_IDLE == 1 )\r
        static uint32_t xMaximumPossibleSuppressedTicks = 0;\r
 #endif /* configUSE_TICKLESS_IDLE */\r
 \r
@@ -181,7 +148,7 @@ static void prvTaskExitError( void );
  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
  * power functionality only.\r
  */\r
-#if configUSE_TICKLESS_IDLE == 1\r
+#if( configUSE_TICKLESS_IDLE == 1 )\r
        static uint32_t ulStoppedTimerCompensation = 0;\r
 #endif /* configUSE_TICKLESS_IDLE */\r
 \r
@@ -190,7 +157,7 @@ static void prvTaskExitError( void );
  * FreeRTOS API functions are not called from interrupts that have been assigned\r
  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
  */\r
-#if ( configASSERT_DEFINED == 1 )\r
+#if( configASSERT_DEFINED == 1 )\r
         static uint8_t ucMaxSysCallPriority = 0;\r
         static uint32_t ulMaxPRIGROUPValue = 0;\r
         static const volatile uint8_t * const pcInterruptPriorityRegisters = ( const volatile uint8_t * const ) portNVIC_IP_REGISTERS_OFFSET_16;\r
@@ -208,7 +175,7 @@ StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t px
        pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */\r
        *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( StackType_t ) pxCode; /* PC */\r
+       *pxTopOfStack = ( ( StackType_t ) pxCode ) & portSTART_ADDRESS_MASK;    /* PC */\r
        pxTopOfStack--;\r
        *pxTopOfStack = ( StackType_t ) prvTaskExitError;       /* LR */\r
        pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
@@ -238,6 +205,10 @@ static void prvTaskExitError( void )
  */\r
 BaseType_t xPortStartScheduler( void )\r
 {\r
+       /* configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.\r
+       See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
+       configASSERT( configMAX_SYSCALL_INTERRUPT_PRIORITY );\r
+\r
        #if( configASSERT_DEFINED == 1 )\r
        {\r
                volatile uint32_t ulOriginalPriority;\r
@@ -271,6 +242,24 @@ BaseType_t xPortStartScheduler( void )
                        ucMaxPriorityValue <<= ( uint8_t ) 0x01;\r
                }\r
 \r
+               #ifdef __NVIC_PRIO_BITS\r
+               {\r
+                       /* Check the CMSIS configuration that defines the number of\r
+                       priority bits matches the number of priority bits actually queried\r
+                       from the hardware. */\r
+                       configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == __NVIC_PRIO_BITS );\r
+               }\r
+               #endif\r
+\r
+               #ifdef configPRIO_BITS\r
+               {\r
+                       /* Check the FreeRTOS configuration that defines the number of\r
+                       priority bits matches the number of priority bits actually queried\r
+                       from the hardware. */\r
+                       configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == configPRIO_BITS );\r
+               }\r
+               #endif\r
+\r
                /* Shift the priority group value back to its position within the AIRCR\r
                register. */\r
                ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;\r
@@ -309,27 +298,13 @@ void vPortEndScheduler( void )
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vPortYield( void )\r
-{\r
-       /* Set a PendSV to request a context switch. */\r
-       portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
-\r
-       /* Barriers are normally not required but do ensure the code is completely\r
-       within the specified behaviour for the architecture. */\r
-       __DSB();\r
-       __ISB();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
 void vPortEnterCritical( void )\r
 {\r
        portDISABLE_INTERRUPTS();\r
        uxCriticalNesting++;\r
-       __DSB();\r
-       __ISB();\r
-       \r
+\r
        /* This is not the interrupt safe version of the enter critical function so\r
-       assert() if it is being called from an interrupt context.  Only API \r
+       assert() if it is being called from an interrupt context.  Only API\r
        functions that end in "FromISR" can be used in an interrupt.  Only assert if\r
        the critical nesting count is 1 to protect against recursive calls if the\r
        assert function also uses a critical section. */\r
@@ -357,7 +332,7 @@ void xPortSysTickHandler( void )
        executes all interrupts must be unmasked.  There is therefore no need to\r
        save and then restore the interrupt mask value as its value is already\r
        known. */\r
-       ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
+       portDISABLE_INTERRUPTS();\r
        {\r
                /* Increment the RTOS tick. */\r
                if( xTaskIncrementTick() != pdFALSE )\r
@@ -367,15 +342,15 @@ void xPortSysTickHandler( void )
                        portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
                }\r
        }\r
-       portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
+       portENABLE_INTERRUPTS();\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-#if configUSE_TICKLESS_IDLE == 1\r
+#if( configUSE_TICKLESS_IDLE == 1 )\r
 \r
        __weak void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime )\r
        {\r
-       uint32_t ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements, ulSysTickCTRL;\r
+       uint32_t ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;\r
        TickType_t xModifiableIdleTime;\r
 \r
                /* Make sure the SysTick reload value does not overflow the counter. */\r
@@ -402,6 +377,8 @@ void xPortSysTickHandler( void )
                /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
                method as that will mask interrupts that should exit sleep mode. */\r
                __disable_interrupt();\r
+               __DSB();\r
+               __ISB();\r
 \r
                /* If a context switch is pending or a task is waiting for the scheduler\r
                to be unsuspended then abandon the low power entry. */\r
@@ -449,23 +426,41 @@ void xPortSysTickHandler( void )
                        }\r
                        configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
 \r
-                       /* Stop SysTick.  Again, the time the SysTick is stopped for is\r
-                       accounted for as best it can be, but using the tickless mode will\r
-                       inevitably result in some tiny drift of the time maintained by the\r
-                       kernel with respect to calendar time. */\r
-                       ulSysTickCTRL = portNVIC_SYSTICK_CTRL_REG;\r
-                       portNVIC_SYSTICK_CTRL_REG = ( ulSysTickCTRL & ~portNVIC_SYSTICK_ENABLE_BIT );\r
-\r
-                       /* Re-enable interrupts - see comments above __disable_interrupt()\r
-                       call above. */\r
+                       /* Re-enable interrupts to allow the interrupt that brought the MCU\r
+                       out of sleep mode to execute immediately.  see comments above\r
+                       __disable_interrupt() call above. */\r
                        __enable_interrupt();\r
-\r
-                       if( ( ulSysTickCTRL & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
+                       __DSB();\r
+                       __ISB();\r
+\r
+                       /* Disable interrupts again because the clock is about to be stopped\r
+                       and interrupts that execute while the clock is stopped will increase\r
+                       any slippage between the time maintained by the RTOS and calendar\r
+                       time. */\r
+                       __disable_interrupt();\r
+                       __DSB();\r
+                       __ISB();\r
+                       \r
+                       /* Disable the SysTick clock without reading the \r
+                       portNVIC_SYSTICK_CTRL_REG register to ensure the\r
+                       portNVIC_SYSTICK_COUNT_FLAG_BIT is not cleared if it is set.  Again, \r
+                       the time the SysTick is stopped for is accounted for as best it can \r
+                       be, but using the tickless mode will inevitably result in some tiny \r
+                       drift of the time maintained by the kernel with respect to calendar \r
+                       time*/\r
+                       portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT );\r
+\r
+                       /* Determine if the SysTick clock has already counted to zero and\r
+                       been set back to the current reload value (the reload back being\r
+                       correct for the entire expected idle time) or if the SysTick is yet\r
+                       to count to zero (in which case an interrupt other than the SysTick\r
+                       must have brought the system out of sleep mode). */\r
+                       if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
                        {\r
                                uint32_t ulCalculatedLoadValue;\r
 \r
-                               /* The tick interrupt has already executed, and the SysTick\r
-                               count reloaded with ulReloadValue.  Reset the\r
+                               /* The tick interrupt is already pending, and the SysTick count\r
+                               reloaded with ulReloadValue.  Reset the\r
                                portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
                                period. */\r
                                ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
@@ -480,11 +475,9 @@ void xPortSysTickHandler( void )
 \r
                                portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;\r
 \r
-                               /* The tick interrupt handler will already have pended the tick\r
-                               processing in the kernel.  As the pending tick will be\r
-                               processed as soon as this function exits, the tick value\r
-                               maintained by the tick is stepped forward by one less than the\r
-                               time spent waiting. */\r
+                               /* As the pending tick will be processed as soon as this\r
+                               function exits, the tick value maintained by the tick is stepped\r
+                               forward by one less than the time spent waiting. */\r
                                ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
                        }\r
                        else\r
@@ -501,26 +494,23 @@ void xPortSysTickHandler( void )
 \r
                                /* The reload value is set to whatever fraction of a single tick\r
                                period remains. */\r
-                               portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
+                               portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1UL ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
                        }\r
 \r
                        /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
                        again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
-                       value.  The critical section is used to ensure the tick interrupt\r
-                       can only execute once in the case that the reload register is near\r
-                       zero. */\r
+                       value. */\r
                        portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
-                       portENTER_CRITICAL();\r
-                       {\r
-                               portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
-                               vTaskStepTick( ulCompleteTickPeriods );\r
-                               portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
-                       }\r
-                       portEXIT_CRITICAL();\r
+                       portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
+                       vTaskStepTick( ulCompleteTickPeriods );\r
+                       portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
+\r
+                       /* Exit with interrpts enabled. */\r
+                       __enable_interrupt();\r
                }\r
        }\r
 \r
-#endif /* #if configUSE_TICKLESS_IDLE */\r
+#endif /* configUSE_TICKLESS_IDLE */\r
 /*-----------------------------------------------------------*/\r
 \r
 /*\r
@@ -530,7 +520,7 @@ void xPortSysTickHandler( void )
 __weak void vPortSetupTimerInterrupt( void )\r
 {\r
        /* Calculate the constants required to configure the tick interrupt. */\r
-       #if configUSE_TICKLESS_IDLE == 1\r
+       #if( configUSE_TICKLESS_IDLE == 1 )\r
        {\r
                ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
                xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
@@ -538,6 +528,10 @@ __weak void vPortSetupTimerInterrupt( void )
        }\r
        #endif /* configUSE_TICKLESS_IDLE */\r
 \r
+       /* Stop and clear the SysTick. */\r
+       portNVIC_SYSTICK_CTRL_REG = 0UL;\r
+       portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
+\r
        /* Configure SysTick to interrupt at the requested rate. */\r
        portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
        portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT );\r
@@ -552,7 +546,7 @@ __weak void vPortSetupTimerInterrupt( void )
        uint8_t ucCurrentPriority;\r
 \r
                /* Obtain the number of the currently executing interrupt. */\r
-               __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) );\r
+               __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) :: "memory" );\r
 \r
                /* Is the interrupt number a user defined interrupt? */\r
                if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )\r
@@ -598,7 +592,7 @@ __weak void vPortSetupTimerInterrupt( void )
                devices by calling NVIC_SetPriorityGrouping( 0 ); before starting the\r
                scheduler.  Note however that some vendor specific peripheral libraries\r
                assume a non-zero priority group setting, in which cases using a value\r
-               of zero will result in unpredicable behaviour. */\r
+               of zero will result in unpredictable behaviour. */\r
                configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );\r
        }\r
 \r