git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A53_64-bit_UltraScale_MPSoC/RTOSDemo_A53_bsp/psu_cortexa53_0/libsrc/standalone_v6_6/src/xil_assert.c

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