git.sur5r.net Git - freertos/blob

   1 /*****************************************************************************
   2 *
   3 * (c) Copyright 2010-13 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 xuartps_selftest.c
  45 *
  46 * This file contains the self-test functions for the XUartPs driver.
  47 *
  48 * <pre>
  49 * MODIFICATION HISTORY:
  50 *
  51 * Ver   Who    Date     Changes
  52 * ----- ------ -------- -----------------------------------------------
  53 * 1.00  drg/jz 01/13/108First Release
  54 * </pre>
  55 *
  56 ******************************************************************************/
  57
  58 /***************************** Include Files *********************************/
  59
  60 #include "xstatus.h"
  61 #include "xuartps.h"
  62
  63 /************************** Constant Definitions *****************************/
  64
  65
  66 /**************************** Type Definitions *******************************/
  67
  68
  69 /***************** Macros (Inline Functions) Definitions *********************/
  70
  71 #define XUARTPS_TOTAL_BYTES 32
  72
  73 /************************** Variable Definitions *****************************/
  74
  75 static u8 TestString[XUARTPS_TOTAL_BYTES]="abcdefghABCDEFGH012345677654321";
  76 static u8 ReturnString[XUARTPS_TOTAL_BYTES];
  77
  78 /************************** Function Prototypes ******************************/
  79
  80
  81 /****************************************************************************/
  82 /**
  83 *
  84 * This function runs a self-test on the driver and hardware device. This self
  85 * test performs a local loopback and verifies data can be sent and received.
  86 *
  87 * The time for this test is proportional to the baud rate that has been set
  88 * prior to calling this function.
  89 *
  90 * The mode and control registers are restored before return.
  91 *
  92 * @param        InstancePtr is a pointer to the XUartPs instance
  93 *
  94 * @return
  95 *                - XST_SUCCESS if the test was successful
  96 *               - XST_UART_TEST_FAIL if the test failed looping back the data
  97 *
  98 * @note
  99 *
 100 * This function can hang if the hardware is not functioning properly.
 101 *
 102 ******************************************************************************/
 103 int XUartPs_SelfTest(XUartPs *InstancePtr)
 104 {
 105         int Status = XST_SUCCESS;
 106         u32 IntrRegister;
 107         u32 ModeRegister;
 108         u8 Index;
 109
 110         /*
 111          * Assert validates the input arguments
 112          */
 113         Xil_AssertNonvoid(InstancePtr != NULL);
 114         Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
 115
 116         /*
 117          * Disable all interrupts in the interrupt disable register
 118          */
 119         IntrRegister = XUartPs_ReadReg(InstancePtr->Config.BaseAddress,
 120                                    XUARTPS_IMR_OFFSET);
 121         XUartPs_WriteReg(InstancePtr->Config.BaseAddress, XUARTPS_IDR_OFFSET,
 122                 XUARTPS_IXR_MASK);
 123
 124         /*
 125          * Setup for local loopback
 126          */
 127         ModeRegister = XUartPs_ReadReg(InstancePtr->Config.BaseAddress,
 128                                    XUARTPS_MR_OFFSET);
 129         XUartPs_WriteReg(InstancePtr->Config.BaseAddress, XUARTPS_MR_OFFSET,
 130                            ((ModeRegister & (~XUARTPS_MR_CHMODE_MASK)) |
 131                                 XUARTPS_MR_CHMODE_L_LOOP));
 132
 133         /*
 134          * Send a number of bytes and receive them, one at a time.
 135          */
 136         for (Index = 0; Index < XUARTPS_TOTAL_BYTES; Index++) {
 137                 /*
 138                  * Send out the byte and if it was not sent then the failure
 139                  * will be caught in the comparison at the end
 140                  */
 141                 XUartPs_Send(InstancePtr, &TestString[Index], 1);
 142
 143                 /*
 144                  * Wait until the byte is received. This can hang if the HW
 145                  * is broken. Watch for the FIFO empty flag to be false.
 146                  */
 147                 while (!(XUartPs_IsReceiveData(InstancePtr->Config.
 148                                                 BaseAddress)));
 149
 150                 /*
 151                  * Receive the byte
 152                  */
 153                 XUartPs_Recv(InstancePtr, &ReturnString[Index], 1);
 154         }
 155
 156         /*
 157          * Compare the bytes received to the bytes sent to verify the exact data
 158          * was received
 159          */
 160         for (Index = 0; Index < XUARTPS_TOTAL_BYTES; Index++) {
 161                 if (TestString[Index] != ReturnString[Index]) {
 162                         Status = XST_UART_TEST_FAIL;
 163                 }
 164         }
 165
 166         /*
 167          * Restore the registers which were altered to put into polling and
 168          * loopback modes so that this test is not destructive
 169          */
 170         XUartPs_WriteReg(InstancePtr->Config.BaseAddress, XUARTPS_IER_OFFSET,
 171                            IntrRegister);
 172         XUartPs_WriteReg(InstancePtr->Config.BaseAddress, XUARTPS_MR_OFFSET,
 173                            ModeRegister);
 174
 175         return Status;
 176 }