git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2010 - 2015 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 xspips_selftest.c
  36 *
  37 * This component contains the implementation of selftest functions for an SPI
  38 * device.
  39 *
  40 * <pre>
  41 * MODIFICATION HISTORY:
  42 *
  43 * Ver   Who    Date     Changes
  44 * ----- ------ -------- ----------------------------------------------
  45 * 1.00  drg/jz 01/25/10 First release
  46 * 1.04a sg     01/30/13 SetDelays test includes DelayTestNss parameter.
  47 * 3.00  kvn    02/13/15 Modified code for MISRA-C:2012 compliance.
  48 *
  49 * </pre>
  50 *
  51 ******************************************************************************/
  52
  53 /***************************** Include Files *********************************/
  54
  55 #include "xspips.h"
  56
  57 /************************** Constant Definitions *****************************/
  58
  59
  60 /**************************** Type Definitions *******************************/
  61
  62
  63 /***************** Macros (Inline Functions) Definitions *********************/
  64
  65
  66 /************************** Function Prototypes ******************************/
  67
  68
  69 /************************** Variable Definitions *****************************/
  70
  71
  72 /*****************************************************************************/
  73 /**
  74 *
  75 * Runs a self-test on the driver/device. The self-test is destructive in that
  76 * a reset of the device is performed in order to check the reset values of
  77 * the registers and to get the device into a known state.
  78 *
  79 * Upon successful return from the self-test, the device is reset.
  80 *
  81 * @param        InstancePtr is a pointer to the XSpiPs instance.
  82 *
  83 * @return
  84 *               - XST_SUCCESS if successful
  85 *               - XST_REGISTER_ERROR indicates a register did not read or write
  86 *               correctly.
  87 *
  88 * @note         None.
  89 *
  90 ******************************************************************************/
  91 s32 XSpiPs_SelfTest(XSpiPs *InstancePtr)
  92 {
  93         s32 Status;
  94         u32 Register;
  95         u8 DelayTestNss;
  96         u8 DelayTestBtwn;
  97         u8 DelayTestAfter;
  98         u8 DelayTestInit;
  99
 100         Xil_AssertNonvoid(InstancePtr != NULL);
 101         Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
 102
 103         /*
 104          * Reset the SPI device to leave it in a known good state
 105          */
 106         XSpiPs_Reset(InstancePtr);
 107
 108         /*
 109          * All the SPI registers should be in their default state right now.
 110          */
 111         Register = XSpiPs_ReadReg(InstancePtr->Config.BaseAddress,
 112                                  XSPIPS_CR_OFFSET);
 113         if (Register != XSPIPS_CR_RESET_STATE) {
 114                 return (s32)XST_REGISTER_ERROR;
 115         }
 116
 117         Register = XSpiPs_ReadReg(InstancePtr->Config.BaseAddress,
 118                                  XSPIPS_SR_OFFSET);
 119         if (Register != XSPIPS_ISR_RESET_STATE) {
 120                 return (s32)XST_REGISTER_ERROR;
 121         }
 122
 123         DelayTestNss = 0x5AU;
 124         DelayTestBtwn = 0xA5U;
 125         DelayTestAfter = 0xAAU;
 126         DelayTestInit = 0x55U;
 127
 128         /*
 129          * Write and read the delay register, just to be sure there is some
 130          * hardware out there.
 131          */
 132         Status = XSpiPs_SetDelays(InstancePtr, DelayTestNss, DelayTestBtwn,
 133                                    DelayTestAfter, DelayTestInit);
 134         if (Status != (s32)XST_SUCCESS) {
 135                 return Status;
 136         }
 137
 138         XSpiPs_GetDelays(InstancePtr, &DelayTestNss, &DelayTestBtwn,
 139                         &DelayTestAfter, &DelayTestInit);
 140         if ((0x5AU != DelayTestNss) || (0xA5U != DelayTestBtwn) ||
 141                 (0xAAU != DelayTestAfter) || (0x55U != DelayTestInit)) {
 142                 return (s32)XST_REGISTER_ERROR;
 143         }
 144
 145         Status = XSpiPs_SetDelays(InstancePtr, 0U, 0U, 0U, 0U);
 146         if (Status != (s32)XST_SUCCESS) {
 147                 return Status;
 148         }
 149
 150         /*
 151          * Reset the SPI device to leave it in a known good state
 152          */
 153         XSpiPs_Reset(InstancePtr);
 154
 155         return (s32)XST_SUCCESS;
 156 }