1 /* 2 * Copyright (c) 2021 - 2024, Nordic Semiconductor ASA 3 * All rights reserved. 4 * 5 * SPDX-License-Identifier: BSD-3-Clause 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions are met: 9 * 10 * 1. Redistributions of source code must retain the above copyright notice, this 11 * list of conditions and the following disclaimer. 12 * 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * 3. Neither the name of the copyright holder nor the names of its 18 * contributors may be used to endorse or promote products derived from this 19 * software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #ifndef NRFY_COMMON_H__ 35 #define NRFY_COMMON_H__ 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 /** 42 * @defgroup nrfy_common Common nrfy module 43 * @{ 44 * @ingroup nrfx 45 * @brief Common nrfy module. 46 */ 47 48 /** 49 * @brief Macro for calculating interrupt bit position associated with the specified event. 50 * 51 * @param[in] event Event. 52 * 53 * @return Interrupt bit position. 54 */ 55 #define NRFY_EVENT_TO_INT_BITPOS(event) ((((uint32_t)(event)) - 0x100) >> 2) 56 57 /** 58 * @brief Macro for converting interrupt bit position to the specified event. 59 * 60 * @param[in] bitpos Interrupt bit position. 61 * 62 * @return Event. 63 */ 64 #define NRFY_INT_BITPOS_TO_EVENT(bitpos) (((bitpos) << 2) + 0x100) 65 66 /** 67 * @brief Macro for calculating interrupt bitmask associated with the specified event. 68 * 69 * @param[in] event Event. 70 * 71 * @return Interrupt bitmask. 72 */ 73 #define NRFY_EVENT_TO_INT_BITMASK(event) (1U << NRFY_EVENT_TO_INT_BITPOS(event)) 74 75 /** @sa NRFX_IRQ_PRIORITY_SET */ 76 #define NRFY_IRQ_PRIORITY_SET(irq_number, priority) NRFX_IRQ_PRIORITY_SET(irq_number, priority) 77 78 /** @sa NRFX_IRQ_ENABLE */ 79 #define NRFY_IRQ_ENABLE(irq_number) NRFX_IRQ_ENABLE(irq_number) 80 81 /** @sa NRFX_IRQ_IS_ENABLED */ 82 #define NRFY_IRQ_IS_ENABLED(irq_number) NRFX_IRQ_IS_ENABLED(irq_number) 83 84 /** @sa NRFX_IRQ_DISABLE */ 85 #define NRFY_IRQ_DISABLE(irq_number) NRFX_IRQ_DISABLE(irq_number) 86 87 /** @sa NRFX_IRQ_PENDING_SET */ 88 #define NRFY_IRQ_PENDING_SET(irq_number) NRFX_IRQ_PENDING_SET(irq_number) 89 90 /** @sa NRFX_IRQ_PENDING_CLEAR */ 91 #define NRFY_IRQ_PENDING_CLEAR(irq_number) NRFX_IRQ_PENDING_CLEAR(irq_number) 92 93 /** @sa NRFX_IRQ_IS_PENDING */ 94 #define NRFY_IRQ_IS_PENDING(irq_number) NRFX_IRQ_IS_PENDING(irq_number) 95 96 /** @sa NRFX_CRITICAL_SECTION_ENTER */ 97 #define NRFY_CRITICAL_SECTION_ENTER() NRFX_CRITICAL_SECTION_ENTER() 98 99 /** @sa NRFX_CRITICAL_SECTION_EXIT */ 100 #define NRFY_CRITICAL_SECTION_EXIT() NRFX_CRITICAL_SECTION_EXIT() 101 102 /** @} */ 103 104 #ifdef __cplusplus 105 } 106 #endif 107 108 #endif // NRFY_COMMON_H__ 109