1
0

am_hal_debug.h 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. //*****************************************************************************
  2. //
  3. // am_hal_debug.h
  4. //! @file
  5. //!
  6. //! @brief Useful macros for debugging.
  7. //!
  8. //! These functions and macros were created to assist with debugging. They are
  9. //! intended to be as unintrusive as possible and designed to be removed from
  10. //! the compilation of a project when they are no longer needed.
  11. //
  12. //*****************************************************************************
  13. //*****************************************************************************
  14. //
  15. // Copyright (c) 2017, Ambiq Micro
  16. // All rights reserved.
  17. //
  18. // Redistribution and use in source and binary forms, with or without
  19. // modification, are permitted provided that the following conditions are met:
  20. //
  21. // 1. Redistributions of source code must retain the above copyright notice,
  22. // this list of conditions and the following disclaimer.
  23. //
  24. // 2. Redistributions in binary form must reproduce the above copyright
  25. // notice, this list of conditions and the following disclaimer in the
  26. // documentation and/or other materials provided with the distribution.
  27. //
  28. // 3. Neither the name of the copyright holder nor the names of its
  29. // contributors may be used to endorse or promote products derived from this
  30. // software without specific prior written permission.
  31. //
  32. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  33. // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  34. // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  35. // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  36. // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  37. // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  38. // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  39. // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  40. // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  41. // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42. // POSSIBILITY OF SUCH DAMAGE.
  43. //
  44. // This is part of revision 1.2.11 of the AmbiqSuite Development Package.
  45. //
  46. //*****************************************************************************
  47. #ifndef AM_HAL_DEBUG_H
  48. #define AM_HAL_DEBUG_H
  49. //*****************************************************************************
  50. //
  51. // Debug assert macros.
  52. //
  53. //*****************************************************************************
  54. #ifndef AM_HAL_DEBUG_NO_ASSERT
  55. #define am_hal_debug_assert_msg(bCondition, pcMessage) \
  56. if ( !(bCondition)) am_hal_debug_error(__FILE__, __LINE__, pcMessage)
  57. #define am_hal_debug_assert(bCondition) \
  58. if ( !(bCondition)) am_hal_debug_error(__FILE__, __LINE__, 0)
  59. #else
  60. #define am_hal_debug_assert_msg(bCondition, pcMessage)
  61. #define am_hal_debug_assert(bCondition)
  62. #endif // AM_DEBUG_ASSERT
  63. #ifdef __cplusplus
  64. extern "C"
  65. {
  66. #endif
  67. //*****************************************************************************
  68. //
  69. // External function prototypes.
  70. //
  71. //*****************************************************************************
  72. extern void am_hal_debug_error(const char *pcFile, uint32_t ui32Line,
  73. const char *pcMessage);
  74. #ifdef __cplusplus
  75. }
  76. #endif
  77. #endif // AM_HAL_DEBUG_H