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_FF_LPC546XX/TOOLCHAIN_GCC_ARM/fsl_mrt.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?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 171:3a7713b1edbc | 1 | /* |
AnnaBridge | 171:3a7713b1edbc | 2 | * The Clear BSD License |
AnnaBridge | 171:3a7713b1edbc | 3 | * Copyright (c) 2016, Freescale Semiconductor, Inc. |
AnnaBridge | 171:3a7713b1edbc | 4 | * Copyright 2016-2017 NXP |
AnnaBridge | 171:3a7713b1edbc | 5 | * All rights reserved. |
AnnaBridge | 171:3a7713b1edbc | 6 | * |
AnnaBridge | 171:3a7713b1edbc | 7 | * Redistribution and use in source and binary forms, with or without modification, |
AnnaBridge | 171:3a7713b1edbc | 8 | * are permitted (subject to the limitations in the disclaimer below) provided |
AnnaBridge | 171:3a7713b1edbc | 9 | * that the following conditions are met: |
AnnaBridge | 171:3a7713b1edbc | 10 | * |
AnnaBridge | 171:3a7713b1edbc | 11 | * o Redistributions of source code must retain the above copyright notice, this list |
AnnaBridge | 171:3a7713b1edbc | 12 | * of conditions and the following disclaimer. |
AnnaBridge | 171:3a7713b1edbc | 13 | * |
AnnaBridge | 171:3a7713b1edbc | 14 | * o Redistributions in binary form must reproduce the above copyright notice, this |
AnnaBridge | 171:3a7713b1edbc | 15 | * list of conditions and the following disclaimer in the documentation and/or |
AnnaBridge | 171:3a7713b1edbc | 16 | * other materials provided with the distribution. |
AnnaBridge | 171:3a7713b1edbc | 17 | * |
AnnaBridge | 171:3a7713b1edbc | 18 | * o Neither the name of the copyright holder nor the names of its |
AnnaBridge | 171:3a7713b1edbc | 19 | * contributors may be used to endorse or promote products derived from this |
AnnaBridge | 171:3a7713b1edbc | 20 | * software without specific prior written permission. |
AnnaBridge | 171:3a7713b1edbc | 21 | * |
AnnaBridge | 171:3a7713b1edbc | 22 | * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. |
AnnaBridge | 171:3a7713b1edbc | 23 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
AnnaBridge | 171:3a7713b1edbc | 24 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
AnnaBridge | 171:3a7713b1edbc | 25 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
AnnaBridge | 171:3a7713b1edbc | 26 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
AnnaBridge | 171:3a7713b1edbc | 27 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
AnnaBridge | 171:3a7713b1edbc | 28 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
AnnaBridge | 171:3a7713b1edbc | 29 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
AnnaBridge | 171:3a7713b1edbc | 30 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
AnnaBridge | 171:3a7713b1edbc | 31 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
AnnaBridge | 171:3a7713b1edbc | 32 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
AnnaBridge | 171:3a7713b1edbc | 33 | */ |
AnnaBridge | 171:3a7713b1edbc | 34 | #ifndef _FSL_MRT_H_ |
AnnaBridge | 171:3a7713b1edbc | 35 | #define _FSL_MRT_H_ |
AnnaBridge | 171:3a7713b1edbc | 36 | |
AnnaBridge | 171:3a7713b1edbc | 37 | #include "fsl_common.h" |
AnnaBridge | 171:3a7713b1edbc | 38 | |
AnnaBridge | 171:3a7713b1edbc | 39 | /*! |
AnnaBridge | 171:3a7713b1edbc | 40 | * @addtogroup mrt |
AnnaBridge | 171:3a7713b1edbc | 41 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 42 | */ |
AnnaBridge | 171:3a7713b1edbc | 43 | |
AnnaBridge | 171:3a7713b1edbc | 44 | /*! @file */ |
AnnaBridge | 171:3a7713b1edbc | 45 | |
AnnaBridge | 171:3a7713b1edbc | 46 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 47 | * Definitions |
AnnaBridge | 171:3a7713b1edbc | 48 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 49 | |
AnnaBridge | 171:3a7713b1edbc | 50 | /*! @name Driver version */ |
AnnaBridge | 171:3a7713b1edbc | 51 | /*@{*/ |
AnnaBridge | 171:3a7713b1edbc | 52 | #define FSL_MRT_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) /*!< Version 2.0.0 */ |
AnnaBridge | 171:3a7713b1edbc | 53 | /*@}*/ |
AnnaBridge | 171:3a7713b1edbc | 54 | |
AnnaBridge | 171:3a7713b1edbc | 55 | /*! @brief List of MRT channels */ |
AnnaBridge | 171:3a7713b1edbc | 56 | typedef enum _mrt_chnl |
AnnaBridge | 171:3a7713b1edbc | 57 | { |
AnnaBridge | 171:3a7713b1edbc | 58 | kMRT_Channel_0 = 0U, /*!< MRT channel number 0*/ |
AnnaBridge | 171:3a7713b1edbc | 59 | kMRT_Channel_1, /*!< MRT channel number 1 */ |
AnnaBridge | 171:3a7713b1edbc | 60 | kMRT_Channel_2, /*!< MRT channel number 2 */ |
AnnaBridge | 171:3a7713b1edbc | 61 | kMRT_Channel_3 /*!< MRT channel number 3 */ |
AnnaBridge | 171:3a7713b1edbc | 62 | } mrt_chnl_t; |
AnnaBridge | 171:3a7713b1edbc | 63 | |
AnnaBridge | 171:3a7713b1edbc | 64 | /*! @brief List of MRT timer modes */ |
AnnaBridge | 171:3a7713b1edbc | 65 | typedef enum _mrt_timer_mode |
AnnaBridge | 171:3a7713b1edbc | 66 | { |
AnnaBridge | 171:3a7713b1edbc | 67 | kMRT_RepeatMode = (0 << MRT_CHANNEL_CTRL_MODE_SHIFT), /*!< Repeat Interrupt mode */ |
AnnaBridge | 171:3a7713b1edbc | 68 | kMRT_OneShotMode = (1 << MRT_CHANNEL_CTRL_MODE_SHIFT), /*!< One-shot Interrupt mode */ |
AnnaBridge | 171:3a7713b1edbc | 69 | kMRT_OneShotStallMode = (2 << MRT_CHANNEL_CTRL_MODE_SHIFT) /*!< One-shot stall mode */ |
AnnaBridge | 171:3a7713b1edbc | 70 | } mrt_timer_mode_t; |
AnnaBridge | 171:3a7713b1edbc | 71 | |
AnnaBridge | 171:3a7713b1edbc | 72 | /*! @brief List of MRT interrupts */ |
AnnaBridge | 171:3a7713b1edbc | 73 | typedef enum _mrt_interrupt_enable |
AnnaBridge | 171:3a7713b1edbc | 74 | { |
AnnaBridge | 171:3a7713b1edbc | 75 | kMRT_TimerInterruptEnable = MRT_CHANNEL_CTRL_INTEN_MASK /*!< Timer interrupt enable*/ |
AnnaBridge | 171:3a7713b1edbc | 76 | } mrt_interrupt_enable_t; |
AnnaBridge | 171:3a7713b1edbc | 77 | |
AnnaBridge | 171:3a7713b1edbc | 78 | /*! @brief List of MRT status flags */ |
AnnaBridge | 171:3a7713b1edbc | 79 | typedef enum _mrt_status_flags |
AnnaBridge | 171:3a7713b1edbc | 80 | { |
AnnaBridge | 171:3a7713b1edbc | 81 | kMRT_TimerInterruptFlag = MRT_CHANNEL_STAT_INTFLAG_MASK, /*!< Timer interrupt flag */ |
AnnaBridge | 171:3a7713b1edbc | 82 | kMRT_TimerRunFlag = MRT_CHANNEL_STAT_RUN_MASK, /*!< Indicates state of the timer */ |
AnnaBridge | 171:3a7713b1edbc | 83 | } mrt_status_flags_t; |
AnnaBridge | 171:3a7713b1edbc | 84 | |
AnnaBridge | 171:3a7713b1edbc | 85 | /*! |
AnnaBridge | 171:3a7713b1edbc | 86 | * @brief MRT configuration structure |
AnnaBridge | 171:3a7713b1edbc | 87 | * |
AnnaBridge | 171:3a7713b1edbc | 88 | * This structure holds the configuration settings for the MRT peripheral. To initialize this |
AnnaBridge | 171:3a7713b1edbc | 89 | * structure to reasonable defaults, call the MRT_GetDefaultConfig() function and pass a |
AnnaBridge | 171:3a7713b1edbc | 90 | * pointer to your config structure instance. |
AnnaBridge | 171:3a7713b1edbc | 91 | * |
AnnaBridge | 171:3a7713b1edbc | 92 | * The config struct can be made const so it resides in flash |
AnnaBridge | 171:3a7713b1edbc | 93 | */ |
AnnaBridge | 171:3a7713b1edbc | 94 | typedef struct _mrt_config |
AnnaBridge | 171:3a7713b1edbc | 95 | { |
AnnaBridge | 171:3a7713b1edbc | 96 | bool enableMultiTask; /*!< true: Timers run in multi-task mode; false: Timers run in hardware status mode */ |
AnnaBridge | 171:3a7713b1edbc | 97 | } mrt_config_t; |
AnnaBridge | 171:3a7713b1edbc | 98 | |
AnnaBridge | 171:3a7713b1edbc | 99 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 100 | * API |
AnnaBridge | 171:3a7713b1edbc | 101 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 102 | |
AnnaBridge | 171:3a7713b1edbc | 103 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 104 | extern "C" { |
AnnaBridge | 171:3a7713b1edbc | 105 | #endif |
AnnaBridge | 171:3a7713b1edbc | 106 | |
AnnaBridge | 171:3a7713b1edbc | 107 | /*! |
AnnaBridge | 171:3a7713b1edbc | 108 | * @name Initialization and deinitialization |
AnnaBridge | 171:3a7713b1edbc | 109 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 110 | */ |
AnnaBridge | 171:3a7713b1edbc | 111 | |
AnnaBridge | 171:3a7713b1edbc | 112 | /*! |
AnnaBridge | 171:3a7713b1edbc | 113 | * @brief Ungates the MRT clock and configures the peripheral for basic operation. |
AnnaBridge | 171:3a7713b1edbc | 114 | * |
AnnaBridge | 171:3a7713b1edbc | 115 | * @note This API should be called at the beginning of the application using the MRT driver. |
AnnaBridge | 171:3a7713b1edbc | 116 | * |
AnnaBridge | 171:3a7713b1edbc | 117 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 118 | * @param config Pointer to user's MRT config structure |
AnnaBridge | 171:3a7713b1edbc | 119 | */ |
AnnaBridge | 171:3a7713b1edbc | 120 | void MRT_Init(MRT_Type *base, const mrt_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 121 | |
AnnaBridge | 171:3a7713b1edbc | 122 | /*! |
AnnaBridge | 171:3a7713b1edbc | 123 | * @brief Gate the MRT clock |
AnnaBridge | 171:3a7713b1edbc | 124 | * |
AnnaBridge | 171:3a7713b1edbc | 125 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 126 | */ |
AnnaBridge | 171:3a7713b1edbc | 127 | void MRT_Deinit(MRT_Type *base); |
AnnaBridge | 171:3a7713b1edbc | 128 | |
AnnaBridge | 171:3a7713b1edbc | 129 | /*! |
AnnaBridge | 171:3a7713b1edbc | 130 | * @brief Fill in the MRT config struct with the default settings |
AnnaBridge | 171:3a7713b1edbc | 131 | * |
AnnaBridge | 171:3a7713b1edbc | 132 | * The default values are: |
AnnaBridge | 171:3a7713b1edbc | 133 | * @code |
AnnaBridge | 171:3a7713b1edbc | 134 | * config->enableMultiTask = false; |
AnnaBridge | 171:3a7713b1edbc | 135 | * @endcode |
AnnaBridge | 171:3a7713b1edbc | 136 | * @param config Pointer to user's MRT config structure. |
AnnaBridge | 171:3a7713b1edbc | 137 | */ |
AnnaBridge | 171:3a7713b1edbc | 138 | static inline void MRT_GetDefaultConfig(mrt_config_t *config) |
AnnaBridge | 171:3a7713b1edbc | 139 | { |
AnnaBridge | 171:3a7713b1edbc | 140 | assert(config); |
AnnaBridge | 171:3a7713b1edbc | 141 | |
AnnaBridge | 171:3a7713b1edbc | 142 | /* Use hardware status operating mode */ |
AnnaBridge | 171:3a7713b1edbc | 143 | config->enableMultiTask = false; |
AnnaBridge | 171:3a7713b1edbc | 144 | } |
AnnaBridge | 171:3a7713b1edbc | 145 | |
AnnaBridge | 171:3a7713b1edbc | 146 | /*! |
AnnaBridge | 171:3a7713b1edbc | 147 | * @brief Sets up an MRT channel mode. |
AnnaBridge | 171:3a7713b1edbc | 148 | * |
AnnaBridge | 171:3a7713b1edbc | 149 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 150 | * @param channel Channel that is being configured. |
AnnaBridge | 171:3a7713b1edbc | 151 | * @param mode Timer mode to use for the channel. |
AnnaBridge | 171:3a7713b1edbc | 152 | */ |
AnnaBridge | 171:3a7713b1edbc | 153 | static inline void MRT_SetupChannelMode(MRT_Type *base, mrt_chnl_t channel, const mrt_timer_mode_t mode) |
AnnaBridge | 171:3a7713b1edbc | 154 | { |
AnnaBridge | 171:3a7713b1edbc | 155 | uint32_t reg = base->CHANNEL[channel].CTRL; |
AnnaBridge | 171:3a7713b1edbc | 156 | |
AnnaBridge | 171:3a7713b1edbc | 157 | /* Clear old value */ |
AnnaBridge | 171:3a7713b1edbc | 158 | reg &= ~MRT_CHANNEL_CTRL_MODE_MASK; |
AnnaBridge | 171:3a7713b1edbc | 159 | /* Add the new mode */ |
AnnaBridge | 171:3a7713b1edbc | 160 | reg |= mode; |
AnnaBridge | 171:3a7713b1edbc | 161 | |
AnnaBridge | 171:3a7713b1edbc | 162 | base->CHANNEL[channel].CTRL = reg; |
AnnaBridge | 171:3a7713b1edbc | 163 | } |
AnnaBridge | 171:3a7713b1edbc | 164 | |
AnnaBridge | 171:3a7713b1edbc | 165 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 166 | |
AnnaBridge | 171:3a7713b1edbc | 167 | /*! |
AnnaBridge | 171:3a7713b1edbc | 168 | * @name Interrupt Interface |
AnnaBridge | 171:3a7713b1edbc | 169 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 170 | */ |
AnnaBridge | 171:3a7713b1edbc | 171 | |
AnnaBridge | 171:3a7713b1edbc | 172 | /*! |
AnnaBridge | 171:3a7713b1edbc | 173 | * @brief Enables the MRT interrupt. |
AnnaBridge | 171:3a7713b1edbc | 174 | * |
AnnaBridge | 171:3a7713b1edbc | 175 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 176 | * @param channel Timer channel number |
AnnaBridge | 171:3a7713b1edbc | 177 | * @param mask The interrupts to enable. This is a logical OR of members of the |
AnnaBridge | 171:3a7713b1edbc | 178 | * enumeration ::mrt_interrupt_enable_t |
AnnaBridge | 171:3a7713b1edbc | 179 | */ |
AnnaBridge | 171:3a7713b1edbc | 180 | static inline void MRT_EnableInterrupts(MRT_Type *base, mrt_chnl_t channel, uint32_t mask) |
AnnaBridge | 171:3a7713b1edbc | 181 | { |
AnnaBridge | 171:3a7713b1edbc | 182 | base->CHANNEL[channel].CTRL |= mask; |
AnnaBridge | 171:3a7713b1edbc | 183 | } |
AnnaBridge | 171:3a7713b1edbc | 184 | |
AnnaBridge | 171:3a7713b1edbc | 185 | /*! |
AnnaBridge | 171:3a7713b1edbc | 186 | * @brief Disables the selected MRT interrupt. |
AnnaBridge | 171:3a7713b1edbc | 187 | * |
AnnaBridge | 171:3a7713b1edbc | 188 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 189 | * @param channel Timer channel number |
AnnaBridge | 171:3a7713b1edbc | 190 | * @param mask The interrupts to disable. This is a logical OR of members of the |
AnnaBridge | 171:3a7713b1edbc | 191 | * enumeration ::mrt_interrupt_enable_t |
AnnaBridge | 171:3a7713b1edbc | 192 | */ |
AnnaBridge | 171:3a7713b1edbc | 193 | static inline void MRT_DisableInterrupts(MRT_Type *base, mrt_chnl_t channel, uint32_t mask) |
AnnaBridge | 171:3a7713b1edbc | 194 | { |
AnnaBridge | 171:3a7713b1edbc | 195 | base->CHANNEL[channel].CTRL &= ~mask; |
AnnaBridge | 171:3a7713b1edbc | 196 | } |
AnnaBridge | 171:3a7713b1edbc | 197 | |
AnnaBridge | 171:3a7713b1edbc | 198 | /*! |
AnnaBridge | 171:3a7713b1edbc | 199 | * @brief Gets the enabled MRT interrupts. |
AnnaBridge | 171:3a7713b1edbc | 200 | * |
AnnaBridge | 171:3a7713b1edbc | 201 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 202 | * @param channel Timer channel number |
AnnaBridge | 171:3a7713b1edbc | 203 | * |
AnnaBridge | 171:3a7713b1edbc | 204 | * @return The enabled interrupts. This is the logical OR of members of the |
AnnaBridge | 171:3a7713b1edbc | 205 | * enumeration ::mrt_interrupt_enable_t |
AnnaBridge | 171:3a7713b1edbc | 206 | */ |
AnnaBridge | 171:3a7713b1edbc | 207 | static inline uint32_t MRT_GetEnabledInterrupts(MRT_Type *base, mrt_chnl_t channel) |
AnnaBridge | 171:3a7713b1edbc | 208 | { |
AnnaBridge | 171:3a7713b1edbc | 209 | return (base->CHANNEL[channel].CTRL & MRT_CHANNEL_CTRL_INTEN_MASK); |
AnnaBridge | 171:3a7713b1edbc | 210 | } |
AnnaBridge | 171:3a7713b1edbc | 211 | |
AnnaBridge | 171:3a7713b1edbc | 212 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 213 | |
AnnaBridge | 171:3a7713b1edbc | 214 | /*! |
AnnaBridge | 171:3a7713b1edbc | 215 | * @name Status Interface |
AnnaBridge | 171:3a7713b1edbc | 216 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 217 | */ |
AnnaBridge | 171:3a7713b1edbc | 218 | |
AnnaBridge | 171:3a7713b1edbc | 219 | /*! |
AnnaBridge | 171:3a7713b1edbc | 220 | * @brief Gets the MRT status flags |
AnnaBridge | 171:3a7713b1edbc | 221 | * |
AnnaBridge | 171:3a7713b1edbc | 222 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 223 | * @param channel Timer channel number |
AnnaBridge | 171:3a7713b1edbc | 224 | * |
AnnaBridge | 171:3a7713b1edbc | 225 | * @return The status flags. This is the logical OR of members of the |
AnnaBridge | 171:3a7713b1edbc | 226 | * enumeration ::mrt_status_flags_t |
AnnaBridge | 171:3a7713b1edbc | 227 | */ |
AnnaBridge | 171:3a7713b1edbc | 228 | static inline uint32_t MRT_GetStatusFlags(MRT_Type *base, mrt_chnl_t channel) |
AnnaBridge | 171:3a7713b1edbc | 229 | { |
AnnaBridge | 171:3a7713b1edbc | 230 | return (base->CHANNEL[channel].STAT & (MRT_CHANNEL_STAT_INTFLAG_MASK | MRT_CHANNEL_STAT_RUN_MASK)); |
AnnaBridge | 171:3a7713b1edbc | 231 | } |
AnnaBridge | 171:3a7713b1edbc | 232 | |
AnnaBridge | 171:3a7713b1edbc | 233 | /*! |
AnnaBridge | 171:3a7713b1edbc | 234 | * @brief Clears the MRT status flags. |
AnnaBridge | 171:3a7713b1edbc | 235 | * |
AnnaBridge | 171:3a7713b1edbc | 236 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 237 | * @param channel Timer channel number |
AnnaBridge | 171:3a7713b1edbc | 238 | * @param mask The status flags to clear. This is a logical OR of members of the |
AnnaBridge | 171:3a7713b1edbc | 239 | * enumeration ::mrt_status_flags_t |
AnnaBridge | 171:3a7713b1edbc | 240 | */ |
AnnaBridge | 171:3a7713b1edbc | 241 | static inline void MRT_ClearStatusFlags(MRT_Type *base, mrt_chnl_t channel, uint32_t mask) |
AnnaBridge | 171:3a7713b1edbc | 242 | { |
AnnaBridge | 171:3a7713b1edbc | 243 | base->CHANNEL[channel].STAT = (mask & MRT_CHANNEL_STAT_INTFLAG_MASK); |
AnnaBridge | 171:3a7713b1edbc | 244 | } |
AnnaBridge | 171:3a7713b1edbc | 245 | |
AnnaBridge | 171:3a7713b1edbc | 246 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 247 | |
AnnaBridge | 171:3a7713b1edbc | 248 | /*! |
AnnaBridge | 171:3a7713b1edbc | 249 | * @name Read and Write the timer period |
AnnaBridge | 171:3a7713b1edbc | 250 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 251 | */ |
AnnaBridge | 171:3a7713b1edbc | 252 | |
AnnaBridge | 171:3a7713b1edbc | 253 | /*! |
AnnaBridge | 171:3a7713b1edbc | 254 | * @brief Used to update the timer period in units of count. |
AnnaBridge | 171:3a7713b1edbc | 255 | * |
AnnaBridge | 171:3a7713b1edbc | 256 | * The new value will be immediately loaded or will be loaded at the end of the current time |
AnnaBridge | 171:3a7713b1edbc | 257 | * interval. For one-shot interrupt mode the new value will be immediately loaded. |
AnnaBridge | 171:3a7713b1edbc | 258 | * |
AnnaBridge | 171:3a7713b1edbc | 259 | * @note User can call the utility macros provided in fsl_common.h to convert to ticks |
AnnaBridge | 171:3a7713b1edbc | 260 | * |
AnnaBridge | 171:3a7713b1edbc | 261 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 262 | * @param channel Timer channel number |
AnnaBridge | 171:3a7713b1edbc | 263 | * @param count Timer period in units of ticks |
AnnaBridge | 171:3a7713b1edbc | 264 | * @param immediateLoad true: Load the new value immediately into the TIMER register; |
AnnaBridge | 171:3a7713b1edbc | 265 | * false: Load the new value at the end of current timer interval |
AnnaBridge | 171:3a7713b1edbc | 266 | */ |
AnnaBridge | 171:3a7713b1edbc | 267 | void MRT_UpdateTimerPeriod(MRT_Type *base, mrt_chnl_t channel, uint32_t count, bool immediateLoad); |
AnnaBridge | 171:3a7713b1edbc | 268 | |
AnnaBridge | 171:3a7713b1edbc | 269 | /*! |
AnnaBridge | 171:3a7713b1edbc | 270 | * @brief Reads the current timer counting value. |
AnnaBridge | 171:3a7713b1edbc | 271 | * |
AnnaBridge | 171:3a7713b1edbc | 272 | * This function returns the real-time timer counting value, in a range from 0 to a |
AnnaBridge | 171:3a7713b1edbc | 273 | * timer period. |
AnnaBridge | 171:3a7713b1edbc | 274 | * |
AnnaBridge | 171:3a7713b1edbc | 275 | * @note User can call the utility macros provided in fsl_common.h to convert ticks to usec or msec |
AnnaBridge | 171:3a7713b1edbc | 276 | * |
AnnaBridge | 171:3a7713b1edbc | 277 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 278 | * @param channel Timer channel number |
AnnaBridge | 171:3a7713b1edbc | 279 | * |
AnnaBridge | 171:3a7713b1edbc | 280 | * @return Current timer counting value in ticks |
AnnaBridge | 171:3a7713b1edbc | 281 | */ |
AnnaBridge | 171:3a7713b1edbc | 282 | static inline uint32_t MRT_GetCurrentTimerCount(MRT_Type *base, mrt_chnl_t channel) |
AnnaBridge | 171:3a7713b1edbc | 283 | { |
AnnaBridge | 171:3a7713b1edbc | 284 | return base->CHANNEL[channel].TIMER; |
AnnaBridge | 171:3a7713b1edbc | 285 | } |
AnnaBridge | 171:3a7713b1edbc | 286 | |
AnnaBridge | 171:3a7713b1edbc | 287 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 288 | |
AnnaBridge | 171:3a7713b1edbc | 289 | /*! |
AnnaBridge | 171:3a7713b1edbc | 290 | * @name Timer Start and Stop |
AnnaBridge | 171:3a7713b1edbc | 291 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 292 | */ |
AnnaBridge | 171:3a7713b1edbc | 293 | |
AnnaBridge | 171:3a7713b1edbc | 294 | /*! |
AnnaBridge | 171:3a7713b1edbc | 295 | * @brief Starts the timer counting. |
AnnaBridge | 171:3a7713b1edbc | 296 | * |
AnnaBridge | 171:3a7713b1edbc | 297 | * After calling this function, timers load period value, counts down to 0 and |
AnnaBridge | 171:3a7713b1edbc | 298 | * depending on the timer mode it will either load the respective start value again or stop. |
AnnaBridge | 171:3a7713b1edbc | 299 | * |
AnnaBridge | 171:3a7713b1edbc | 300 | * @note User can call the utility macros provided in fsl_common.h to convert to ticks |
AnnaBridge | 171:3a7713b1edbc | 301 | * |
AnnaBridge | 171:3a7713b1edbc | 302 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 303 | * @param channel Timer channel number. |
AnnaBridge | 171:3a7713b1edbc | 304 | * @param count Timer period in units of ticks |
AnnaBridge | 171:3a7713b1edbc | 305 | */ |
AnnaBridge | 171:3a7713b1edbc | 306 | static inline void MRT_StartTimer(MRT_Type *base, mrt_chnl_t channel, uint32_t count) |
AnnaBridge | 171:3a7713b1edbc | 307 | { |
AnnaBridge | 171:3a7713b1edbc | 308 | /* Write the timer interval value */ |
AnnaBridge | 171:3a7713b1edbc | 309 | base->CHANNEL[channel].INTVAL = count; |
AnnaBridge | 171:3a7713b1edbc | 310 | } |
AnnaBridge | 171:3a7713b1edbc | 311 | |
AnnaBridge | 171:3a7713b1edbc | 312 | /*! |
AnnaBridge | 171:3a7713b1edbc | 313 | * @brief Stops the timer counting. |
AnnaBridge | 171:3a7713b1edbc | 314 | * |
AnnaBridge | 171:3a7713b1edbc | 315 | * This function stops the timer from counting. |
AnnaBridge | 171:3a7713b1edbc | 316 | * |
AnnaBridge | 171:3a7713b1edbc | 317 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 318 | * @param channel Timer channel number. |
AnnaBridge | 171:3a7713b1edbc | 319 | */ |
AnnaBridge | 171:3a7713b1edbc | 320 | static inline void MRT_StopTimer(MRT_Type *base, mrt_chnl_t channel) |
AnnaBridge | 171:3a7713b1edbc | 321 | { |
AnnaBridge | 171:3a7713b1edbc | 322 | /* Stop the timer immediately */ |
AnnaBridge | 171:3a7713b1edbc | 323 | base->CHANNEL[channel].INTVAL = MRT_CHANNEL_INTVAL_LOAD_MASK; |
AnnaBridge | 171:3a7713b1edbc | 324 | } |
AnnaBridge | 171:3a7713b1edbc | 325 | |
AnnaBridge | 171:3a7713b1edbc | 326 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 327 | |
AnnaBridge | 171:3a7713b1edbc | 328 | /*! |
AnnaBridge | 171:3a7713b1edbc | 329 | * @name Get & release channel |
AnnaBridge | 171:3a7713b1edbc | 330 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 331 | */ |
AnnaBridge | 171:3a7713b1edbc | 332 | |
AnnaBridge | 171:3a7713b1edbc | 333 | /*! |
AnnaBridge | 171:3a7713b1edbc | 334 | * @brief Find the available channel. |
AnnaBridge | 171:3a7713b1edbc | 335 | * |
AnnaBridge | 171:3a7713b1edbc | 336 | * This function returns the lowest available channel number. |
AnnaBridge | 171:3a7713b1edbc | 337 | * |
AnnaBridge | 171:3a7713b1edbc | 338 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 339 | */ |
AnnaBridge | 171:3a7713b1edbc | 340 | static inline uint32_t MRT_GetIdleChannel(MRT_Type *base) |
AnnaBridge | 171:3a7713b1edbc | 341 | { |
AnnaBridge | 171:3a7713b1edbc | 342 | return base->IDLE_CH; |
AnnaBridge | 171:3a7713b1edbc | 343 | } |
AnnaBridge | 171:3a7713b1edbc | 344 | |
AnnaBridge | 171:3a7713b1edbc | 345 | /*! |
AnnaBridge | 171:3a7713b1edbc | 346 | * @brief Release the channel when the timer is using the multi-task mode. |
AnnaBridge | 171:3a7713b1edbc | 347 | * |
AnnaBridge | 171:3a7713b1edbc | 348 | * In multi-task mode, the INUSE flags allow more control over when MRT channels are released for |
AnnaBridge | 171:3a7713b1edbc | 349 | * further use. The user can hold on to a channel acquired by calling MRT_GetIdleChannel() for as |
AnnaBridge | 171:3a7713b1edbc | 350 | * long as it is needed and release it by calling this function. This removes the need to ask for |
AnnaBridge | 171:3a7713b1edbc | 351 | * an available channel for every use. |
AnnaBridge | 171:3a7713b1edbc | 352 | * |
AnnaBridge | 171:3a7713b1edbc | 353 | * @param base Multi-Rate timer peripheral base address |
AnnaBridge | 171:3a7713b1edbc | 354 | * @param channel Timer channel number. |
AnnaBridge | 171:3a7713b1edbc | 355 | */ |
AnnaBridge | 171:3a7713b1edbc | 356 | static inline void MRT_ReleaseChannel(MRT_Type *base, mrt_chnl_t channel) |
AnnaBridge | 171:3a7713b1edbc | 357 | { |
AnnaBridge | 171:3a7713b1edbc | 358 | uint32_t reg = base->CHANNEL[channel].STAT; |
AnnaBridge | 171:3a7713b1edbc | 359 | |
AnnaBridge | 171:3a7713b1edbc | 360 | /* Clear flag bits to prevent accidentally clearing anything when writing back */ |
AnnaBridge | 171:3a7713b1edbc | 361 | reg = ~MRT_CHANNEL_STAT_INTFLAG_MASK; |
AnnaBridge | 171:3a7713b1edbc | 362 | reg |= MRT_CHANNEL_STAT_INUSE_MASK; |
AnnaBridge | 171:3a7713b1edbc | 363 | |
AnnaBridge | 171:3a7713b1edbc | 364 | base->CHANNEL[channel].STAT = reg; |
AnnaBridge | 171:3a7713b1edbc | 365 | } |
AnnaBridge | 171:3a7713b1edbc | 366 | |
AnnaBridge | 171:3a7713b1edbc | 367 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 368 | |
AnnaBridge | 171:3a7713b1edbc | 369 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 370 | } |
AnnaBridge | 171:3a7713b1edbc | 371 | #endif |
AnnaBridge | 171:3a7713b1edbc | 372 | |
AnnaBridge | 171:3a7713b1edbc | 373 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 374 | |
AnnaBridge | 171:3a7713b1edbc | 375 | #endif /* _FSL_MRT_H_ */ |