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_KW41Z/TOOLCHAIN_GCC_ARM/fsl_cmt.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 171:3a7713b1edbc | 1 | /* |
AnnaBridge | 171:3a7713b1edbc | 2 | * Copyright (c) 2015, Freescale Semiconductor, Inc. |
AnnaBridge | 171:3a7713b1edbc | 3 | * All rights reserved. |
AnnaBridge | 171:3a7713b1edbc | 4 | * |
AnnaBridge | 171:3a7713b1edbc | 5 | * Redistribution and use in source and binary forms, with or without modification, |
AnnaBridge | 171:3a7713b1edbc | 6 | * are permitted provided that the following conditions are met: |
AnnaBridge | 171:3a7713b1edbc | 7 | * |
AnnaBridge | 171:3a7713b1edbc | 8 | * o Redistributions of source code must retain the above copyright notice, this list |
AnnaBridge | 171:3a7713b1edbc | 9 | * of conditions and the following disclaimer. |
AnnaBridge | 171:3a7713b1edbc | 10 | * |
AnnaBridge | 171:3a7713b1edbc | 11 | * o Redistributions in binary form must reproduce the above copyright notice, this |
AnnaBridge | 171:3a7713b1edbc | 12 | * list of conditions and the following disclaimer in the documentation and/or |
AnnaBridge | 171:3a7713b1edbc | 13 | * other materials provided with the distribution. |
AnnaBridge | 171:3a7713b1edbc | 14 | * |
AnnaBridge | 171:3a7713b1edbc | 15 | * o Neither the name of Freescale Semiconductor, Inc. nor the names of its |
AnnaBridge | 171:3a7713b1edbc | 16 | * contributors may be used to endorse or promote products derived from this |
AnnaBridge | 171:3a7713b1edbc | 17 | * software without specific prior written permission. |
AnnaBridge | 171:3a7713b1edbc | 18 | * |
AnnaBridge | 171:3a7713b1edbc | 19 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
AnnaBridge | 171:3a7713b1edbc | 20 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
AnnaBridge | 171:3a7713b1edbc | 21 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
AnnaBridge | 171:3a7713b1edbc | 22 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
AnnaBridge | 171:3a7713b1edbc | 23 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
AnnaBridge | 171:3a7713b1edbc | 24 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
AnnaBridge | 171:3a7713b1edbc | 25 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
AnnaBridge | 171:3a7713b1edbc | 26 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
AnnaBridge | 171:3a7713b1edbc | 27 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
AnnaBridge | 171:3a7713b1edbc | 28 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
AnnaBridge | 171:3a7713b1edbc | 29 | */ |
AnnaBridge | 171:3a7713b1edbc | 30 | #ifndef _FSL_CMT_H_ |
AnnaBridge | 171:3a7713b1edbc | 31 | #define _FSL_CMT_H_ |
AnnaBridge | 171:3a7713b1edbc | 32 | |
AnnaBridge | 171:3a7713b1edbc | 33 | #include "fsl_common.h" |
AnnaBridge | 171:3a7713b1edbc | 34 | |
AnnaBridge | 171:3a7713b1edbc | 35 | /*! |
AnnaBridge | 171:3a7713b1edbc | 36 | * @addtogroup cmt |
AnnaBridge | 171:3a7713b1edbc | 37 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 38 | */ |
AnnaBridge | 171:3a7713b1edbc | 39 | |
AnnaBridge | 171:3a7713b1edbc | 40 | /*! @file */ |
AnnaBridge | 171:3a7713b1edbc | 41 | |
AnnaBridge | 171:3a7713b1edbc | 42 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 43 | * Definitions |
AnnaBridge | 171:3a7713b1edbc | 44 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 45 | |
AnnaBridge | 171:3a7713b1edbc | 46 | /*! @name Driver version */ |
AnnaBridge | 171:3a7713b1edbc | 47 | /*@{*/ |
AnnaBridge | 171:3a7713b1edbc | 48 | /*! @brief CMT driver version 2.0.0. */ |
AnnaBridge | 171:3a7713b1edbc | 49 | #define FSL_CMT_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) |
AnnaBridge | 171:3a7713b1edbc | 50 | /*@}*/ |
AnnaBridge | 171:3a7713b1edbc | 51 | |
AnnaBridge | 171:3a7713b1edbc | 52 | /*! |
AnnaBridge | 171:3a7713b1edbc | 53 | * @brief The modes of CMT. |
AnnaBridge | 171:3a7713b1edbc | 54 | */ |
AnnaBridge | 171:3a7713b1edbc | 55 | typedef enum _cmt_mode |
AnnaBridge | 171:3a7713b1edbc | 56 | { |
AnnaBridge | 171:3a7713b1edbc | 57 | kCMT_DirectIROCtl = 0x00U, /*!< Carrier modulator is disabled and the IRO signal is directly in software control */ |
AnnaBridge | 171:3a7713b1edbc | 58 | kCMT_TimeMode = 0x01U, /*!< Carrier modulator is enabled in time mode. */ |
AnnaBridge | 171:3a7713b1edbc | 59 | kCMT_FSKMode = 0x05U, /*!< Carrier modulator is enabled in FSK mode. */ |
AnnaBridge | 171:3a7713b1edbc | 60 | kCMT_BasebandMode = 0x09U /*!< Carrier modulator is enabled in baseband mode. */ |
AnnaBridge | 171:3a7713b1edbc | 61 | } cmt_mode_t; |
AnnaBridge | 171:3a7713b1edbc | 62 | |
AnnaBridge | 171:3a7713b1edbc | 63 | /*! |
AnnaBridge | 171:3a7713b1edbc | 64 | * @brief The CMT clock divide primary prescaler. |
AnnaBridge | 171:3a7713b1edbc | 65 | * The primary clock divider is used to divider the bus clock to |
AnnaBridge | 171:3a7713b1edbc | 66 | * get the intermediate frequency to approximately equal to 8 MHZ. |
AnnaBridge | 171:3a7713b1edbc | 67 | * When the bus clock is 8 MHZ, set primary prescaler to "kCMT_PrimaryClkDiv1". |
AnnaBridge | 171:3a7713b1edbc | 68 | */ |
AnnaBridge | 171:3a7713b1edbc | 69 | typedef enum _cmt_primary_clkdiv |
AnnaBridge | 171:3a7713b1edbc | 70 | { |
AnnaBridge | 171:3a7713b1edbc | 71 | kCMT_PrimaryClkDiv1 = 0U, /*!< The intermediate frequency is the bus clock divided by 1. */ |
AnnaBridge | 171:3a7713b1edbc | 72 | kCMT_PrimaryClkDiv2 = 1U, /*!< The intermediate frequency is the bus clock divided by 2. */ |
AnnaBridge | 171:3a7713b1edbc | 73 | kCMT_PrimaryClkDiv3 = 2U, /*!< The intermediate frequency is the bus clock divided by 3. */ |
AnnaBridge | 171:3a7713b1edbc | 74 | kCMT_PrimaryClkDiv4 = 3U, /*!< The intermediate frequency is the bus clock divided by 4. */ |
AnnaBridge | 171:3a7713b1edbc | 75 | kCMT_PrimaryClkDiv5 = 4U, /*!< The intermediate frequency is the bus clock divided by 5. */ |
AnnaBridge | 171:3a7713b1edbc | 76 | kCMT_PrimaryClkDiv6 = 5U, /*!< The intermediate frequency is the bus clock divided by 6. */ |
AnnaBridge | 171:3a7713b1edbc | 77 | kCMT_PrimaryClkDiv7 = 6U, /*!< The intermediate frequency is the bus clock divided by 7. */ |
AnnaBridge | 171:3a7713b1edbc | 78 | kCMT_PrimaryClkDiv8 = 7U, /*!< The intermediate frequency is the bus clock divided by 8. */ |
AnnaBridge | 171:3a7713b1edbc | 79 | kCMT_PrimaryClkDiv9 = 8U, /*!< The intermediate frequency is the bus clock divided by 9. */ |
AnnaBridge | 171:3a7713b1edbc | 80 | kCMT_PrimaryClkDiv10 = 9U, /*!< The intermediate frequency is the bus clock divided by 10. */ |
AnnaBridge | 171:3a7713b1edbc | 81 | kCMT_PrimaryClkDiv11 = 10U, /*!< The intermediate frequency is the bus clock divided by 11. */ |
AnnaBridge | 171:3a7713b1edbc | 82 | kCMT_PrimaryClkDiv12 = 11U, /*!< The intermediate frequency is the bus clock divided by 12. */ |
AnnaBridge | 171:3a7713b1edbc | 83 | kCMT_PrimaryClkDiv13 = 12U, /*!< The intermediate frequency is the bus clock divided by 13. */ |
AnnaBridge | 171:3a7713b1edbc | 84 | kCMT_PrimaryClkDiv14 = 13U, /*!< The intermediate frequency is the bus clock divided by 14. */ |
AnnaBridge | 171:3a7713b1edbc | 85 | kCMT_PrimaryClkDiv15 = 14U, /*!< The intermediate frequency is the bus clock divided by 15. */ |
AnnaBridge | 171:3a7713b1edbc | 86 | kCMT_PrimaryClkDiv16 = 15U /*!< The intermediate frequency is the bus clock divided by 16. */ |
AnnaBridge | 171:3a7713b1edbc | 87 | } cmt_primary_clkdiv_t; |
AnnaBridge | 171:3a7713b1edbc | 88 | |
AnnaBridge | 171:3a7713b1edbc | 89 | /*! |
AnnaBridge | 171:3a7713b1edbc | 90 | * @brief The CMT clock divide secondary prescaler. |
AnnaBridge | 171:3a7713b1edbc | 91 | * The second prescaler can be used to divide the 8 MHZ CMT clock |
AnnaBridge | 171:3a7713b1edbc | 92 | * by 1, 2, 4, or 8 according to the specification. |
AnnaBridge | 171:3a7713b1edbc | 93 | */ |
AnnaBridge | 171:3a7713b1edbc | 94 | typedef enum _cmt_second_clkdiv |
AnnaBridge | 171:3a7713b1edbc | 95 | { |
AnnaBridge | 171:3a7713b1edbc | 96 | kCMT_SecondClkDiv1 = 0U, /*!< The CMT clock is the intermediate frequency frequency divided by 1. */ |
AnnaBridge | 171:3a7713b1edbc | 97 | kCMT_SecondClkDiv2 = 1U, /*!< The CMT clock is the intermediate frequency frequency divided by 2. */ |
AnnaBridge | 171:3a7713b1edbc | 98 | kCMT_SecondClkDiv4 = 2U, /*!< The CMT clock is the intermediate frequency frequency divided by 4. */ |
AnnaBridge | 171:3a7713b1edbc | 99 | kCMT_SecondClkDiv8 = 3U /*!< The CMT clock is the intermediate frequency frequency divided by 8. */ |
AnnaBridge | 171:3a7713b1edbc | 100 | } cmt_second_clkdiv_t; |
AnnaBridge | 171:3a7713b1edbc | 101 | |
AnnaBridge | 171:3a7713b1edbc | 102 | /*! |
AnnaBridge | 171:3a7713b1edbc | 103 | * @brief The CMT infrared output polarity. |
AnnaBridge | 171:3a7713b1edbc | 104 | */ |
AnnaBridge | 171:3a7713b1edbc | 105 | typedef enum _cmt_infrared_output_polarity |
AnnaBridge | 171:3a7713b1edbc | 106 | { |
AnnaBridge | 171:3a7713b1edbc | 107 | kCMT_IROActiveLow = 0U, /*!< The CMT infrared output signal polarity is active-low. */ |
AnnaBridge | 171:3a7713b1edbc | 108 | kCMT_IROActiveHigh = 1U /*!< The CMT infrared output signal polarity is active-high. */ |
AnnaBridge | 171:3a7713b1edbc | 109 | } cmt_infrared_output_polarity_t; |
AnnaBridge | 171:3a7713b1edbc | 110 | |
AnnaBridge | 171:3a7713b1edbc | 111 | /*! |
AnnaBridge | 171:3a7713b1edbc | 112 | * @brief The CMT infrared output signal state control. |
AnnaBridge | 171:3a7713b1edbc | 113 | */ |
AnnaBridge | 171:3a7713b1edbc | 114 | typedef enum _cmt_infrared_output_state |
AnnaBridge | 171:3a7713b1edbc | 115 | { |
AnnaBridge | 171:3a7713b1edbc | 116 | kCMT_IROCtlLow = 0U, /*!< The CMT Infrared output signal state is controlled to low. */ |
AnnaBridge | 171:3a7713b1edbc | 117 | kCMT_IROCtlHigh = 1U /*!< The CMT Infrared output signal state is controlled to high. */ |
AnnaBridge | 171:3a7713b1edbc | 118 | } cmt_infrared_output_state_t; |
AnnaBridge | 171:3a7713b1edbc | 119 | |
AnnaBridge | 171:3a7713b1edbc | 120 | /*! |
AnnaBridge | 171:3a7713b1edbc | 121 | * @brief CMT interrupt configuration structure, default settings all disabled. |
AnnaBridge | 171:3a7713b1edbc | 122 | * |
AnnaBridge | 171:3a7713b1edbc | 123 | * This structure contains the settings for all of the CMT interrupt configurations. |
AnnaBridge | 171:3a7713b1edbc | 124 | */ |
AnnaBridge | 171:3a7713b1edbc | 125 | enum _cmt_interrupt_enable |
AnnaBridge | 171:3a7713b1edbc | 126 | { |
AnnaBridge | 171:3a7713b1edbc | 127 | kCMT_EndOfCycleInterruptEnable = CMT_MSC_EOCIE_MASK, /*!< CMT end of cycle interrupt. */ |
AnnaBridge | 171:3a7713b1edbc | 128 | }; |
AnnaBridge | 171:3a7713b1edbc | 129 | |
AnnaBridge | 171:3a7713b1edbc | 130 | /*! |
AnnaBridge | 171:3a7713b1edbc | 131 | * @brief CMT carrier generator and modulator configure structure |
AnnaBridge | 171:3a7713b1edbc | 132 | * |
AnnaBridge | 171:3a7713b1edbc | 133 | */ |
AnnaBridge | 171:3a7713b1edbc | 134 | typedef struct _cmt_modulate_config |
AnnaBridge | 171:3a7713b1edbc | 135 | { |
AnnaBridge | 171:3a7713b1edbc | 136 | uint8_t highCount1; /*!< The high time for carrier generator first register. */ |
AnnaBridge | 171:3a7713b1edbc | 137 | uint8_t lowCount1; /*!< The low time for carrier generator first register. */ |
AnnaBridge | 171:3a7713b1edbc | 138 | uint8_t highCount2; /*!< The high time for carrier generator second register for FSK mode. */ |
AnnaBridge | 171:3a7713b1edbc | 139 | uint8_t lowCount2; /*!< The low time for carrier generator second register for FSK mode. */ |
AnnaBridge | 171:3a7713b1edbc | 140 | uint16_t markCount; /*!< The mark time for the modulator gate. */ |
AnnaBridge | 171:3a7713b1edbc | 141 | uint16_t spaceCount; /*!< The space time for the modulator gate. */ |
AnnaBridge | 171:3a7713b1edbc | 142 | } cmt_modulate_config_t; |
AnnaBridge | 171:3a7713b1edbc | 143 | |
AnnaBridge | 171:3a7713b1edbc | 144 | /*! @brief CMT basic configuration structure. */ |
AnnaBridge | 171:3a7713b1edbc | 145 | typedef struct _cmt_config |
AnnaBridge | 171:3a7713b1edbc | 146 | { |
AnnaBridge | 171:3a7713b1edbc | 147 | bool isInterruptEnabled; /*!< Timer interrupt 0-disable, 1-enable. */ |
AnnaBridge | 171:3a7713b1edbc | 148 | bool isIroEnabled; /*!< The IRO output 0-disabled, 1-enabled. */ |
AnnaBridge | 171:3a7713b1edbc | 149 | cmt_infrared_output_polarity_t iroPolarity; /*!< The IRO polarity. */ |
AnnaBridge | 171:3a7713b1edbc | 150 | cmt_second_clkdiv_t divider; /*!< The CMT clock divide prescaler. */ |
AnnaBridge | 171:3a7713b1edbc | 151 | } cmt_config_t; |
AnnaBridge | 171:3a7713b1edbc | 152 | |
AnnaBridge | 171:3a7713b1edbc | 153 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 154 | * API |
AnnaBridge | 171:3a7713b1edbc | 155 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 156 | |
AnnaBridge | 171:3a7713b1edbc | 157 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 158 | extern "C" { |
AnnaBridge | 171:3a7713b1edbc | 159 | #endif |
AnnaBridge | 171:3a7713b1edbc | 160 | |
AnnaBridge | 171:3a7713b1edbc | 161 | /*! |
AnnaBridge | 171:3a7713b1edbc | 162 | * @name Initialization and deinitialization |
AnnaBridge | 171:3a7713b1edbc | 163 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 164 | */ |
AnnaBridge | 171:3a7713b1edbc | 165 | |
AnnaBridge | 171:3a7713b1edbc | 166 | /*! |
AnnaBridge | 171:3a7713b1edbc | 167 | * @brief Gets the CMT default configuration structure. The purpose |
AnnaBridge | 171:3a7713b1edbc | 168 | * of this API is to get the default configuration structure for the CMT_Init(). |
AnnaBridge | 171:3a7713b1edbc | 169 | * Use the initialized structure unchanged in CMT_Init(), or modify |
AnnaBridge | 171:3a7713b1edbc | 170 | * some fields of the structure before calling the CMT_Init(). |
AnnaBridge | 171:3a7713b1edbc | 171 | * |
AnnaBridge | 171:3a7713b1edbc | 172 | * @param config The CMT configuration structure pointer. |
AnnaBridge | 171:3a7713b1edbc | 173 | */ |
AnnaBridge | 171:3a7713b1edbc | 174 | void CMT_GetDefaultConfig(cmt_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 175 | |
AnnaBridge | 171:3a7713b1edbc | 176 | /*! |
AnnaBridge | 171:3a7713b1edbc | 177 | * @brief Initializes the CMT module. |
AnnaBridge | 171:3a7713b1edbc | 178 | * |
AnnaBridge | 171:3a7713b1edbc | 179 | * This function ungates the module clock and sets the CMT internal clock, |
AnnaBridge | 171:3a7713b1edbc | 180 | * interrupt, and infrared output signal for the CMT module. |
AnnaBridge | 171:3a7713b1edbc | 181 | * |
AnnaBridge | 171:3a7713b1edbc | 182 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 183 | * @param config The CMT basic configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 184 | * @param busClock_Hz The CMT module input clock - bus clock frequency. |
AnnaBridge | 171:3a7713b1edbc | 185 | */ |
AnnaBridge | 171:3a7713b1edbc | 186 | void CMT_Init(CMT_Type *base, const cmt_config_t *config, uint32_t busClock_Hz); |
AnnaBridge | 171:3a7713b1edbc | 187 | |
AnnaBridge | 171:3a7713b1edbc | 188 | /*! |
AnnaBridge | 171:3a7713b1edbc | 189 | * @brief Disables the CMT module and gate control. |
AnnaBridge | 171:3a7713b1edbc | 190 | * |
AnnaBridge | 171:3a7713b1edbc | 191 | * This function disables CMT modulator, interrupts, and gates the |
AnnaBridge | 171:3a7713b1edbc | 192 | * CMT clock control. CMT_Init must be called to use the CMT again. |
AnnaBridge | 171:3a7713b1edbc | 193 | * |
AnnaBridge | 171:3a7713b1edbc | 194 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 195 | */ |
AnnaBridge | 171:3a7713b1edbc | 196 | void CMT_Deinit(CMT_Type *base); |
AnnaBridge | 171:3a7713b1edbc | 197 | |
AnnaBridge | 171:3a7713b1edbc | 198 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 199 | |
AnnaBridge | 171:3a7713b1edbc | 200 | /*! |
AnnaBridge | 171:3a7713b1edbc | 201 | * @name Basic Control Operations |
AnnaBridge | 171:3a7713b1edbc | 202 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 203 | */ |
AnnaBridge | 171:3a7713b1edbc | 204 | |
AnnaBridge | 171:3a7713b1edbc | 205 | /*! |
AnnaBridge | 171:3a7713b1edbc | 206 | * @brief Selects the mode for CMT. |
AnnaBridge | 171:3a7713b1edbc | 207 | * |
AnnaBridge | 171:3a7713b1edbc | 208 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 209 | * @param mode The CMT feature mode enumeration. See "cmt_mode_t". |
AnnaBridge | 171:3a7713b1edbc | 210 | * @param modulateConfig The carrier generation and modulator configuration. |
AnnaBridge | 171:3a7713b1edbc | 211 | */ |
AnnaBridge | 171:3a7713b1edbc | 212 | void CMT_SetMode(CMT_Type *base, cmt_mode_t mode, cmt_modulate_config_t *modulateConfig); |
AnnaBridge | 171:3a7713b1edbc | 213 | |
AnnaBridge | 171:3a7713b1edbc | 214 | /*! |
AnnaBridge | 171:3a7713b1edbc | 215 | * @brief Gets the mode of the CMT module. |
AnnaBridge | 171:3a7713b1edbc | 216 | * |
AnnaBridge | 171:3a7713b1edbc | 217 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 218 | * @return The CMT mode. |
AnnaBridge | 171:3a7713b1edbc | 219 | * kCMT_DirectIROCtl Carrier modulator is disabled, the IRO signal is directly in software control. |
AnnaBridge | 171:3a7713b1edbc | 220 | * kCMT_TimeMode Carrier modulator is enabled in time mode. |
AnnaBridge | 171:3a7713b1edbc | 221 | * kCMT_FSKMode Carrier modulator is enabled in FSK mode. |
AnnaBridge | 171:3a7713b1edbc | 222 | * kCMT_BasebandMode Carrier modulator is enabled in baseband mode. |
AnnaBridge | 171:3a7713b1edbc | 223 | */ |
AnnaBridge | 171:3a7713b1edbc | 224 | cmt_mode_t CMT_GetMode(CMT_Type *base); |
AnnaBridge | 171:3a7713b1edbc | 225 | |
AnnaBridge | 171:3a7713b1edbc | 226 | /*! |
AnnaBridge | 171:3a7713b1edbc | 227 | * @brief Gets the actual CMT clock frequency. |
AnnaBridge | 171:3a7713b1edbc | 228 | * |
AnnaBridge | 171:3a7713b1edbc | 229 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 230 | * @param busClock_Hz CMT module input clock - bus clock frequency. |
AnnaBridge | 171:3a7713b1edbc | 231 | * @return The CMT clock frequency. |
AnnaBridge | 171:3a7713b1edbc | 232 | */ |
AnnaBridge | 171:3a7713b1edbc | 233 | uint32_t CMT_GetCMTFrequency(CMT_Type *base, uint32_t busClock_Hz); |
AnnaBridge | 171:3a7713b1edbc | 234 | |
AnnaBridge | 171:3a7713b1edbc | 235 | /*! |
AnnaBridge | 171:3a7713b1edbc | 236 | * @brief Sets the primary data set for the CMT carrier generator counter. |
AnnaBridge | 171:3a7713b1edbc | 237 | * |
AnnaBridge | 171:3a7713b1edbc | 238 | * This function sets the high time and low time of the primary data set for the |
AnnaBridge | 171:3a7713b1edbc | 239 | * CMT carrier generator counter to control the period and the duty cycle of the |
AnnaBridge | 171:3a7713b1edbc | 240 | * output carrier signal. |
AnnaBridge | 171:3a7713b1edbc | 241 | * If the CMT clock period is Tcmt, The period of the carrier generator signal equals |
AnnaBridge | 171:3a7713b1edbc | 242 | * (highCount + lowCount) * Tcmt. The duty cycle equals highCount / (highCount + lowCount). |
AnnaBridge | 171:3a7713b1edbc | 243 | * |
AnnaBridge | 171:3a7713b1edbc | 244 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 245 | * @param highCount The number of CMT clocks for carrier generator signal high time, |
AnnaBridge | 171:3a7713b1edbc | 246 | * integer in the range of 1 ~ 0xFF. |
AnnaBridge | 171:3a7713b1edbc | 247 | * @param lowCount The number of CMT clocks for carrier generator signal low time, |
AnnaBridge | 171:3a7713b1edbc | 248 | * integer in the range of 1 ~ 0xFF. |
AnnaBridge | 171:3a7713b1edbc | 249 | */ |
AnnaBridge | 171:3a7713b1edbc | 250 | static inline void CMT_SetCarrirGenerateCountOne(CMT_Type *base, uint32_t highCount, uint32_t lowCount) |
AnnaBridge | 171:3a7713b1edbc | 251 | { |
AnnaBridge | 171:3a7713b1edbc | 252 | assert(highCount <= CMT_CGH1_PH_MASK); |
AnnaBridge | 171:3a7713b1edbc | 253 | assert(highCount); |
AnnaBridge | 171:3a7713b1edbc | 254 | assert(lowCount <= CMT_CGL1_PL_MASK); |
AnnaBridge | 171:3a7713b1edbc | 255 | assert(lowCount); |
AnnaBridge | 171:3a7713b1edbc | 256 | |
AnnaBridge | 171:3a7713b1edbc | 257 | base->CGH1 = highCount; |
AnnaBridge | 171:3a7713b1edbc | 258 | base->CGL1 = lowCount; |
AnnaBridge | 171:3a7713b1edbc | 259 | } |
AnnaBridge | 171:3a7713b1edbc | 260 | |
AnnaBridge | 171:3a7713b1edbc | 261 | /*! |
AnnaBridge | 171:3a7713b1edbc | 262 | * @brief Sets the secondary data set for the CMT carrier generator counter. |
AnnaBridge | 171:3a7713b1edbc | 263 | * |
AnnaBridge | 171:3a7713b1edbc | 264 | * This function is used for FSK mode setting the high time and low time of the secondary |
AnnaBridge | 171:3a7713b1edbc | 265 | * data set CMT carrier generator counter to control the period and the duty cycle |
AnnaBridge | 171:3a7713b1edbc | 266 | * of the output carrier signal. |
AnnaBridge | 171:3a7713b1edbc | 267 | * If the CMT clock period is Tcmt, The period of the carrier generator signal equals |
AnnaBridge | 171:3a7713b1edbc | 268 | * (highCount + lowCount) * Tcmt. The duty cycle equals highCount / (highCount + lowCount). |
AnnaBridge | 171:3a7713b1edbc | 269 | * |
AnnaBridge | 171:3a7713b1edbc | 270 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 271 | * @param highCount The number of CMT clocks for carrier generator signal high time, |
AnnaBridge | 171:3a7713b1edbc | 272 | * integer in the range of 1 ~ 0xFF. |
AnnaBridge | 171:3a7713b1edbc | 273 | * @param lowCount The number of CMT clocks for carrier generator signal low time, |
AnnaBridge | 171:3a7713b1edbc | 274 | * integer in the range of 1 ~ 0xFF. |
AnnaBridge | 171:3a7713b1edbc | 275 | */ |
AnnaBridge | 171:3a7713b1edbc | 276 | static inline void CMT_SetCarrirGenerateCountTwo(CMT_Type *base, uint32_t highCount, uint32_t lowCount) |
AnnaBridge | 171:3a7713b1edbc | 277 | { |
AnnaBridge | 171:3a7713b1edbc | 278 | assert(highCount <= CMT_CGH2_SH_MASK); |
AnnaBridge | 171:3a7713b1edbc | 279 | assert(highCount); |
AnnaBridge | 171:3a7713b1edbc | 280 | assert(lowCount <= CMT_CGL2_SL_MASK); |
AnnaBridge | 171:3a7713b1edbc | 281 | assert(lowCount); |
AnnaBridge | 171:3a7713b1edbc | 282 | |
AnnaBridge | 171:3a7713b1edbc | 283 | base->CGH2 = highCount; |
AnnaBridge | 171:3a7713b1edbc | 284 | base->CGL2 = lowCount; |
AnnaBridge | 171:3a7713b1edbc | 285 | } |
AnnaBridge | 171:3a7713b1edbc | 286 | |
AnnaBridge | 171:3a7713b1edbc | 287 | /*! |
AnnaBridge | 171:3a7713b1edbc | 288 | * @brief Sets the modulation mark and space time period for the CMT modulator. |
AnnaBridge | 171:3a7713b1edbc | 289 | * |
AnnaBridge | 171:3a7713b1edbc | 290 | * This function sets the mark time period of the CMT modulator counter |
AnnaBridge | 171:3a7713b1edbc | 291 | * to control the mark time of the output modulated signal from the carrier generator output signal. |
AnnaBridge | 171:3a7713b1edbc | 292 | * If the CMT clock frequency is Fcmt and the carrier out signal frequency is fcg: |
AnnaBridge | 171:3a7713b1edbc | 293 | * - In Time and Baseband mode: The mark period of the generated signal equals (markCount + 1) / (Fcmt/8). |
AnnaBridge | 171:3a7713b1edbc | 294 | * The space period of the generated signal equals spaceCount / (Fcmt/8). |
AnnaBridge | 171:3a7713b1edbc | 295 | * - In FSK mode: The mark period of the generated signal equals (markCount + 1)/fcg. |
AnnaBridge | 171:3a7713b1edbc | 296 | * The space period of the generated signal equals spaceCount / fcg. |
AnnaBridge | 171:3a7713b1edbc | 297 | * |
AnnaBridge | 171:3a7713b1edbc | 298 | * @param base Base address for current CMT instance. |
AnnaBridge | 171:3a7713b1edbc | 299 | * @param markCount The number of clock period for CMT modulator signal mark period, |
AnnaBridge | 171:3a7713b1edbc | 300 | * in the range of 0 ~ 0xFFFF. |
AnnaBridge | 171:3a7713b1edbc | 301 | * @param spaceCount The number of clock period for CMT modulator signal space period, |
AnnaBridge | 171:3a7713b1edbc | 302 | * in the range of the 0 ~ 0xFFFF. |
AnnaBridge | 171:3a7713b1edbc | 303 | */ |
AnnaBridge | 171:3a7713b1edbc | 304 | void CMT_SetModulateMarkSpace(CMT_Type *base, uint32_t markCount, uint32_t spaceCount); |
AnnaBridge | 171:3a7713b1edbc | 305 | |
AnnaBridge | 171:3a7713b1edbc | 306 | /*! |
AnnaBridge | 171:3a7713b1edbc | 307 | * @brief Enables or disables the extended space operation. |
AnnaBridge | 171:3a7713b1edbc | 308 | * |
AnnaBridge | 171:3a7713b1edbc | 309 | * This function is used to make the space period longer |
AnnaBridge | 171:3a7713b1edbc | 310 | * for time, baseband, and FSK modes. |
AnnaBridge | 171:3a7713b1edbc | 311 | * |
AnnaBridge | 171:3a7713b1edbc | 312 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 313 | * @param enable True enable the extended space, false disable the extended space. |
AnnaBridge | 171:3a7713b1edbc | 314 | */ |
AnnaBridge | 171:3a7713b1edbc | 315 | static inline void CMT_EnableExtendedSpace(CMT_Type *base, bool enable) |
AnnaBridge | 171:3a7713b1edbc | 316 | { |
AnnaBridge | 171:3a7713b1edbc | 317 | if (enable) |
AnnaBridge | 171:3a7713b1edbc | 318 | { |
AnnaBridge | 171:3a7713b1edbc | 319 | base->MSC |= CMT_MSC_EXSPC_MASK; |
AnnaBridge | 171:3a7713b1edbc | 320 | } |
AnnaBridge | 171:3a7713b1edbc | 321 | else |
AnnaBridge | 171:3a7713b1edbc | 322 | { |
AnnaBridge | 171:3a7713b1edbc | 323 | base->MSC &= ~CMT_MSC_EXSPC_MASK; |
AnnaBridge | 171:3a7713b1edbc | 324 | } |
AnnaBridge | 171:3a7713b1edbc | 325 | } |
AnnaBridge | 171:3a7713b1edbc | 326 | |
AnnaBridge | 171:3a7713b1edbc | 327 | /*! |
AnnaBridge | 171:3a7713b1edbc | 328 | * @brief Sets IRO - infrared output signal state. |
AnnaBridge | 171:3a7713b1edbc | 329 | * |
AnnaBridge | 171:3a7713b1edbc | 330 | * Changes the states of the IRO signal when the kCMT_DirectIROMode mode is set |
AnnaBridge | 171:3a7713b1edbc | 331 | * and the IRO signal is enabled. |
AnnaBridge | 171:3a7713b1edbc | 332 | * |
AnnaBridge | 171:3a7713b1edbc | 333 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 334 | * @param state The control of the IRO signal. See "cmt_infrared_output_state_t" |
AnnaBridge | 171:3a7713b1edbc | 335 | */ |
AnnaBridge | 171:3a7713b1edbc | 336 | void CMT_SetIroState(CMT_Type *base, cmt_infrared_output_state_t state); |
AnnaBridge | 171:3a7713b1edbc | 337 | |
AnnaBridge | 171:3a7713b1edbc | 338 | /*! |
AnnaBridge | 171:3a7713b1edbc | 339 | * @brief Enables the CMT interrupt. |
AnnaBridge | 171:3a7713b1edbc | 340 | * |
AnnaBridge | 171:3a7713b1edbc | 341 | * This function enables the CMT interrupts according to the provided maskIf enabled. |
AnnaBridge | 171:3a7713b1edbc | 342 | * The CMT only has the end of the cycle interrupt - an interrupt occurs at the end |
AnnaBridge | 171:3a7713b1edbc | 343 | * of the modulator cycle. This interrupt provides a means for the user |
AnnaBridge | 171:3a7713b1edbc | 344 | * to reload the new mark/space values into the CMT modulator data registers |
AnnaBridge | 171:3a7713b1edbc | 345 | * and verify the modulator mark and space. |
AnnaBridge | 171:3a7713b1edbc | 346 | * For example, to enable the end of cycle, do the following: |
AnnaBridge | 171:3a7713b1edbc | 347 | * @code |
AnnaBridge | 171:3a7713b1edbc | 348 | * CMT_EnableInterrupts(CMT, kCMT_EndOfCycleInterruptEnable); |
AnnaBridge | 171:3a7713b1edbc | 349 | * @endcode |
AnnaBridge | 171:3a7713b1edbc | 350 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 351 | * @param mask The interrupts to enable. Logical OR of @ref _cmt_interrupt_enable. |
AnnaBridge | 171:3a7713b1edbc | 352 | */ |
AnnaBridge | 171:3a7713b1edbc | 353 | static inline void CMT_EnableInterrupts(CMT_Type *base, uint32_t mask) |
AnnaBridge | 171:3a7713b1edbc | 354 | { |
AnnaBridge | 171:3a7713b1edbc | 355 | base->MSC |= mask; |
AnnaBridge | 171:3a7713b1edbc | 356 | } |
AnnaBridge | 171:3a7713b1edbc | 357 | |
AnnaBridge | 171:3a7713b1edbc | 358 | /*! |
AnnaBridge | 171:3a7713b1edbc | 359 | * @brief Disables the CMT interrupt. |
AnnaBridge | 171:3a7713b1edbc | 360 | * |
AnnaBridge | 171:3a7713b1edbc | 361 | * This function disables the CMT interrupts according to the provided maskIf enabled. |
AnnaBridge | 171:3a7713b1edbc | 362 | * The CMT only has the end of the cycle interrupt. |
AnnaBridge | 171:3a7713b1edbc | 363 | * For example, to disable the end of cycle, do the following: |
AnnaBridge | 171:3a7713b1edbc | 364 | * @code |
AnnaBridge | 171:3a7713b1edbc | 365 | * CMT_DisableInterrupts(CMT, kCMT_EndOfCycleInterruptEnable); |
AnnaBridge | 171:3a7713b1edbc | 366 | * @endcode |
AnnaBridge | 171:3a7713b1edbc | 367 | * |
AnnaBridge | 171:3a7713b1edbc | 368 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 369 | * @param mask The interrupts to enable. Logical OR of @ref _cmt_interrupt_enable. |
AnnaBridge | 171:3a7713b1edbc | 370 | */ |
AnnaBridge | 171:3a7713b1edbc | 371 | static inline void CMT_DisableInterrupts(CMT_Type *base, uint32_t mask) |
AnnaBridge | 171:3a7713b1edbc | 372 | { |
AnnaBridge | 171:3a7713b1edbc | 373 | base->MSC &= ~mask; |
AnnaBridge | 171:3a7713b1edbc | 374 | } |
AnnaBridge | 171:3a7713b1edbc | 375 | |
AnnaBridge | 171:3a7713b1edbc | 376 | /*! |
AnnaBridge | 171:3a7713b1edbc | 377 | * @brief Gets the end of the cycle status flag. |
AnnaBridge | 171:3a7713b1edbc | 378 | * |
AnnaBridge | 171:3a7713b1edbc | 379 | * The flag is set: |
AnnaBridge | 171:3a7713b1edbc | 380 | * - When the modulator is not currently active and carrier and modulator |
AnnaBridge | 171:3a7713b1edbc | 381 | * are set to start the initial CMT transmission. |
AnnaBridge | 171:3a7713b1edbc | 382 | * - At the end of each modulation cycle when the counter is reloaded and |
AnnaBridge | 171:3a7713b1edbc | 383 | * the carrier and modulator are enabled. |
AnnaBridge | 171:3a7713b1edbc | 384 | * @param base CMT peripheral base address. |
AnnaBridge | 171:3a7713b1edbc | 385 | * @return Current status of the end of cycle status flag |
AnnaBridge | 171:3a7713b1edbc | 386 | * @arg non-zero: End-of-cycle has occurred. |
AnnaBridge | 171:3a7713b1edbc | 387 | * @arg zero: End-of-cycle has not yet occurred since the flag last cleared. |
AnnaBridge | 171:3a7713b1edbc | 388 | */ |
AnnaBridge | 171:3a7713b1edbc | 389 | static inline uint32_t CMT_GetStatusFlags(CMT_Type *base) |
AnnaBridge | 171:3a7713b1edbc | 390 | { |
AnnaBridge | 171:3a7713b1edbc | 391 | return base->MSC & CMT_MSC_EOCF_MASK; |
AnnaBridge | 171:3a7713b1edbc | 392 | } |
AnnaBridge | 171:3a7713b1edbc | 393 | |
AnnaBridge | 171:3a7713b1edbc | 394 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 395 | |
AnnaBridge | 171:3a7713b1edbc | 396 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 397 | } |
AnnaBridge | 171:3a7713b1edbc | 398 | #endif |
AnnaBridge | 171:3a7713b1edbc | 399 | |
AnnaBridge | 171:3a7713b1edbc | 400 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 401 | |
AnnaBridge | 171:3a7713b1edbc | 402 | #endif /* _FSL_CMT_H_*/ |