/** * Copyright (c) 2017 - 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. * */ #ifndef NRFX_GLUE_H__ #define NRFX_GLUE_H__ #ifdef __cplusplus extern "C" { #endif /** * @defgroup nrfx_glue nrfx_glue.h * @{ * @ingroup nrfx * * @brief This file contains macros that should be implemented according to * the needs of the host environment into which @em nrfx is integrated. */ #include #include //------------------------------------------------------------------------------ #include /** * @brief Macro for placing a runtime assertion. * * @param expression Expression to evaluate. */ #define NRFX_ASSERT(expression) ASSERT(expression) #include /** * @brief Macro for placing a compile time assertion. * * @param expression Expression to evaluate. */ #define NRFX_STATIC_ASSERT(expression) STATIC_ASSERT(expression) //------------------------------------------------------------------------------ #ifdef NRF51 #ifdef SOFTDEVICE_PRESENT #define INTERRUPT_PRIORITY_IS_VALID(pri) (((pri) == 1) || ((pri) == 3)) #else #define INTERRUPT_PRIORITY_IS_VALID(pri) ((pri) < 4) #endif //SOFTDEVICE_PRESENT #else #ifdef SOFTDEVICE_PRESENT #define INTERRUPT_PRIORITY_IS_VALID(pri) ((((pri) > 1) && ((pri) < 4)) || \ (((pri) > 4) && ((pri) < 8))) #else #define INTERRUPT_PRIORITY_IS_VALID(pri) ((pri) < 8) #endif //SOFTDEVICE_PRESENT #endif //NRF52 /** * @brief Macro for setting the priority of a specific IRQ. * * @param irq_number IRQ number. * @param priority Priority to set. */ #define NRFX_IRQ_PRIORITY_SET(irq_number, priority) \ _NRFX_IRQ_PRIORITY_SET(irq_number, priority) static inline void _NRFX_IRQ_PRIORITY_SET(IRQn_Type irq_number, uint8_t priority) { ASSERT(INTERRUPT_PRIORITY_IS_VALID(priority)); NVIC_SetPriority(irq_number, priority); } /** * @brief Macro for enabling a specific IRQ. * * @param irq_number IRQ number. */ #define NRFX_IRQ_ENABLE(irq_number) _NRFX_IRQ_ENABLE(irq_number) static inline void _NRFX_IRQ_ENABLE(IRQn_Type irq_number) { NVIC_EnableIRQ(irq_number); } /** * @brief Macro for checking if a specific IRQ is enabled. * * @param irq_number IRQ number. * * @retval true If the IRQ is enabled. * @retval false Otherwise. */ #define NRFX_IRQ_IS_ENABLED(irq_number) _NRFX_IRQ_IS_ENABLED(irq_number) static inline bool _NRFX_IRQ_IS_ENABLED(IRQn_Type irq_number) { return 0 != (NVIC->ISER[irq_number / 32] & (1UL << (irq_number % 32))); } /** * @brief Macro for disabling a specific IRQ. * * @param irq_number IRQ number. */ #define NRFX_IRQ_DISABLE(irq_number) _NRFX_IRQ_DISABLE(irq_number) static inline void _NRFX_IRQ_DISABLE(IRQn_Type irq_number) { NVIC_DisableIRQ(irq_number); } /** * @brief Macro for setting a specific IRQ as pending. * * @param irq_number IRQ number. */ #define NRFX_IRQ_PENDING_SET(irq_number) _NRFX_IRQ_PENDING_SET(irq_number) static inline void _NRFX_IRQ_PENDING_SET(IRQn_Type irq_number) { NVIC_SetPendingIRQ(irq_number); } /** * @brief Macro for clearing the pending status of a specific IRQ. * * @param irq_number IRQ number. */ #define NRFX_IRQ_PENDING_CLEAR(irq_number) _NRFX_IRQ_PENDING_CLEAR(irq_number) static inline void _NRFX_IRQ_PENDING_CLEAR(IRQn_Type irq_number) { NVIC_ClearPendingIRQ(irq_number); } /** * @brief Macro for checking the pending status of a specific IRQ. * * @retval true If the IRQ is pending. * @retval false Otherwise. */ #define NRFX_IRQ_IS_PENDING(irq_number) _NRFX_IRQ_IS_PENDING(irq_number) static inline bool _NRFX_IRQ_IS_PENDING(IRQn_Type irq_number) { return (NVIC_GetPendingIRQ(irq_number) == 1); } #include #include /** * @brief Macro for entering into a critical section. */ #define NRFX_CRITICAL_SECTION_ENTER() CRITICAL_REGION_ENTER() /** * @brief Macro for exiting from a critical section. */ #define NRFX_CRITICAL_SECTION_EXIT() CRITICAL_REGION_EXIT() //------------------------------------------------------------------------------ /** * @brief When set to a non-zero value, this macro specifies that * @ref nrfx_coredep_delay_us uses a precise DWT-based solution. * A compilation error is generated if the DWT unit is not present * in the SoC used. */ #define NRFX_DELAY_DWT_BASED 0 #include #define NRFX_DELAY_US(us_time) nrfx_coredep_delay_us(us_time) //------------------------------------------------------------------------------ #include /** * @brief Atomic 32 bit unsigned type. */ #define nrfx_atomic_t nrfx_atomic_u32_t /** * @brief Stores value to an atomic object and returns previously stored value. * * @param[in] p_data Atomic memory pointer. * @param[in] value Value to store. * * @return Old value stored into atomic object. */ #define NRFX_ATOMIC_FETCH_STORE(p_data, value) nrfx_atomic_u32_fetch_store(p_data, value) /** * @brief Performs logical OR operation on an atomic object and returns previously stored value. * * @param[in] p_data Atomic memory pointer. * @param[in] value Value of second operand of OR operation. * * @return Old value stored into atomic object. */ #define NRFX_ATOMIC_FETCH_OR(p_data, value) nrfx_atomic_u32_fetch_or(p_data, value) /** * @brief Performs logical AND operation on an atomic object and returns previously stored value. * * @param[in] p_data Atomic memory pointer. * @param[in] value Value of second operand of AND operation. * * @return Old value stored into atomic object. */ #define NRFX_ATOMIC_FETCH_AND(p_data, value) nrfx_atomic_u32_fetch_and(p_data, value) /** * @brief Performs logical XOR operation on an atomic object and returns previously stored value. * * @param[in] p_data Atomic memory pointer. * @param[in] value Value of second operand of XOR operation. * * @return Old value stored into atomic object. */ #define NRFX_ATOMIC_FETCH_XOR(p_data, value) nrfx_atomic_u32_fetch_xor(p_data, value) /** * @brief Performs logical ADD operation on an atomic object and returns previously stored value. * * @param[in] p_data Atomic memory pointer. * @param[in] value Value of second operand of ADD operation. * * @return Old value stored into atomic object. */ #define NRFX_ATOMIC_FETCH_ADD(p_data, value) nrfx_atomic_u32_fetch_add(p_data, value) /** * @brief Performs logical SUB operation on an atomic object and returns previously stored value. * * @param[in] p_data Atomic memory pointer. * @param[in] value Value of second operand of SUB operation. * * @return Old value stored into atomic object. */ #define NRFX_ATOMIC_FETCH_SUB(p_data, value) nrfx_atomic_u32_fetch_sub(p_data, value) //------------------------------------------------------------------------------ #ifndef NRFX_CUSTOM_ERROR_CODES #include /** * @brief When set to a non-zero value, this macro specifies that the * @ref nrfx_error_codes and the @ref ret_code_t type itself are defined * in a customized way and the default definitions from @c * should not be used. */ #define NRFX_CUSTOM_ERROR_CODES 1 typedef ret_code_t nrfx_err_t; #define NRFX_SUCCESS NRF_SUCCESS #define NRFX_ERROR_INTERNAL NRF_ERROR_INTERNAL #define NRFX_ERROR_NO_MEM NRF_ERROR_NO_MEM #define NRFX_ERROR_NOT_SUPPORTED NRF_ERROR_NOT_SUPPORTED #define NRFX_ERROR_INVALID_PARAM NRF_ERROR_INVALID_PARAM #define NRFX_ERROR_INVALID_STATE NRF_ERROR_INVALID_STATE #define NRFX_ERROR_INVALID_LENGTH NRF_ERROR_INVALID_LENGTH #define NRFX_ERROR_TIMEOUT NRF_ERROR_TIMEOUT #define NRFX_ERROR_FORBIDDEN NRF_ERROR_FORBIDDEN #define NRFX_ERROR_NULL NRF_ERROR_NULL #define NRFX_ERROR_INVALID_ADDR NRF_ERROR_INVALID_ADDR #define NRFX_ERROR_BUSY NRF_ERROR_BUSY #define NRFX_ERROR_ALREADY_INITIALIZED NRF_ERROR_MODULE_ALREADY_INITIALIZED #define NRFX_ERROR_DRV_TWI_ERR_OVERRUN NRF_ERROR_DRV_TWI_ERR_OVERRUN #define NRFX_ERROR_DRV_TWI_ERR_ANACK NRF_ERROR_DRV_TWI_ERR_ANACK #define NRFX_ERROR_DRV_TWI_ERR_DNACK NRF_ERROR_DRV_TWI_ERR_DNACK #endif // NRFX_CUSTOM_ERROR_CODES //------------------------------------------------------------------------------ #include /** * @brief Bitmask defining PPI channels reserved to be used outside of nrfx. */ #define NRFX_PPI_CHANNELS_USED NRF_PPI_CHANNELS_USED /** * @brief Bitmask defining PPI groups reserved to be used outside of nrfx. */ #define NRFX_PPI_GROUPS_USED NRF_PPI_GROUPS_USED /** * @brief Bitmask defining SWI instances reserved to be used outside of nrfx. */ #define NRFX_SWI_USED NRF_SWI_USED /** * @brief Bitmask defining TIMER instances reserved to be used outside of nrfx. */ #define NRFX_TIMERS_USED NRF_TIMERS_USED /** @} */ #ifdef __cplusplus } #endif #endif // NRFX_GLUE_H__