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_ARM_STD/nrf_drv_timer.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/timer/nrf_drv_timer.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 | /**@file |
AnnaBridge | 143:86740a56073b | 41 | * @addtogroup nrf_timer Timer HAL and driver |
AnnaBridge | 143:86740a56073b | 42 | * @ingroup nrf_drivers |
AnnaBridge | 143:86740a56073b | 43 | * @brief Timer APIs. |
AnnaBridge | 143:86740a56073b | 44 | * @details The timer HAL provides basic APIs for accessing the registers |
AnnaBridge | 143:86740a56073b | 45 | * of the timer. The timer driver provides APIs on a higher level. |
AnnaBridge | 143:86740a56073b | 46 | * |
AnnaBridge | 143:86740a56073b | 47 | * @defgroup lib_driver_timer Timer driver |
AnnaBridge | 143:86740a56073b | 48 | * @{ |
AnnaBridge | 143:86740a56073b | 49 | * @ingroup nrf_timer |
AnnaBridge | 143:86740a56073b | 50 | * @brief Multi-instance timer driver. |
AnnaBridge | 143:86740a56073b | 51 | */ |
AnnaBridge | 143:86740a56073b | 52 | |
AnnaBridge | 143:86740a56073b | 53 | #ifndef NRF_DRV_TIMER_H__ |
AnnaBridge | 143:86740a56073b | 54 | #define NRF_DRV_TIMER_H__ |
AnnaBridge | 143:86740a56073b | 55 | |
AnnaBridge | 143:86740a56073b | 56 | #include "nordic_common.h" |
AnnaBridge | 143:86740a56073b | 57 | #include "nrf_drv_config.h" |
AnnaBridge | 143:86740a56073b | 58 | #include "nrf_timer.h" |
AnnaBridge | 143:86740a56073b | 59 | #include "sdk_errors.h" |
AnnaBridge | 143:86740a56073b | 60 | #include "nrf_assert.h" |
AnnaBridge | 143:86740a56073b | 61 | |
AnnaBridge | 143:86740a56073b | 62 | /** |
AnnaBridge | 143:86740a56073b | 63 | * @brief Timer driver instance data structure. |
AnnaBridge | 143:86740a56073b | 64 | */ |
AnnaBridge | 143:86740a56073b | 65 | typedef struct |
AnnaBridge | 143:86740a56073b | 66 | { |
AnnaBridge | 143:86740a56073b | 67 | NRF_TIMER_Type * p_reg; ///< Pointer to the structure with TIMER peripheral instance registers. |
AnnaBridge | 143:86740a56073b | 68 | uint8_t instance_id; ///< Driver instance index. |
AnnaBridge | 143:86740a56073b | 69 | uint8_t cc_channel_count; ///< Number of capture/compare channels. |
AnnaBridge | 143:86740a56073b | 70 | } nrf_drv_timer_t; |
AnnaBridge | 143:86740a56073b | 71 | |
AnnaBridge | 143:86740a56073b | 72 | /** |
AnnaBridge | 143:86740a56073b | 73 | * @brief Macro for creating a timer driver instance. |
AnnaBridge | 143:86740a56073b | 74 | */ |
AnnaBridge | 143:86740a56073b | 75 | #define NRF_DRV_TIMER_INSTANCE(id) \ |
AnnaBridge | 143:86740a56073b | 76 | { \ |
AnnaBridge | 143:86740a56073b | 77 | .p_reg = CONCAT_2(NRF_TIMER, id), \ |
AnnaBridge | 143:86740a56073b | 78 | .instance_id = CONCAT_3(TIMER, id, _INSTANCE_INDEX), \ |
AnnaBridge | 143:86740a56073b | 79 | .cc_channel_count = NRF_TIMER_CC_CHANNEL_COUNT(id), \ |
AnnaBridge | 143:86740a56073b | 80 | } |
AnnaBridge | 143:86740a56073b | 81 | |
AnnaBridge | 143:86740a56073b | 82 | /** |
AnnaBridge | 143:86740a56073b | 83 | * @brief Timer driver instance configuration structure. |
AnnaBridge | 143:86740a56073b | 84 | */ |
AnnaBridge | 143:86740a56073b | 85 | typedef struct |
AnnaBridge | 143:86740a56073b | 86 | { |
AnnaBridge | 143:86740a56073b | 87 | nrf_timer_frequency_t frequency; ///< Frequency. |
AnnaBridge | 143:86740a56073b | 88 | nrf_timer_mode_t mode; ///< Mode of operation. |
AnnaBridge | 143:86740a56073b | 89 | nrf_timer_bit_width_t bit_width; ///< Bit width. |
AnnaBridge | 143:86740a56073b | 90 | uint8_t interrupt_priority; ///< Interrupt priority. |
AnnaBridge | 143:86740a56073b | 91 | void * p_context; ///< Context passed to interrupt handler. |
AnnaBridge | 143:86740a56073b | 92 | } nrf_drv_timer_config_t; |
AnnaBridge | 143:86740a56073b | 93 | |
AnnaBridge | 143:86740a56073b | 94 | #define TIMER_CONFIG_FREQUENCY(id) CONCAT_3(TIMER, id, _CONFIG_FREQUENCY) |
AnnaBridge | 143:86740a56073b | 95 | #define TIMER_CONFIG_MODE(id) CONCAT_3(TIMER, id, _CONFIG_MODE) |
AnnaBridge | 143:86740a56073b | 96 | #define TIMER_CONFIG_BIT_WIDTH(id) CONCAT_3(TIMER, id, _CONFIG_BIT_WIDTH) |
AnnaBridge | 143:86740a56073b | 97 | #define TIMER_CONFIG_IRQ_PRIORITY(id) CONCAT_3(TIMER, id, _CONFIG_IRQ_PRIORITY) |
AnnaBridge | 143:86740a56073b | 98 | |
AnnaBridge | 143:86740a56073b | 99 | /** |
AnnaBridge | 143:86740a56073b | 100 | * @brief Timer driver instance default configuration. |
AnnaBridge | 143:86740a56073b | 101 | */ |
AnnaBridge | 143:86740a56073b | 102 | #define NRF_DRV_TIMER_DEFAULT_CONFIG(id) \ |
AnnaBridge | 143:86740a56073b | 103 | { \ |
AnnaBridge | 143:86740a56073b | 104 | .frequency = TIMER_CONFIG_FREQUENCY(id), \ |
AnnaBridge | 143:86740a56073b | 105 | .mode = (nrf_timer_mode_t)TIMER_CONFIG_MODE(id), \ |
AnnaBridge | 143:86740a56073b | 106 | .bit_width = (nrf_timer_bit_width_t)TIMER_CONFIG_BIT_WIDTH(id), \ |
AnnaBridge | 143:86740a56073b | 107 | .interrupt_priority = TIMER_CONFIG_IRQ_PRIORITY(id), \ |
AnnaBridge | 143:86740a56073b | 108 | .p_context = NULL \ |
AnnaBridge | 143:86740a56073b | 109 | } |
AnnaBridge | 143:86740a56073b | 110 | |
AnnaBridge | 143:86740a56073b | 111 | /** |
AnnaBridge | 143:86740a56073b | 112 | * @brief Timer driver event handler type. |
AnnaBridge | 143:86740a56073b | 113 | * |
AnnaBridge | 143:86740a56073b | 114 | * @param[in] event_type Timer event. |
AnnaBridge | 143:86740a56073b | 115 | * @param[in] p_context General purpose parameter set during initialization of |
AnnaBridge | 143:86740a56073b | 116 | * the timer. This parameter can be used to pass |
AnnaBridge | 143:86740a56073b | 117 | * additional information to the handler function, for |
AnnaBridge | 143:86740a56073b | 118 | * example, the timer ID. |
AnnaBridge | 143:86740a56073b | 119 | */ |
AnnaBridge | 143:86740a56073b | 120 | typedef void (* nrf_timer_event_handler_t)(nrf_timer_event_t event_type, |
AnnaBridge | 143:86740a56073b | 121 | void * p_context); |
AnnaBridge | 143:86740a56073b | 122 | |
AnnaBridge | 143:86740a56073b | 123 | /** |
AnnaBridge | 143:86740a56073b | 124 | * @brief Function for initializing the timer. |
AnnaBridge | 143:86740a56073b | 125 | * |
AnnaBridge | 143:86740a56073b | 126 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 127 | * @param[in] p_config Initial configuration. |
AnnaBridge | 143:86740a56073b | 128 | * If NULL, the default configuration is used. |
AnnaBridge | 143:86740a56073b | 129 | * @param[in] timer_event_handler Event handler provided by the user. |
AnnaBridge | 143:86740a56073b | 130 | * Must not be NULL. |
AnnaBridge | 143:86740a56073b | 131 | * |
AnnaBridge | 143:86740a56073b | 132 | * @retval NRF_SUCCESS If initialization was successful. |
AnnaBridge | 143:86740a56073b | 133 | * @retval NRF_ERROR_INVALID_STATE If the instance is already initialized. |
AnnaBridge | 143:86740a56073b | 134 | * @retval NRF_ERROR_INVALID_PARAM If no handler was provided. |
AnnaBridge | 143:86740a56073b | 135 | */ |
AnnaBridge | 143:86740a56073b | 136 | ret_code_t nrf_drv_timer_init(nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 137 | nrf_drv_timer_config_t const * p_config, |
AnnaBridge | 143:86740a56073b | 138 | nrf_timer_event_handler_t timer_event_handler); |
AnnaBridge | 143:86740a56073b | 139 | |
AnnaBridge | 143:86740a56073b | 140 | /** |
AnnaBridge | 143:86740a56073b | 141 | * @brief Function for uninitializing the timer. |
AnnaBridge | 143:86740a56073b | 142 | * |
AnnaBridge | 143:86740a56073b | 143 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 144 | */ |
AnnaBridge | 143:86740a56073b | 145 | void nrf_drv_timer_uninit(nrf_drv_timer_t const * const p_instance); |
AnnaBridge | 143:86740a56073b | 146 | |
AnnaBridge | 143:86740a56073b | 147 | /** |
AnnaBridge | 143:86740a56073b | 148 | * @brief Function for turning on the timer. |
AnnaBridge | 143:86740a56073b | 149 | * |
AnnaBridge | 143:86740a56073b | 150 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 151 | */ |
AnnaBridge | 143:86740a56073b | 152 | void nrf_drv_timer_enable(nrf_drv_timer_t const * const p_instance); |
AnnaBridge | 143:86740a56073b | 153 | |
AnnaBridge | 143:86740a56073b | 154 | /** |
AnnaBridge | 143:86740a56073b | 155 | * @brief Function for turning off the timer. |
AnnaBridge | 143:86740a56073b | 156 | * |
AnnaBridge | 143:86740a56073b | 157 | * Note that the timer will allow to enter the lowest possible SYSTEM_ON state |
AnnaBridge | 143:86740a56073b | 158 | * only after this function is called. |
AnnaBridge | 143:86740a56073b | 159 | * |
AnnaBridge | 143:86740a56073b | 160 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 161 | */ |
AnnaBridge | 143:86740a56073b | 162 | void nrf_drv_timer_disable(nrf_drv_timer_t const * const p_instance); |
AnnaBridge | 143:86740a56073b | 163 | |
AnnaBridge | 143:86740a56073b | 164 | /** |
AnnaBridge | 143:86740a56073b | 165 | * @brief Function for pausing the timer. |
AnnaBridge | 143:86740a56073b | 166 | * |
AnnaBridge | 143:86740a56073b | 167 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 168 | */ |
AnnaBridge | 143:86740a56073b | 169 | void nrf_drv_timer_pause(nrf_drv_timer_t const * const p_instance); |
AnnaBridge | 143:86740a56073b | 170 | |
AnnaBridge | 143:86740a56073b | 171 | /** |
AnnaBridge | 143:86740a56073b | 172 | * @brief Function for resuming the timer. |
AnnaBridge | 143:86740a56073b | 173 | * |
AnnaBridge | 143:86740a56073b | 174 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 175 | */ |
AnnaBridge | 143:86740a56073b | 176 | void nrf_drv_timer_resume(nrf_drv_timer_t const * const p_instance); |
AnnaBridge | 143:86740a56073b | 177 | |
AnnaBridge | 143:86740a56073b | 178 | /** |
AnnaBridge | 143:86740a56073b | 179 | * @brief Function for clearing the timer. |
AnnaBridge | 143:86740a56073b | 180 | * |
AnnaBridge | 143:86740a56073b | 181 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 182 | */ |
AnnaBridge | 143:86740a56073b | 183 | void nrf_drv_timer_clear(nrf_drv_timer_t const * const p_instance); |
AnnaBridge | 143:86740a56073b | 184 | |
AnnaBridge | 143:86740a56073b | 185 | /** |
AnnaBridge | 143:86740a56073b | 186 | * @brief Function for incrementing the timer. |
AnnaBridge | 143:86740a56073b | 187 | * |
AnnaBridge | 143:86740a56073b | 188 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 189 | */ |
AnnaBridge | 143:86740a56073b | 190 | void nrf_drv_timer_increment(nrf_drv_timer_t const * const p_instance); |
AnnaBridge | 143:86740a56073b | 191 | |
AnnaBridge | 143:86740a56073b | 192 | /** |
AnnaBridge | 143:86740a56073b | 193 | * @brief Function for returning the address of a specific timer task. |
AnnaBridge | 143:86740a56073b | 194 | * |
AnnaBridge | 143:86740a56073b | 195 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 196 | * @param[in] timer_task Timer task. |
AnnaBridge | 143:86740a56073b | 197 | * |
AnnaBridge | 143:86740a56073b | 198 | * @return Task address. |
AnnaBridge | 143:86740a56073b | 199 | */ |
AnnaBridge | 143:86740a56073b | 200 | __STATIC_INLINE uint32_t nrf_drv_timer_task_address_get( |
AnnaBridge | 143:86740a56073b | 201 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 202 | nrf_timer_task_t timer_task); |
AnnaBridge | 143:86740a56073b | 203 | |
AnnaBridge | 143:86740a56073b | 204 | /** |
AnnaBridge | 143:86740a56073b | 205 | * @brief Function for returning the address of a specific timer capture task. |
AnnaBridge | 143:86740a56073b | 206 | * |
AnnaBridge | 143:86740a56073b | 207 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 208 | * @param[in] channel Capture channel number. |
AnnaBridge | 143:86740a56073b | 209 | * |
AnnaBridge | 143:86740a56073b | 210 | * @return Task address. |
AnnaBridge | 143:86740a56073b | 211 | */ |
AnnaBridge | 143:86740a56073b | 212 | __STATIC_INLINE uint32_t nrf_drv_timer_capture_task_address_get( |
AnnaBridge | 143:86740a56073b | 213 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 214 | uint32_t channel); |
AnnaBridge | 143:86740a56073b | 215 | |
AnnaBridge | 143:86740a56073b | 216 | /** |
AnnaBridge | 143:86740a56073b | 217 | * @brief Function for returning the address of a specific timer event. |
AnnaBridge | 143:86740a56073b | 218 | * |
AnnaBridge | 143:86740a56073b | 219 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 220 | * @param[in] timer_event Timer event. |
AnnaBridge | 143:86740a56073b | 221 | * |
AnnaBridge | 143:86740a56073b | 222 | * @return Event address. |
AnnaBridge | 143:86740a56073b | 223 | */ |
AnnaBridge | 143:86740a56073b | 224 | __STATIC_INLINE uint32_t nrf_drv_timer_event_address_get( |
AnnaBridge | 143:86740a56073b | 225 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 226 | nrf_timer_event_t timer_event); |
AnnaBridge | 143:86740a56073b | 227 | |
AnnaBridge | 143:86740a56073b | 228 | /** |
AnnaBridge | 143:86740a56073b | 229 | * @brief Function for returning the address of a specific timer compare event. |
AnnaBridge | 143:86740a56073b | 230 | * |
AnnaBridge | 143:86740a56073b | 231 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 232 | * @param[in] channel Compare channel number. |
AnnaBridge | 143:86740a56073b | 233 | * |
AnnaBridge | 143:86740a56073b | 234 | * @return Event address. |
AnnaBridge | 143:86740a56073b | 235 | */ |
AnnaBridge | 143:86740a56073b | 236 | __STATIC_INLINE uint32_t nrf_drv_timer_compare_event_address_get( |
AnnaBridge | 143:86740a56073b | 237 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 238 | uint32_t channel); |
AnnaBridge | 143:86740a56073b | 239 | |
AnnaBridge | 143:86740a56073b | 240 | /** |
AnnaBridge | 143:86740a56073b | 241 | * @brief Function for capturing the timer value. |
AnnaBridge | 143:86740a56073b | 242 | * |
AnnaBridge | 143:86740a56073b | 243 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 244 | * @param[in] cc_channel Capture channel number. |
AnnaBridge | 143:86740a56073b | 245 | * |
AnnaBridge | 143:86740a56073b | 246 | * @return Captured value. |
AnnaBridge | 143:86740a56073b | 247 | */ |
AnnaBridge | 143:86740a56073b | 248 | uint32_t nrf_drv_timer_capture(nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 249 | nrf_timer_cc_channel_t cc_channel); |
AnnaBridge | 143:86740a56073b | 250 | |
AnnaBridge | 143:86740a56073b | 251 | /** |
AnnaBridge | 143:86740a56073b | 252 | * @brief Function for returning the capture value from a specific channel. |
AnnaBridge | 143:86740a56073b | 253 | * |
AnnaBridge | 143:86740a56073b | 254 | * Use this function to read channel values when PPI is used for capturing. |
AnnaBridge | 143:86740a56073b | 255 | * |
AnnaBridge | 143:86740a56073b | 256 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 257 | * @param[in] cc_channel Capture channel number. |
AnnaBridge | 143:86740a56073b | 258 | * |
AnnaBridge | 143:86740a56073b | 259 | * @return Captured value. |
AnnaBridge | 143:86740a56073b | 260 | */ |
AnnaBridge | 143:86740a56073b | 261 | __STATIC_INLINE uint32_t nrf_drv_timer_capture_get( |
AnnaBridge | 143:86740a56073b | 262 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 263 | nrf_timer_cc_channel_t cc_channel); |
AnnaBridge | 143:86740a56073b | 264 | |
AnnaBridge | 143:86740a56073b | 265 | /** |
AnnaBridge | 143:86740a56073b | 266 | * @brief Function for setting the timer channel in compare mode. |
AnnaBridge | 143:86740a56073b | 267 | * |
AnnaBridge | 143:86740a56073b | 268 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 269 | * @param[in] cc_channel Compare channel number. |
AnnaBridge | 143:86740a56073b | 270 | * @param[in] cc_value Compare value. |
AnnaBridge | 143:86740a56073b | 271 | * @param[in] enable_int Enable or disable the interrupt for the compare channel. |
AnnaBridge | 143:86740a56073b | 272 | */ |
AnnaBridge | 143:86740a56073b | 273 | void nrf_drv_timer_compare(nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 274 | nrf_timer_cc_channel_t cc_channel, |
AnnaBridge | 143:86740a56073b | 275 | uint32_t cc_value, |
AnnaBridge | 143:86740a56073b | 276 | bool enable_int); |
AnnaBridge | 143:86740a56073b | 277 | |
AnnaBridge | 143:86740a56073b | 278 | /** |
AnnaBridge | 143:86740a56073b | 279 | * @brief Function for setting the timer channel in extended compare mode. |
AnnaBridge | 143:86740a56073b | 280 | * |
AnnaBridge | 143:86740a56073b | 281 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 282 | * @param[in] cc_channel Compare channel number. |
AnnaBridge | 143:86740a56073b | 283 | * @param[in] cc_value Compare value. |
AnnaBridge | 143:86740a56073b | 284 | * @param[in] timer_short_mask Shortcut between the compare event on the channel |
AnnaBridge | 143:86740a56073b | 285 | * and the timer task (STOP or CLEAR). |
AnnaBridge | 143:86740a56073b | 286 | * @param[in] enable_int Enable or disable the interrupt for the compare |
AnnaBridge | 143:86740a56073b | 287 | * channel. |
AnnaBridge | 143:86740a56073b | 288 | */ |
AnnaBridge | 143:86740a56073b | 289 | void nrf_drv_timer_extended_compare(nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 290 | nrf_timer_cc_channel_t cc_channel, |
AnnaBridge | 143:86740a56073b | 291 | uint32_t cc_value, |
AnnaBridge | 143:86740a56073b | 292 | nrf_timer_short_mask_t timer_short_mask, |
AnnaBridge | 143:86740a56073b | 293 | bool enable_int); |
AnnaBridge | 143:86740a56073b | 294 | |
AnnaBridge | 143:86740a56073b | 295 | /** |
AnnaBridge | 143:86740a56073b | 296 | * @brief Function for converting time in microseconds to timer ticks. |
AnnaBridge | 143:86740a56073b | 297 | * |
AnnaBridge | 143:86740a56073b | 298 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 299 | * @param[in] time_us Time in microseconds. |
AnnaBridge | 143:86740a56073b | 300 | * |
AnnaBridge | 143:86740a56073b | 301 | * @return Number of ticks. |
AnnaBridge | 143:86740a56073b | 302 | */ |
AnnaBridge | 143:86740a56073b | 303 | __STATIC_INLINE uint32_t nrf_drv_timer_us_to_ticks( |
AnnaBridge | 143:86740a56073b | 304 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 305 | uint32_t time_us); |
AnnaBridge | 143:86740a56073b | 306 | |
AnnaBridge | 143:86740a56073b | 307 | /** |
AnnaBridge | 143:86740a56073b | 308 | * @brief Function for converting time in milliseconds to timer ticks. |
AnnaBridge | 143:86740a56073b | 309 | * |
AnnaBridge | 143:86740a56073b | 310 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 311 | * @param[in] time_ms Time in milliseconds. |
AnnaBridge | 143:86740a56073b | 312 | * |
AnnaBridge | 143:86740a56073b | 313 | * @return Number of ticks. |
AnnaBridge | 143:86740a56073b | 314 | */ |
AnnaBridge | 143:86740a56073b | 315 | __STATIC_INLINE uint32_t nrf_drv_timer_ms_to_ticks( |
AnnaBridge | 143:86740a56073b | 316 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 317 | uint32_t time_ms); |
AnnaBridge | 143:86740a56073b | 318 | |
AnnaBridge | 143:86740a56073b | 319 | /** |
AnnaBridge | 143:86740a56073b | 320 | * @brief Function for enabling timer compare interrupt. |
AnnaBridge | 143:86740a56073b | 321 | * |
AnnaBridge | 143:86740a56073b | 322 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 323 | * @param[in] channel Compare channel. |
AnnaBridge | 143:86740a56073b | 324 | */ |
AnnaBridge | 143:86740a56073b | 325 | void nrf_drv_timer_compare_int_enable(nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 326 | uint32_t channel); |
AnnaBridge | 143:86740a56073b | 327 | |
AnnaBridge | 143:86740a56073b | 328 | /** |
AnnaBridge | 143:86740a56073b | 329 | * @brief Function for disabling timer compare interrupt. |
AnnaBridge | 143:86740a56073b | 330 | * |
AnnaBridge | 143:86740a56073b | 331 | * @param[in] p_instance Timer instance. |
AnnaBridge | 143:86740a56073b | 332 | * @param[in] channel Compare channel. |
AnnaBridge | 143:86740a56073b | 333 | */ |
AnnaBridge | 143:86740a56073b | 334 | void nrf_drv_timer_compare_int_disable(nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 335 | uint32_t channel); |
AnnaBridge | 143:86740a56073b | 336 | |
AnnaBridge | 143:86740a56073b | 337 | |
AnnaBridge | 143:86740a56073b | 338 | #ifndef SUPPRESS_INLINE_IMPLEMENTATION |
AnnaBridge | 143:86740a56073b | 339 | |
AnnaBridge | 143:86740a56073b | 340 | __STATIC_INLINE uint32_t nrf_drv_timer_task_address_get( |
AnnaBridge | 143:86740a56073b | 341 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 342 | nrf_timer_task_t timer_task) |
AnnaBridge | 143:86740a56073b | 343 | { |
AnnaBridge | 143:86740a56073b | 344 | return (uint32_t)nrf_timer_task_address_get(p_instance->p_reg, timer_task); |
AnnaBridge | 143:86740a56073b | 345 | } |
AnnaBridge | 143:86740a56073b | 346 | |
AnnaBridge | 143:86740a56073b | 347 | __STATIC_INLINE uint32_t nrf_drv_timer_capture_task_address_get( |
AnnaBridge | 143:86740a56073b | 348 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 349 | uint32_t channel) |
AnnaBridge | 143:86740a56073b | 350 | { |
AnnaBridge | 143:86740a56073b | 351 | ASSERT(channel < p_instance->cc_channel_count); |
AnnaBridge | 143:86740a56073b | 352 | return (uint32_t)nrf_timer_task_address_get(p_instance->p_reg, |
AnnaBridge | 143:86740a56073b | 353 | nrf_timer_capture_task_get(channel)); |
AnnaBridge | 143:86740a56073b | 354 | } |
AnnaBridge | 143:86740a56073b | 355 | |
AnnaBridge | 143:86740a56073b | 356 | __STATIC_INLINE uint32_t nrf_drv_timer_event_address_get( |
AnnaBridge | 143:86740a56073b | 357 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 358 | nrf_timer_event_t timer_event) |
AnnaBridge | 143:86740a56073b | 359 | { |
AnnaBridge | 143:86740a56073b | 360 | return (uint32_t)nrf_timer_event_address_get(p_instance->p_reg, timer_event); |
AnnaBridge | 143:86740a56073b | 361 | } |
AnnaBridge | 143:86740a56073b | 362 | |
AnnaBridge | 143:86740a56073b | 363 | __STATIC_INLINE uint32_t nrf_drv_timer_compare_event_address_get( |
AnnaBridge | 143:86740a56073b | 364 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 365 | uint32_t channel) |
AnnaBridge | 143:86740a56073b | 366 | { |
AnnaBridge | 143:86740a56073b | 367 | ASSERT(channel < p_instance->cc_channel_count); |
AnnaBridge | 143:86740a56073b | 368 | return (uint32_t)nrf_timer_event_address_get(p_instance->p_reg, |
AnnaBridge | 143:86740a56073b | 369 | nrf_timer_compare_event_get(channel)); |
AnnaBridge | 143:86740a56073b | 370 | } |
AnnaBridge | 143:86740a56073b | 371 | |
AnnaBridge | 143:86740a56073b | 372 | __STATIC_INLINE uint32_t nrf_drv_timer_capture_get( |
AnnaBridge | 143:86740a56073b | 373 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 374 | nrf_timer_cc_channel_t cc_channel) |
AnnaBridge | 143:86740a56073b | 375 | { |
AnnaBridge | 143:86740a56073b | 376 | return nrf_timer_cc_read(p_instance->p_reg, cc_channel); |
AnnaBridge | 143:86740a56073b | 377 | } |
AnnaBridge | 143:86740a56073b | 378 | |
AnnaBridge | 143:86740a56073b | 379 | __STATIC_INLINE uint32_t nrf_drv_timer_us_to_ticks( |
AnnaBridge | 143:86740a56073b | 380 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 381 | uint32_t timer_us) |
AnnaBridge | 143:86740a56073b | 382 | { |
AnnaBridge | 143:86740a56073b | 383 | return nrf_timer_us_to_ticks(timer_us, |
AnnaBridge | 143:86740a56073b | 384 | nrf_timer_frequency_get(p_instance->p_reg)); |
AnnaBridge | 143:86740a56073b | 385 | } |
AnnaBridge | 143:86740a56073b | 386 | |
AnnaBridge | 143:86740a56073b | 387 | __STATIC_INLINE uint32_t nrf_drv_timer_ms_to_ticks( |
AnnaBridge | 143:86740a56073b | 388 | nrf_drv_timer_t const * const p_instance, |
AnnaBridge | 143:86740a56073b | 389 | uint32_t timer_ms) |
AnnaBridge | 143:86740a56073b | 390 | { |
AnnaBridge | 143:86740a56073b | 391 | return nrf_timer_ms_to_ticks(timer_ms, |
AnnaBridge | 143:86740a56073b | 392 | nrf_timer_frequency_get(p_instance->p_reg)); |
AnnaBridge | 143:86740a56073b | 393 | } |
AnnaBridge | 143:86740a56073b | 394 | |
AnnaBridge | 143:86740a56073b | 395 | #endif // SUPPRESS_INLINE_IMPLEMENTATION |
AnnaBridge | 143:86740a56073b | 396 | |
AnnaBridge | 143:86740a56073b | 397 | #endif // NRF_DRV_TIMER_H__ |
AnnaBridge | 143:86740a56073b | 398 | |
AnnaBridge | 143:86740a56073b | 399 | /** @} */ |