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