279 lines
9.6 KiB
C
279 lines
9.6 KiB
C
|
/**
|
||
|
|
* Copyright (c) 2014 - 2020, 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 app_util_platform Utility Functions and Definitions (Platform)
|
||
|
|
* @{
|
||
|
|
* @ingroup app_common
|
||
|
|
*
|
||
|
|
* @brief Various types and definitions available to all applications when using SoftDevice.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef APP_UTIL_PLATFORM_H__
|
||
|
|
#define APP_UTIL_PLATFORM_H__
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
#include "compiler_abstraction.h"
|
||
|
|
#include "nrf.h"
|
||
|
|
#ifdef SOFTDEVICE_PRESENT
|
||
|
|
#include "nrf_soc.h"
|
||
|
|
#include "nrf_nvic.h"
|
||
|
|
#endif
|
||
|
|
#include "nrf_assert.h"
|
||
|
|
#include "app_error.h"
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#if __CORTEX_M == (0x00U)
|
||
|
|
#define _PRIO_SD_HIGH 0
|
||
|
|
#define _PRIO_APP_HIGH 1
|
||
|
|
#define _PRIO_APP_MID 1
|
||
|
|
#define _PRIO_SD_LOW 2
|
||
|
|
#define _PRIO_APP_LOW_MID 3
|
||
|
|
#define _PRIO_APP_LOW 3
|
||
|
|
#define _PRIO_APP_LOWEST 3
|
||
|
|
#define _PRIO_THREAD 4
|
||
|
|
#elif __CORTEX_M >= (0x04U)
|
||
|
|
#define _PRIO_SD_HIGH 0
|
||
|
|
#define _PRIO_SD_MID 1
|
||
|
|
#define _PRIO_APP_HIGH 2
|
||
|
|
#define _PRIO_APP_MID 3
|
||
|
|
#define _PRIO_SD_LOW 4
|
||
|
|
#define _PRIO_APP_LOW_MID 5
|
||
|
|
#define _PRIO_APP_LOW 6
|
||
|
|
#define _PRIO_APP_LOWEST 7
|
||
|
|
#define _PRIO_THREAD 15
|
||
|
|
#else
|
||
|
|
#error "No platform defined"
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
//lint -save -e113 -e452
|
||
|
|
/**@brief The interrupt priorities available to the application while the SoftDevice is active. */
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
#ifndef SOFTDEVICE_PRESENT
|
||
|
|
APP_IRQ_PRIORITY_HIGHEST = _PRIO_SD_HIGH, /**< Running in Application Highest interrupt level. */
|
||
|
|
#else
|
||
|
|
APP_IRQ_PRIORITY_HIGHEST = _PRIO_APP_HIGH, /**< Running in Application Highest interrupt level. */
|
||
|
|
#endif
|
||
|
|
APP_IRQ_PRIORITY_HIGH = _PRIO_APP_HIGH, /**< Running in Application High interrupt level. */
|
||
|
|
#ifndef SOFTDEVICE_PRESENT
|
||
|
|
APP_IRQ_PRIORITY_MID = _PRIO_SD_LOW, /**< Running in Application Middle interrupt level. */
|
||
|
|
#else
|
||
|
|
APP_IRQ_PRIORITY_MID = _PRIO_APP_MID, /**< Running in Application Middle interrupt level. */
|
||
|
|
#endif
|
||
|
|
APP_IRQ_PRIORITY_LOW_MID = _PRIO_APP_LOW_MID, /**< Running in Application Middle Low interrupt level. */
|
||
|
|
APP_IRQ_PRIORITY_LOW = _PRIO_APP_LOW, /**< Running in Application Low interrupt level. */
|
||
|
|
APP_IRQ_PRIORITY_LOWEST = _PRIO_APP_LOWEST, /**< Running in Application Lowest interrupt level. */
|
||
|
|
APP_IRQ_PRIORITY_THREAD = _PRIO_THREAD /**< Running in Thread Mode. */
|
||
|
|
} app_irq_priority_t;
|
||
|
|
//lint -restore
|
||
|
|
|
||
|
|
|
||
|
|
/*@brief The privilege levels available to applications in Thread Mode */
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
APP_LEVEL_UNPRIVILEGED,
|
||
|
|
APP_LEVEL_PRIVILEGED
|
||
|
|
} app_level_t;
|
||
|
|
|
||
|
|
/**@cond NO_DOXYGEN */
|
||
|
|
#define EXTERNAL_INT_VECTOR_OFFSET 16
|
||
|
|
/**@endcond */
|
||
|
|
|
||
|
|
/**@brief Macro for setting a breakpoint.
|
||
|
|
*/
|
||
|
|
#if defined(__GNUC__)
|
||
|
|
#define NRF_BREAKPOINT __asm__("BKPT 0");
|
||
|
|
#else
|
||
|
|
#define NRF_BREAKPOINT __BKPT(0)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/** @brief Macro for setting a breakpoint.
|
||
|
|
*
|
||
|
|
* If it is possible to detect debugger presence then it is set only in that case.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
#if __CORTEX_M == 0x04
|
||
|
|
#define NRF_BREAKPOINT_COND do { \
|
||
|
|
/* C_DEBUGEN == 1 -> Debugger Connected */ \
|
||
|
|
if (CoreDebug->DHCSR & CoreDebug_DHCSR_C_DEBUGEN_Msk) \
|
||
|
|
{ \
|
||
|
|
/* Generate breakpoint if debugger is connected */ \
|
||
|
|
NRF_BREAKPOINT; \
|
||
|
|
} \
|
||
|
|
}while (0)
|
||
|
|
#else
|
||
|
|
#define NRF_BREAKPOINT_COND NRF_BREAKPOINT
|
||
|
|
#endif // __CORTEX_M == 0x04
|
||
|
|
|
||
|
|
#if defined ( __CC_ARM )
|
||
|
|
#define PACKED(TYPE) __packed TYPE
|
||
|
|
#define PACKED_STRUCT PACKED(struct)
|
||
|
|
#elif defined ( __GNUC__ )
|
||
|
|
#define PACKED __attribute__((packed))
|
||
|
|
#define PACKED_STRUCT struct PACKED
|
||
|
|
#elif defined (__ICCARM__)
|
||
|
|
#define PACKED_STRUCT __packed struct
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#if defined ( __CC_ARM )
|
||
|
|
#define PRAGMA_OPTIMIZATION_FORCE_START _Pragma ("push") \
|
||
|
|
_Pragma ("O3")
|
||
|
|
#define PRAGMA_OPTIMIZATION_FORCE_END _Pragma ("pop")
|
||
|
|
#elif defined ( __GNUC__ )
|
||
|
|
#define PRAGMA_OPTIMIZATION_FORCE_START _Pragma("GCC push_options") \
|
||
|
|
_Pragma ("GCC optimize (\"Os\")")
|
||
|
|
#define PRAGMA_OPTIMIZATION_FORCE_END _Pragma ("GCC pop_options")
|
||
|
|
#elif defined (__ICCARM__)
|
||
|
|
#define PRAGMA_OPTIMIZATION_FORCE_START _Pragma ("optimize=high z")
|
||
|
|
#define PRAGMA_OPTIMIZATION_FORCE_END
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
void app_util_critical_region_enter (uint8_t *p_nested);
|
||
|
|
void app_util_critical_region_exit (uint8_t nested);
|
||
|
|
|
||
|
|
/**@brief Macro for entering a critical region.
|
||
|
|
*
|
||
|
|
* @note Due to implementation details, there must exist one and only one call to
|
||
|
|
* CRITICAL_REGION_EXIT() for each call to CRITICAL_REGION_ENTER(), and they must be located
|
||
|
|
* in the same scope.
|
||
|
|
*/
|
||
|
|
#ifdef SOFTDEVICE_PRESENT
|
||
|
|
#define CRITICAL_REGION_ENTER() \
|
||
|
|
{ \
|
||
|
|
uint8_t __CR_NESTED = 0; \
|
||
|
|
app_util_critical_region_enter(&__CR_NESTED);
|
||
|
|
#else
|
||
|
|
#define CRITICAL_REGION_ENTER() app_util_critical_region_enter(NULL)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**@brief Macro for leaving a critical region.
|
||
|
|
*
|
||
|
|
* @note Due to implementation details, there must exist one and only one call to
|
||
|
|
* CRITICAL_REGION_EXIT() for each call to CRITICAL_REGION_ENTER(), and they must be located
|
||
|
|
* in the same scope.
|
||
|
|
*/
|
||
|
|
#ifdef SOFTDEVICE_PRESENT
|
||
|
|
#define CRITICAL_REGION_EXIT() \
|
||
|
|
app_util_critical_region_exit(__CR_NESTED); \
|
||
|
|
}
|
||
|
|
#else
|
||
|
|
#define CRITICAL_REGION_EXIT() app_util_critical_region_exit(0)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/* Workaround for Keil 4 */
|
||
|
|
#ifndef IPSR_ISR_Msk
|
||
|
|
#define IPSR_ISR_Msk (0x1FFUL /*<< IPSR_ISR_Pos*/) /*!< IPSR: ISR Mask */
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**@brief Macro to enable anonymous unions from a certain point in the code.
|
||
|
|
*/
|
||
|
|
#if defined(__CC_ARM)
|
||
|
|
#define ANON_UNIONS_ENABLE _Pragma("push") \
|
||
|
|
_Pragma("anon_unions") \
|
||
|
|
struct semicolon_swallower
|
||
|
|
#elif defined(__ICCARM__)
|
||
|
|
#define ANON_UNIONS_ENABLE _Pragma("language=extended") \
|
||
|
|
struct semicolon_swallower
|
||
|
|
#else
|
||
|
|
#define ANON_UNIONS_ENABLE struct semicolon_swallower
|
||
|
|
// No action will be taken.
|
||
|
|
// For GCC anonymous unions are enabled by default.
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**@brief Macro to disable anonymous unions from a certain point in the code.
|
||
|
|
* @note Call only after first calling @ref ANON_UNIONS_ENABLE.
|
||
|
|
*/
|
||
|
|
#if defined(__CC_ARM)
|
||
|
|
#define ANON_UNIONS_DISABLE _Pragma("pop") \
|
||
|
|
struct semicolon_swallower
|
||
|
|
#elif defined(__ICCARM__)
|
||
|
|
#define ANON_UNIONS_DISABLE struct semicolon_swallower
|
||
|
|
// for IAR leave anonymous unions enabled
|
||
|
|
#else
|
||
|
|
#define ANON_UNIONS_DISABLE struct semicolon_swallower
|
||
|
|
// No action will be taken.
|
||
|
|
// For GCC anonymous unions are enabled by default.
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**@brief Macro for adding pragma directive only for GCC.
|
||
|
|
*/
|
||
|
|
#ifdef __GNUC__
|
||
|
|
#define GCC_PRAGMA(v) _Pragma(v)
|
||
|
|
#else
|
||
|
|
#define GCC_PRAGMA(v)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/* Workaround for Keil 4 */
|
||
|
|
#ifndef CONTROL_nPRIV_Msk
|
||
|
|
#define CONTROL_nPRIV_Msk (1UL /*<< CONTROL_nPRIV_Pos*/) /*!< CONTROL: nPRIV Mask */
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**@brief Function for finding the current interrupt level.
|
||
|
|
*
|
||
|
|
* @return Current interrupt level. See @ref app_irq_priority_t for values.
|
||
|
|
*/
|
||
|
|
uint8_t current_int_priority_get(void);
|
||
|
|
|
||
|
|
|
||
|
|
/**@brief Function for finding out the current privilege level.
|
||
|
|
*
|
||
|
|
* @return Current privilege level.
|
||
|
|
* @retval APP_LEVEL_UNPRIVILEGED We are running in unprivileged level.
|
||
|
|
* @retval APP_LEVEL_PRIVILEGED We are running in privileged level.
|
||
|
|
*/
|
||
|
|
uint8_t privilege_level_get(void);
|
||
|
|
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif // APP_UTIL_PLATFORM_H__
|
||
|
|
|
||
|
|
/** @} */
|