Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 | /*
* Copyright (c) 2015, Freescale Semiconductor, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* o Redistributions in binary form 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.
*
* o Neither the name of Freescale Semiconductor, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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 _FSL_FTM_H_
#define _FSL_FTM_H_
#include "fsl_common.h"
/*!
* @addtogroup ftm_driver
* @{
*/
/*! @file */
/*******************************************************************************
* Definitions
******************************************************************************/
/*! @name Driver version */
/*@{*/
#define FSL_FTM_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) /*!< Version 2.0.0 */
/*@}*/
/*!
* @brief List of FTM channels
* @note Actual number of available channels is SoC dependent
*/
typedef enum _ftm_chnl
{
kFTM_Chnl_0 = 0U, /*!< FTM channel number 0*/
kFTM_Chnl_1, /*!< FTM channel number 1 */
kFTM_Chnl_2, /*!< FTM channel number 2 */
kFTM_Chnl_3, /*!< FTM channel number 3 */
kFTM_Chnl_4, /*!< FTM channel number 4 */
kFTM_Chnl_5, /*!< FTM channel number 5 */
kFTM_Chnl_6, /*!< FTM channel number 6 */
kFTM_Chnl_7 /*!< FTM channel number 7 */
} ftm_chnl_t;
/*! @brief List of FTM faults */
typedef enum _ftm_fault_input
{
kFTM_Fault_0 = 0U, /*!< FTM fault 0 input pin */
kFTM_Fault_1, /*!< FTM fault 1 input pin */
kFTM_Fault_2, /*!< FTM fault 2 input pin */
kFTM_Fault_3 /*!< FTM fault 3 input pin */
} ftm_fault_input_t;
/*! @brief FTM PWM operation modes */
typedef enum _ftm_pwm_mode
{
kFTM_EdgeAlignedPwm = 0U, /*!< Edge-aligned PWM */
kFTM_CenterAlignedPwm, /*!< Center-aligned PWM */
kFTM_CombinedPwm /*!< Combined PWM */
} ftm_pwm_mode_t;
/*! @brief FTM PWM output pulse mode: high-true, low-true or no output */
typedef enum _ftm_pwm_level_select
{
kFTM_NoPwmSignal = 0U, /*!< No PWM output on pin */
kFTM_LowTrue, /*!< Low true pulses */
kFTM_HighTrue /*!< High true pulses */
} ftm_pwm_level_select_t;
/*! @brief Options to configure a FTM channel's PWM signal */
typedef struct _ftm_chnl_pwm_signal_param
{
ftm_chnl_t chnlNumber; /*!< The channel/channel pair number.
In combined mode, this represents the channel pair number. */
ftm_pwm_level_select_t level; /*!< PWM output active level select. */
uint8_t dutyCyclePercent; /*!< PWM pulse width, value should be between 0 to 100
0 = inactive signal(0% duty cycle)...
100 = always active signal (100% duty cycle).*/
uint8_t firstEdgeDelayPercent; /*!< Used only in combined PWM mode to generate an asymmetrical PWM.
Specifies the delay to the first edge in a PWM period.
If unsure leave as 0; Should be specified as a
percentage of the PWM period */
} ftm_chnl_pwm_signal_param_t;
/*! @brief FlexTimer output compare mode */
typedef enum _ftm_output_compare_mode
{
kFTM_NoOutputSignal = (1U << FTM_CnSC_MSA_SHIFT), /*!< No channel output when counter reaches CnV */
kFTM_ToggleOnMatch = ((1U << FTM_CnSC_MSA_SHIFT) | (1U << FTM_CnSC_ELSA_SHIFT)), /*!< Toggle output */
kFTM_ClearOnMatch = ((1U << FTM_CnSC_MSA_SHIFT) | (2U << FTM_CnSC_ELSA_SHIFT)), /*!< Clear output */
kFTM_SetOnMatch = ((1U << FTM_CnSC_MSA_SHIFT) | (3U << FTM_CnSC_ELSA_SHIFT)) /*!< Set output */
} ftm_output_compare_mode_t;
/*! @brief FlexTimer input capture edge */
typedef enum _ftm_input_capture_edge
{
kFTM_RisingEdge = (1U << FTM_CnSC_ELSA_SHIFT), /*!< Capture on rising edge only*/
kFTM_FallingEdge = (2U << FTM_CnSC_ELSA_SHIFT), /*!< Capture on falling edge only*/
kFTM_RiseAndFallEdge = (3U << FTM_CnSC_ELSA_SHIFT) /*!< Capture on rising or falling edge */
} ftm_input_capture_edge_t;
/*! @brief FlexTimer dual edge capture modes */
typedef enum _ftm_dual_edge_capture_mode
{
kFTM_OneShot = 0U, /*!< One-shot capture mode */
kFTM_Continuous = (1U << FTM_CnSC_MSA_SHIFT) /*!< Continuous capture mode */
} ftm_dual_edge_capture_mode_t;
/*! @brief FlexTimer dual edge capture parameters */
typedef struct _ftm_dual_edge_capture_param
{
ftm_dual_edge_capture_mode_t mode; /*!< Dual Edge Capture mode */
ftm_input_capture_edge_t currChanEdgeMode; /*!< Input capture edge select for channel n */
ftm_input_capture_edge_t nextChanEdgeMode; /*!< Input capture edge select for channel n+1 */
} ftm_dual_edge_capture_param_t;
/*! @brief FlexTimer quadrature decode modes */
typedef enum _ftm_quad_decode_mode
{
kFTM_QuadPhaseEncode = 0U, /*!< Phase A and Phase B encoding mode */
kFTM_QuadCountAndDir /*!< Count and direction encoding mode */
} ftm_quad_decode_mode_t;
/*! @brief FlexTimer quadrature phase polarities */
typedef enum _ftm_phase_polarity
{
kFTM_QuadPhaseNormal = 0U, /*!< Phase input signal is not inverted */
kFTM_QuadPhaseInvert /*!< Phase input signal is inverted */
} ftm_phase_polarity_t;
/*! @brief FlexTimer quadrature decode phase parameters */
typedef struct _ftm_phase_param
{
bool enablePhaseFilter; /*!< True: enable phase filter; false: disable filter */
uint32_t phaseFilterVal; /*!< Filter value, used only if phase filter is enabled */
ftm_phase_polarity_t phasePolarity; /*!< Phase polarity */
} ftm_phase_params_t;
/*! @brief Structure is used to hold the parameters to configure a FTM fault */
typedef struct _ftm_fault_param
{
bool enableFaultInput; /*!< True: Fault input is enabled; false: Fault input is disabled */
bool faultLevel; /*!< True: Fault polarity is active low i.e '0' indicates a fault;
False: Fault polarity is active high */
bool useFaultFilter; /*!< True: Use the filtered fault signal;
False: Use the direct path from fault input */
} ftm_fault_param_t;
/*! @brief FlexTimer pre-scaler factor for the dead time insertion*/
typedef enum _ftm_deadtime_prescale
{
kFTM_Deadtime_Prescale_1 = 1U, /*!< Divide by 1 */
kFTM_Deadtime_Prescale_4, /*!< Divide by 4 */
kFTM_Deadtime_Prescale_16 /*!< Divide by 16 */
} ftm_deadtime_prescale_t;
/*! @brief FlexTimer clock source selection*/
typedef enum _ftm_clock_source
{
kFTM_SystemClock = 1U, /*!< System clock selected */
kFTM_FixedClock, /*!< Fixed frequency clock */
kFTM_ExternalClock /*!< External clock */
} ftm_clock_source_t;
/*! @brief FlexTimer pre-scaler factor selection for the clock source*/
typedef enum _ftm_clock_prescale
{
kFTM_Prescale_Divide_1 = 0U, /*!< Divide by 1 */
kFTM_Prescale_Divide_2, /*!< Divide by 2 */
kFTM_Prescale_Divide_4, /*!< Divide by 4 */
kFTM_Prescale_Divide_8, /*!< Divide by 8 */
kFTM_Prescale_Divide_16, /*!< Divide by 16 */
kFTM_Prescale_Divide_32, /*!< Divide by 32 */
kFTM_Prescale_Divide_64, /*!< Divide by 64 */
kFTM_Prescale_Divide_128 /*!< Divide by 128 */
} ftm_clock_prescale_t;
/*! @brief Options for the FlexTimer behaviour in BDM Mode */
typedef enum _ftm_bdm_mode
{
kFTM_BdmMode_0 = 0U,
/*!< FTM counter stopped, CH(n)F bit can be set, FTM channels in functional mode, writes to MOD,CNTIN and C(n)V
registers bypass the register buffers */
kFTM_BdmMode_1,
/*!< FTM counter stopped, CH(n)F bit is not set, FTM channels outputs are forced to their safe value , writes to
MOD,CNTIN and C(n)V registers bypass the register buffers */
kFTM_BdmMode_2,
/*!< FTM counter stopped, CH(n)F bit is not set, FTM channels outputs are frozen when chip enters in BDM mode,
writes to MOD,CNTIN and C(n)V registers bypass the register buffers */
kFTM_BdmMode_3
/*!< FTM counter in functional mode, CH(n)F bit can be set, FTM channels in functional mode, writes to MOD,CNTIN and
C(n)V registers is in fully functional mode */
} ftm_bdm_mode_t;
/*! @brief Options for the FTM fault control mode */
typedef enum _ftm_fault_mode
{
kFTM_Fault_Disable = 0U, /*!< Fault control is disabled for all channels */
kFTM_Fault_EvenChnls, /*!< Enabled for even channels only(0,2,4,6) with manual fault clearing */
kFTM_Fault_AllChnlsMan, /*!< Enabled for all channels with manual fault clearing */
kFTM_Fault_AllChnlsAuto /*!< Enabled for all channels with automatic fault clearing */
} ftm_fault_mode_t;
/*!
* @brief FTM external trigger options
* @note Actual available external trigger sources are SoC-specific
*/
typedef enum _ftm_external_trigger
{
kFTM_Chnl0Trigger = (1U << 4), /*!< Generate trigger when counter equals chnl 0 CnV reg */
kFTM_Chnl1Trigger = (1U << 5), /*!< Generate trigger when counter equals chnl 1 CnV reg */
kFTM_Chnl2Trigger = (1U << 0), /*!< Generate trigger when counter equals chnl 2 CnV reg */
kFTM_Chnl3Trigger = (1U << 1), /*!< Generate trigger when counter equals chnl 3 CnV reg */
kFTM_Chnl4Trigger = (1U << 2), /*!< Generate trigger when counter equals chnl 4 CnV reg */
kFTM_Chnl5Trigger = (1U << 3), /*!< Generate trigger when counter equals chnl 5 CnV reg */
kFTM_Chnl6Trigger =
(1U << 8), /*!< Available on certain SoC's, generate trigger when counter equals chnl 6 CnV reg */
kFTM_Chnl7Trigger =
(1U << 9), /*!< Available on certain SoC's, generate trigger when counter equals chnl 7 CnV reg */
kFTM_InitTrigger = (1U << 6), /*!< Generate Trigger when counter is updated with CNTIN */
kFTM_ReloadInitTrigger = (1U << 7) /*!< Available on certain SoC's, trigger on reload point */
} ftm_external_trigger_t;
/*! @brief FlexTimer PWM sync options to update registers with buffer */
typedef enum _ftm_pwm_sync_method
{
kFTM_SoftwareTrigger = FTM_SYNC_SWSYNC_MASK, /*!< Software triggers PWM sync */
kFTM_HardwareTrigger_0 = FTM_SYNC_TRIG0_MASK, /*!< Hardware trigger 0 causes PWM sync */
kFTM_HardwareTrigger_1 = FTM_SYNC_TRIG1_MASK, /*!< Hardware trigger 1 causes PWM sync */
kFTM_HardwareTrigger_2 = FTM_SYNC_TRIG2_MASK /*!< Hardware trigger 2 causes PWM sync */
} ftm_pwm_sync_method_t;
/*!
* @brief FTM options available as loading point for register reload
* @note Actual available reload points are SoC-specific
*/
typedef enum _ftm_reload_point
{
kFTM_Chnl0Match = (1U << 0), /*!< Channel 0 match included as a reload point */
kFTM_Chnl1Match = (1U << 1), /*!< Channel 1 match included as a reload point */
kFTM_Chnl2Match = (1U << 2), /*!< Channel 2 match included as a reload point */
kFTM_Chnl3Match = (1U << 3), /*!< Channel 3 match included as a reload point */
kFTM_Chnl4Match = (1U << 4), /*!< Channel 4 match included as a reload point */
kFTM_Chnl5Match = (1U << 5), /*!< Channel 5 match included as a reload point */
kFTM_Chnl6Match = (1U << 6), /*!< Channel 6 match included as a reload point */
kFTM_Chnl7Match = (1U << 7), /*!< Channel 7 match included as a reload point */
kFTM_CntMax = (1U << 8), /*!< Use in up-down count mode only, reload when counter reaches the maximum value */
kFTM_CntMin = (1U << 9), /*!< Use in up-down count mode only, reload when counter reaches the minimum value */
kFTM_HalfCycMatch = (1U << 10) /*!< Available on certain SoC's, half cycle match reload point */
} ftm_reload_point_t;
/*!
* @brief List of FTM interrupts
* @note Actual available interrupts are SoC-specific
*/
typedef enum _ftm_interrupt_enable
{
kFTM_Chnl0InterruptEnable = (1U << 0), /*!< Channel 0 interrupt */
kFTM_Chnl1InterruptEnable = (1U << 1), /*!< Channel 1 interrupt */
kFTM_Chnl2InterruptEnable = (1U << 2), /*!< Channel 2 interrupt */
kFTM_Chnl3InterruptEnable = (1U << 3), /*!< Channel 3 interrupt */
kFTM_Chnl4InterruptEnable = (1U << 4), /*!< Channel 4 interrupt */
kFTM_Chnl5InterruptEnable = (1U << 5), /*!< Channel 5 interrupt */
kFTM_Chnl6InterruptEnable = (1U << 6), /*!< Channel 6 interrupt */
kFTM_Chnl7InterruptEnable = (1U << 7), /*!< Channel 7 interrupt */
kFTM_FaultInterruptEnable = (1U << 8), /*!< Fault interrupt */
kFTM_TimeOverflowInterruptEnable = (1U << 9), /*!< Time overflow interrupt */
kFTM_ReloadInterruptEnable = (1U << 10) /*!< Reload interrupt; Available only on certain SoC's */
} ftm_interrupt_enable_t;
/*!
* @brief List of FTM flags
* @note Actual available flags are SoC-specific
*/
typedef enum _ftm_status_flags
{
kFTM_Chnl0Flag = (1U << 0), /*!< Channel 0 Flag */
kFTM_Chnl1Flag = (1U << 1), /*!< Channel 1 Flag */
kFTM_Chnl2Flag = (1U << 2), /*!< Channel 2 Flag */
kFTM_Chnl3Flag = (1U << 3), /*!< Channel 3 Flag */
kFTM_Chnl4Flag = (1U << 4), /*!< Channel 4 Flag */
kFTM_Chnl5Flag = (1U << 5), /*!< Channel 5 Flag */
kFTM_Chnl6Flag = (1U << 6), /*!< Channel 6 Flag */
kFTM_Chnl7Flag = (1U << 7), /*!< Channel 7 Flag */
kFTM_FaultFlag = (1U << 8), /*!< Fault Flag */
kFTM_TimeOverflowFlag = (1U << 9), /*!< Time overflow Flag */
kFTM_ChnlTriggerFlag = (1U << 10), /*!< Channel trigger Flag */
kFTM_ReloadFlag = (1U << 11) /*!< Reload Flag; Available only on certain SoC's */
} ftm_status_flags_t;
/*!
* @brief FTM configuration structure
*
* This structure holds the configuration settings for the FTM peripheral. To initialize this
* structure to reasonable defaults, call the FTM_GetDefaultConfig() function and pass a
* pointer to the configuration structure instance.
*
* The configuration structure can be made constant so as to reside in flash.
*/
typedef struct _ftm_config
{
ftm_clock_prescale_t prescale; /*!< FTM clock prescale value */
ftm_bdm_mode_t bdmMode; /*!< FTM behavior in BDM mode */
uint32_t pwmSyncMode; /*!< Synchronization methods to use to update buffered registers; Multiple
update modes can be used by providing an OR'ed list of options
available in enumeration ::ftm_pwm_sync_method_t. */
uint32_t reloadPoints; /*!< FTM reload points; When using this, the PWM
synchronization is not required. Multiple reload points can be used by providing
an OR'ed list of options available in
enumeration ::ftm_reload_point_t. */
ftm_fault_mode_t faultMode; /*!< FTM fault control mode */
uint8_t faultFilterValue; /*!< Fault input filter value */
ftm_deadtime_prescale_t deadTimePrescale; /*!< The dead time prescalar value */
uint8_t deadTimeValue; /*!< The dead time value */
uint32_t extTriggers; /*!< External triggers to enable. Multiple trigger sources can be
enabled by providing an OR'ed list of options available in
enumeration ::ftm_external_trigger_t. */
uint8_t chnlInitState; /*!< Defines the initialization value of the channels in OUTINT register */
uint8_t chnlPolarity; /*!< Defines the output polarity of the channels in POL register */
bool useGlobalTimeBase; /*!< True: Use of an external global time base is enabled;
False: disabled */
} ftm_config_t;
/*******************************************************************************
* API
******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
/*!
* @name Initialization and deinitialization
* @{
*/
/*!
* @brief Ungates the FTM clock and configures the peripheral for basic operation.
*
* @note This API should be called at the beginning of the application using the FTM driver.
*
* @param base FTM peripheral base address
* @param config Pointer to the user configuration structure.
*
* @return kStatus_Success indicates success; Else indicates failure.
*/
status_t FTM_Init(FTM_Type *base, const ftm_config_t *config);
/*!
* @brief Gates the FTM clock.
*
* @param base FTM peripheral base address
*/
void FTM_Deinit(FTM_Type *base);
/*!
* @brief Fills in the FTM configuration structure with the default settings.
*
* The default values are:
* @code
* config->prescale = kFTM_Prescale_Divide_1;
* config->bdmMode = kFTM_BdmMode_0;
* config->pwmSyncMode = kFTM_SoftwareTrigger;
* config->reloadPoints = 0;
* config->faultMode = kFTM_Fault_Disable;
* config->faultFilterValue = 0;
* config->deadTimePrescale = kFTM_Deadtime_Prescale_1;
* config->deadTimeValue = 0;
* config->extTriggers = 0;
* config->chnlInitState = 0;
* config->chnlPolarity = 0;
* config->useGlobalTimeBase = false;
* @endcode
* @param config Pointer to the user configuration structure.
*/
void FTM_GetDefaultConfig(ftm_config_t *config);
/*! @}*/
/*!
* @name Channel mode operations
* @{
*/
/*!
* @brief Configures the PWM signal parameters.
*
* Call this function to configure the PWM signal period, mode, duty cycle, and edge. Use this
* function to configure all FTM channels that are used to output a PWM signal.
*
* @param base FTM peripheral base address
* @param chnlParams Array of PWM channel parameters to configure the channel(s)
* @param numOfChnls Number of channels to configure; This should be the size of the array passed in
* @param mode PWM operation mode, options available in enumeration ::ftm_pwm_mode_t
* @param pwmFreq_Hz PWM signal frequency in Hz
* @param srcClock_Hz FTM counter clock in Hz
*
* @return kStatus_Success if the PWM setup was successful
* kStatus_Error on failure
*/
status_t FTM_SetupPwm(FTM_Type *base,
const ftm_chnl_pwm_signal_param_t *chnlParams,
uint8_t numOfChnls,
ftm_pwm_mode_t mode,
uint32_t pwmFreq_Hz,
uint32_t srcClock_Hz);
/*!
* @brief Updates the duty cycle of an active PWM signal.
*
* @param base FTM peripheral base address
* @param chnlNumber The channel/channel pair number. In combined mode, this represents
* the channel pair number
* @param currentPwmMode The current PWM mode set during PWM setup
* @param dutyCyclePercent New PWM pulse width; The value should be between 0 to 100
* 0=inactive signal(0% duty cycle)...
* 100=active signal (100% duty cycle)
*/
void FTM_UpdatePwmDutycycle(FTM_Type *base,
ftm_chnl_t chnlNumber,
ftm_pwm_mode_t currentPwmMode,
uint8_t dutyCyclePercent);
/*!
* @brief Updates the edge level selection for a channel.
*
* @param base FTM peripheral base address
* @param chnlNumber The channel number
* @param level The level to be set to the ELSnB:ELSnA field; Valid values are 00, 01, 10, 11.
* See the Kinetis SoC reference manual for details about this field.
*/
void FTM_UpdateChnlEdgeLevelSelect(FTM_Type *base, ftm_chnl_t chnlNumber, uint8_t level);
/*!
* @brief Enables capturing an input signal on the channel using the function parameters.
*
* When the edge specified in the captureMode argument occurs on the channel, the FTM counter is
* captured into the CnV register. The user has to read the CnV register separately to get this
* value. The filter function is disabled if the filterVal argument passed in is 0. The filter
* function is available only for channels 0, 1, 2, 3.
*
* @param base FTM peripheral base address
* @param chnlNumber The channel number
* @param captureMode Specifies which edge to capture
* @param filterValue Filter value, specify 0 to disable filter. Available only for channels 0-3.
*/
void FTM_SetupInputCapture(FTM_Type *base,
ftm_chnl_t chnlNumber,
ftm_input_capture_edge_t captureMode,
uint32_t filterValue);
/*!
* @brief Configures the FTM to generate timed pulses.
*
* When the FTM counter matches the value of compareVal argument (this is written into CnV reg),
* the channel output is changed based on what is specified in the compareMode argument.
*
* @param base FTM peripheral base address
* @param chnlNumber The channel number
* @param compareMode Action to take on the channel output when the compare condition is met
* @param compareValue Value to be programmed in the CnV register.
*/
void FTM_SetupOutputCompare(FTM_Type *base,
ftm_chnl_t chnlNumber,
ftm_output_compare_mode_t compareMode,
uint32_t compareValue);
/*!
* @brief Configures the dual edge capture mode of the FTM.
*
* This function sets up the dual edge capture mode on a channel pair. The capture edge for the
* channel pair and the capture mode (one-shot or continuous) is specified in the parameter
* argument. The filter function is disabled if the filterVal argument passed is zero. The filter
* function is available only on channels 0 and 2. The user has to read the channel CnV registers
* separately to get the capture values.
*
* @param base FTM peripheral base address
* @param chnlPairNumber The FTM channel pair number; options are 0, 1, 2, 3
* @param edgeParam Sets up the dual edge capture function
* @param filterValue Filter value, specify 0 to disable filter. Available only for channel pair 0 and 1.
*/
void FTM_SetupDualEdgeCapture(FTM_Type *base,
ftm_chnl_t chnlPairNumber,
const ftm_dual_edge_capture_param_t *edgeParam,
uint32_t filterValue);
/*! @}*/
/*!
* @brief Configures the parameters and activates the quadrature decoder mode.
*
* @param base FTM peripheral base address
* @param phaseAParams Phase A configuration parameters
* @param phaseBParams Phase B configuration parameters
* @param quadMode Selects encoding mode used in quadrature decoder mode
*/
void FTM_SetupQuadDecode(FTM_Type *base,
const ftm_phase_params_t *phaseAParams,
const ftm_phase_params_t *phaseBParams,
ftm_quad_decode_mode_t quadMode);
/*!
* @brief Sets up the working of the FTM fault protection.
*
* FTM can have up to 4 fault inputs. This function sets up fault parameters, fault level, and a filter.
*
* @param base FTM peripheral base address
* @param faultNumber FTM fault to configure.
* @param faultParams Parameters passed in to set up the fault
*/
void FTM_SetupFault(FTM_Type *base, ftm_fault_input_t faultNumber, const ftm_fault_param_t *faultParams);
/*!
* @name Interrupt Interface
* @{
*/
/*!
* @brief Enables the selected FTM interrupts.
*
* @param base FTM peripheral base address
* @param mask The interrupts to enable. This is a logical OR of members of the
* enumeration ::ftm_interrupt_enable_t
*/
void FTM_EnableInterrupts(FTM_Type *base, uint32_t mask);
/*!
* @brief Disables the selected FTM interrupts.
*
* @param base FTM peripheral base address
* @param mask The interrupts to enable. This is a logical OR of members of the
* enumeration ::ftm_interrupt_enable_t
*/
void FTM_DisableInterrupts(FTM_Type *base, uint32_t mask);
/*!
* @brief Gets the enabled FTM interrupts.
*
* @param base FTM peripheral base address
*
* @return The enabled interrupts. This is the logical OR of members of the
* enumeration ::ftm_interrupt_enable_t
*/
uint32_t FTM_GetEnabledInterrupts(FTM_Type *base);
/*! @}*/
/*!
* @name Status Interface
* @{
*/
/*!
* @brief Gets the FTM status flags.
*
* @param base FTM peripheral base address
*
* @return The status flags. This is the logical OR of members of the
* enumeration ::ftm_status_flags_t
*/
uint32_t FTM_GetStatusFlags(FTM_Type *base);
/*!
* @brief Clears the FTM status flags.
*
* @param base FTM peripheral base address
* @param mask The status flags to clear. This is a logical OR of members of the
* enumeration ::ftm_status_flags_t
*/
void FTM_ClearStatusFlags(FTM_Type *base, uint32_t mask);
/*! @}*/
/*!
* @name Timer Start and Stop
* @{
*/
/*!
* @brief Starts the FTM counter.
*
* @param base FTM peripheral base address
* @param clockSource FTM clock source; After the clock source is set, the counter starts running.
*/
static inline void FTM_StartTimer(FTM_Type *base, ftm_clock_source_t clockSource)
{
uint32_t reg = base->SC;
reg &= ~(FTM_SC_CLKS_MASK);
reg |= FTM_SC_CLKS(clockSource);
base->SC = reg;
}
/*!
* @brief Stops the FTM counter.
*
* @param base FTM peripheral base address
*/
static inline void FTM_StopTimer(FTM_Type *base)
{
/* Set clock source to none to disable counter */
base->SC &= ~(FTM_SC_CLKS_MASK);
}
/*! @}*/
/*!
* @name Software output control
* @{
*/
/*!
* @brief Enables or disables the channel software output control.
*
* @param base FTM peripheral base address
* @param chnlNumber Channel to be enabled or disabled
* @param value true: channel output is affected by software output control
false: channel output is unaffected by software output control
*/
static inline void FTM_SetSoftwareCtrlEnable(FTM_Type *base, ftm_chnl_t chnlNumber, bool value)
{
if (value)
{
base->SWOCTRL |= (1U << chnlNumber);
}
else
{
base->SWOCTRL &= ~(1U << chnlNumber);
}
}
/*!
* @brief Sets the channel software output control value.
*
* @param base FTM peripheral base address.
* @param chnlNumber Channel to be configured
* @param value true to set 1, false to set 0
*/
static inline void FTM_SetSoftwareCtrlVal(FTM_Type *base, ftm_chnl_t chnlNumber, bool value)
{
if (value)
{
base->SWOCTRL |= (1U << (chnlNumber + FTM_SWOCTRL_CH0OCV_SHIFT));
}
else
{
base->SWOCTRL &= ~(1U << (chnlNumber + FTM_SWOCTRL_CH0OCV_SHIFT));
}
}
/*! @}*/
/*!
* @brief Enables or disables the FTM global time base signal generation to other FTMs.
*
* @param base FTM peripheral base address
* @param enable true to enable, false to disable
*/
static inline void FTM_SetGlobalTimeBaseOutputEnable(FTM_Type *base, bool enable)
{
if (enable)
{
base->CONF |= FTM_CONF_GTBEOUT_MASK;
}
else
{
base->CONF &= ~FTM_CONF_GTBEOUT_MASK;
}
}
/*!
* @brief Sets the FTM peripheral timer channel output mask.
*
* @param base FTM peripheral base address
* @param chnlNumber Channel to be configured
* @param mask true: masked, channel is forced to its inactive state; false: unmasked
*/
static inline void FTM_SetOutputMask(FTM_Type *base, ftm_chnl_t chnlNumber, bool mask)
{
if (mask)
{
base->OUTMASK |= (1U << chnlNumber);
}
else
{
base->OUTMASK &= ~(1U << chnlNumber);
}
}
#if defined(FSL_FEATURE_FTM_HAS_ENABLE_PWM_OUTPUT) && (FSL_FEATURE_FTM_HAS_ENABLE_PWM_OUTPUT)
/*!
* @brief Allows user to enable an output on an FTM channel.
*
* To enable the PWM channel output call this function with val=true. For input mode,
* call this function with val=false.
*
* @param base FTM peripheral base address
* @param chnlNumber Channel to be configured
* @param value true: enable output; false: output is disabled, used in input mode
*/
static inline void FTM_SetPwmOutputEnable(FTM_Type *base, ftm_chnl_t chnlNumber, bool value)
{
if (value)
{
base->SC |= (1U << (chnlNumber + FTM_SC_PWMEN0_SHIFT));
}
else
{
base->SC &= ~(1U << (chnlNumber + FTM_SC_PWMEN0_SHIFT));
}
}
#endif
/*!
* @name Channel pair operations
* @{
*/
/*!
* @brief This function enables/disables the fault control in a channel pair.
*
* @param base FTM peripheral base address
* @param chnlPairNumber The FTM channel pair number; options are 0, 1, 2, 3
* @param value true: Enable fault control for this channel pair; false: No fault control
*/
static inline void FTM_SetFaultControlEnable(FTM_Type *base, ftm_chnl_t chnlPairNumber, bool value)
{
if (value)
{
base->COMBINE |= (1U << (FTM_COMBINE_FAULTEN0_SHIFT + (FTM_COMBINE_COMBINE1_SHIFT * chnlPairNumber)));
}
else
{
base->COMBINE &= ~(1U << (FTM_COMBINE_FAULTEN0_SHIFT + (FTM_COMBINE_COMBINE1_SHIFT * chnlPairNumber)));
}
}
/*!
* @brief This function enables/disables the dead time insertion in a channel pair.
*
* @param base FTM peripheral base address
* @param chnlPairNumber The FTM channel pair number; options are 0, 1, 2, 3
* @param value true: Insert dead time in this channel pair; false: No dead time inserted
*/
static inline void FTM_SetDeadTimeEnable(FTM_Type *base, ftm_chnl_t chnlPairNumber, bool value)
{
if (value)
{
base->COMBINE |= (1U << (FTM_COMBINE_DTEN0_SHIFT + (FTM_COMBINE_COMBINE1_SHIFT * chnlPairNumber)));
}
else
{
base->COMBINE &= ~(1U << (FTM_COMBINE_DTEN0_SHIFT + (FTM_COMBINE_COMBINE1_SHIFT * chnlPairNumber)));
}
}
/*!
* @brief This function enables/disables complementary mode in a channel pair.
*
* @param base FTM peripheral base address
* @param chnlPairNumber The FTM channel pair number; options are 0, 1, 2, 3
* @param value true: enable complementary mode; false: disable complementary mode
*/
static inline void FTM_SetComplementaryEnable(FTM_Type *base, ftm_chnl_t chnlPairNumber, bool value)
{
if (value)
{
base->COMBINE |= (1U << (FTM_COMBINE_COMP0_SHIFT + (FTM_COMBINE_COMBINE1_SHIFT * chnlPairNumber)));
}
else
{
base->COMBINE &= ~(1U << (FTM_COMBINE_COMP0_SHIFT + (FTM_COMBINE_COMBINE1_SHIFT * chnlPairNumber)));
}
}
/*!
* @brief This function enables/disables inverting control in a channel pair.
*
* @param base FTM peripheral base address
* @param chnlPairNumber The FTM channel pair number; options are 0, 1, 2, 3
* @param value true: enable inverting; false: disable inverting
*/
static inline void FTM_SetInvertEnable(FTM_Type *base, ftm_chnl_t chnlPairNumber, bool value)
{
if (value)
{
base->INVCTRL |= (1U << chnlPairNumber);
}
else
{
base->INVCTRL &= ~(1U << chnlPairNumber);
}
}
/*! @}*/
/*!
* @brief Enables or disables the FTM software trigger for PWM synchronization.
*
* @param base FTM peripheral base address
* @param enable true: software trigger is selected, false: software trigger is not selected
*/
static inline void FTM_SetSoftwareTrigger(FTM_Type *base, bool enable)
{
if (enable)
{
base->SYNC |= FTM_SYNC_SWSYNC_MASK;
}
else
{
base->SYNC &= ~FTM_SYNC_SWSYNC_MASK;
}
}
/*!
* @brief Enables or disables the FTM write protection.
*
* @param base FTM peripheral base address
* @param enable true: Write-protection is enabled, false: Write-protection is disabled
*/
static inline void FTM_SetWriteProtection(FTM_Type *base, bool enable)
{
/* Configure write protection */
if (enable)
{
base->FMS |= FTM_FMS_WPEN_MASK;
}
else
{
base->MODE |= FTM_MODE_WPDIS_MASK;
}
}
#if defined(__cplusplus)
}
#endif
/*! @}*/
#endif /* _FSL_FTM_H_*/
|