git.sur5r.net Git - freertos/blob

   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 xcanps_selftest.c
  36 *
  37 * This file contains a diagnostic self-test function for the XCanPs driver.
  38 *
  39 * Read xcanps.h file for more information.
  40 *
  41 * @note
  42 * The  Baud Rate Prescaler Register (BRPR) and Bit Timing Register(BTR)
  43 * are setup such that CAN baud rate equals 40Kbps, given the CAN clock
  44 * equal to 24MHz. These need to be changed based on the desired baudrate
  45 * and CAN clock frequency.
  46 *
  47 * <pre>
  48 * MODIFICATION HISTORY:
  49 *
  50 * Ver   Who    Date     Changes
  51 * ----- -----  -------- -----------------------------------------------
  52 * 1.00a xd/sv  01/12/10 First release
  53 * </pre>
  54 *
  55 *****************************************************************************/
  56
  57 /***************************** Include Files ********************************/
  58
  59 #include "xstatus.h"
  60 #include "xcanps.h"
  61
  62 /************************** Constant Definitions ****************************/
  63
  64 #define XCANPS_MAX_FRAME_SIZE_IN_WORDS (XCANPS_MAX_FRAME_SIZE / sizeof(u32))
  65
  66 #define FRAME_DATA_LENGTH       8 /* Frame Data field length */
  67
  68 /**************************** Type Definitions ******************************/
  69
  70 /***************** Macros (Inline Functions) Definitions ********************/
  71
  72 /************************** Variable Definitions ****************************/
  73
  74 /*
  75  * Buffers to hold frames to send and receive. These are declared as global so
  76  * that they are not on the stack.
  77  */
  78 static u32 TxFrame[XCANPS_MAX_FRAME_SIZE_IN_WORDS];
  79 static u32 RxFrame[XCANPS_MAX_FRAME_SIZE_IN_WORDS];
  80
  81 /************************** Function Prototypes *****************************/
  82
  83 /*****************************************************************************/
  84 /**
  85 *
  86 * This function runs a self-test on the CAN driver/device. The test resets
  87 * the device, sets up the Loop Back mode, sends a standard frame, receives the
  88 * frame, verifies the contents, and resets the device again.
  89 *
  90 * Note that this is a destructive test in that resets of the device are
  91 * performed. Refer the device specification for the device status after
  92 * the reset operation.
  93 *
  94 *
  95 * @param        InstancePtr is a pointer to the XCanPs instance.
  96 *
  97 * @return
  98 *               - XST_SUCCESS if the self-test passed. i.e., the frame
  99 *                 received via the internal loop back has the same contents as
 100 *                 the frame sent.
 101 *               - XST_FAILURE   Otherwise.
 102 *
 103 * @note
 104 *
 105 * If the CAN device does not work properly, this function may enter an
 106 * infinite loop and will never return to the caller.
 107 * <br><br>
 108 * If XST_FAILURE is returned, the device is not reset so that the caller could
 109 * have a chance to check reason(s) causing the failure.
 110 *
 111 ******************************************************************************/
 112 int XCanPs_SelfTest(XCanPs *InstancePtr)
 113 {
 114         u8 *FramePtr;
 115         u32 Status;
 116         u32 Index;
 117
 118         Xil_AssertNonvoid(InstancePtr != NULL);
 119         Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
 120
 121         XCanPs_Reset(InstancePtr);
 122
 123         /*
 124          * The device should enter Configuration Mode immediately after
 125          * reset above is finished. Now check the mode and return error code if
 126          * it is not Configuration Mode.
 127          */
 128         if (XCanPs_GetMode(InstancePtr) != XCANPS_MODE_CONFIG) {
 129                 return XST_FAILURE;
 130         }
 131
 132         /*
 133          * Setup Baud Rate Prescaler Register (BRPR) and Bit Timing Register
 134          * (BTR) such that CAN baud rate equals 40Kbps, given the CAN clock
 135          * equal to 24MHz. For more information see the CAN 2.0A, CAN 2.0B,
 136          * ISO 11898-1 specifications.
 137          */
 138         XCanPs_SetBaudRatePrescaler(InstancePtr, 1);
 139         XCanPs_SetBitTiming(InstancePtr, 1, 3, 8);
 140
 141         /*
 142          * Enter the loop back mode.
 143          */
 144         XCanPs_EnterMode(InstancePtr, XCANPS_MODE_LOOPBACK);
 145         while (XCanPs_GetMode(InstancePtr) != XCANPS_MODE_LOOPBACK);
 146
 147         /*
 148          * Create a frame to send with known values so we can verify them
 149          * on receive.
 150          */
 151         TxFrame[0] = (u32)XCanPs_CreateIdValue((u32)2000, 0, 0, 0, 0);
 152         TxFrame[1] = (u32)XCanPs_CreateDlcValue((u32)8);
 153
 154         FramePtr = (u8 *) (&TxFrame[2]);
 155         for (Index = 0; Index < 8; Index++) {
 156                 *FramePtr++ = (u8) Index;
 157         }
 158
 159         /*
 160          * Send the frame.
 161          */
 162         Status = XCanPs_Send(InstancePtr, TxFrame);
 163         if (Status != XST_SUCCESS) {
 164                 return XST_FAILURE;
 165         }
 166
 167         /*
 168          * Wait until the frame arrives RX FIFO via internal loop back.
 169          */
 170         while (XCanPs_IsRxEmpty(InstancePtr) == TRUE);
 171
 172         /*
 173          * Receive the frame.
 174          */
 175         Status = XCanPs_Recv(InstancePtr, RxFrame);
 176         if (Status != XST_SUCCESS) {
 177                 return XST_FAILURE;
 178         }
 179
 180         /*
 181          * Verify Identifier and Data Length Code.
 182          */
 183         if (RxFrame[0] !=
 184                 (u32)XCanPs_CreateIdValue((u32)2000, 0, 0, 0, 0)) {
 185                 return XST_FAILURE;
 186         }
 187
 188         if ((RxFrame[1] & ~XCANPS_DLCR_TIMESTAMP_MASK) != TxFrame[1]) {
 189                 return XST_FAILURE;
 190         }
 191
 192
 193         for (Index = 2; Index < XCANPS_MAX_FRAME_SIZE_IN_WORDS; Index++) {
 194                 if (RxFrame[Index] != TxFrame[Index]) {
 195                         return XST_FAILURE;
 196                 }
 197         }
 198
 199         /*
 200          * Reset device again before returning to the caller.
 201          */
 202         XCanPs_Reset(InstancePtr);
 203
 204         return XST_SUCCESS;
 205 }
 206
 207