git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2009 - 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 xil_assert.c
  36 *
  37 * This file contains basic assert related functions for Xilinx software IP.
  38 *
  39 * <pre>
  40 * MODIFICATION HISTORY:
  41 *
  42 * Ver   Who    Date   Changes
  43 * ----- ---- -------- -------------------------------------------------------
  44 * 1.00a hbm  07/14/09 Initial release
  45 * </pre>
  46 *
  47 ******************************************************************************/
  48
  49 /***************************** Include Files *********************************/
  50
  51 #include "xil_types.h"
  52 #include "xil_assert.h"
  53
  54 /************************** Constant Definitions *****************************/
  55
  56 /**************************** Type Definitions *******************************/
  57
  58 /***************** Macros (Inline Functions) Definitions *********************/
  59
  60 /************************** Variable Definitions *****************************/
  61
  62 /**
  63  * This variable allows testing to be done easier with asserts. An assert
  64  * sets this variable such that a driver can evaluate this variable
  65  * to determine if an assert occurred.
  66  */
  67 unsigned int Xil_AssertStatus;
  68
  69 /**
  70  * This variable allows the assert functionality to be changed for testing
  71  * such that it does not wait infinitely. Use the debugger to disable the
  72  * waiting during testing of asserts.
  73  */
  74 int Xil_AssertWait = TRUE;
  75
  76 /* The callback function to be invoked when an assert is taken */
  77 static Xil_AssertCallback Xil_AssertCallbackRoutine = NULL;
  78
  79 /************************** Function Prototypes ******************************/
  80
  81 /*****************************************************************************/
  82 /**
  83 *
  84 * Implement assert. Currently, it calls a user-defined callback function
  85 * if one has been set.  Then, it potentially enters an infinite loop depending
  86 * on the value of the Xil_AssertWait variable.
  87 *
  88 * @param    file is the name of the filename of the source
  89 * @param    line is the linenumber within File
  90 *
  91 * @return   None.
  92 *
  93 * @note     None.
  94 *
  95 ******************************************************************************/
  96 void Xil_Assert(const char *File, int Line)
  97 {
  98         /* if the callback has been set then invoke it */
  99         if (Xil_AssertCallbackRoutine != 0) {
 100                 (*Xil_AssertCallbackRoutine)(File, Line);
 101         }
 102
 103         /* if specified, wait indefinitely such that the assert will show up
 104          * in testing
 105          */
 106         while (Xil_AssertWait) {
 107         }
 108 }
 109
 110 /*****************************************************************************/
 111 /**
 112 *
 113 * Set up a callback function to be invoked when an assert occurs. If there
 114 * was already a callback installed, then it is replaced.
 115 *
 116 * @param    routine is the callback to be invoked when an assert is taken
 117 *
 118 * @return   None.
 119 *
 120 * @note     This function has no effect if NDEBUG is set
 121 *
 122 ******************************************************************************/
 123 void Xil_AssertSetCallback(Xil_AssertCallback Routine)
 124 {
 125         Xil_AssertCallbackRoutine = Routine;
 126 }
 127
 128 /*****************************************************************************/
 129 /**
 130 *
 131 * Null handler function. This follows the XInterruptHandler signature for
 132 * interrupt handlers. It can be used to assign a null handler (a stub) to an
 133 * interrupt controller vector table.
 134 *
 135 * @param    NullParameter is an arbitrary void pointer and not used.
 136 *
 137 * @return   None.
 138 *
 139 * @note     None.
 140 *
 141 ******************************************************************************/
 142 void XNullHandler(void *NullParameter)
 143 {
 144  (void) NullParameter;
 145 }
 146