git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_STM32L152_Discovery_IAR/STM32L_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 /* ST library functions. */\r
  74 #include "stm32l1xx.h"\r
  75 \r
  76 /*\r
  77  * When configCREATE_LOW_POWER_DEMO is set to 1 then the tick interrupt\r
  78  * is generated by the wakeup interrupt of the real time clock (RTC).  The RTC\r
  79  * configuration and handling functions are defined in this file.\r
  80  *\r
  81  * When configCREATE_LOW_POWER_DEMO is set to 0 the tick interrupt is\r
  82  * generated by the standard FreeRTOS Cortex-M port layer, which uses the\r
  83  * SysTick timer.\r
  84  */\r
  85 #if configCREATE_LOW_POWER_DEMO == 1\r
  86 \r
  87 /* The frequency at which TIM2 should run. */\r
  88 #define lpCLOCK_INPUT_FREQUENCY         ( 1000UL )\r
  89 \r
  90 /* Constants required to pend a PendSV interrupt from the tick ISR if the\r
  91 preemptive scheduler is being used.  These are just standard bits and registers\r
  92 within the Cortex-M core itself. */\r
  93 #define portNVIC_PENDSVSET_BIT  ( 1UL << 28UL )\r
  94 \r
  95 #define DBGMCU_APB1_FZ  ( * ( ( volatile unsigned long * ) 0xE0042008 ) )\r
  96 /*-----------------------------------------------------------*/\r
  97 \r
  98 /*\r
  99  * The tick interrupt is generated by the TIM2 timer.  The default interrupt\r
 100  * handler cannot be used (even with the TIM2 being handled from the tick hook\r
 101  * function) because the default tick interrupt accesses the SysTick registers\r
 102  * when configUSE_TICKLESS_IDLE set to 1.  TIM2_IRQHandler() is the default name\r
 103  * for the TIM2 interrupt handler.\r
 104  */\r
 105 void TIM2_IRQHandler( void );\r
 106 \r
 107 /*-----------------------------------------------------------*/\r
 108 \r
 109 /* Calculate how many clock increments make up a single tick period. */\r
 110 static const uint32_t ulReloadValueForOneTick = ( ( lpCLOCK_INPUT_FREQUENCY / configTICK_RATE_HZ ) - 1 );\r
 111 \r
 112 /* Holds the maximum number of ticks that can be suppressed - which is\r
 113 basically how far into the future an interrupt can be generated. Set during\r
 114 initialisation. */\r
 115 static portTickType xMaximumPossibleSuppressedTicks = 0;\r
 116 \r
 117 /* Flag set from the tick interrupt to allow the sleep processing to know if\r
 118 sleep mode was exited because of an RTC interrupt or a different interrupt. */\r
 119 static volatile uint32_t ulTickFlag = pdFALSE;\r
 120 \r
 121 /* The RTC counter is stopped temporarily each time it is re-programmed.  The\r
 122 following variable offsets the RTC counter alarm value by the number of RTC\r
 123 counts that would typically be missed while the counter was stopped to\r
 124 compensate for the lost time.  _RB_ Value needs calculating correctly. */\r
 125 static uint32_t ulStoppedTimerCompensation = 1;//_RB_ / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
 126 \r
 127 /*-----------------------------------------------------------*/\r
 128 \r
 129 /* The tick interrupt handler.  This is always the same other than the part that\r
 130 clears the interrupt, which is specific to the clock being used to generate the\r
 131 tick. */\r
 132 void TIM2_IRQHandler( void )\r
 133 {\r
 134         TIM_ClearITPendingBit( TIM2, TIM_IT_Update );\r
 135         TIM_SetAutoreload( TIM2, ( uint16_t ) ulReloadValueForOneTick );\r
 136 \r
 137         /* Protect incrementing the tick with an interrupt safe critical section. */\r
 138         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
 139         {\r
 140                 if( xTaskIncrementTick() != pdFALSE )\r
 141                 {\r
 142                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 143                 }\r
 144 \r
 145                 /* Just completely clear the interrupt mask on exit by passing 0 because\r
 146                 it is known that this interrupt will only ever execute with the lowest\r
 147                 possible interrupt priority. */\r
 148         }\r
 149         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
 150 \r
 151         /* The CPU woke because of a tick. */\r
 152         ulTickFlag = pdTRUE;\r
 153 }\r
 154 /*-----------------------------------------------------------*/\r
 155 \r
 156 /* Override the default definition of vPortSetupTimerInterrupt() that is weakly\r
 157 defined in the FreeRTOS Cortex-M3 port layer with a version that configures the\r
 158 wakeup timer of the RTC to generate the tick interrupt. */\r
 159 void vPortSetupTimerInterrupt( void )\r
 160 {\r
 161 NVIC_InitTypeDef NVIC_InitStructure;\r
 162 TIM_TimeBaseInitTypeDef  TIM_TimeBaseStructure;\r
 163 \r
 164         /* Enable the TIM2 clock, which is used to generate long tickless periods\r
 165         when the tickless period is finite. */\r
 166         RCC_APB1PeriphClockCmd( RCC_APB1Periph_TIM2, ENABLE );\r
 167 \r
 168         /* Ensure clock stops in debug mode. */\r
 169         DBGMCU_APB1_FZ |= DBGMCU_APB1_FZ_DBG_TIM2_STOP;\r
 170 \r
 171         /* Scale the clock so very long tickless periods can be acheived.  The\r
 172         SysTick is not used as even when its frequency is divided by 8 the maximum\r
 173         tickless period with a system clock of 16MHz is only 8.3 seconds.  Using\r
 174         a prescaled clock on the 16-bit TIM2 allows a tickless period of nearly\r
 175         66 seconds, albeit at low resolution. */\r
 176         TIM_TimeBaseStructure.TIM_Prescaler = ( uint16_t ) ( SystemCoreClock / lpCLOCK_INPUT_FREQUENCY );\r
 177         TIM_TimeBaseStructure.TIM_CounterMode = TIM_CounterMode_Up;\r
 178         TIM_TimeBaseStructure.TIM_Period = ( uint16_t ) ( lpCLOCK_INPUT_FREQUENCY / configTICK_RATE_HZ );\r
 179         TIM_TimeBaseStructure.TIM_ClockDivision = 0;\r
 180         TIM_TimeBaseInit( TIM2, &TIM_TimeBaseStructure );\r
 181 \r
 182         /* Enable the TIM2 interrupt - used for the tick interrupt when the tickless\r
 183         period is finite. */\r
 184         NVIC_InitStructure.NVIC_IRQChannel = TIM2_IRQn;\r
 185         NVIC_InitStructure.NVIC_IRQChannelPreemptionPriority = configLIBRARY_LOWEST_INTERRUPT_PRIORITY; /* Must be set to lowest priority. */\r
 186         NVIC_InitStructure.NVIC_IRQChannelSubPriority = 0;\r
 187         NVIC_InitStructure.NVIC_IRQChannelCmd = ENABLE;\r
 188         NVIC_Init(&NVIC_InitStructure);\r
 189         TIM_ITConfig( TIM2, TIM_IT_Update, ENABLE );\r
 190         TIM_SetCounter( TIM2, 0 );\r
 191         TIM_Cmd( TIM2, ENABLE );\r
 192 \r
 193         /* See the comments where xMaximumPossibleSuppressedTicks is declared. */\r
 194         xMaximumPossibleSuppressedTicks = ( ( unsigned long ) USHRT_MAX ) / ulReloadValueForOneTick;\r
 195 }\r
 196 /*-----------------------------------------------------------*/\r
 197 \r
 198 /* Override the default definition of vPortSuppressTicksAndSleep() that is\r
 199 weakly defined in the FreeRTOS Cortex-M3 port layer with a version that manages\r
 200 the TIM2 interrupt, as the tick is generated from TIM2 compare matches events. */\r
 201 void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )\r
 202 {\r
 203 uint32_t ulCounterValue, ulCompleteTickPeriods;\r
 204 eSleepModeStatus eSleepAction;\r
 205 portTickType xModifiableIdleTime;\r
 206 const portTickType xRegulatorOffIdleTime = 30;\r
 207 \r
 208         /* THIS FUNCTION IS CALLED WITH THE SCHEDULER SUSPENDED. */\r
 209 \r
 210         /* Make sure the TIM2 reload value does not overflow the counter. */\r
 211         if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
 212         {\r
 213                 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
 214         }\r
 215 \r
 216         /* Calculate the reload value required to wait xExpectedIdleTime tick\r
 217         periods. */\r
 218         ulCounterValue = ulReloadValueForOneTick * xExpectedIdleTime;\r
 219         if( ulCounterValue > ulStoppedTimerCompensation )\r
 220         {\r
 221                 /* Compensate for the fact that TIM2 is going to be stopped\r
 222                 momentarily. */\r
 223                 ulCounterValue -= ulStoppedTimerCompensation;\r
 224         }\r
 225 \r
 226         /* Stop TIM2 momentarily.  The time TIM2 is stopped for is accounted for as\r
 227         best it can be, but using the tickless mode will inevitably result in some\r
 228         tiny drift of the time maintained by the kernel with respect to calendar\r
 229         time. */\r
 230         TIM_Cmd( TIM2, DISABLE );\r
 231 \r
 232         /* Enter a critical section but don't use the taskENTER_CRITICAL() method as\r
 233         that will mask interrupts that should exit sleep mode. */\r
 234         __asm volatile ( "cpsid i" );\r
 235         __asm volatile ( "dsb" );\r
 236         __asm volatile ( "isb" );\r
 237 \r
 238         /* The tick flag is set to false before sleeping.  If it is true when sleep\r
 239         mode is exited then sleep mode was probably exited because the tick was\r
 240         suppressed for the entire xExpectedIdleTime period. */\r
 241         ulTickFlag = pdFALSE;\r
 242 \r
 243         /* If a context switch is pending then abandon the low power entry as\r
 244         the context switch might have been pended by an external interrupt that\r
 245         requires processing. */\r
 246         eSleepAction = eTaskConfirmSleepModeStatus();\r
 247         if( eSleepAction == eAbortSleep )\r
 248         {\r
 249                 /* Restart tick. */\r
 250                 TIM_Cmd( TIM2, ENABLE );\r
 251 \r
 252                 /* Re-enable interrupts - see comments above the cpsid instruction()\r
 253                 above. */\r
 254                 __asm volatile ( "cpsie i" );\r
 255         }\r
 256         else if( eSleepAction == eNoTasksWaitingTimeout )\r
 257         {\r
 258                 /* There are no running state tasks and no tasks that are blocked with a\r
 259                 time out.  Assuming the application does not care if the tick time slips\r
 260                 with respect to calendar time then enter a deep sleep that can only be\r
 261                 woken by (in this demo case) the user button being pushed on the\r
 262                 STM32L discovery board. */\r
 263                 configPRE_STOP_PROCESSING();\r
 264                 PWR_EnterSTOPMode( PWR_Regulator_LowPower, PWR_SLEEPEntry_WFI );\r
 265                 configPOST_STOP_PROCESSING();\r
 266 \r
 267                 /* Restart tick. */\r
 268                 TIM_SetCounter( TIM2, 0 );\r
 269                 TIM_Cmd( TIM2, ENABLE );\r
 270 \r
 271                 /* Re-enable interrupts - see comments above the cpsid instruction()\r
 272                 above. */\r
 273                 __asm volatile ( "cpsie i" );\r
 274         }\r
 275         else\r
 276         {\r
 277                 /* Adjust the TIM2 value to take into account that the current time\r
 278                 slice is already partially complete. */\r
 279                 configASSERT( ulCounterValue >= TIM_GetCounter( TIM2 ) );\r
 280                 ulCounterValue -= ( uint32_t ) TIM_GetCounter( TIM2 );\r
 281                 configASSERT( ulCounterValue < ( uint32_t ) USHRT_MAX );\r
 282                 configASSERT( ulCounterValue != 0 );\r
 283                 TIM_SetAutoreload( TIM2, ( uint16_t ) ulCounterValue );\r
 284                 TIM_SetCounter( TIM2, 0 );\r
 285 \r
 286                 /* Restart the TIM2. */\r
 287                 TIM_Cmd( TIM2, ENABLE );\r
 288 \r
 289                 /* Allow the application to define some pre-sleep processing. */\r
 290                 xModifiableIdleTime = xExpectedIdleTime;\r
 291                 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
 292 \r
 293                 /* xExpectedIdleTime being set to 0 by configPRE_SLEEP_PROCESSING()\r
 294                 means the application defined code has already executed the WAIT\r
 295                 instruction. */\r
 296                 if( xModifiableIdleTime > 0 )\r
 297                 {\r
 298                         /* The sleep mode used is dependent on the expected idle time\r
 299                         as the deeper the sleep the longer the wake up time. */\r
 300                         if( xModifiableIdleTime > xRegulatorOffIdleTime )\r
 301                         {\r
 302                                 /* A slightly lower power sleep mode with a longer wake up\r
 303                                 time. */\r
 304                                 PWR_EnterSleepMode( PWR_Regulator_LowPower, PWR_SLEEPEntry_WFI );\r
 305                         }\r
 306                         else if( pdTRUE )\r
 307                         {\r
 308                                 /* A slightly higher power sleep mode with a faster wake up\r
 309                                 time. */\r
 310                                 PWR_EnterSleepMode( PWR_Regulator_ON, PWR_SLEEPEntry_WFI );\r
 311                         }\r
 312                 }\r
 313 \r
 314                 /* Allow the application to define some post sleep processing. */\r
 315                 configPOST_SLEEP_PROCESSING( xModifiableIdleTime );\r
 316 \r
 317                 /* Stop TIM2.  Again, the time the SysTick is stopped for is accounted\r
 318                 for as best it can be, but using the tickless mode will inevitably\r
 319                 result in some tiny drift of the time maintained by the kernel with\r
 320                 respect to calendar time. */\r
 321                 TIM_Cmd( TIM2, DISABLE );\r
 322 \r
 323                 /* Re-enable interrupts - see comments above the cpsid instruction()\r
 324                 above. */\r
 325                 __asm volatile ( "cpsie i" );\r
 326                 __asm volatile ( "dsb" );\r
 327                 __asm volatile ( "isb" );\r
 328 \r
 329                 if( ulTickFlag != pdFALSE )\r
 330                 {\r
 331                         /* The tick interrupt has already executed, although because this\r
 332                         function is called with the scheduler suspended the actual tick\r
 333                         processing will not occur until after this function has exited.\r
 334                         Reset the reload value with whatever remains of this tick period. */\r
 335                         configASSERT( ulReloadValueForOneTick >= ( uint32_t ) TIM_GetCounter( TIM2 ) );\r
 336                         ulCounterValue = ulReloadValueForOneTick - ( uint32_t ) TIM_GetCounter( TIM2 );\r
 337                         configASSERT( ulCounterValue <= ( uint32_t ) USHRT_MAX );\r
 338                         configASSERT( ulCounterValue != 0 );\r
 339                         TIM_SetAutoreload( TIM2, ( uint16_t ) ulCounterValue );\r
 340                         TIM_SetCounter( TIM2, 0 );\r
 341 \r
 342                         /* The tick interrupt handler will already have pended the tick\r
 343                         processing in the kernel.  As the pending tick will be processed as\r
 344                         soon as this function exits, the tick value     maintained by the tick\r
 345                         is stepped forward by one less than the time spent sleeping.  The\r
 346                         actual stepping of the tick appears later in this function. */\r
 347                         ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
 348                 }\r
 349                 else\r
 350                 {\r
 351                         /* Something other than the tick interrupt ended the sleep.  How\r
 352                         many complete tick periods passed while the processor was\r
 353                         sleeping? */\r
 354                         ulCompleteTickPeriods = ( ( uint32_t ) TIM_GetCounter( TIM2 ) ) / ulReloadValueForOneTick;\r
 355 \r
 356                         /* The reload value is set to whatever fraction of a single tick\r
 357                         period remains. */\r
 358                         configASSERT( ( ( uint32_t ) TIM_GetCounter( TIM2 ) ) >= ( ulCompleteTickPeriods * ulReloadValueForOneTick ) );\r
 359                         ulCounterValue = ( ( uint32_t ) TIM_GetCounter( TIM2 ) ) - ( ulCompleteTickPeriods * ulReloadValueForOneTick );\r
 360                         configASSERT( ulCounterValue <= ( uint32_t ) USHRT_MAX );\r
 361                         if( ulCounterValue == 0 )\r
 362                         {\r
 363                                 /* There is no fraction remaining. */\r
 364                                 ulCounterValue = ulReloadValueForOneTick;\r
 365                                 ulCompleteTickPeriods++;\r
 366                         }\r
 367                         TIM_SetAutoreload( TIM2, ( uint16_t ) ulCounterValue );\r
 368                         TIM_SetCounter( TIM2, 0 );\r
 369                 }\r
 370 \r
 371                 /* Restart TIM2 so it runs up to the reload value.  The reload value\r
 372                 will get set to the value required to generate exactly one tick period\r
 373                 the next time the TIM2 interrupt executes. */\r
 374                 TIM_Cmd( TIM2, ENABLE );\r
 375 \r
 376                 /* Wind the tick forward by the number of tick periods that the CPU\r
 377                 remained in a low power state. */\r
 378                 vTaskStepTick( ulCompleteTickPeriods );\r
 379         }\r
 380 }\r
 381 \r
 382 \r
 383 \r
 384 #endif /* configCREATE_LOW_POWER_DEMO == 1 */\r
 385 \r