git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_R5_UltraScale_MPSoC/RTOSDemo_R5_bsp/psu_cortexr5_0/libsrc/uartps_v3_6/src/xuartps_selftest.c

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