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_VBLUNO51/TOOLCHAIN_GCC_ARM/nrf_drv_common.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- TARGET_NRF51_DONGLE/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/drivers_nrf/common/nrf_drv_common.h@169:a7c7b631e539
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 143:86740a56073b | 1 | /* |
AnnaBridge | 143:86740a56073b | 2 | * Copyright (c) 2015 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 | #ifndef NRF_DRV_COMMON_H__ |
AnnaBridge | 143:86740a56073b | 41 | #define NRF_DRV_COMMON_H__ |
AnnaBridge | 143:86740a56073b | 42 | |
AnnaBridge | 143:86740a56073b | 43 | #include <stdint.h> |
AnnaBridge | 143:86740a56073b | 44 | #include <stdbool.h> |
AnnaBridge | 143:86740a56073b | 45 | #include "nrf.h" |
AnnaBridge | 143:86740a56073b | 46 | #include "sdk_errors.h" |
AnnaBridge | 143:86740a56073b | 47 | #include "nrf_drv_config.h" |
AnnaBridge | 143:86740a56073b | 48 | |
AnnaBridge | 143:86740a56073b | 49 | |
AnnaBridge | 143:86740a56073b | 50 | /** |
AnnaBridge | 143:86740a56073b | 51 | * @brief Offset of event registers in every peripheral instance |
AnnaBridge | 143:86740a56073b | 52 | * |
AnnaBridge | 143:86740a56073b | 53 | * This is the offset where event registers start in the every peripheral. |
AnnaBridge | 143:86740a56073b | 54 | */ |
AnnaBridge | 143:86740a56073b | 55 | #define NRF_DRV_COMMON_EVREGS_OFFSET 0x100U |
AnnaBridge | 143:86740a56073b | 56 | |
AnnaBridge | 143:86740a56073b | 57 | /** |
AnnaBridge | 143:86740a56073b | 58 | * @brief Driver state. |
AnnaBridge | 143:86740a56073b | 59 | */ |
AnnaBridge | 143:86740a56073b | 60 | typedef enum |
AnnaBridge | 143:86740a56073b | 61 | { |
AnnaBridge | 143:86740a56073b | 62 | NRF_DRV_STATE_UNINITIALIZED, /**< Uninitialized. */ |
AnnaBridge | 143:86740a56073b | 63 | NRF_DRV_STATE_INITIALIZED, /**< Initialized but powered off. */ |
AnnaBridge | 143:86740a56073b | 64 | NRF_DRV_STATE_POWERED_ON |
AnnaBridge | 143:86740a56073b | 65 | } nrf_drv_state_t; |
AnnaBridge | 143:86740a56073b | 66 | |
AnnaBridge | 143:86740a56073b | 67 | /** |
AnnaBridge | 143:86740a56073b | 68 | * @brief Driver power state selection. |
AnnaBridge | 143:86740a56073b | 69 | */ |
AnnaBridge | 143:86740a56073b | 70 | typedef enum |
AnnaBridge | 143:86740a56073b | 71 | { |
AnnaBridge | 143:86740a56073b | 72 | NRF_DRV_PWR_CTRL_ON, /**< Power on request. */ |
AnnaBridge | 143:86740a56073b | 73 | NRF_DRV_PWR_CTRL_OFF /**< Power off request. */ |
AnnaBridge | 143:86740a56073b | 74 | } nrf_drv_pwr_ctrl_t; |
AnnaBridge | 143:86740a56073b | 75 | |
AnnaBridge | 143:86740a56073b | 76 | /** |
AnnaBridge | 143:86740a56073b | 77 | * @brief IRQ handler type. |
AnnaBridge | 143:86740a56073b | 78 | */ |
AnnaBridge | 143:86740a56073b | 79 | typedef void (*nrf_drv_irq_handler_t)(void); |
AnnaBridge | 143:86740a56073b | 80 | |
AnnaBridge | 143:86740a56073b | 81 | |
AnnaBridge | 143:86740a56073b | 82 | #if PERIPHERAL_RESOURCE_SHARING_ENABLED |
AnnaBridge | 143:86740a56073b | 83 | |
AnnaBridge | 143:86740a56073b | 84 | /** |
AnnaBridge | 143:86740a56073b | 85 | * @brief Function for acquiring shared peripheral resources associated with |
AnnaBridge | 143:86740a56073b | 86 | * the specified peripheral. |
AnnaBridge | 143:86740a56073b | 87 | * |
AnnaBridge | 143:86740a56073b | 88 | * Certain resources and registers are shared among peripherals that have |
AnnaBridge | 143:86740a56073b | 89 | * the same ID (for example: SPI0, SPIM0, SPIS0, TWI0, TWIM0, and TWIS0). |
AnnaBridge | 143:86740a56073b | 90 | * Only one of them can be utilized at a given time. This function reserves |
AnnaBridge | 143:86740a56073b | 91 | * proper resources to be used by the specified peripheral. |
AnnaBridge | 143:86740a56073b | 92 | * If PERIPHERAL_RESOURCE_SHARING_ENABLED is set to a non-zero value, IRQ |
AnnaBridge | 143:86740a56073b | 93 | * handlers for peripherals that are sharing resources with others are |
AnnaBridge | 143:86740a56073b | 94 | * implemented by the nrf_drv_common module instead of individual drivers. |
AnnaBridge | 143:86740a56073b | 95 | * The drivers must then specify their interrupt handling routines and |
AnnaBridge | 143:86740a56073b | 96 | * register them by using this function. |
AnnaBridge | 143:86740a56073b | 97 | * |
AnnaBridge | 143:86740a56073b | 98 | * @param[in] p_per_base Requested peripheral base pointer. |
AnnaBridge | 143:86740a56073b | 99 | * @param[in] handler Interrupt handler to register. May be NULL |
AnnaBridge | 143:86740a56073b | 100 | * if interrupts are not used for the peripheral. |
AnnaBridge | 143:86740a56073b | 101 | * |
AnnaBridge | 143:86740a56073b | 102 | * @retval NRF_SUCCESS If resources were acquired successfully. |
AnnaBridge | 143:86740a56073b | 103 | * @retval NRF_ERROR_BUSY If resources were already acquired. |
AnnaBridge | 143:86740a56073b | 104 | * @retval NRF_ERROR_INVALID_PARAM If the specified peripheral is not enabled |
AnnaBridge | 143:86740a56073b | 105 | * or the peripheral does not share resources |
AnnaBridge | 143:86740a56073b | 106 | * with other peripherals. |
AnnaBridge | 143:86740a56073b | 107 | */ |
AnnaBridge | 143:86740a56073b | 108 | ret_code_t nrf_drv_common_per_res_acquire(void const * p_per_base, |
AnnaBridge | 143:86740a56073b | 109 | nrf_drv_irq_handler_t handler); |
AnnaBridge | 143:86740a56073b | 110 | |
AnnaBridge | 143:86740a56073b | 111 | /** |
AnnaBridge | 143:86740a56073b | 112 | * @brief Function for releasing shared resources reserved previously by |
AnnaBridge | 143:86740a56073b | 113 | * @ref nrf_drv_common_per_res_acquire() for the specified peripheral. |
AnnaBridge | 143:86740a56073b | 114 | * |
AnnaBridge | 143:86740a56073b | 115 | * @param[in] p_per_base Requested peripheral base pointer. |
AnnaBridge | 143:86740a56073b | 116 | */ |
AnnaBridge | 143:86740a56073b | 117 | void nrf_drv_common_per_res_release(void const * p_per_base); |
AnnaBridge | 143:86740a56073b | 118 | |
AnnaBridge | 143:86740a56073b | 119 | #endif // PERIPHERAL_RESOURCE_SHARING_ENABLED |
AnnaBridge | 143:86740a56073b | 120 | |
AnnaBridge | 143:86740a56073b | 121 | |
AnnaBridge | 143:86740a56073b | 122 | /** |
AnnaBridge | 143:86740a56073b | 123 | * @brief Function sets priority and enables NVIC interrupt |
AnnaBridge | 143:86740a56073b | 124 | * |
AnnaBridge | 143:86740a56073b | 125 | * @note Function checks if correct priority is used when softdevice is present |
AnnaBridge | 143:86740a56073b | 126 | * |
AnnaBridge | 143:86740a56073b | 127 | * @param[in] IRQn Interrupt id |
AnnaBridge | 143:86740a56073b | 128 | * @param[in] priority Interrupt priority |
AnnaBridge | 143:86740a56073b | 129 | */ |
AnnaBridge | 143:86740a56073b | 130 | void nrf_drv_common_irq_enable(IRQn_Type IRQn, uint8_t priority); |
AnnaBridge | 143:86740a56073b | 131 | |
AnnaBridge | 143:86740a56073b | 132 | /** |
AnnaBridge | 143:86740a56073b | 133 | * @brief Function disables NVIC interrupt |
AnnaBridge | 143:86740a56073b | 134 | * |
AnnaBridge | 143:86740a56073b | 135 | * @param[in] IRQn Interrupt id |
AnnaBridge | 143:86740a56073b | 136 | */ |
AnnaBridge | 143:86740a56073b | 137 | __STATIC_INLINE void nrf_drv_common_irq_disable(IRQn_Type IRQn); |
AnnaBridge | 143:86740a56073b | 138 | |
AnnaBridge | 143:86740a56073b | 139 | /** |
AnnaBridge | 143:86740a56073b | 140 | * @brief Convert bit position to event code |
AnnaBridge | 143:86740a56073b | 141 | * |
AnnaBridge | 143:86740a56073b | 142 | * Function for converting the bit position in INTEN register to event code |
AnnaBridge | 143:86740a56073b | 143 | * that is equivalent to the offset of the event register from the beginning |
AnnaBridge | 143:86740a56073b | 144 | * of peripheral instance. |
AnnaBridge | 143:86740a56073b | 145 | * |
AnnaBridge | 143:86740a56073b | 146 | * For example the result of this function can be casted directly to |
AnnaBridge | 143:86740a56073b | 147 | * the types like @ref nrf_twis_event_t or @ref nrf_rng_events_t... |
AnnaBridge | 143:86740a56073b | 148 | * |
AnnaBridge | 143:86740a56073b | 149 | * @param bit Bit position in INTEN register |
AnnaBridge | 143:86740a56073b | 150 | * @return Event code to be casted to the right enum type or to be used in functions like |
AnnaBridge | 143:86740a56073b | 151 | * @ref nrf_rng_event_get |
AnnaBridge | 143:86740a56073b | 152 | * |
AnnaBridge | 143:86740a56073b | 153 | * @sa nrf_drv_event_to_bitpos |
AnnaBridge | 143:86740a56073b | 154 | */ |
AnnaBridge | 143:86740a56073b | 155 | __STATIC_INLINE uint32_t nrf_drv_bitpos_to_event(uint32_t bit); |
AnnaBridge | 143:86740a56073b | 156 | |
AnnaBridge | 143:86740a56073b | 157 | /** |
AnnaBridge | 143:86740a56073b | 158 | * @brief Convert event code to bit position |
AnnaBridge | 143:86740a56073b | 159 | * |
AnnaBridge | 143:86740a56073b | 160 | * This function can be used to get bit position in INTEN register from event code. |
AnnaBridge | 143:86740a56073b | 161 | * |
AnnaBridge | 143:86740a56073b | 162 | * @param event Event code that may be casted from enum values from types like |
AnnaBridge | 143:86740a56073b | 163 | * @ref nrf_twis_event_t or @ref nrf_rng_events_t |
AnnaBridge | 143:86740a56073b | 164 | * @return Bit position in INTEN register that corresponds to the given code. |
AnnaBridge | 143:86740a56073b | 165 | * |
AnnaBridge | 143:86740a56073b | 166 | * @sa nrf_drv_bitpos_to_event |
AnnaBridge | 143:86740a56073b | 167 | */ |
AnnaBridge | 143:86740a56073b | 168 | __STATIC_INLINE uint32_t nrf_drv_event_to_bitpos(uint32_t event); |
AnnaBridge | 143:86740a56073b | 169 | |
AnnaBridge | 143:86740a56073b | 170 | /** |
AnnaBridge | 143:86740a56073b | 171 | * @brief Get interrupt number connected with given instance |
AnnaBridge | 143:86740a56073b | 172 | * |
AnnaBridge | 143:86740a56073b | 173 | * Function returns interrupt number for a given instance of any peripheral. |
AnnaBridge | 143:86740a56073b | 174 | * @param[in] pinst Pointer to peripheral registry |
AnnaBridge | 143:86740a56073b | 175 | * @return Interrupt number |
AnnaBridge | 143:86740a56073b | 176 | */ |
AnnaBridge | 143:86740a56073b | 177 | __STATIC_INLINE IRQn_Type nrf_drv_get_IRQn(void const * const pinst); |
AnnaBridge | 143:86740a56073b | 178 | |
AnnaBridge | 143:86740a56073b | 179 | /** |
AnnaBridge | 143:86740a56073b | 180 | * @brief Check if given object is in RAM |
AnnaBridge | 143:86740a56073b | 181 | * |
AnnaBridge | 143:86740a56073b | 182 | * Function for analyzing if given location is placed in RAM. |
AnnaBridge | 143:86740a56073b | 183 | * This function is used to determine if we have address that can be supported by EasyDMA. |
AnnaBridge | 143:86740a56073b | 184 | * @param[in] ptr Pointer to the object |
AnnaBridge | 143:86740a56073b | 185 | * @retval true Object is located in RAM |
AnnaBridge | 143:86740a56073b | 186 | * @retval false Object is not located in RAM |
AnnaBridge | 143:86740a56073b | 187 | */ |
AnnaBridge | 143:86740a56073b | 188 | __STATIC_INLINE bool nrf_drv_is_in_RAM(void const * const ptr); |
AnnaBridge | 143:86740a56073b | 189 | |
AnnaBridge | 143:86740a56073b | 190 | |
AnnaBridge | 143:86740a56073b | 191 | #ifndef SUPPRESS_INLINE_IMPLEMENTATION |
AnnaBridge | 143:86740a56073b | 192 | |
AnnaBridge | 143:86740a56073b | 193 | __STATIC_INLINE void nrf_drv_common_irq_disable(IRQn_Type IRQn) |
AnnaBridge | 143:86740a56073b | 194 | { |
AnnaBridge | 143:86740a56073b | 195 | NVIC_DisableIRQ(IRQn); |
AnnaBridge | 143:86740a56073b | 196 | } |
AnnaBridge | 143:86740a56073b | 197 | |
AnnaBridge | 143:86740a56073b | 198 | __STATIC_INLINE uint32_t nrf_drv_bitpos_to_event(uint32_t bit) |
AnnaBridge | 143:86740a56073b | 199 | { |
AnnaBridge | 143:86740a56073b | 200 | return NRF_DRV_COMMON_EVREGS_OFFSET + bit * sizeof(uint32_t); |
AnnaBridge | 143:86740a56073b | 201 | } |
AnnaBridge | 143:86740a56073b | 202 | |
AnnaBridge | 143:86740a56073b | 203 | __STATIC_INLINE uint32_t nrf_drv_event_to_bitpos(uint32_t event) |
AnnaBridge | 143:86740a56073b | 204 | { |
AnnaBridge | 143:86740a56073b | 205 | return (event - NRF_DRV_COMMON_EVREGS_OFFSET) / sizeof(uint32_t); |
AnnaBridge | 143:86740a56073b | 206 | } |
AnnaBridge | 143:86740a56073b | 207 | |
AnnaBridge | 143:86740a56073b | 208 | __STATIC_INLINE IRQn_Type nrf_drv_get_IRQn(void const * const pinst) |
AnnaBridge | 143:86740a56073b | 209 | { |
AnnaBridge | 143:86740a56073b | 210 | uint8_t ret = (uint8_t)((uint32_t)pinst>>12U); |
AnnaBridge | 143:86740a56073b | 211 | return (IRQn_Type) ret; |
AnnaBridge | 143:86740a56073b | 212 | } |
AnnaBridge | 143:86740a56073b | 213 | |
AnnaBridge | 143:86740a56073b | 214 | __STATIC_INLINE bool nrf_drv_is_in_RAM(void const * const ptr) |
AnnaBridge | 143:86740a56073b | 215 | { |
AnnaBridge | 143:86740a56073b | 216 | return ((((uintptr_t)ptr) & 0xE0000000u) == 0x20000000u); |
AnnaBridge | 143:86740a56073b | 217 | } |
AnnaBridge | 143:86740a56073b | 218 | |
AnnaBridge | 143:86740a56073b | 219 | #endif // SUPPRESS_INLINE_IMPLEMENTATION |
AnnaBridge | 143:86740a56073b | 220 | |
AnnaBridge | 143:86740a56073b | 221 | #endif // NRF_DRV_COMMON_H__ |