]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/portable/IAR/ARM_CA9/port.c
Update version number in readiness for V10.3.0 release. Sync SVN with reviewed releas...
[freertos] / FreeRTOS / Source / portable / IAR / ARM_CA9 / port.c
index fc79ce54eb38e54cb2aeb8e752b10010f7120534..372f8d65f6cf611ec2ef6f1b6b0dbd26d0151b3d 100644 (file)
@@ -1,67 +1,29 @@
 /*\r
-    FreeRTOS V7.6.0 - Copyright (C) 2013 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 distribute\r
-    >>! a combined work that includes FreeRTOS without being obliged to provide\r
-    >>! the source code for proprietary components outside of the FreeRTOS\r
-    >>! 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.3.0\r
+ * Copyright (C) 2020 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.\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
 /* Standard includes. */\r
 #include <stdlib.h>\r
        #error configMAX_API_CALL_INTERRUPT_PRIORITY must be greater than ( configUNIQUE_INTERRUPT_PRIORITIES / 2 )\r
 #endif\r
 \r
+#ifndef configCLEAR_TICK_INTERRUPT\r
+       #define configCLEAR_TICK_INTERRUPT()\r
+#endif\r
+\r
 /* A critical section is exited when the critical section nesting count reaches\r
 this value. */\r
-#define portNO_CRITICAL_NESTING                        ( ( unsigned long ) 0 )\r
+#define portNO_CRITICAL_NESTING                        ( ( uint32_t ) 0 )\r
 \r
 /* In all GICs 255 can be written to the priority mask register to unmask all\r
 (but the lowest) interrupt priority. */\r
-#define portUNMASK_VALUE                               ( 0xFF )\r
+#define portUNMASK_VALUE                               ( 0xFFUL )\r
 \r
 /* Tasks are not created with a floating point context, but can be given a\r
 floating point context after they have been created.  A variable is stored as\r
 part of the tasks context that holds portNO_FLOATING_POINT_CONTEXT if the task\r
 does not have an FPU context, or any other value if the task does have an FPU\r
 context. */\r
-#define portNO_FLOATING_POINT_CONTEXT  ( ( portSTACK_TYPE ) 0 )\r
+#define portNO_FLOATING_POINT_CONTEXT  ( ( StackType_t ) 0 )\r
 \r
 /* Constants required to setup the initial task context. */\r
-#define portINITIAL_SPSR                               ( ( portSTACK_TYPE ) 0x1f ) /* System mode, ARM mode, interrupts enabled. */\r
-#define portTHUMB_MODE_BIT                             ( ( portSTACK_TYPE ) 0x20 )\r
-#define portINTERRUPT_ENABLE_BIT               ( 0x80UL )\r
+#define portINITIAL_SPSR                               ( ( StackType_t ) 0x1f ) /* System mode, ARM mode, interrupts enabled. */\r
+#define portTHUMB_MODE_BIT                             ( ( StackType_t ) 0x20 )\r
 #define portTHUMB_MODE_ADDRESS                 ( 0x01UL )\r
 \r
 /* Used by portASSERT_IF_INTERRUPT_PRIORITY_INVALID() when ensuring the binary\r
 point is zero. */\r
-#define portBINARY_POINT_BITS                  ( ( unsigned char ) 0x03 )\r
+#define portBINARY_POINT_BITS                  ( ( uint8_t ) 0x03 )\r
 \r
 /* Masks all bits in the APSR other than the mode bits. */\r
 #define portAPSR_MODE_BITS_MASK                        ( 0x1F )\r
@@ -163,6 +128,11 @@ mode. */
  */\r
 extern void vPortRestoreTaskContext( void );\r
 \r
+/*\r
+ * Used to catch tasks that attempt to return from their implementing function.\r
+ */\r
+static void prvTaskExitError( void );\r
+\r
 /*-----------------------------------------------------------*/\r
 \r
 /* A variable is used to keep track of the critical section nesting.  This\r
@@ -170,18 +140,18 @@ variable has to be stored as part of the task context and must be initialised to
 a non zero value to ensure interrupts don't inadvertently become unmasked before\r
 the scheduler starts.  As it is stored as part of the task context it will\r
 automatically be set to 0 when the first task is started. */\r
-volatile unsigned long ulCriticalNesting = 9999UL;\r
+volatile uint32_t ulCriticalNesting = 9999UL;\r
 \r
-/* Saved as part of the task context.  If ulPortTaskHasFPUContext is non-zero then\r
-a floating point context must be saved and restored for the task. */\r
-unsigned long ulPortTaskHasFPUContext = pdFALSE;\r
+/* Saved as part of the task context.  If ulPortTaskHasFPUContext is non-zero\r
+then a floating point context must be saved and restored for the task. */\r
+uint32_t ulPortTaskHasFPUContext = pdFALSE;\r
 \r
 /* Set to 1 to pend a context switch from an ISR. */\r
-unsigned long ulPortYieldRequired = pdFALSE;\r
+uint32_t ulPortYieldRequired = pdFALSE;\r
 \r
 /* Counts the interrupt nesting depth.  A context switch is only performed if\r
 if the nesting depth is 0. */\r
-unsigned long ulPortInterruptNesting = 0UL;\r
+uint32_t ulPortInterruptNesting = 0UL;\r
 \r
 \r
 /*-----------------------------------------------------------*/\r
@@ -189,7 +159,7 @@ unsigned long ulPortInterruptNesting = 0UL;
 /*\r
  * See header file for description.\r
  */\r
-portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
+StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
 {\r
        /* Setup the initial stack of the task.  The stack is set exactly as\r
        expected by the portRESTORE_CONTEXT() macro.\r
@@ -203,9 +173,9 @@ portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE
        pxTopOfStack--;\r
        *pxTopOfStack = NULL;\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) portINITIAL_SPSR;\r
+       *pxTopOfStack = ( StackType_t ) portINITIAL_SPSR;\r
 \r
-       if( ( ( unsigned long ) pxCode & portTHUMB_MODE_ADDRESS ) != 0x00UL )\r
+       if( ( ( uint32_t ) pxCode & portTHUMB_MODE_ADDRESS ) != 0x00UL )\r
        {\r
                /* The task will start in THUMB mode. */\r
                *pxTopOfStack |= portTHUMB_MODE_BIT;\r
@@ -214,37 +184,37 @@ portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE
        pxTopOfStack--;\r
 \r
        /* Next the return address, which in this case is the start of the task. */\r
-       *pxTopOfStack = ( portSTACK_TYPE ) pxCode;\r
+       *pxTopOfStack = ( StackType_t ) pxCode;\r
        pxTopOfStack--;\r
 \r
        /* Next all the registers other than the stack pointer. */\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x00000000;  /* R14 */\r
+       *pxTopOfStack = ( StackType_t ) prvTaskExitError;       /* R14 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x12121212;  /* R12 */\r
+       *pxTopOfStack = ( StackType_t ) 0x12121212;     /* R12 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x11111111;  /* R11 */\r
+       *pxTopOfStack = ( StackType_t ) 0x11111111;     /* R11 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x10101010;  /* R10 */\r
+       *pxTopOfStack = ( StackType_t ) 0x10101010;     /* R10 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x09090909;  /* R9 */\r
+       *pxTopOfStack = ( StackType_t ) 0x09090909;     /* R9 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x08080808;  /* R8 */\r
+       *pxTopOfStack = ( StackType_t ) 0x08080808;     /* R8 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x07070707;  /* R7 */\r
+       *pxTopOfStack = ( StackType_t ) 0x07070707;     /* R7 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x06060606;  /* R6 */\r
+       *pxTopOfStack = ( StackType_t ) 0x06060606;     /* R6 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x05050505;  /* R5 */\r
+       *pxTopOfStack = ( StackType_t ) 0x05050505;     /* R5 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x04040404;  /* R4 */\r
+       *pxTopOfStack = ( StackType_t ) 0x04040404;     /* R4 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x03030303;  /* R3 */\r
+       *pxTopOfStack = ( StackType_t ) 0x03030303;     /* R3 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x02020202;  /* R2 */\r
+       *pxTopOfStack = ( StackType_t ) 0x02020202;     /* R2 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) 0x01010101;  /* R1 */\r
+       *pxTopOfStack = ( StackType_t ) 0x01010101;     /* R1 */\r
        pxTopOfStack--;\r
-       *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */\r
+       *pxTopOfStack = ( StackType_t ) pvParameters; /* R0 */\r
        pxTopOfStack--;\r
 \r
        /* The task will start with a critical nesting count of 0 as interrupts are\r
@@ -261,9 +231,23 @@ portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-portBASE_TYPE xPortStartScheduler( void )\r
+static void prvTaskExitError( void )\r
 {\r
-unsigned long ulAPSR;\r
+       /* A function that implements a task must not exit or attempt to return to\r
+       its caller as there is nothing to return to.  If a task wants to exit it\r
+       should instead call vTaskDelete( NULL ).\r
+\r
+       Artificially force an assert() to be triggered if configASSERT() is\r
+       defined, then stop here so application writers can catch the error. */\r
+       configASSERT( ulPortInterruptNesting == ~0UL );\r
+       portDISABLE_INTERRUPTS();\r
+       for( ;; );\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+BaseType_t xPortStartScheduler( void )\r
+{\r
+uint32_t ulAPSR;\r
 \r
        /* Only continue if the CPU is not in User mode.  The CPU must be in a\r
        Privileged mode for the scheduler to start. */\r
@@ -288,7 +272,7 @@ unsigned long ulAPSR;
                }\r
        }\r
 \r
-       /* Will only get here if xTaskStartScheduler() was called with the CPU in\r
+       /* Will only get here if vTaskStartScheduler() was called with the CPU in\r
        a non-privileged mode or the binary point register was not set to its lowest\r
        possible value. */\r
        return 0;\r
@@ -297,8 +281,9 @@ unsigned long ulAPSR;
 \r
 void vPortEndScheduler( void )\r
 {\r
-       /* It is unlikely that the ARM port will require this function as there\r
-       is nothing to return to. */\r
+       /* Not implemented in ports where there is nothing to return to.\r
+       Artificially force an assert. */\r
+       configASSERT( ulCriticalNesting == 1000UL );\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
@@ -311,6 +296,16 @@ void vPortEnterCritical( void )
        directly.  Increment ulCriticalNesting to keep a count of how many times\r
        portENTER_CRITICAL() has been called. */\r
        ulCriticalNesting++;\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
+       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
+       if( ulCriticalNesting == 1 )\r
+       {\r
+               configASSERT( ulPortInterruptNesting == 0 );\r
+       }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
@@ -340,7 +335,7 @@ void FreeRTOS_Tick_Handler( void )
        handler runs at the lowest priority, so interrupts cannot already be masked,\r
        so there is no need to save and restore the current mask value. */\r
        __disable_irq();\r
-       portICCPMR_PRIORITY_MASK_REGISTER = ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );\r
+       portICCPMR_PRIORITY_MASK_REGISTER = ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );\r
        __asm(  "DSB            \n"\r
                        "ISB            \n" );\r
        __enable_irq();\r
@@ -353,12 +348,13 @@ void FreeRTOS_Tick_Handler( void )
 \r
        /* Ensure all interrupt priorities are active again. */\r
        portCLEAR_INTERRUPT_MASK();\r
+       configCLEAR_TICK_INTERRUPT();\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
 void vPortTaskUsesFPU( void )\r
 {\r
-unsigned long ulInitialFPSCR = 0;\r
+uint32_t ulInitialFPSCR = 0;\r
 \r
        /* A task is registering the fact that it needs an FPU context.  Set the\r
        FPU flag (which is saved as part of the task context). */\r
@@ -369,7 +365,7 @@ unsigned long ulInitialFPSCR = 0;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vPortClearInterruptMask( unsigned long ulNewMaskValue )\r
+void vPortClearInterruptMask( uint32_t ulNewMaskValue )\r
 {\r
        if( ulNewMaskValue == pdFALSE )\r
        {\r
@@ -378,12 +374,12 @@ void vPortClearInterruptMask( unsigned long ulNewMaskValue )
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-unsigned long ulPortSetInterruptMask( void )\r
+uint32_t ulPortSetInterruptMask( void )\r
 {\r
-unsigned long ulReturn;\r
+uint32_t ulReturn;\r
 \r
        __disable_irq();\r
-       if( portICCPMR_PRIORITY_MASK_REGISTER == ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) )\r
+       if( portICCPMR_PRIORITY_MASK_REGISTER == ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) )\r
        {\r
                /* Interrupts were already masked. */\r
                ulReturn = pdTRUE;\r
@@ -391,7 +387,7 @@ unsigned long ulReturn;
        else\r
        {\r
                ulReturn = pdFALSE;\r
-               portICCPMR_PRIORITY_MASK_REGISTER = ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );\r
+               portICCPMR_PRIORITY_MASK_REGISTER = ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );\r
                __asm(  "DSB            \n"\r
                                "ISB            \n" );\r
        }\r
@@ -423,7 +419,7 @@ unsigned long ulReturn;
                The following links provide detailed information:\r
                http://www.freertos.org/RTOS-Cortex-M3-M4.html\r
                http://www.freertos.org/FAQHelp.html */\r
-               configASSERT( portICCRPR_RUNNING_PRIORITY_REGISTER >= ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) );\r
+               configASSERT( portICCRPR_RUNNING_PRIORITY_REGISTER >= ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) );\r
 \r
                /* Priority grouping:  The interrupt controller (GIC) allows the bits\r
                that define each interrupt's priority to be split between bits that\r