git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * (c) Copyright 2011-2013 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 xadcps_selftest.c
  45 *
  46 * This file contains a diagnostic self test function for the XAdcPs driver.
  47 * The self test function does a simple read/write test of the Alarm Threshold
  48 * Register.
  49 *
  50 * See xadcps.h for more information.
  51 *
  52 * @note None.
  53 *
  54 * <pre>
  55 *
  56 * MODIFICATION HISTORY:
  57 *
  58 * Ver   Who    Date     Changes
  59 * ----- -----  -------- -----------------------------------------------------
  60 * 1.00a ssb    12/22/11 First release based on the XPS/AXI xadc driver
  61 *
  62 * </pre>
  63 *
  64 *****************************************************************************/
  65
  66 /***************************** Include Files ********************************/
  67
  68 #include "xadcps.h"
  69
  70 /************************** Constant Definitions ****************************/
  71
  72 /*
  73  * The following constant defines the test value to be written
  74  * to the Alarm Threshold Register
  75  */
  76 #define XADCPS_ATR_TEST_VALUE           0x55
  77
  78 /**************************** Type Definitions ******************************/
  79
  80 /***************** Macros (Inline Functions) Definitions ********************/
  81
  82 /************************** Variable Definitions ****************************/
  83
  84 /************************** Function Prototypes *****************************/
  85
  86 /*****************************************************************************/
  87 /**
  88 *
  89 * Run a self-test on the driver/device. The test
  90 *       - Resets the device,
  91 *       - Writes a value into the Alarm Threshold register and reads it back
  92 *       for comparison.
  93 *       - Resets the device again.
  94 *
  95 *
  96 * @param        InstancePtr is a pointer to the XAdcPs instance.
  97 *
  98 * @return
  99 *               - XST_SUCCESS if the value read from the Alarm Threshold
 100 *               register is the same as the value written.
 101 *               - XST_FAILURE Otherwise
 102 *
 103 * @note         This is a destructive test in that resets of the device are
 104 *               performed. Refer to the device specification for the
 105 *               device status after the reset operation.
 106 *
 107 ******************************************************************************/
 108 int XAdcPs_SelfTest(XAdcPs *InstancePtr)
 109 {
 110         int Status;
 111         u32 RegValue;
 112
 113         /*
 114          * Assert the argument
 115          */
 116         Xil_AssertNonvoid(InstancePtr != NULL);
 117         Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
 118
 119
 120         /*
 121          * Reset the device to get it back to its default state
 122          */
 123         XAdcPs_Reset(InstancePtr);
 124
 125         /*
 126          * Write a value into the Alarm Threshold registers, read it back, and
 127          * do the comparison
 128          */
 129         XAdcPs_SetAlarmThreshold(InstancePtr, XADCPS_ATR_VCCINT_UPPER,
 130                                   XADCPS_ATR_TEST_VALUE);
 131         RegValue = XAdcPs_GetAlarmThreshold(InstancePtr, XADCPS_ATR_VCCINT_UPPER);
 132
 133         if (RegValue == XADCPS_ATR_TEST_VALUE) {
 134                 Status = XST_SUCCESS;
 135         } else {
 136                 Status = XST_FAILURE;
 137         }
 138
 139         /*
 140          * Reset the device again to its default state.
 141          */
 142         XAdcPs_Reset(InstancePtr);
 143         /*
 144          * Return the test result.
 145          */
 146         return Status;
 147 }