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 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/10 First Release
  45 * 3.00  kvn    02/13/15 Modified code for MISRA-C:2012 compliance.
  46 * </pre>
  47 *
  48 ******************************************************************************/
  49
  50 /***************************** Include Files *********************************/
  51
  52 #include "xstatus.h"
  53 #include "xuartps.h"
  54
  55 /************************** Constant Definitions *****************************/
  56
  57
  58 /**************************** Type Definitions *******************************/
  59
  60
  61 /***************** Macros (Inline Functions) Definitions *********************/
  62
  63 #define XUARTPS_TOTAL_BYTES (u8)32
  64
  65 /************************** Variable Definitions *****************************/
  66
  67 static u8 TestString[XUARTPS_TOTAL_BYTES]="abcdefghABCDEFGH012345677654321";
  68 static u8 ReturnString[XUARTPS_TOTAL_BYTES];
  69
  70 /************************** Function Prototypes ******************************/
  71
  72
  73 /****************************************************************************/
  74 /**
  75 *
  76 * This function runs a self-test on the driver and hardware device. This self
  77 * test performs a local loopback and verifies data can be sent and received.
  78 *
  79 * The time for this test is proportional to the baud rate that has been set
  80 * prior to calling this function.
  81 *
  82 * The mode and control registers are restored before return.
  83 *
  84 * @param        InstancePtr is a pointer to the XUartPs instance
  85 *
  86 * @return
  87 *                - XST_SUCCESS if the test was successful
  88 *               - XST_UART_TEST_FAIL if the test failed looping back the data
  89 *
  90 * @note
  91 *
  92 * This function can hang if the hardware is not functioning properly.
  93 *
  94 ******************************************************************************/
  95 s32 XUartPs_SelfTest(XUartPs *InstancePtr)
  96 {
  97         s32 Status = XST_SUCCESS;
  98         u32 IntrRegister;
  99         u32 ModeRegister;
 100         u8 Index;
 101         u32 ReceiveDataResult;
 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 & (u32)(~XUARTPS_MR_CHMODE_MASK)) |
 124                                 (u32)XUARTPS_MR_CHMODE_L_LOOP));
 125
 126         /*
 127          * Send a number of bytes and receive them, one at a time.
 128          */
 129         for (Index = 0U; 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                 (void)XUartPs_Send(InstancePtr, &TestString[Index], 1U);
 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                 ReceiveDataResult = Xil_In32((InstancePtr->Config.BaseAddress) + XUARTPS_SR_OFFSET) &
 141                                 XUARTPS_SR_RXEMPTY;
 142                 while (ReceiveDataResult == XUARTPS_SR_RXEMPTY ) {
 143                         ReceiveDataResult = Xil_In32((InstancePtr->Config.BaseAddress) + XUARTPS_SR_OFFSET) &
 144                                         XUARTPS_SR_RXEMPTY;
 145                 }
 146
 147                 /*
 148                  * Receive the byte
 149                  */
 150                 (void)XUartPs_Recv(InstancePtr, &ReturnString[Index], 1U);
 151         }
 152
 153         /*
 154          * Compare the bytes received to the bytes sent to verify the exact data
 155          * was received
 156          */
 157         for (Index = 0U; Index < XUARTPS_TOTAL_BYTES; Index++) {
 158                 if (TestString[Index] != ReturnString[Index]) {
 159                         Status = XST_UART_TEST_FAIL;
 160                 }
 161         }
 162
 163         /*
 164          * Restore the registers which were altered to put into polling and
 165          * loopback modes so that this test is not destructive
 166          */
 167         XUartPs_WriteReg(InstancePtr->Config.BaseAddress, XUARTPS_IER_OFFSET,
 168                            IntrRegister);
 169         XUartPs_WriteReg(InstancePtr->Config.BaseAddress, XUARTPS_MR_OFFSET,
 170                            ModeRegister);
 171
 172         return Status;
 173 }