aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/stack_info/nrf_stack_info.h
diff options
context:
space:
mode:
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/stack_info/nrf_stack_info.h')
-rw-r--r--thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/stack_info/nrf_stack_info.h163
1 files changed, 163 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/stack_info/nrf_stack_info.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/stack_info/nrf_stack_info.h
new file mode 100644
index 0000000..cf7902a
--- /dev/null
+++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/stack_info/nrf_stack_info.h
@@ -0,0 +1,163 @@
+/**
+ * Copyright (c) 2018 - 2018, Nordic Semiconductor ASA
+ *
+ * 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, except as embedded into a Nordic
+ * Semiconductor ASA integrated circuit in a product or a software update for
+ * such product, 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 Nordic Semiconductor ASA nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ * Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ * engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA 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.
+ *
+ */
+/** @file
+ *
+ * @defgroup nrf_stack_info Stack info functions and definitions
+ * @{
+ * @ingroup app_common
+ *
+ * @brief Functions and definitions used to obtain information about the state of the stack.
+ */
+
+#ifndef NRF_STACK_INFO_H__
+#define NRF_STACK_INFO_H__
+
+#include <stddef.h>
+#include <stdbool.h>
+#include "compiler_abstraction.h"
+#include "app_util.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/**
+ * @brief Top (highest) stack address.
+ */
+#define NRF_STACK_INFO_TOP ((uint32_t)STACK_TOP)
+
+
+/**
+ * @brief Base (lowest) stack address.
+ */
+#define NRF_STACK_INFO_BASE ((uint32_t)STACK_BASE)
+
+
+/**
+ * @brief Function to get the current stack pointer value.
+ *
+ * @return Current stack pointer value.
+ */
+#define NRF_STACK_INFO_GET_SP() ((uint32_t)GET_SP())
+
+
+__STATIC_INLINE size_t nrf_stack_info_get_available(void);
+__STATIC_INLINE size_t nrf_stack_info_get_depth(void);
+__STATIC_INLINE bool nrf_stack_info_overflowed(void);
+__STATIC_INLINE bool nrf_stack_info_is_on_stack(void const * const p_address);
+
+
+#ifndef SUPPRESS_INLINE_IMPLEMENTATION
+
+/**
+ * @brief Calculate the available (free) space on the stack.
+ *
+ * @return Number of available bytes on the stack.
+ */
+ __STATIC_INLINE size_t nrf_stack_info_get_available(void)
+{
+ uint32_t sp = NRF_STACK_INFO_GET_SP();
+ if (sp > NRF_STACK_INFO_BASE)
+ {
+ return (size_t)(sp - NRF_STACK_INFO_BASE);
+ }
+
+ // Stack overflow
+ return 0;
+}
+
+
+/**
+ * @brief Calculate the current stack depth (occupied space).
+ *
+ * @return Current stack depth in bytes.
+ */
+__STATIC_INLINE size_t nrf_stack_info_get_depth(void)
+{
+ return (size_t)(NRF_STACK_INFO_TOP - NRF_STACK_INFO_GET_SP());
+}
+
+
+/**
+ * @brief Function for checking if the stack is currently overflowed.
+ *
+ * @details This function checks if the stack is currently in an overflowed by comparing the stack
+ * pointer with the stack base address. Intended to be used to be used to ease debugging.
+ *
+ * @return true if stack is currently overflowed, false otherwise.
+ */
+ __STATIC_INLINE bool nrf_stack_info_overflowed(void)
+ {
+ if (NRF_STACK_INFO_GET_SP() < NRF_STACK_INFO_BASE)
+ {
+ return true;
+ }
+
+ return false;
+ }
+
+
+/**
+ * @brief Function for checking if provided address is located in stack space.
+ *
+ * @param[in] p_address Address to be checked.
+ *
+ * @return true if address is in stack space, false otherwise.
+ */
+__STATIC_INLINE bool nrf_stack_info_is_on_stack(void const * const p_address)
+{
+ if (((uint32_t)p_address >= NRF_STACK_INFO_BASE) && ((uint32_t)p_address < NRF_STACK_INFO_TOP))
+ {
+ return true;
+ }
+
+ return false;
+}
+
+#endif // SUPPRESS_INLINE_IMPLEMENTATION
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // NRF_STACK_INFO_H__
+
+/**@} */