git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A53_64-bit_UltraScale_MPSoC/RTOSDemo_A53/src/Full_Demo/IntQueueTimer.c

   1 /*\r
   2  * FreeRTOS Kernel V10.2.1\r
   3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /*\r
  29  * NOTE:  Currently only timer 1 and timer 2 are used -\r
  30  *\r
  31  * This file initialises two timers as follows:\r
  32  *\r
  33  * Timer 0 and Timer 1 provide the interrupts that are used with the IntQ\r
  34  * standard demo tasks, which test interrupt nesting and using queues from\r
  35  * interrupts.  Both these interrupts operate below the maximum syscall\r
  36  * interrupt priority.\r
  37  *\r
  38  * Timer 2 is a much higher frequency timer that tests the nesting of interrupts\r
  39  * that execute above the maximum syscall interrupt priority.\r
  40  *\r
  41  * All the timers can nest with the tick interrupt - creating a maximum\r
  42  * interrupt nesting depth of 4.\r
  43  *\r
  44  * For convenience, the high frequency timer is also used to provide the time\r
  45  * base for the run time stats.\r
  46  */\r
  47 \r
  48 /* Scheduler includes. */\r
  49 #include "FreeRTOS.h"\r
  50 \r
  51 /* Demo includes. */\r
  52 #include "IntQueueTimer.h"\r
  53 #include "IntQueue.h"\r
  54 \r
  55 /* Xilinx includes. */\r
  56 #include "xttcps.h"\r
  57 #include "xscugic.h"\r
  58 \r
  59 /* The frequencies at which the first two timers expire are slightly offset to\r
  60 ensure they don't remain synchronised.  The frequency of the interrupt that\r
  61 operates above the max syscall interrupt priority is 10 times faster so really\r
  62 hammers the interrupt entry and exit code. */\r
  63 #define tmrTIMERS_USED  3\r
  64 #define tmrTIMER_0_FREQUENCY    ( 100UL )\r
  65 #define tmrTIMER_1_FREQUENCY    ( 111UL )\r
  66 #define tmrTIMER_2_FREQUENCY    ( 20000UL )\r
  67 \r
  68 /*-----------------------------------------------------------*/\r
  69 \r
  70 /*\r
  71  * The single interrupt service routines that is used to service all three\r
  72  * timers.\r
  73  */\r
  74 static void prvTimerHandler( void *CallBackRef );\r
  75 \r
  76 /*-----------------------------------------------------------*/\r
  77 \r
  78 /* Hardware constants. */\r
  79 static const BaseType_t xDeviceIDs[ tmrTIMERS_USED ] = { XPAR_XTTCPS_0_DEVICE_ID, XPAR_XTTCPS_1_DEVICE_ID, XPAR_XTTCPS_2_DEVICE_ID };\r
  80 static const BaseType_t xInterruptIDs[ tmrTIMERS_USED ] = { XPAR_XTTCPS_0_INTR, XPAR_XTTCPS_1_INTR, XPAR_XTTCPS_2_INTR };\r
  81 \r
  82 /* Timer configuration settings. */\r
  83 typedef struct\r
  84 {\r
  85         uint32_t OutputHz;      /* Output frequency. */\r
  86         uint16_t Interval;      /* Interval value. */\r
  87         uint8_t Prescaler;      /* Prescaler value. */\r
  88         uint16_t Options;       /* Option settings. */\r
  89 } TmrCntrSetup;\r
  90 \r
  91 static TmrCntrSetup xTimerSettings[ tmrTIMERS_USED ] =\r
  92 {\r
  93         { tmrTIMER_0_FREQUENCY, 0, 0, XTTCPS_OPTION_INTERVAL_MODE | XTTCPS_OPTION_WAVE_DISABLE },\r
  94         { tmrTIMER_1_FREQUENCY, 0, 0, XTTCPS_OPTION_INTERVAL_MODE | XTTCPS_OPTION_WAVE_DISABLE },\r
  95         { tmrTIMER_2_FREQUENCY, 0, 0, XTTCPS_OPTION_INTERVAL_MODE | XTTCPS_OPTION_WAVE_DISABLE }\r
  96 };\r
  97 \r
  98 /* Lower priority number means higher logical priority, so\r
  99 configMAX_API_CALL_INTERRUPT_PRIORITY - 1 is above the maximum system call\r
 100 interrupt priority. */\r
 101 static const UBaseType_t uxInterruptPriorities[ tmrTIMERS_USED ] =\r
 102 {\r
 103         configMAX_API_CALL_INTERRUPT_PRIORITY + 1,\r
 104         configMAX_API_CALL_INTERRUPT_PRIORITY,\r
 105         configMAX_API_CALL_INTERRUPT_PRIORITY - 1\r
 106 };\r
 107 \r
 108 static XTtcPs xTimerInstances[ tmrTIMERS_USED ];\r
 109 \r
 110 /* Used to provide a means of ensuring the intended interrupt nesting depth is\r
 111 actually being reached. */\r
 112 extern uint64_t ullPortInterruptNesting;\r
 113 static volatile uint32_t ulMaxRecordedNesting = 1;\r
 114 \r
 115 /* Used to ensure the high frequency timer is running at the expected\r
 116 frequency. */\r
 117 static volatile uint32_t ulHighFrequencyTimerCounts = 0;\r
 118 \r
 119 /*-----------------------------------------------------------*/\r
 120 \r
 121 void vInitialiseTimerForIntQueueTest( void )\r
 122 {\r
 123 BaseType_t xStatus;\r
 124 TmrCntrSetup *pxTimerSettings;\r
 125 extern XScuGic xInterruptController;\r
 126 BaseType_t xTimer;\r
 127 XTtcPs *pxTimerInstance;\r
 128 XTtcPs_Config *pxTimerConfiguration;\r
 129 const uint8_t ucRisingEdge = 3;\r
 130 \r
 131         /*_RB_ Currently only timer 1 and timer 2 are used. */\r
 132         for( xTimer = 0; xTimer < ( tmrTIMERS_USED - 1 ); xTimer++ )\r
 133         {\r
 134                 /* Look up the timer's configuration. */\r
 135                 pxTimerInstance = &( xTimerInstances[ xTimer ] );\r
 136                 pxTimerConfiguration = XTtcPs_LookupConfig( xDeviceIDs[ xTimer ] );\r
 137                 configASSERT( pxTimerConfiguration );\r
 138 \r
 139                 pxTimerSettings = &( xTimerSettings[ xTimer ] );\r
 140 \r
 141                 /* Initialise the device. */\r
 142                 xStatus = XTtcPs_CfgInitialize( pxTimerInstance, pxTimerConfiguration, pxTimerConfiguration->BaseAddress );\r
 143                 if( xStatus != XST_SUCCESS )\r
 144                 {\r
 145                         /* Not sure how to do this before XTtcPs_CfgInitialize is called\r
 146                         as pxTimerInstance is set within XTtcPs_CfgInitialize(). */\r
 147                         XTtcPs_Stop( pxTimerInstance );\r
 148                         xStatus = XTtcPs_CfgInitialize( pxTimerInstance, pxTimerConfiguration, pxTimerConfiguration->BaseAddress );\r
 149                         configASSERT( xStatus == XST_SUCCESS );\r
 150                 }\r
 151 \r
 152                 /* Set the options. */\r
 153                 XTtcPs_SetOptions( pxTimerInstance, pxTimerSettings->Options );\r
 154 \r
 155                 /* The timer frequency is preset in the pxTimerSettings structure.\r
 156                 Derive the values for the other structure members. */\r
 157                 XTtcPs_CalcIntervalFromFreq( pxTimerInstance, pxTimerSettings->OutputHz, &( pxTimerSettings->Interval ), &( pxTimerSettings->Prescaler ) );\r
 158 \r
 159                 /* Set the interval and prescale. */\r
 160                 XTtcPs_SetInterval( pxTimerInstance, pxTimerSettings->Interval );\r
 161                 XTtcPs_SetPrescaler( pxTimerInstance, pxTimerSettings->Prescaler );\r
 162 \r
 163                 /* The priority must be the lowest possible. */\r
 164                 XScuGic_SetPriorityTriggerType( &xInterruptController, xInterruptIDs[ xTimer ], uxInterruptPriorities[ xTimer ] << portPRIORITY_SHIFT, ucRisingEdge );\r
 165 \r
 166                 /* Connect to the interrupt controller. */\r
 167                 xStatus = XScuGic_Connect( &xInterruptController, xInterruptIDs[ xTimer ], ( Xil_InterruptHandler ) prvTimerHandler, ( void * ) pxTimerInstance );\r
 168                 configASSERT( xStatus == XST_SUCCESS);\r
 169 \r
 170                 /* Enable the interrupt in the GIC. */\r
 171                 XScuGic_Enable( &xInterruptController, xInterruptIDs[ xTimer ] );\r
 172 \r
 173                 /* Enable the interrupts in the timer. */\r
 174                 XTtcPs_EnableInterrupts( pxTimerInstance, XTTCPS_IXR_INTERVAL_MASK );\r
 175 \r
 176                 /* Start the timer. */\r
 177                 XTtcPs_Start( pxTimerInstance );\r
 178         }\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 static void prvTimerHandler( void *pvCallBackRef )\r
 183 {\r
 184 uint32_t ulInterruptStatus;\r
 185 XTtcPs *pxTimer = ( XTtcPs * ) pvCallBackRef;\r
 186 BaseType_t xYieldRequired;\r
 187 \r
 188         /* Read the interrupt status, then write it back to clear the interrupt. */\r
 189         ulInterruptStatus = XTtcPs_GetInterruptStatus( pxTimer );\r
 190         XTtcPs_ClearInterruptStatus( pxTimer, ulInterruptStatus );\r
 191         __asm volatile( "DSB SY" );\r
 192         __asm volatile( "ISB SY" );\r
 193 \r
 194 \r
 195         /* Now the interrupt has been cleared, interrupts can be re-enabled. */\r
 196         portENABLE_INTERRUPTS();\r
 197 \r
 198         /* Only one interrupt event type is expected. */\r
 199         configASSERT( ( XTTCPS_IXR_INTERVAL_MASK & ulInterruptStatus ) != 0 );\r
 200 \r
 201         /* Check the device ID to know which IntQueue demo to call. */\r
 202         if( pxTimer->Config.DeviceId == xDeviceIDs[ 0 ] )\r
 203         {\r
 204                 xYieldRequired = xFirstTimerHandler();\r
 205         }\r
 206         else if( pxTimer->Config.DeviceId == xDeviceIDs[ 1 ] )\r
 207         {\r
 208                 xYieldRequired = xSecondTimerHandler();\r
 209         }\r
 210         else\r
 211         {\r
 212                 /* Used to check the timer is running at the expected frequency. */\r
 213                 ulHighFrequencyTimerCounts++;\r
 214                 xYieldRequired = pdFALSE;\r
 215         }\r
 216 \r
 217         /* Latch the highest interrupt nesting count detected. */\r
 218         if( ullPortInterruptNesting > ulMaxRecordedNesting )\r
 219         {\r
 220                 ulMaxRecordedNesting = ullPortInterruptNesting;\r
 221         }\r
 222 \r
 223         /* If xYieldRequired is not pdFALSE then calling either xFirstTimerHandler()\r
 224         or xSecondTimerHandler() resulted in a task leaving the blocked state and\r
 225         the task that left the blocked state had a priority higher than the currently\r
 226         running task (the task this interrupt interrupted) - so a context switch\r
 227         should be performed so the interrupt returns directly to the higher priority\r
 228         task.  xYieldRequired is tested inside the following macro. */\r
 229         portYIELD_FROM_ISR( xYieldRequired );\r
 230 }\r
 231 \r