git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2010 - 2014 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 *
  35 * @file xscutimer_selftest.c
  36 * @addtogroup scutimer_v2_0
  37 * @{
  38 *
  39 * Contains diagnostic self-test functions for the XScuTimer driver.
  40 *
  41 * <pre>
  42 * MODIFICATION HISTORY:
  43 *
  44 * Ver   Who Date     Changes
  45 * ----- --- -------- ---------------------------------------------
  46 * 1.00a nm  03/10/10 First release
  47 * </pre>
  48 *
  49 ******************************************************************************/
  50
  51 /***************************** Include Files *********************************/
  52
  53 #include "xscutimer.h"
  54
  55 /************************** Constant Definitions *****************************/
  56
  57 #define XSCUTIMER_SELFTEST_VALUE        0xA55AF00F
  58
  59 /**************************** Type Definitions *******************************/
  60
  61 /***************** Macros (Inline Functions) Definitions *********************/
  62
  63 /************************** Function Prototypes ******************************/
  64
  65 /************************** Variable Definitions *****************************/
  66
  67 /****************************************************************************/
  68 /**
  69 *
  70 * Run a self-test on the timer. This test clears the timer enable bit in
  71 * the control register, writes to the timer load register and verifies the
  72 * value read back matches the value written and restores the control register
  73 * and the timer load register.
  74 *
  75 * @param        InstancePtr is a pointer to the XScuTimer instance.
  76 *
  77 * @return
  78 *               - XST_SUCCESS if self-test was successful.
  79 *               - XST_FAILURE if self test was not successful.
  80 *
  81 * @note         None.
  82 *
  83 ******************************************************************************/
  84 int XScuTimer_SelfTest(XScuTimer *InstancePtr)
  85 {
  86         u32 Register;
  87         u32 CtrlOrig;
  88         u32 LoadOrig;
  89
  90         /*
  91          * Assert to ensure the inputs are valid and the instance has been
  92          * initialized.
  93          */
  94         Xil_AssertNonvoid(InstancePtr != NULL);
  95         Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
  96
  97         /*
  98          * Save the contents of the Control Register and stop the timer.
  99          */
 100         CtrlOrig = XScuTimer_ReadReg(InstancePtr->Config.BaseAddr,
 101                                   XSCUTIMER_CONTROL_OFFSET);
 102         Register = CtrlOrig & ~XSCUTIMER_CONTROL_ENABLE_MASK;
 103         XScuTimer_WriteReg(InstancePtr->Config.BaseAddr,
 104                         XSCUTIMER_CONTROL_OFFSET, Register);
 105
 106         /*
 107          * Save the contents of the Load Register.
 108          * Load a new test value in the Load Register, read it back and
 109          * compare it with the written value.
 110          */
 111         LoadOrig = XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr,
 112                                   XSCUTIMER_LOAD_OFFSET);
 113         XScuTimer_LoadTimer(InstancePtr, XSCUTIMER_SELFTEST_VALUE);
 114         Register = XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr,
 115                                   XSCUTIMER_LOAD_OFFSET);
 116
 117         /*
 118          * Restore the contents of the Load Register and Control Register.
 119          */
 120         XScuTimer_LoadTimer(InstancePtr, LoadOrig);
 121         XScuTimer_WriteReg(InstancePtr->Config.BaseAddr,
 122                         XSCUTIMER_CONTROL_OFFSET, CtrlOrig);
 123
 124         /*
 125          * Return a Failure if the contents of the Load Register do not
 126          * match with the value written to it.
 127          */
 128         if (Register != XSCUTIMER_SELFTEST_VALUE) {
 129                 return XST_FAILURE;
 130         }
 131
 132         return XST_SUCCESS;
 133 }
 134 /** @} */