141 lines
5.0 KiB
C
141 lines
5.0 KiB
C
//*****************************************************************************
|
|
//
|
|
// am_hal_debug.h
|
|
//! @file
|
|
//!
|
|
//! @brief Useful macros for debugging.
|
|
//!
|
|
//! These functions and macros were created to assist with debugging. They are
|
|
//! intended to be as unintrusive as possible and designed to be removed from
|
|
//! the compilation of a project when they are no longer needed.
|
|
//!
|
|
//! @addtogroup haldebug3 HAL Debug/Assert Utilities
|
|
//! @ingroup apollo2hal
|
|
//! @{
|
|
//
|
|
//*****************************************************************************
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Copyright (c) 2020, Ambiq Micro
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// 1. Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
//
|
|
// 2. Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// 3. Neither the name of the copyright holder nor the names of its
|
|
// contributors may be used to endorse or promote products derived from this
|
|
// software without specific prior written permission.
|
|
//
|
|
// Third party software included in this distribution is subject to the
|
|
// additional license terms as defined in the /docs/licenses directory.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
// This is part of revision 2.4.2 of the AmbiqSuite Development Package.
|
|
//
|
|
//*****************************************************************************
|
|
#ifndef AM_HAL_DEBUG_H
|
|
#define AM_HAL_DEBUG_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Determine DBG_FILENAME
|
|
//
|
|
//*****************************************************************************
|
|
//
|
|
// By spec and convention, the standard __FILE__ compiler macro includes a full
|
|
// path (absolute or relative) to the file being compiled. This makes recreating
|
|
// binaries virtually impossible unless rebuilt on the same or identically
|
|
// configured system.
|
|
//
|
|
// To be able to build consistent binaries on different systems, we want to make
|
|
// sure the full pathname is not included in the binary. Only IAR EWARM provides
|
|
// an easy mechanism to provide only the filename without the path. For other
|
|
// platforms, we will simply use a generic pathname.
|
|
//
|
|
#if defined (__IAR_SYSTEMS_ICC__)
|
|
//
|
|
// With EWARM the --no_path_in_file_macros option reduces __FILE__ to only the
|
|
// module name. Therefore this define assumes the option is being used.
|
|
//
|
|
#define DBG_FILENAME __FILE__
|
|
#elif defined(__KEIL__)
|
|
//
|
|
// Keil provides __MODULE__ which is simply the module name portion of __FILE__.
|
|
//
|
|
#define DBG_FILENAME __MODULE__
|
|
#elif defined(__ARMCC_VERSION)
|
|
#define DBG_FILENAME __MODULE__
|
|
#else
|
|
//
|
|
// With GCC, we're out of luck.
|
|
//
|
|
#define DBG_FILENAME "debug_filename.ext"
|
|
//#define DBG_FILENAME __FILE__
|
|
#endif
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// Debug assert macros.
|
|
//
|
|
//*****************************************************************************
|
|
#ifndef AM_HAL_DEBUG_NO_ASSERT
|
|
|
|
#define am_hal_debug_assert_msg(bCondition, pcMessage) \
|
|
if ( !(bCondition)) am_hal_debug_error(DBG_FILENAME, __LINE__, pcMessage)
|
|
|
|
#define am_hal_debug_assert(bCondition) \
|
|
if ( !(bCondition)) am_hal_debug_error(DBG_FILENAME, __LINE__, 0)
|
|
|
|
#else
|
|
|
|
#define am_hal_debug_assert_msg(bCondition, pcMessage)
|
|
#define am_hal_debug_assert(bCondition)
|
|
|
|
#endif // AM_DEBUG_ASSERT
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// External function prototypes.
|
|
//
|
|
//*****************************************************************************
|
|
extern void am_hal_debug_error(const char *pcFile, uint32_t ui32Line,
|
|
const char *pcMessage);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // AM_HAL_DEBUG_H
|
|
|
|
//*****************************************************************************
|
|
//
|
|
// End Doxygen group.
|
|
//! @}
|
|
//
|
|
//*****************************************************************************
|