git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_R5_UltraScale_MPSoC/RTOSDemo_R5_bsp/psu_cortexr5_0/libsrc/standalone_v6_6/src/xtime_l.h

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2014 - 2017 Xilinx, Inc. All rights reserved.
   4 *
   5 * Permission is hereby granted, free of charge, to any person obtaining a copy
   6 * of this software and associated documentation files (the "Software"), to deal
   7 * in the Software without restriction, including without limitation the rights
   8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 * copies of the Software, and to permit persons to whom the Software is
  10 * furnished to do so, subject to the following conditions:
  11 *
  12 * The above copyright notice and this permission notice shall be included in
  13 * all copies or substantial portions of the Software.
  14 *
  15 * Use of the Software is limited solely to applications:
  16 * (a) running on a Xilinx device, or
  17 * (b) that interact with a Xilinx device through a bus or interconnect.
  18 *
  19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  22 * XILINX  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  24 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25 * SOFTWARE.
  26 *
  27 * Except as contained in this notice, the name of the Xilinx shall not be used
  28 * in advertising or otherwise to promote the sale, use or other dealings in
  29 * this Software without prior written authorization from Xilinx.
  30 *
  31 ******************************************************************************/
  32 /*****************************************************************************/
  33 /**
  34 * @file xtime_l.h
  35 *
  36 * @addtogroup r5_time_apis Cortex R5 Time Functions
  37 * The xtime_l.h provides access to 32-bit TTC timer counter. These functions
  38 * can be used by applications to track the time.
  39 *
  40 * @{
  41 * <pre>
  42 * MODIFICATION HISTORY:
  43 *
  44 * Ver   Who    Date     Changes
  45 * ----- ------ -------- ---------------------------------------------------
  46 * 5.00  pkp        05/29/14 First release
  47 * 5.04  pkp        02/19/16 Added timer configuration register offset definitions
  48 * 5.04  pkp        03/11/16 Removed definitions for overflow interrupt register
  49 *                                               and mask
  50 * 6.6   srm    10/22/17 Added a warning message for the user configurable sleep
  51 *                       implementation when default timer is selected by the user
  52 * </pre>
  53 *
  54 ******************************************************************************/
  55
  56 #ifndef XTIME_H /* prevent circular inclusions */
  57 #define XTIME_H /* by using protection macros */
  58
  59 #ifdef __cplusplus
  60 extern "C" {
  61 #endif
  62
  63 /***************************** Include Files *********************************/
  64 #include "xil_types.h"
  65 #include "xparameters.h"
  66 /***************** Macros (Inline Functions) Definitions *********************/
  67
  68 /************************** Constant Definitions *****************************/
  69
  70 #ifdef SLEEP_TIMER_BASEADDR
  71
  72 #define COUNTS_PER_SECOND                               SLEEP_TIMER_FREQUENCY
  73 #define COUNTS_PER_USECOND                              COUNTS_PER_SECOND/1000000
  74
  75 #else
  76 #define ITERS_PER_SEC  (XPAR_CPU_CORTEXR5_0_CPU_CLK_FREQ_HZ / 4)
  77 #define ITERS_PER_USEC  (XPAR_CPU_CORTEXR5_0_CPU_CLK_FREQ_HZ / 4000000)
  78 #define IRQ_FIQ_MASK    0xC0    /* Mask IRQ and FIQ interrupts in cpsr */
  79 #endif
  80
  81 #if defined (XSLEEP_TIMER_IS_DEFAULT_TIMER)
  82 #pragma message ("For the sleep routines, TTC3 is used if present else the assembly instructions are called")
  83 #endif
  84
  85 /**************************** Type Definitions *******************************/
  86
  87 /* The following definitions are applicable only when TTC3 is present*/
  88 #ifdef SLEEP_TIMER_BASEADDR
  89 typedef u32 XTime;
  90
  91 void XTime_SetTime(XTime Xtime_Global);
  92 void XTime_GetTime(XTime *Xtime_Global);
  93 #endif
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif /* __cplusplus */
  98
  99 #endif /* XTIME_H */
 100 /**
 101 * @} End of "@addtogroup r5_time_apis".
 102 */