git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M4_ATSAM4L_Atmel_Studio/src/SAM4L_low_power_tick_management.c

   1 /*\r
   2     FreeRTOS V7.6.0 - Copyright (C) 2013 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /* Standard includes. */\r
  67 #include "limits.h"\r
  68 \r
  69 /* FreeRTOS includes. */\r
  70 #include "FreeRTOS.h"\r
  71 #include "task.h"\r
  72 \r
  73 /* Library includes. */\r
  74 #include <asf.h>\r
  75 \r
  76 \r
  77 /*\r
  78  * When configCREATE_LOW_POWER_DEMO is set to 1 then the tick interrupt\r
  79  * is generated by the AST.  The AST configuration and handling functions are\r
  80  * defined in this file.\r
  81  *\r
  82  * When configCREATE_LOW_POWER_DEMO is set to 0 the tick interrupt is\r
  83  * generated by the standard FreeRTOS Cortex-M port layer, which uses the\r
  84  * SysTick timer.\r
  85  */\r
  86 #if configCREATE_LOW_POWER_DEMO == 1\r
  87 \r
  88 /* Constants required to pend a PendSV interrupt from the tick ISR if the\r
  89 preemptive scheduler is being used.  These are just standard bits and registers\r
  90 within the Cortex-M core itself. */\r
  91 #define portNVIC_INT_CTRL_REG   ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )\r
  92 #define portNVIC_PENDSVSET_BIT  ( 1UL << 28UL )\r
  93 \r
  94 /* The alarm used to generate interrupts in the asynchronous timer. */\r
  95 #define portAST_ALARM_CHANNEL   0\r
  96 \r
  97 /*-----------------------------------------------------------*/\r
  98 \r
  99 /*\r
 100  * The tick interrupt is generated by the asynchronous timer.  The default tick\r
 101  * interrupt handler cannot be used (even with the AST being handled from the\r
 102  * tick hook function) because the default tick interrupt accesses the SysTick\r
 103  * registers when configUSE_TICKLESS_IDLE set to 1.  AST_ALARM_Handler() is the\r
 104  * default name for the AST alarm interrupt.  This definition overrides the\r
 105  * default implementation that is weakly defined in the interrupt vector table\r
 106  * file.\r
 107  */\r
 108 void AST_ALARM_Handler(void);\r
 109 \r
 110 /*\r
 111  * Functions that disable and enable the AST respectively, not returning until\r
 112  * the operation is known to have taken effect.\r
 113  */\r
 114 static void prvDisableAST( void );\r
 115 static void prvEnableAST( void );\r
 116 \r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 /* Calculate how many clock increments make up a single tick period. */\r
 120 static const uint32_t ulAlarmValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
 121 \r
 122 /* Holds the maximum number of ticks that can be suppressed - which is\r
 123 basically how far into the future an interrupt can be generated. Set\r
 124 during initialisation. */\r
 125 static portTickType xMaximumPossibleSuppressedTicks = 0;\r
 126 \r
 127 /* Flag set from the tick interrupt to allow the sleep processing to know if\r
 128 sleep mode was exited because of an AST interrupt or a different interrupt. */\r
 129 static volatile uint32_t ulTickFlag = pdFALSE;\r
 130 \r
 131 /* The AST counter is stopped temporarily each time it is re-programmed.  The\r
 132 following variable offsets the AST counter alarm value by the number of AST\r
 133 counts that would typically be missed while the counter was stopped to compensate\r
 134 for the lost time.  _RB_ Value needs calculating correctly. */\r
 135 static uint32_t ulStoppedTimerCompensation = 2 / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
 136 \r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 /* The tick interrupt handler.  This is always the same other than the part that\r
 140 clears the interrupt, which is specific to the clock being used to generate the\r
 141 tick. */\r
 142 void AST_ALARM_Handler(void)\r
 143 {\r
 144         /* Protect incrementing the tick with an interrupt safe critical section. */\r
 145         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
 146         {\r
 147                 if( xTaskIncrementTick() != pdFALSE )\r
 148                 {\r
 149                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 150                 }\r
 151 \r
 152                 /* Just completely clear the interrupt mask on exit by passing 0 because\r
 153                 it is known that this interrupt will only ever execute with the lowest\r
 154                 possible interrupt priority. */\r
 155         }\r
 156         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
 157 \r
 158         /* The CPU woke because of a tick. */\r
 159         ulTickFlag = pdTRUE;\r
 160 \r
 161         /* If this is the first tick since exiting tickless mode then the AST needs\r
 162         to be reconfigured to generate interrupts at the defined tick frequency. */\r
 163         ast_write_alarm0_value( AST, ulAlarmValueForOneTick );\r
 164 \r
 165         /* Ensure the interrupt is clear before exiting. */\r
 166         ast_clear_interrupt_flag( AST, AST_INTERRUPT_ALARM );\r
 167 }\r
 168 /*-----------------------------------------------------------*/\r
 169 \r
 170 /* Override the default definition of vPortSetupTimerInterrupt() that is weakly\r
 171 defined in the FreeRTOS Cortex-M3 port layer with a version that configures the\r
 172 asynchronous timer (AST) to generate the tick interrupt. */\r
 173 void vPortSetupTimerInterrupt( void )\r
 174 {\r
 175 struct ast_config ast_conf;\r
 176 \r
 177         /* Ensure the AST can bring the CPU out of sleep mode. */\r
 178         sleepmgr_lock_mode( SLEEPMGR_RET );\r
 179 \r
 180         /* Ensure the 32KHz oscillator is enabled. */\r
 181         if( osc_is_ready( OSC_ID_OSC32 ) == pdFALSE )\r
 182         {\r
 183                 osc_enable( OSC_ID_OSC32 );\r
 184                 osc_wait_ready( OSC_ID_OSC32 );\r
 185         }\r
 186 \r
 187         /* Enable the AST itself. */\r
 188         ast_enable( AST );\r
 189 \r
 190         ast_conf.mode = AST_COUNTER_MODE;  /* Simple up counter. */\r
 191         ast_conf.osc_type = AST_OSC_32KHZ;\r
 192         ast_conf.psel = 0; /* No prescale so the actual frequency is 32KHz/2. */\r
 193         ast_conf.counter = 0;\r
 194         ast_set_config( AST, &ast_conf );\r
 195 \r
 196         /* The AST alarm interrupt is used as the tick interrupt.  Ensure the alarm\r
 197         status starts clear. */\r
 198         ast_clear_interrupt_flag( AST, AST_INTERRUPT_ALARM );\r
 199 \r
 200         /* Enable wakeup from alarm 0 in the AST and power manager.  */\r
 201         ast_enable_wakeup( AST, AST_WAKEUP_ALARM );\r
 202         bpm_enable_wakeup_source( BPM, ( 1 << BPM_BKUPWEN_AST ) );\r
 203 \r
 204         /* Tick interrupt MUST execute at the lowest interrupt priority. */\r
 205         NVIC_SetPriority( AST_ALARM_IRQn, configLIBRARY_LOWEST_INTERRUPT_PRIORITY);\r
 206         ast_enable_interrupt( AST, AST_INTERRUPT_ALARM );\r
 207         NVIC_ClearPendingIRQ( AST_ALARM_IRQn );\r
 208         NVIC_EnableIRQ( AST_ALARM_IRQn );\r
 209 \r
 210         /* Automatically clear the counter on interrupt. */\r
 211         ast_enable_counter_clear_on_alarm( AST, portAST_ALARM_CHANNEL );\r
 212 \r
 213         /* Start with the tick active and generating a tick with regular period. */\r
 214         ast_write_alarm0_value( AST, ulAlarmValueForOneTick );\r
 215         ast_write_counter_value( AST, 0 );\r
 216 \r
 217         /* See the comments where xMaximumPossibleSuppressedTicks is declared. */\r
 218         xMaximumPossibleSuppressedTicks = ULONG_MAX / ulAlarmValueForOneTick;\r
 219 }\r
 220 /*-----------------------------------------------------------*/\r
 221 \r
 222 static void prvDisableAST( void )\r
 223 {\r
 224         while( ast_is_busy( AST ) )\r
 225         {\r
 226                 /* Nothing to do here, just waiting. */\r
 227         }\r
 228         AST->AST_CR &= ~( AST_CR_EN );\r
 229         while( ast_is_busy( AST ) )\r
 230         {\r
 231                 /* Nothing to do here, just waiting. */\r
 232         }\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 static void prvEnableAST( void )\r
 237 {\r
 238         while( ast_is_busy( AST ) )\r
 239         {\r
 240                 /* Nothing to do here, just waiting. */\r
 241         }\r
 242         AST->AST_CR |= AST_CR_EN;\r
 243         while( ast_is_busy( AST ) )\r
 244         {\r
 245                 /* Nothing to do here, just waiting. */\r
 246         }\r
 247 }\r
 248 /*-----------------------------------------------------------*/\r
 249 \r
 250 /* Override the default definition of vPortSuppressTicksAndSleep() that is weakly\r
 251 defined in the FreeRTOS Cortex-M3 port layet with a version that manages the\r
 252 asynchronous timer (AST), as the tick is generated from the low power AST and\r
 253 not the SysTick as would normally be the case on a Cortex-M. */\r
 254 void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )\r
 255 {\r
 256 uint32_t ulAlarmValue, ulCompleteTickPeriods;\r
 257 eSleepModeStatus eSleepAction;\r
 258 portTickType xModifiableIdleTime;\r
 259 enum sleepmgr_mode xSleepMode;\r
 260 \r
 261         /* THIS FUNCTION IS CALLED WITH THE SCHEDULER SUSPENDED. */\r
 262 \r
 263         /* Make sure the AST reload value does not overflow the counter. */\r
 264         if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
 265         {\r
 266                 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
 267         }\r
 268 \r
 269         /* Calculate the reload value required to wait xExpectedIdleTime tick\r
 270         periods. */\r
 271         ulAlarmValue = ulAlarmValueForOneTick * xExpectedIdleTime;\r
 272         if( ulAlarmValue > ulStoppedTimerCompensation )\r
 273         {\r
 274                 /* Compensate for the fact that the AST is going to be stopped\r
 275                 momentarily. */\r
 276                 ulAlarmValue -= ulStoppedTimerCompensation;\r
 277         }\r
 278 \r
 279         /* Stop the AST momentarily.  The time the AST is stopped for is accounted\r
 280         for as best it can be, but using the tickless mode will inevitably result in\r
 281         some tiny drift of the time maintained by the kernel with respect to\r
 282         calendar time. */\r
 283         prvDisableAST();\r
 284 \r
 285         /* Enter a critical section but don't use the taskENTER_CRITICAL() method as\r
 286         that will mask interrupts that should exit sleep mode. */\r
 287         __asm volatile( "cpsid i                \n\t"\r
 288                                         "dsb                    \n\t" );\r
 289 \r
 290         /* The tick flag is set to false before sleeping.  If it is true when sleep\r
 291         mode is exited then sleep mode was probably exited because the tick was\r
 292         suppressed for the entire xExpectedIdleTime period. */\r
 293         ulTickFlag = pdFALSE;\r
 294 \r
 295         /* If a context switch is pending then abandon the low power entry as\r
 296         the context switch might have been pended by an external interrupt that\r
 297         requires processing. */\r
 298         eSleepAction = eTaskConfirmSleepModeStatus();\r
 299         if( eSleepAction == eAbortSleep )\r
 300         {\r
 301                 /* Restart tick. */\r
 302                 prvEnableAST();\r
 303 \r
 304                 /* Re-enable interrupts - see comments above the cpsid instruction()\r
 305                 above. */\r
 306                 __asm volatile( "cpsie i" );\r
 307         }\r
 308         else\r
 309         {\r
 310                 /* Adjust the alarm value to take into account that the current time\r
 311                 slice is already partially complete. */\r
 312                 ulAlarmValue -= ast_read_counter_value( AST );\r
 313                 ast_write_alarm0_value( AST, ulAlarmValue );\r
 314 \r
 315                 /* Restart the AST. */\r
 316                 prvEnableAST();\r
 317 \r
 318                 /* Allow the application to define some pre-sleep processing. */\r
 319                 xModifiableIdleTime = xExpectedIdleTime;\r
 320                 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
 321 \r
 322                 /* xExpectedIdleTime being set to 0 by configPRE_SLEEP_PROCESSING()\r
 323                 means the application defined code has already executed the WAIT\r
 324                 instruction. */\r
 325                 if( xModifiableIdleTime > 0 )\r
 326                 {\r
 327                         /* Find the deepest allowable sleep mode. */\r
 328                         xSleepMode = sleepmgr_get_sleep_mode();\r
 329 \r
 330                         if( xSleepMode != SLEEPMGR_ACTIVE )\r
 331                         {\r
 332                                 /* Sleep until something happens. */\r
 333                                 bpm_sleep( BPM, xSleepMode );\r
 334                         }\r
 335                 }\r
 336 \r
 337                 /* Allow the application to define some post sleep processing. */\r
 338                 configPOST_SLEEP_PROCESSING( xModifiableIdleTime );\r
 339 \r
 340                 /* Stop AST.  Again, the time the SysTick is stopped for is     accounted\r
 341                 for as best it can be, but using the tickless mode will inevitably\r
 342                 result in some tiny drift of the time maintained by the kernel with\r
 343                 respect to calendar time. */\r
 344                 prvDisableAST();\r
 345 \r
 346                 /* Re-enable interrupts - see comments above the cpsid instruction()\r
 347                 above. */\r
 348                 __asm volatile( "cpsie i" );\r
 349 \r
 350                 if( ulTickFlag != pdFALSE )\r
 351                 {\r
 352                         /* The tick interrupt has already executed, although because this\r
 353                         function is called with the scheduler suspended the actual tick\r
 354                         processing will not occur until after this function has exited.\r
 355                         Reset the alarm value with whatever remains of this tick period. */\r
 356                         ulAlarmValue = ulAlarmValueForOneTick - ast_read_counter_value( AST );\r
 357                         ast_write_alarm0_value( AST, ulAlarmValue );\r
 358 \r
 359                         /* The tick interrupt handler will already have pended the tick\r
 360                         processing in the kernel.  As the pending tick will be processed as\r
 361                         soon as this function exits, the tick value     maintained by the tick\r
 362                         is stepped forward by one less than the time spent sleeping.  The\r
 363                         actual stepping of the tick appears later in this function. */\r
 364                         ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
 365                 }\r
 366                 else\r
 367                 {\r
 368                         /* Something other than the tick interrupt ended the sleep.  How\r
 369                         many complete tick periods passed while the processor was\r
 370                         sleeping? */\r
 371                         ulCompleteTickPeriods = ast_read_counter_value( AST ) / ulAlarmValueForOneTick;\r
 372 \r
 373                         /* The alarm value is set to whatever fraction of a single tick\r
 374                         period remains. */\r
 375                         ulAlarmValue = ast_read_counter_value( AST ) - ( ulCompleteTickPeriods * ulAlarmValueForOneTick );\r
 376                         ast_write_alarm0_value( AST, ulAlarmValue );\r
 377                 }\r
 378 \r
 379                 /* Restart the AST so it runs up to the alarm value.  The alarm value\r
 380                 will get set to the value required to generate exactly one tick period\r
 381                 the next time the AST interrupt executes. */\r
 382                 prvEnableAST();\r
 383 \r
 384                 /* Wind the tick forward by the number of tick periods that the CPU\r
 385                 remained in a low power state. */\r
 386                 vTaskStepTick( ulCompleteTickPeriods );\r
 387         }\r
 388 }\r
 389 \r
 390 \r
 391 #endif /* configCREATE_LOW_POWER_DEMO == 1 */\r
 392 \r