app_error_weak.h 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. /**
  2. * Copyright (c) 2016 - 2019, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef APP_ERROR_WEAK_H__
  41. #define APP_ERROR_WEAK_H__
  42. #include <stdint.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /** @file
  47. *
  48. * @defgroup app_error Common application error handler
  49. * @{
  50. * @ingroup app_common
  51. *
  52. * @brief Common application error handler.
  53. */
  54. /**@brief Callback function for errors, asserts, and faults.
  55. *
  56. * @details This function is called every time an error is raised in app_error, nrf_assert, or
  57. * in the SoftDevice. Information about the error can be found in the @p info
  58. * parameter.
  59. *
  60. * See also @ref nrf_fault_handler_t for more details.
  61. *
  62. * @note The function is implemented as weak so that it can be redefined by a custom error
  63. * handler when needed.
  64. *
  65. * @param[in] id Fault identifier. See @ref NRF_FAULT_IDS.
  66. * @param[in] pc The program counter of the instruction that triggered the fault, or 0 if
  67. * unavailable.
  68. * @param[in] info Optional additional information regarding the fault. The value of the @p id
  69. * parameter dictates how to interpret this parameter. Refer to the documentation
  70. * for each fault identifier (@ref NRF_FAULT_IDS and @ref APP_ERROR_FAULT_IDS) for
  71. * details about interpreting @p info.
  72. */
  73. void app_error_fault_handler(uint32_t id, uint32_t pc, uint32_t info);
  74. /** @} */
  75. #ifdef __cplusplus
  76. }
  77. #endif
  78. #endif // APP_ERROR_WEAK_H__