begriffs open source - freertos/blob - portable/IAR/LPC2000/port.c

   1 /*
   2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>
   3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * SPDX-License-Identifier: MIT
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   8  * this software and associated documentation files (the "Software"), to deal in
   9  * the Software without restriction, including without limitation the rights to
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  11  * the Software, and to permit persons to whom the Software is furnished to do so,
  12  * subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in all
  15  * copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  *
  24  * https://www.FreeRTOS.org
  25  * https://github.com/FreeRTOS
  26  *
  27  */
  28
  29 /*-----------------------------------------------------------
  30  * Implementation of functions defined in portable.h for the Philips ARM7 port.
  31  *----------------------------------------------------------*/
  32
  33 /*
  34     Changes from V3.2.2
  35
  36     + Bug fix - The prescale value for the timer setup is now written to T0PR
  37       instead of T0PC.  This bug would have had no effect unless a prescale
  38       value was actually used.
  39 */
  40
  41 /* Standard includes. */
  42 #include <stdlib.h>
  43 #include <intrinsics.h>
  44
  45 /* Scheduler includes. */
  46 #include "FreeRTOS.h"
  47 #include "task.h"
  48
  49 /* Constants required to setup the tick ISR. */
  50 #define portENABLE_TIMER            ( ( uint8_t ) 0x01 )
  51 #define portPRESCALE_VALUE          0x00
  52 #define portINTERRUPT_ON_MATCH      ( ( uint32_t ) 0x01 )
  53 #define portRESET_COUNT_ON_MATCH    ( ( uint32_t ) 0x02 )
  54
  55 /* Constants required to setup the initial stack. */
  56 #define portINITIAL_SPSR                ( ( StackType_t ) 0x1f ) /* System mode, ARM mode, interrupts enabled. */
  57 #define portTHUMB_MODE_BIT              ( ( StackType_t ) 0x20 )
  58 #define portINSTRUCTION_SIZE            ( ( StackType_t ) 4 )
  59
  60 /* Constants required to setup the PIT. */
  61 #define portPIT_CLOCK_DIVISOR           ( ( uint32_t ) 16 )
  62 #define portPIT_COUNTER_VALUE           ( ( ( configCPU_CLOCK_HZ / portPIT_CLOCK_DIVISOR ) / 1000UL ) * portTICK_PERIOD_MS )
  63
  64 /* Constants required to handle interrupts. */
  65 #define portTIMER_MATCH_ISR_BIT     ( ( uint8_t ) 0x01 )
  66 #define portCLEAR_VIC_INTERRUPT     ( ( uint32_t ) 0 )
  67
  68 /* Constants required to handle critical sections. */
  69 #define portNO_CRITICAL_NESTING         ( ( uint32_t ) 0 )
  70
  71
  72 #define portINT_LEVEL_SENSITIVE  0
  73 #define portPIT_ENABLE          ( ( uint16_t ) 0x1 << 24 )
  74 #define portPIT_INT_ENABLE      ( ( uint16_t ) 0x1 << 25 )
  75
  76 /* Constants required to setup the VIC for the tick ISR. */
  77 #define portTIMER_VIC_CHANNEL       ( ( uint32_t ) 0x0004 )
  78 #define portTIMER_VIC_CHANNEL_BIT   ( ( uint32_t ) 0x0010 )
  79 #define portTIMER_VIC_ENABLE        ( ( uint32_t ) 0x0020 )
  80
  81 /*-----------------------------------------------------------*/
  82
  83 /* Setup the PIT to generate the tick interrupts. */
  84 static void prvSetupTimerInterrupt( void );
  85
  86 /* ulCriticalNesting will get set to zero when the first task starts.  It
  87 cannot be initialised to 0 as this will cause interrupts to be enabled
  88 during the kernel initialisation process. */
  89 uint32_t ulCriticalNesting = ( uint32_t ) 9999;
  90
  91 /*-----------------------------------------------------------*/
  92
  93 /*
  94  * Initialise the stack of a task to look exactly as if a call to
  95  * portSAVE_CONTEXT had been called.
  96  *
  97  * See header file for description.
  98  */
  99 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )
 100 {
 101 StackType_t *pxOriginalTOS;
 102
 103     pxOriginalTOS = pxTopOfStack;
 104
 105     /* Setup the initial stack of the task.  The stack is set exactly as
 106     expected by the portRESTORE_CONTEXT() macro. */
 107
 108     /* First on the stack is the return address - which in this case is the
 109     start of the task.  The offset is added to make the return address appear
 110     as it would within an IRQ ISR. */
 111     *pxTopOfStack = ( StackType_t ) pxCode + portINSTRUCTION_SIZE;
 112     pxTopOfStack--;
 113
 114     *pxTopOfStack = ( StackType_t ) 0xaaaaaaaa; /* R14 */
 115     pxTopOfStack--;
 116     *pxTopOfStack = ( StackType_t ) pxOriginalTOS; /* Stack used when task starts goes in R13. */
 117     pxTopOfStack--;
 118     *pxTopOfStack = ( StackType_t ) 0x12121212; /* R12 */
 119     pxTopOfStack--;
 120     *pxTopOfStack = ( StackType_t ) 0x11111111; /* R11 */
 121     pxTopOfStack--;
 122     *pxTopOfStack = ( StackType_t ) 0x10101010; /* R10 */
 123     pxTopOfStack--;
 124     *pxTopOfStack = ( StackType_t ) 0x09090909; /* R9 */
 125     pxTopOfStack--;
 126     *pxTopOfStack = ( StackType_t ) 0x08080808; /* R8 */
 127     pxTopOfStack--;
 128     *pxTopOfStack = ( StackType_t ) 0x07070707; /* R7 */
 129     pxTopOfStack--;
 130     *pxTopOfStack = ( StackType_t ) 0x06060606; /* R6 */
 131     pxTopOfStack--;
 132     *pxTopOfStack = ( StackType_t ) 0x05050505; /* R5 */
 133     pxTopOfStack--;
 134     *pxTopOfStack = ( StackType_t ) 0x04040404; /* R4 */
 135     pxTopOfStack--;
 136     *pxTopOfStack = ( StackType_t ) 0x03030303; /* R3 */
 137     pxTopOfStack--;
 138     *pxTopOfStack = ( StackType_t ) 0x02020202; /* R2 */
 139     pxTopOfStack--;
 140     *pxTopOfStack = ( StackType_t ) 0x01010101; /* R1 */
 141     pxTopOfStack--;
 142
 143     /* When the task starts is will expect to find the function parameter in
 144     R0. */
 145     *pxTopOfStack = ( StackType_t ) pvParameters; /* R0 */
 146     pxTopOfStack--;
 147
 148     /* The status register is set for system mode, with interrupts enabled. */
 149     *pxTopOfStack = ( StackType_t ) portINITIAL_SPSR;
 150
 151     if( ( ( uint32_t ) pxCode & 0x01UL ) != 0x00UL )
 152     {
 153         /* We want the task to start in thumb mode. */
 154         *pxTopOfStack |= portTHUMB_MODE_BIT;
 155     }
 156
 157     pxTopOfStack--;
 158
 159     /* Interrupt flags cannot always be stored on the stack and will
 160     instead be stored in a variable, which is then saved as part of the
 161     tasks context. */
 162     *pxTopOfStack = portNO_CRITICAL_NESTING;
 163
 164     return pxTopOfStack;
 165 }
 166 /*-----------------------------------------------------------*/
 167
 168 BaseType_t xPortStartScheduler( void )
 169 {
 170 extern void vPortStartFirstTask( void );
 171
 172     /* Start the timer that generates the tick ISR.  Interrupts are disabled
 173     here already. */
 174     prvSetupTimerInterrupt();
 175
 176     /* Start the first task. */
 177     vPortStartFirstTask();
 178
 179     /* Should not get here! */
 180     return 0;
 181 }
 182 /*-----------------------------------------------------------*/
 183
 184 void vPortEndScheduler( void )
 185 {
 186     /* It is unlikely that the ARM port will require this function as there
 187     is nothing to return to.  */
 188 }
 189 /*-----------------------------------------------------------*/
 190
 191 #if configUSE_PREEMPTION == 0
 192
 193     /* The cooperative scheduler requires a normal IRQ service routine to
 194     simply increment the system tick. */
 195     static __arm __irq void vPortNonPreemptiveTick( void );
 196     static __arm __irq void vPortNonPreemptiveTick( void )
 197     {
 198         /* Increment the tick count - which may wake some tasks but as the
 199         preemptive scheduler is not being used any woken task is not given
 200         processor time no matter what its priority. */
 201         xTaskIncrementTick();
 202
 203         /* Ready for the next interrupt. */
 204         T0IR = portTIMER_MATCH_ISR_BIT;
 205         VICVectAddr = portCLEAR_VIC_INTERRUPT;
 206     }
 207
 208 #else
 209
 210     /* This function is called from an asm wrapper, so does not require the __irq
 211     keyword. */
 212     void vPortPreemptiveTick( void );
 213     void vPortPreemptiveTick( void )
 214     {
 215         /* Increment the tick counter. */
 216         if( xTaskIncrementTick() != pdFALSE )
 217         {
 218             /* The new tick value might unblock a task.  Ensure the highest task that
 219             is ready to execute is the task that will execute when the tick ISR
 220             exits. */
 221             vTaskSwitchContext();
 222         }
 223
 224         /* Ready for the next interrupt. */
 225         T0IR = portTIMER_MATCH_ISR_BIT;
 226         VICVectAddr = portCLEAR_VIC_INTERRUPT;
 227     }
 228
 229 #endif
 230
 231 /*-----------------------------------------------------------*/
 232
 233 static void prvSetupTimerInterrupt( void )
 234 {
 235 uint32_t ulCompareMatch;
 236
 237     /* A 1ms tick does not require the use of the timer prescale.  This is
 238     defaulted to zero but can be used if necessary. */
 239     T0PR = portPRESCALE_VALUE;
 240
 241     /* Calculate the match value required for our wanted tick rate. */
 242     ulCompareMatch = configCPU_CLOCK_HZ / configTICK_RATE_HZ;
 243
 244     /* Protect against divide by zero.  Using an if() statement still results
 245     in a warning - hence the #if. */
 246     #if portPRESCALE_VALUE != 0
 247     {
 248         ulCompareMatch /= ( portPRESCALE_VALUE + 1 );
 249     }
 250     #endif
 251
 252     T0MR0 = ulCompareMatch;
 253
 254     /* Generate tick with timer 0 compare match. */
 255     T0MCR = portRESET_COUNT_ON_MATCH | portINTERRUPT_ON_MATCH;
 256
 257     /* Setup the VIC for the timer. */
 258     VICIntSelect &= ~( portTIMER_VIC_CHANNEL_BIT );
 259     VICIntEnable |= portTIMER_VIC_CHANNEL_BIT;
 260
 261     /* The ISR installed depends on whether the preemptive or cooperative
 262     scheduler is being used. */
 263     #if configUSE_PREEMPTION == 1
 264     {
 265         extern void ( vPortPreemptiveTickEntry )( void );
 266
 267         VICVectAddr0 = ( uint32_t ) vPortPreemptiveTickEntry;
 268     }
 269     #else
 270     {
 271         extern void ( vNonPreemptiveTick )( void );
 272
 273         VICVectAddr0 = ( int32_t ) vPortNonPreemptiveTick;
 274     }
 275     #endif
 276
 277     VICVectCntl0 = portTIMER_VIC_CHANNEL | portTIMER_VIC_ENABLE;
 278
 279     /* Start the timer - interrupts are disabled when this function is called
 280     so it is okay to do this here. */
 281     T0TCR = portENABLE_TIMER;
 282 }
 283 /*-----------------------------------------------------------*/
 284
 285 void vPortEnterCritical( void )
 286 {
 287     /* Disable interrupts first! */
 288     __disable_interrupt();
 289
 290     /* Now interrupts are disabled ulCriticalNesting can be accessed
 291     directly.  Increment ulCriticalNesting to keep a count of how many times
 292     portENTER_CRITICAL() has been called. */
 293     ulCriticalNesting++;
 294 }
 295 /*-----------------------------------------------------------*/
 296
 297 void vPortExitCritical( void )
 298 {
 299     if( ulCriticalNesting > portNO_CRITICAL_NESTING )
 300     {
 301         /* Decrement the nesting count as we are leaving a critical section. */
 302         ulCriticalNesting--;
 303
 304         /* If the nesting level has reached zero then interrupts should be
 305         re-enabled. */
 306         if( ulCriticalNesting == portNO_CRITICAL_NESTING )
 307         {
 308             __enable_interrupt();
 309         }
 310     }
 311 }
 312 /*-----------------------------------------------------------*/