mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NRF51_DK/TOOLCHAIN_ARM_STD/app_util_platform.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 143:86740a56073b 1 /*
AnnaBridge 143:86740a56073b 2 * Copyright (c) 2014 Nordic Semiconductor ASA
AnnaBridge 143:86740a56073b 3 * All rights reserved.
AnnaBridge 143:86740a56073b 4 *
AnnaBridge 143:86740a56073b 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 143:86740a56073b 6 * are permitted provided that the following conditions are met:
AnnaBridge 143:86740a56073b 7 *
AnnaBridge 143:86740a56073b 8 * 1. Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 143:86740a56073b 9 * of conditions and the following disclaimer.
AnnaBridge 143:86740a56073b 10 *
AnnaBridge 143:86740a56073b 11 * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA
AnnaBridge 143:86740a56073b 12 * integrated circuit in a product or a software update for such product, must reproduce
AnnaBridge 143:86740a56073b 13 * the above copyright notice, this list of conditions and the following disclaimer in
AnnaBridge 143:86740a56073b 14 * the documentation and/or other materials provided with the distribution.
AnnaBridge 143:86740a56073b 15 *
AnnaBridge 143:86740a56073b 16 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be
AnnaBridge 143:86740a56073b 17 * used to endorse or promote products derived from this software without specific prior
AnnaBridge 143:86740a56073b 18 * written permission.
AnnaBridge 143:86740a56073b 19 *
AnnaBridge 143:86740a56073b 20 * 4. This software, with or without modification, must only be used with a
AnnaBridge 143:86740a56073b 21 * Nordic Semiconductor ASA integrated circuit.
AnnaBridge 143:86740a56073b 22 *
AnnaBridge 143:86740a56073b 23 * 5. Any software provided in binary or object form under this license must not be reverse
AnnaBridge 143:86740a56073b 24 * engineered, decompiled, modified and/or disassembled.
AnnaBridge 143:86740a56073b 25 *
AnnaBridge 143:86740a56073b 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 143:86740a56073b 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 143:86740a56073b 28 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 143:86740a56073b 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 143:86740a56073b 30 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 143:86740a56073b 31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 143:86740a56073b 32 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 143:86740a56073b 33 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 143:86740a56073b 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 143:86740a56073b 35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 143:86740a56073b 36 *
AnnaBridge 143:86740a56073b 37 */
AnnaBridge 143:86740a56073b 38
AnnaBridge 143:86740a56073b 39
AnnaBridge 143:86740a56073b 40 /**@file
AnnaBridge 143:86740a56073b 41 *
AnnaBridge 143:86740a56073b 42 * @defgroup app_util_platform Utility Functions and Definitions (Platform)
AnnaBridge 143:86740a56073b 43 * @{
AnnaBridge 143:86740a56073b 44 * @ingroup app_common
AnnaBridge 143:86740a56073b 45 *
AnnaBridge 143:86740a56073b 46 * @brief Various types and definitions available to all applications when using SoftDevice.
AnnaBridge 143:86740a56073b 47 */
AnnaBridge 143:86740a56073b 48
AnnaBridge 143:86740a56073b 49 #ifndef APP_UTIL_PLATFORM_H__
AnnaBridge 143:86740a56073b 50 #define APP_UTIL_PLATFORM_H__
AnnaBridge 143:86740a56073b 51
AnnaBridge 143:86740a56073b 52 #include <stdint.h>
AnnaBridge 143:86740a56073b 53 #include "compiler_abstraction.h"
AnnaBridge 143:86740a56073b 54 #include "nrf.h"
AnnaBridge 143:86740a56073b 55 #ifdef SOFTDEVICE_PRESENT
AnnaBridge 143:86740a56073b 56 #include "nrf_soc.h"
AnnaBridge 143:86740a56073b 57 #include "nrf_nvic.h"
AnnaBridge 143:86740a56073b 58 #endif
AnnaBridge 143:86740a56073b 59 #include "nrf_assert.h"
AnnaBridge 143:86740a56073b 60 #include "app_error.h"
AnnaBridge 143:86740a56073b 61
AnnaBridge 143:86740a56073b 62 #if defined(NRF51)
AnnaBridge 143:86740a56073b 63 #define _PRIO_SD_HIGH 0
AnnaBridge 143:86740a56073b 64 #define _PRIO_APP_HIGH 1
AnnaBridge 143:86740a56073b 65 #define _PRIO_APP_MID 1
AnnaBridge 143:86740a56073b 66 #define _PRIO_SD_LOW 2
AnnaBridge 143:86740a56073b 67 #define _PRIO_APP_LOW 3
AnnaBridge 143:86740a56073b 68 #define _PRIO_APP_LOWEST 3
AnnaBridge 143:86740a56073b 69 #define _PRIO_THREAD 4
AnnaBridge 143:86740a56073b 70 #elif defined(NRF52)
AnnaBridge 143:86740a56073b 71 #define _PRIO_SD_HIGH 0
AnnaBridge 143:86740a56073b 72 #define _PRIO_SD_MID 1
AnnaBridge 143:86740a56073b 73 #define _PRIO_APP_HIGH 2
AnnaBridge 143:86740a56073b 74 #define _PRIO_APP_MID 3
AnnaBridge 143:86740a56073b 75 #define _PRIO_SD_LOW 4
AnnaBridge 143:86740a56073b 76 #define _PRIO_SD_LOWEST 5
AnnaBridge 143:86740a56073b 77 #define _PRIO_APP_LOW 6
AnnaBridge 143:86740a56073b 78 #define _PRIO_APP_LOWEST 7
AnnaBridge 143:86740a56073b 79 #define _PRIO_THREAD 15
AnnaBridge 143:86740a56073b 80 #else
AnnaBridge 143:86740a56073b 81 #error "No platform defined"
AnnaBridge 143:86740a56073b 82 #endif
AnnaBridge 143:86740a56073b 83
AnnaBridge 143:86740a56073b 84 /**@brief The interrupt priorities available to the application while the SoftDevice is active. */
AnnaBridge 143:86740a56073b 85 typedef enum
AnnaBridge 143:86740a56073b 86 {
AnnaBridge 143:86740a56073b 87 #ifdef SOFTDEVICE_PRESENT
AnnaBridge 143:86740a56073b 88 APP_IRQ_PRIORITY_HIGHEST = _PRIO_SD_HIGH,
AnnaBridge 143:86740a56073b 89 #else
AnnaBridge 143:86740a56073b 90 APP_IRQ_PRIORITY_HIGHEST = _PRIO_APP_HIGH,
AnnaBridge 143:86740a56073b 91 #endif
AnnaBridge 143:86740a56073b 92 APP_IRQ_PRIORITY_HIGH = _PRIO_APP_HIGH,
AnnaBridge 143:86740a56073b 93 #ifndef SOFTDEVICE_PRESENT
AnnaBridge 143:86740a56073b 94 APP_IRQ_PRIORITY_MID = _PRIO_SD_LOW,
AnnaBridge 143:86740a56073b 95 #else
AnnaBridge 143:86740a56073b 96 APP_IRQ_PRIORITY_MID = _PRIO_APP_MID,
AnnaBridge 143:86740a56073b 97 #endif
AnnaBridge 143:86740a56073b 98 APP_IRQ_PRIORITY_LOW = _PRIO_APP_LOW,
AnnaBridge 143:86740a56073b 99 APP_IRQ_PRIORITY_LOWEST = _PRIO_APP_LOWEST,
AnnaBridge 143:86740a56073b 100 APP_IRQ_PRIORITY_THREAD = _PRIO_THREAD /**< "Interrupt level" when running in Thread Mode. */
AnnaBridge 143:86740a56073b 101 } app_irq_priority_t;
AnnaBridge 143:86740a56073b 102
AnnaBridge 143:86740a56073b 103 /*@brief The privilege levels available to applications in Thread Mode */
AnnaBridge 143:86740a56073b 104 typedef enum
AnnaBridge 143:86740a56073b 105 {
AnnaBridge 143:86740a56073b 106 APP_LEVEL_UNPRIVILEGED,
AnnaBridge 143:86740a56073b 107 APP_LEVEL_PRIVILEGED
AnnaBridge 143:86740a56073b 108 } app_level_t;
AnnaBridge 143:86740a56073b 109
AnnaBridge 143:86740a56073b 110 /**@cond NO_DOXYGEN */
AnnaBridge 143:86740a56073b 111 #define EXTERNAL_INT_VECTOR_OFFSET 16
AnnaBridge 143:86740a56073b 112 /**@endcond */
AnnaBridge 143:86740a56073b 113
AnnaBridge 143:86740a56073b 114 void app_util_critical_region_enter (uint8_t *p_nested);
AnnaBridge 143:86740a56073b 115 void app_util_critical_region_exit (uint8_t nested);
AnnaBridge 143:86740a56073b 116
AnnaBridge 143:86740a56073b 117 /**@brief Macro for entering a critical region.
AnnaBridge 143:86740a56073b 118 *
AnnaBridge 143:86740a56073b 119 * @note Due to implementation details, there must exist one and only one call to
AnnaBridge 143:86740a56073b 120 * CRITICAL_REGION_EXIT() for each call to CRITICAL_REGION_ENTER(), and they must be located
AnnaBridge 143:86740a56073b 121 * in the same scope.
AnnaBridge 143:86740a56073b 122 */
AnnaBridge 143:86740a56073b 123 #ifdef SOFTDEVICE_PRESENT
AnnaBridge 143:86740a56073b 124 #define CRITICAL_REGION_ENTER() \
AnnaBridge 143:86740a56073b 125 { \
AnnaBridge 143:86740a56073b 126 uint8_t __CR_NESTED = 0; \
AnnaBridge 143:86740a56073b 127 app_util_critical_region_enter(&__CR_NESTED);
AnnaBridge 143:86740a56073b 128 #else
AnnaBridge 143:86740a56073b 129 #define CRITICAL_REGION_ENTER() app_util_critical_region_enter(NULL)
AnnaBridge 143:86740a56073b 130 #endif
AnnaBridge 143:86740a56073b 131
AnnaBridge 143:86740a56073b 132 /**@brief Macro for leaving a critical region.
AnnaBridge 143:86740a56073b 133 *
AnnaBridge 143:86740a56073b 134 * @note Due to implementation details, there must exist one and only one call to
AnnaBridge 143:86740a56073b 135 * CRITICAL_REGION_EXIT() for each call to CRITICAL_REGION_ENTER(), and they must be located
AnnaBridge 143:86740a56073b 136 * in the same scope.
AnnaBridge 143:86740a56073b 137 */
AnnaBridge 143:86740a56073b 138 #ifdef SOFTDEVICE_PRESENT
AnnaBridge 143:86740a56073b 139 #define CRITICAL_REGION_EXIT() \
AnnaBridge 143:86740a56073b 140 app_util_critical_region_exit(__CR_NESTED); \
AnnaBridge 143:86740a56073b 141 }
AnnaBridge 143:86740a56073b 142 #else
AnnaBridge 143:86740a56073b 143 #define CRITICAL_REGION_EXIT() app_util_critical_region_exit(0)
AnnaBridge 143:86740a56073b 144 #endif
AnnaBridge 143:86740a56073b 145
AnnaBridge 143:86740a56073b 146 /* Workaround for Keil 4 */
AnnaBridge 143:86740a56073b 147 #ifndef IPSR_ISR_Msk
AnnaBridge 143:86740a56073b 148 #define IPSR_ISR_Msk (0x1FFUL /*<< IPSR_ISR_Pos*/) /*!< IPSR: ISR Mask */
AnnaBridge 143:86740a56073b 149 #endif
AnnaBridge 143:86740a56073b 150
AnnaBridge 143:86740a56073b 151
AnnaBridge 143:86740a56073b 152
AnnaBridge 143:86740a56073b 153 /**@brief Macro to enable anonymous unions from a certain point in the code.
AnnaBridge 143:86740a56073b 154 */
AnnaBridge 143:86740a56073b 155 #if defined(__CC_ARM)
AnnaBridge 143:86740a56073b 156 #define ANON_UNIONS_ENABLE _Pragma("push") \
AnnaBridge 143:86740a56073b 157 _Pragma("anon_unions")
AnnaBridge 143:86740a56073b 158 #elif defined(__ICCARM__)
AnnaBridge 143:86740a56073b 159 #define ANON_UNIONS_ENABLE _Pragma("language=extended")
AnnaBridge 143:86740a56073b 160 #else
AnnaBridge 143:86740a56073b 161 #define ANON_UNIONS_ENABLE
AnnaBridge 143:86740a56073b 162 // No action will be taken.
AnnaBridge 143:86740a56073b 163 // For GCC anonymous unions are enabled by default.
AnnaBridge 143:86740a56073b 164 #endif
AnnaBridge 143:86740a56073b 165
AnnaBridge 143:86740a56073b 166 /**@brief Macro to disable anonymous unions from a certain point in the code.
AnnaBridge 143:86740a56073b 167 * @note Call only after first calling @ref ANON_UNIONS_ENABLE.
AnnaBridge 143:86740a56073b 168 */
AnnaBridge 143:86740a56073b 169 #if defined(__CC_ARM)
AnnaBridge 143:86740a56073b 170 #define ANON_UNIONS_DISABLE _Pragma("pop")
AnnaBridge 143:86740a56073b 171 #elif defined(__ICCARM__)
AnnaBridge 143:86740a56073b 172 #define ANON_UNIONS_DISABLE
AnnaBridge 143:86740a56073b 173 // for IAR leave anonymous unions enabled
AnnaBridge 143:86740a56073b 174 #else
AnnaBridge 143:86740a56073b 175 #define ANON_UNIONS_DISABLE
AnnaBridge 143:86740a56073b 176 // No action will be taken.
AnnaBridge 143:86740a56073b 177 // For GCC anonymous unions are enabled by default.
AnnaBridge 143:86740a56073b 178 #endif
AnnaBridge 143:86740a56073b 179
AnnaBridge 143:86740a56073b 180
AnnaBridge 143:86740a56073b 181 /* Workaround for Keil 4 */
AnnaBridge 143:86740a56073b 182 #ifndef CONTROL_nPRIV_Msk
AnnaBridge 143:86740a56073b 183 #define CONTROL_nPRIV_Msk (1UL /*<< CONTROL_nPRIV_Pos*/) /*!< CONTROL: nPRIV Mask */
AnnaBridge 143:86740a56073b 184 #endif
AnnaBridge 143:86740a56073b 185
AnnaBridge 143:86740a56073b 186 /**@brief Function for finding the current interrupt level.
AnnaBridge 143:86740a56073b 187 *
AnnaBridge 143:86740a56073b 188 * @return Current interrupt level.
AnnaBridge 143:86740a56073b 189 * @retval APP_IRQ_PRIORITY_HIGH We are running in Application High interrupt level.
AnnaBridge 143:86740a56073b 190 * @retval APP_IRQ_PRIORITY_LOW We are running in Application Low interrupt level.
AnnaBridge 143:86740a56073b 191 * @retval APP_IRQ_PRIORITY_THREAD We are running in Thread Mode.
AnnaBridge 143:86740a56073b 192 */
AnnaBridge 143:86740a56073b 193 static __INLINE uint8_t current_int_priority_get(void)
AnnaBridge 143:86740a56073b 194 {
AnnaBridge 143:86740a56073b 195 uint32_t isr_vector_num = __get_IPSR() & IPSR_ISR_Msk ;
AnnaBridge 143:86740a56073b 196 if (isr_vector_num > 0)
AnnaBridge 143:86740a56073b 197 {
AnnaBridge 143:86740a56073b 198 int32_t irq_type = ((int32_t)isr_vector_num - EXTERNAL_INT_VECTOR_OFFSET);
AnnaBridge 143:86740a56073b 199 return (NVIC_GetPriority((IRQn_Type)irq_type) & 0xFF);
AnnaBridge 143:86740a56073b 200 }
AnnaBridge 143:86740a56073b 201 else
AnnaBridge 143:86740a56073b 202 {
AnnaBridge 143:86740a56073b 203 return APP_IRQ_PRIORITY_THREAD;
AnnaBridge 143:86740a56073b 204 }
AnnaBridge 143:86740a56073b 205 }
AnnaBridge 143:86740a56073b 206
AnnaBridge 143:86740a56073b 207 /**@brief Function for finding out the current privilege level.
AnnaBridge 143:86740a56073b 208 *
AnnaBridge 143:86740a56073b 209 * @return Current privilege level.
AnnaBridge 143:86740a56073b 210 * @retval APP_LEVEL_UNPRIVILEGED We are running in unprivileged level.
AnnaBridge 143:86740a56073b 211 * @retval APP_LEVEL_PRIVILEGED We are running in privileged level.
AnnaBridge 143:86740a56073b 212 */
AnnaBridge 143:86740a56073b 213 static __INLINE uint8_t privilege_level_get(void)
AnnaBridge 143:86740a56073b 214 {
AnnaBridge 143:86740a56073b 215 #if defined(NRF51)
AnnaBridge 143:86740a56073b 216 /* the Cortex-M0 has no concept of privilege */
AnnaBridge 143:86740a56073b 217 return APP_LEVEL_PRIVILEGED;
AnnaBridge 143:86740a56073b 218 #elif defined(NRF52)
AnnaBridge 143:86740a56073b 219 uint32_t isr_vector_num = __get_IPSR() & IPSR_ISR_Msk ;
AnnaBridge 143:86740a56073b 220 if (0 == isr_vector_num)
AnnaBridge 143:86740a56073b 221 {
AnnaBridge 143:86740a56073b 222 /* Thread Mode, check nPRIV */
AnnaBridge 143:86740a56073b 223 int32_t control = __get_CONTROL();
AnnaBridge 143:86740a56073b 224 return control & CONTROL_nPRIV_Msk ? APP_LEVEL_UNPRIVILEGED : APP_LEVEL_PRIVILEGED;
AnnaBridge 143:86740a56073b 225 }
AnnaBridge 143:86740a56073b 226 else
AnnaBridge 143:86740a56073b 227 {
AnnaBridge 143:86740a56073b 228 /* Handler Mode, always privileged */
AnnaBridge 143:86740a56073b 229 return APP_LEVEL_PRIVILEGED;
AnnaBridge 143:86740a56073b 230 }
AnnaBridge 143:86740a56073b 231 #endif
AnnaBridge 143:86740a56073b 232 }
AnnaBridge 143:86740a56073b 233
AnnaBridge 143:86740a56073b 234 #endif // APP_UTIL_PLATFORM_H__
AnnaBridge 143:86740a56073b 235
AnnaBridge 143:86740a56073b 236 /** @} */