git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo_bsp/ps7_cortexa9_0/libsrc/uartps_v2_1/src/xuartps_selftest.c

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