git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * (c) Copyright 2010-12 Xilinx, Inc. All rights reserved.
   4 *
   5 * This file contains confidential and proprietary information of Xilinx, Inc.
   6 * and is protected under U.S. and international copyright and other
   7 * intellectual property laws.
   8 *
   9 * DISCLAIMER
  10 * This disclaimer is not a license and does not grant any rights to the
  11 * materials distributed herewith. Except as otherwise provided in a valid
  12 * license issued to you by Xilinx, and to the maximum extent permitted by
  13 * applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND WITH ALL
  14 * FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS,
  15 * IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
  16 * MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE;
  17 * and (2) Xilinx shall not be liable (whether in contract or tort, including
  18 * negligence, or under any other theory of liability) for any loss or damage
  19 * of any kind or nature related to, arising under or in connection with these
  20 * materials, including for any direct, or any indirect, special, incidental,
  21 * or consequential loss or damage (including loss of data, profits, goodwill,
  22 * or any type of loss or damage suffered as a result of any action brought by
  23 * a third party) even if such damage or loss was reasonably foreseeable or
  24 * Xilinx had been advised of the possibility of the same.
  25 *
  26 * CRITICAL APPLICATIONS
  27 * Xilinx products are not designed or intended to be fail-safe, or for use in
  28 * any application requiring fail-safe performance, such as life-support or
  29 * safety devices or systems, Class III medical devices, nuclear facilities,
  30 * applications related to the deployment of airbags, or any other applications
  31 * that could lead to death, personal injury, or severe property or
  32 * environmental damage (individually and collectively, "Critical
  33 * Applications"). Customer assumes the sole risk and liability of any use of
  34 * Xilinx products in Critical Applications, subject only to applicable laws
  35 * and regulations governing limitations on product liability.
  36 *
  37 * THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE
  38 * AT ALL TIMES.
  39 *
  40 ******************************************************************************/
  41 /****************************************************************************/
  42 /**
  43 *
  44 * @file xscutimer_selftest.c
  45 *
  46 * Contains diagnostic self-test functions for the XScuTimer driver.
  47 *
  48 * <pre>
  49 * MODIFICATION HISTORY:
  50 *
  51 * Ver   Who Date     Changes
  52 * ----- --- -------- ---------------------------------------------
  53 * 1.00a nm  03/10/10 First release
  54 * </pre>
  55 *
  56 ******************************************************************************/
  57
  58 /***************************** Include Files *********************************/
  59
  60 #include "xscutimer.h"
  61
  62 /************************** Constant Definitions *****************************/
  63
  64 #define XSCUTIMER_SELFTEST_VALUE        0xA55AF00F
  65
  66 /**************************** Type Definitions *******************************/
  67
  68 /***************** Macros (Inline Functions) Definitions *********************/
  69
  70 /************************** Function Prototypes ******************************/
  71
  72 /************************** Variable Definitions *****************************/
  73
  74 /****************************************************************************/
  75 /**
  76 *
  77 * Run a self-test on the timer. This test clears the timer enable bit in
  78 * the control register, writes to the timer load register and verifies the
  79 * value read back matches the value written and restores the control register
  80 * and the timer load register.
  81 *
  82 * @param        InstancePtr is a pointer to the XScuTimer instance.
  83 *
  84 * @return
  85 *               - XST_SUCCESS if self-test was successful.
  86 *               - XST_FAILURE if self test was not successful.
  87 *
  88 * @note         None.
  89 *
  90 ******************************************************************************/
  91 int XScuTimer_SelfTest(XScuTimer *InstancePtr)
  92 {
  93         u32 Register;
  94         u32 CtrlOrig;
  95         u32 LoadOrig;
  96
  97         /*
  98          * Assert to ensure the inputs are valid and the instance has been
  99          * initialized.
 100          */
 101         Xil_AssertNonvoid(InstancePtr != NULL);
 102         Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
 103
 104         /*
 105          * Save the contents of the Control Register and stop the timer.
 106          */
 107         CtrlOrig = XScuTimer_ReadReg(InstancePtr->Config.BaseAddr,
 108                                   XSCUTIMER_CONTROL_OFFSET);
 109         Register = CtrlOrig & ~XSCUTIMER_CONTROL_ENABLE_MASK;
 110         XScuTimer_WriteReg(InstancePtr->Config.BaseAddr,
 111                         XSCUTIMER_CONTROL_OFFSET, Register);
 112
 113         /*
 114          * Save the contents of the Load Register.
 115          * Load a new test value in the Load Register, read it back and
 116          * compare it with the written value.
 117          */
 118         LoadOrig = XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr,
 119                                   XSCUTIMER_LOAD_OFFSET);
 120         XScuTimer_LoadTimer(InstancePtr, XSCUTIMER_SELFTEST_VALUE);
 121         Register = XScuTimer_ReadReg((InstancePtr)->Config.BaseAddr,
 122                                   XSCUTIMER_LOAD_OFFSET);
 123
 124         /*
 125          * Restore the contents of the Load Register and Control Register.
 126          */
 127         XScuTimer_LoadTimer(InstancePtr, LoadOrig);
 128         XScuTimer_WriteReg(InstancePtr->Config.BaseAddr,
 129                         XSCUTIMER_CONTROL_OFFSET, CtrlOrig);
 130
 131         /*
 132          * Return a Failure if the contents of the Load Register do not
 133          * match with the value written to it.
 134          */
 135         if (Register != XSCUTIMER_SELFTEST_VALUE) {
 136                 return XST_FAILURE;
 137         }
 138
 139         return XST_SUCCESS;
 140 }